azeroth 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c8e0229917b320108b25371d2c30ca48f83663288d50d2e767b8cf45c037c95
-  data.tar.gz: 2e6fe774d10fa5b5ca3f22c0b4deac4828a28480ebd3ebb1cce370c84c0f359c
+  metadata.gz: 2bb67d32bc51b4aa26e666ec6d4f942dba16b454d07cf65cb5ebff1f052766ae
+  data.tar.gz: b5d68c84445bde028dcc0038cfe075947de6d45ffb31afb5f7bec088de680a09
 SHA512:
-  metadata.gz: b517e33573aa729a94fee810f0f4cea17a39533359332017e1dea8a3d80c74aacaac1010754739d8ba312d42353c57bb93d0c172aa640453450383ea1ff99328
-  data.tar.gz: 7bdfbfce3bdc6f40c2c82ea904a5778b5d0e7cc037f4fbf73f2e7d5fe8a449b7dacbac41f55523afea298bea5de998cc5d442e395fbf4949e555775aeabccff4
+  metadata.gz: c2604e2557de1bf029e1fbb0f32d16957e150a302c80b4db0c95e70dc2c7809f4883365b0e7f5756dfb8348aafd304f7262087ca80f95fa3f24e626a4dafe2b0
+  data.tar.gz: a54c254012d8de5f00c799a5cc9fa3e65467d8c624e3ad1d8eff8adf892f3bd7ec6b80134abd61766e0cadf37719a56d607b9d241af7c038fb56591b93255e94

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/.gitignore

@@ -12,3 +12,5 @@ spec/dummy/log/*
 spec/dummy/tmp/*
 spec/dummy/db/*.sqlite3
 spec/dummy/db/*.sqlite3-journal
+spec/dummy/db/*.sqlite3-shm
+spec/dummy/db/*.sqlite3-wal

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:
@@ -12,7 +13,7 @@ Metrics/BlockLength:
     - 'azeroth.gemspec'
 
 RSpec/NestedGroups:
-  Max: 4
+  Max: 5
 
 RSpec/AlignLeftLetBrace:
   Enabled: true
@@ -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.1.0](https://www.rubydoc.info/gems/azeroth/1.1.0)
+[https://www.rubydoc.info/gems/azeroth/2.1.0](https://www.rubydoc.info/gems/azeroth/2.1.0)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same
@@ -25,9 +25,9 @@ does not perform database operations
 Future versions will enable `html` rendering to also perform
 database operations.
 
-Current Release: [1.1.0](https://github.com/darthjee/azeroth/tree/1.1.0)
+Current Release: [2.1.0](https://github.com/darthjee/azeroth/tree/2.1.0)
 
-[Next release](https://github.com/darthjee/azeroth/compare/1.1.0...master)
+[Next release](https://github.com/darthjee/azeroth/compare/2.1.0...master)
 
 Installation
 ---------------
@@ -68,6 +68,8 @@ It accepts options
 - update_with: Method/Block to be ran when updating the reource on update
 - paginated: Flag when pagination should be applied
 - per_page: Number of items returned when pagination is active
+- id_key: key used to find a model. id by default
+- param_key: parameter key used to find the model
 
 ```ruby
   # publishers_controller.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/lib/azeroth/controller_interface.rb

@@ -60,6 +60,7 @@ module Azeroth
     private
 
     attr_reader :controller
+
     # @method controller
     # @private
     # @api private
@@ -74,13 +75,11 @@ module Azeroth
     #
     # @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)
+    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/hash_builder.rb

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

data/lib/azeroth/decorator.rb

@@ -94,13 +94,11 @@ module Azeroth
     # When object is an iterator, decoration is applied to each
     # and an array is returned
     #
-    # @param args [Hash] options (to be implemented)
-    #
     # @return [Hash]
-    def as_json(*args)
+    def as_json(*)
       return nil if object.nil?
 
-      return array_as_json(*args) if enum?
+      return array_as_json(*) if enum?
 
       HashBuilder.new(self).as_json
     end
@@ -108,6 +106,7 @@ module Azeroth
     private
 
     attr_reader :object
+
     # @method object
     # @api private
     #
@@ -145,13 +144,11 @@ module Azeroth
     #
     # @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)
+    def method_missing(method_name, *)
       if object.respond_to?(method_name)
-        object.public_send(method_name, *args)
+        object.public_send(method_name, *)
       else
         super
       end

data/lib/azeroth/model.rb

@@ -54,6 +54,7 @@ module Azeroth
     private
 
     attr_reader :options
+
     # @method options
     # @api private
     # @private

data/lib/azeroth/options.rb

@@ -17,6 +17,8 @@ module Azeroth
     DEFAULT_OPTIONS = {
       only: %i[create destroy edit index new show update],
       except: [],
+      id_key: :id,
+      param_key: :id,
       decorator: true,
       before_save: nil,
       after_save: nil,
@@ -65,6 +67,20 @@ module Azeroth
     #
     # @return [Array<String,Symbol>]
 
+    # @method id_key
+    # @api private
+    #
+    # key used to find a model. id by default
+    #
+    # @return [Symbol]
+
+    # @method param_key
+    # @api private
+    #
+    # parameter key used to find the model
+    #
+    # @return [Symbol]
+
     # @method decorator
     # @api private
     #

data/lib/azeroth/params_builder.rb

@@ -6,14 +6,15 @@ module Azeroth
   #
   # Class responsible for adding params handling methods to a controller
   class ParamsBuilder < Sinclair::Model
-    # @!method initialize(model:, builder:)
+    # @!method initialize(model:, builder:, options:)
     #   @api private
     #
     #   @param model [Model] Resource interface
     #   @param builder [Sinclair] Methods builder
+    #   @param options [Azeroth::Options] options
     #
     #   @return [ParamsBuilder]
-    initialize_with(:model, :builder, writter: false)
+    initialize_with(:model, :builder, :options, writter: false)
 
     # Append the params methods to be built
     #
@@ -22,7 +23,8 @@ module Azeroth
       method_name = name
       allowed_attributes = permitted_attributes.map(&:to_sym)
 
-      add_method("#{name}_id") { params.require(:id) }
+      param_key = options.param_key
+      add_method("#{name}_id") { params.require(param_key) }
       add_method("#{name}_params") do
         params.require(method_name)
               .permit(*allowed_attributes)
@@ -47,6 +49,14 @@ module Azeroth
     #
     # @return [Sinclair]
 
+    # @method options
+    # @api private
+    # @private
+    #
+    # Methods builder
+    #
+    # @return [Azeroth::Options]
+
     delegate :add_method, to: :builder
     # @method add_method
     # @api private

data/lib/azeroth/request_handler.rb

@@ -46,6 +46,7 @@ module Azeroth
     private
 
     attr_reader :controller, :model, :options
+
     # @method controller
     # @api private
     # @private
@@ -119,8 +120,8 @@ module Azeroth
     # Run a block triggering the event
     #
     # @return [Object] Result of given block
-    def trigger_event(event, &block)
-      options.event_registry.trigger(event, controller, &block)
+    def trigger_event(event, &)
+      options.event_registry.trigger(event, controller, &)
     end
 
     # @private

data/lib/azeroth/resource_builder.rb

@@ -10,14 +10,15 @@ module Azeroth
   # entries of a resource, and one for fetching an specific
   # entry
   class ResourceBuilder < Sinclair::Model
-    # @!method initialize(model:, builder:)
+    # @!method initialize(model:, builder:, options:)
     #   @api private
     #
     #   @param model [Model] Resource model interface
     #   @param builder [Sinclair] method builder
+    #   @param options [Azeroth::Options] options
     #
     #   @return [ResourceBuilder]
-    initialize_with(:model, :builder, writter: false)
+    initialize_with(:model, :builder, :options, writter: false)
 
     # Append methods to be built to the builder
     #
@@ -27,7 +28,10 @@ module Azeroth
     # @return [Array<Sinclair::MethodDefinition>]
     def append
       add_method(plural, "@#{plural} ||= #{model.klass}.all")
-      add_method(name, "@#{name} ||= #{plural}.find(#{name}_id)")
+      add_method(
+        name,
+        "@#{name} ||= #{plural}.find_by!(#{id_key}: #{name}_id)"
+      )
     end
 
     # @method model
@@ -70,5 +74,13 @@ module Azeroth
     # Return the pluralized version of resource name
     #
     # @return [String]
+
+    delegate :id_key, to: :options
+    # @method plural
+    # @api private
+    #
+    # key used to find a model. id by default
+    #
+    # @return [Symbol]
   end
 end

data/lib/azeroth/resourceable/class_methods.rb

@@ -7,7 +7,7 @@ module Azeroth
     #
     # Class methods added by {Resourceable}
     module ClassMethods
-      # Adds resource methods for resource
+      # Adds resource and routes methods for resource
       #
       # @param (see Resourceable.resource_for)
       # @option (see Resourceable.resource_for)
@@ -16,10 +16,23 @@ module Azeroth
       # @see (see Resourceable.resource_for)
       # @example (see Resourceable.resource_for)
       def resource_for(name, **options)
-        Builder.new(
+        EndpointsBuilder.new(
           self, name, Azeroth::Options.new(options)
         ).build
       end
+
+      # Adds resource methods for resource
+      #
+      # @param (see Resourceable.model_for)
+      # @return (see Resourceable.model_for)
+      #
+      # @see (see Resourceable.model_for)
+      # @example (see Resourceable.model_for)
+      def model_for(name)
+        ResourcesBuilder.new(
+          self, name, Azeroth::Options.new({})
+        ).build
+      end
     end
   end
 end

data/lib/azeroth/resourceable/endpoints_builder.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'sinclair'
+
+module Azeroth
+  module Resourceable
+    # @api private
+    # Builder responsible to add all methods to the controller
+    #
+    # Builder uses other builders to put together it's methods
+    #
+    # @see ResourceBuilder
+    # @see ResourceRouteBuilder
+    # @see RoutesBuilder
+    class EndpointsBuilder
+      # @param klass [ActionController::Base] Controller to
+      #   to be changed
+      # @param model_name [Symbol,String]
+      # @param options [Options]
+      def initialize(klass, model_name, options)
+        @klass = klass
+        @options = options
+        @model = Azeroth::Model.new(model_name, options)
+
+        add_routes
+        ResourcesBuilder.new(klass, model_name, options).build
+      end
+
+      private
+
+      attr_reader :klass, :model, :options
+
+      # @method klass
+      # @api private
+      # @private
+      #
+      # Controller to changed
+      #
+      # @return [ActionController::Base]
+
+      # @method model
+      # @api private
+      # @private
+      #
+      # Model interface to resource model
+      #
+      # @return [Model]
+
+      # @method options
+      # @api private
+      # @private
+      #
+      # Options
+      #
+      # @return [Options]
+
+      delegate :build, :add_method, to: :builder
+      # @method build
+      # @api private
+      # @private
+      #
+      # build all the methods
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+
+      # @method add_method
+      # @api private
+      #
+      # Add method to be built
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+
+      delegate :name, to: :model
+      # @method name
+      # @api private
+      # @private
+      #
+      # Resource name
+      #
+      # @return [Symbol,String]
+
+      # @api private
+      # @private
+      #
+      # Returns a method builder
+      #
+      # @return [Sinclair]
+      #
+      # @see https://www.rubydoc.info/gems/sinclair Sinclair
+      def builder
+        @builder ||= Sinclair.new(klass)
+      end
+
+      # Add metohods for each route
+      #
+      # @return [Array<Sinclair::MethodDefinition>]
+      def add_routes
+        RoutesBuilder.new(
+          model: model, builder: builder, options: options
+        ).append
+      end
+    end
+  end
+end

data/lib/azeroth/resourceable/{builder.rb → resources_builder.rb}

@@ -5,14 +5,12 @@ require 'sinclair'
 module Azeroth
   module Resourceable
     # @api private
-    # Builder responsible to add all methods to the controller
+    # Builder responsible to add resource / model methods to the controller
     #
-    # Builder uses other builders to put together it's methods
+    # Builder uses {ResourceBuilder} to put together it's methods
     #
     # @see ResourceBuilder
-    # @see ResourceRouteBuilder
-    # @see RoutesBuilder
-    class Builder
+    class ResourcesBuilder
       # @param klass [ActionController::Base] Controller to
       #   to be changed
       # @param model_name [Symbol,String]
@@ -24,13 +22,13 @@ module Azeroth
 
         add_params
         add_resource
-        add_routes
         add_helpers
       end
 
       private
 
       attr_reader :klass, :model, :options
+
       # @method klass
       # @api private
       # @private
@@ -97,7 +95,7 @@ module Azeroth
       # @return [Array<Sinclair::MethodDefinition>]
       def add_params
         ParamsBuilder.new(
-          model: model, builder: builder
+          model: model, builder: builder, options: options
         ).append
       end
 
@@ -105,24 +103,15 @@ module Azeroth
       #
       # @return [Array<Sinclair::MethodDefinition>]
       def add_resource
-        ResourceBuilder.new(model: model, builder: builder).append
-      end
-
-      # Add metohods for each route
-      #
-      # @return [Array<Sinclair::MethodDefinition>]
-      def add_routes
-        RoutesBuilder.new(
-          model: model, builder: builder, options: options
-        ).append
+        ResourceBuilder.new(model: model, builder: builder, options: options).append
       end
 
       # Add helpers to render objects on template
       #
       # @return [String]
       def add_helpers
-        klass.public_send(:helper_method, model.name)
-        klass.public_send(:helper_method, model.plural)
+        klass.helper_method(model.name)
+        klass.helper_method(model.plural)
       end
     end
   end