pragma-decorator 2.2.4 → 2.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a95d2a912a1328c91c7ba4bd2cb023ebe3772bf67900fed17e7e6119a0e4a1a
-  data.tar.gz: 6fe2f0c3e0a87767d25f31e06b4fa8d3dd00fa420456c98f9b47ddb3ee0185a3
+  metadata.gz: 98b91700778dde7caf78fca62ad944dd136d8c2ce8d48bb598b085ad8567c741
+  data.tar.gz: 9d428e1e9e9c0c6eb00a0e128728da271375d939c60230fe67f7c62466086cc2
 SHA512:
-  metadata.gz: 4764e283b3fc8f3d5528f648096a4684dba6f322c0fb59f6a6da32399cfe7bf1c1d56ab9b57e0c6dffa5f658f3dfc17a5509d988adcea15091fb439f0be29101
-  data.tar.gz: 1fd589f81ff1e00d7e01ba98fb19ef10a812096ac10e471fe707000f7b71d7feb3604298889b8013503cc418d6c86fcd321578ee9a290cf064d989be0c1ebbc7
+  metadata.gz: 72b88fd97948adf0f682469ab5854cb302fd967d09da55afc04974d5a2200748dbf70d36699b810eb4d9999723b72e7088d5a0074846b64d17639ad6167becdb
+  data.tar.gz: c7c96cce6da9dff0946e003a0ab990013ccf1dfc02e77656b31e4ebd747007e79341c7fc8d042f981c14e8e3d6cc80e6a0dc6ce345bb9fec8fd58d43dc7c71bb

data/.rubocop.yml

@@ -1,10 +1,11 @@
 require: rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
   Include:
     - '**/Gemfile'
     - '**/Rakefile'
+    - '**/*.rb'
   Exclude:
    - 'bin/*'
    - 'db/**/*'
@@ -53,7 +54,7 @@ Style/SignalException:
 Style/BracesAroundHashParameters:
   EnforcedStyle: context_dependent
 
-Lint/EndAlignment:
+Layout/EndAlignment:
   EnforcedStyleAlignWith: variable
   AutoCorrect: true
 

data/CHANGELOG.md

@@ -7,11 +7,24 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.2.6]
+
+### Fixed
+
+- Fixed an issue with association definition
+
+## [2.2.5] (yanked)
+
+### Fixed
+
+- Fixed the expansion of associations with custom names requiring the original name to be used
+
 ## [2.2.4]
 
 ### Fixed
 
-- Fixed an issue where expanding a property would expand properties with the same name in associated objects
+- Fixed an issue where expanding a property would expand properties with the same name in associated 
+  objects
 
 ## [2.2.3]
 
@@ -80,7 +93,9 @@ 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.2.4...HEAD
+[Unreleased]: https://github.com/pragmarb/pragma-decorator/compare/v2.2.6...HEAD
+[2.2.6]: https://github.com/pragmarb/pragma-decorator/compare/v2.2.5...v2.2.6
+[2.2.5]: https://github.com/pragmarb/pragma-decorator/compare/v2.2.4...v2.2.5
 [2.2.4]: https://github.com/pragmarb/pragma-decorator/compare/v2.2.3...v2.2.4
 [2.2.3]: https://github.com/pragmarb/pragma-decorator/compare/v2.2.2...v2.2.3
 [2.2.2]: https://github.com/pragmarb/pragma-decorator/compare/v2.2.1...v2.2.2

data/README.md

@@ -96,7 +96,7 @@ This would result in the following representation:
 ```json
 {
   "type": "user",
-  "...": "...""
+  "...": "..."
 }
 ```
 
@@ -167,7 +167,7 @@ module API
         class Instance < Pragma::Decorator::Base
           include Pragma::Decorator::Association
 
-          belongs_to :customer, decorator: API::V1::Customer::Decorator
+          belongs_to :customer, decorator: API::V1::Customer::Decorator::Instance
         end
       end
     end
@@ -211,7 +211,26 @@ decorator.to_json(user_options: {
 Needless to say, this is done automatically for you when you use all components together through
 the [pragma](https://github.com/pragmarb/pragma) gem! :)
 
-Associations support all the options supported by `#property`.
+Associations support all the options supported by `#property`. Additionally, `decorator` can be a
+callable object, which is useful for polymorphic associations:
+
+```ruby
+module API
+  module V1
+    module Discount
+      module Decorator
+        class Instance < Pragma::Decorator::Base
+          include Pragma::Decorator::Association
+
+          belongs_to :discountable, decorator: -> (discountable) {
+            "API::V1::#{discountable.class}::Decorator::Instance".constantize
+          }
+        end
+      end
+    end
+  end
+end
+```
 
 ### Collection
 

data/lib/pragma/decorator/association.rb

@@ -39,10 +39,10 @@ module Pragma
         #
         # This method supports all the usual options accepted by +#property+.
         #
-        # @param property_name [Symbol] name of the association
+        # @param attribute_name [Symbol] name of the association
         # @param options [Hash] the association's options
-        def belongs_to(property_name, options = {})
-          define_association :belongs_to, property_name, options
+        def belongs_to(attribute_name, options = {})
+          define_association :belongs_to, attribute_name, options
         end
 
         # Defines a +has_one+ association on this decorator.
@@ -52,36 +52,43 @@ module Pragma
         #
         # This method supports all the usual options accepted by +#property+.
         #
-        # @param property_name [Symbol] name of the association
+        # @param attribute_name [Symbol] name of the association
         # @param options [Hash] the association's options
-        def has_one(property_name, options = {}) # rubocop:disable Naming/PredicateName
-          define_association :has_one, property_name, options
+        def has_one(attribute_name, options = {}) # rubocop:disable Naming/PredicateName
+          define_association :has_one, attribute_name, options
         end
 
         private
 
-        def define_association(type, property_name, options = {})
-          create_association_definition(type, property_name, options)
-          create_association_property(type, property_name, options)
+        def define_association(type, attribute_name, options = {})
+          create_association_definition(type, attribute_name, options)
+          create_association_property(attribute_name, options)
         end
 
-        def create_association_definition(type, property_name, options)
-          associations[property_name.to_sym] = Reflection.new(type, property_name, options)
+        def create_association_definition(type, attribute_name, options)
+          association_name = options.fetch(:as, attribute_name.to_sym)
+          associations[association_name] = Reflection.new(options.merge(
+            type: type,
+            name: association_name,
+            attribute: attribute_name
+          ))
         end
 
-        def create_association_property(_type, property_name, options)
+        def create_association_property(attribute_name, options)
+          association_name = options.fetch(:as, attribute_name.to_sym)
+
           property_options = options.dup.tap { |po| po.delete(:decorator) }.merge(
             exec_context: :decorator,
-            as: options[:as] || property_name,
+            as: options[:as] || attribute_name,
             getter: (lambda do |decorator:, user_options:, **_args|
               Bond.new(
-                reflection: decorator.class.associations[property_name],
+                reflection: decorator.class.associations[association_name],
                 decorator: decorator
               ).render(user_options)
             end)
           )
 
-          property("_#{property_name}_association", property_options)
+          property("_#{association_name}_association", property_options)
         end
       end
 

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

@@ -97,7 +97,7 @@ module Pragma
               association_reflection.association_primary_key
             end
 
-            if model.association(reflection.property).loaded?
+            if model.association(reflection.attribute).loaded?
               return associated_object&.public_send(primary_key)
             end
 
@@ -112,7 +112,7 @@ module Pragma
           end
 
           def compute_has_one_fk
-            if model.association(reflection.property).loaded?
+            if model.association(reflection.attribute).loaded?
               return associated_object&.public_send(association_reflection.association_primary_key)
             end
 
@@ -133,7 +133,7 @@ module Pragma
           end
 
           def association_reflection
-            @association_reflection ||= model.class.reflect_on_association(reflection.property)
+            @association_reflection ||= model.class.reflect_on_association(reflection.attribute)
           end
 
           def check_type_consistency

data/lib/pragma/decorator/association/bond.rb

@@ -29,9 +29,9 @@ module Pragma
         def associated_object
           case reflection.options[:exec_context]
           when :decorated
-            model.public_send(reflection.property)
+            model.public_send(reflection.attribute)
           when :decorator
-            decorator.public_send(reflection.property)
+            decorator.public_send(reflection.attribute)
           end
         end
 
@@ -81,7 +81,7 @@ module Pragma
         #
         # @return [Hash|Pragma::Decorator::Base]
         def render(user_options)
-          if user_options[:expand]&.any? { |value| value.to_s == reflection.property.to_s }
+          if user_options[:expand]&.any? { |value| value.to_s == reflection.name.to_s }
             expanded_value(user_options)
           else
             unexpanded_value
@@ -104,7 +104,7 @@ module Pragma
         def flatten_expand(expand)
           expand ||= []
 
-          expected_beginning = "#{reflection.property}."
+          expected_beginning = "#{reflection.name}."
 
           expand.select { |value| value.start_with?(expected_beginning) }.map do |value|
             value.sub(expected_beginning, '')

data/lib/pragma/decorator/association/errors.rb

@@ -55,7 +55,7 @@ module Pragma
         # @param model_type [Symbol|String] the real type of the association
         def initialize(decorator:, reflection:, model_type:)
           message = <<~MSG.tr("\n", ' ')
-            #{decorator.class}: Association #{reflection.property} is defined as #{model_type} on
+            #{decorator.class}: Association #{reflection.attribute} is defined as #{model_type} on
             the model, but as #{reflection.type} in the decorator.
           MSG
 

data/lib/pragma/decorator/association/reflection.rb

@@ -10,17 +10,20 @@ module Pragma
         # @!attribute [r] type
         #   @return [Symbol] the type of the association
         #
-        # @!attribute [r] property
-        #   @return [Symbol] the property holding the associated object
+        # @!attribute [r] name
+        #   @return [Symbol] the name of the association property
+        #
+        # @!attribute [r] attribute
+        #   @return [Symbol] the attribute holding the associated object
         #
         # @!attribute [r] options
         #   @return [Hash] additional options for the association
-        attr_reader :type, :property, :options
+        attr_reader :type, :name, :attribute, :options
 
         # Initializes the association.
         #
         # @param type [Symbol] the type of the association
-        # @param property [Symbol] the property holding the associated object
+        # @param attribute [Symbol] the attribute holding the associated object
         # @param options [Hash] additional options
         #
         # @option options [Class|Proc] :decorator the decorator to use for the associated object
@@ -28,9 +31,10 @@ module Pragma
         # @option options [Boolean] :render_nil (`true`) whether to render a +nil+ association
         # @option options [Symbol] :exec_context (`decorated`) whether to call the getter on the
         #   decorator (+decorator+) or the decorated object (+decorated+)
-        def initialize(type, property, **options)
+        def initialize(type:, name:, attribute:, **options)
           @type = type
-          @property = property
+          @name = name
+          @attribute = attribute
           @options = options
 
           normalize_options

data/lib/pragma/decorator/version.rb

@@ -2,6 +2,6 @@
 
 module Pragma
   module Decorator
-    VERSION = '2.2.4'
+    VERSION = '2.2.6'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pragma-decorator
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.2.6
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-09 00:00:00.000000000 Z
+date: 2018-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar