Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create render_jsonapi_test.rb #110

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions test/render_jsonapi_test.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
require 'test_helper'

class RenderTest < ActionController::TestCase
include Roar::Rails::TestCase

class SingersController < ActionController::Base

module SingerRepresenter
include Roar::JSON::JSONAPI
# type :musicians
property :name, :as => :title
end

module SingersRepresenter
include Representable::JSON::Collection
self.represenation_wrap = :musicians
items :extend => PersonRepresenter
end

include Roar::Rails::ControllerAdditions
include Roar::Rails::ControllerAdditions::Render

# NOTE: using :json_api will break
represents :json, :entity => SingerRepresenter, :collection => SingersRepresenter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure you want that? Both entities and collections must be rendered with the "same" representer using JSONAPI - this is a media format specification and not up to you. So, there should be no need to declare the :collection representer here, this must be sorted internally.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the :collection would throw this error: NameError: uninitialized constant RenderTest::SingersRepresenter. So I had to bake that in to make it work.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, for further contributions, keep in mind that you don't have to make tests work with hacks. For the author, it's even better if you submit breaking tests so they can see what's missing. It's actually my favourite PR style when people simply add a broken test.

Thanks, I'm pushing soon!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heh, that's the thing I didn't realize :collection was a hack... mostly because I'm not as into the Roar project as you are and you know what should work and when. Thanks for the tip and will definitely keep that in mind to provide broken tests! :)


def show
singer = Musician.new("Bumi")
render :json => singer, status: 201
end

def index
singers = [Musician.new("Bumi"), Musician.new("Iggy")]
render :json => singers, status: 201
end

end

tests SingersController

test "should use Representer for #render using jsonapi on a single model" do
get :show, :id => "bumi", :format => :json_api
assert_equal response.body, '{"musicians":{"title":"Bumi"}}'
assert_equal 201, response.status
end

test "should use Representer for #render using jsonapi on a model collection" do
get :index, :format => :json_api
assert_equal response.body, '{"musicians":[{"title":"Bumi"},{"title":"Iggy"}]}'
assert_equal 201, response.status
end

end