azeroth 1.1.0 → 2.1.0

data/lib/azeroth/resourceable.rb

@@ -16,13 +16,16 @@ module Azeroth
       rescue_from ActiveRecord::RecordNotFound, with: :not_found
     end
 
-    autoload :Builder, 'azeroth/resourceable/builder'
-    autoload :ClassMethods, 'azeroth/resourceable/class_methods'
+    autoload :ClassMethods,     'azeroth/resourceable/class_methods'
+    autoload :EndpointsBuilder, 'azeroth/resourceable/endpoints_builder'
+    autoload :ResourcesBuilder, 'azeroth/resourceable/resources_builder'
 
     class << self
       # @method self.resource_for(name, **options)
       # @api public
       #
+      # Adds resource and routes methods for resource
+      #
       # @param name [String, Symbol] Name of the resource
       # @param options [Hash] resource building options
       # @option options only [Array<Symbol,String>,Symbol,String] List of
@@ -45,6 +48,8 @@ module Azeroth
       #   endpoint should be paginated
       # @option options per_page [Integer] number of entries returned per
       #   page on index
+      # @option options id_key [Symbol] key used to find a model. id by default
+      # @option options param_key [Symbol] parameter key used to find the model
       #
       # @return [Array<MethodDefinition>] list of methods created
       #
@@ -209,6 +214,16 @@ module Azeroth
       #     'per_page' => 20,
       #     'page' => 2
       #   }
+
+      # @method self.model_for(name, **options)
+      # @api public
+      #
+      # Adds resource and routes methods for resource
+      #
+      # @param name [String, Symbol] Name of the resource
+      # @param options [Hash] resource building options
+      # @option options id_key [Symbol] key used to find a model. id by default
+      # @option options param_key [Symbol] parameter key used to find the model
     end
 
     private

data/lib/azeroth/version.rb

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

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

@@ -89,7 +89,7 @@ Rails.application.configure do
   config.active_support.deprecation = :notify
 
   # Use default logging formatter so that PID and timestamp are not suppressed.
-  config.log_formatter = ::Logger::Formatter.new
+  config.log_formatter = Logger::Formatter.new
 
   # Use a different logger for distributed setups.
   # require 'syslog/logger'
@@ -98,7 +98,7 @@ Rails.application.configure do
   # )
 
   if ENV['RAILS_LOG_TO_STDOUT'].present?
-    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger           = ActiveSupport::Logger.new($stdout)
     logger.formatter = config.log_formatter
     config.logger    = ActiveSupport::TaggedLogging.new(logger)
   end

data/spec/dummy/config/puma.rb

@@ -6,17 +6,17 @@
 # the maximum value specified for Puma. Default is set to 5 threads for minimum
 # and maximum; this matches the default thread size of Active Record.
 #
-threads_count = ENV.fetch('RAILS_MAX_THREADS') { 5 }
+threads_count = ENV.fetch('RAILS_MAX_THREADS', 5)
 threads threads_count, threads_count
 
 # Specifies the `port` that Puma will listen on to receive requests;
 # default is 3000.
 #
-port        ENV.fetch('PORT') { 3000 }
+port        ENV.fetch('PORT', 3000)
 
 # Specifies the `environment` that Puma will run in.
 #
-environment ENV.fetch('RAILS_ENV') { 'development' }
+environment ENV.fetch('RAILS_ENV', 'development')
 
 # Specifies the number of `workers` to boot in clustered mode.
 # Workers are forked webserver processes. If using threads and workers together

data/spec/dummy/db/schema.rb

@@ -54,7 +54,7 @@ ActiveRecord::Schema.define do
 
   create_table :websites, force: true do |t|
     t.string :domain, null: false
-    t.integer :port, limit: 2, unsigned: true
+    t.integer :port, limit: 2
     t.string :protocol, limit: 5
   end
 end

data/spec/integration/readme/controllers/games_controller_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe GamesController, controller: true do
+describe GamesController, :controller do
   describe 'readme' do
     describe 'POST create' do
       it 'create game' do

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

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe GamesController, controller: true do
+describe GamesController, :controller do
   describe 'yard' do
     describe 'POST create' do
       it 'create game' do

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

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe PaginatedDocumentsController, controller: true do
+describe PaginatedDocumentsController, :controller do
   describe 'yard' do
     describe 'GET index' do
       before { create_list(:document, 30) }

data/spec/lib/azeroth/controller_interface_spec.rb

@@ -11,7 +11,7 @@ describe Azeroth::ControllerInterface do
   describe '#add_headers' do
     let(:controller_headers) do
       {
-        'old_key': 100
+        old_key: 100
       }
     end
 

data/spec/lib/azeroth/decorator_spec.rb

@@ -416,12 +416,10 @@ describe Azeroth::Decorator do
     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

data/spec/lib/azeroth/params_builder_spec.rb

@@ -4,55 +4,71 @@ require 'spec_helper'
 
 describe Azeroth::ParamsBuilder do
   subject(:params_builder) do
-    described_class.new(model: model, builder: builder)
+    described_class.new(model: model, builder: builder, options: options)
   end
 
-  let(:model)   { Azeroth::Model.new(:document, options) }
-  let(:options) { Azeroth::Options.new }
-  let(:builder) { Sinclair.new(klass) }
-  let(:klass)   { Class.new(ParamsBuilderController) }
+  let(:model)        { Azeroth::Model.new(:document, options) }
+  let(:options)      { Azeroth::Options.new(options_hash) }
+  let(:options_hash) { {} }
+  let(:builder)      { Sinclair.new(klass) }
+  let(:klass)        { Class.new(ParamsBuilderController) }
+  let(:controller)   { klass.new(id, attributes) }
+  let(:attributes)   { document.attributes }
+  let(:document)     { create(:document) }
+  let(:id)           { Random.rand(10..100) }
 
   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
+    context 'when no options are given' do
+      it 'adds id method' do
+        expect { builder.build }
+          .to add_method(:document_id).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
-        }
+      it 'adds params method' do
+        expect { builder.build }
+          .to add_method(:document_params).to(klass)
       end
 
-      before { builder.build }
+      describe 'after the build' do
+        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)
+        context 'when requesting id' do
+          it 'returns id from request path' do
+            expect(controller.document_id).to eq(id)
+          end
         end
-      end
 
-      context 'when requesting params' do
-        it 'returns payload' do
-          expect(controller.document_params.to_h)
-            .to eq(expected_attributes)
+        context 'when requesting params' do
+          it 'returns payload' do
+            expect(controller.document_params.to_h)
+              .to eq(expected_attributes)
+          end
         end
       end
     end
   end
+
+  context 'when no options are given' do
+    let(:options_hash) { { param_key: :document_id } }
+    let(:controller)   { klass.new(id, attributes, param_id: :document_id) }
+
+    before { builder.build }
+
+    context 'when requesting id' do
+      it 'returns id from request path' do
+        expect(controller.document_id).to eq(id)
+      end
+    end
+  end
 end

data/spec/lib/azeroth/request_handler/update_spec.rb

@@ -30,7 +30,7 @@ describe Azeroth::RequestHandler::Update do
       end
     end
 
-    context 'when update_with option is given ' do
+    context 'when update_with option is given' do
       context 'with block' do
         it_behaves_like 'a request handler' do
           let(:block) do

data/spec/lib/azeroth/resource_builder_spec.rb

@@ -4,13 +4,14 @@ require 'spec_helper'
 
 describe Azeroth::ResourceBuilder do
   subject(:resource_builder) do
-    described_class.new(model: model, builder: builder)
+    described_class.new(model: model, builder: builder, options: options)
   end
 
-  let(:model)   { Azeroth::Model.new(:document, options) }
-  let(:options) { Azeroth::Options.new }
-  let(:builder) { Sinclair.new(klass) }
-  let(:klass)   { Class.new(ResourceBuilderController) }
+  let(:model)        { Azeroth::Model.new(:document, options) }
+  let(:options)      { Azeroth::Options.new(options_hash) }
+  let(:options_hash) { {} }
+  let(:builder)      { Sinclair.new(klass) }
+  let(:klass)        { Class.new(ResourceBuilderController) }
 
   before do
     resource_builder.append
@@ -18,21 +19,44 @@ describe Azeroth::ResourceBuilder do
   end
 
   describe '#append' do
-    it 'adds the listing method' do
-      expect { builder.build }
-        .to change { klass.new.respond_to?(:documents) }
-        .to(true)
-    end
+    context 'when no option is given' do
+      it 'adds the listing method' do
+        expect { builder.build }
+          .to change { klass.new.respond_to?(:documents) }
+          .to(true)
+      end
+
+      it 'adds the fetching method' do
+        expect { builder.build }
+          .to change { klass.new.respond_to?(:document) }
+          .to(true)
+      end
+
+      describe 'after the build' do
+        let(:controller) { klass.new(document_id: document.id) }
+        let(:document)   { create(:document) }
+
+        before { builder.build }
 
-    it 'adds the fetching method' do
-      expect { builder.build }
-        .to change { klass.new.respond_to?(:document) }
-        .to(true)
+        context 'when requesting the list of documents' do
+          it 'returns the list of documents' do
+            expect(controller.documents).to eq(Document.all)
+          end
+        end
+
+        context 'when requesting one document' do
+          it 'returns the requested document' do
+            expect(controller.document).to eq(document)
+          end
+        end
+      end
     end
 
-    describe 'after the build' do
-      let(:controller) { klass.new(document_id: document.id) }
-      let(:document)   { create(:document) }
+    context 'when id_key option is given' do
+      let(:options_hash) { { id_key: :reference } }
+
+      let(:controller) { klass.new(document_id: document.reference) }
+      let(:document)   { create(:document, reference: SecureRandom.hex(20)) }
 
       before { builder.build }
 

data/spec/lib/azeroth/resourceable/endpoints_builder_spec.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::Resourceable::EndpointsBuilder do
+  subject(:builder) { described_class.new(klass, :document, options) }
+
+  let(:options)      { Azeroth::Options.new(options_hash) }
+  let(:options_hash) { {} }
+
+  let(:klass) do
+    Class.new(Controller) do
+    end
+  end
+
+  describe '#build' do
+    let(:available_routes) { %i[index show new destroy create update] }
+    let(:expected_params_methods)   { %i[document_id document_params] }
+    let(:expected_routes_methods)   { available_routes }
+    let(:expected_resource_methods) { %i[document documents] }
+
+    context 'when no option is given' do
+      it 'adds params methods' do
+        expect { builder.build }
+          .to change { (klass.instance_methods & expected_params_methods).sort }
+          .from([]).to(expected_params_methods.sort)
+      end
+
+      it 'adds routes methods' do
+        expect { builder.build }
+          .to change { (klass.instance_methods & available_routes).sort }
+          .from([]).to(expected_routes_methods.sort)
+      end
+
+      it 'adds resource methods' do
+        expect { builder.build }
+          .to change { (klass.instance_methods & expected_resource_methods).sort }
+          .from([]).to(expected_resource_methods.sort)
+      end
+    end
+
+    context 'when only option is given for a route' do
+      let(:options_hash) { { only: route } }
+      let(:route)                   { available_routes.sample }
+      let(:expected_routes_methods) { [route] }
+
+      it 'adds routes methods' do
+        expect { builder.build }
+          .to change { (klass.instance_methods & available_routes).sort }
+          .from([]).to(expected_routes_methods.sort)
+      end
+    end
+
+    context 'when only option as array is given for a route' do
+      let(:options_hash) { { only: routes } }
+      let(:routes)                  { [available_routes.sample, available_routes.sample].uniq }
+      let(:expected_routes_methods) { routes }
+
+      it 'adds routes methods' do
+        expect { builder.build }
+          .to change { (klass.instance_methods & available_routes).sort }
+          .from([]).to(expected_routes_methods.sort)
+      end
+    end
+
+    context 'when except option is given for a route' do
+      let(:options_hash) { { except: route } }
+      let(:route)                   { available_routes.sample }
+      let(:expected_routes_methods) { available_routes - [route] }
+
+      it 'adds routes methods' do
+        expect { builder.build }
+          .to change { (klass.instance_methods & available_routes).sort }
+          .from([]).to(expected_routes_methods.sort)
+      end
+    end
+
+    context 'when except option as array is given for a route' do
+      let(:options_hash) { { except: routes } }
+      let(:routes)                  { [available_routes.sample, available_routes.sample].uniq }
+      let(:expected_routes_methods) { available_routes - routes }
+
+      it 'adds routes methods' do
+        expect { builder.build }
+          .to change { (klass.instance_methods & available_routes).sort }
+          .from([]).to(expected_routes_methods.sort)
+      end
+    end
+  end
+end

data/spec/lib/azeroth/resourceable/resources_builder_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Azeroth::Resourceable::ResourcesBuilder do
+  subject(:builder) { described_class.new(klass, :document, options) }
+
+  let(:options)      { Azeroth::Options.new(options_hash) }
+  let(:options_hash) { {} }
+
+  let(:klass) do
+    Class.new(Controller) do
+    end
+  end
+
+  describe '#build' do
+    let(:expected_resource_methods) { %i[document documents] }
+    let(:expected_params_methods)   { %i[document_id document_params] }
+
+    it 'adds params methods' do
+      expect { builder.build }
+        .to change { (klass.instance_methods & expected_params_methods).sort }
+        .from([]).to(expected_params_methods.sort)
+    end
+
+    it 'adds resource methods' do
+      expect { builder.build }
+        .to change { (klass.instance_methods & expected_resource_methods).sort }
+        .from([]).to(expected_resource_methods.sort)
+    end
+  end
+end

data/spec/lib/azeroth/resourceable_spec.rb

@@ -10,54 +10,41 @@ describe Azeroth::Resourceable do
   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 }
+    let(:available_routes) { %i[index show new destroy create update] }
+    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
+      it 'add routes methods' do
+        expect { controller_class.resource_for(model_name) }
+          .to change { (controller.methods & available_routes).sort }
+          .from([]).to(available_routes.sort)
       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
+      let(:options) { { only: expected_routes_methods } }
+      let(:expected_routes_methods) { %i[index show] }
 
-      %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
+      it 'add routes methods' do
+        expect { controller_class.resource_for(model_name, **options) }
+          .to change { (controller.methods & available_routes).sort }
+          .from([]).to(expected_routes_methods.sort)
       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
+      let(:options) { { except: skipped_routes } }
+      let(:skipped_routes)          { %i[index show] }
+      let(:expected_routes_methods) { available_routes - skipped_routes }
+
+      it 'add routes methods' do
+        expect { controller_class.resource_for(model_name, **options) }
+          .to change { (controller.methods & available_routes).sort }
+          .from([]).to(expected_routes_methods.sort)
       end
     end
 
@@ -105,4 +92,17 @@ describe Azeroth::Resourceable do
       end
     end
   end
+
+  describe '.model_for' do
+    let(:model_name) { :document }
+    let(:model)                     { create(model_name) }
+    let(:controller)                { controller_class.new({}) }
+    let(:expected_resource_methods) { %i[document documents] }
+
+    it 'adds resource methods' do
+      expect { controller_class.model_for(model_name) }
+        .to change { (controller.methods & expected_resource_methods).sort }
+        .from([]).to(expected_resource_methods.sort)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -22,7 +22,7 @@ require 'shoulda-matchers'
 require 'rspec/collection_matchers'
 
 support_files = File.expand_path('spec/support/**/*.rb')
-Dir[support_files].sort.each { |file| require file }
+Dir[support_files].each { |file| require file }
 
 RSpec::Matchers.define_negated_matcher :not_change, :change
 RSpec::Matchers.define_negated_matcher :not_add_method, :add_method

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

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

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 class ParamsBuilderController
-  def initialize(id, attributes)
+  def initialize(id, attributes, param_id: :id)
     @params = ActionController::Parameters.new(
-      id: id,
+      param_id => id,
       document: attributes
     )
   end

data/spec/support/matchers/add_method.rb

@@ -6,11 +6,12 @@ module RSpec
       attr_reader :method
 
       def initialize(method = nil)
+        super
         @method = method
       end
 
-      def to(instance = nil, &block)
-        AddMethodTo.new(instance, method, &block)
+      def to(instance = nil, &)
+        AddMethodTo.new(instance, method, &)
       end
     end
 
@@ -18,6 +19,7 @@ module RSpec
       attr_reader :method, :instance, :block
 
       def initialize(instance, method, &block)
+        super
         @instance = instance
         @method = method
         @block = block
@@ -68,8 +70,8 @@ module RSpec
 
       def raise_block_syntax_error
         raise SyntaxError, 'Block not received by the' \
-        '`add_method_to` matcher. ' \
-        'Perhaps you want to use `{ ... }` instead of do/end?'
+                           '`add_method_to` matcher. ' \
+                           'Perhaps you want to use `{ ... }` instead of do/end?'
       end
     end
   end

data/spec/support/shared_examples/request_handler.rb

@@ -29,15 +29,11 @@ shared_examples 'a request handler' do |status: :ok|
   before do
     create_list(:document, documents_count)
 
-    allow(controller).to receive(:params)
-      .and_return(params)
-
     allow(controller).to receive(:render)
       .with(json: expected_json, status: status)
       .and_return(expected_json)
 
-    allow(controller).to receive(:headers)
-      .and_return(controller_headers)
+    allow(controller).to receive_messages(params: params, headers: controller_headers)
   end
 
   it 'returns all documents json' do