auxiliary_rails 0.3.1 → 0.4.1

data/lib/auxiliary_rails/application/error.rb

@@ -1,10 +1,50 @@
 module AuxiliaryRails
   module Application
-    class Error < StandardError
-      # @return [self] Creates new error object
-      def self.wrap(error)
-        new(error.message)
+    # @abstract
+    class Error < RuntimeError
+      attr_accessor :context
+      attr_reader :exc, :severity
+
+      class << self
+        def i18n_scope
+          "errors.#{name.underscore}"
+        end
+
+        # @return [self] Wraps exception into a new ApplicationError object
+        def wrap(exc, context: {}, severity: nil)
+          new(exc.message, context: context, exc: exc, severity: severity)
+        end
       end
+
+      def initialize(message = nil, context: {}, exc: nil, severity: nil)
+        super(message)
+
+        self.context = default_context.merge(context || {})
+        self.exc = exc
+        self.severity = severity&.to_sym || default_severity
+      end
+
+      def default_context
+        {}
+      end
+
+      def default_severity
+        :error
+      end
+
+      def friendly_message
+        I18n.t(:default,
+          scope: self.class.i18n_scope,
+          default: 'We are sorry, but something went wrong.')
+      end
+
+      def report
+        raise NotImplementedError
+      end
+
+      protected
+
+      attr_writer :exc, :severity
     end
   end
 end

data/lib/auxiliary_rails/application/form.rb

@@ -1,4 +1,5 @@
 require 'active_model'
+require 'auxiliary_rails/concerns/performable'
 
 module AuxiliaryRails
   module Application

data/lib/auxiliary_rails/application/query.rb

@@ -1,30 +1,34 @@
+require 'auxiliary_rails/concerns/callable'
 require 'auxiliary_rails/concerns/errorable'
 require 'dry/core/class_attributes'
 require 'dry-initializer'
 
 module AuxiliaryRails
   module Application
+    # @abstract
     class Query
       extend Dry::Core::ClassAttributes
       extend Dry::Initializer
+      include AuxiliaryRails::Concerns::Callable
       include AuxiliaryRails::Concerns::Errorable
 
       defines :default_relation
 
-      option :relation, default: proc { nil }
-
-      def self.call(*args)
-        new(*args).call
-      end
+      option :relation, default: proc {}
 
       def call
         ensure_proper_relation_types!
 
         perform
 
+        if !queriable_object?(query)
+          error!('Invalid class of resulted query')
+        end
+
         query
       end
 
+      # @abstract
       def perform
         raise NotImplementedError
       end
@@ -41,7 +45,7 @@ module AuxiliaryRails
 
       private
 
-      # rubocop:disable Metrics/AbcSize, Style/GuardClause
+      # rubocop:disable Style/GuardClause
       def ensure_proper_relation_types!
         if self.class.default_relation.nil?
           error!('Undefined `default_relation`')
@@ -53,7 +57,7 @@ module AuxiliaryRails
           error!('Invalid class of `relation` option')
         end
       end
-      # rubocop:enable Metrics/AbcSize, Style/GuardClause
+      # rubocop:enable Style/GuardClause
 
       def queriable_object?(object)
         object.is_a?(ActiveRecord::Relation)

data/lib/auxiliary_rails/application/service.rb

@@ -0,0 +1,42 @@
+require 'active_support/concern'
+require 'active_support/ordered_options'
+
+module AuxiliaryRails
+  module Application
+    module Service
+      def self.included(klass)
+        raise AuxiliaryRails::Error,
+          "Use `extend` insted of `include` for #{self} in #{klass}"
+      end
+
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      def config
+        return @config if @config.present?
+
+        # load from constant
+        if const_defined?(:CONFIG)
+          return @config = ActiveSupport::OrderedOptions.new.update(const_get(:CONFIG))
+        end
+
+        service_name = name.underscore
+
+        # load from service config file
+        if Rails.root.join("config/services/#{service_name}.yml").exist?
+          return @config = Rails.application.config_for("services/#{service_name}")
+        end
+
+        # load from application config
+        if Object.const_defined?(:Config) && Config.respond_to?(:const_name)
+          app_config = Object.const_get(Config.const_name)
+          if app_config.dig(:services, service_name).present?
+            return @config = app_config[:services][service_name]
+          end
+        end
+
+        raise AuxiliaryRails::Error,
+          "Unable to find suitable config for #{name} module"
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+    end
+  end
+end

data/lib/auxiliary_rails/concerns/callable.rb

@@ -0,0 +1,23 @@
+module AuxiliaryRails
+  module Concerns
+    module Callable
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # Initializes object and runs <tt>#call</tt> method.
+        #
+        # @return [self]
+        def call(*args, **kws)
+          new(*args, **kws).call
+        end
+      end
+
+      # @abstract
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/auxiliary_rails/concerns/errorable.rb

@@ -1,22 +1,22 @@
 module AuxiliaryRails
   module Concerns
     module Errorable
-      # extend ActiveSupport::Concern
+      extend ActiveSupport::Concern
 
-      def error!(message = nil)
-        message ||= "`#{self.class}` raised error."
-        raise error_class, message
-      end
-
-      if defined?(ApplicationError)
-        def error_class
-          ApplicationError
-        end
-      else
+      class_methods do
         def error_class
-          AuxiliaryRails::Application::Error
+          if Object.const_defined?(:ApplicationError)
+            ApplicationError
+          else
+            AuxiliaryRails::Application::Error
+          end
         end
       end
+
+      def error!(message = nil)
+        message ||= "`#{self.class}` raised error."
+        raise self.class.error_class, message
+      end
     end
   end
 end

data/lib/auxiliary_rails/concerns/performable.rb

@@ -1,4 +1,5 @@
 require 'active_support/concern'
+require 'auxiliary_rails/concerns/callable'
 require 'auxiliary_rails/concerns/errorable'
 
 module AuxiliaryRails
@@ -6,14 +7,9 @@ module AuxiliaryRails
     module Performable
       extend ActiveSupport::Concern
       include ActiveModel::Validations
+      include AuxiliaryRails::Concerns::Callable
       include AuxiliaryRails::Concerns::Errorable
 
-      class_methods do
-        def call(*args)
-          new(*args).call
-        end
-      end
-
       def call(options = {})
         ensure_empty_status!
 
@@ -58,24 +54,15 @@ module AuxiliaryRails
       # 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
+      # @param status [Symbol] 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?
+      def on(status, &block)
+        yield(self) if status?(status) && block
 
         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
@@ -86,19 +73,19 @@ module AuxiliaryRails
       def ensure_empty_errors!
         return if errors.empty?
 
-        error!("`#{self.class}` contains errors.")
+        error!("'#{self.class}' contains errors.")
       end
 
       def ensure_empty_status!
         return if performable_status.nil?
 
-        error!("`#{self.class}` was already executed.")
+        error!("'#{self.class}' was already executed.")
       end
 
       def ensure_execution!
         return if performable_status.present?
 
-        error!("`#{self.class}` was not executed yet.")
+        error!("'#{self.class}' was not executed yet.")
       end
 
       # Sets command's status to <tt>failure</tt>.
@@ -123,6 +110,11 @@ module AuxiliaryRails
         self.performable_status = :success
         self
       end
+
+      # Shortcut for <tt>ActiveRecord::Base.transaction</tt>
+      def transaction(&block)
+        ActiveRecord::Base.transaction(&block) if block
+      end
     end
   end
 end

data/lib/auxiliary_rails/railtie.rb

@@ -1,9 +1,10 @@
+require 'rails/railtie'
 require 'auxiliary_rails/view_helpers'
 
 module AuxiliaryRails
   class Railtie < Rails::Railtie
     initializer 'auxiliary_rails.view_helpers' do
-      ActionView::Base.send :include, ViewHelpers
+      ActionView::Base.include ViewHelpers
     end
   end
 end

data/lib/auxiliary_rails/version.rb

@@ -1,3 +1,3 @@
 module AuxiliaryRails
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.1'.freeze
 end

data/lib/auxiliary_rails/view_helpers/display_helper.rb

@@ -0,0 +1,30 @@
+module AuxiliaryRails
+  module ViewHelpers
+    module DisplayHelper
+      DISPLAY_NAME_METHODS = %i[
+        display_name
+        name
+        title
+        full_name
+        username
+        email
+      ].freeze
+
+      def display_name(resource)
+        return if resource.nil?
+
+        DISPLAY_NAME_METHODS.each do |method_name|
+          if resource.respond_to?(method_name)
+            return resource.public_send(method_name)
+          end
+        end
+
+        if resource.respond_to?(:model_name) && resource.respond_to?(:id)
+          return "#{resource.model_name.human} ##{resource.id}"
+        end
+
+        resource.to_s
+      end
+    end
+  end
+end

data/lib/auxiliary_rails/view_helpers.rb

@@ -1,5 +1,9 @@
+require 'auxiliary_rails/view_helpers/display_helper'
+
 module AuxiliaryRails
   module ViewHelpers
+    include DisplayHelper
+
     def current_controller?(*ctrl_names)
       ctrl_names.include?(params[:controller])
     end

data/lib/auxiliary_rails.rb

@@ -1,7 +1,9 @@
 require 'auxiliary_rails/application/command'
-require 'auxiliary_rails/application/form'
 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'
 

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,6 +5,7 @@ module AuxiliaryRails
     def install
       generate 'auxiliary_rails:install_commands'
       generate 'auxiliary_rails:install_errors'
+      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/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/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