pragma-decorator 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ff5939aba8c33bfd6bce0dfe784392ec89b0905
-  data.tar.gz: 24b7825e2c07df12ef69089d7ee854a1bcbcc408
+  metadata.gz: e8cbfb161f363349668460111a7fb2f5936b400a
+  data.tar.gz: 1e49a4456a7d4aaf2a01d217f3fb52538e49fa86
 SHA512:
-  metadata.gz: cf9c5241c0107a425dbe86bd802f46ac25c698b219ace26187aa1b5a744ecf18fbbf230ea090f59799964e1c7c632980e2488f9c779a5bae25880f5f8d45ffb1
-  data.tar.gz: 3e6a9cfbfaca8868c8f2f39a9be3978f2e5319c4f7b2e5ac7357413bc2372d83ca6450e0bf800e98e98fe1ab66b71005784c54fe111ce159e041823f89fbb0be
+  metadata.gz: ff52579a206fea38b5333c74b84589a579c5b1d0886f633848635fc61a28f6f178176ac609c7a0a53bff1683e173b6652a4628d54c767a3a86be00abbb763f37
+  data.tar.gz: 666eb32eb1ba858e3659ee403af8a40432ef623292f2a7e3ff0fc53ee2c9a023f0256f3ee30043d33c3d346c971c384751a798b124656adf27ed422e10e41815

data/.rubocop.yml

@@ -85,3 +85,13 @@ Metrics/CyclomaticComplexity:
 
 Metrics/BlockLength:
   Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - 'pragma-decorator.gemspec'

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Pragma
   module Decorator
     module Association
@@ -20,6 +21,8 @@ module Pragma
         def initialize(reflection:, decorator:)
           @reflection = reflection
           @decorator = decorator
+
+          check_type_consistency
         end
 
         # Returns the associated object.
@@ -28,18 +31,52 @@ module Pragma
         def associated_object
           case reflection.options[:exec_context]
           when :decorated
-            decorator.decorated.send(reflection.property)
+            model.public_send(reflection.property)
           when :decorator
-            decorator.send(reflection.property)
+            decorator.public_send(reflection.property)
           end
         end
 
+        # Returns whether the association belongs to the model.
+        #
+        # @return [Boolean]
+        def model_context?
+          reflection.options[:exec_context].to_sym == :decorated
+        end
+
+        # Returns whether the association belongs to the decorator.
+        #
+        # @return [Boolean]
+        def decorator_context?
+          reflection.options[:exec_context].to_sym == :decorator
+        end
+
         # Returns the unexpanded value for the associated object (i.e. its +id+ property).
         #
         # @return [String]
         def unexpanded_value
-          return unless associated_object
-          associated_object.id
+          if decorator_context? || model_reflection.nil?
+            return associated_object&.public_send(associated_object.class.primary_key)
+          end
+
+          case reflection.type
+          when :belongs_to
+            model.public_send(model_reflection.foreign_key)
+          when :has_one
+            if model.association(reflection.property).loaded?
+              return associated_object&.public_send(associated_object.class.primary_key)
+            end
+
+            pk = model.public_send(model_reflection.active_record_primary_key)
+
+            model_reflection
+              .klass
+              .where(model_reflection.foreign_key => pk)
+              .pluck(model_reflection.klass.primary_key)
+              .first
+          else
+            associated_object&.public_send(associated_object.class.primary_key)
+          end
         end
 
         # Returns the expanded value for the associated object.
@@ -116,6 +153,36 @@ module Pragma
             reflection.options[:decorator]
           end
         end
+
+        def model
+          decorator.decorated
+        end
+
+        def model_reflection
+          # rubocop:disable Metrics/LineLength
+          @model_reflection ||= if Object.const_defined?('ActiveRecord') && model.is_a?(ActiveRecord::Base)
+            model.class.reflect_on_association(reflection.property)
+          end
+          # rubocop:enable Metrics/LineLength
+        end
+
+        def model_association_type
+          return unless model_reflection
+
+          if Object.const_defined?('ActiveRecord') && model.is_a?(ActiveRecord::Base)
+            model_reflection.macro
+          end
+        end
+
+        def check_type_consistency
+          return if !model_association_type || model_association_type == reflection.type
+
+          fail InconsistentTypeError.new(
+            decorator: decorator,
+            reflection: reflection,
+            model_type: model_association_type
+          )
+        end
       end
     end
   end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pragma
+  module Decorator
+    module Association
+      # This error is raised when an association's type is different from its type as reported by
+      # the model's reflection.
+      #
+      # @author Alessandro Desantis
+      class InconsistentTypeError < StandardError
+        # Initializes the error.
+        #
+        # @param decorator [Base] the decorator where the association is defined
+        # @param reflection [Reflection] the reflection of the inconsistent association
+        # @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
+            the model, but as #{reflection.type} in the decorator.
+          MSG
+
+          super message
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Pragma
   module Decorator
     module Association
@@ -50,14 +51,14 @@ module Pragma
           @options = {
             expandable: false,
             render_nil: false,
-            exec_context: :decorated
+            exec_context: :decorated,
           }.merge(options).tap do |opts|
             opts[:exec_context] = opts[:exec_context].to_sym
           end
         end
 
         def validate_options
-          return if [:decorator, :decorated].include?(options[:exec_context])
+          return if %i[decorator decorated].include?(options[:exec_context])
 
           fail(
             ArgumentError,

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Pragma
   module Decorator
     module Association

data/lib/pragma/decorator/association.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Pragma
   module Decorator
     # Adds association expansion to decorators.
@@ -63,11 +64,13 @@ module Pragma
         end
 
         def create_association_getter(property)
-          class_eval <<~RUBY
+          code = <<~RUBY
             def _#{property}_association
               @association_bindings[:#{property}].render(user_options[:expand])
             end
           RUBY
+
+          class_eval code, __FILE__, __LINE__
         end
 
         def create_association_property(property_name)

data/lib/pragma/decorator/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'roar/decorator'
 require 'roar/json'
 

data/lib/pragma/decorator/timestamp.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Pragma
   module Decorator
     # Supports rendering timestamps as UNIX times.

data/lib/pragma/decorator/type.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Pragma
   module Decorator
     # Adds a +type+ property containing the machine-readable type of the represented object.

data/lib/pragma/decorator/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module Pragma
   module Decorator
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'
   end
 end

data/lib/pragma/decorator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'roar'
 
 require 'pragma/decorator/version'
@@ -7,6 +8,7 @@ require 'pragma/decorator/association'
 require 'pragma/decorator/association/reflection'
 require 'pragma/decorator/association/binding'
 require 'pragma/decorator/association/unexpandable_error'
+require 'pragma/decorator/association/inconsistent_type_error'
 require 'pragma/decorator/timestamp'
 require 'pragma/decorator/type'
 

data/pragma-decorator.gemspec

@@ -1,4 +1,6 @@
-# coding: utf-8
+
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pragma/decorator/version'
@@ -20,13 +22,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'roar', '~> 1.0'
   spec.add_dependency 'multi_json', '~> 1.12'
+  spec.add_dependency 'roar', '~> 1.0'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'coveralls'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: pragma-decorator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2018-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: roar
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: roar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -146,6 +146,7 @@ files:
 - lib/pragma/decorator.rb
 - lib/pragma/decorator/association.rb
 - lib/pragma/decorator/association/binding.rb
+- lib/pragma/decorator/association/inconsistent_type_error.rb
 - lib/pragma/decorator/association/reflection.rb
 - lib/pragma/decorator/association/unexpandable_error.rb
 - lib/pragma/decorator/base.rb
@@ -173,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Convert your API resources into JSON with minimum hassle.