azeroth 0.7.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbddea8e78679a5a20ccb7c04fd94da0f55718713add9d352d97bff07921df9c
-  data.tar.gz: e5cc1161a4b36df822458101ce8e4f443a8be05eaf5a0430a0ae09db313e8794
+  metadata.gz: 60f05e09418f7fc0e6155ee3c4e7349e3a80638295eb01032dc0c284a5ccbaa5
+  data.tar.gz: 97e333436d04d1cfb255c2dc26751e43aa9da6fad9a383f4c26de33c1df70ffe
 SHA512:
-  metadata.gz: dd4a272074e69969eddf5d7c3fa3b96d1b0154e117d81b6be419b59573169e100773ecbd97d96f2465a72a5c5e0458c3d7e13d12b5e2c1ed710412a8139e7b4c
-  data.tar.gz: 0eb07f9c6da10355a9c9db82e555d0eecfaefa75abce57603109efa8aa841a53a70f372afeef6dafe5df9e88504a4180e76f66a8060cbf5841dbdeb6895f6a9f
+  metadata.gz: 2d01f8321b172c0f3d6aedde71ae3e34de04ba261bcacaa4f9157bf8223a75390378167dee429e704a67c38d9d8bb21e695d00faaf612b32dd09d2f53aff9927
+  data.tar.gz: b73a0aee9cc39faff3f6e7a3281987028a27bee1034ecc22e0176e36bd8113fa784800d0460966e16fe973384e081112a74472c7e5878595a4156375b09d0ce2

data/.circleci/config.yml

@@ -18,7 +18,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_rails_gems:0.5.4
+      - image: darthjee/circleci_rails_gems:0.6.3
         environment:
           PROJECT: azeroth
     steps:
@@ -52,7 +52,7 @@ jobs:
           command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_rails_gems:0.5.4
+      - image: darthjee/circleci_rails_gems:0.6.3
         environment:
           PROJECT: azeroth
     steps:

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM darthjee/rails_gems:0.5.4 as base
+FROM darthjee/rails_gems:0.7.0 as base
 FROM darthjee/scripts:0.1.8 as scripts
 
 ######################################

data/README.md

@@ -11,7 +11,7 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/0.7.1](https://www.rubydoc.info/gems/azeroth/0.7.2)
+[https://www.rubydoc.info/gems/azeroth/0.8.1](https://www.rubydoc.info/gems/azeroth/0.8.1)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same
@@ -59,7 +59,10 @@ It accepts options
 - except: List of actions to not to be built
 - decorator: Decorator class or flag allowing/disallowing decorators
 - before_save: Method/Proc to be ran before saving the resource on create or update
+- after_save: Method/Proc to be ran after saving the resource on create or update
 - build_with: Method/Block to be ran when building the reource on create
+- paginated: Flag when pagination should be applied
+- per_page: Number of items returned when pagination is active
 
 ```ruby
   # publishers_controller.rb

data/azeroth.gemspec

@@ -18,33 +18,35 @@ 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.4.3'
+  gem.add_runtime_dependency 'activesupport',       '~> 5.2.x'
   gem.add_runtime_dependency 'darthjee-active_ext', '>= 1.3.2'
   gem.add_runtime_dependency 'jace',                '>= 0.0.3'
-  gem.add_runtime_dependency 'sinclair',            '>= 1.6.5'
+  gem.add_runtime_dependency 'sinclair',            '>= 1.6.7'
 
-  gem.add_development_dependency 'actionpack',               '5.2.4.3'
-  gem.add_development_dependency 'activerecord',             '5.2.4.3'
-  gem.add_development_dependency 'bundler',                  '1.16.1'
-  gem.add_development_dependency 'factory_bot',              '5.2.0'
-  gem.add_development_dependency 'nokogiri',                 '1.10.9'
-  gem.add_development_dependency 'pry',                      '0.12.2'
-  gem.add_development_dependency 'pry-nav',                  '0.3.0'
-  gem.add_development_dependency 'rails',                    '5.2.4.3'
-  gem.add_development_dependency 'rails-controller-testing', '1.0.4'
-  gem.add_development_dependency 'rake',                     '13.0.1'
-  gem.add_development_dependency 'reek',                     '5.6.0'
-  gem.add_development_dependency 'rspec',                    '3.9.0'
-  gem.add_development_dependency 'rspec-core',               '3.9.1'
-  gem.add_development_dependency 'rspec-expectations',       '3.9.1'
-  gem.add_development_dependency 'rspec-mocks',              '3.9.1'
-  gem.add_development_dependency 'rspec-rails',              '3.9.0'
-  gem.add_development_dependency 'rspec-support',            '3.9.2'
-  gem.add_development_dependency 'rubocop',                  '0.80.1'
-  gem.add_development_dependency 'rubocop-rspec',            '1.38.1'
-  gem.add_development_dependency 'rubycritic',               '4.4.1'
-  gem.add_development_dependency 'simplecov',                '0.17.1'
-  gem.add_development_dependency 'sqlite3',                  '1.4.2'
-  gem.add_development_dependency 'yard',                     '0.9.24'
-  gem.add_development_dependency 'yardstick',                '0.9.9'
+  gem.add_development_dependency 'actionpack',                '~> 5.2.x'
+  gem.add_development_dependency 'activerecord',              '~> 5.2.x'
+  gem.add_development_dependency 'bundler',                   '1.16.1'
+  gem.add_development_dependency 'factory_bot',               '5.2.0'
+  gem.add_development_dependency 'nokogiri',                  '1.11.4'
+  gem.add_development_dependency 'pry',                       '0.12.2'
+  gem.add_development_dependency 'pry-nav',                   '0.3.0'
+  gem.add_development_dependency 'rails',                     '~> 5.2.x'
+  gem.add_development_dependency 'rails-controller-testing',  '1.0.4'
+  gem.add_development_dependency 'rake',                      '13.0.3'
+  gem.add_development_dependency 'reek',                      '6.0.3'
+  gem.add_development_dependency 'rspec',                     '3.9.0'
+  gem.add_development_dependency 'rspec-collection_matchers', '1.2.0'
+  gem.add_development_dependency 'rspec-core',                '3.9.3'
+  gem.add_development_dependency 'rspec-expectations',        '3.9.4'
+  gem.add_development_dependency 'rspec-mocks',               '3.9.1'
+  gem.add_development_dependency 'rspec-rails',               '3.9.0'
+  gem.add_development_dependency 'rspec-support',             '3.9.4'
+  gem.add_development_dependency 'rubocop',                   '0.80.1'
+  gem.add_development_dependency 'rubocop-rspec',             '1.38.1'
+  gem.add_development_dependency 'rubycritic',                '4.6.1'
+  gem.add_development_dependency 'shoulda-matchers',          '4.3.0'
+  gem.add_development_dependency 'simplecov',                 '0.17.1'
+  gem.add_development_dependency 'sqlite3',                   '1.4.2'
+  gem.add_development_dependency 'yard',                      '0.9.26'
+  gem.add_development_dependency 'yardstick',                 '0.9.9'
 end

data/config/yardstick.yml

@@ -23,6 +23,7 @@ rules:
   Summary::Presence:
     enabled: true
     exclude:
+      - Azeroth::ControllerInterface#initialize
       - Azeroth::Decorator#initialize
       - Azeroth::Decorator::HashBuilder#initialize
       - Azeroth::Decorator::KeyValueExtractor#initialize

data/lib/azeroth.rb

@@ -11,12 +11,13 @@ require 'jace'
 #
 # @see Resourceable
 module Azeroth
-  autoload :Decorator,       'azeroth/decorator'
-  autoload :DummyDecorator,  'azeroth/dummy_decorator'
-  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 :ControllerInterface, 'azeroth/controller_interface'
+  autoload :Decorator,           'azeroth/decorator'
+  autoload :DummyDecorator,      'azeroth/dummy_decorator'
+  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/controller_interface.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Azeroth
+  # @api private
+  #
+  # Interface for using the controller
+  class ControllerInterface
+    # @param controller [ApplicationController]
+    def initialize(controller)
+      @controller = controller
+    end
+
+    # Set response headers
+    #
+    # @param headers_hash [Hash] headers to be set
+    #
+    # @return [Hash]
+    def add_headers(headers_hash)
+      controller.instance_eval do
+        headers_hash.each do |key, value|
+          headers[key.to_s] = value
+        end
+      end
+    end
+
+    # Renders response json
+    #
+    # @return [String]
+    def render_json(json, status)
+      controller.instance_eval do
+        render(json: json, status: status)
+      end
+    end
+
+    # Set a variable in the controller
+    #
+    # @param variable [String,Symbol] variable name
+    # @param value [Object] value to be set
+    #
+    # @return [Object]
+    def set(variable, value)
+      controller.instance_variable_set("@#{variable}", value)
+    end
+
+    private
+
+    attr_reader :controller
+    # @method controller
+    # @private
+    # @api private
+    #
+    # Controller where methods will be called
+    #
+    # @return [ApplicationController]
+
+    # @private
+    #
+    # Dispatcher to delegate all methods call to controller
+    #
+    # @param method_name [Symbol] name of the method
+    #   called
+    # @param args [Array<Object>] arguments of the
+    #   method called
+    #
+    # @return [Object]
+    def method_missing(method_name, *args)
+      if controller.respond_to?(method_name, true)
+        controller.send(method_name, *args)
+      else
+        super
+      end
+    end
+
+    # @private
+    #
+    # Checks if a controller responds to a method
+    #
+    # @param method_name [Symbol] name of the method checked
+    # @param include_private [TrueClass,FalseClass] flag
+    #   indicating if private methods should be included
+    #
+    # @return [TrueClass,FalseClass]
+    def respond_to_missing?(method_name, include_private)
+      controller.respond_to?(method_name, include_private)
+    end
+  end
+end

data/lib/azeroth/decorator.rb

@@ -42,6 +42,7 @@ module Azeroth
   class Decorator
     autoload :HashBuilder,       'azeroth/decorator/hash_builder'
     autoload :KeyValueExtractor, 'azeroth/decorator/key_value_extractor'
+    autoload :MethodBuilder,     'azeroth/decorator/method_builder'
     autoload :Options,           'azeroth/decorator/options'
 
     class << self
@@ -228,9 +229,7 @@ module Azeroth
       def expose(attribute, **options_hash)
         options = Decorator::Options.new(options_hash)
 
-        builder = Sinclair.new(self)
-        builder.add_method(attribute, "@object.#{attribute}")
-        builder.build
+        MethodBuilder.build_reader(self, attribute)
 
         attributes_map[attribute] = options
       end

data/lib/azeroth/decorator/method_builder.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'sinclair'
+
+module Azeroth
+  class Decorator
+    # Responsible for building readers for attributes
+    # @api private
+    class MethodBuilder < Sinclair
+      # Builds reader
+      #
+      # reaader delegate method calls to @object
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+      def self.build_reader(klass, attribute)
+        new(klass).build_reader(attribute)
+      end
+
+      # (see MethodBuilder.build_reader)
+      def build_reader(attribute)
+        add_method(attribute, "@object.#{attribute}")
+        build
+      end
+    end
+  end
+end

data/lib/azeroth/options.rb

@@ -19,7 +19,10 @@ module Azeroth
       except: [],
       decorator: true,
       before_save: nil,
-      build_with: nil
+      after_save: nil,
+      build_with: nil,
+      paginated: false,
+      per_page: 20
     }.freeze
 
     with_options DEFAULT_OPTIONS
@@ -40,10 +43,18 @@ module Azeroth
     # @return [Jace::Dispatcher]
     def event_dispatcher(event)
       Jace::Dispatcher.new(
-        before: try("before_#{event}")
+        before: try("before_#{event}"),
+        after: try("after_#{event}")
       )
     end
 
+    alias paginated? paginated
+    # @method paginated?
+    # @api private
+    #
+    # @see paginated
+    # @return [TrueClass,FalseClass]
+
     # @method only
     # @api private
     #
@@ -81,11 +92,36 @@ module Azeroth
     #
     # @return [Symbol,Proc]
 
+    # @method after_save
+    # @api private
+    #
+    # Block or method name to be run after save
+    #
+    # The given method or block will be ran
+    # after committing changes in models
+    # to database
+    #
+    # @return [Symbol,Proc]
+
     # @method build_with
     # @api private
     #
     # Block or method name to be ran when building the resource
     #
     # @return [Symbol,Proc]
+
+    # @method paginated
+    # @api private
+    #
+    # Boolean indicating if pagination should or not be used
+    #
+    # @return [TrueClass,FalseClass]
+
+    # @method per_page
+    # @api private
+    #
+    # Number of elements when pagination is active
+    #
+    # @return [Integer]
   end
 end

data/lib/azeroth/request_handler.rb

@@ -19,7 +19,7 @@ module Azeroth
     # @param controller [ApplicationController]
     # @param model [Azeroth::Model]
     def initialize(controller, model, options)
-      @controller = controller
+      @controller = ControllerInterface.new(controller)
       @model = model
       @options = options
     end
@@ -35,12 +35,11 @@ module Azeroth
     def process
       return unless json?
 
-      json            = model.decorate(resource)
-      response_status = status
-
-      controller.instance_eval do
-        render(json: json, status: response_status)
-      end
+      controller.add_headers(headers)
+      controller.render_json(
+        model.decorate(resource),
+        status
+      )
     end
 
     private
@@ -141,5 +140,15 @@ module Azeroth
     def collection
       @collection = controller.send(model.plural)
     end
+
+    # @private
+    # @abstract
+    #
+    # Headers to be added
+    #
+    # @return [Hash]
+    def headers
+      {}
+    end
   end
 end

data/lib/azeroth/request_handler/create.rb

@@ -29,7 +29,7 @@ module Azeroth
       # @return [Object]
       def build_and_save_resource
         @resource = build_resource
-        controller.instance_variable_set("@#{model.name}", resource)
+        controller.set(model.name, resource)
 
         trigger_event(:save) do
           resource.tap(&:save)

data/lib/azeroth/request_handler/index.rb

@@ -8,14 +8,92 @@ module Azeroth
     class Index < RequestHandler
       private
 
+      delegate :paginated?, :per_page, to: :options
+
       # @private
       #
       # return a collection of the model
       #
       # @return [Enumerable<Object>]
       def resource
+        return scoped_entries unless paginated?
+
+        paginated_entries
+      end
+
+      # @private
+      #
+      # returns pagination headers
+      #
+      # @return [Hash] heders
+      def headers
+        return {} unless paginated?
+
+        {
+          pages: pages,
+          page: current_page,
+          per_page: limit
+        }
+      end
+
+      # @private
+      #
+      # paginated collection of the model
+      #
+      # @return [Enumerable<Object>]
+      def paginated_entries
+        scoped_entries.offset(offset).limit(limit)
+      end
+
+      # @private
+      #
+      # offest used in pagination
+      #
+      # offset is retrieved from +params[:per_page]+
+      # or +options.per_page+
+      #
+      # @return [Integer]
+      def offset
+        (current_page - 1) * limit
+      end
+
+      # @private
+      #
+      # limit used in pagination
+      #
+      # limit is retrieved from +params[:page]+
+      #
+      # @return [Integer]
+      def limit
+        (params[:per_page] || per_page).to_i
+      end
+
+      # @private
+      #
+      # default scope of elements
+      #
+      # @return [Enumerable<Object>]
+      def scoped_entries
         controller.send(model.plural)
       end
+
+      # @private
+      #
+      # calculates current page
+      #
+      # @return [Integer]
+      def current_page
+        (params[:page] || 1).to_i
+      end
+
+      # @private
+      #
+      # calculates how many pages are there
+      #
+      # @return [Integer]
+      def pages
+        (scoped_entries.count.to_f / limit).ceil
+      end
     end
   end
 end