auxiliary_rails 0.2.0 → 0.3.0

data/auxiliary_rails.gemspec

@@ -18,14 +18,14 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   if spec.respond_to?(:metadata)
-    spec.metadata['homepage_uri'] = 'https://github.com/ergoserv/auxiliary_rails'
-    spec.metadata['source_code_uri'] = 'https://github.com/ergoserv/auxiliary_rails'
-    spec.metadata['changelog_uri'] = 'https://github.com/ergoserv/auxiliary_rails/blob/master/CHANGELOG.md'
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = "#{spec.homepage}/releases"
   else
     raise 'RubyGems 2.0 or newer is required'
   end
 
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
       f.match(%r{^(test|spec|features)/})
     end
@@ -38,10 +38,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rails', '>= 5.2', '< 7'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop', '0.79'
   spec.add_development_dependency 'rubocop-performance'
   spec.add_development_dependency 'rubocop-rspec'
 
+  spec.add_runtime_dependency 'dry-core'
+  spec.add_runtime_dependency 'dry-initializer'
   spec.add_runtime_dependency 'dry-initializer-rails'
   spec.add_runtime_dependency 'thor'
 end

data/bin/rubocop

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+bundle exec rubocop "$@"

data/lib/auxiliary_rails.rb

@@ -1,6 +1,8 @@
-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/form'
+require 'auxiliary_rails/application/error'
+require 'auxiliary_rails/application/query'
+require 'auxiliary_rails/railtie'
 require 'auxiliary_rails/version'
 
 module AuxiliaryRails

data/lib/auxiliary_rails/application/command.rb

@@ -0,0 +1,56 @@
+require 'active_model'
+require 'auxiliary_rails/concerns/performable'
+require 'dry-initializer-rails'
+
+module AuxiliaryRails
+  module Application
+    # @abstract
+    class Command
+      extend Dry::Initializer
+      include AuxiliaryRails::Concerns::Performable
+
+      class << self
+        # @!method param(name, options = {})
+        #   Defines param using <tt>Dry::Initializer</tt> format.
+        #
+        #   @see Dry::Initializer
+        #   @see https://dry-rb.org/gems/dry-initializer/3.0/params-and-options/
+        #
+        #   @param name [Symbol]
+        #   @param options [Hash]
+
+        # @!method option(name, options = {})
+        #   Defines option using <tt>Dry::Initializer</tt> format.
+
+        #   @see Dry::Initializer
+        #   @see https://dry-rb.org/gems/dry-initializer/3.0/params-and-options/
+        #
+        #   @param name [Symbol]
+        #   @param options [Hash]
+
+        # Initializes command with <tt>args</tt> and runs <tt>#call</tt> method.
+        #
+        # @return [self]
+        def call(*args)
+          new(*args).call
+        end
+
+        # Defines `scope` for <tt>ActiveModel::Translation</tt>
+        #
+        # @return [Symbol]
+        def i18n_scope
+          :commands
+        end
+      end
+
+      protected
+
+      # Shortcut reader for attributes defined by <tt>Dry::Initializer</tt>
+      #
+      # @return [Hash]
+      def arguments
+        self.class.dry_initializer.attributes(self)
+      end
+    end
+  end
+end

data/lib/auxiliary_rails/application/error.rb

@@ -0,0 +1,10 @@
+module AuxiliaryRails
+  module Application
+    class Error < StandardError
+      # @return [self] Creates new error object
+      def self.wrap(error)
+        new(error.message)
+      end
+    end
+  end
+end

data/lib/auxiliary_rails/application/form.rb

@@ -0,0 +1,30 @@
+require 'active_model'
+
+module AuxiliaryRails
+  module Application
+    # @abstract
+    class Form
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+      include ActiveModel::AttributeAssignment
+      include AuxiliaryRails::Concerns::Performable
+
+      class << self
+        # Defines `scope` for <tt>ActiveModel::Translation</tt>
+        #
+        # @return [Symbol]
+        def i18n_scope
+          :forms
+        end
+      end
+
+      # Indicates object persistence.
+      #
+      # In case of form as performable object that means that form
+      # was executed with success.
+      def persisted?
+        performable_status == true
+      end
+    end
+  end
+end

data/lib/auxiliary_rails/application/query.rb

@@ -0,0 +1,78 @@
+require 'dry/core/class_attributes'
+require 'dry-initializer'
+
+module AuxiliaryRails
+  module Application
+    class Query
+      extend Dry::Core::ClassAttributes
+      extend Dry::Initializer
+
+      defines :default_relation
+
+      option :relation, default: proc { nil }
+
+      def self.call(*args)
+        new(*args).call
+      end
+
+      def call
+        ensure_proper_relation_types!
+
+        perform
+
+        query
+      end
+
+      def perform
+        raise NotImplementedError
+      end
+
+      def method_missing(method_name, *args, &block)
+        super unless query.respond_to?(method_name)
+
+        query.send(method_name, *args, &block)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        query.respond_to?(method_name) || super
+      end
+
+      private
+
+      # rubocop:disable Metrics/AbcSize, Style/GuardClause
+      def ensure_proper_relation_types!
+        if self.class.default_relation.nil?
+          error!('Undefined `default_relation`')
+        end
+        if !queriable_object?(self.class.default_relation)
+          error!('Invalid class of `default_relation`')
+        end
+        if !relation.nil? && !queriable_object?(relation)
+          error!('Invalid class of `relation` option')
+        end
+      end
+      # rubocop:enable Metrics/AbcSize, Style/GuardClause
+
+      def error!(message = nil)
+        raise error_class,
+          "`#{self.class}` #{message || 'Query raised an error.'}"
+      end
+
+      def error_class
+        AuxiliaryRails::Application::Error
+      end
+
+      def queriable_object?(object)
+        object.is_a?(ActiveRecord::Relation)
+      end
+
+      def query(scoped_query = nil)
+        @query ||= (relation || self.class.default_relation)
+
+        @query = scoped_query unless scoped_query.nil?
+
+        @query
+      end
+    end
+  end
+end

data/lib/auxiliary_rails/cli.rb

@@ -6,6 +6,10 @@ module AuxiliaryRails
 
     TEMPLATES_DIR =
       File.expand_path("#{__dir__}/../../templates/")
+    REPOSITORY_URL =
+      'https://raw.githubusercontent.com/ergoserv/' \
+        'auxiliary_rails/develop/templates'
+        .freeze
 
     desc 'new APP_PATH', 'Create Rails application from template'
     long_desc <<-LONGDESC
@@ -17,20 +21,30 @@ module AuxiliaryRails
     option :database,
       default: 'postgresql',
       type: :string
-    option :template_name,
+    option :template,
       default: 'elementary',
       type: :string
+    option :develop,
+      default: false,
+      type: :boolean
     def new(app_path)
       run "rails new #{app_path} " \
-        '--skip-action-cable --skip-coffee --skip-test ' \
         "--database=#{options[:database]} " \
-        "--template=#{rails_template_path(options[:template_name])}"
+        "--template=#{rails_template_path(options[:template])}" \
+        '--skip-action-cable ' \
+        '--skip-coffee ' \
+        '--skip-test ' \
+        '--skip-webpack-install'
     end
 
     private
 
-    def rails_template_path(template_name)
-      "#{TEMPLATES_DIR}/rails/#{template_name}.rb"
+    def rails_template_path(template)
+      if options[:develop] == true
+        "#{REPOSITORY_URL}/rails/#{template}.rb"
+      else
+        "#{TEMPLATES_DIR}/rails/#{template}.rb"
+      end
     end
   end
 end

data/lib/auxiliary_rails/concerns/performable.rb

@@ -0,0 +1,141 @@
+require 'active_support/concern'
+
+module AuxiliaryRails
+  module Concerns
+    module Performable
+      extend ActiveSupport::Concern
+      include ActiveModel::Validations
+
+      class_methods do
+        def call(*args)
+          new(*args).call
+        end
+      end
+
+      def call(options = {})
+        ensure_empty_status!
+
+        if options[:validate!] == true
+          validate!
+        elsif options[:validate] != false && invalid?
+          return failure!(:validation_failed)
+        end
+
+        perform
+
+        ensure_execution!
+        self
+      end
+
+      # Describes business logic.
+      #
+      # Method <b>should always</b> return <tt>success!</tt>
+      # or <tt>failure!</tt> methods in order pro provide further
+      # correct method chaining.
+      #
+      # @abstract
+      # @return [self]
+      def perform
+        raise NotImplementedError
+      end
+
+      def failure?
+        status?(:failure)
+      end
+
+      def status?(value)
+        ensure_execution!
+
+        performable_status == value&.to_sym
+      end
+
+      def success?
+        status?(:success)
+      end
+
+      # Provides ability to execude block of the code depending on
+      # command execution status
+      #
+      # @param status [Symol] Desired command status
+      # @param &_block Code to be executed if status matches
+      # @return [self]
+      def on(status, &_block)
+        ensure_execution!
+
+        return self unless status?(status)
+
+        yield(self) if block_given?
+
+        self
+      end
+
+      # Shortcut for <tt>ActiveRecord::Base.transaction</tt>
+      def transaction(&block)
+        ActiveRecord::Base.transaction(&block) if block_given?
+      end
+
+      protected
+
+      attr_accessor :performable_status
+
+      # @raise [AuxiliaryRails::Application::Error]
+      #   Error happens if command contains any errors.
+      # @return [nil]
+      def ensure_empty_errors!
+        return if errors.empty?
+
+        error!("`#{self.class}` contains errors.")
+      end
+
+      def ensure_empty_status!
+        return if performable_status.nil?
+
+        error!("`#{self.class}` was already executed.")
+      end
+
+      def ensure_execution!
+        return if performable_status.present?
+
+        error!("`#{self.class}` was not executed yet.")
+      end
+
+      def error!(message = nil)
+        message ||= "`#{self.class}` raised error."
+        raise error_class, message
+      end
+
+      if defined?(ApplicationError)
+        def error_class
+          ApplicationError
+        end
+      else
+        def error_class
+          AuxiliaryRails::Application::Error
+        end
+      end
+
+      # Sets command's status to <tt>failure</tt>.
+      #
+      # @return [self]
+      def failure!(message = nil, options = {})
+        ensure_empty_status!
+
+        errors.add(:base, message, options) if message.present?
+
+        self.performable_status = :failure
+        self
+      end
+
+      # Sets command's status to <tt>success</tt>.
+      #
+      # @return [self]
+      def success!
+        ensure_empty_errors!
+        ensure_empty_status!
+
+        self.performable_status = :success
+        self
+      end
+    end
+  end
+end

data/lib/auxiliary_rails/version.rb

@@ -1,3 +1,3 @@
 module AuxiliaryRails
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 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_generator.rb

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