azeroth 0.10.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcc284d1b166fec28f03e31cd42642ad09a86c85a81718ba401531443b1bbc08
-  data.tar.gz: 335851aa5d9a160cf387971e904248c2f89041594ccdaec57fa9ab130624558f
+  metadata.gz: 72a4e7c837a4053e850b9479d42cfccd2e279ac028f57da2c5d3baed6c6babfa
+  data.tar.gz: 84591492fc859555d87b86704a61e68c0b8171e42a8fd77d1f4e502216516fc0
 SHA512:
-  metadata.gz: 7ef7afcbd3282d181339fa6f154d1b4dcb6c6bad00f7c4e33e5c0b912b55eecc7de9876e44d2d54e7709a006a7cef487ee6c057dc0645bc0e336ff2b70629fdf
-  data.tar.gz: d37ba6ffdfe83b55fd51f103fd9ba3f35a3edf5eb0121c5aab424da29ffcce3e7850d52acdb4c41097c773d2f5b56692dc5f0e6c751ebce1651153bde42f2e1d
+  metadata.gz: ad6ca16b03b7b99b051bf9bfd25e25d1d522fa89e5b5ff31e495fa1af4fbb193dd269b062d8a87205aa8eeea84bd8a405b84de5d1663d7a1636239d4dd6b973f
+  data.tar.gz: 3eec0d1c24bb260dab5fb3ccccf5deedc8ae2eeff7378084fd501c82e740f776f1e3a14e32cee939155f5f833c4c1affdd3ca19f6636681f664be3deca36ed23

data/.circleci/config.yml

@@ -22,7 +22,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_rails_gems:1.1.0
+      - image: darthjee/circleci_rails_gems:1.2.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.1.0
+      - image: darthjee/circleci_rails_gems:1.2.0
         environment:
           PROJECT: azeroth
     steps:
@@ -66,7 +66,7 @@ jobs:
           command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_rails_gems:1.1.0
+      - image: darthjee/circleci_rails_gems:1.2.0
         environment:
           PROJECT: azeroth
     steps:

data/Dockerfile

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

data/README.md

@@ -11,7 +11,7 @@ Azeroth
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/azeroth/0.10.1](https://www.rubydoc.info/gems/azeroth/0.10.1)
+[https://www.rubydoc.info/gems/azeroth/1.0.0](https://www.rubydoc.info/gems/azeroth/1.0.0)
 
 Azeroth has been designed making the coding of controllers easier
 as routes in controllers are usually copy, paste and replace of same
@@ -131,6 +131,36 @@ It accepts options
   end
 ```
 
+```ruby
+  class PaginatedDocumentsController < ApplicationController
+    include Azeroth::Resourceable
+
+    resource_for :document, only: 'index', paginated: true
+  end
+
+  30.times { create(:document) }
+
+  get '/paginated_documents.json'
+
+  # returns Array with 20 first documents
+  # returns in the headers pagination headers
+  # {
+  #   'pages' => 2,
+  #   'per_page' => 20,
+  #   'page' => 1
+  # }
+
+  get '/paginated_documents.json?page=2'
+
+  # returns Array with 10 next documents
+  # returns in the headers pagination headers
+  # {
+  #   'pages' => 2,
+  #   'per_page' => 20,
+  #   'page' => 2
+  # }
+```
+
 ## Azeroth::Decorator
 
 [Decorators](https://www.rubydoc.info/gems/azeroth/Azeroth/Decorator) are
@@ -172,35 +202,6 @@ defining which and how fields will be exposed
   end
 ```
 
-```ruby
-  class PaginatedDocumentsController < ApplicationController
-    include Azeroth::Resourceable
-
-    resource_for :document, only: 'index', paginated: true
-  end
-
-  30.times { create(:document) }
-
-  get '/paginated_documents.json'
-
-  # returns Array with 20 first documents
-  # returns in the headers pagination headers
-  {
-    'pages' => 2,
-    'per_page' => 20,
-    'page' => 1
-  }
-
-  get '/paginated_documents.json?page=2'
-
-  # returns Array with 10 next documents
-  # returns in the headers pagination headers
-  {
-    'pages' => 2,
-    'per_page' => 20,
-    'page' => 2
-  }
-```
 Exposing is done through the class method
 [expose](https://www.rubydoc.info/gems/azeroth/Azeroth/Decorator#expose-class_method)
 which accepts several options:

data/azeroth.gemspec

@@ -18,20 +18,20 @@ 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.x'
+  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',            '>= 1.6.7'
+  gem.add_runtime_dependency 'sinclair',            '>= 2.0.0'
 
-  gem.add_development_dependency 'actionpack',                '5.2.8.1'
-  gem.add_development_dependency 'activerecord',              '5.2.8.1'
-  gem.add_development_dependency 'bundler',                   '~> 2.3.14'
+  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.6'
+  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',                     '5.2.8.1'
+  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'
@@ -47,6 +47,7 @@ Gem::Specification.new do |gem|
   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'

data/lib/azeroth/decorator/hash_builder.rb

@@ -25,7 +25,9 @@ module Azeroth
       # @return [Hash]
       def as_json
         attributes_map.inject({}) do |hash, (method, options)|
-          new_hash = KeyValueExtractor.new(decorator, method, options).as_json
+          new_hash = KeyValueExtractor.new(
+            decorator: decorator, attribute: method, options: options
+          ).as_json
           hash.merge!(new_hash)
         end
       end

data/lib/azeroth/decorator/key_value_extractor.rb

@@ -11,18 +11,14 @@ module Azeroth
     #
     # A decorator is infered for the value / attribute
     # or used from the options given
-    class KeyValueExtractor
+    class KeyValueExtractor < Sinclair::Model
+      initialize_with(:decorator, :attribute, :options)
       # @param decorator [Decorator] decorator object
       # @param attribute [Symbol] attribute to be used on output hash
       # @param options [Decorator::Options] decoration options
       # @option options if [Proc,Symbol] conditional to be
       #   checked when exposing field
       #   (see {Decorator::Options#if})
-      def initialize(decorator, attribute, options)
-        @decorator = decorator
-        @attribute = attribute
-        @options = options
-      end
 
       # Return hash for attribute
       #
@@ -38,9 +34,8 @@ module Azeroth
         }
       end
 
-      # private
+      private
 
-      attr_reader :decorator, :attribute, :options
       # @method decorator
       # @api private
       # @private

data/lib/azeroth/params_builder.rb

@@ -5,13 +5,15 @@ module Azeroth
   # @author Darthjee
   #
   # Class responsible for adding params handling methods to a controller
-  class ParamsBuilder
-    # @param model [Model] resource interface
-    # @param builder [Sinclair] methods builder
-    def initialize(model, builder)
-      @model = model
-      @builder = builder
-    end
+  class ParamsBuilder < Sinclair::Model
+    # @!method initialize(model:, builder:)
+    #   @api private
+    #
+    #   @param model [Model] Resource interface
+    #   @param builder [Sinclair] Methods builder
+    #
+    #   @return [ParamsBuilder]
+    initialize_with(:model, :builder, writter: false)
 
     # Append the params methods to be built
     #
@@ -27,7 +29,8 @@ module Azeroth
       end
     end
 
-    attr_reader :model, :builder
+    private
+
     # @method model
     # @api private
     # @private

data/lib/azeroth/resource_builder.rb

@@ -9,13 +9,15 @@ module Azeroth
   # The builder adds 2 methods, one for listing all
   # entries of a resource, and one for fetching an specific
   # entry
-  class ResourceBuilder
-    # @param model [Model] Resource model interface
-    # @param builder [Sinclair] method builder
-    def initialize(model, builder)
-      @model = model
-      @builder = builder
-    end
+  class ResourceBuilder < Sinclair::Model
+    # @!method initialize(model:, builder:)
+    #   @api private
+    #
+    #   @param model [Model] Resource model interface
+    #   @param builder [Sinclair] method builder
+    #
+    #   @return [ResourceBuilder]
+    initialize_with(:model, :builder, writter: false)
 
     # Append methods to be built to the builder
     #
@@ -28,9 +30,6 @@ module Azeroth
       add_method(name, "@#{name} ||= #{plural}.find(#{name}_id)")
     end
 
-    private
-
-    attr_reader :model, :builder
     # @method model
     # @api private
     # @private

data/lib/azeroth/resourceable/builder.rb

@@ -13,12 +13,12 @@ module Azeroth
     # @see ResourceRouteBuilder
     # @see RoutesBuilder
     class Builder
-      # @param clazz [ActionController::Base] Controller to
+      # @param klass [ActionController::Base] Controller to
       #   to be changed
       # @param model_name [Symbol,String]
       # @param options [Options]
-      def initialize(clazz, model_name, options)
-        @clazz = clazz
+      def initialize(klass, model_name, options)
+        @klass = klass
         @options = options
         @model = Azeroth::Model.new(model_name, options)
 
@@ -30,8 +30,8 @@ module Azeroth
 
       private
 
-      attr_reader :clazz, :model, :options
-      # @method clazz
+      attr_reader :klass, :model, :options
+      # @method klass
       # @api private
       # @private
       #
@@ -89,36 +89,40 @@ module Azeroth
       #
       # @see https://www.rubydoc.info/gems/sinclair Sinclair
       def builder
-        @builder ||= Sinclair.new(clazz)
+        @builder ||= Sinclair.new(klass)
       end
 
       # Add methods for id and parameters
       #
       # @return [Array<Sinclair::MethodDefinition>]
       def add_params
-        ParamsBuilder.new(model, builder).append
+        ParamsBuilder.new(
+          model: model, builder: builder
+        ).append
       end
 
       # Add methods for resource fetching
       #
       # @return [Array<Sinclair::MethodDefinition>]
       def add_resource
-        ResourceBuilder.new(model, builder).append
+        ResourceBuilder.new(model: model, builder: builder).append
       end
 
       # Add metohods for each route
       #
       # @return [Array<Sinclair::MethodDefinition>]
       def add_routes
-        RoutesBuilder.new(model, builder, options).append
+        RoutesBuilder.new(
+          model: model, builder: builder, options: options
+        ).append
       end
 
       # Add helpers to render objects on template
       #
       # @return [String]
       def add_helpers
-        clazz.public_send(:helper_method, model.name)
-        clazz.public_send(:helper_method, model.plural)
+        klass.public_send(:helper_method, model.name)
+        klass.public_send(:helper_method, model.plural)
       end
     end
   end

data/lib/azeroth/routes_builder.rb

@@ -5,15 +5,14 @@ module Azeroth
   # @author Darthjee
   #
   # Builder resposible for adding routes methods to the controller
-  class RoutesBuilder
-    # @param model [Model] resource interface
-    # @param builder [Sinclair] methods builder
-    # @param options [Option]
-    def initialize(model, builder, options)
-      @model = model
-      @builder = builder
-      @options = options
-    end
+  class RoutesBuilder < Sinclair::Model
+    initialize_with(:model, :builder, :options, writter: false)
+
+    # @method initialize(model:, builder:, options:)
+    #   @param model [Model] resource interface
+    #   @param builder [Sinclair] methods builder
+    #   @param options [Option]
+    #   @return [RoutesBuilder]
 
     # Append the routes methods to be built
     #
@@ -26,7 +25,6 @@ module Azeroth
 
     private
 
-    attr_reader :model, :builder, :options
     # @method model
     # @api private
     # @private

data/lib/azeroth/version.rb

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

data/spec/controllers/documents_with_error_controller_spec.rb

@@ -128,7 +128,9 @@ describe DocumentsWithErrorController do
 
     it 'returns updated document json' do
       patch :update, params: parameters
-      expect(response.body).to eq(expected_body)
+
+      expect(JSON.parse(response.body))
+        .to eq(JSON.parse(expected_body))
     end
 
     it do

data/spec/dummy/config/environments/development.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 Rails.application.configure do
+  config.hosts << 'www.example.com'
   # Settings specified here will take precedence over
   # those in config/application.rb.
 

data/spec/dummy/db/schema.rb

@@ -51,6 +51,4 @@ ActiveRecord::Schema.define do
     t.string :name, null: false
     t.string :director, null: false
   end
-
-  add_foreign_key 'pokemons', 'pokemon_masters'
 end

data/spec/lib/azeroth/decorator/key_value_extractor_spec.rb

@@ -4,7 +4,9 @@ require 'spec_helper'
 
 describe Azeroth::Decorator::KeyValueExtractor do
   subject(:extractor) do
-    described_class.new(decorator, attribute, options)
+    described_class.new(
+      decorator: decorator, attribute: attribute, options: options
+    )
   end
 
   let(:decorator_class) { Class.new(Azeroth::Decorator) }

data/spec/lib/azeroth/params_builder_spec.rb

@@ -3,7 +3,9 @@
 require 'spec_helper'
 
 describe Azeroth::ParamsBuilder do
-  subject(:params_builder) { described_class.new(model, builder) }
+  subject(:params_builder) do
+    described_class.new(model: model, builder: builder)
+  end
 
   let(:model)   { Azeroth::Model.new(:document, options) }
   let(:options) { Azeroth::Options.new }

data/spec/lib/azeroth/resource_builder_spec.rb

@@ -3,7 +3,9 @@
 require 'spec_helper'
 
 describe Azeroth::ResourceBuilder do
-  subject(:resource_builder) { described_class.new(model, builder) }
+  subject(:resource_builder) do
+    described_class.new(model: model, builder: builder)
+  end
 
   let(:model)   { Azeroth::Model.new(:document, options) }
   let(:options) { Azeroth::Options.new }

data/spec/lib/azeroth/routes_builder_spec.rb

@@ -4,7 +4,9 @@ require 'spec_helper'
 
 describe Azeroth::RoutesBuilder do
   subject(:routes_builder) do
-    described_class.new(model, builder, options)
+    described_class.new(
+      model: model, builder: builder, options: options
+    )
   end
 
   let(:controller) { controller_class.new }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azeroth
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Darthjee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-27 00:00:00.000000000 Z
+date: 2023-05-13 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.x
+        version: 7.0.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.x
+        version: 7.0.x
 - !ruby/object:Gem::Dependency
   name: darthjee-active_ext
   requirement: !ruby/object:Gem::Requirement
@@ -58,56 +58,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.8.1
+        version: 7.0.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.8.1
+        version: 7.0.4.3
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.8.1
+        version: 7.0.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.8.1
+        version: 7.0.4.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.14
+        version: 2.4.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.14
+        version: 2.4.8
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.13.6
+        version: 1.13.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.13.6
+        version: 1.13.8
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.8.1
+        version: 7.0.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.8.1
+        version: 7.0.4.3
 - !ruby/object:Gem::Dependency
   name: rails-controller-testing
   requirement: !ruby/object:Gem::Requirement
@@ -402,6 +402,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -679,7 +693,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Azeroth