azeroth 0.6.3 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff267cb06b99dea008313ebf30569e33565cbbe210602b3008bd859016c28755
-  data.tar.gz: 494a34050515c0dcd7e05ecdce0151e26f089e0ae39d3c1652a38d210ec1f99d
+  metadata.gz: dbddea8e78679a5a20ccb7c04fd94da0f55718713add9d352d97bff07921df9c
+  data.tar.gz: e5cc1161a4b36df822458101ce8e4f443a8be05eaf5a0430a0ae09db313e8794
 SHA512:
-  metadata.gz: 1e89465dc060b9ab4a0b9a6c95e6b2cb054ab08efd32ebf312bbe94f751f5d505f20230632e8435d0de57898f9bbd9875215fd23c59f51a1de6516a2bfb0e273
-  data.tar.gz: fe6c480bc37d5e03ea61eb22df4c66154537fca6917d671e19fac1ce7bdf5de5051dfd736de0c7529ffa240512f615bd5a1c1a2e5ed285a3326956bd59758dd4
+  metadata.gz: dd4a272074e69969eddf5d7c3fa3b96d1b0154e117d81b6be419b59573169e100773ecbd97d96f2465a72a5c5e0458c3d7e13d12b5e2c1ed710412a8139e7b4c
+  data.tar.gz: 0eb07f9c6da10355a9c9db82e555d0eecfaefa75abce57603109efa8aa841a53a70f372afeef6dafe5df9e88504a4180e76f66a8060cbf5841dbdeb6895f6a9f

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.5.4
         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.5.4
+        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/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*_spec.rb'
+    - 'spec/dummy/db/schema.rb'
     - 'spec/support/shared_*/**/*.rb'
     - 'azeroth.gemspec'
 
@@ -24,3 +25,13 @@ Style/HashTransformKeys:
 
 Style/HashTransformValues:
   Enabled: true
+
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/integration/readme/**/*_spec.rb'
+    - 'spec/integration/yard/**/*_spec.rb'
+
+RSpec/MultipleExpectations:
+  Exclude:
+    - 'spec/integration/readme/**/*_spec.rb'
+    - 'spec/integration/yard/**/*_spec.rb'

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,4 +11,167 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/0.6.3](https://www.rubydoc.info/gems/azeroth/0.6.3)
+[https://www.rubydoc.info/gems/azeroth/0.7.1](https://www.rubydoc.info/gems/azeroth/0.7.2)
+
+Azeroth has been designed making the coding of controllers easier
+as routes in controllers are usually copy, paste and replace of same
+code.
+
+Azeroth was originally developed for controller actions
+which will respond with json or template rendering based
+on the requested format `.json` or `.html` where `html` rendering
+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
+-----
+
+## Azeroth::Resourceable
+
+[Resourceable](https://www.rubydoc.info/gems/azeroth/Azeroth/Resourceable)
+module adds class method [resource_for](https://www.rubydoc.info/gems/azeroth/Azeroth/Resourceable/ClassMethods#resource_for-instance_method)
+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
+- 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
+
+  class PublishersController < ApplicationController
+    include Azeroth::Resourceable
+    skip_before_action :verify_authenticity_token
+
+    resource_for :publisher, only: %i[create index]
+  end
+```
+
+```ruby
+  # games_controller.rb
+
+  class GamesController < ApplicationController
+    include Azeroth::Resourceable
+    skip_before_action :verify_authenticity_token
+
+    resource_for :game, except: :delete
+
+    private
+
+    def games
+      publisher.games
+    end
+
+    def publisher
+      @publisher ||= Publisher.find(publisher_id)
+    end
+
+    def publisher_id
+      params.require(:publisher_id)
+    end
+  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
+used to define how an object is exposed as json on controller responses
+defining which and how fields will be exposed
+
+```ruby
+  # pokemon/decorator.rb
+
+  class Pokemon::Decorator < Azeroth::Decorator
+    expose :name
+    expose :previous_form_name, as: :evolution_of, if: :evolution?
+
+    def evolution?
+      previous_form
+    end
+
+    def previous_form_name
+      previous_form.name
+    end
+  end
+```
+
+```ruby
+  # pokemon/favorite_decorator.rb
+
+  class Pokemon::FavoriteDecorator < Pokemon::Decorator
+    expose :nickname
+  end
+```
+
+```ruby
+  # pokemon_master/decorator.rb
+
+  class PokemonMaster < ActiveRecord::Base
+    has_one :favorite_pokemon, -> { where(favorite: true) },
+            class_name: 'Pokemon'
+    has_many :pokemons
+  end
+```
+
+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

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.4.3'
   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.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.2'
+  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'

data/lib/azeroth.rb

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

data/lib/azeroth/decorator.rb

@@ -84,6 +84,8 @@ module Azeroth
       #   to be called
       #   checking if an attribute should or should not
       #   be exposed
+      # @option options_hash decorator [FalseClass,TrueClass,Class]
+      #   flag to use or not a decorator or decorator class to be used
       #
       # @return [Array<Symbol>]
       #
@@ -104,6 +106,125 @@ module Azeroth
       #       end
       #     end
       #   end
+      #
+      # @example With relations
+      #   # pokemon/decorator.rb
+      #
+      #   class Pokemon::Decorator < Azeroth::Decorator
+      #     expose :name
+      #     expose :previous_form_name, as: :evolution_of, if: :evolution?
+      #
+      #     def evolution?
+      #       previous_form
+      #     end
+      #
+      #     def previous_form_name
+      #       previous_form.name
+      #     end
+      #   end
+      #
+      #   # pokemon/favorite_decorator.rb
+      #
+      #   class Pokemon::FavoriteDecorator < Pokemon::Decorator
+      #     expose :nickname
+      #   end
+      #
+      #   # pokemon_master/decorator.rb
+      #
+      #   class PokemonMaster < ActiveRecord::Base
+      #     has_one :favorite_pokemon, -> { where(favorite: true) },
+      #             class_name: 'Pokemon'
+      #     has_many :pokemons
+      #   end
+      #
+      #   # pokemon.rb
+      #
+      #   class Pokemon < ActiveRecord::Base
+      #     belongs_to :pokemon_master
+      #     has_one :previous_form,
+      #             class_name: 'Pokemon',
+      #             foreign_key: :previous_form_id
+      #   end
+      #
+      #   # pokemon_master.rb
+      #
+      #   class PokemonMaster::Decorator < Azeroth::Decorator
+      #     expose :name
+      #     expose :age
+      #     expose :favorite_pokemon, decorator: Pokemon::FavoriteDecorator
+      #     expose :pokemons
+      #
+      #     def name
+      #       [
+      #         first_name,
+      #         last_name
+      #       ].compact.join(' ')
+      #     end
+      #   end
+      #
+      #   # schema.rb
+      #
+      #   ActiveRecord::Schema.define do
+      #     self.verbose = false
+      #
+      #      create_table :pokemon_masters, force: true do |t|
+      #       t.string :first_name, null: false
+      #       t.string :last_name
+      #       t.integer :age, null: false
+      #     end
+      #
+      #     create_table :pokemons, force: true do |t|
+      #       t.string :name, null: false
+      #       t.string :nickname
+      #       t.integer :pokemon_master_id
+      #       t.boolean :favorite
+      #       t.integer :previous_form_id
+      #       t.index %i[pokemon_master_id favorite], unique: true
+      #     end
+      #
+      #     add_foreign_key 'pokemons', 'pokemon_masters'
+      #   end
+      #
+      #   # test.rb
+      #
+      #   master = PokemonMaster.create(
+      #     first_name: 'Ash',
+      #     last_name: 'Ketchum',
+      #     age: 10
+      #   )
+      #
+      #   master.create_favorite_pokemon(
+      #     name: 'pikachu',
+      #     nickname: 'Pikachu'
+      #   )
+      #
+      #   metapod = Pokemon.create(name: :metapod)
+      #
+      #   master.pokemons.create(
+      #     name: 'butterfree', previous_form: metapod
+      #   )
+      #   master.pokemons.create(name: 'squirtle')
+      #
+      #   decorator = PokemonMaster::Decorator.new(master)
+      #
+      #   decorator.as_json
+      #   # returns
+      #   # {
+      #   #   'age' => 10,
+      #   #   'name' => 'Ash Ketchum',
+      #   #   'favorite_pokemon' => {
+      #   #     'name' => 'pikachu',
+      #   #     'nickname' => 'Pikachu'
+      #   #   },
+      #   #   'pokemons' => [{
+      #   #     'name' => 'butterfree',
+      #   #     'evolution_of' => 'metapod'
+      #   #   }, {
+      #   #     'name' => 'squirtle'
+      #   #   }, {
+      #   #     'name' => 'pikachu'
+      #   #   }]
+      #   # }
       def expose(attribute, **options_hash)
         options = Decorator::Options.new(options_hash)
 
@@ -136,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/decorator/key_value_extractor.rb

@@ -97,9 +97,9 @@ module Azeroth
       #
       # @return [Class<Decorator>, NilClass]
       def decorator_from_options
-        return options.decorator if options.decorator
+        return options.decorator if options.decorator_defined?
 
-        Azeroth::DummyDecorator unless options.any_decorator?
+        Azeroth::DummyDecorator unless options.decorator
       end
 
       # @private