azeroth 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a4e7c837a4053e850b9479d42cfccd2e279ac028f57da2c5d3baed6c6babfa
-  data.tar.gz: 84591492fc859555d87b86704a61e68c0b8171e42a8fd77d1f4e502216516fc0
+  metadata.gz: 65ba326980d7b37bb878cf1f230dea518561a68fdc337e53b9ca6391766957f3
+  data.tar.gz: 6f39fcee3056ad4eccbc72d1fc268460144bf3ec442cc4292f31a3bbf98f77b4
 SHA512:
-  metadata.gz: ad6ca16b03b7b99b051bf9bfd25e25d1d522fa89e5b5ff31e495fa1af4fbb193dd269b062d8a87205aa8eeea84bd8a405b84de5d1663d7a1636239d4dd6b973f
-  data.tar.gz: 3eec0d1c24bb260dab5fb3ccccf5deedc8ae2eeff7378084fd501c82e740f776f1e3a14e32cee939155f5f833c4c1affdd3ca19f6636681f664be3deca36ed23
+  metadata.gz: 10907b167920b813c0de6aa9a77dad7366cf8a16179a4179c6343ab4544d9b86560ed812a2d897aaf702d4d556b3d77d45de2a03b00a47e34368488230ef2cf7
+  data.tar.gz: 805c0ea2d52a06e1c2472ba390d973fcf0b06e3ae16fcf03cde5cae97a70b0b25072aff1f7295a42cbcfd4c228a62e32481e126bbc9191394f2031d1df5b7482

data/.circleci/config.yml

@@ -22,7 +22,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_rails_gems:1.2.0
+      - image: darthjee/circleci_rails_gems:2.0.0
         environment:
           PROJECT: azeroth
     steps:
@@ -41,7 +41,7 @@ jobs:
           command: cc-test-reporter after-build --exit-code $?
   checks:
     docker:
-      - image: darthjee/circleci_rails_gems:1.2.0
+      - image: darthjee/circleci_rails_gems:2.0.0
         environment:
           PROJECT: azeroth
     steps:
@@ -66,7 +66,7 @@ jobs:
           command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_rails_gems:1.2.0
+      - image: darthjee/circleci_rails_gems:2.0.0
         environment:
           PROJECT: azeroth
     steps:

data/.rubocop.yml

@@ -2,7 +2,8 @@ require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.3
+  NewCops: enable
 
 Metrics/BlockLength:
   Exclude:
@@ -35,3 +36,16 @@ RSpec/MultipleExpectations:
   Exclude:
     - 'spec/integration/readme/**/*_spec.rb'
     - 'spec/integration/yard/**/*_spec.rb'
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Lint/EmptyClass:
+  Enabled: false

data/Dockerfile

@@ -1,6 +1,6 @@
-FROM darthjee/scripts:0.3.1 as scripts
+FROM darthjee/scripts:0.4.3 as scripts
 
-FROM darthjee/rails_gems:1.2.0 as base
+FROM darthjee/rails_gems:2.0.0 as base
 
 COPY --chown=app:app ./ /home/app/app/
 

data/Gemfile

@@ -3,3 +3,33 @@
 source 'https://rubygems.org'
 
 gemspec
+
+gem 'actionpack',                '7.2.2.1'
+gem 'activerecord',              '7.2.2.1'
+gem 'bundler',                   '~> 2.6.8'
+gem 'factory_bot',               '6.2.1'
+gem 'minitest',                  '5.25.4'
+gem 'nokogiri',                  '1.18.8'
+gem 'pry',                       '0.14.2'
+gem 'pry-nav',                   '1.0.0'
+gem 'rails',                     '7.2.2.1'
+gem 'rails-controller-testing',  '1.0.5'
+gem 'rake',                      '13.2.1'
+gem 'reek',                      '6.4.0'
+gem 'rspec',                     '3.13.0'
+gem 'rspec-collection_matchers', '1.2.1'
+gem 'rspec-core',                '3.13.3'
+gem 'rspec-expectations',        '3.13.3'
+gem 'rspec-mocks',               '3.13.2'
+gem 'rspec-rails',               '8.0.0'
+gem 'rspec-support',             '3.13.2'
+gem 'rubocop',                   '1.75.5'
+gem 'rubocop-rspec',             '3.6.0'
+gem 'rubycritic',                '4.9.2'
+gem 'shoulda-matchers',          '6.5.0'
+gem 'simplecov',                 '0.22.0'
+gem 'sprockets-rails',           '3.5.2'
+gem 'sqlite3',                   '1.4.2'
+gem 'tzinfo-data',               '~> 1.2025.2'
+gem 'yard',                      '0.9.37'
+gem 'yardstick',                 '0.9.9'

data/Makefile

@@ -0,0 +1,6 @@
+.PHONY: dev
+
+PROJECT?=azeroth
+
+dev:
+	docker-compose run $(PROJECT) /bin/bash

data/README.md

@@ -11,7 +11,7 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/1.0.0](https://www.rubydoc.info/gems/azeroth/1.0.0)
+[https://www.rubydoc.info/gems/azeroth/2.0.0](https://www.rubydoc.info/gems/azeroth/2.0.0)
 
 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,10 @@ does not perform database operations
 Future versions will enable `html` rendering to also perform
 database operations.
 
+Current Release: [2.0.0](https://github.com/darthjee/azeroth/tree/2.0.0)
+
+[Next release](https://github.com/darthjee/azeroth/compare/2.0.0...master)
+
 Installation
 ---------------
 
@@ -167,6 +171,14 @@ It accepts options
 used to define how an object is exposed as json on controller responses
 defining which and how fields will be exposed
 
+Exposing options:
+
+- as: custom key to expose the value as
+- 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
+- reader: Flag indicating if a reader to access the attribute should be created. usefull if you want method_missing to take over
+- override: Flag indicating if an existing method should be overriden. This is useful when a method acessor was included from another module
+
 ```ruby
   # pokemon/decorator.rb
 

data/azeroth.gemspec

@@ -10,46 +10,16 @@ Gem::Specification.new do |gem|
   gem.authors       = ['Darthjee']
   gem.email         = ['darthjee@gmail.com']
   gem.summary       = 'Azeroth'
-  gem.description   = gem.description
+  gem.description   = 'Rails controller builder'
   gem.homepage      = 'https://github.com/darthjee/azeroth'
+  gem.required_ruby_version = '>= 3.3.1'
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'activesupport',       '~> 7.0.x'
-  gem.add_runtime_dependency 'darthjee-active_ext', '>= 1.3.2'
-  gem.add_runtime_dependency 'jace',                '>= 0.1.1'
-  gem.add_runtime_dependency 'sinclair',            '>= 2.0.0'
-
-  gem.add_development_dependency 'actionpack',                '7.0.4.3'
-  gem.add_development_dependency 'activerecord',              '7.0.4.3'
-  gem.add_development_dependency 'bundler',                   '~> 2.4.8'
-  gem.add_development_dependency 'factory_bot',               '6.2.1'
-  gem.add_development_dependency 'minitest',                  '5.16.2'
-  gem.add_development_dependency 'nokogiri',                  '1.13.8'
-  gem.add_development_dependency 'pry',                       '0.14.1'
-  gem.add_development_dependency 'pry-nav',                   '1.0.0'
-  gem.add_development_dependency 'rails',                     '7.0.4.3'
-  gem.add_development_dependency 'rails-controller-testing',  '1.0.5'
-  gem.add_development_dependency 'rake',                      '13.0.6'
-  gem.add_development_dependency 'reek',                      '6.0.3'
-  gem.add_development_dependency 'rspec',                     '3.11.0'
-  gem.add_development_dependency 'rspec-collection_matchers', '1.2.0'
-  gem.add_development_dependency 'rspec-core',                '3.11.0'
-  gem.add_development_dependency 'rspec-expectations',        '3.11.0'
-  gem.add_development_dependency 'rspec-mocks',               '3.11.1'
-  gem.add_development_dependency 'rspec-rails',               '5.1.2'
-  gem.add_development_dependency 'rspec-support',             '3.11.0'
-  gem.add_development_dependency 'rubocop',                   '0.80.1'
-  gem.add_development_dependency 'rubocop-rspec',             '1.38.1'
-  gem.add_development_dependency 'rubycritic',                '4.7.0'
-  gem.add_development_dependency 'shoulda-matchers',          '4.3.0'
-  gem.add_development_dependency 'simplecov',                 '0.21.2'
-  gem.add_development_dependency 'sprockets-rails',           '3.4.2'
-  gem.add_development_dependency 'sqlite3',                   '1.4.2'
-  gem.add_development_dependency 'tzinfo-data',               '~> 1.2022.1'
-  gem.add_development_dependency 'yard',                      '0.9.27'
-  gem.add_development_dependency 'yardstick',                 '0.9.9'
+  gem.add_dependency 'activesupport',       '~> 7.2.x'
+  gem.add_dependency 'darthjee-active_ext', '>= 1.3.2'
+  gem.add_dependency 'jace',                '>= 0.1.1'
+  gem.add_dependency 'sinclair',            '>= 3.0.0'
 end

data/config/check_specs.yml

@@ -1,4 +1,5 @@
 ignore:
+  - lib/azeroth/decorator/class_methods.rb
   - lib/azeroth/decorator/options.rb
   - lib/azeroth/resourceable/class_methods.rb
   - lib/azeroth/resourceable.rb

data/lib/azeroth/controller_interface.rb

@@ -60,6 +60,7 @@ module Azeroth
     private
 
     attr_reader :controller
+
     # @method controller
     # @private
     # @api private
@@ -78,9 +79,9 @@ module Azeroth
     #   method called
     #
     # @return [Object]
-    def method_missing(method_name, *args)
+    def method_missing(method_name, *)
       if controller.respond_to?(method_name, true)
-        controller.send(method_name, *args)
+        controller.send(method_name, *)
       else
         super
       end

data/lib/azeroth/decorator/class_methods.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class Decorator
+    # @api private
+    # @author Darthjee
+    #
+    # Class methods added by {Decorator}
+    #
+    # @see ClassMethods#expose
+    module ClassMethods
+      # @api private
+      #
+      # All attributes exposed
+      #
+      # @return [Hash<Symbol,Hash>]
+      def attributes_map
+        @attributes_map ||= build_attributes_map
+      end
+
+      private
+
+      # @api private
+      # @private
+      #
+      # Initialize attributes to be exposed map
+      #
+      # When the class inherity from another
+      # decorator, the new class should expose the
+      # same attributes.
+      #
+      # @return [Hash<Symbol,Hash>]
+      def build_attributes_map
+        superclass.try(:attributes_map).dup || {}
+      end
+
+      # @visibility public
+      # @api (see Decorator.expose)
+      # @private
+      #
+      # Expose attributes on json decorated
+      #
+      # @param (see Decorator.expose)
+      # @option (see Decorator.expose)
+      #
+      # @return (see Decorator.expose)
+      #
+      # @example Simple usage
+      #   class DummyModel
+      #     include ActiveModel::Model
+      #
+      #     attr_accessor :id, :first_name, :last_name, :age,
+      #                   :favorite_pokemon
+      #
+      #     class Decorator < Azeroth::Decorator
+      #       expose :name
+      #       expose :age
+      #       expose :favorite_pokemon, as: :pokemon
+      #
+      #       def name
+      #         [object.first_name, object.last_name].join(' ')
+      #       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'
+      #   #   }]
+      #   # }
+      #
+      # @example With method building options
+      #   ActiveRecord::Schema.define do
+      #     self.verbose = false
+      #
+      #     create_table :websites, force: true do |t|
+      #       t.string :domain, null: false
+      #       t.integer :port, limit: 2, unsigned: true
+      #       t.string :protocol, limit: 5
+      #     end
+      #   end
+      #
+      #   class Website < ActiveRecord::Base
+      #   end
+      #
+      #   class Website < ActiveRecord::Base
+      #     module WithLocation
+      #       def location
+      #         "#{protocol}://#{domain}:#{port}"
+      #       end
+      #
+      #       def protocol
+      #         website.protocol || '*'
+      #       end
+      #
+      #       def domain
+      #         website.domain || '*'
+      #       end
+      #
+      #       def port
+      #         website.port || '*'
+      #       end
+      #     end
+      #   end
+      #
+      #   class Website < ActiveRecord::Base
+      #     class Decorator < Azeroth::Decorator
+      #       include WithLocation
+      #
+      #       expose :location, override: false
+      #
+      #       alias website object
+      #     end
+      #   end
+      #
+      #   website = Website.create(
+      #     protocol: :http,
+      #     domain: 'google.com'
+      #   )
+      #
+      #   decorator = Website::Decorator.new(website)
+      #
+      #   decorator.as_json
+      #
+      #   # returns
+      #   # { 'location' => 'http://google.com:*' }
+      def expose(attribute, **options_hash)
+        options = Decorator::Options.new(options_hash)
+
+        MethodBuilder.build_reader(self, attribute, options)
+
+        attributes_map[attribute] = options
+      end
+    end
+  end
+end

data/lib/azeroth/decorator/hash_builder.rb

@@ -35,6 +35,7 @@ module Azeroth
       private
 
       attr_reader :decorator
+
       # @method decorator
       # @api private
       # @private

data/lib/azeroth/decorator/method_builder.rb

@@ -7,20 +7,36 @@ module Azeroth
     # 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)
+      class << self
+        # Builds reader
+        #
+        # reaader delegate method calls to @object
+        #
+        # @return [Array<Sinclair::MethodDefinition>]
+        def build_reader(klass, attribute, options)
+          new(klass, options).build_reader(attribute)
+        end
+      end
+
+      def initialize(klass, options)
+        super(klass)
+        @options = options
       end
 
       # (see MethodBuilder.build_reader)
       def build_reader(attribute)
+        return if skip_creation?(attribute)
+
         add_method(attribute, "@object.#{attribute}")
         build
       end
+
+      def skip_creation?(attribute)
+        return true unless options.reader
+        return false unless klass.method_defined?(attribute)
+
+        !options.override
+      end
     end
   end
 end

data/lib/azeroth/decorator/options.rb

@@ -13,7 +13,9 @@ module Azeroth
       DEFAULT_OPTIONS = {
         as: nil,
         if: nil,
-        decorator: true
+        decorator: true,
+        override: true,
+        reader: true
       }.freeze
 
       with_options DEFAULT_OPTIONS