azeroth 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e12fe40f870d7fdb3cea6050cd78c2e9fc664645afc834be42036f01261d7078
-  data.tar.gz: ce539d54b582033f05342045a923313367a307bb999d8ec7c2b7e9aabc550edb
+  metadata.gz: 5b3f2e1e80d4b8a81dc439e3932b0742cc127fb6ebbe7b00b10668a0c71f1a59
+  data.tar.gz: 47ddb93df9b8071bd0eeac69b3a709b2e7698f24a3cff1615931f8f244298d70
 SHA512:
-  metadata.gz: 744f9bf09c7c3ab19c8ea8541f322c498983904ec1b084dc52bb9e07f05e8fdeddc05c30dc5d52d8553412c4b00a1f82c1cdcd83fa08e8cc5e1ca86ed894097f
-  data.tar.gz: bffa4c272a0e8610d694b3762627eb3ad81416bc979da72f789ea6b29be97e8ff0b3790a14a74108b1a81dc932b69fff2dc27a9cc4bcd07874fe437efc3069d8
+  metadata.gz: f46485bfd779e80c4c56fb3e727ab3bdd1beda52f25a6ad923e6952ae114f7ab15b47e9ed529fcfa84094767dd67606872b7cea0bce61c12a81166d49b28ac75
+  data.tar.gz: ea59d8e707925e64004493181c5303bc954ddf28e7c518a214ef2d19c9314098a9bc29454cd4bec9b9d697750d1f92e1492d48e2a345fa21518d43c6b2177e2d

data/.circleci/config.yml

@@ -18,7 +18,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_rails_gems:0.5.1
+      - image: darthjee/circleci_rails_gems:0.5.4
         environment:
           PROJECT: azeroth
     steps:
@@ -52,7 +52,7 @@ jobs:
           command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_rails_gems:0.5.1
+      - image: darthjee/circleci_rails_gems:0.5.4
         environment:
           PROJECT: azeroth
     steps:
@@ -62,10 +62,10 @@ jobs:
           command: bundle install
       - run:
           name: Signin
-          command: scripts/build.sh signin
+          command: build_gem.sh signin
       - run:
           name: Build Gem
-          command: scripts/build.sh build
+          command: build_gem.sh build
       - run:
           name: Push Gem
-          command: scripts/build.sh push
+          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.5.4 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.0](https://www.rubydoc.info/gems/azeroth/0.7.0)
+[https://www.rubydoc.info/gems/azeroth/0.7.1](https://www.rubydoc.info/gems/azeroth/0.7.1)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same
@@ -59,6 +59,7 @@ 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
+- build_with: Method/Block to be ran when building the reource on create
 
 ```ruby
   # publishers_controller.rb

data/azeroth.gemspec

@@ -18,10 +18,10 @@ 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.4.2'
   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.4'
+  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'

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

@@ -18,7 +18,8 @@ module Azeroth
       only: %i[create destroy edit index new show update],
       except: [],
       decorator: true,
-      before_save: nil
+      before_save: nil,
+      build_with: nil
     }.freeze
 
     with_options DEFAULT_OPTIONS
@@ -79,5 +80,12 @@ module Azeroth
     # 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/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,14 +19,16 @@ 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_resource
-        @resource = collection.build(attributes)
+      def build_and_save_resource
+        @resource = build_resource
         controller.instance_variable_set("@#{model.name}", resource)
 
         trigger_event(:save) do
@@ -32,6 +36,25 @@ module Azeroth
         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
+        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
       #
       # Response status

data/lib/azeroth/resourceable.rb

@@ -35,6 +35,9 @@ module Azeroth
       #   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
       #

data/lib/azeroth/version.rb

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

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

@@ -108,6 +108,89 @@ describe Azeroth::RequestHandler::Create do
     end
   end
 
+  context 'with build_with as symbol' do
+    it_behaves_like 'a request handler', status: :created do
+      let(:options_hash) do
+        {
+          build_with: :build_magic_document
+        }
+      end
+
+      let(:extra_params) do
+        {
+          document: {
+            name: 'My Document'
+          }
+        }
+      end
+
+      let(:expected_json) do
+        {
+          'name' => 'My Document',
+          'reference' => 'X-MAGIC-15'
+        }
+      end
+
+      it 'creates entry' do
+        expect { handler.process }
+          .to change(Document, :count)
+          .by(1)
+      end
+
+      it 'builds entity with custom method' do
+        handler.process
+
+        expect(Document.last.reference)
+          .to eq('X-MAGIC-15')
+      end
+    end
+  end
+
+  context 'with build_with as block' do
+    it_behaves_like 'a request handler', status: :created do
+      let(:block) do
+        proc do
+          documents.where(reference: 'X-MAGIC-20')
+                   .build(document_params)
+        end
+      end
+
+      let(:options_hash) do
+        {
+          build_with: block
+        }
+      end
+
+      let(:extra_params) do
+        {
+          document: {
+            name: 'My Document'
+          }
+        }
+      end
+
+      let(:expected_json) do
+        {
+          'name' => 'My Document',
+          'reference' => 'X-MAGIC-20'
+        }
+      end
+
+      it 'creates entry' do
+        expect { handler.process }
+          .to change(Document, :count)
+          .by(1)
+      end
+
+      it 'builds entity with custom method' do
+        handler.process
+
+        expect(Document.last.reference)
+          .to eq('X-MAGIC-20')
+      end
+    end
+  end
+
   context 'when payload is invalid' do
     it_behaves_like 'a request handler',
                     status: :unprocessable_entity do

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

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 class RequestHandlerController < ActionController::Base
+  private
+
   def document_params
     params.require(:document).permit(:name)
   end
@@ -16,4 +18,9 @@ class RequestHandlerController < ActionController::Base
   def add_magic_reference
     document.reference = 'X-MAGIC-15'
   end
+
+  def build_magic_document
+    documents.where(reference: 'X-MAGIC-15')
+             .build(document_params)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 5.2.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 5.2.4.2
 - !ruby/object:Gem::Dependency
   name: darthjee-active_ext
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: 1.6.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: 1.6.5
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -449,7 +449,6 @@ files:
 - lib/azeroth/resourceable/class_methods.rb
 - lib/azeroth/routes_builder.rb
 - lib/azeroth/version.rb
-- scripts/build.sh
 - spec/controllers/documents_controller_spec.rb
 - spec/controllers/documents_with_error_controller_spec.rb
 - spec/controllers/index_documents_controller_spec.rb

data/scripts/build.sh

@@ -1,47 +0,0 @@
-#!/bin/bash
-
-function version() {
-  echo $(cat lib/$PROJECT/version.rb | grep VERSION | sed -e "s/.*'\\(.*\\)'.*/\\1/g")
-}
-
-function isTagged() {
-  VERSION=$(version)
-  TAG=$(git tag | tail -n 1)
-
-  if [ $VERSION = $TAG ]; then
-    return 0
-  else
-    return 1
-  fi
-}
-
-ACTION=$1
-
-case $ACTION in
-  "signin")
-    mkdir ~/.gem
-    echo "---" > ~/.gem/credentials
-    echo ":rubygems_api_key: $RUBY_GEMS_API_KEY" >> ~/.gem/credentials
-    chmod 600 ~/.gem/credentials
-    ;;
-  "build")
-    if $(isTagged); then
-      rake build
-    else
-      echo version did not change
-    fi
-    ;;
-  "push")
-    if $(isTagged); then
-      VERSION=$(version)
-      gem push "pkg/$PROJECT-$VERSION.gem"
-    else
-      echo version did not change
-    fi
-    ;;
-  *)
-    echo Usage:
-    echo "$0 build # builds gem"
-    echo "$0 push # pushes gem"
-    ;;
-esac