azeroth 0.0.4 → 0.0.5

data/lib/azeroth/resourceable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 
 module Azeroth
@@ -8,7 +10,9 @@ module Azeroth
 
     class_methods do
       def resource_for(name, **options)
-        Builder.new(self, name, **options).build
+        Builder.new(
+          self, name, Azeroth::Options.new(options)
+        ).build
       end
     end
   end

data/lib/azeroth/resourceable/builder.rb

@@ -1,15 +1,26 @@
+# frozen_string_literal: true
+
 require 'sinclair'
 
 module Azeroth
   module Resourceable
+    # @api private
+    # Builder responsible to add all methods to the controller
+    #
+    # Builder uses other builders to put together it's methods
+    #
+    # @see ResourceBuilder
+    # @see ResourceRouteBuilder
+    # @see RoutesBuilder
     class Builder
-      attr_reader :clazz, :model
-
-      delegate :build, :add_method, to: :builder
-
-      def initialize(clazz, model_name, **_options)
+      # @param clazz [ActionController::Base] Controller to
+      #   to be changed
+      # @param model_name [Symbol,String]
+      # @param options [Options]
+      def initialize(clazz, model_name, options)
         @clazz = clazz
         @model = Azeroth::Model.new(model_name)
+        @options = options
 
         add_params
         add_resource
@@ -19,29 +30,113 @@ module Azeroth
 
       private
 
+      attr_reader :clazz, :model, :options
+      # @method clazz
+      # @api private
+      # @private
+      #
+      # Controller to changed
+      #
+      # @return [ActionController::Base]
+
+      # @method model
+      # @api private
+      # @private
+      #
+      # Model interface to resource model
+      #
+      # @return [Model]
+
+      # @method options
+      # @api private
+      # @private
+      #
+      # Options
+      #
+      # @return [Options]
+
+      delegate :build, :add_method, to: :builder
+      # @method build
+      # @api private
+      # @private
+      #
+      # build all the methods
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+
+      # @method add_method
+      # @api private
+      #
+      # Add method to be built
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+
+      delegate :name, :klass, to: :model
+      # @method name
+      # @api private
+      # @private
+      #
+      # Resource name
+      #
+      # @return [Symbol,String]
+
+      # @method klass
+      # @api private
+      # @private
+      #
+      # Controller to be changed
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+
+      # @api private
+      # @private
+      #
+      # Returns a method builder
+      #
+      # @return [Sinclair]
+      #
+      # @see https://www.rubydoc.info/gems/sinclair Sinclair
       def builder
         @builder ||= Sinclair.new(clazz)
       end
 
+      # Add methods for id and parameters
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
       def add_params
-        add_method("#{model.name}_id",     'params.require(:id)')
-        add_method("#{model.name}_params", "params.require(:#{model.name}).permit(:#{permitted_attributes.join(', :')})")
+        add_method("#{name}_id", 'params.require(:id)')
+        add_method(
+          "#{name}_params",
+          <<-CODE
+            params.require(:#{name})
+              .permit(:#{permitted_attributes.join(', :')})
+          CODE
+        )
       end
 
+      # Add methods for resource fetching
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
       def add_resource
         ResourceBuilder.new(model, builder).append
       end
 
+      # Add the routes resource methods
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
       def add_resource_for_routes
         ResourceRouteBuilder.new(model, builder).append
       end
 
+      # Add metohods for each route
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
       def add_routes
-        RoutesBuilder.new(model, builder).append
+        RoutesBuilder.new(model, builder, options).append
       end
 
       def permitted_attributes
-        @permitted_attributes ||= model.klass.attribute_names - ['id']
+        @permitted_attributes ||= klass.attribute_names - ['id']
       end
     end
   end

data/lib/azeroth/routes_builder.rb

@@ -1,35 +1,69 @@
+# frozen_string_literal: true
+
 module Azeroth
+  # @api private
+  # @author Darthjee
+  #
+  # Builder resposible for adding routes methods to the controller
   class RoutesBuilder
-    attr_reader :model, :builder
-
-    delegate :add_method, to: :builder
-
-    def initialize(model, builder)
+    # @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
 
+    # Append the routes methods to be built
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
     def append
-      %i[index show new edit create update destroy].each do |route|
-        add_method(route, route_code[route].to_s)
+      %i[index show new edit create update].each do |route|
+        add_method(route, 'render_basic')
       end
+
+      add_method(:destroy, destroy_code)
     end
 
     private
 
-    def route_code
-      {
-        index: :render_basic,
-        show: :render_basic,
-        new: :render_basic,
-        edit: :render_basic,
-        create: :render_basic,
-        update: :render_basic,
-        destroy: <<-RUBY
-          #{model.name}.destroy
-          head :no_content
-        RUBY
-      }
+    attr_reader :model, :builder
+    # @method model
+    # @api private
+    # @private
+    #
+    # Resource interface
+    #
+    # @return [Model]
+
+    # @method builder
+    # @api private
+    # @private
+    #
+    # Methods builder
+    #
+    # @return [Sinclair]
+
+    delegate :add_method, to: :builder
+    # @method add_method
+    # @api private
+    # @private
+    #
+    # Appends a method
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
+
+    # @private
+    #
+    # Method code to destrou route
+    #
+    # @return [String]
+    def destroy_code
+      <<-RUBY
+        #{model.name}.destroy
+        head :no_content
+      RUBY
     end
   end
 end

data/lib/azeroth/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Azeroth
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.0.5'
 end

data/spec/lib/azeroth/model_spec.rb

@@ -1,29 +1,31 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 shared_examples 'a model wrapper' do
   describe '#name' do
     it 'returns the model name' do
-      expect(subject.name).to eq('document')
+      expect(model.name).to eq('document')
     end
   end
 
   describe '#plural' do
     it 'returns the model name pluralized' do
-      expect(subject.plural).to eq('documents')
+      expect(model.plural).to eq('documents')
     end
   end
 
   describe '#klass' do
     it 'returns the class of the model' do
-      expect(subject.klass).to eq(Document)
+      expect(model.klass).to eq(Document)
     end
   end
 end
 
 describe Azeroth::Model do
-  subject { described_class.new(input) }
+  subject(:model) { described_class.new(input) }
 
-  context 'when initializing with simbol' do
+  context 'when initializing with symbol' do
     let(:input) { :document }
 
     it_behaves_like 'a model wrapper'

data/spec/lib/azeroth/resource_builder_spec.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Azeroth::ResourceBuilder do
-  subject { described_class.new(model, builder) }
+  subject(:resource_builder) { described_class.new(model, builder) }
 
   let(:model)   { Azeroth::Model.new(:document) }
   let(:builder) { Sinclair.new(klass) }
   let(:klass)   { Class.new(ResourceBuilderController) }
 
   before do
-    subject.append
+    resource_builder.append
     10.times { Document.create }
   end
 
@@ -25,7 +27,7 @@ describe Azeroth::ResourceBuilder do
         .to(true)
     end
 
-    context 'after the build' do
+    describe 'after the build' do
       let(:controller) { klass.new(document_id: document.id) }
       let(:document)   { Document.create }
 

data/spec/lib/azeroth/resource_route_builder_spec.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Azeroth::ResourceRouteBuilder do
-  subject { described_class.new(model, builder) }
+  subject(:resource_routes_builder) do
+    described_class.new(model, builder)
+  end
 
   let(:model)   { Azeroth::Model.new(:document) }
   let(:builder) { Sinclair.new(klass) }
   let(:klass)   { Class.new(ResourceRouteBuilderController) }
 
   before do
-    subject.append
+    resource_routes_builder.append
     10.times { Document.create }
   end
 

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

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Azeroth::Resourceable::Builder do
-  subject { described_class.new(klass, :document) }
+  subject { described_class.new(klass, :document, options) }
+
+  let(:options)      { Azeroth::Options.new(options_hash) }
+  let(:options_hash) { {} }
 
   let(:klass) do
     Class.new(Controller) do

data/spec/lib/azeroth/routes_builder_spec.rb

@@ -1,21 +1,27 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Azeroth::RoutesBuilder do
-  subject { described_class.new(model, builder) }
+  subject(:routes_builder) do
+    described_class.new(model, builder, options)
+  end
 
-  let(:model)    { Azeroth::Model.new(:document) }
-  let(:builder)  { Sinclair.new(klass) }
-  let(:klass)    { Class.new(RoutesBuilderController) }
-  let(:instance) { klass.new(params) }
-  let(:params)   { {} }
+  let(:model)        { Azeroth::Model.new(:document) }
+  let(:builder)      { Sinclair.new(klass) }
+  let(:klass)        { Class.new(RoutesBuilderController) }
+  let(:instance)     { klass.new(params) }
+  let(:params)       { {} }
+  let(:options)      { Azeroth::Options.new(options_hash) }
+  let(:options_hash) { {} }
 
   before do
-    subject.append
+    routes_builder.append
     10.times { Document.create }
   end
 
   describe '#append' do
-    before { subject.append }
+    before { routes_builder.append }
 
     it 'adds index route' do
       expect do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 SimpleCov.start do
   add_filter '/spec/'
@@ -7,7 +9,9 @@ require 'pry-nav'
 require 'azeroth'
 
 require 'active_record'
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3', database: ':memory:'
+)
 
 support_files = File.expand_path('spec/support/**/*.rb')
 Dir[support_files].each { |file| require file }

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'action_controller'
 
 class Controller

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ResourceBuilderController
   def initialize(document_id: nil)
     @document_id = document_id

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ResourceRouteBuilderController
   def initialize(id: nil, document: nil)
     @id = id

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class RoutesBuilderController
   def initialize(id: nil, document: nil)
     @id = id

data/spec/support/app/models/document.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class Document < ActiveRecord::Base
 end