Merge pull request #6 from richmolj/jsonapirb

Jsonapirb

Author: richmolj

Gemfile

@@ -2,7 +2,6 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in jsonapi_compliable.gemspec
 gemspec
-gem 'active_model_serializers', git: 'https://github.com/richmolj/active_model_serializers.git'
 
 group :test do
   gem 'appraisal'

jsonapi_compliable.gemspec

@@ -18,9 +18,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", ['>= 4.1', '< 6']
-  spec.add_dependency "jsonapi", '~> 0.1.1.beta2'
-  spec.add_dependency "active_model_serializers", "~> 0.10"
-  spec.add_dependency "jsonapi_ams_extensions", "~> 0.1"
+
+  spec.add_dependency 'jsonapi-rails', '~> 0.1'
 
   spec.add_development_dependency "kaminari"
   spec.add_development_dependency "active_model_serializers"

lib/jsonapi_compliable.rb

@@ -1,6 +1,4 @@
-require 'active_model_serializers'
-require 'jsonapi'
-require 'jsonapi_ams_extensions'
+require 'jsonapi/rails'
 
 require "jsonapi_compliable/version"
 require "jsonapi_compliable/errors"
@@ -19,8 +17,8 @@
 require "jsonapi_compliable/util/field_params"
 require "jsonapi_compliable/util/scoping"
 require "jsonapi_compliable/util/pagination"
-
-require 'jsonapi_compliable/railtie' if defined?(::Rails)
+require "jsonapi_compliable/extensions/extra_attribute"
+require "jsonapi_compliable/extensions/boolean_attribute"
 
 module JsonapiCompliable
   autoload :Base,           'jsonapi_compliable/base'

lib/jsonapi_compliable/base.rb

@@ -51,25 +51,26 @@ def parse_fieldsets!
       Util::FieldParams.parse!(params, :extra_fields)
     end
 
-    def render_ams(scope, opts = {})
+    def render_jsonapi(scope, opts = {})
       scoped = Util::Scoping.apply?(self, scope, opts.delete(:scope)) ? jsonapi_scope(scope) : scope
-      options = default_ams_options
+      options = default_jsonapi_render_options
       options[:include] = forced_includes || Util::IncludeParams.scrub(self)
       options[:jsonapi] = JsonapiCompliable::Util::Pagination.zero?(params) ? [] : scoped
       options[:fields] = Util::FieldParams.fieldset(params, :fields) if params[:fields]
-      options[:extra_fields] = Util::FieldParams.fieldset(params, :extra_fields) if params[:extra_fields]
       options[:meta] ||= {}
       options.merge!(opts)
       options[:meta][:stats] = Stats::Payload.new(self, scoped).generate if params[:stats]
+      options[:expose] ||= {}
+      options[:expose][:context] = self
+      options[:expose][:extra_fields] = Util::FieldParams.fieldset(params, :extra_fields) if params[:extra_fields]
 
       render(options)
     end
 
-    # render_ams(foo) equivalent to
-    # render json: foo, ams_default_options
-    def default_ams_options
+    # render_jsonapi(foo) equivalent to
+    # render jsonapi: foo, default_jsonapi_render_options
+    def default_jsonapi_render_options
       {}.tap do |options|
-        options[:adapter] = :json_api
       end
     end
 

lib/jsonapi_compliable/extensions/boolean_attribute.rb

@@ -0,0 +1,21 @@
+module JsonapiCompliable
+  module Extensions
+    module BooleanAttribute
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def boolean_attribute(name, options = {}, &blk)
+          blk ||= proc { @object.public_send(name) }
+          field_name = :"is_#{name.to_s.gsub('?', '')}"
+          attribute field_name, options, &blk
+        end
+      end
+    end
+  end
+end
+
+JSONAPI::Serializable::Resource.class_eval do
+  include JsonapiCompliable::Extensions::BooleanAttribute
+end

lib/jsonapi_compliable/extensions/extra_attribute.rb

@@ -0,0 +1,34 @@
+require 'jsonapi/serializable/resource/conditional_fields'
+
+module JsonapiCompliable
+  module Extensions
+    module ExtraAttribute
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def extra_attribute(name, options = {}, &blk)
+          allow_field = proc {
+            if options[:if]
+              next false unless instance_eval(&options[:if])
+            end
+
+            if @extra_fields && @extra_fields[jsonapi_type]
+              @extra_fields[jsonapi_type].include?(name)
+            else
+              false
+            end
+          }
+
+          attribute name, if: allow_field, &blk
+        end
+      end
+    end
+  end
+end
+
+JSONAPI::Serializable::Resource.class_eval do
+  prepend JSONAPI::Serializable::Resource::ConditionalFields
+  include JsonapiCompliable::Extensions::ExtraAttribute
+end

lib/jsonapi_compliable/railtie.rb

@@ -1,3 +1,3 @@
 module JsonapiCompliable
-  VERSION = "0.3.10"
+  VERSION = "0.4.0"
 end

lib/jsonapi_compliable/version.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+RSpec.describe '.boolean_attribute' do
+  let(:klass) do
+    Class.new(JSONAPI::Serializable::Resource) do
+      type 'authors'
+
+      boolean_attribute :celebrity?
+    end
+  end
+
+  let(:author)   { double(id: 1) }
+  let(:resource) { klass.new(object: author) }
+
+  subject { resource.as_jsonapi[:attributes] }
+
+  before do
+    allow(author).to receive(:celebrity?) { true }
+  end
+
+  it { is_expected.to eq(is_celebrity: true) }
+
+  context 'when supplied a block' do
+    before do
+      klass.class_eval do
+        boolean_attribute :alive? do
+          'yesss'
+        end
+      end
+    end
+
+    it { is_expected.to include(is_alive: 'yesss') }
+  end
+end

spec/boolean_attribute_spec.rb

@@ -10,7 +10,7 @@ def create
       author = Author.new(author_params.except(:state_attributes))
       author.state = State.find_or_initialize_by(author_params[:state_attributes])
       author.save!(validate: false)
-      render_ams(author, scope: false)
+      render_jsonapi(author, scope: false)
     end
 
     def update
@@ -21,7 +21,7 @@ def update
       end
       author.association(:books).loaded!
       author.save!
-      render_ams(author, scope: false)
+      render_jsonapi(author, scope: false)
     end
 
     private

spec/create_update_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
 
 RSpec.describe 'extra_fields', type: :controller do
-  class TestExtraFieldsSerializer < ActiveModel::Serializer
-    include JsonapiAmsExtensions
+  class SerializableTestExtraFields < JSONAPI::Serializable::Resource
+    type 'authors'
     attributes :first_name, :last_name
-    extra_attribute :net_worth
-
-    def net_worth
+    extra_attribute :net_worth, if: proc { @context.allow_net_worth? } do
       100_000_000
     end
   end
@@ -18,8 +16,12 @@ def net_worth
       end
     end
 
+    def allow_net_worth?
+      true
+    end
+
     def index
-      render_ams(Author.all, each_serializer: TestExtraFieldsSerializer)
+      render_jsonapi(Author.all, class: SerializableTestExtraFields)
     end
   end
 
@@ -57,8 +59,7 @@ def include_foo!
 
   context 'when extra field is requested but guarded' do
     before do
-      allow_any_instance_of(TestExtraFieldsSerializer)
-        .to receive(:allow_net_worth?) { false }
+      allow(controller).to receive(:allow_net_worth?) { false }
     end
 
     it 'does not include the extra field in the response' do

spec/extra_fields_spec.rb

@@ -4,25 +4,25 @@
   controller(ApplicationController) do
     jsonapi {}
 
-    class TestFieldsSerializer < ActiveModel::Serializer
-      attributes :first_name, :last_name, :uuid
-      attribute :salary, if: :admin?
+    class SerializableTestFields < JSONAPI::Serializable::Resource
+      type 'authors'
 
-      def uuid
+      attribute :first_name
+      attribute :last_name
+      attribute :uuid do
         SecureRandom.uuid
       end
+      attribute :salary, if: proc { @context.current_user == 'admin' } do
+        50_000
+      end
 
       def admin?
         scope == 'admin'
       end
-
-      def salary
-        50_000
-      end
     end
 
     def index
-      render_ams(Author.all, each_serializer: TestFieldsSerializer)
+      render_jsonapi(Author.all, class: SerializableTestFields)
     end
 
     def current_user

spec/fields_spec.rb

@@ -12,7 +12,7 @@
     end
 
     def index
-      render_ams(Author.all)
+      render_jsonapi(Author.all)
     end
 
     def can_filter_first_name?

spec/filtering_spec.rb

@@ -6,7 +6,7 @@
 
     def index
       scope = Author.all
-      render_ams(scope)
+      render_jsonapi(scope)
     end
   end
 
@@ -46,15 +46,15 @@ def index
     end
   end
 
-  describe '#render_ams' do
+  describe '#render_jsonapi' do
     it 'is able to override options' do
       author = Author.create!(first_name: 'Stephen', last_name: 'King')
       author.books.create(title: "The Shining", genre: Genre.new(name: 'horror'))
 
       controller.class_eval do
         def index
           scope = Author.all
-          render_ams(scope, include: { books: :genre })
+          render_jsonapi(scope, include: { books: :genre })
         end
       end
 
@@ -67,7 +67,7 @@ def index
         controller.class_eval do
           def index
             people = jsonapi_scope(Author.all).to_a
-            render_ams(people)
+            render_jsonapi(people)
           end
         end
       end
@@ -97,7 +97,7 @@ def index
         controller.class_eval do
           def index
             people = Author.all
-            render_ams(people, scope: false)
+            render_jsonapi(people, scope: false)
           end
         end
       end

spec/jsonapi_compliable_spec.rb

@@ -5,7 +5,7 @@
     jsonapi {}
 
     def index
-      render_ams(Author.all)
+      render_jsonapi(Author.all)
     end
   end
 

spec/pagination_spec.rb

@@ -7,7 +7,7 @@
     end
 
     def index
-      render_ams(Author.all)
+      render_jsonapi(Author.all)
     end
   end
 
@@ -48,11 +48,11 @@ def index
     end
 
     it 'uses the custom include function' do
-      scope = double.as_null_object
+      scope = Author.all
+      allow(Author).to receive(:all) { scope }
+
       expect(scope).to receive(:special_include)
-        .and_return(scope)
-        .with(books: { genre: {} })
-      expect(Author).to receive(:all) { scope }
+        .with(books: { genre: {} }).and_return(scope)
 
       get :index, params: { include: 'books.genre' }
     end

spec/sideloading_spec.rb

@@ -5,7 +5,7 @@
     jsonapi {}
 
     def index
-      render_ams(Author.all)
+      render_jsonapi(Author.all)
     end
   end