jsonapi_compliable 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06adc2e0a9833b1556d62814a1f88c81a4beac2e
-  data.tar.gz: 53d1f7f2d515a1c9dd18fe02f0ab7fe72069f5a9
+  metadata.gz: 363fc9bc08c13030150de69edfaec4bbbbbdb03b
+  data.tar.gz: c7b39b7e43d39bb165c5eda6ae41e5be72f6532d
 SHA512:
-  metadata.gz: 4b5e0517b385fe8fe14234570db9a07c27dc552454d3d7197740708828ad1a84faa496e593148f469ca609262f5047905d7a06f5942c30c60c03ac1b4f692455
-  data.tar.gz: d80f8f709221fd66c313409129bb7aac91c9c53bd8d1c8d7ad8affa646c84e7b3eb5eac511a97eb3067519a2f785f15c9ea2885fa3199507b87dbec8fdf64141
+  metadata.gz: b4284c0e7b12b594985925c4c30f74c911c526cfa6531ed0c5990069d9f8e148cde3f4162a89e0e5f5ad177c1ac9bd042daf9228c72e963efd62920d1b7fa4e4
+  data.tar.gz: 2b90de831bb4d5678bf996bfc1806f55ac9b6f99f4167d9e3b1de9c3ee9df96de068c2a53f5109cd88b7c5de1f23d5a723d0f4f7732879929532fed7e073ac25

data/Appraisals

@@ -1,7 +1,11 @@
 appraise "rails-4" do
   gem "rails", "~> 4.1"
+  gem 'jsonapi-rails', '~> 0.1', require: 'jsonapi/rails'
+  gem 'rspec-rails'
 end
 
 appraise "rails-5" do
   gem "rails", "~> 5.0"
+  gem 'jsonapi-rails', '~> 0.1', require: 'jsonapi/rails'
+  gem 'rspec-rails'
 end

data/Gemfile

@@ -4,9 +4,9 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
+  gem 'pry'
+  gem 'pry-byebug', platform: [:mri]
   gem 'appraisal'
   gem 'guard'
   gem 'guard-rspec'
-  gem 'pry'
-  gem 'pry-byebug'
 end

data/gemfiles/rails_4.gemfile

@@ -2,15 +2,16 @@
 
 source "https://rubygems.org"
 
-gem "active_model_serializers", :git => "https://github.com/richmolj/active_model_serializers.git"
 gem "rails", "~> 4.1"
+gem "jsonapi-rails", "~> 0.1", :require => "jsonapi/rails"
+gem "rspec-rails"
 
 group :test do
+  gem "pry"
+  gem "pry-byebug", :platform => [:mri]
   gem "appraisal"
   gem "guard"
   gem "guard-rspec"
-  gem "pry"
-  gem "pry-byebug"
 end
 
 gemspec :path => "../"

data/gemfiles/rails_4.gemfile.lock

@@ -1,21 +1,8 @@
-GIT
-  remote: https://github.com/richmolj/active_model_serializers.git
-  revision: 1dc2b74059731339f4df3e7882fd949e20433013
-  specs:
-    active_model_serializers (0.10.2)
-      actionpack (>= 4.1, < 6)
-      activemodel (>= 4.1, < 6)
-      jsonapi (~> 0.1.1.beta2)
-      railties (>= 4.1, < 6)
-
 PATH
   remote: ../
   specs:
-    jsonapi_compliable (0.3.4)
-      active_model_serializers (~> 0.10)
-      jsonapi (~> 0.1.1.beta2)
-      jsonapi_ams_extensions (~> 0.1)
-      rails (>= 4.1, < 6)
+    jsonapi_compliable (0.4.0)
+      jsonapi-serializable (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -61,9 +48,9 @@ GEM
       thor (>= 0.14.0)
     arel (6.0.3)
     builder (3.2.2)
-    byebug (9.0.5)
+    byebug (9.0.6)
     coderay (1.1.1)
-    concurrent-ruby (1.0.2)
+    concurrent-ruby (1.0.4)
     database_cleaner (1.5.3)
     diff-lcs (1.2.5)
     erubis (2.7.0)
@@ -87,11 +74,17 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     i18n (0.7.0)
     json (1.8.3)
-    jsonapi (0.1.1.beta2)
-      json (~> 1.8)
-    jsonapi_ams_extensions (0.1.1)
-      active_model_serializers (~> 0.10.x)
-    jsonapi_spec_helpers (0.2.0)
+    jsonapi-deserializable (0.1.1)
+      jsonapi-parser (= 0.1.1)
+    jsonapi-parser (0.1.1)
+    jsonapi-rails (0.1.1)
+      jsonapi-rb (= 0.1.1)
+    jsonapi-rb (0.1.1)
+      jsonapi-deserializable (= 0.1.1)
+      jsonapi-serializable (= 0.1.1)
+    jsonapi-renderer (0.1.1)
+    jsonapi-serializable (0.1.1)
+      jsonapi-renderer (= 0.1.1)
     kaminari (0.17.0)
       actionpack (>= 3.0.0)
       activesupport (>= 3.0.0)
@@ -109,23 +102,21 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
-    minitest (5.9.0)
+    minitest (5.10.1)
     nenv (0.3.0)
-    nokogiri (1.6.8)
+    nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pkg-config (1.1.7)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-byebug (3.4.0)
+    pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
-    rack (1.6.4)
+    rack (1.6.5)
     rack-test (0.6.3)
       rack (>= 1.0)
     rails (4.2.7.1)
@@ -153,14 +144,14 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.5.0)
-    rb-fsevent (0.9.7)
+    rb-fsevent (0.9.8)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -177,7 +168,7 @@ GEM
       rspec-mocks (~> 3.5.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    ruby_dep (1.4.0)
+    ruby_dep (1.5.0)
     shellany (0.0.1)
     slop (3.6.0)
     sprockets (3.7.0)
@@ -187,8 +178,8 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.11)
-    thor (0.19.1)
+    sqlite3 (1.3.12)
+    thor (0.19.4)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
@@ -197,14 +188,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  active_model_serializers!
+  activerecord (>= 4.1, < 6)
   appraisal
   bundler (~> 1.12)
   database_cleaner
   guard
   guard-rspec
+  jsonapi-rails (~> 0.1)
   jsonapi_compliable!
-  jsonapi_spec_helpers
   kaminari
   pry
   pry-byebug
@@ -214,4 +205,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/gemfiles/rails_5.gemfile

@@ -2,15 +2,16 @@
 
 source "https://rubygems.org"
 
-gem "active_model_serializers", :git => "https://github.com/richmolj/active_model_serializers.git"
 gem "rails", "~> 5.0"
+gem "jsonapi-rails", "~> 0.1", :require => "jsonapi/rails"
+gem "rspec-rails"
 
 group :test do
+  gem "pry"
+  gem "pry-byebug", :platform => [:mri]
   gem "appraisal"
   gem "guard"
   gem "guard-rspec"
-  gem "pry"
-  gem "pry-byebug"
 end
 
 gemspec :path => "../"

data/gemfiles/rails_5.gemfile.lock

@@ -1,21 +1,8 @@
-GIT
-  remote: https://github.com/richmolj/active_model_serializers.git
-  revision: 1dc2b74059731339f4df3e7882fd949e20433013
-  specs:
-    active_model_serializers (0.10.2)
-      actionpack (>= 4.1, < 6)
-      activemodel (>= 4.1, < 6)
-      jsonapi (~> 0.1.1.beta2)
-      railties (>= 4.1, < 6)
-
 PATH
   remote: ../
   specs:
-    jsonapi_compliable (0.3.4)
-      active_model_serializers (~> 0.10)
-      jsonapi (~> 0.1.1.beta2)
-      jsonapi_ams_extensions (~> 0.1)
-      rails (>= 4.1, < 6)
+    jsonapi_compliable (0.4.0)
+      jsonapi-serializable (~> 0.1)
 
 GEM
   remote: https://rubygems.org/
@@ -61,11 +48,11 @@ GEM
       bundler
       rake
       thor (>= 0.14.0)
-    arel (7.1.1)
+    arel (7.1.4)
     builder (3.2.2)
-    byebug (9.0.5)
+    byebug (9.0.6)
     coderay (1.1.1)
-    concurrent-ruby (1.0.2)
+    concurrent-ruby (1.0.4)
     database_cleaner (1.5.3)
     diff-lcs (1.2.5)
     erubis (2.7.0)
@@ -88,12 +75,17 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     i18n (0.7.0)
-    json (1.8.3)
-    jsonapi (0.1.1.beta2)
-      json (~> 1.8)
-    jsonapi_ams_extensions (0.1.1)
-      active_model_serializers (~> 0.10.x)
-    jsonapi_spec_helpers (0.2.0)
+    jsonapi-deserializable (0.1.1)
+      jsonapi-parser (= 0.1.1)
+    jsonapi-parser (0.1.1)
+    jsonapi-rails (0.1.1)
+      jsonapi-rb (= 0.1.1)
+    jsonapi-rb (0.1.1)
+      jsonapi-deserializable (= 0.1.1)
+      jsonapi-serializable (= 0.1.1)
+    jsonapi-renderer (0.1.1)
+    jsonapi-serializable (0.1.1)
+      jsonapi-renderer (= 0.1.1)
     kaminari (0.17.0)
       actionpack (>= 3.0.0)
       activesupport (>= 3.0.0)
@@ -111,21 +103,19 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
-    minitest (5.9.0)
+    minitest (5.10.1)
     nenv (0.3.0)
     nio4r (1.2.1)
-    nokogiri (1.6.8)
+    nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    pkg-config (1.1.7)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-byebug (3.4.0)
+    pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
     rack (2.0.1)
@@ -155,14 +145,14 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.5.0)
-    rb-fsevent (0.9.7)
+    rb-fsevent (0.9.8)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.3)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -179,7 +169,7 @@ GEM
       rspec-mocks (~> 3.5.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    ruby_dep (1.4.0)
+    ruby_dep (1.5.0)
     shellany (0.0.1)
     slop (3.6.0)
     sprockets (3.7.0)
@@ -189,8 +179,8 @@ GEM
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.11)
-    thor (0.19.1)
+    sqlite3 (1.3.12)
+    thor (0.19.4)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
@@ -202,14 +192,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  active_model_serializers!
+  activerecord (>= 4.1, < 6)
   appraisal
   bundler (~> 1.12)
   database_cleaner
   guard
   guard-rspec
+  jsonapi-rails (~> 0.1)
   jsonapi_compliable!
-  jsonapi_spec_helpers
   kaminari
   pry
   pry-byebug
@@ -219,4 +209,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/jsonapi_compliable.gemspec

@@ -17,16 +17,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", ['>= 4.1', '< 6']
+  spec.add_dependency 'jsonapi-serializable', '~> 0.1'
 
-  spec.add_dependency 'jsonapi-rails', '~> 0.1'
-
-  spec.add_development_dependency "kaminari"
-  spec.add_development_dependency "active_model_serializers"
-  spec.add_development_dependency "jsonapi_spec_helpers"
+  spec.add_development_dependency "activerecord", ['>= 4.1', '< 6']
+  spec.add_development_dependency "kaminari", '~> 0.17'
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "database_cleaner"
 end

data/lib/jsonapi_compliable/adapters/abstract.rb

@@ -0,0 +1,25 @@
+module JsonapiCompliable
+  module Adapters
+    class Abstract
+      def filter(scope, attribute, value)
+        raise 'you must override #filter in an adapter subclass'
+      end
+
+      def order(scope, attribute, direction)
+        raise 'you must override #order in an adapter subclass'
+      end
+
+      def paginate(scope, number, size)
+        raise 'you must override #paginate in an adapter subclass'
+      end
+
+      def sideload(scope, includes)
+        raise 'you must override #sideload in an adapter subclass'
+      end
+
+      def sideloading_module
+        Module.new
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/adapters/active_record.rb

@@ -0,0 +1,47 @@
+require 'jsonapi_compliable/adapters/active_record_sideloading'
+
+module JsonapiCompliable
+  module Adapters
+    class ActiveRecord < Abstract
+      def filter(scope, attribute, value)
+        scope.where(attribute => value)
+      end
+
+      def order(scope, attribute, direction)
+        scope.order(attribute => direction)
+      end
+
+      def paginate(scope, current_page, per_page)
+        scope.page(current_page).per(per_page)
+      end
+
+      def sideload(scope, includes)
+        scope.includes(includes)
+      end
+
+      def count(scope, attr)
+        scope.count
+      end
+
+      def average(scope, attr)
+        scope.average(attr).to_f
+      end
+
+      def sum(scope, attr)
+        scope.sum(attr)
+      end
+
+      def maximum(scope, attr)
+        scope.maximum(attr)
+      end
+
+      def minimum(scope, attr)
+        scope.minimum(attr)
+      end
+
+      def sideloading_module
+        JsonapiCompliable::Adapters::ActiveRecordSideloading
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/adapters/active_record_sideloading.rb

@@ -0,0 +1,119 @@
+module JsonapiCompliable
+  module Adapters
+    module ActiveRecordSideloading
+      def has_many(association_name, scope:, resource:, foreign_key:, primary_key: :id, &blk)
+        _scope = scope
+
+        allow_sideload association_name, resource: resource do
+          scope do |parents|
+            parent_ids = parents.map { |p| p.send(primary_key) }
+            _scope.call.where(foreign_key => parent_ids)
+          end
+
+          assign do |parents, children|
+            parents.each do |parent|
+              parent.association(association_name).loaded!
+              relevant_children = children.select { |c| c.send(foreign_key) == parent.send(primary_key) }
+              relevant_children.each do |c|
+                parent.association(association_name).add_to_target(c, :skip_callbacks)
+              end
+            end
+          end
+
+          instance_eval(&blk) if blk
+        end
+      end
+
+      def belongs_to(association_name, scope:, resource:, foreign_key:, primary_key: :id, &blk)
+        _scope = scope
+
+        allow_sideload association_name, resource: resource do
+          scope do |parents|
+            parent_ids = parents.map { |p| p.send(foreign_key) }
+            _scope.call.where(primary_key => parent_ids)
+          end
+
+          assign do |parents, children|
+            parents.each do |parent|
+              relevant_child = children.find { |c| parent.send(foreign_key) == c.send(primary_key) }
+              parent.send(:"#{association_name}=", relevant_child)
+            end
+          end
+        end
+
+        instance_eval(&blk) if blk
+      end
+
+      def has_one(association_name, scope:, resource:, foreign_key:, primary_key: :id, &blk)
+        _scope = scope
+
+        allow_sideload association_name, resource: resource do
+          scope do |parents|
+            parent_ids = parents.map { |p| p.send(primary_key) }
+            _scope.call.where(foreign_key => parent_ids)
+          end
+
+          assign do |parents, children|
+            parents.each do |parent|
+              parent.association(association_name).loaded!
+              relevant_child = children.find { |c| c.send(foreign_key) == parent.send(primary_key) }
+              next unless relevant_child
+              parent.association(association_name).replace(relevant_child, false)
+            end
+          end
+
+          instance_eval(&blk) if blk
+        end
+      end
+
+      def has_and_belongs_to_many(association_name, scope:, resource:, foreign_key:, primary_key: :id, as: nil, &blk)
+        through = foreign_key.keys.first
+        fk      = foreign_key.values.first
+        _scope  = scope
+
+        allow_sideload association_name, resource: resource do
+          scope do |parents|
+            _scope.call.joins(through).where(through => { fk => parents.map { |p| p.send(primary_key) } })
+          end
+
+          assign do |parents, children|
+            parents.each do |parent|
+              parent.association(association_name).loaded!
+              relevant_children = children.select { |c| c.send(through).any? { |ct| ct.send(fk) == parent.send(primary_key) } }
+              relevant_children.each do |c|
+                parent.association(association_name).add_to_target(c, :skip_callbacks)
+              end
+            end
+          end
+
+          instance_eval(&blk) if blk
+        end
+      end
+
+      def polymorphic_belongs_to(association_name, group_by:, groups:, &blk)
+        allow_sideload association_name, polymorphic: true do
+          group_by(&group_by)
+
+          groups.each_pair do |type, config|
+            primary_key = config[:primary_key] || :id
+            foreign_key = config[:foreign_key]
+
+            allow_sideload type, resource: config[:resource] do
+              scope do |parents|
+                config[:scope].call.where(primary_key => parents.map { |p| p.send(foreign_key) })
+              end
+
+              assign do |parents, children|
+                parents.each do |parent|
+                  parent.send(:"#{association_name}=", children.find { |c| c.send(primary_key) == parent.send(foreign_key) })
+                end
+              end
+            end
+          end
+        end
+
+        instance_eval(&blk) if blk
+      end
+    end
+  end
+end

data/lib/jsonapi_compliable/adapters/null.rb

@@ -0,0 +1,21 @@
+module JsonapiCompliable
+  module Adapters
+    class Null < Abstract
+      def filter(scope, attribute, value)
+        scope
+      end
+
+      def order(scope, attribute, direction)
+        scope
+      end
+
+      def paginate(scope, number, size)
+        scope
+      end
+
+      def sideload(scope, includes)
+        scope
+      end
+    end
+  end
+end