azeroth 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b900f12e602cd5e71dcb0384e0d4edf783a699a9462dd644d849ec52af171f1
-  data.tar.gz: c9212340df4b356fb223874e340a3679111d0dd1d80b4e0293d7b3f7afebb790
+  metadata.gz: 12fa0ab1ef082540f0c7d7bdedf2ed52c3b9bdce5655d15ea45779be34c1cbe0
+  data.tar.gz: 7b9e0ce7be0223f0e2d9797197160f30ec1113d48cb9375ad650846d4f1ae481
 SHA512:
-  metadata.gz: c884137cfce1ae2e0fac3a35817ecfecb62dc1093a7b95c5f77a8d9fffb426b0b7024028221789b6b560097bcae07a8012ef751edd3c9a08941a1ab6d4890e7d
-  data.tar.gz: 63ca6a97a61293b3551852ac2fab43ce0ab27fe9fafc37268c9c542f3c033ce5f6a8aac45d9c5ae0f220c9c6963dcaa169b8e9810841fe7cdf3751e1505631d6
+  metadata.gz: d0c2dffb1b5b8366d2c37ae8addf1c15396825c3711acdf6c4b20b7818ddf9dc7ad720a0be1baad0cc8dbe29a88fb3e4fe681989d892b96f4390d8787e8a95de
+  data.tar.gz: c1cdf88c0f8ecad8d5b00fb5a1898445e33b2da407c77893f87df2d1ca57cf051d99642f65273fdf3e8c08ea71746dd8e3c013550d65324105f16e9cbbcfb375

data/README.md

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

data/config/yardstick.yml

@@ -15,7 +15,8 @@ rules:
     exclude: []
   ExampleTag:
     enabled: true
-    exclude: []
+    exclude:
+      - Azeroth::DummyDecorator#as_json
   ReturnTag:
     enabled: true
     exclude: []
@@ -24,6 +25,7 @@ rules:
     exclude:
       - Azeroth::Decorator#initialize
       - Azeroth::Decorator::HashBuilder#initialize
+      - Azeroth::DummyDecorator#initialize
       - Azeroth::Exception::InvalidOptions#initialize
       - Azeroth::Model#initialize
       - Azeroth::Options#initialize

data/lib/azeroth.rb

@@ -10,12 +10,13 @@ require 'sinclair'
 #
 # @see Resourceable
 module Azeroth
-  autoload :Decorator,            'azeroth/decorator'
-  autoload :Exception,            'azeroth/exception'
-  autoload :Model,                'azeroth/model'
-  autoload :RequestHandler,       'azeroth/request_handler'
-  autoload :Resourceable,         'azeroth/resourceable'
-  autoload :ResourceBuilder,      'azeroth/resource_builder'
-  autoload :RoutesBuilder,        'azeroth/routes_builder'
-  autoload :Options,              'azeroth/options'
+  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'
+  autoload :ResourceBuilder, 'azeroth/resource_builder'
+  autoload :RoutesBuilder,   'azeroth/routes_builder'
+  autoload :Options,         'azeroth/options'
 end

data/lib/azeroth/decorator.rb

@@ -47,13 +47,27 @@ module Azeroth
       #
       # All attributes exposed
       #
-      # @return [Array<Symbol>]
+      # @return [Hash<Symbol,Hash>]
       def attributes_map
-        @attributes_map ||= {}
+        @attributes_map ||= build_attributes_map
       end
 
       private
 
+      # @api private
+      # @private
+      #
+      # Initialize attributes to be exposed map
+      #
+      # When the class inherity from another
+      # decorator, the new class should expose the
+      # same attributes.
+      #
+      # @return [Hash<Symbol,Hash>]
+      def build_attributes_map
+        superclass.try(:attributes_map).dup || {}
+      end
+
       # @visibility public
       # @api public
       # @private

data/lib/azeroth/dummy_decorator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'sinclair'
+
+module Azeroth
+  # @api private
+  # @author Darthjee
+  #
+  # Decorator that calls #as_json on object
+  class DummyDecorator
+    delegate :as_json, to: :@object
+    # @method as_json
+    # @public
+    # @api public
+    #
+    # Returns object.as_json
+    #
+    # @return [Hash]
+
+    # @param object [Object] object to be decorated
+    def initialize(object)
+      @object = object
+    end
+  end
+end

data/lib/azeroth/model.rb

@@ -7,12 +7,15 @@ module Azeroth
   # Model responsible for making the conection to the resource model class
   class Model
     # @param name [String,Symbol] name of the resource
-    def initialize(name)
+    # @param options [Azeroth::Options] resource options
+    def initialize(name, options)
       if name.is_a?(Class)
         @klass = name
       else
         @name = name.to_s
       end
+
+      @options = options
     end
 
     # Returns the name of the resource represented by the model
@@ -46,19 +49,47 @@ module Azeroth
     # @return [Hash]
     def decorate(object)
       decorator_class.new(object).as_json
-    rescue NameError
-      object.as_json
     end
 
     private
 
+    attr_reader :options
+    # @method options
+    # @api private
+    # @private
+    #
+    # Returns options
+    #
+    # @return [Azeroth::Options]
+
     # @private
     #
     # Returns decorator class for the object
     #
     # @return [Class] subclass of {Decorator}
     def decorator_class
-      @decorator_class ||= klass::Decorator
+      @decorator_class ||= calculate_decorator_class
+    end
+
+    # @private
+    #
+    # Calculates decorator class
+    #
+    # When options.decorator is false return DummyDecorator
+    #
+    # when options.decorator is a class, returns it
+    #
+    # When finding the decorator from the model fails,
+    # returns DummyDecorator
+    #
+    # @return [Azeroth::Decorator,DummyDecorator]
+    def calculate_decorator_class
+      return DummyDecorator unless options.decorator
+      return options.decorator if options.decorator.is_a?(Class)
+
+      klass::Decorator
+    rescue NameError
+      DummyDecorator
     end
   end
 end

data/lib/azeroth/options.rb

@@ -6,16 +6,20 @@ module Azeroth
   #
   # Resource buiilding options
   class Options < ::OpenStruct
+    # Default options
     DEFAULT_OPTIONS = {
       only: %i[create destroy edit index new show update],
-      except: []
+      except: [],
+      decorator: true
     }.freeze
 
-    # @param options [Hash] hash with options
+    # @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)
 

data/lib/azeroth/resourceable/builder.rb

@@ -19,8 +19,8 @@ module Azeroth
       # @param options [Options]
       def initialize(clazz, model_name, options)
         @clazz = clazz
-        @model = Azeroth::Model.new(model_name)
         @options = options
+        @model = Azeroth::Model.new(model_name, options)
 
         add_params
         add_resource

data/lib/azeroth/resourceable/class_methods.rb

@@ -10,15 +10,25 @@ module Azeroth
       # Adds resource methods for resource
       #
       # @param name [String, Symbol] Name of the resource
-      # @param options [Hash]
+      # @param (see Options#initialize)
+      # @option (see Options#initialize)
       #
-      # @return [Array<MethodDefinition>]
+      # @return [Array<MethodDefinition>] list of methods created
       #
-      # @example
+      # @see Options
+      #
+      # @example Controller without delete
+      #   class DocumentsController < ApplicationController
+      #     include Azeroth::Resourceable
+      #
+      #     resource_for :document, except: :delete
+      #   end
+      #
+      # @example Controller with only create, show and list
       #   class DocumentsController < ApplicationController
       #     include Azeroth::Resourceable
       #
-      #     resource_for :document
+      #     resource_for :document, only: %w[create index show]
       #   end
       def resource_for(name, **options)
         Builder.new(

data/lib/azeroth/version.rb

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

data/spec/controllers/documents_controller_spec.rb

@@ -215,12 +215,12 @@ describe DocumentsController do
       end
 
       it do
-        post :create, params: parameters
+        post :update, params: parameters
         expect(response).not_to be_successful
       end
 
       it 'returns created document json' do
-        post :create, params: parameters
+        post :update, params: parameters
         expect(parsed_response).to eq(expected_json)
       end
 

data/spec/controllers/documents_with_error_controller_spec.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DocumentsWithErrorController do
+  let(:parsed_response) do
+    JSON.parse(response.body)
+  end
+
+  describe 'GET index' do
+    let(:documents_count) { 0 }
+
+    before do
+      documents_count.times.map { create(:document) }
+    end
+
+    context 'when calling on format json' do
+      it do
+        expect { get :index, params: { format: :json } }
+          .to raise_error(AbstractController::ActionNotFound)
+      end
+
+      context 'when there is a document' do
+        let(:documents_count) { 1 }
+
+        it do
+          expect { get :index, params: { format: :json } }
+            .to raise_error(AbstractController::ActionNotFound)
+        end
+      end
+    end
+
+    context 'when calling on format html' do
+      it do
+        expect { get :index, params: { format: :html } }
+          .to raise_error(AbstractController::ActionNotFound)
+      end
+    end
+  end
+
+  describe 'POST create' do
+    let(:payload) do
+      {
+        name: 'My document'
+      }
+    end
+    let(:parameters) do
+      {
+        format: format,
+        document: payload
+      }
+    end
+
+    context 'when requesting format json' do
+      let(:format) { :json }
+
+      let(:expected_json) do
+        Document::Decorator.new(Document.last).as_json
+      end
+
+      it do
+        post :create, params: parameters
+        expect(response).to be_successful
+      end
+
+      it 'returns created document json' do
+        post :create, params: parameters
+        expect(parsed_response).to eq(expected_json)
+      end
+
+      it do
+        expect { post :create, params: parameters }
+          .to change(Document, :count).by(1)
+      end
+    end
+
+    context 'when there is validation error' do
+      let(:format)  { :json }
+      let(:payload) { { reference: 'x01' } }
+
+      let(:expected_body) do
+        Document::DecoratorWithError.new(Document.new(payload)).to_json
+      end
+
+      it do
+        post :create, params: parameters
+        expect(response).not_to be_successful
+      end
+
+      it 'returns created document json' do
+        post :create, params: parameters
+        expect(response.body).to eq(expected_body)
+      end
+
+      it do
+        expect { post :create, params: parameters }
+          .not_to change(Document, :count)
+      end
+    end
+  end
+
+  describe 'PATCH update' do
+    let(:document)    { create(:document) }
+    let(:document_id) { document.id }
+
+    let(:expected_body) do
+      Document.last.to_json
+    end
+
+    let(:payload) do
+      {
+        name: 'My document'
+      }
+    end
+
+    let(:parameters) do
+      {
+        id: document_id,
+        format: :json,
+        document: payload
+      }
+    end
+
+    it do
+      patch :update, params: parameters
+      expect(response).to be_successful
+    end
+
+    it 'returns updated document json' do
+      patch :update, params: parameters
+      expect(response.body).to eq(expected_body)
+    end
+
+    it do
+      expect { patch :update, params: parameters }
+        .to change { document.reload.name }
+        .to('My document')
+    end
+
+    context 'when calling on an inexistent id' do
+      let(:document_id) { :wrong_id }
+
+      before do
+        patch :update, params: parameters
+      end
+
+      it { expect(response).not_to be_successful }
+      it { expect(response.status).to eq(404) }
+
+      it 'returns empty body' do
+        expect(response.body).to eq('')
+      end
+    end
+
+    context 'when there is validation error' do
+      let(:format)  { :json }
+      let(:payload) { { name: nil } }
+
+      let(:expected_json) do
+        {
+          'id' => document.id,
+          'name' => '',
+          'reference' => nil
+        }
+      end
+
+      it do
+        post :update, params: parameters
+        expect(response).not_to be_successful
+      end
+
+      it 'returns created document json' do
+        post :update, params: parameters
+        expect(parsed_response).to eq(expected_json)
+      end
+
+      it 'does not update entry' do
+        expect { post :update, params: parameters }
+          .not_to(change { document.reload.name })
+      end
+    end
+  end
+end

data/spec/dummy/app/controllers/documents_with_error_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class DocumentsWithErrorController < ApplicationController
+  include Azeroth::Resourceable
+
+  resource_for :document,
+               only: :create,
+               decorator: Document::DecoratorWithError
+
+  resource_for :document,
+               only: :update,
+               decorator: false
+end

data/spec/dummy/app/controllers/index_documents_controller.rb

@@ -3,5 +3,5 @@
 class IndexDocumentsController < ApplicationController
   include Azeroth::Resourceable
 
-  resource_for :document, only: :index
+  resource_for :document, only: 'index'
 end

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

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 class Document
-  class DecoratorWithError < Azeroth::Decorator
-    expose :name
+  class DecoratorWithError < Document::Decorator
     expose :errors, if: :invalid?
 
     def errors

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

@@ -4,7 +4,7 @@ class DummyModel
   include ActiveModel::Model
 
   attr_accessor :id, :first_name, :last_name, :age,
-                :favorite_pokemon
+                :favorite_pokemon, :favorite_game
 
   validates_presence_of :first_name
 

data/spec/dummy/config/routes.rb

@@ -3,4 +3,5 @@
 Rails.application.routes.draw do
   resources :documents
   resources :public_documents, controller: :index_documents
+  resources :create_documents, controller: :documents_with_error
 end

data/spec/lib/azeroth/dummy_decorator_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::DummyDecorator do
+  subject(:decorator) { described_class.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
+        {
+          favorite_game: 'pokemon',
+          favorite_pokemon: 'squirtle',
+          first_name: 'dummy',
+          id: model.id,
+          last_name: 'bot',
+          age: 21
+        }.stringify_keys
+      end
+
+      it 'object.as_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
+        [
+          {
+            favorite_game: 'pokemon',
+            favorite_pokemon: 'squirtle',
+            first_name: 'dummy',
+            id: model.id,
+            last_name: 'bot',
+            age: 21
+          }, {
+            favorite_game: 'pokemon',
+            favorite_pokemon: 'bulbasaur',
+            first_name: 'dum',
+            id: other_model.id,
+            last_name: 'bot',
+            age: 65
+          }
+        ].map(&:stringify_keys)
+      end
+
+      it 'object.as_json' do
+        expect(decorator.as_json).to eq(expected_json)
+      end
+    end
+  end
+end

data/spec/lib/azeroth/model_spec.rb

@@ -23,7 +23,10 @@ shared_examples 'a model wrapper' do
 end
 
 describe Azeroth::Model do
-  subject(:model) { described_class.new(input) }
+  subject(:model) { described_class.new(input, options) }
+
+  let(:options)      { Azeroth::Options.new(options_hash) }
+  let(:options_hash) { {} }
 
   context 'when initializing with symbol' do
     let(:input) { :document }
@@ -119,5 +122,48 @@ describe Azeroth::Model do
         expect(model.decorate(object)).to eq(object.as_json)
       end
     end
+
+    context 'when model has a decorator and option decorator is false' do
+      let(:input)        { :document }
+      let(:reference)    { SecureRandom.uuid }
+      let(:object)       { create(:document, reference: reference) }
+      let(:options_hash) { { decorator: false } }
+
+      context 'when object is just a model and has decorator' do
+        let!(:object) { create(:document, reference: reference) }
+
+        let(:expected_json) do
+          object.as_json
+        end
+
+        it 'object.as_json' do
+          expect(model.decorate(object)).to eq(expected_json)
+        end
+      end
+    end
+
+    context 'when model has a decorator and option decorator is a decorator' do
+      let(:input)        { :document }
+      let(:reference)    { SecureRandom.uuid }
+      let(:object)       { create(:document, reference: reference) }
+      let(:options_hash) { { decorator: Document::DecoratorWithError } }
+
+      context 'when object is just a model and has decorator' do
+        let!(:object) { Document.new }
+
+        let(:expected_json) do
+          {
+            name: nil,
+            errors: {
+              name: ["can't be blank"]
+            }
+          }.stringify_keys
+        end
+
+        it 'object.as_json' do
+          expect(model.decorate(object)).to eq(expected_json)
+        end
+      end
+    end
   end
 end

data/spec/lib/azeroth/request_handler_spec.rb

@@ -8,7 +8,8 @@ describe Azeroth::RequestHandler do
 
     let(:controller) { controller_class.new }
     let(:params)     { ActionController::Parameters.new(parameters) }
-    let(:model)      { Azeroth::Model.new(:document) }
+    let(:model)      { Azeroth::Model.new(:document, options) }
+    let(:options)    { Azeroth::Options.new }
 
     let(:decorator)       { Document::Decorator.new(Document.all) }
     let(:expected_json)   { decorator.as_json }

data/spec/lib/azeroth/resource_builder_spec.rb

@@ -5,7 +5,8 @@ require 'spec_helper'
 describe Azeroth::ResourceBuilder do
   subject(:resource_builder) { described_class.new(model, builder) }
 
-  let(:model)   { Azeroth::Model.new(:document) }
+  let(:model)   { Azeroth::Model.new(:document, options) }
+  let(:options) { Azeroth::Options.new }
   let(:builder) { Sinclair.new(klass) }
   let(:klass)   { Class.new(ResourceBuilderController) }
 

data/spec/lib/azeroth/routes_builder_spec.rb

@@ -9,7 +9,7 @@ describe Azeroth::RoutesBuilder do
 
   let(:controller) { controller_class.new }
   let(:params)     { ActionController::Parameters.new(parameters) }
-  let(:model)      { Azeroth::Model.new(:document) }
+  let(:model)      { Azeroth::Model.new(:document, options) }
   let(:builder)    { Sinclair.new(controller_class) }
   let(:parameters) { { action: :index, format: :json } }
 

data/spec/support/factories/dummy_model.rb

@@ -7,5 +7,6 @@ FactoryBot.define do
     last_name        { 'bot' }
     age              { 21 }
     favorite_pokemon { 'squirtle' }
+    favorite_game    { 'pokemon' }
   end
 end

data/spec/support/shared_examples/request_handler.rb

@@ -5,7 +5,8 @@ shared_examples 'a request handler' do |status: :ok|
 
   let(:controller)      { controller_class.new }
   let(:params)          { ActionController::Parameters.new(parameters) }
-  let(:model)           { Azeroth::Model.new(:document) }
+  let(:model)           { Azeroth::Model.new(:document, options) }
+  let(:options)         { Azeroth::Options.new }
   let(:extra_params)    { {} }
 
   let(:decorator)       { Document::Decorator.new(expected_resource) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Darthjee
@@ -416,6 +416,7 @@ files:
 - lib/azeroth.rb
 - lib/azeroth/decorator.rb
 - lib/azeroth/decorator/hash_builder.rb
+- lib/azeroth/dummy_decorator.rb
 - lib/azeroth/exception.rb
 - lib/azeroth/model.rb
 - lib/azeroth/options.rb
@@ -434,6 +435,7 @@ files:
 - lib/azeroth/routes_builder.rb
 - lib/azeroth/version.rb
 - spec/controllers/documents_controller_spec.rb
+- spec/controllers/documents_with_error_controller_spec.rb
 - spec/controllers/index_documents_controller_spec.rb
 - spec/dummy/.ruby-version
 - spec/dummy/Rakefile
@@ -448,6 +450,7 @@ files:
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/concerns/.keep
 - spec/dummy/app/controllers/documents_controller.rb
+- spec/dummy/app/controllers/documents_with_error_controller.rb
 - spec/dummy/app/controllers/index_documents_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/jobs/application_job.rb
@@ -513,6 +516,7 @@ files:
 - 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
@@ -563,6 +567,7 @@ specification_version: 4
 summary: Azeroth
 test_files:
 - spec/controllers/documents_controller_spec.rb
+- spec/controllers/documents_with_error_controller_spec.rb
 - spec/controllers/index_documents_controller_spec.rb
 - spec/dummy/.ruby-version
 - spec/dummy/Rakefile
@@ -577,6 +582,7 @@ test_files:
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/controllers/concerns/.keep
 - spec/dummy/app/controllers/documents_controller.rb
+- spec/dummy/app/controllers/documents_with_error_controller.rb
 - spec/dummy/app/controllers/index_documents_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
 - spec/dummy/app/jobs/application_job.rb
@@ -642,6 +648,7 @@ test_files:
 - 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