pragma-decorator 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bbec18405551712b35736d4c0ce74e0981ed356e
-  data.tar.gz: bacafc3eca685e41332be8991ff1709d36d5cddc
+SHA256:
+  metadata.gz: '0845e95dd2b1793d4db9ddc6280f62fb9420a385416779de9d0de56573a4ba18'
+  data.tar.gz: 85d1bf273b7748ab953eea1861e3e9935dc548b3d90a6815ffd25fd26c255dbb
 SHA512:
-  metadata.gz: 9e08aabbc192fd4c81f638ae98d92b71b23663a2aad72db873f148edeb63211c5878e6072d7dbb377e0bdf72bbe7851ecd9262d02772b159c7aff8e1f4bebe52
-  data.tar.gz: b0f12d8e1196b6205de676aa7bffc270d20342e0b3b7ec8a517cf8693e53f67970a449e37659f2c291f417111d5e98554f6717bd71d70f5e9a34ffa1593338c0
+  metadata.gz: 596e58d11fc5b7e309ef09a443002d7bd79acb5aada4f7a09eb85b449f357a55995600d0f93ae003d0ef32ef8373c6038c9d187b9a074715c90a91dfa9dc2403
+  data.tar.gz: f36e57ae761386a60c87245182f9f186803300ec77af42c0a7893568dba99967e85258c6cdfa39bfb8d71f7de21330d7d677dec69edfecae6117bd7036a913b7

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /spec/examples.txt
+.ruby-version

data/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.2.0]
+
+### Added
+
+- Added support for custom pagination adapters
+- Implemented STI support in `Collection`
+
+### Changed
+
+- Renamed `Pagination#adapter` to `#pagination_adapter`
+- `Type` now replaces `::` with `/`
+
+### Fixed
+
+- Fixed AR association adapter not working with custom scopes
+- Fixed AR association adapter not working with `has_one`
+- Fixed associations inheritance
+- Fixed association expansion for non-AR associations defined on AR models
+
 ## [2.1.1]
 
 ### Fixed
@@ -38,6 +57,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 First Pragma 2 release.
 
 [Unreleased]: https://github.com/pragmarb/pragma-decorator/compare/v2.1.1...HEAD
+[2.2.0]: https://github.com/pragmarb/pragma-decorator/compare/v2.1.1...v2.2.0
 [2.1.1]: https://github.com/pragmarb/pragma-decorator/compare/v2.1.0...v2.1.1
 [2.1.0]: https://github.com/pragmarb/pragma-decorator/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/pragmarb/pragma-decorator/compare/v1.2.0...v2.0.0

data/lib/pragma/decorator/association/adapter/active_record.rb

@@ -61,7 +61,8 @@ module Pragma
           #
           # @todo Allow to specify a different PK attribute when +exec_context+ is +decorator+
           def primary_key
-            return associated_object&.id if reflection.options[:exec_context] == :decorator
+            return associated_object&.id if association_reflection.nil? ||
+                                            reflection.options[:exec_context] == :decorator
 
             case reflection.type
             when :belongs_to
@@ -103,7 +104,7 @@ module Pragma
 
           def compute_has_one_fk
             if model.association(reflection.property).loaded?
-              return associated_object&.public_send(associated_object.association_primary_key)
+              return associated_object&.public_send(association_reflection.association_primary_key)
             end
 
             pluck_association_fk do |scope|
@@ -116,7 +117,7 @@ module Pragma
             scope = association_reflection.klass.all
 
             if association_reflection.scope
-              scope = association_reflection.instance_eval(&association_reflection.scope)
+              scope = scope.instance_eval(&association_reflection.scope)
             end
 
             yield(scope).pluck(association_reflection.association_primary_key).first
@@ -127,6 +128,7 @@ module Pragma
           end
 
           def check_type_consistency
+            return unless association_reflection
             return if association_reflection.macro.to_sym == reflection.type.to_sym
 
             fail InconsistentTypeError.new(

data/lib/pragma/decorator/association.rb

@@ -29,7 +29,7 @@ module Pragma
         #
         # @return [Hash{Symbol => Reflection}] the associations
         def associations
-          @associations ||= {}
+          @associations ||= superclass.respond_to?(:associations) ? superclass.associations : {}
         end
 
         # Defines a +belongs_to+ association on this decorator.

data/lib/pragma/decorator/collection.rb

@@ -35,7 +35,18 @@ module Pragma
         klass.extend ClassMethods
 
         klass.class_eval do
-          collection :represented, as: :data, exec_context: :decorator
+          collection :data, exec_context: :decorator, getter: (lambda do |options:, **|
+            represented_collection = if self.class.instance_decorator.is_a?(Proc)
+              represented.map do |item|
+                self.class.instance_decorator.call(item).represent(item).to_hash(options)
+              end
+            elsif self.class.instance_decorator
+              self.class.instance_decorator.represent(represented.to_a).to_hash(options)
+            else
+              represented
+            end
+            represented_collection
+          end)
         end
       end
 
@@ -49,13 +60,16 @@ module Pragma
       end
 
       module ClassMethods # :nodoc:
+        # @!attribute [r]
+        #   @return [Class\Proc] the instance decorator to use
+        attr_reader :instance_decorator
+
         # Defines the decorator to use for each resource in the collection.
         #
-        # @param decorator [Class] a decorator class
-        #
-        # @todo Accept a callable/block or document how to decorate polymorphic collections
+        # @param decorator [Class|Proc] a decorator class, or a callable accepting a represented
+        #   object as argument and returning a decorator class
         def decorate_with(decorator)
-          collection :represented, as: :data, exec_context: :decorator, decorator: decorator
+          @instance_decorator = decorator
         end
       end
     end

data/lib/pragma/decorator/pagination/adapter/kaminari.rb

@@ -3,7 +3,7 @@
 module Pragma
   module Decorator
     module Pagination
-      module Adapter
+      module Adapter # :nodoc:
         # This adapter provides support for retireving pagination information from collections
         # paginated with {https://github.com/kaminari/kaminari Kaminari}.
         #
@@ -65,6 +65,8 @@ module Pragma
             collection.next_page
           end
         end
+
+        adapters << Kaminari
       end
     end
   end

data/lib/pragma/decorator/pagination/adapter/will_paginate.rb

@@ -3,8 +3,8 @@
 module Pragma
   module Decorator
     module Pagination
-      module Adapter
-        # This adapter provides support for retireving pagination information from collections
+      module Adapter # :nodoc:
+        # This adapter provides support for retrieving pagination information from collections
         # paginated with {https://github.com/mislav/will_paginate will_paginate}.
         #
         # @api private
@@ -65,6 +65,8 @@ module Pragma
             collection.next_page
           end
         end
+
+        adapters << WillPaginate
       end
     end
   end

data/lib/pragma/decorator/pagination/adapter.rb

@@ -8,29 +8,37 @@ module Pragma
       #
       # @api private
       module Adapter
-        # The list of supported adapters, in order of priority.
-        SUPPORTED_ADAPTERS = [Kaminari, WillPaginate].freeze
+        class << self
+          # Loads the adapter for the given collection.
+          #
+          # This will try {SUPPORTED_ADAPTERS} in order until it finds an adapter that supports the
+          # collection. When the adapter is found, it will return a new instance of it.
+          #
+          # @param collection [Object] the collection to load the adapter for
+          #
+          # @return [Adapter::Base]
+          #
+          # @see Adapter::Base.supports?
+          #
+          # @raise [AdapterError] if no adapter supports the collection
+          def load_for(collection)
+            adapter_klass = adapters.find do |klass|
+              klass.supports?(collection)
+            end
 
-        # Loads the adapter for the given collection.
-        #
-        # This will try {SUPPORTED_ADAPTERS} in order until it finds an adapter that supports the
-        # collection. When the adapter is found, it will return a new instance of it.
-        #
-        # @param collection [Object] the collection to load the adapter for
-        #
-        # @return [Adapter::Base]
-        #
-        # @see Adapter::Base.supports?
-        #
-        # @raise [AdapterError] if no adapter supports the collection
-        def self.load_for(collection)
-          adapter_klass = SUPPORTED_ADAPTERS.find do |klass|
-            klass.supports?(collection)
-          end
+            fail NoAdapterError unless adapter_klass
 
-          fail NoAdapterError unless adapter_klass
+            adapter_klass.new(collection)
+          end
 
-          adapter_klass.new(collection)
+          # Returns the available pagination adpaters.
+          #
+          # This can be used to register new adapters: just append your class to the collection.
+          #
+          # @return [Array] an array of pagination adapters
+          def adapters
+            @adapters ||= []
+          end
         end
 
         # This error is raised when no adapter can be found for a collection.

data/lib/pragma/decorator/pagination.rb

@@ -37,7 +37,7 @@ module Pragma
         #
         # @see Adapter::Base#current_page
         def current_page
-          adapter.current_page
+          pagination_adapter.current_page
         end
 
         # Returns the next page of the collection.
@@ -46,7 +46,7 @@ module Pragma
         #
         # @see Adapter::Base#next_page
         def next_page
-          adapter.next_page
+          pagination_adapter.next_page
         end
 
         # Returns the number of items per page in the collection.
@@ -55,7 +55,7 @@ module Pragma
         #
         # @see Adapter::Base#per_page
         def per_page
-          adapter.per_page
+          pagination_adapter.per_page
         end
 
         # Returns the previous page of the collection.
@@ -64,7 +64,7 @@ module Pragma
         #
         # @see Adapter::Base#previous_page
         def previous_page
-          adapter.previous_page
+          pagination_adapter.previous_page
         end
 
         # Returns the total number of items in the collection.
@@ -73,7 +73,7 @@ module Pragma
         #
         # @see Adapter::Base#total_entries
         def total_entries
-          adapter.total_entries
+          pagination_adapter.total_entries
         end
 
         # Returns the total number of pages in the collection.
@@ -82,13 +82,13 @@ module Pragma
         #
         # @see Adapter::Base#total_pages
         def total_pages
-          adapter.total_pages
+          pagination_adapter.total_pages
         end
 
         private
 
-        def adapter
-          @adapter ||= Pagination::Adapter.load_for(represented)
+        def pagination_adapter
+          @pagination_adapter ||= Pagination::Adapter.load_for(represented)
         end
       end
 

data/lib/pragma/decorator/type.rb

@@ -56,6 +56,7 @@ module Pragma
         klass
           .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .gsub('::', '/')
           .downcase
       end
     end

data/lib/pragma/decorator/version.rb

@@ -2,6 +2,6 @@
 
 module Pragma
   module Decorator
-    VERSION = '2.1.1'
+    VERSION = '2.2.0'
   end
 end

data/lib/pragma/decorator.rb

@@ -16,10 +16,10 @@ require 'pragma/decorator/timestamp'
 require 'pragma/decorator/type'
 require 'pragma/decorator/collection'
 require 'pragma/decorator/pagination'
+require 'pragma/decorator/pagination/adapter'
 require 'pragma/decorator/pagination/adapter/base'
 require 'pragma/decorator/pagination/adapter/kaminari'
 require 'pragma/decorator/pagination/adapter/will_paginate'
-require 'pragma/decorator/pagination/adapter'
 
 module Pragma
   # Represent your API resources in JSON with minimum hassle.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pragma-decorator
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-15 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: Convert your API resources into JSON with minimum hassle.