azeroth 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75366fe54c6684c1e58e55ced58c72570a211ba6e463c46d06504bc8b803a667
-  data.tar.gz: 45548e777bf55688478af05716b200421c7629b6542222a4abab559bb24dd966
+  metadata.gz: ff267cb06b99dea008313ebf30569e33565cbbe210602b3008bd859016c28755
+  data.tar.gz: 494a34050515c0dcd7e05ecdce0151e26f089e0ae39d3c1652a38d210ec1f99d
 SHA512:
-  metadata.gz: 19602b6e52d2f20ef53c1c8f555bf9d7b55de7cd898fe201b91fdd6afd5714ad9c9ec1ffaa4136219180e6631f94440bfaea3bc449ea9031e79691f281caae49
-  data.tar.gz: 9f02bc1df351a23f01bd964ffda1d51169dd84e25b4835847b4a709e6efab9ce08612407de771371d90280d6c029a0a2f49613d5dad2d1be40ced130f1d649f3
+  metadata.gz: 1e89465dc060b9ab4a0b9a6c95e6b2cb054ab08efd32ebf312bbe94f751f5d505f20230632e8435d0de57898f9bbd9875215fd23c59f51a1de6516a2bfb0e273
+  data.tar.gz: fe6c480bc37d5e03ea61eb22df4c66154537fca6917d671e19fac1ce7bdf5de5051dfd736de0c7529ffa240512f615bd5a1c1a2e5ed285a3326956bd59758dd4

data/README.md

@@ -11,4 +11,4 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/0.6.2](https://www.rubydoc.info/gems/azeroth/0.6.2)
+[https://www.rubydoc.info/gems/azeroth/0.6.3](https://www.rubydoc.info/gems/azeroth/0.6.3)

data/config/yardstick.yml

@@ -25,6 +25,7 @@ rules:
     exclude:
       - Azeroth::Decorator#initialize
       - Azeroth::Decorator::HashBuilder#initialize
+      - Azeroth::Decorator::KeyValueExtractor#initialize
       - Azeroth::DummyDecorator#initialize
       - Azeroth::Exception::InvalidOptions#initialize
       - Azeroth::Model#initialize

data/lib/azeroth/decorator.rb

@@ -40,8 +40,9 @@ module Azeroth
   #                     #   'pokemon' => 'Arcanine'
   #                     # }
   class Decorator
-    autoload :HashBuilder, 'azeroth/decorator/hash_builder'
-    autoload :Options,     'azeroth/decorator/options'
+    autoload :HashBuilder,       'azeroth/decorator/hash_builder'
+    autoload :KeyValueExtractor, 'azeroth/decorator/key_value_extractor'
+    autoload :Options,           'azeroth/decorator/options'
 
     class << self
       # @api private
@@ -76,10 +77,11 @@ module Azeroth
       # Expose attributes on json decorated
       #
       # @param attribute [Symbol,String] attribute to be exposed
-      # @param options [Hash] exposing options
-      # @option options as [Symbol,String] custom key
+      # @param options_hash [Hash] exposing options
+      # @option options_hash as [Symbol,String] custom key
       #   to expose
-      # @option options if [Symbol,Proc] method/block to be called
+      # @option options_hash if [Symbol,Proc] method/block
+      #   to be called
       #   checking if an attribute should or should not
       #   be exposed
       #

data/lib/azeroth/decorator/hash_builder.rb

@@ -24,10 +24,10 @@ module Azeroth
       #
       # @return [Hash]
       def as_json
-        attributes_map.each do |method, options|
-          add_attribute(method, options)
+        attributes_map.inject({}) do |hash, (method, options)|
+          new_hash = KeyValueExtractor.new(decorator, method, options).as_json
+          hash.merge!(new_hash)
         end
-        hash
       end
 
       private
@@ -41,57 +41,6 @@ module Azeroth
       #
       # @return [Decorator]
 
-      # Adds an attribute to the exposed hash
-      #
-      # @param method [Symbol,String] method to be called
-      #   from the decorator
-      # @param options [Hash] exposing options
-      # @option options as [Symbol,String] custom key
-      #   to expose
-      # @option options if [Symbol,Proc] method/block to be called
-      #   checking if an attribute should or should not
-      #   be exposed
-      #
-      # @return [Object] result of method call from decorator
-      def add_attribute(method, options)
-        return unless add_attribute?(options)
-
-        key = options.as || method
-
-        hash[key.to_s] = json_for(method)
-      end
-
-      def json_for(method)
-        value = decorator.public_send(method)
-
-        decorator_class_for(value).new(value).as_json
-      end
-
-      def decorator_class_for(value)
-        return value.class::Decorator unless value.is_a?(Enumerable)
-
-        decorator_class_for(value.first)
-      rescue NameError
-        Azeroth::DummyDecorator
-      end
-
-      # Check if an attribute should be added to the hash
-      #
-      # @param options [Hash] exposing options
-      # @option options if [Symbol,Proc] method/block to be called
-      #   checking if an attribute should or should not
-      #   be exposed
-      #
-      # @return [Object] result of method call from decorator
-      def add_attribute?(options)
-        conditional = options.if
-        return true unless conditional.present?
-
-        block = proc(&conditional)
-
-        block.call(decorator)
-      end
-
       # attributes to be built to hash
       #
       # The keys are the methods to be called and
@@ -101,13 +50,6 @@ module Azeroth
       def attributes_map
         decorator.class.attributes_map
       end
-
-      # Hash being built
-      #
-      # @return [Hash]
-      def hash
-        @hash ||= {}
-      end
     end
   end
 end

data/lib/azeroth/decorator/key_value_extractor.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class Decorator
+    # @api private
+    #
+    # Class responsible to extract the value for an attribute
+    #
+    # The value is extracted by sending a method
+    # call to the decorator
+    #
+    # A decorator is infered for the value / attribute
+    # or used from the options given
+    class KeyValueExtractor
+      # @param decorator [Decorator] decorator object
+      # @param attribute [Symbol] attribute to be used on output hash
+      # @param options [Decorator::Options] decoration options
+      # @option options if [Proc,Symbol] conditional to be
+      #   checked when exposing field
+      #   (see {Decorator::Options#if})
+      def initialize(decorator, attribute, options)
+        @decorator = decorator
+        @attribute = attribute
+        @options = options
+      end
+
+      # Return hash for attribute
+      #
+      # @return [Hash] hash in the format
+      #   +{ attribute => decorated_value }+
+      def as_json
+        return {} unless add_attribute?
+
+        key = options.as || attribute
+
+        {
+          key.to_s => json_value
+        }
+      end
+
+      # private
+
+      attr_reader :decorator, :attribute, :options
+      # @method decorator
+      # @api private
+      # @private
+      #
+      # decorator with object to be decorated
+      #
+      # @return [Decorator]
+
+      # @method attribute
+      # @api private
+      # @private
+      #
+      # attribute to be exposed
+      #
+      # @return [Symbol]
+
+      # @method options
+      # @api private
+      # @private
+      #
+      # exposing options
+      #
+      # @return [Decorator::Options]
+
+      # @private
+      #
+      # returns the value ready to be transformed into json
+      #
+      # @return [Object]
+      def json_value
+        decorator_class(value).new(value).as_json
+      end
+
+      # @private
+      # Retruns the value extracted from decorator
+      #
+      # @return [Object]
+      def value
+        @value ||= decorator.public_send(attribute)
+      end
+
+      # @private
+      #
+      # Finds the correct decorator class for a value
+      #
+      # @return [Class<Decorator>]
+      def decorator_class(object)
+        decorator_from_options || decorator_class_for(object)
+      end
+
+      # @private
+      #
+      # returns decorator defined in options
+      #
+      # @return [Class<Decorator>, NilClass]
+      def decorator_from_options
+        return options.decorator if options.decorator
+
+        Azeroth::DummyDecorator unless options.any_decorator?
+      end
+
+      # @private
+      #
+      # Finds the correct decorator class for a value
+      #
+      # @return [Class<Decorator>]
+      def decorator_class_for(object)
+        return object.class::Decorator unless object.is_a?(Enumerable)
+
+        decorator_class_for(object.first)
+      rescue NameError
+        Azeroth::DummyDecorator
+      end
+
+      # @private
+      #
+      # Check if an attribute should be added to the hash
+      #
+      # @return [Object] result of method call from decorator
+      def add_attribute?
+        conditional = options.if
+        return true unless conditional.present?
+
+        block = proc(&conditional)
+
+        block.call(decorator)
+      end
+    end
+  end
+end

data/lib/azeroth/decorator/options.rb

@@ -12,14 +12,14 @@ module Azeroth
     class Options < Sinclair::Options
       DEFAULT_OPTIONS = {
         as: nil,
-        if: nil
+        if: nil,
+        decorator: nil
       }.freeze
 
       with_options DEFAULT_OPTIONS
 
       # @method as
       # @api private
-      # @public
       #
       # key to use when exposing the field
       #
@@ -29,17 +29,42 @@ module Azeroth
 
       # @method if
       # @api private
-      # @public
       #
       # conditional to be checked when exposing field
       #
       # when conditional returns false, the
       # field will not be exposed
       #
-      # when if is a {Proc} the proc will be used,
-      # when it is a {Symbol} or {String} this will be
+      # when if is a Proc the proc will be used,
+      # when it is a Symbol or String this will be
       # the name of the method called in the decorator
       # to evaluate the condition
+      #
+      # @return [Proc,Symbol]
+
+      # @method decorator
+      # @api private
+      #
+      # Decorator class to decorate the value
+      #
+      # when false {DummyDecorator} will be used
+      #
+      # when nil, a decorator will be infered from
+      # value::Decorator
+      #
+      # @return [NilClass,Decorator]
+
+      # @api private
+      #
+      # Returns true when attribute must can be decorated
+      #
+      # when false, decoration happens through
+      # #as_json call on value
+      #
+      # @return [TrueClass,FalseClass]
+      def any_decorator?
+        decorator != false
+      end
     end
   end
 end

data/lib/azeroth/dummy_decorator.rb

@@ -10,7 +10,6 @@ module Azeroth
   class DummyDecorator
     delegate :as_json, to: :@object
     # @method as_json
-    # @public
     # @api public
     #
     # Returns object.as_json

data/lib/azeroth/options.rb

@@ -27,7 +27,6 @@ module Azeroth
 
     # @method only
     # @api private
-    # @public
     #
     # filter of only actions to be built
     #
@@ -35,7 +34,6 @@ module Azeroth
 
     # @method except
     # @api private
-    # @public
     #
     # actions to be ignored
     #
@@ -43,7 +41,6 @@ module Azeroth
 
     # @method decorator
     # @api private
-    # @public
     #
     # decorator class to be used
     #

data/lib/azeroth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Azeroth
-  VERSION = '0.6.2'
+  VERSION = '0.6.3'
 end

data/spec/dummy/app/models/factory/decorator_with_product.rb

@@ -3,7 +3,7 @@
 class Factory
   class DecoratorWithProduct < Azeroth::Decorator
     expose :name
-    expose :main_product
+    expose :main_product, decorator: Product::DecoratorWithFactory
     expose :products
   end
 end

data/spec/dummy/app/models/id_decorator.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class IdDecorator < Azeroth::Decorator
+  expose :id
+end

data/spec/lib/azeroth/decorator/key_value_extractor_spec.rb

@@ -0,0 +1,231 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::Decorator::KeyValueExtractor do
+  subject(:extractor) do
+    described_class.new(decorator, attribute, options)
+  end
+
+  let(:decorator_class) { Class.new(Azeroth::Decorator) }
+  let(:decorator)       { decorator_class.new(object) }
+  let(:object)          { create(:document) }
+  let(:attribute)       { :name }
+  let(:options_hash)    { {} }
+  let(:options) do
+    Azeroth::Decorator::Options.new(options_hash)
+  end
+
+  describe '#as_json' do
+    context 'with default options' do
+      it 'returns attribute and value as hash' do
+        expect(extractor.as_json)
+          .to eq({ 'name' => object.name })
+      end
+    end
+
+    context 'when value is a collection' do
+      let(:options_hash) { { decorator: false } }
+      let(:object)    { create(:factory) }
+      let(:attribute) { :products }
+
+      let!(:products) do
+        create_list(:product, 3, factory: object)
+      end
+
+      let(:expected) do
+        {
+          'products' => products.as_json
+        }
+      end
+
+      it 'returns value as array' do
+        expect(extractor.as_json)
+          .to eq(expected)
+      end
+
+      context 'with custom decorator option' do
+        let(:options_hash) { { decorator: IdDecorator } }
+        let(:expected) do
+          {
+            'products' => [
+              { 'id' => products[0].id },
+              { 'id' => products[1].id },
+              { 'id' => products[2].id }
+            ]
+          }
+        end
+
+        it 'returns value as array' do
+          expect(extractor.as_json)
+            .to eq(expected)
+        end
+      end
+    end
+
+    context "with 'as' option" do
+      let(:options_hash) { { as: :the_name } }
+
+      it 'uses new given key' do
+        expect(extractor.as_json)
+          .to eq({ 'the_name' => object.name })
+      end
+    end
+
+    context "with 'if' option" do
+      context 'with symbol for method returns true' do
+        let(:options_hash)    { { if: :magic? } }
+        let(:decorator_class) { Document::Decorator }
+        let(:object) do
+          create(:document, reference: 'X-MAGIC-1')
+        end
+
+        it 'returns attribute and value as hash' do
+          expect(extractor.as_json)
+            .to eq({ 'name' => object.name })
+        end
+      end
+
+      context 'with symbol for method returns false' do
+        let(:options_hash)    { { if: :magic? } }
+        let(:decorator_class) { Document::Decorator }
+
+        it do
+          expect(extractor.as_json)
+            .to be_a(Hash)
+        end
+
+        it do
+          expect(extractor.as_json)
+            .to be_empty
+        end
+      end
+
+      context 'with Proc resolving to true' do
+        let(:options_hash) do
+          {
+            if: proc do |decorator|
+              decorator.name == object.name
+            end
+          }
+        end
+
+        it do
+          expect(extractor.as_json)
+            .to eq({ 'name' => object.name })
+        end
+      end
+
+      context 'with Proc resolving to false' do
+        let(:options_hash) do
+          {
+            if: proc do |decorator|
+              decorator.name != object.name
+            end
+          }
+        end
+
+        it do
+          expect(extractor.as_json)
+            .to be_a(Hash)
+        end
+
+        it do
+          expect(extractor.as_json)
+            .to be_empty
+        end
+      end
+    end
+
+    context 'when value is an object that can be decorated' do
+      context 'when it has decorator' do
+        let(:object)    { create(:factory) }
+        let!(:product)  { create(:product, factory: object) }
+        let(:attribute) { :main_product }
+        let(:expected) do
+          {
+            'main_product' => {
+              'name' => product.name
+            }
+          }
+        end
+
+        it 'exposes value with default decorator' do
+          expect(extractor.as_json)
+            .to eq(expected)
+        end
+      end
+
+      context 'when it has decorator and false decorator is given' do
+        let(:object)           { create(:factory) }
+        let!(:product)         { create(:product, factory: object) }
+        let(:attribute)        { :main_product }
+        let(:options_hash)     { { decorator: false } }
+
+        let(:expected) do
+          {
+            'main_product' => product.as_json
+          }
+        end
+
+        it 'expose decorated value' do
+          expect(extractor.as_json)
+            .to eq(expected)
+        end
+      end
+
+      context 'when it has decorator and cusom decorator is given' do
+        let(:object)           { create(:factory) }
+        let!(:product)         { create(:product, factory: object) }
+        let(:attribute)        { :main_product }
+        let(:custom_decorator) { IdDecorator }
+        let(:options_hash)     { { decorator: custom_decorator } }
+
+        let(:expected) do
+          {
+            'main_product' => {
+              'id' => product.id
+            }
+          }
+        end
+
+        it 'expose decorated value' do
+          expect(extractor.as_json)
+            .to eq(expected)
+        end
+      end
+
+      context 'when it has no decorator' do
+        let(:object)    { create(:product) }
+        let(:factory)   { object.factory }
+        let(:attribute) { :factory }
+
+        it 'exposes value as json' do
+          expect(extractor.as_json)
+            .to eq({ 'factory' => factory.as_json })
+        end
+      end
+
+      context 'when it has no decorator and cusom decorator is given' do
+        let(:object)           { create(:product) }
+        let(:factory)          { object.factory }
+        let(:attribute)        { :factory }
+        let(:custom_decorator) { IdDecorator }
+        let(:options_hash)     { { decorator: custom_decorator } }
+
+        let(:expected) do
+          {
+            'factory' => {
+              'id' => factory.id
+            }
+          }
+        end
+
+        it 'expose decorated value' do
+          expect(extractor.as_json)
+            .to eq(expected)
+        end
+      end
+    end
+  end
+end

data/spec/lib/azeroth/decorator_spec.rb

@@ -224,7 +224,7 @@ describe Azeroth::Decorator do
         end
       end
 
-      context 'when relation object has decorator' do
+      context 'when relation object has decorator and defined decorator' do
         subject(:decorator) do
           Factory::DecoratorWithProduct.new(factory)
         end
@@ -240,7 +240,8 @@ describe Azeroth::Decorator do
           {
             name: factory.name,
             main_product: {
-              name: main_product.name
+              name: main_product.name,
+              factory: factory.as_json
             },
             products: [{
               name: main_product.name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-03 00:00:00.000000000 Z
+date: 2020-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -416,6 +416,7 @@ files:
 - lib/azeroth.rb
 - lib/azeroth/decorator.rb
 - lib/azeroth/decorator/hash_builder.rb
+- lib/azeroth/decorator/key_value_extractor.rb
 - lib/azeroth/decorator/options.rb
 - lib/azeroth/dummy_decorator.rb
 - lib/azeroth/model.rb
@@ -464,6 +465,7 @@ files:
 - spec/dummy/app/models/dummy_model/decorator.rb
 - spec/dummy/app/models/factory.rb
 - spec/dummy/app/models/factory/decorator_with_product.rb
+- spec/dummy/app/models/id_decorator.rb
 - spec/dummy/app/models/product.rb
 - spec/dummy/app/models/product/decorator.rb
 - spec/dummy/app/models/product/decorator_with_factory.rb
@@ -519,6 +521,7 @@ files:
 - spec/dummy/tmp/storage/.keep
 - spec/integration/yard/azeroth/decorator_spec.rb
 - spec/lib/azeroth/decorator/hash_builder_spec.rb
+- spec/lib/azeroth/decorator/key_value_extractor_spec.rb
 - spec/lib/azeroth/decorator_spec.rb
 - spec/lib/azeroth/dummy_decorator_spec.rb
 - spec/lib/azeroth/model_spec.rb
@@ -601,6 +604,7 @@ test_files:
 - spec/dummy/app/models/dummy_model/decorator.rb
 - spec/dummy/app/models/factory.rb
 - spec/dummy/app/models/factory/decorator_with_product.rb
+- spec/dummy/app/models/id_decorator.rb
 - spec/dummy/app/models/product.rb
 - spec/dummy/app/models/product/decorator.rb
 - spec/dummy/app/models/product/decorator_with_factory.rb
@@ -656,6 +660,7 @@ test_files:
 - spec/dummy/tmp/storage/.keep
 - spec/integration/yard/azeroth/decorator_spec.rb
 - spec/lib/azeroth/decorator/hash_builder_spec.rb
+- spec/lib/azeroth/decorator/key_value_extractor_spec.rb
 - spec/lib/azeroth/decorator_spec.rb
 - spec/lib/azeroth/dummy_decorator_spec.rb
 - spec/lib/azeroth/model_spec.rb