azeroth 0.6.4 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac2c03e9a7b51ed50db9ecab43a4f7257d98839126f79a45cc6b3563efd7b296
-  data.tar.gz: 95d18220fae24c2f049cf186fe25a0d5cdc94bada48ccd9ce02b867c5334f3ce
+  metadata.gz: 51518b95de11772f06c52d5000e7fd2a4d888dc8d22402e978ba5eb90da2eb75
+  data.tar.gz: 363de647988cec21c1cb741d4cbca29801676291010cb8316a480dc6db52108e
 SHA512:
-  metadata.gz: 8dd092347ebebde2ccdaad5b2c165a8a595a2f8f2a6fc463303566f1b3812d84b22a0295f75ce9dbf696c752ad045691953696166705e0294f94ae3450b0f3e7
-  data.tar.gz: 4a406a9e2d4609034cab48bd8aff6ead1c644f3535d3cacd6e18523881572dde035afccbc4279ee96f9a110a0b078897641ebcfc5008a93cf47b7b4ce89bd746
+  metadata.gz: 695b44810f4cbc23c71ceb40cfcce8bd657d63cb30aaac9346328c1b3a0d92bafc27f0206caa0bc5f7d044eb6641a27f92fde3f1216e438afff21e584d6d6c45
+  data.tar.gz: 20b4768481d46c1210e75eea1c6fa6552dede748f871fe402af864fe1bc855dd9b3196550966a01c672b5a7891a810cc29c2b4d1e179c2c289b97169225553e5

data/.circleci/config.yml

@@ -1,8 +1,24 @@
 version: 2
+workflows:
+  version: 2
+  test-and-build:
+    jobs:
+      - test:
+          filters:
+            tags:
+              only: /.*/
+      - build-and-release:
+          requires: [test]
+          filters:
+            tags:
+              only: /\d+\.\d+\.\d+/
+            branches:
+              only:
+                - master
 jobs:
-  build:
+  test:
     docker:
-      - image: darthjee/circleci_rails_gems:0.5.1
+      - image: darthjee/circleci_rails_gems:0.6.3
         environment:
           PROJECT: azeroth
     steps:
@@ -34,3 +50,22 @@ jobs:
       - run:
           name: Check unit tests
           command: check_specs
+  build-and-release:
+    docker:
+      - image: darthjee/circleci_rails_gems:0.6.3
+        environment:
+          PROJECT: azeroth
+    steps:
+      - checkout
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: Signin
+          command: build_gem.sh signin
+      - run:
+          name: Build Gem
+          command: build_gem.sh build
+      - run:
+          name: Push Gem
+          command: build_gem.sh push

data/Dockerfile

@@ -1,5 +1,5 @@
-FROM darthjee/rails_gems:0.5.2 as base
-FROM darthjee/scripts:0.1.7 as scripts
+FROM darthjee/rails_gems:0.6.3 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.6.4](https://www.rubydoc.info/gems/azeroth/0.6.4)
+[https://www.rubydoc.info/gems/azeroth/0.7.3](https://www.rubydoc.info/gems/azeroth/0.7.3)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same
@@ -25,6 +25,25 @@ does not perform database operations
 Future versions will enable `html` rendering to also perform
 database operations.
 
+Installation
+---------------
+
+- Install it
+
+```ruby
+  gem install azeroth
+```
+
+- Or add Sinclair to your `Gemfile` and `bundle install`:
+
+```ruby
+  gem 'azeroth'
+```
+
+```bash
+  bundle install azeroth
+```
+
 Usage
 -----
 
@@ -36,9 +55,11 @@ which adds a resource and action methods for `create`, `show`, `index`,
 `update`, `delete`, `edit`
 
 It accepts options
--only List of actions to be built
--except List of actions to not to be built
--decorator Decorator class or flag allowing/disallowing decorators
+- only: List of actions to be built
+- 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
+- build_with: Method/Block to be ran when building the reource on create
 
 ```ruby
   # publishers_controller.rb
@@ -76,6 +97,36 @@ It accepts options
   end
 ```
 
+```ruby
+  # pokemons_controller.rb
+
+  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
+```
+
 ## Azeroth::Decorator
 
 [Decorators](https://www.rubydoc.info/gems/azeroth/Azeroth/Decorator) are
@@ -121,6 +172,6 @@ Exposing is done through the class method
 [expose](https://www.rubydoc.info/gems/azeroth/Azeroth/Decorator#expose-class_method)
 which accepts several options:
 
--as: custom key to expose
--if: method/block to be called checking if an attribute should or should not be exposed
--decorator: flag to use or not a decorator or decorator class to be used
+- as: custom key to expose
+- if: method/block to be called checking if an attribute should or should not be exposed
+- decorator: flag to use or not a decorator or decorator class to be used

data/azeroth.gemspec

@@ -18,18 +18,19 @@ 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.x'
   gem.add_runtime_dependency 'darthjee-active_ext', '>= 1.3.2'
-  gem.add_runtime_dependency 'sinclair',            '>= 1.6.4'
+  gem.add_runtime_dependency 'jace',                '>= 0.0.3'
+  gem.add_runtime_dependency 'sinclair',            '>= 1.6.5'
 
-  gem.add_development_dependency 'actionpack',               '5.2.4.2'
-  gem.add_development_dependency 'activerecord',             '5.2.4.2'
+  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.10.9'
+  gem.add_development_dependency 'nokogiri',                 '1.11.3'
   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.2'
+  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.1'
   gem.add_development_dependency 'reek',                     '5.6.0'

data/lib/azeroth.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'sinclair'
+require 'jace'
 
 # @api public
 #

data/lib/azeroth/decorator.rb

@@ -257,6 +257,8 @@ module Azeroth
     #
     # @return [Hash]
     def as_json(*args)
+      return nil if object.nil?
+
       return array_as_json(*args) if enum?
 
       HashBuilder.new(self).as_json

data/lib/azeroth/model.rb

@@ -62,6 +62,8 @@ module Azeroth
     #
     # @return [Azeroth::Options]
 
+    delegate :decorator, to: :options
+
     # @private
     #
     # Returns decorator class for the object
@@ -85,7 +87,7 @@ module Azeroth
     # @return [Azeroth::Decorator,DummyDecorator]
     def calculate_decorator_class
       return DummyDecorator unless options.decorator
-      return options.decorator if options.decorator.is_a?(Class)
+      return decorator if decorator.is_a?(Class)
 
       klass::Decorator
     rescue NameError

data/lib/azeroth/options.rb

@@ -10,10 +10,16 @@ module Azeroth
   #   Sinclair::Options
   class Options < Sinclair::Options
     # Default options
+    #
+    # @api public
+    #
+    # @see Resourceable::ClassMethods#resource_for
     DEFAULT_OPTIONS = {
       only: %i[create destroy edit index new show update],
       except: [],
-      decorator: true
+      decorator: true,
+      before_save: nil,
+      build_with: nil
     }.freeze
 
     with_options DEFAULT_OPTIONS
@@ -25,6 +31,19 @@ module Azeroth
       [only].flatten.map(&:to_sym) - [except].flatten.map(&:to_sym)
     end
 
+    # Returns event dispatcher
+    #
+    # Event dispatcher is responsible for
+    # sending events such as +before_save+
+    # to it's correct calling point
+    #
+    # @return [Jace::Dispatcher]
+    def event_dispatcher(event)
+      Jace::Dispatcher.new(
+        before: try("before_#{event}")
+      )
+    end
+
     # @method only
     # @api private
     #
@@ -50,5 +69,23 @@ module Azeroth
     # model.as_json
     #
     # @return [Decorator,TrueClass,FalseClass]
+
+    # @method before_save
+    # @api private
+    #
+    # Block or method name to be run before save
+    #
+    # The given method or block will be ran
+    # before 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]
   end
 end

data/lib/azeroth/request_handler.rb

@@ -18,9 +18,10 @@ module Azeroth
 
     # @param controller [ApplicationController]
     # @param model [Azeroth::Model]
-    def initialize(controller, model)
+    def initialize(controller, model, options)
       @controller = controller
       @model = model
+      @options = options
     end
 
     # process the request
@@ -44,7 +45,7 @@ module Azeroth
 
     private
 
-    attr_reader :controller, :model
+    attr_reader :controller, :model, :options
     # @method controller
     # @api private
     # @private
@@ -61,6 +62,14 @@ module Azeroth
     #
     # @return [Azeroth::Model]
 
+    # @method options
+    # @api private
+    # @private
+    #
+    # Handling options
+    #
+    # @return [Azeroth::Options]
+
     delegate :params, to: :controller
     # @method params
     # @api private
@@ -104,5 +113,33 @@ module Azeroth
     def status
       :ok
     end
+
+    # @private
+    #
+    # Run a block triggering the event
+    #
+    # @return [Object] Result of given block
+    def trigger_event(event, &block)
+      options.event_dispatcher(event)
+             .dispatch(controller, &block)
+    end
+
+    # @private
+    #
+    # Attributes to be used on resource creating
+    #
+    # @return [Hash]
+    def attributes
+      @attributes ||= controller.send("#{model.name}_params")
+    end
+
+    # @private
+    #
+    # Collection scope of the resource
+    #
+    # @return [ActiveRecord::Relation]
+    def collection
+      @collection = controller.send(model.plural)
+    end
   end
 end

data/lib/azeroth/request_handler/create.rb

@@ -8,6 +8,8 @@ module Azeroth
     class Create < RequestHandler
       private
 
+      delegate :build_with, to: :options
+
       # @private
       #
       # Creates and return an instance of the model
@@ -17,16 +19,40 @@ module Azeroth
       #
       # @return [Object]
       def resource
-        @resource ||= build_resource
+        @resource ||= build_and_save_resource
       end
 
-      # build resource for create
+      # @private
+      #
+      # build resource for create and save it
       #
       # @return [Object]
+      def build_and_save_resource
+        @resource = build_resource
+        controller.instance_variable_set("@#{model.name}", resource)
+
+        trigger_event(:save) do
+          resource.tap(&:save)
+        end
+      end
+
+      # @private
+      #
+      # build resource without saving it
+      #
+      # when +build_with+ option is given, the proc/method
+      # is called instead of collection.build
+      #
+      # @return [Object] resource built
       def build_resource
-        attributes = controller.send("#{model.name}_params")
-        collection = controller.send(model.plural)
-        collection.create(attributes)
+        return collection.build(attributes) unless build_with
+
+        case build_with
+        when Proc
+          controller.instance_eval(&build_with)
+        else
+          controller.send(build_with)
+        end
       end
 
       # @private

data/lib/azeroth/request_handler/update.rb

@@ -24,10 +24,10 @@ module Azeroth
       #
       # @return [Object]
       def update_resource
-        attributes = controller.send("#{model.name}_params")
-
         controller.send(model.name).tap do |entry|
-          entry.update(attributes)
+          trigger_event(:save) do
+            entry.update(attributes)
+          end
         end
       end
 

data/lib/azeroth/resourceable.rb

@@ -21,6 +21,29 @@ module Azeroth
     autoload :Builder, 'azeroth/resourceable/builder'
     autoload :ClassMethods, 'azeroth/resourceable/class_methods'
 
+    class << self
+      # @method self.resource_for(name, **options)
+      # @api public
+      #
+      # @param name [String, Symbol] Name of the resource
+      # @param options [Hash] resource building options
+      # @option options only [Array<Symbol,String>] List of
+      #   actions to be built
+      # @option options except [Array<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 build_with [Symbol,Proc] method/block
+      #   to be ran when building resource
+      #   (default proc { <resource_collection>.build(resource_params) }
+      #
+      # @return [Array<MethodDefinition>] list of methods created
+      #
+      # @see Options::DEFAULT_OPTIONS
+    end
+
     private
 
     # @api private