Switch to jsonapi-rb

Author: Lee Richmond

Gemfile

@@ -2,7 +2,7 @@ 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'
+gem 'jsonapi-serializable', path: '../serializable'
 
 group :test do
   gem 'appraisal'

jsonapi_compliable.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
 
   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'
 
   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,6 +17,8 @@
 require "jsonapi_compliable/util/field_params"
 require "jsonapi_compliable/util/scoping"
 require "jsonapi_compliable/util/pagination"
+require "jsonapi_compliable/extensions/extra_attribute"
+require "jsonapi_compliable/extensions/boolean_attribute"
 
 require 'jsonapi_compliable/railtie' if defined?(::Rails)
 

lib/jsonapi_compliable/base.rb

@@ -57,10 +57,12 @@ def render_ams(scope, opts = {})
       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
@@ -69,7 +71,6 @@ def render_ams(scope, opts = {})
     # render json: foo, ams_default_options
     def default_ams_options
       {}.tap do |options|
-        options[:adapter] = :json_api
       end
     end
 

lib/jsonapi_compliable/extensions/boolean_attribute.rb

@@ -0,0 +1,23 @@
+require 'jsonapi/serializable/conditional_fields'
+
+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/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::ConditionalFields
+  include JsonapiCompliable::Extensions::ExtraAttribute
+end

lib/jsonapi_compliable/railtie.rb

@@ -5,14 +5,14 @@
 
 module ActiveModelSerializers
   class Railtie < Rails::Railtie
-    initializer 'jsonapi_compliable.register_renderer' do
-      require 'active_model_serializers/register_jsonapi_renderer'
-    end
+    #initializer 'jsonapi_compliable.register_renderer' do
+      #require 'active_model_serializers/register_jsonapi_renderer'
+    #end
 
-    initializer 'jsonapi_compliable.configure_ams' do
-      if ActiveModelSerializers.config.respond_to?(:include_data_default)
-        ActiveModelSerializers.config.include_data_default = :if_sideloaded
-      end
-    end
+    #initializer 'jsonapi_compliable.configure_ams' do
+      #if ActiveModelSerializers.config.respond_to?(:include_data_default)
+        #ActiveModelSerializers.config.include_data_default = :if_sideloaded
+      #end
+    #end
   end
 end

spec/boolean_attribute_spec.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/extra_fields_spec.rb

@@ -1,12 +1,12 @@
 require 'spec_helper'
+require 'jsonapi/serializable/conditional_fields'
 
 RSpec.describe 'extra_fields', type: :controller do
-  class TestExtraFieldsSerializer < ActiveModel::Serializer
-    include JsonapiAmsExtensions
+  class SerializableTestExtraFields < JSONAPI::Serializable::Resource
+    prepend JSONAPI::Serializable::ConditionalFields
+    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 +18,12 @@ def net_worth
       end
     end
 
+    def allow_net_worth?
+      true
+    end
+
     def index
-      render_ams(Author.all, each_serializer: TestExtraFieldsSerializer)
+      render_ams(Author.all, class: SerializableTestExtraFields)
     end
   end
 
@@ -57,8 +61,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/fields_spec.rb

@@ -1,28 +1,30 @@
 require 'spec_helper'
+require 'jsonapi/serializable/conditional_fields'
 
 RSpec.describe 'fields', type: :controller do
   controller(ApplicationController) do
     jsonapi {}
 
-    class TestFieldsSerializer < ActiveModel::Serializer
-      attributes :first_name, :last_name, :uuid
-      attribute :salary, if: :admin?
+    class SerializableTestFields < JSONAPI::Serializable::Resource
+      prepend JSONAPI::Serializable::ConditionalFields
+      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_ams(Author.all, class: SerializableTestFields)
     end
 
     def current_user