azeroth 0.10.0 → 1.0.0

data/lib/azeroth/resourceable.rb

@@ -8,8 +8,6 @@ module Azeroth
   #
   # Concern for building controller methods for the routes
   #
-  # @example (see Resourceable::ClassMethods#resource_for)
-  #
   # @see Resourceable::ClassMethods
   module Resourceable
     extend ActiveSupport::Concern
@@ -27,21 +25,190 @@ module Azeroth
       #
       # @param name [String, Symbol] Name of the resource
       # @param options [Hash] resource building options
-      # @option options only [Array<Symbol,String>] List of
+      # @option options only [Array<Symbol,String>,Symbol,String] List of
       #   actions to be built
-      # @option options except [Array<Symbol,String>] List of
+      # @option options except [Array<Symbol,String>,Symbol,String] List of
       #   actions to not to be built
       # @option options decorator [Azeroth::Decorator,TrueClass,FalseClass]
       #   Decorator class or flag allowing/disallowing decorators
       # @option options before_save [Symbol,Proc] method/block
       #   to be ran on the controller before saving the resource
+      # @option options after_save [Symbol,Proc] method/block
+      #   to be ran on the controller after saving the resource
       # @option options build_with [Symbol,Proc] method/block
       #   to be ran when building resource
       #   (default proc { <resource_collection>.build(resource_params) }
+      # @option options update_with [Symbol,Proc] method/block
+      #   to be ran when updating resource
+      #   (default proc { <resource>.update(resource_params) }
+      # @option options paginated [TrueClass,FalseClass] flag defining if index
+      #   endpoint should be paginated
+      # @option options per_page [Integer] number of entries returned per
+      #   page on index
       #
       # @return [Array<MethodDefinition>] list of methods created
       #
       # @see Options::DEFAULT_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, only: %w[create index show]
+      #   end
+      #
+      # @example complete example gmaes and publishers
+      #   class PublishersController < ApplicationController
+      #     include Azeroth::Resourceable
+      #     skip_before_action :verify_authenticity_token
+      #
+      #     resource_for :publisher, only: %i[create index]
+      #   end
+      #
+      #   class GamesController < ApplicationController
+      #     include Azeroth::Resourceable
+      #     skip_before_action :verify_authenticity_token
+      #
+      #     resource_for :game, except: :delete
+      #
+      #     private
+      #
+      #     def games
+      #       publisher.games
+      #     end
+      #
+      #     def publisher
+      #       @publisher ||= Publisher.find(publisher_id)
+      #     end
+      #
+      #     def publisher_id
+      #       params.require(:publisher_id)
+      #     end
+      #   end
+      #
+      #   ActiveRecord::Schema.define do
+      #     self.verbose = false
+      #
+      #     create_table :publishers, force: true do |t|
+      #       t.string :name
+      #     end
+      #
+      #     create_table :games, force: true do |t|
+      #       t.string :name
+      #       t.integer :publisher_id
+      #     end
+      #    end
+      #
+      #   class Publisher < ActiveRecord::Base
+      #     has_many :games
+      #   end
+      #
+      #   class Game < ActiveRecord::Base
+      #     belongs_to :publisher
+      #   end
+      #
+      #   class Game::Decorator < Azeroth::Decorator
+      #     expose :id
+      #     expose :name
+      #     expose :publisher, decorator: NameDecorator
+      #   end
+      #
+      # @example requesting games and publishers
+      #   post "/publishers.json", params: {
+      #     publisher: {
+      #       name: 'Nintendo'
+      #     }
+      #   }
+      #
+      #   publisher = JSON.parse(response.body)
+      #   # returns
+      #   # {
+      #   #   'id' => 11,
+      #   #   'name' => 'Nintendo'
+      #   # }
+      #
+      #   publisher = Publisher.last
+      #   post "/publishers/#{publisher['id']}/games.json", params: {
+      #     game: {
+      #       name: 'Pokemon'
+      #     }
+      #   }
+      #
+      #   game = Game.last
+      #
+      #   JSON.parse(response.body)
+      #   # returns
+      #   # {
+      #   #   id: game.id,
+      #   #   name: 'Pokemon',
+      #   #   publisher: {
+      #   #     name: 'Nintendo'
+      #   #   }
+      #   # }
+      #
+      # @example Controller with before_save
+      #   class PokemonsController < ApplicationController
+      #     include Azeroth::Resourceable
+      #
+      #     resource_for :pokemon,
+      #                  only: %i[create update],
+      #                  before_save: :set_favorite
+      #
+      #     private
+      #
+      #     def set_favorite
+      #       pokemon.favorite = true
+      #     end
+      #
+      #     def pokemons
+      #       master.pokemons
+      #     end
+      #
+      #     def master
+      #       @master ||= PokemonMaster.find(master_id)
+      #     end
+      #
+      #     def master_id
+      #       params.require(:pokemon_master_id)
+      #     end
+      #   end
+      #
+      # @example Controller with paginated index response
+      #
+      #   class PaginatedDocumentsController < ApplicationController
+      #     include Azeroth::Resourceable
+      #
+      #     resource_for :document, only: 'index', paginated: true
+      #   end
+      #
+      #   30.times { create(:document) }
+      #
+      #   get '/paginated_documents.json'
+      #
+      #   # returns Array with 20 first documents
+      #   # returns in the headers pagination headers
+      #   {
+      #     'pages' => 2,
+      #     'per_page' => 20,
+      #     'page' => 1
+      #   }
+      #
+      #   get '/paginated_documents.json?page=2'
+      #
+      #   # returns Array with 10 next documents
+      #   # returns in the headers pagination headers
+      #   {
+      #     'pages' => 2,
+      #     'per_page' => 20,
+      #     'page' => 2
+      #   }
     end
 
     private

data/lib/azeroth/routes_builder.rb

@@ -5,15 +5,14 @@ module Azeroth
   # @author Darthjee
   #
   # Builder resposible for adding routes methods to the controller
-  class RoutesBuilder
-    # @param model [Model] resource interface
-    # @param builder [Sinclair] methods builder
-    # @param options [Option]
-    def initialize(model, builder, options)
-      @model = model
-      @builder = builder
-      @options = options
-    end
+  class RoutesBuilder < Sinclair::Model
+    initialize_with(:model, :builder, :options, writter: false)
+
+    # @method initialize(model:, builder:, options:)
+    #   @param model [Model] resource interface
+    #   @param builder [Sinclair] methods builder
+    #   @param options [Option]
+    #   @return [RoutesBuilder]
 
     # Append the routes methods to be built
     #
@@ -26,7 +25,6 @@ module Azeroth
 
     private
 
-    attr_reader :model, :builder, :options
     # @method model
     # @api private
     # @private

data/lib/azeroth/version.rb

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

data/lib/azeroth.rb

@@ -15,6 +15,7 @@ module Azeroth
   autoload :Decorator,           'azeroth/decorator'
   autoload :DummyDecorator,      'azeroth/dummy_decorator'
   autoload :Model,               'azeroth/model'
+  autoload :ParamsBuilder,       'azeroth/params_builder'
   autoload :RequestHandler,      'azeroth/request_handler'
   autoload :Resourceable,        'azeroth/resourceable'
   autoload :ResourceBuilder,     'azeroth/resource_builder'

data/spec/controllers/documents_with_error_controller_spec.rb

@@ -128,7 +128,9 @@ describe DocumentsWithErrorController do
 
     it 'returns updated document json' do
       patch :update, params: parameters
-      expect(response.body).to eq(expected_body)
+
+      expect(JSON.parse(response.body))
+        .to eq(JSON.parse(expected_body))
     end
 
     it do

data/spec/dummy/app/models/movie/simple_decorator.rb

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

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Movie < ActiveRecord::Base
+  validates :name, :director, presence: true
+end

data/spec/dummy/config/environments/development.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 Rails.application.configure do
+  config.hosts << 'www.example.com'
   # Settings specified here will take precedence over
   # those in config/application.rb.
 

data/spec/dummy/db/schema.rb

@@ -47,5 +47,8 @@ ActiveRecord::Schema.define do
     t.index %i[pokemon_master_id favorite], unique: true
   end
 
-  add_foreign_key 'pokemons', 'pokemon_masters'
+  create_table :movies, force: true do |t|
+    t.string :name, null: false
+    t.string :director, null: false
+  end
 end

data/spec/integration/yard/controllers/paginated_documents_controller_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe PaginatedDocumentsController, controller: true do
+  describe 'yard' do
+    describe 'GET index' do
+      before { create_list(:document, 30) }
+
+      it 'list documents with pagination page' do
+        get '/paginated_documents.json'
+
+        documents = JSON.parse(response.body)
+        expect(documents)
+          .to have(20).items
+
+        expect(response.headers['pages']).to eq(2)
+        expect(response.headers['per_page']).to eq(20)
+        expect(response.headers['page']).to eq(1)
+
+        get '/paginated_documents.json?page=2'
+
+        documents = JSON.parse(response.body)
+        expect(documents)
+          .to have(10).items
+
+        expect(response.headers['pages']).to eq(2)
+        expect(response.headers['per_page']).to eq(20)
+        expect(response.headers['page']).to eq(2)
+      end
+    end
+  end
+end

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

@@ -4,7 +4,9 @@ require 'spec_helper'
 
 describe Azeroth::Decorator::KeyValueExtractor do
   subject(:extractor) do
-    described_class.new(decorator, attribute, options)
+    described_class.new(
+      decorator: decorator, attribute: attribute, options: options
+    )
   end
 
   let(:decorator_class) { Class.new(Azeroth::Decorator) }

data/spec/lib/azeroth/params_builder_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::ParamsBuilder do
+  subject(:params_builder) do
+    described_class.new(model: model, builder: builder)
+  end
+
+  let(:model)   { Azeroth::Model.new(:document, options) }
+  let(:options) { Azeroth::Options.new }
+  let(:builder) { Sinclair.new(klass) }
+  let(:klass)   { Class.new(ParamsBuilderController) }
+
+  before do
+    params_builder.append
+  end
+
+  describe '#append' do
+    it 'adds id method' do
+      expect { builder.build }
+        .to add_method(:document_id).to(klass)
+    end
+
+    it 'adds params method' do
+      expect { builder.build }
+        .to add_method(:document_params).to(klass)
+    end
+
+    describe 'after the build' do
+      let(:controller) { klass.new(id, attributes) }
+      let(:document)   { create(:document) }
+      let(:attributes) { document.attributes }
+      let(:id)         { Random.rand(10..100) }
+      let(:expected_attributes) do
+        {
+          'name' => document.name,
+          'reference' => document.reference
+        }
+      end
+
+      before { builder.build }
+
+      context 'when requesting id' do
+        it 'returns id from request path' do
+          expect(controller.document_id).to eq(id)
+        end
+      end
+
+      context 'when requesting params' do
+        it 'returns payload' do
+          expect(controller.document_params.to_h)
+            .to eq(expected_attributes)
+        end
+      end
+    end
+  end
+end

data/spec/lib/azeroth/resource_builder_spec.rb

@@ -3,7 +3,9 @@
 require 'spec_helper'
 
 describe Azeroth::ResourceBuilder do
-  subject(:resource_builder) { described_class.new(model, builder) }
+  subject(:resource_builder) do
+    described_class.new(model: model, builder: builder)
+  end
 
   let(:model)   { Azeroth::Model.new(:document, options) }
   let(:options) { Azeroth::Options.new }

data/spec/lib/azeroth/resourceable_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::Resourceable do
+  let(:controller_class) do
+    Class.new(Controller) do
+      include Azeroth::Resourceable
+    end
+  end
+
+  describe '.resource_for' do
+    let(:params)     { { id: model.id, format: :json } }
+    let(:model_name) { :document }
+    let(:model)      { create(model_name) }
+    let(:controller) { controller_class.new(params) }
+    let(:decorator)  { Document::Decorator }
+
+    context 'when no special option is given' do
+      %i[index show new edit update destroy].each do |method_name|
+        it do
+          expect { controller_class.resource_for(model_name) }
+            .to add_method(method_name).to(controller_class)
+        end
+      end
+    end
+
+    context 'when passing the only option' do
+      let(:options) { { only: %i[index show] } }
+
+      %i[index show].each do |method_name|
+        it do
+          expect { controller_class.resource_for(model_name, **options) }
+            .to add_method(method_name).to(controller_class)
+        end
+      end
+
+      %i[new edit update destroy].each do |method_name|
+        it do
+          expect { controller_class.resource_for(model_name, **options) }
+            .not_to add_method(method_name).to(controller_class)
+        end
+      end
+    end
+
+    context 'when passing the except option' do
+      let(:options) { { except: %i[index show] } }
+
+      %i[index show].each do |method_name|
+        it do
+          expect { controller_class.resource_for(model_name, **options) }
+            .not_to add_method(method_name).to(controller_class)
+        end
+      end
+
+      %i[new edit update destroy].each do |method_name|
+        it do
+          expect { controller_class.resource_for(model_name, **options) }
+            .to add_method(method_name).to(controller_class)
+        end
+      end
+    end
+
+    context 'when passing decorator option' do
+      let(:model_name) { :movie }
+      let(:decorator)  { Movie::SimpleDecorator }
+      let(:rendered)   { {} }
+
+      before do
+        controller_class.resource_for(model_name, decorator: decorator)
+
+        allow(controller).to receive(:render) do |args|
+          rendered.merge!(args[:json])
+        end
+      end
+
+      it 'decorates the model' do
+        controller.show
+        expect(rendered).to eq(decorator.new(model).as_json)
+      end
+    end
+
+    context 'when the method is called' do
+      let(:rendered) { {} }
+
+      before do
+        controller_class.resource_for(model_name)
+        allow(controller).to receive(:render) do |args|
+          rendered.merge!(args[:json])
+        end
+      end
+
+      it 'decorates the model' do
+        controller.show
+        expect(rendered).to eq(decorator.new(model).as_json)
+      end
+
+      context 'when the model does not have a decorator' do
+        let(:model_name) { :movie }
+
+        it 'renders model as json' do
+          controller.show
+          expect(rendered).to eq(model.as_json)
+        end
+      end
+    end
+  end
+end

data/spec/lib/azeroth/routes_builder_spec.rb

@@ -4,7 +4,9 @@ require 'spec_helper'
 
 describe Azeroth::RoutesBuilder do
   subject(:routes_builder) do
-    described_class.new(model, builder, options)
+    described_class.new(
+      model: model, builder: builder, options: options
+    )
   end
 
   let(:controller) { controller_class.new }

data/spec/support/app/controllers/controller.rb

@@ -2,7 +2,7 @@
 
 require 'action_controller'
 
-class Controller
+class Controller < ActionController::Base
   def initialize(params = {})
     @params = ActionController::Parameters.new(params)
   end

data/spec/support/app/controllers/params_builder_controller.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class ParamsBuilderController
+  def initialize(id, attributes)
+    @params = ActionController::Parameters.new(
+      id: id,
+      document: attributes
+    )
+  end
+
+  private
+
+  attr_reader :params
+end

data/spec/support/factories/movie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :movie, class: '::Movie' do
+    sequence(:name)     { |n| "Name-#{n}" }
+    sequence(:director) { |n| "Director-#{n}" }
+  end
+end