azeroth 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe08d469b1d7f7de1b5e506ecfb28bf25d0529f12cb0ed44e738373685ff2f86
-  data.tar.gz: f947cca246ca569dfad592f4a25d806bdc32f4c5071a409719590828f2fb0b36
+  metadata.gz: afd378d756eaf524cab794de457c654237f287bee671be9e6409702528695247
+  data.tar.gz: 6dabd7110587bb3df0dcf7239a179ea1ceaee017692262f2366a2ac8b73fe0fc
 SHA512:
-  metadata.gz: ffd2677abcd53391963db5e8d4fb40cf35f3c0d86ad41a82bea3b9149a894bd6d8c7737e499c75cbb410106611f1c1c897c174069b9f5e74c8081f72e47fd258
-  data.tar.gz: 998012e33fe8abc53f81633a85d54181b4db805bb578b619b97c2a3974f1509ee06c260e0ef81e728b4965a9457bb805237cf711b334faded65ce399a25d07e3
+  metadata.gz: b434a935b247bce958b72abefc6dc82063df57c9ad331e3b087c246e95cebea9dc2a619964081c54c65fe5c2775b62f5fac1b58ed4122a3776850922b24096b7
+  data.tar.gz: d12697602efd61c4932b8fddb3e6b83b273dc51c441b4f9c5a1cf07a5325933e6b3c0629f594b06921d06a8cd4f37998f75ccedbf39c3a4950f7d9353fc3bfaf

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: darthjee/circleci_ruby_gems:0.2.3
+      - image: darthjee/circleci_rails_gems:0.2.3
         environment:
           PROJECT: azeroth
     steps:

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM darthjee/ruby_gems:0.2.3 as base
+FROM darthjee/rails_gems:0.2.3 as base
 FROM darthjee/scripts:0.1.2 as scripts
 
 ######################################

data/README.md

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

data/azeroth.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'activesupport', '~> 5.2.0'
+  gem.add_runtime_dependency 'activesupport',       '~> 5.2.0'
   gem.add_runtime_dependency 'darthjee-active_ext', '>= 1.3.2'
-  gem.add_runtime_dependency 'sinclair', '>= 1.5.2'
+  gem.add_runtime_dependency 'sinclair',            '>= 1.5.2'
 
   gem.add_development_dependency 'actionpack',               '~> 5.x'
   gem.add_development_dependency 'activerecord',             '~> 5.x'

data/config/yardstick.yml

@@ -24,6 +24,7 @@ rules:
     exclude:
       - Azeroth::Decorator#initialize
       - Azeroth::Model#initialize
+      - Azeroth::RequestHandler#initialize
       - Azeroth::ResourceBuilder#initialize
       - Azeroth::ResourceRouteBuilder#initialize
       - Azeroth::Resourceable::Builder#initialize

data/lib/azeroth.rb

@@ -5,12 +5,15 @@
 # Lib for easily developing controllers
 #
 # @see Resourceable
+
+require 'sinclair'
+
 module Azeroth
   autoload :Decorator,            'azeroth/decorator'
   autoload :Model,                'azeroth/model'
+  autoload :RequestHandler,       'azeroth/request_handler'
   autoload :Resourceable,         'azeroth/resourceable'
   autoload :ResourceBuilder,      'azeroth/resource_builder'
-  autoload :ResourceRouteBuilder, 'azeroth/resource_route_builder'
   autoload :RoutesBuilder,        'azeroth/routes_builder'
   autoload :Options,              'azeroth/options'
 end

data/lib/azeroth/request_handler.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Azeroth
+  # @api private
+  #
+  # Handle a request on behalf of the controller
+  #
+  # Request handler sends messages to the controller
+  # in order to get the resource and rendering the response
+  class RequestHandler
+    autoload :Create,  'azeroth/request_handler/create'
+    autoload :Destroy, 'azeroth/request_handler/destroy'
+    autoload :Edit,    'azeroth/request_handler/edit'
+    autoload :Index,   'azeroth/request_handler/index'
+    autoload :New,     'azeroth/request_handler/new'
+    autoload :Show,    'azeroth/request_handler/show'
+    autoload :Update,  'azeroth/request_handler/update'
+
+    # @param controller [ApplicationController]
+    # @param model [Azeroth::Model]
+    def initialize(controller, model)
+      @controller = controller
+      @model = model
+    end
+
+    # process the request
+    #
+    # No action is performd when format is HTML
+    #
+    # When format is json, the resource is fetched/processed
+    # (by the subclass) and returned as json (decorated)
+    #
+    # @return [String]
+    def process
+      return unless json?
+
+      json = model.decorate(resource)
+
+      controller.instance_eval do
+        render(json: json)
+      end
+    end
+
+    private
+
+    attr_reader :controller, :model
+    # @method controller
+    # @api private
+    # @private
+    #
+    # Controller to receive the message
+    #
+    # @return [ApplicationController]
+
+    # @method model
+    # @api private
+    # @private
+    #
+    # Model interface
+    #
+    # @return [Azeroth::Model]
+
+    delegate :params, to: :controller
+    # @method params
+    # @api private
+    # @private
+    #
+    # request parameters
+    #
+    # @return [ActionController::Parameters]
+
+    # @private
+    #
+    # Checks if request format is json
+    #
+    # @return [TrueClass,FalseClass]
+    def json?
+      params[:format]&.to_s == 'json'
+    end
+
+    # @private
+    #
+    # Resource to be serialized and returned
+    #
+    # Must be implemented in subclass
+    #
+    # @return [Object]
+    # @raise Not implmented
+    def resource
+      raise 'must be implemented in subclass'
+    end
+  end
+end

data/lib/azeroth/request_handler/create.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class RequestHandler
+    # @api private
+    #
+    # hadler for requests to create resources
+    class Create < RequestHandler
+      private
+
+      # @private
+      #
+      # Creates and return an instance of the model
+      #
+      # creation uses the method +"#{model.name}_params"+ to
+      # fetch all allowed attributes for creation
+      #
+      # @return [Object]
+      def resource
+        attributes = controller.send("#{model.name}_params")
+        collection = controller.send(model.plural)
+        collection.create(attributes)
+      end
+    end
+  end
+end

data/lib/azeroth/request_handler/destroy.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class RequestHandler
+    # @api private
+    #
+    # hadler for requests to destroy resources
+    class Destroy < RequestHandler
+      private
+
+      # @private
+      #
+      # Destroy and return an instance of the model
+      #
+      # @return [Object]
+      def resource
+        resource = controller.send(model.name)
+        resource.tap(&:destroy)
+      end
+    end
+  end
+end

data/lib/azeroth/request_handler/edit.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class RequestHandler
+    # @api private
+    #
+    # hadler for requests to edit resources
+    #
+    # This handler does the same as {Show}
+    # returning the model for editing
+    class Edit < RequestHandler::Show
+    end
+  end
+end

data/lib/azeroth/request_handler/index.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class RequestHandler
+    # @api private
+    #
+    # hadler for requests to list resources
+    class Index < RequestHandler
+      private
+
+      # @private
+      #
+      # return a collection of the model
+      #
+      # @return [Enumerable<Object>]
+      def resource
+        controller.send(model.plural)
+      end
+    end
+  end
+end

data/lib/azeroth/request_handler/new.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class RequestHandler
+    # @api private
+    #
+    # hadler for requests for new resources
+    class New < RequestHandler
+      private
+
+      # @private
+      #
+      # returns a new empty instance of the model
+      #
+      # the initialization of the model uses the collection
+      # so that any attribute related to the collection
+      # will be present
+      #
+      # @return [Object]
+      def resource
+        controller.send(model.plural).new
+      end
+    end
+  end
+end

data/lib/azeroth/request_handler/show.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class RequestHandler
+    # @api private
+    #
+    # hadler for requests to show a resource
+    class Show < RequestHandler
+      private
+
+      # @private
+      #
+      # Finds and return an instance of the model
+      #
+      # finding happens through calling the controller
+      # method +"#{model.name}"+
+      #
+      # @return [Object]
+      def resource
+        controller.send(model.name)
+      end
+    end
+  end
+end

data/lib/azeroth/request_handler/update.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class RequestHandler
+    # @api private
+    #
+    # hadler for requests to update resource
+    class Update < RequestHandler
+      private
+
+      # @private
+      #
+      # Updates and return an instance of the model
+      #
+      # update uses the method +"#{model.name}_params"+ to
+      # fetch all allowed attributes for update
+      #
+      # @return [Object]
+      def resource
+        attributes = controller.send("#{model.name}_params")
+        resource = controller.send(model.name)
+        resource.update(attributes)
+        resource
+      end
+    end
+  end
+end

data/lib/azeroth/resourceable.rb

@@ -19,20 +19,6 @@ 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|
-        format.json { render json: send("#{action}_resource") }
-        format.html { action }
-      end
-    end
-
     # @api private
     # @private
     #

data/lib/azeroth/resourceable/builder.rb

@@ -24,7 +24,6 @@ module Azeroth
 
         add_params
         add_resource
-        add_resource_for_routes
         add_routes
       end
 
@@ -121,13 +120,6 @@ module Azeroth
         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>]

data/lib/azeroth/routes_builder.rb

@@ -19,14 +19,11 @@ module Azeroth
     #
     # @return [Array<Sinclair::MethodDefinition>]
     def append
-      %i[index show edit].each do |route|
-        add_method(route, 'render_basic')
-      end
+      actions = %i[create destroy edit index new show update]
 
-      add_method(:new, '')
-      add_method(:update,  update_code)
-      add_method(:create,  create_code)
-      add_method(:destroy, destroy_code)
+      actions.each do |route|
+        add_method(route, &route_code(route))
+      end
     end
 
     private
@@ -57,38 +54,17 @@ module Azeroth
     #
     # @return [Array<Sinclair::MethodDefinition>]
 
-    # @private
-    #
-    # Method code to update route
-    #
-    # @return [String]
-    def update_code
-      <<-RUBY
-        render json: update_resource
-      RUBY
-    end
+    def route_code(route)
+      model_interface = model
+      handler_class = Azeroth::RequestHandler.const_get(
+        route.to_s.capitalize
+      )
 
-    # @private
-    #
-    # Method code to create route
-    #
-    # @return [String]
-    def create_code
-      <<-RUBY
-        render json: create_resource
-      RUBY
-    end
-
-    # @private
-    #
-    # Method code to destroy route
-    #
-    # @return [String]
-    def destroy_code
-      <<-RUBY
-        #{model.name}.destroy
-        head :no_content
-      RUBY
+      proc do
+        handler_class.new(
+          self, model_interface
+        ).process
+      end
     end
   end
 end