auxiliary_rails 0.2.0 → 0.4.0

data/lib/auxiliary_rails.rb

@@ -1,6 +1,10 @@
-require 'auxiliary_rails/abstract_error'
-require 'auxiliary_rails/abstract_command'
-require 'auxiliary_rails/railtie' if defined?(Rails)
+require 'auxiliary_rails/application/command'
+require 'auxiliary_rails/application/error'
+require 'auxiliary_rails/application/form'
+require 'auxiliary_rails/application/service'
+require 'auxiliary_rails/application/query'
+
+require 'auxiliary_rails/railtie'
 require 'auxiliary_rails/version'
 
 module AuxiliaryRails

data/lib/generators/auxiliary_rails/command_generator.rb

@@ -38,7 +38,7 @@ module AuxiliaryRails
     end
 
     def command_spec_path
-      command_file_path.gsub(/^app\//, 'spec/')
+      command_file_path.gsub(%r{^app/}, 'spec/')
     end
   end
 end

data/lib/generators/auxiliary_rails/install_commands_generator.rb

@@ -8,5 +8,10 @@ module AuxiliaryRails
       copy_file 'application_command_template.rb',
         'app/commands/application_command.rb'
     end
+
+    def copy_locale_command_file
+      copy_file 'commands.en_template.yml',
+        'config/locales/commands.en.yml'
+    end
   end
 end

data/lib/generators/auxiliary_rails/install_errors_controller_generator.rb

@@ -0,0 +1,31 @@
+require 'rails'
+
+module AuxiliaryRails
+  class InstallErrorsControllerGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('templates/errors_controller', __dir__)
+
+    VIEW_TEMPLATES = %w[show not_found unacceptable].freeze
+
+    def copy_controller_file
+      copy_file 'errors_controller_template.rb',
+        'app/controllers/errors_controller.rb'
+    end
+
+    def copy_view_files
+      VIEW_TEMPLATES.each do |tempate_name|
+        copy_file "#{tempate_name}_template.html.erb",
+          "app/views/errors/#{tempate_name}.html.erb"
+      end
+    end
+
+    def add_route
+      route "match '/404', to: 'errors#not_found', via: :all"
+      route "match '/422', to: 'errors#unacceptable', via: :all"
+      route "match '/500', to: 'errors#show', via: :all"
+    end
+
+    def add_exceptions_app_config
+      application 'config.exceptions_app = routes'
+    end
+  end
+end

data/lib/generators/auxiliary_rails/install_generator.rb

@@ -5,7 +5,7 @@ module AuxiliaryRails
     def install
       generate 'auxiliary_rails:install_commands'
       generate 'auxiliary_rails:install_errors'
-      generate 'auxiliary_rails:install_rubocop --no-specify-gems'
+      generate 'auxiliary_rails:install_errors_controller'
     end
   end
 end

data/lib/generators/auxiliary_rails/service_generator.rb

@@ -0,0 +1,48 @@
+require 'rails'
+
+module AuxiliaryRails
+  class ServiceGenerator < ::Rails::Generators::NamedBase
+    desc 'Stubs out a new Service and spec.'
+
+    source_root File.expand_path('templates/services', __dir__)
+
+    class_option :path,
+      type: :string,
+      default: 'app/services',
+      desc: 'Service location'
+
+    def create_service_dir
+      FileUtils.mkdir_p("#{service_file_path}/#{service_file_name}")
+    end
+
+    def create_service_file
+      FileUtils.mkdir_p(service_file_path)
+      template 'service_template.rb',
+        "#{service_file_path}/#{service_file_name}.rb"
+    end
+
+    def create_service_spec_file
+      FileUtils.mkdir_p(service_spec_path)
+      template 'service_spec_template.rb',
+        "#{service_spec_path}/#{service_file_name}_spec.rb"
+    end
+
+    private
+
+    def service_module_name
+      "#{class_name.gsub(/Service$/, '')}Service"
+    end
+
+    def service_file_name
+      service_module_name.underscore
+    end
+
+    def service_file_path
+      options[:path]
+    end
+
+    def service_spec_path
+      service_file_path.gsub(%r{^app/}, 'spec/')
+    end
+  end
+end

data/lib/generators/auxiliary_rails/templates/application_error_template.rb

@@ -1,2 +1,2 @@
-class ApplicationError < AuxiliaryRails::AbstractError
+class ApplicationError < AuxiliaryRails::Application::Error
 end

data/lib/generators/auxiliary_rails/templates/commands/application_command_template.rb

@@ -1,2 +1,2 @@
-class ApplicationCommand < AuxiliaryRails::AbstractCommand
+class ApplicationCommand < AuxiliaryRails::Application::Command
 end

data/lib/generators/auxiliary_rails/templates/commands/command_spec_template.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
 
-describe <%= command_class_name %> do
+RSpec.describe <%= command_class_name %> do
   describe '#call' do
     it 'succeeds' do
       # TODO: implement spec for command

data/lib/generators/auxiliary_rails/templates/commands/command_template.rb

@@ -1,6 +1,6 @@
 class <%= command_class_name %> < ApplicationCommand
-  def call
-    # TODO: implement <%= command_class_name %>.call method
+  def perform
+    # TODO: implement <%= command_class_name %>.perform method
     success!
   end
 end

data/lib/generators/auxiliary_rails/templates/commands/commands.en_template.yml

@@ -0,0 +1,5 @@
+en:
+  commands:
+    errors:
+      messages:
+        validation_failed: validation failed

data/lib/generators/auxiliary_rails/templates/errors_controller/errors_controller_template.rb

@@ -0,0 +1,15 @@
+class ErrorsController < ApplicationController
+  DEFAULT_ERROR_STATUS = 500
+
+  def show
+    render status: params[:status] || DEFAULT_ERROR_STATUS
+  end
+
+  def not_found
+    render status: :not_found
+  end
+
+  def unacceptable
+    render status: :unprocessable_entity
+  end
+end

data/lib/generators/auxiliary_rails/templates/errors_controller/not_found_template.html.erb

@@ -0,0 +1,2 @@
+<h1>The page you were looking for doesn't exist.</h1>
+<p>You may have mistyped the address or the page may have moved.</p>

data/lib/generators/auxiliary_rails/templates/errors_controller/show_template.html.erb

@@ -0,0 +1 @@
+<h1>We're sorry, but something went wrong.</h1>

data/lib/generators/auxiliary_rails/templates/errors_controller/unacceptable_template.html.erb

@@ -0,0 +1,2 @@
+<h1>The change you wanted was rejected.</h1>
+<p>Maybe you tried to change something you didn't have access to.</p>

data/lib/generators/auxiliary_rails/templates/services/service_spec_template.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe <%= service_module_name %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/auxiliary_rails/templates/services/service_template.rb

@@ -0,0 +1,10 @@
+module <%= service_module_name %>
+  extend AuxiliaryRails::Application::Service
+
+  module_function
+
+  CONFIG = {
+    key: 'value'
+  }.freeze
+
+end

data/templates/rails/elementary.rb

@@ -3,22 +3,43 @@ gsub_file 'Gemfile', /^\s*#.*$\n/, ''
 gsub_file 'Gemfile', /^.*coffee.*$\n/, ''
 gsub_file 'Gemfile', /^.*jbuilder.*$\n/, ''
 gsub_file 'Gemfile', /^.*tzinfo-data.*$\n/, ''
+gsub_file 'Gemfile', /^group :development, :test do\n.*byebug.*\nend\n\n/, ''
 
-gem 'auxiliary_rails',
-  git: 'https://github.com/ergoserv/auxiliary_rails',
-  branch: 'develop'
+gsub_file '.gitignore', /^\s*#.*$\n/, ''
+gsub_file 'config/routes.rb', /^\s*#.*$\n/, ''
+
+gsub_file 'config/database.yml', /^\s*#.*$\n/, ''
+gsub_file 'config/database.yml', /^\s*pool.*$\n/, <<-FILE
+  host: <%= ENV['DATABASE_HOST'] %>
+  username: <%= ENV['DATABASE_USERNAME'] %>
+  pool: <%= ENV.fetch('RAILS_MAX_THREADS') { 5 } %>
+FILE
+
+# Create RuboCop files
+file '.rubocop.yml', <<~FILE
+  inherit_gem:
+    rubocop-ergoserv:
+      - config/default.yml
+FILE
+
+run 'touch .env'
+append_file '.gitignore', <<~FILE
+  .env*.local
+FILE
+
+# Gemfile additions
+gem 'auxiliary_rails'
 
 gem_group :development, :test do
+  gem 'byebug'
   gem 'dotenv-rails'
   gem 'factory_bot_rails'
   gem 'faker'
-  gem 'pry-byebug'
   gem 'pry-rails'
   gem 'rspec-rails'
-  gem 'rubocop'
-  gem 'rubocop-performance'
-  gem 'rubocop-rails'
-  gem 'rubocop-rspec'
+  gem 'rubocop-ergoserv',
+    git: 'https://github.com/ergoserv/rubocop-ergoserv',
+    require: false
 end
 
 gem_group :test do
@@ -29,6 +50,14 @@ end
 after_bundle do
   # ensure using the latest versions of gems
   run 'bundle update'
-  rails_command 'generate auxiliary_rails:install_rubocop --no-specify-gems'
-  rails_command 'generate rspec:install'
+  run 'bundle binstubs rubocop'
+
+  generate 'rspec:install'
+
+  generate 'controller', 'pages', 'home',
+    '--no-assets',
+    '--no-helper',
+    '--no-test-framework',
+    '--skip-routes'
+  route "root to: 'pages#home'"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: auxiliary_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Dmitry Babenko
 - ErgoServ
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2022-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -40,27 +40,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
-    - - "<"
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.20.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -74,21 +96,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -102,13 +124,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: dry-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -116,13 +138,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: dry-initializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -143,6 +165,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -169,12 +205,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
@@ -185,20 +224,31 @@ files:
 - auxiliary_rails.gemspec
 - bin/auxiliary_rails
 - bin/console
+- bin/rspec
+- bin/rubocop
 - bin/setup
+- bitbucket-pipelines.yml
 - lib/auxiliary_rails.rb
-- lib/auxiliary_rails/abstract_command.rb
-- lib/auxiliary_rails/abstract_error.rb
+- lib/auxiliary_rails/application/command.rb
+- lib/auxiliary_rails/application/error.rb
+- lib/auxiliary_rails/application/form.rb
+- lib/auxiliary_rails/application/query.rb
+- lib/auxiliary_rails/application/service.rb
 - lib/auxiliary_rails/cli.rb
+- lib/auxiliary_rails/concerns/callable.rb
+- lib/auxiliary_rails/concerns/errorable.rb
+- lib/auxiliary_rails/concerns/performable.rb
 - lib/auxiliary_rails/railtie.rb
 - lib/auxiliary_rails/version.rb
 - lib/auxiliary_rails/view_helpers.rb
+- lib/auxiliary_rails/view_helpers/display_helper.rb
 - lib/generators/auxiliary_rails/api_resource_generator.rb
 - lib/generators/auxiliary_rails/command_generator.rb
 - lib/generators/auxiliary_rails/install_commands_generator.rb
+- lib/generators/auxiliary_rails/install_errors_controller_generator.rb
 - lib/generators/auxiliary_rails/install_errors_generator.rb
 - lib/generators/auxiliary_rails/install_generator.rb
-- lib/generators/auxiliary_rails/install_rubocop_generator.rb
+- lib/generators/auxiliary_rails/service_generator.rb
 - lib/generators/auxiliary_rails/templates/apis/api_entity_template.rb.erb
 - lib/generators/auxiliary_rails/templates/apis/api_helper_template.rb.erb
 - lib/generators/auxiliary_rails/templates/apis/api_resource_spec_template.rb.erb
@@ -207,8 +257,13 @@ files:
 - lib/generators/auxiliary_rails/templates/commands/application_command_template.rb
 - lib/generators/auxiliary_rails/templates/commands/command_spec_template.rb
 - lib/generators/auxiliary_rails/templates/commands/command_template.rb
-- lib/generators/auxiliary_rails/templates/rubocop/rubocop_auxiliary_rails_template.yml
-- lib/generators/auxiliary_rails/templates/rubocop/rubocop_template.yml
+- lib/generators/auxiliary_rails/templates/commands/commands.en_template.yml
+- lib/generators/auxiliary_rails/templates/errors_controller/errors_controller_template.rb
+- lib/generators/auxiliary_rails/templates/errors_controller/not_found_template.html.erb
+- lib/generators/auxiliary_rails/templates/errors_controller/show_template.html.erb
+- lib/generators/auxiliary_rails/templates/errors_controller/unacceptable_template.html.erb
+- lib/generators/auxiliary_rails/templates/services/service_spec_template.rb
+- lib/generators/auxiliary_rails/templates/services/service_template.rb
 - templates/rails/elementary.rb
 homepage: https://github.com/ergoserv/auxiliary_rails
 licenses:
@@ -216,8 +271,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/ergoserv/auxiliary_rails
   source_code_uri: https://github.com/ergoserv/auxiliary_rails
-  changelog_uri: https://github.com/ergoserv/auxiliary_rails/blob/master/CHANGELOG.md
-post_install_message: 
+  changelog_uri: https://github.com/ergoserv/auxiliary_rails/releases
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,15 +280,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: AuxiliaryRails provides extra layers and utils for helping to build solid
   and clean Ruby on Rails applications

data/lib/auxiliary_rails/abstract_command.rb

@@ -1,95 +0,0 @@
-require 'dry-initializer-rails'
-require 'active_model'
-
-module AuxiliaryRails
-  class AbstractCommand
-    extend Dry::Initializer
-    include ActiveModel::Validations
-
-    def self.call(*args)
-      new(*args).call
-    end
-
-    def call
-      raise NotImplementedError
-    end
-
-    def failure?
-      status?(:failure)
-    end
-
-    def status?(value)
-      ensure_execution!
-
-      status == value&.to_sym
-    end
-
-    def success?
-      status?(:success)
-    end
-
-    # Shortcut for `ActiveRecord::Base.transaction`
-    def transaction(&block)
-      ActiveRecord::Base.transaction(&block) if block_given?
-    end
-
-    # Method for ActiveModel::Errors
-    def read_attribute_for_validation(attr_name)
-      attr_name = attr_name.to_sym
-      if attr_name == :command
-        self
-      else
-        self.class.dry_initializer.attributes(self)[attr_name]
-      end
-    end
-
-    # Method for ActiveModel::Translation
-    def self.i18n_scope
-      :commands
-    end
-
-    protected
-
-    attr_accessor :status
-
-    def ensure_empty_errors!
-      return if errors.empty?
-
-      error!("`#{self.class}` contains errors.")
-    end
-
-    def ensure_empty_status!
-      return if status.nil?
-
-      error!("`#{self.class}` was already executed.")
-    end
-
-    def ensure_execution!
-      return if status.present?
-
-      error!("`#{self.class}` was not executed yet.")
-    end
-
-    def error!(message = nil)
-      message ||= "`#{self.class}` raised error."
-      raise ApplicationError, message
-    end
-
-    def failure!(message = nil)
-      ensure_empty_status!
-
-      errors.add(:command, :failed, message: message) unless message.nil?
-
-      self.status = :failure
-      self
-    end
-
-    def success!
-      ensure_empty_errors!
-      ensure_empty_status!
-
-      self.status = :success
-      self
-    end
-  end
-end

data/lib/auxiliary_rails/abstract_error.rb

@@ -1,7 +0,0 @@
-module AuxiliaryRails
-  class AbstractError < StandardError
-    def self.wrap(error)
-      new(error.message)
-    end
-  end
-end

data/lib/generators/auxiliary_rails/install_rubocop_generator.rb

@@ -1,29 +0,0 @@
-require 'rails'
-
-module AuxiliaryRails
-  class InstallRubocopGenerator < ::Rails::Generators::Base
-    class_option :specify_gems,
-      type: :boolean,
-      default: true,
-      desc: 'Indicates if `rubocop` gem needs to be added to Gemfile'
-    source_root File.expand_path('templates/rubocop', __dir__)
-
-    def copy_config_files
-      copy_file 'rubocop_template.yml',
-        '.rubocop.yml'
-      copy_file 'rubocop_auxiliary_rails_template.yml',
-        '.rubocop_auxiliary_rails.yml'
-    end
-
-    def specify_gems_dependency
-      return unless options[:specify_gems]
-
-      gem_group :development, :test do
-        gem 'rubocop'
-        gem 'rubocop-performance'
-        gem 'rubocop-rails'
-        gem 'rubocop-rspec'
-      end
-    end
-  end
-end