azeroth 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564c4da855e8fb88cf9baadf79b22cc26574777869979c4e746ae4a2341334b4
-  data.tar.gz: 32fd29efed31108ec9c5a6a260a18b5238bbb995af0863917c91f6a7fc564d47
+  metadata.gz: 932722b68ea70d25532bae9611143e1858edbe50b38459bf1134b6429ec960e0
+  data.tar.gz: 77b46098f931ba91e40e00b28b8d4fe823cc81bdaeebcbb8f9e44a0d2ab150c0
 SHA512:
-  metadata.gz: 9dc5c3dd01694a0fd7a1d171938a7a612dcea48d3631760b1b7de851cdd3f379194ae6f79ed2201fd009f4c3b4290ff550b9c154650f8a5f9e4128cbf6a5f636
-  data.tar.gz: b9233fa302ec9a94c1fb6947ef31f2ccfb5d4b8e37b7c8837c741883edaeef21851616ebdb6be098d7c74fd2a4af3d8a0bd81311d4de2930ed2ea6cb5715afbd
+  metadata.gz: c4bad15f9ba9d71be3da8a48507cd3a96b9834892ed14001abd3122b780d465a787da7c34979222f7b13a1603c5510265c6b09ea9e92f7b176f9a6307741b737
+  data.tar.gz: 8c437bf58301cfc6a28893b7bdff6390beed0640c843be66d662505cfb582200e7f847333ac6d7b5b4719e4bb3fb5af26408844d62899e77846e14fceef229f0

data/.circleci/config.yml

@@ -2,7 +2,9 @@ version: 2
 jobs:
   build:
     docker:
-      - image: darthjee/circleci_ruby_gems:0.0.1
+      - image: darthjee/circleci_ruby_gems:0.2.3
+        environment:
+          PROJECT: azeroth
     steps:
       - checkout
       - run:
@@ -25,4 +27,10 @@ jobs:
           command: bundle exec rake verify_measurements
       - run:
           name: Check version documentation
-          command: scripts/check_readme.sh
+          command: check_readme.sh
+      - run:
+          name: Rubycritcs check
+          command: rubycritic.sh
+      - run:
+          name: Check unit tests
+          command: check_specs

data/.gitignore

@@ -1,3 +1,9 @@
-coverage/
-pkg/
+coverages
+pkg
 Gemfile.lock
+coverage
+doc
+.yardoc/
+measurement/
+**/*.swp
+rubycritic/

data/.rubocop.yml

@@ -1 +1,17 @@
+require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'spec/support/shared_*/**/*.rb'
+    - 'azeroth.gemspec'
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/AlignLeftLetBrace:
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,40 +1,21 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-06-20 21:55:03 +0000 using RuboCop version 0.57.2.
+# on 2019-03-26 17:30:42 +0000 using RuboCop version 0.58.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-Metrics/AbcSize:
-  Max: 22
-
-# Offense count: 2
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 58
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 11
-
-# Offense count: 7
+# Offense count: 8
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/azeroth.rb'
     - 'lib/azeroth/model.rb'
-    - 'lib/azeroth/resourceable.rb'
-    - 'lib/azeroth/resourceable/builder.rb'
+    - 'lib/azeroth/options.rb'
     - 'lib/azeroth/resource_builder.rb'
     - 'lib/azeroth/resource_route_builder.rb'
+    - 'lib/azeroth/resourceable.rb'
+    - 'lib/azeroth/resourceable/builder.rb'
     - 'lib/azeroth/routes_builder.rb'
-
-# Offense count: 6
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 121

data/Dockerfile

@@ -1,6 +1,30 @@
-FROM darthjee/ruby_gems:0.0.1
+FROM darthjee/ruby_gems:0.2.3 as base
+FROM darthjee/scripts:0.1.2 as scripts
+
+######################################
+
+FROM base as builder
 
-USER app
 COPY --chown=app ./ /home/app/app/
+COPY --chown=app:app --from=scripts /home/scripts/builder/bundle_builder.sh /usr/local/sbin/
+
+ENV HOME_DIR /home/app
+RUN bundle_builder.sh
 
+#######################
+#FINAL IMAGE
+FROM base
+RUN mkdir lib/azeroth -p
+
+USER root
+
+COPY --chown=app:app --from=builder /home/app/bundle/gems /usr/local/bundle/gems
+COPY --chown=app:app --from=builder /home/app/bundle/cache /usr/local/bundle/cache
+COPY --chown=app:app --from=builder /home/app/bundle/specifications /usr/local/bundle/specifications
+COPY --chown=app:app --from=builder /home/app/bundle/bin /usr/local/bundle/bin
+COPY --chown=app:app --from=builder /home/app/bundle/extensions /usr/local/bundle/extensions
+
+COPY --chown=app ./*.gemspec ./Gemfile /home/app/app/
+COPY --chown=app ./lib/azeroth/version.rb /home/app/app/lib/azeroth/
+USER app
 RUN bundle install

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -3,9 +3,10 @@ Azeroth
 [![Code Climate](https://codeclimate.com/github/darthjee/azeroth/badges/gpa.svg)](https://codeclimate.com/github/darthjee/azeroth)
 [![Test Coverage](https://codeclimate.com/github/darthjee/azeroth/badges/coverage.svg)](https://codeclimate.com/github/darthjee/azeroth/coverage)
 [![Issue Count](https://codeclimate.com/github/darthjee/azeroth/badges/issue_count.svg)](https://codeclimate.com/github/darthjee/azeroth)
+[![Gem Version](https://badge.fury.io/rb/azeroth.svg)](https://badge.fury.io/rb/azeroth)
 
 ![azeroth](https://raw.githubusercontent.com/darthjee/azeroth/master/azeroth.jpg)
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/azeroth/0.0.4
+https://www.rubydoc.info/gems/azeroth/0.0.5

data/Rakefile

@@ -4,6 +4,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'yardstick/rake/measurement'
 require './config/yardstick'
+require './config/rubycritc'
 
 RSpec::Core::RakeTask.new
 

data/azeroth.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'azeroth/version'
@@ -16,22 +18,27 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'sinclair', '>= 1.1.2'
-
-  gem.add_runtime_dependency 'activesupport', '~> 5.x'
+  gem.add_runtime_dependency 'activesupport', '~> 5.2.0'
   gem.add_runtime_dependency 'darthjee-active_ext', '>= 1.3.2'
+  gem.add_runtime_dependency 'sinclair', '>= 1.5.2'
 
   gem.add_development_dependency 'actionpack', '~> 5.x'
   gem.add_development_dependency 'activerecord', '~> 5.x'
+  gem.add_development_dependency 'bundler', '~> 1.16.1'
+  gem.add_development_dependency 'pry', '0.12.2'
+  gem.add_development_dependency 'pry-nav', '0.3.0'
+  gem.add_development_dependency 'rake', '12.3.3'
+  gem.add_development_dependency 'reek', '5.4.0'
+  gem.add_development_dependency 'rspec', '3.8.0'
+  gem.add_development_dependency 'rspec-core', '3.8.0'
+  gem.add_development_dependency 'rspec-expectations', '3.8.3'
+  gem.add_development_dependency 'rspec-mocks',        '3.8.0'
+  gem.add_development_dependency 'rspec-support',      '3.8.0'
+  gem.add_development_dependency 'rubocop',            '0.73.0'
+  gem.add_development_dependency 'rubocop-rspec',      '1.33.0'
+  gem.add_development_dependency 'rubycritic',         '4.1.0'
+  gem.add_development_dependency 'simplecov',          '0.17.0'
   gem.add_development_dependency 'sqlite3', '>= 1.3.13'
-
-  gem.add_development_dependency 'bundler',       '~> 1.16.1'
-  gem.add_development_dependency 'pry-nav',       '~> 0.2.4'
-  gem.add_development_dependency 'rake',          '>= 12.3.1'
-  gem.add_development_dependency 'rspec',         '>= 3.8'
-  gem.add_development_dependency 'rubocop',       '0.58.1'
-  gem.add_development_dependency 'rubocop-rspec', '1.30.0'
-  gem.add_development_dependency 'simplecov',     '~> 0.16.x'
-  gem.add_development_dependency 'yard',          '>= 0.9.18'
-  gem.add_development_dependency 'yardstick',     '>= 0.9.9'
+  gem.add_development_dependency 'yard',               '0.9.20'
+  gem.add_development_dependency 'yardstick',          '0.9.9'
 end

data/config/check_specs.yml

@@ -0,0 +1,5 @@
+ignore:
+  - lib/azeroth/resourceable.rb
+  - lib/azeroth/version.rb
+  - lib/azeroth/options.rb
+  - lib/azeroth.rb

data/config/rubycritc.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rubycritic/rake_task'
+
+RubyCritic::RakeTask.new do |task|
+  options = %w[
+    --path rubycritic/
+    --no-browser
+  ]
+  task.options = options.join(' ')
+  task.paths   = %w[lib]
+end

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 52.6
+threshold: 98.5
 require_exact_threshold: false
 rules:
   ApiTag::Presence:
@@ -21,7 +21,12 @@ rules:
     exclude: []
   Summary::Presence:
     enabled: true
-    exclude: []
+    exclude:
+      - Azeroth::Model#initialize
+      - Azeroth::ResourceBuilder#initialize
+      - Azeroth::ResourceRouteBuilder#initialize
+      - Azeroth::Resourceable::Builder#initialize
+      - Azeroth::RoutesBuilder#initialize
   Summary::Length:
     enabled: true
     exclude: []

data/lib/azeroth.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Azeroth
-  autoload :Resourceable,         'azeroth/resourceable'
   autoload :Model,                'azeroth/model'
-  autoload :RoutesBuilder,        'azeroth/routes_builder'
-  autoload :ResourceRouteBuilder, 'azeroth/resource_route_builder'
+  autoload :Resourceable,         'azeroth/resourceable'
   autoload :ResourceBuilder,      'azeroth/resource_builder'
+  autoload :ResourceRouteBuilder, 'azeroth/resource_route_builder'
+  autoload :RoutesBuilder,        'azeroth/routes_builder'
+  autoload :Options,              'azeroth/options'
 end

data/lib/azeroth/model.rb

@@ -1,15 +1,34 @@
+# frozen_string_literal: true
+
 module Azeroth
+  # @api private
+  # @author Darthjee
+  #
+  # Model responsible for making the conection to the resource model class
   class Model
     attr_reader :name
+    # @method name
+    # @api private
+    #
+    # Returns the name of the resource represented by the model
+    #
+    # @return [String]
 
+    # @param name [String,Symbol] name of the resource
     def initialize(name)
-      @name ||= name.to_s
+      @name = name.to_s
     end
 
+    # Resource class (real model class)
+    #
+    # @return [Class]
     def klass
       @klass ||= name.camelize.constantize
     end
 
+    # Return the pluralized version of resource name
+    #
+    # @return [String]
     def plural
       name.pluralize
     end

data/lib/azeroth/options.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Azeroth
+  class Options < ::OpenStruct
+    DEFAULT_OPTIONS = {
+    }.freeze
+
+    def initialize(options)
+      super(DEFAULT_OPTIONS.merge(options))
+    end
+  end
+end

data/lib/azeroth/resource_builder.rb

@@ -1,17 +1,75 @@
+# frozen_string_literal: true
+
 module Azeroth
+  # @api private
+  # @author Darthjee
+  #
+  # Builder responsible for for building the resource methods
+  #
+  # The builder adds 2 methods, one for listing all
+  # entries of a resource, and one for fetching an specific
+  # entry
   class ResourceBuilder
-    attr_reader :model, :builder
-
-    delegate :add_method, to: :builder
-
+    # @param model [Model] Resource model interface
+    # @param builder [Sinclair] method builder
     def initialize(model, builder)
       @model = model
       @builder = builder
     end
 
+    # Append methods to be built to the builder
+    #
+    # Methods are the listing of all entities and fetching
+    # of an specific entity
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
     def append
-      add_method(model.plural, "@#{model.plural} ||= #{model.klass}.all")
-      add_method(model.name,   "@#{model.name} ||= #{model.plural}.find(#{model.name}_id)")
+      add_method(plural, "@#{plural} ||= #{model.klass}.all")
+      add_method(name, "@#{name} ||= #{plural}.find(#{name}_id)")
     end
+
+    private
+
+    attr_reader :model, :builder
+    # @method model
+    # @api private
+    # @private
+    #
+    # Returns the model class of the resource
+    #
+    # @return [Model]
+
+    # @method builder
+    # @api private
+    # @private
+    #
+    # Returns a method builder
+    #
+    # @return [Sinclair]
+    #
+    # @see https://www.rubydoc.info/gems/sinclair Sinclair
+
+    delegate :add_method, to: :builder
+    # @api private
+    # @method add_method
+    #
+    # Add a method to be build on the controller
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
+
+    delegate :name, :plural, to: :model
+    # @method name
+    # @api private
+    #
+    # Returns the name of the resource represented by the model
+    #
+    # @return [String]
+
+    # @method plural
+    # @api private
+    #
+    # Return the pluralized version of resource name
+    #
+    # @return [String]
   end
 end

data/lib/azeroth/resource_route_builder.rb

@@ -1,21 +1,124 @@
+# frozen_string_literal: true
+
 module Azeroth
+  # @api private
+  # @author Darthjee
+  #
+  # Builder for resources for each route
+  #
+  # For each route method in the controller, there
+  # should be a resource, index should have  listing
+  # of all entries, update should update and return
+  # updated resource, new should return an empty object,
+  # etc..
   class ResourceRouteBuilder
-    attr_reader :model, :builder
-
-    delegate :add_method, to: :builder
-
+    # @param (see ResourceBuilder#initialize)
     def initialize(model, builder)
       @model = model
       @builder = builder
     end
 
+    # Append methods to be build to the builder
+    #
+    # The methods to be added are resources related
+    # to the routes:
+    # - new
+    # - show
+    # - create
+    # - update
+    # - edit
+    # - index
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
     def append
-      add_method(:new_resource,    "@new_resource ||= #{model.klass}.new")
-      add_method(:create_resource, "@create_resource ||= #{model.klass}.create(#{model.name}_params)")
-      add_method(:update_resource, "@update_resource ||= #{model.name}.tap { |v| v.update(#{model.name}_params) }")
+      add_new_reource
+      add_create_resource
+      add_update_resource
+
       add_method(:index_resource,  model.plural)
-      add_method(:edit_resource,   model.name)
-      add_method(:show_resource,   model.name)
+      add_method(:edit_resource,   name)
+      add_method(:show_resource,   name)
+    end
+
+    private
+
+    attr_reader :model, :builder
+    # @method model
+    # @api private
+    # @private
+    #
+    # Returns the model class of the resource
+    #
+    # @return [Model]
+
+    # @method builder
+    # @api private
+    # @private
+    #
+    # Returns a method builder
+    #
+    # @return [Sinclair]
+    #
+    # @see https://www.rubydoc.info/gems/sinclair Sinclair
+
+    delegate :add_method, to: :builder
+    # @api private
+    # @method add_method
+    #
+    # Add a method to be build on the controller
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
+
+    delegate :name, :klass, to: :model
+    # @method name
+    # @api private
+    #
+    # Returns the name of the resource represented by the model
+    #
+    # @return [String]
+
+    # @method klass
+    # @api private
+    #
+    # Resource class (real model class)
+    #
+    # @return [Class]
+
+    # Adds the reource for new route
+    #
+    # It returns a new empty object
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
+    def add_new_reource
+      add_method(:new_resource, "@new_resource ||= #{klass}.new")
+    end
+
+    # Adds the reource for create route
+    #
+    # It creates an entry in the database from the parameters
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
+    def add_create_resource
+      add_method(
+        :create_resource,
+        "@create_resource ||= #{klass}.create(#{name}_params)"
+      )
+    end
+
+    # Adds the reource for update route
+    #
+    # It updates an entry in the database from the parameters
+    #
+    # @return [Array<Sinclair::MethodDefinition>]
+    def add_update_resource
+      add_method(
+        :update_resource,
+        <<-CODE
+          @update_resource ||= #{name}.tap do |value|
+            value.update(#{name}_params)
+          end
+        CODE
+      )
     end
   end
 end