azeroth 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afd378d756eaf524cab794de457c654237f287bee671be9e6409702528695247
-  data.tar.gz: 6dabd7110587bb3df0dcf7239a179ea1ceaee017692262f2366a2ac8b73fe0fc
+  metadata.gz: 4969648cf9b578079bc4d7baca012aa82768fd37edc9279ed2be606ef11b78b4
+  data.tar.gz: e426759bcab101a0ef02b0b9cc68d56d2cabc43fdea9a30027974dbaebf7a4e5
 SHA512:
-  metadata.gz: b434a935b247bce958b72abefc6dc82063df57c9ad331e3b087c246e95cebea9dc2a619964081c54c65fe5c2775b62f5fac1b58ed4122a3776850922b24096b7
-  data.tar.gz: d12697602efd61c4932b8fddb3e6b83b273dc51c441b4f9c5a1cf07a5325933e6b3c0629f594b06921d06a8cd4f37998f75ccedbf39c3a4950f7d9353fc3bfaf
+  metadata.gz: 8848cd9189e14cb2ac4ce22b401b2d5c4d5a39af868a38c1746a9e05136018bbf42b5e071f4feff680b823ab70fc9f3320c60fb0b4c982dfee23a2621781bc0a
+  data.tar.gz: ed36e6cf227e30e6f37dbe8ca109ccfecda6f2747349a1c73e97cf7319af929785aeaa0ccb8ab08265d0524d58a39fbe6a3101f5e95cb1b39998879866f783d2

data/README.md

@@ -1,12 +1,14 @@
 Azeroth
 ========
+[![Build Status](https://circleci.com/gh/darthjee/azeroth.svg?style=shield)](https://circleci.com/gh/darthjee/azeroth)
 [![Code Climate](https://codeclimate.com/github/darthjee/azeroth/badges/gpa.svg)](https://codeclimate.com/github/darthjee/azeroth)
 [![Test Coverage](https://codeclimate.com/github/darthjee/azeroth/badges/coverage.svg)](https://codeclimate.com/github/darthjee/azeroth/coverage)
 [![Issue Count](https://codeclimate.com/github/darthjee/azeroth/badges/issue_count.svg)](https://codeclimate.com/github/darthjee/azeroth)
 [![Gem Version](https://badge.fury.io/rb/azeroth.svg)](https://badge.fury.io/rb/azeroth)
+[![Inline docs](http://inch-ci.org/github/darthjee/azeroth.svg)](http://inch-ci.org/github/darthjee/azeroth)
 
 ![azeroth](https://raw.githubusercontent.com/darthjee/azeroth/master/azeroth.jpg)
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/azeroth/0.1.0
+[https://www.rubydoc.info/gems/azeroth/0.2.0](https://www.rubydoc.info/gems/azeroth/0.2.0)

data/config/yardstick.yml

@@ -23,6 +23,7 @@ rules:
     enabled: true
     exclude:
       - Azeroth::Decorator#initialize
+      - Azeroth::Decorator::HashBuilder#initialize
       - Azeroth::Model#initialize
       - Azeroth::RequestHandler#initialize
       - Azeroth::ResourceBuilder#initialize

data/lib/azeroth.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
+require 'sinclair'
+
 # @api public
 #
 # Lib for easily developing controllers
 #
+# @example (see Resourceable)
+#
 # @see Resourceable
-
-require 'sinclair'
-
 module Azeroth
   autoload :Decorator,            'azeroth/decorator'
   autoload :Model,                'azeroth/model'

data/lib/azeroth/decorator.rb

@@ -40,20 +40,20 @@ module Azeroth
   #                     #   'pokemon' => 'Arcanine'
   #                     # }
   class Decorator
+    autoload :HashBuilder, 'azeroth/decorator/hash_builder'
+
     class << self
       # @api private
       #
       # All attributes exposed
       #
       # @return [Array<Symbol>]
-      def attributes
-        @attributes ||= []
+      def attributes_map
+        @attributes_map ||= {}
       end
 
       private
 
-      # rubocop:disable Naming/UncommunicativeMethodParamName
-
       # @visibility public
       # @api public
       # @private
@@ -61,7 +61,12 @@ module Azeroth
       # Expose attributes on json decorated
       #
       # @param attribute [Symbol,String] attribute to be exposed
-      # @param as [Symbol,String] name of the attribute on the json
+      # @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 [Array<Symbol>]
       #
@@ -82,14 +87,13 @@ module Azeroth
       #       end
       #     end
       #   end
-      def expose(attribute, as: attribute)
+      def expose(attribute, **options)
         builder = Sinclair.new(self)
-        builder.add_method(as, "@object.#{attribute}")
+        builder.add_method(attribute, "@object.#{attribute}")
         builder.build
 
-        attributes << as.to_sym
+        attributes_map[attribute] = options
       end
-      # rubocop:enable Naming/UncommunicativeMethodParamName
     end
 
     # @api private
@@ -109,17 +113,13 @@ module Azeroth
     # When object is an iterator, decoration is applied to each
     # and an array is returned
     #
-    # @param *args [Hash] options (to be implemented)
+    # @param args [Hash] options (to be implemented)
     #
     # @return [Hash]
     def as_json(*args)
       return array_as_json(*args) if enum?
 
-      {}.tap do |hash|
-        self.class.attributes.each do |method|
-          hash[method.to_s] = public_send(method)
-        end
-      end
+      HashBuilder.new(self).as_json
     end
 
     private
@@ -153,5 +153,40 @@ module Azeroth
         self.class.new(item).as_json(*args)
       end
     end
+
+    # @api private
+    # @private
+    # Method called when method is missing
+    #
+    # This delegates method calls to the given object
+    #
+    # @param method_name [Symbol] name of the method
+    #   called
+    # @param args [Array<Object>] arguments of the
+    #   method called
+    #
+    # @return [Object]
+    def method_missing(method_name, *args)
+      if object.respond_to?(method_name)
+        object.public_send(method_name, *args)
+      else
+        super
+      end
+    end
+
+    # @api private
+    # @private
+    # Checks if it would respond to a method
+    #
+    # The decision is delegated to the object
+    #
+    # @param method_name [Symbol] name of the method checked
+    # @param include_private [TrueClass,FalseClass] flag
+    #   indicating if private methods should be included
+    #
+    # @return [TrueClass,FalseClass]
+    def respond_to_missing?(method_name, include_private)
+      object.respond_to?(method_name, include_private)
+    end
   end
 end

data/lib/azeroth/decorator/hash_builder.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'sinclair'
+
+module Azeroth
+  class Decorator
+    # @api private
+    #
+    # Class responsible for building the hash on
+    # Decorator#as_json calls
+    class HashBuilder
+      # @param decorator [Decorator] decorator that
+      #   will receive all method calls
+      def initialize(decorator)
+        @decorator = decorator
+      end
+
+      # Build hash as defined by decorator
+      #
+      # The built of the hash keys is defined
+      # by decorator attributes and method calls
+      # to the same decorator that will then delgate,
+      # when needed, to its object
+      #
+      # @return [Hash]
+      def as_json
+        attributes_map.each do |method, options|
+          add_attribute(method, options)
+        end
+        hash
+      end
+
+      private
+
+      attr_reader :decorator
+      # @method decorator
+      # @api private
+      # @private
+      #
+      # decorator with object to be decorated
+      #
+      # @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] = decorator.public_send(method)
+      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
+      # the values are the exposing options
+      #
+      # @return [Hash] hash of pairs method,options
+      def attributes_map
+        decorator.class.attributes_map
+      end
+
+      # Hash being built
+      #
+      # @return [Hash]
+      def hash
+        @hash ||= {}
+      end
+    end
+  end
+end

data/lib/azeroth/version.rb

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

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

@@ -3,5 +3,10 @@
 class Document
   class Decorator < Azeroth::Decorator
     expose :name
+    expose :reference, if: proc(&:magic?)
+
+    def magic?
+      reference&.match(/^X-MAGIC/)
+    end
   end
 end

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

@@ -5,4 +5,12 @@ class DummyModel
 
   attr_accessor :id, :first_name, :last_name, :age,
                 :favorite_pokemon
+
+  validates_presence_of :first_name
+
+  private
+
+  def private_name
+    "Secret #{last_name}"
+  end
 end

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

@@ -5,9 +5,15 @@ class DummyModel
     expose :name
     expose :age
     expose :favorite_pokemon, as: :pokemon
+    expose :errors, if: :invalid?
 
     def name
-      [object.first_name, object.last_name].join(' ')
+      [object.first_name, object.last_name].compact.join(' ')
+    end
+
+    def errors
+      object.valid?
+      object.errors.messages
     end
   end
 end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::Decorator::HashBuilder do
+  subject(:builder) { described_class.new(decorator) }
+
+  let(:decorator_class) { DummyModel::Decorator }
+  let(:decorator)       { decorator_class.new(model) }
+  let(:model)           { build(:dummy_model) }
+
+  describe '#as_json' do
+    let(:expected_json) do
+      {
+        name: "#{model.first_name} #{model.last_name}",
+        age: model.age,
+        pokemon: model.favorite_pokemon
+      }.stringify_keys
+    end
+
+    it 'returns meta data defined json' do
+      expect(decorator.as_json).to eq(expected_json)
+    end
+
+    context 'when conditional attibute is exposed' do
+      let(:model) { build(:dummy_model, first_name: nil) }
+
+      let(:expected_json) do
+        {
+          name: model.last_name,
+          age: model.age,
+          pokemon: model.favorite_pokemon,
+          errors: {
+            first_name: ["can't be blank"]
+          }
+        }.stringify_keys
+      end
+
+      it 'include the conditional attributes' do
+        expect(decorator.as_json).to eq(expected_json)
+      end
+    end
+
+    context 'when decorator has an expose block conditional' do
+      let(:decorator_class) { Document::Decorator }
+      let(:model)           { create(:document) }
+
+      let(:expected_json) do
+        {
+          name: model.name
+        }.stringify_keys
+      end
+
+      it 'returns meta data defined json' do
+        expect(decorator.as_json).to eq(expected_json)
+      end
+
+      context 'when conditional returns true' do
+        let(:model) { create(:document, reference: 'X-MAGIC-01') }
+
+        let(:expected_json) do
+          {
+            name: model.name,
+            reference: 'X-MAGIC-01'
+          }.stringify_keys
+        end
+
+        it 'returns meta data defined json' do
+          expect(decorator.as_json).to eq(expected_json)
+        end
+      end
+    end
+  end
+end

data/spec/lib/azeroth/decorator_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'spec_helper'
+
 describe Azeroth::Decorator do
   subject(:decorator) { DummyModel::Decorator.new(object) }
 
@@ -19,6 +21,25 @@ describe Azeroth::Decorator do
       it 'returns meta data defined json' do
         expect(decorator.as_json).to eq(expected_json)
       end
+
+      context 'when conditional attibute is exposed' do
+        let(:model) { build(:dummy_model, first_name: nil) }
+
+        let(:expected_json) do
+          {
+            name: model.last_name,
+            age: model.age,
+            pokemon: model.favorite_pokemon,
+            errors: {
+              first_name: ["can't be blank"]
+            }
+          }.stringify_keys
+        end
+
+        it 'include the conditional attributes' do
+          expect(decorator.as_json).to eq(expected_json)
+        end
+      end
     end
 
     context 'when object is an array' do
@@ -92,4 +113,59 @@ describe Azeroth::Decorator do
       end
     end
   end
+
+  describe '#method_missing' do
+    subject(:decorator) { decorator_class.new(object) }
+
+    let(:decorator_class) { Class.new(described_class) }
+    let(:model) { build(:dummy_model) }
+
+    it 'delegates methods to object' do
+      expect(decorator.first_name).not_to be_nil
+    end
+
+    context 'when object does not respond to method' do
+      it do
+        expect { decorator.bad_method }
+          .to raise_error(NoMethodError)
+      end
+    end
+  end
+
+  describe '#respond_to_missing?' do
+    subject(:decorator) { decorator_class.new(object) }
+
+    let(:decorator_class) { Class.new(described_class) }
+    let(:model) { build(:dummy_model) }
+
+    context 'when object responds to it' do
+      it do
+        expect(decorator)
+          .to respond_to(:first_name)
+      end
+    end
+
+    context 'when method is private' do
+      it do
+        expect(decorator)
+          .not_to respond_to(:private_name)
+      end
+    end
+
+    context 'when method is private and passing include_private' do
+      # rubocop:disable RSpec/PredicateMatcher
+      it do
+        expect(decorator.respond_to?(:private_name, true))
+          .to be_truthy
+      end
+      # rubocop:enable RSpec/PredicateMatcher
+    end
+
+    context 'when object does not respond to it' do
+      it do
+        expect(decorator)
+          .not_to respond_to(:no_name)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-16 00:00:00.000000000 Z
+date: 2019-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -401,6 +401,7 @@ files:
 - docker-compose.yml
 - lib/azeroth.rb
 - lib/azeroth/decorator.rb
+- lib/azeroth/decorator/hash_builder.rb
 - lib/azeroth/model.rb
 - lib/azeroth/options.rb
 - lib/azeroth/request_handler.rb
@@ -491,6 +492,7 @@ files:
 - spec/dummy/tmp/.keep
 - spec/dummy/tmp/storage/.keep
 - spec/integration/yard/azeroth/decorator_spec.rb
+- spec/lib/azeroth/decorator/hash_builder_spec.rb
 - spec/lib/azeroth/decorator_spec.rb
 - spec/lib/azeroth/model_spec.rb
 - spec/lib/azeroth/request_handler/create_spec.rb
@@ -613,6 +615,7 @@ test_files:
 - spec/dummy/tmp/.keep
 - spec/dummy/tmp/storage/.keep
 - spec/integration/yard/azeroth/decorator_spec.rb
+- spec/lib/azeroth/decorator/hash_builder_spec.rb
 - spec/lib/azeroth/decorator_spec.rb
 - spec/lib/azeroth/model_spec.rb
 - spec/lib/azeroth/request_handler/create_spec.rb