azeroth 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cdaf99f5d37798d446e0a2c73f3cfdb47de9e3c67f6eb57fde3bbb57163c852
-  data.tar.gz: 815480871c9eee75490205182da462072090e6697577e54d6e72d5212ae5d153
+  metadata.gz: 75366fe54c6684c1e58e55ced58c72570a211ba6e463c46d06504bc8b803a667
+  data.tar.gz: 45548e777bf55688478af05716b200421c7629b6542222a4abab559bb24dd966
 SHA512:
-  metadata.gz: a3a790fe5214a693590f8f9bbe1d6da897425009046fccae35097de89a4cbac1bd0be1c2257e41fc1929c29a92d500dd28db31beacb706b40d8ca357c5f943d9
-  data.tar.gz: 401a2ba4604c1f36f76f346888158cdcd067f5c4e83ed05c418781a0176ef9309b1a2b0aa691b2c45d35969b7688880a44fc2c4bed980e21237d54cb03dc7dad
+  metadata.gz: 19602b6e52d2f20ef53c1c8f555bf9d7b55de7cd898fe201b91fdd6afd5714ad9c9ec1ffaa4136219180e6631f94440bfaea3bc449ea9031e79691f281caae49
+  data.tar.gz: 9f02bc1df351a23f01bd964ffda1d51169dd84e25b4835847b4a709e6efab9ce08612407de771371d90280d6c029a0a2f49613d5dad2d1be40ced130f1d649f3

data/README.md

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

data/config/check_specs.yml

@@ -1,4 +1,5 @@
 ignore:
+  - lib/azeroth/decorator/options.rb
   - lib/azeroth/resourceable/class_methods.rb
   - lib/azeroth/resourceable.rb
   - lib/azeroth/version.rb

data/lib/azeroth.rb

@@ -12,7 +12,6 @@ require 'sinclair'
 module Azeroth
   autoload :Decorator,       'azeroth/decorator'
   autoload :DummyDecorator,  'azeroth/dummy_decorator'
-  autoload :Exception,       'azeroth/exception'
   autoload :Model,           'azeroth/model'
   autoload :RequestHandler,  'azeroth/request_handler'
   autoload :Resourceable,    'azeroth/resourceable'

data/lib/azeroth/decorator.rb

@@ -41,6 +41,7 @@ module Azeroth
   #                     # }
   class Decorator
     autoload :HashBuilder, 'azeroth/decorator/hash_builder'
+    autoload :Options,     'azeroth/decorator/options'
 
     class << self
       # @api private
@@ -101,7 +102,9 @@ module Azeroth
       #       end
       #     end
       #   end
-      def expose(attribute, **options)
+      def expose(attribute, **options_hash)
+        options = Decorator::Options.new(options_hash)
+
         builder = Sinclair.new(self)
         builder.add_method(attribute, "@object.#{attribute}")
         builder.build

data/lib/azeroth/decorator/hash_builder.rb

@@ -56,9 +56,23 @@ module Azeroth
       def add_attribute(method, options)
         return unless add_attribute?(options)
 
-        key = options[:as] || method
+        key = options.as || method
 
-        hash[key.to_s] = decorator.public_send(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
@@ -70,7 +84,7 @@ module Azeroth
       #
       # @return [Object] result of method call from decorator
       def add_attribute?(options)
-        conditional = options[:if]
+        conditional = options.if
         return true unless conditional.present?
 
         block = proc(&conditional)

data/lib/azeroth/decorator/options.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class Decorator
+    # @api private
+    # @author Darthjee
+    #
+    # Resource buiilding options for decorator
+    #
+    # @see https://www.rubydoc.info/gems/sinclair/1.6.4/Sinclair/Options
+    #   Sinclair::Options
+    class Options < Sinclair::Options
+      DEFAULT_OPTIONS = {
+        as: nil,
+        if: nil
+      }.freeze
+
+      with_options DEFAULT_OPTIONS
+
+      # @method as
+      # @api private
+      # @public
+      #
+      # key to use when exposing the field
+      #
+      # when nil, the name of the field
+      #
+      # @return [Symbol,String]
+
+      # @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
+      # the name of the method called in the decorator
+      # to evaluate the condition
+    end
+  end
+end

data/lib/azeroth/options.rb

@@ -5,7 +5,10 @@ module Azeroth
   # @author Darthjee
   #
   # Resource buiilding options
-  class Options < ::OpenStruct
+  #
+  # @see https://www.rubydoc.info/gems/sinclair/1.6.4/Sinclair/Options
+  #   Sinclair::Options
+  class Options < Sinclair::Options
     # Default options
     DEFAULT_OPTIONS = {
       only: %i[create destroy edit index new show update],
@@ -13,18 +16,7 @@ module Azeroth
       decorator: true
     }.freeze
 
-    # @param options [Hash] hash with options (see {Options::DEFAULT_OPTIONS})
-    # @option options only [Array<Symbol,String>] List of
-    #   actions to be built
-    # @option options except [Array<Symbol,String>] List of
-    #   actions to not to be built
-    # @option options decorator [Azeroth::Decorator,TrueClass,FalseClass]
-    #   Decorator class or flag allowing/disallowing decorators
-    def initialize(options = {})
-      check_options(options)
-
-      super(DEFAULT_OPTIONS.merge(options))
-    end
+    with_options DEFAULT_OPTIONS
 
     # Actions to be built
     #
@@ -33,21 +25,33 @@ module Azeroth
       [only].flatten.map(&:to_sym) - [except].flatten.map(&:to_sym)
     end
 
-    private
-
-    # @private
-    #
-    # check if given options are allowed
+    # @method only
+    # @api private
+    # @public
     #
-    # @raise Azeroth::Exception::InvalidOptions
+    # filter of only actions to be built
     #
-    # @return [NilClass]
-    def check_options(options)
-      invalid_keys = options.keys - DEFAULT_OPTIONS.keys
+    # @return [Array<String,Symbol>]
 
-      return if invalid_keys.empty?
+    # @method except
+    # @api private
+    # @public
+    #
+    # actions to be ignored
+    #
+    # @return [Array<String,Symbol>]
 
-      raise Azeroth::Exception::InvalidOptions, invalid_keys
-    end
+    # @method decorator
+    # @api private
+    # @public
+    #
+    # decorator class to be used
+    #
+    # when set as true/false, it either infer
+    # the class (model_class::Decorator) or
+    # do not use a decorator at all calling
+    # model.as_json
+    #
+    # @return [Decorator,TrueClass,FalseClass]
   end
 end

data/lib/azeroth/version.rb

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

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class Factory < ActiveRecord::Base
+  has_many :products
+  has_one :main_product, class_name: 'Product'
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Factory
+  class DecoratorWithProduct < Azeroth::Decorator
+    expose :name
+    expose :main_product
+    expose :products
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Product < ActiveRecord::Base
+  belongs_to :factory
+end

data/spec/dummy/app/models/product/decorator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Product
+  class Decorator < Azeroth::Decorator
+    expose :name
+  end
+end

data/spec/dummy/app/models/product/decorator_with_factory.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Product
+  class DecoratorWithFactory < Azeroth::Decorator
+    expose :name
+    expose :factory
+  end
+end

data/spec/dummy/db/schema.rb

@@ -13,4 +13,13 @@ ActiveRecord::Schema.define do
     t.string :email
     t.string :reference
   end
+
+  create_table :factories, force: true do |t|
+    t.string :name
+  end
+
+  create_table :products, force: true do |t|
+    t.integer :factory_id
+    t.string :name
+  end
 end

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

@@ -33,7 +33,7 @@ describe Azeroth::Decorator::HashBuilder do
           errors: {
             first_name: ["can't be blank"]
           }
-        }.stringify_keys
+        }.deep_stringify_keys
       end
 
       it 'include the conditional attributes' do

data/spec/lib/azeroth/decorator_spec.rb

@@ -8,6 +8,59 @@ describe Azeroth::Decorator do
   let(:model)  { build(:dummy_model) }
   let(:object) { model }
 
+  describe '.expose' do
+    subject(:decorator) { Class.new(described_class) }
+
+    let(:expected_options) do
+      Azeroth::Decorator::Options.new
+    end
+
+    it do
+      expect { decorator.send(:expose, :name) }
+        .to change(decorator, :attributes_map)
+        .from({})
+        .to({ name: expected_options })
+    end
+
+    it do
+      expect { decorator.send(:expose, :name) }
+        .to add_method(:name).to(decorator)
+    end
+
+    context 'when passing options' do
+      let(:expected_options) do
+        Azeroth::Decorator::Options.new(if: :valid?)
+      end
+
+      it do
+        expect { decorator.send(:expose, :name, if: :valid?) }
+          .to change(decorator, :attributes_map)
+          .from({})
+          .to({ name: expected_options })
+      end
+
+      it do
+        expect { decorator.send(:expose, :name, if: :valid?) }
+          .to add_method(:name).to(decorator)
+      end
+    end
+
+    context 'when passing invalid options' do
+      it do
+        expect { decorator.send(:expose, :name, invalid_option: :valid?) }
+          .to not_change(decorator, :attributes_map)
+          .and raise_error(Sinclair::Exception::InvalidOptions)
+      end
+
+      it do
+        expect { decorator.send(:expose, :name, invalid_option: :valid?) }
+          .to not_add_method(:name)
+          .to(decorator)
+          .and raise_error(Sinclair::Exception::InvalidOptions)
+      end
+    end
+  end
+
   describe '#as_json' do
     context 'when object is just a model' do
       let(:expected_json) do
@@ -33,7 +86,7 @@ describe Azeroth::Decorator do
             errors: {
               first_name: ["can't be blank"]
             }
-          }.stringify_keys
+          }.deep_stringify_keys
         end
 
         it 'include the conditional attributes' do
@@ -59,11 +112,11 @@ describe Azeroth::Decorator do
           {
             name: "#{model.first_name} #{model.last_name}",
             age: model.age,
-            pokemon: model.favorite_pokemon
+            pokemon: model.favorite_pokemon.to_s
           }, {
             name: "#{other_model.first_name} #{other_model.last_name}",
             age: other_model.age,
-            pokemon: other_model.favorite_pokemon
+            pokemon: other_model.favorite_pokemon.to_s
           }
         ].map(&:stringify_keys)
       end
@@ -141,7 +194,7 @@ describe Azeroth::Decorator do
             errors: {
               name: ["can't be blank"]
             }
-          }.stringify_keys
+          }.deep_stringify_keys
         end
 
         it 'returns meta data defined json' do
@@ -149,6 +202,59 @@ describe Azeroth::Decorator do
         end
       end
     end
+
+    context 'when decorator decorates relation' do
+      context 'when relation object has no decorator' do
+        subject(:decorator) do
+          Product::DecoratorWithFactory.new(product)
+        end
+
+        let(:product) { create(:product) }
+        let(:factory) { product.factory }
+
+        let(:expected_json) do
+          {
+            name: product.name,
+            factory: factory.as_json
+          }.stringify_keys
+        end
+
+        it 'exposes relation' do
+          expect(decorator.as_json).to eq(expected_json)
+        end
+      end
+
+      context 'when relation object has decorator' do
+        subject(:decorator) do
+          Factory::DecoratorWithProduct.new(factory)
+        end
+
+        let(:main_product) { create(:product) }
+        let(:factory)      { main_product.factory }
+
+        let!(:other_product) do
+          create(:product, factory: factory)
+        end
+
+        let(:expected_json) do
+          {
+            name: factory.name,
+            main_product: {
+              name: main_product.name
+            },
+            products: [{
+              name: main_product.name
+            }, {
+              name: other_product.name
+            }]
+          }.deep_stringify_keys
+        end
+
+        it 'exposes relation' do
+          expect(decorator.as_json).to eq(expected_json)
+        end
+      end
+    end
   end
 
   describe '#method_missing' do

data/spec/lib/azeroth/model_spec.rb

@@ -157,7 +157,7 @@ describe Azeroth::Model do
             errors: {
               name: ["can't be blank"]
             }
-          }.stringify_keys
+          }.deep_stringify_keys
         end
 
         it 'object.as_json' do

data/spec/lib/azeroth/options_spec.rb

@@ -9,7 +9,7 @@ describe Azeroth::Options do
     context 'when initializing with invalid options' do
       it do
         expect { described_class.new(invalid_option: 1) }
-          .to raise_error(Azeroth::Exception::InvalidOptions)
+          .to raise_error(Sinclair::Exception::InvalidOptions)
       end
     end
   end

data/spec/spec_helper.rb

@@ -17,10 +17,14 @@ require File.expand_path('spec/dummy/config/environment')
 require File.expand_path('spec/dummy/db/schema.rb')
 require 'rspec/rails'
 require 'active_support/railtie'
+require 'sinclair/matchers'
 
 support_files = File.expand_path('spec/support/**/*.rb')
 Dir[support_files].sort.each { |file| require file }
 
+RSpec::Matchers.define_negated_matcher :not_change, :change
+RSpec::Matchers.define_negated_matcher :not_add_method, :add_method
+
 RSpec.configure do |config|
   config.infer_spec_type_from_file_location!
   config.run_all_when_everything_filtered = true
@@ -28,6 +32,7 @@ RSpec.configure do |config|
   config.filter_run_excluding :integration unless ENV['ALL']
 
   config.order = 'random'
+  config.include Sinclair::Matchers
 
   config.around do |example|
     Document.delete_all

data/spec/support/factories/factory.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :factory, class: '::Factory' do
+    sequence(:name) { |n| "Factory ###{n}" }
+  end
+end

data/spec/support/factories/product.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :product, class: '::Product' do
+    sequence(:name) { |n| "Product ###{n}" }
+    association :factory
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Darthjee
@@ -416,8 +416,8 @@ files:
 - lib/azeroth.rb
 - lib/azeroth/decorator.rb
 - lib/azeroth/decorator/hash_builder.rb
+- lib/azeroth/decorator/options.rb
 - lib/azeroth/dummy_decorator.rb
-- lib/azeroth/exception.rb
 - lib/azeroth/model.rb
 - lib/azeroth/options.rb
 - lib/azeroth/request_handler.rb
@@ -462,6 +462,11 @@ files:
 - spec/dummy/app/models/document/decorator_with_error.rb
 - spec/dummy/app/models/dummy_model.rb
 - 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/product.rb
+- spec/dummy/app/models/product/decorator.rb
+- spec/dummy/app/models/product/decorator_with_factory.rb
 - spec/dummy/app/models/user.rb
 - spec/dummy/app/views/documents/edit.html
 - spec/dummy/app/views/documents/index.html
@@ -513,11 +518,9 @@ files:
 - spec/dummy/tmp/.keep
 - spec/dummy/tmp/storage/.keep
 - spec/integration/yard/azeroth/decorator_spec.rb
-- spec/integration/yard/azeroth/exception/invalid_options_spec.rb
 - spec/lib/azeroth/decorator/hash_builder_spec.rb
 - spec/lib/azeroth/decorator_spec.rb
 - spec/lib/azeroth/dummy_decorator_spec.rb
-- spec/lib/azeroth/exception/invalid_options_spec.rb
 - spec/lib/azeroth/model_spec.rb
 - spec/lib/azeroth/options_spec.rb
 - spec/lib/azeroth/request_handler/create_spec.rb
@@ -538,6 +541,8 @@ files:
 - spec/support/app/controllers/resource_route_builder_controller.rb
 - spec/support/factories/document.rb
 - spec/support/factories/dummy_model.rb
+- spec/support/factories/factory.rb
+- spec/support/factories/product.rb
 - spec/support/factories/user.rb
 - spec/support/factory_bot.rb
 - spec/support/matchers/add_method.rb
@@ -594,6 +599,11 @@ test_files:
 - spec/dummy/app/models/document/decorator_with_error.rb
 - spec/dummy/app/models/dummy_model.rb
 - 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/product.rb
+- spec/dummy/app/models/product/decorator.rb
+- spec/dummy/app/models/product/decorator_with_factory.rb
 - spec/dummy/app/models/user.rb
 - spec/dummy/app/views/documents/edit.html
 - spec/dummy/app/views/documents/index.html
@@ -645,11 +655,9 @@ test_files:
 - spec/dummy/tmp/.keep
 - spec/dummy/tmp/storage/.keep
 - spec/integration/yard/azeroth/decorator_spec.rb
-- spec/integration/yard/azeroth/exception/invalid_options_spec.rb
 - spec/lib/azeroth/decorator/hash_builder_spec.rb
 - spec/lib/azeroth/decorator_spec.rb
 - spec/lib/azeroth/dummy_decorator_spec.rb
-- spec/lib/azeroth/exception/invalid_options_spec.rb
 - spec/lib/azeroth/model_spec.rb
 - spec/lib/azeroth/options_spec.rb
 - spec/lib/azeroth/request_handler/create_spec.rb
@@ -670,6 +678,8 @@ test_files:
 - spec/support/app/controllers/resource_route_builder_controller.rb
 - spec/support/factories/document.rb
 - spec/support/factories/dummy_model.rb
+- spec/support/factories/factory.rb
+- spec/support/factories/product.rb
 - spec/support/factories/user.rb
 - spec/support/factory_bot.rb
 - spec/support/matchers/add_method.rb

data/lib/azeroth/exception.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Azeroth
-  # @api private
-  # @author Darthjee
-  #
-  # Excaptions raised by azeroth
-  class Exception < ::StandardError
-    # @api private
-    # @author Darthjee
-    #
-    # Exception raised when invalid options are given
-    #
-    # @example Usage
-    #   exception = Azeroth::Exception::InvalidOptions.new(%i[invalid options])
-    #   exception.message
-    #   # return 'Invalid keys on options initialization (invalid options)'
-    class InvalidOptions < Azeroth::Exception
-      # @param invalid_keys [Array<Symbol>] list of invalid keys
-      def initialize(invalid_keys = [])
-        @invalid_keys = invalid_keys
-      end
-
-      # Exception string showing invalid keys
-      #
-      # @return [String]
-      #
-      # @example (see InvalidOptions)
-      def message
-        keys = invalid_keys.join(' ')
-        "Invalid keys on options initialization (#{keys})"
-      end
-
-      private
-
-      attr_reader :invalid_keys
-      # @method invalid_keys
-      # @api private
-      # @private
-      #
-      # invalid keys on options initialization
-      #
-      # @return [Array<Symbol>]
-    end
-  end
-end

data/spec/integration/yard/azeroth/exception/invalid_options_spec.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Azeroth::Exception::InvalidOptions do
-  describe '#message' do
-    let(:exception) { described_class.new(%i[invalid options]) }
-    let(:expected_message) do
-      'Invalid keys on options initialization (invalid options)'
-    end
-
-    it 'shows invalid keys' do
-      expect(exception.message).to eq(expected_message)
-    end
-  end
-end

data/spec/lib/azeroth/exception/invalid_options_spec.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Azeroth::Exception::InvalidOptions do
-  describe '#message' do
-    let(:exception) { described_class.new(%i[invalid options]) }
-    let(:expected_message) do
-      'Invalid keys on options initialization (invalid options)'
-    end
-
-    it 'shows invalid keys' do
-      expect(exception.message).to eq(expected_message)
-    end
-  end
-end