azeroth 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 670fc994395afb0d20d4a113976c2b813d151ca6cad00d928e145d904294bcbc
-  data.tar.gz: 8c6f020d5e79b0dfc1559672a57d24468e883ec750e6503032e289deed19328b
+  metadata.gz: fe08d469b1d7f7de1b5e506ecfb28bf25d0529f12cb0ed44e738373685ff2f86
+  data.tar.gz: f947cca246ca569dfad592f4a25d806bdc32f4c5071a409719590828f2fb0b36
 SHA512:
-  metadata.gz: caf235cb34805e990b810e396859b42a6937eaa14f54cfff32cfa34867e716b180f0634a00e81042b56e0ce3b0851c08d5e3927b16da3c4138f3134703536e81
-  data.tar.gz: 2adb8cf2c8751e7c3e6cb7dcda4591285565d4b1e6deee999cbbeb6f941127e4b3c3b454fbf65e38c40ae9caa1de02d1562ff77b3ec9e6d4752c1b9f58dbf426
+  metadata.gz: ffd2677abcd53391963db5e8d4fb40cf35f3c0d86ad41a82bea3b9149a894bd6d8c7737e499c75cbb410106611f1c1c897c174069b9f5e74c8081f72e47fd258
+  data.tar.gz: 998012e33fe8abc53f81633a85d54181b4db805bb578b619b97c2a3974f1509ee06c260e0ef81e728b4965a9457bb805237cf711b334faded65ce399a25d07e3

data/.gitignore

@@ -6,6 +6,7 @@ doc
 .yardoc/
 measurement/
 **/*.swp
+**/*.swo
 rubycritic/
 spec/dummy/log/*
 spec/dummy/tmp/*

data/README.md

@@ -9,4 +9,4 @@ Azeroth
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/azeroth/0.0.6
+https://www.rubydoc.info/gems/azeroth/0.0.7

data/azeroth.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'actionpack',               '~> 5.x'
   gem.add_development_dependency 'activerecord',             '~> 5.x'
   gem.add_development_dependency 'bundler',                  '~> 1.16.1'
+  gem.add_development_dependency 'factory_bot',              '~> 5.1.1'
   gem.add_development_dependency 'pry',                      '0.12.2'
   gem.add_development_dependency 'pry-nav',                  '0.3.0'
   gem.add_development_dependency 'rails',                    '>= 5.2.0'

data/config/yardstick.yml

@@ -22,6 +22,7 @@ rules:
   Summary::Presence:
     enabled: true
     exclude:
+      - Azeroth::Decorator#initialize
       - Azeroth::Model#initialize
       - Azeroth::ResourceBuilder#initialize
       - Azeroth::ResourceRouteBuilder#initialize

data/lib/azeroth.rb

@@ -6,6 +6,7 @@
 #
 # @see Resourceable
 module Azeroth
+  autoload :Decorator,            'azeroth/decorator'
   autoload :Model,                'azeroth/model'
   autoload :Resourceable,         'azeroth/resourceable'
   autoload :ResourceBuilder,      'azeroth/resource_builder'

data/lib/azeroth/decorator.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'sinclair'
+
+module Azeroth
+  # @api public
+  #
+  # Class to be used when decorating outputs
+  #
+  # @example
+  #   class DummyModel
+  #     include ActiveModel::Model
+  #
+  #     attr_accessor :id, :first_name, :last_name, :age,
+  #                   :favorite_pokemon
+  #
+  #     class Decorator < Azeroth::Decorator
+  #       expose :name
+  #       expose :age
+  #       expose :favorite_pokemon, as: :pokemon
+  #
+  #       def name
+  #         [object.first_name, object.last_name].join(' ')
+  #       end
+  #     end
+  #   end
+  #
+  #   model = DummyModel.new(
+  #     id: 100,
+  #     first_name: 'John',
+  #     last_name: 'Wick',
+  #     favorite_pokemon: 'Arcanine'
+  #   )
+  #
+  #   decorator = DummyModel::Decorator.new(model)
+  #
+  #   decorator.as_json # returns {
+  #                     #   'name'    => 'John Wick',
+  #                     #   'age'     => nil,
+  #                     #   'pokemon' => 'Arcanine'
+  #                     # }
+  class Decorator
+    class << self
+      # @api private
+      #
+      # All attributes exposed
+      #
+      # @return [Array<Symbol>]
+      def attributes
+        @attributes ||= []
+      end
+
+      private
+
+      # rubocop:disable Naming/UncommunicativeMethodParamName
+
+      # @visibility public
+      # @api public
+      # @private
+      #
+      # Expose attributes on json decorated
+      #
+      # @param attribute [Symbol,String] attribute to be exposed
+      # @param as [Symbol,String] name of the attribute on the json
+      #
+      # @return [Array<Symbol>]
+      #
+      # @example
+      #   class DummyModel
+      #     include ActiveModel::Model
+      #
+      #     attr_accessor :id, :first_name, :last_name, :age,
+      #                   :favorite_pokemon
+      #
+      #     class Decorator < Azeroth::Decorator
+      #       expose :name
+      #       expose :age
+      #       expose :favorite_pokemon, as: :pokemon
+      #
+      #       def name
+      #         [object.first_name, object.last_name].join(' ')
+      #       end
+      #     end
+      #   end
+      def expose(attribute, as: attribute)
+        builder = Sinclair.new(self)
+        builder.add_method(as, "@object.#{attribute}")
+        builder.build
+
+        attributes << as.to_sym
+      end
+      # rubocop:enable Naming/UncommunicativeMethodParamName
+    end
+
+    # @api private
+    #
+    # @overload initialize(object)
+    #   @param [Object] object to be decorated
+    # @overload initialize(array)
+    #   @param array [Array] array of objects to be decorated
+    def initialize(object)
+      @object = object
+    end
+
+    # @api private
+    #
+    # Builds hash / Json from the given object
+    #
+    # When object is an iterator, decoration is applied to each
+    # and an array is returned
+    #
+    # @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
+    end
+
+    private
+
+    attr_reader :object
+    # @method object
+    # @api private
+    #
+    # Object to be decorated
+    #
+    # @return [Object]
+
+    # @api private
+    # @private
+    #
+    # Checks if object is an enumerable
+    #
+    # @return [TrueClass,FalseClass]
+    def enum?
+      object.is_a?(Enumerable)
+    end
+
+    # @api private
+    # @private
+    #
+    # Iterate over enumerable decorating each entry
+    #
+    # @return [Array<Hash>]
+    def array_as_json(*args)
+      object.map do |item|
+        self.class.new(item).as_json(*args)
+      end
+    end
+  end
+end

data/lib/azeroth/model.rb

@@ -6,17 +6,20 @@ module Azeroth
   #
   # Model responsible for making the conection to the resource model class
   class Model
-    attr_reader :name
-    # @method name
-    # @api private
-    #
+    # @param name [String,Symbol] name of the resource
+    def initialize(name)
+      if name.is_a?(Class)
+        @klass = name
+      else
+        @name = name.to_s
+      end
+    end
+
     # Returns the name of the resource represented by the model
     #
     # @return [String]
-
-    # @param name [String,Symbol] name of the resource
-    def initialize(name)
-      @name = name.to_s
+    def name
+      @name ||= klass.name.gsub(/.*::/, '').underscore
     end
 
     # Resource class (real model class)
@@ -32,5 +35,30 @@ module Azeroth
     def plural
       name.pluralize
     end
+
+    # Decorates object to return a hash
+    #
+    # Decorate uses klass::Decorator to decorate.
+    #
+    # When no decorator has been defined, object will
+    # receive an +#as_json+ call instead
+    #
+    # @return [Hash]
+    def decorate(object)
+      decorator_class.new(object).as_json
+    rescue NameError
+      object.as_json
+    end
+
+    private
+
+    # @private
+    #
+    # Returns decorator class for the object
+    #
+    # @return [Class] subclass of {Decorator}
+    def decorator_class
+      @decorator_class ||= klass::Decorator
+    end
   end
 end

data/lib/azeroth/resourceable.rb

@@ -19,6 +19,12 @@ module Azeroth
 
     private
 
+    # @api private
+    # @private
+    #
+    # Perform rendering of an action based on the requested format
+    #
+    # @return [String]
     def render_basic
       action = params[:action]
       respond_to do |format|
@@ -27,6 +33,12 @@ module Azeroth
       end
     end
 
+    # @api private
+    # @private
+    #
+    # returns 404 as HTTP status
+    #
+    # @return [TrueClass]
     def not_found
       head :not_found
     end

data/lib/azeroth/resourceable/builder.rb

@@ -135,6 +135,9 @@ module Azeroth
         RoutesBuilder.new(model, builder, options).append
       end
 
+      # Returns all updatable attributes
+      #
+      # @return [Array<String>]
       def permitted_attributes
         @permitted_attributes ||= klass.attribute_names - ['id']
       end

data/lib/azeroth/resourceable/class_methods.rb

@@ -11,6 +11,15 @@ module Azeroth
       #
       # @param name [String, Symbol] Name of the resource
       # @param options [Hash]
+      #
+      # @return [Array<MethodDefinition>]
+      #
+      # @example
+      #   class DocumentsController < ApplicationController
+      #     include Azeroth::Resourceable
+      #
+      #     resource_for :document
+      #   end
       def resource_for(name, **options)
         Builder.new(
           self, name, Azeroth::Options.new(options)

data/lib/azeroth/routes_builder.rb

@@ -57,12 +57,22 @@ module Azeroth
     #
     # @return [Array<Sinclair::MethodDefinition>]
 
+    # @private
+    #
+    # Method code to update route
+    #
+    # @return [String]
     def update_code
       <<-RUBY
         render json: update_resource
       RUBY
     end
 
+    # @private
+    #
+    # Method code to create route
+    #
+    # @return [String]
     def create_code
       <<-RUBY
         render json: create_resource
@@ -71,7 +81,7 @@ module Azeroth
 
     # @private
     #
-    # Method code to destrou route
+    # Method code to destroy route
     #
     # @return [String]
     def destroy_code

data/lib/azeroth/version.rb

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

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

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

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

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class DummyModel
+  include ActiveModel::Model
+
+  attr_accessor :id, :first_name, :last_name, :age,
+                :favorite_pokemon
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class DummyModel
+  class Decorator < Azeroth::Decorator
+    expose :name
+    expose :age
+    expose :favorite_pokemon, as: :pokemon
+
+    def name
+      [object.first_name, object.last_name].join(' ')
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class User < ActiveRecord::Base
+end

data/spec/dummy/db/schema.rb

@@ -5,5 +5,12 @@ ActiveRecord::Schema.define do
 
   create_table :documents, force: true do |t|
     t.string :name
+    t.string :reference
+  end
+
+  create_table :users, force: true do |t|
+    t.string :name
+    t.string :email
+    t.string :reference
   end
 end

data/spec/integration/yard/azeroth/decorator_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+describe Azeroth::Decorator do
+  subject(:decorator) { DummyModel::Decorator.new(object) }
+
+  let(:object) do
+    DummyModel.new(
+      id: 100,
+      first_name: 'John',
+      last_name: 'Wick',
+      favorite_pokemon: 'Arcanine'
+    )
+  end
+
+  describe '#as_json' do
+    it 'returns exposed attributes' do
+      expect(decorator.as_json).to eq(
+        'name' => 'John Wick',
+        'age' => nil,
+        'pokemon' => 'Arcanine'
+      )
+    end
+  end
+end

data/spec/lib/azeroth/decorator_spec.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+describe Azeroth::Decorator do
+  subject(:decorator) { DummyModel::Decorator.new(object) }
+
+  let(:model)  { build(:dummy_model) }
+  let(:object) { model }
+
+  describe '#as_json' do
+    context 'when object is just a model' 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
+    end
+
+    context 'when object is an array' do
+      let(:object) { [model, other_model] }
+
+      let(:other_model) do
+        build(
+          :dummy_model,
+          first_name: 'dum',
+          age: 65,
+          favorite_pokemon: :bulbasaur
+        )
+      end
+
+      let(:expected_json) do
+        [
+          {
+            name: "#{model.first_name} #{model.last_name}",
+            age: model.age,
+            pokemon: model.favorite_pokemon
+          }, {
+            name: "#{other_model.first_name} #{other_model.last_name}",
+            age: other_model.age,
+            pokemon: other_model.favorite_pokemon
+          }
+        ].map(&:stringify_keys)
+      end
+
+      it 'returns meta data defined json' do
+        expect(decorator.as_json).to eq(expected_json)
+      end
+    end
+
+    context 'when object is just an active record model' do
+      subject(:decorator) { Document::Decorator.new(object) }
+
+      let(:reference) { SecureRandom.uuid }
+      let!(:model)    { create(:document, reference: reference) }
+
+      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
+    end
+
+    context 'when object is an active record relation' do
+      subject(:decorator) { Document::Decorator.new(object) }
+
+      let(:reference)    { SecureRandom.uuid }
+      let!(:model)       { create(:document, reference: reference) }
+      let(:object)       { Document.where(reference: reference) }
+      let!(:other_model) { create(:document, reference: reference) }
+
+      let(:expected_json) do
+        [
+          {
+            name: model.name
+          }, {
+            name: other_model.name
+          }
+        ].map(&:stringify_keys)
+      end
+
+      it 'returns meta data defined json' do
+        expect(decorator.as_json).to eq(expected_json)
+      end
+    end
+  end
+end

data/spec/lib/azeroth/model_spec.rb

@@ -30,4 +30,94 @@ describe Azeroth::Model do
 
     it_behaves_like 'a model wrapper'
   end
+
+  context 'when initializing with string' do
+    let(:input) { 'document' }
+
+    it_behaves_like 'a model wrapper'
+  end
+
+  context 'when initializing with model' do
+    let(:input) { Document }
+
+    it_behaves_like 'a model wrapper'
+  end
+
+  describe '#decorate' do
+    context 'when model has a decorator' do
+      let(:input)     { :document }
+      let(:reference) { SecureRandom.uuid }
+      let!(:object)   { create(:document, reference: reference) }
+
+      context 'when object is just a model and has decorator' do
+        let!(:object) { create(:document, reference: reference) }
+
+        let(:expected_json) do
+          {
+            name: object.name
+          }.stringify_keys
+        end
+
+        it 'returns meta data defined json' do
+          expect(model.decorate(object)).to eq(expected_json)
+        end
+      end
+
+      context 'when object is an active record relation' do
+        let(:relation)      { Document.where(reference: reference) }
+        let!(:other_object) { create(:document, reference: reference) }
+
+        let(:expected_json) do
+          [
+            {
+              name: object.name
+            }, {
+              name: other_object.name
+            }
+          ].map(&:stringify_keys)
+        end
+
+        it 'returns meta data defined json' do
+          expect(model.decorate(relation)).to eq(expected_json)
+        end
+      end
+    end
+
+    context 'when model is an active record that does not have a decorator' do
+      let(:input)     { Class.new(User) }
+      let(:reference) { SecureRandom.uuid }
+      let!(:object)   { create(:user, reference: reference) }
+
+      context 'when object is just a model' do
+        it 'returns regular as_json' do
+          expect(model.decorate(object)).to eq(object.as_json)
+        end
+      end
+
+      context 'when object is an active record relation' do
+        let(:relation) { User.where(reference: reference) }
+
+        before { create(:user, reference: reference) }
+
+        it 'returns regular as_json' do
+          expect(model.decorate(relation)).to eq(relation.as_json)
+        end
+      end
+    end
+
+    context 'when model is an active model that does not have a decorator' do
+      let(:input) do
+        Class.new do
+          include ActiveModel::Model
+          attr_accessor :id, :name
+        end
+      end
+
+      let(:object) { input.new(id: 1, name: 'my name') }
+
+      it 'returns regular as_json' do
+        expect(model.decorate(object)).to eq(object.as_json)
+      end
+    end
+  end
 end

data/spec/support/factories/document.rb

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

data/spec/support/factories/dummy_model.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :dummy_model, class: ::DummyModel do
+    sequence(:id)
+    first_name       { 'dummy' }
+    last_name        { 'bot' }
+    age              { 21 }
+    favorite_pokemon { 'squirtle' }
+  end
+end

data/spec/support/factories/user.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user, class: ::User do
+    sequence(:name)  { |n| "Name-#{n}" }
+    sequence(:email) { |n| "user-#{n}@email.com" }
+  end
+end

data/spec/support/factory_bot.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end
+
+FactoryBot.find_definitions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-10 00:00:00.000000000 Z
+date: 2019-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.16.1
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -386,6 +400,7 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/azeroth.rb
+- lib/azeroth/decorator.rb
 - lib/azeroth/model.rb
 - lib/azeroth/options.rb
 - lib/azeroth/resource_builder.rb
@@ -415,6 +430,10 @@ files:
 - spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/concerns/.keep
 - spec/dummy/app/models/document.rb
+- spec/dummy/app/models/document/decorator.rb
+- spec/dummy/app/models/dummy_model.rb
+- spec/dummy/app/models/dummy_model/decorator.rb
+- spec/dummy/app/models/user.rb
 - spec/dummy/app/views/documents/edit.html
 - spec/dummy/app/views/documents/index.html
 - spec/dummy/app/views/documents/new.html
@@ -464,6 +483,8 @@ files:
 - spec/dummy/storage/.keep
 - spec/dummy/tmp/.keep
 - spec/dummy/tmp/storage/.keep
+- spec/integration/yard/azeroth/decorator_spec.rb
+- spec/lib/azeroth/decorator_spec.rb
 - spec/lib/azeroth/model_spec.rb
 - spec/lib/azeroth/resource_builder_spec.rb
 - spec/lib/azeroth/resource_route_builder_spec.rb
@@ -474,6 +495,10 @@ files:
 - spec/support/app/controllers/resource_builder_controller.rb
 - spec/support/app/controllers/resource_route_builder_controller.rb
 - spec/support/app/controllers/routes_builder_controller.rb
+- spec/support/factories/document.rb
+- spec/support/factories/dummy_model.rb
+- spec/support/factories/user.rb
+- spec/support/factory_bot.rb
 - spec/support/matchers/add_method.rb
 - spec/support/shared_examples/resource_routes.rb
 homepage: https://github.com/darthjee/azeroth
@@ -520,6 +545,10 @@ test_files:
 - spec/dummy/app/models/application_record.rb
 - spec/dummy/app/models/concerns/.keep
 - spec/dummy/app/models/document.rb
+- spec/dummy/app/models/document/decorator.rb
+- spec/dummy/app/models/dummy_model.rb
+- spec/dummy/app/models/dummy_model/decorator.rb
+- spec/dummy/app/models/user.rb
 - spec/dummy/app/views/documents/edit.html
 - spec/dummy/app/views/documents/index.html
 - spec/dummy/app/views/documents/new.html
@@ -569,6 +598,8 @@ test_files:
 - spec/dummy/storage/.keep
 - spec/dummy/tmp/.keep
 - spec/dummy/tmp/storage/.keep
+- spec/integration/yard/azeroth/decorator_spec.rb
+- spec/lib/azeroth/decorator_spec.rb
 - spec/lib/azeroth/model_spec.rb
 - spec/lib/azeroth/resource_builder_spec.rb
 - spec/lib/azeroth/resource_route_builder_spec.rb
@@ -579,5 +610,9 @@ test_files:
 - spec/support/app/controllers/resource_builder_controller.rb
 - spec/support/app/controllers/resource_route_builder_controller.rb
 - spec/support/app/controllers/routes_builder_controller.rb
+- spec/support/factories/document.rb
+- spec/support/factories/dummy_model.rb
+- spec/support/factories/user.rb
+- spec/support/factory_bot.rb
 - spec/support/matchers/add_method.rb
 - spec/support/shared_examples/resource_routes.rb