auxiliary_rails 0.1.6 → 0.3.1

data/lib/auxiliary_rails/application/query.rb

@@ -0,0 +1,71 @@
+require 'auxiliary_rails/concerns/errorable'
+require 'dry/core/class_attributes'
+require 'dry-initializer'
+
+module AuxiliaryRails
+  module Application
+    class Query
+      extend Dry::Core::ClassAttributes
+      extend Dry::Initializer
+      include AuxiliaryRails::Concerns::Errorable
+
+      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 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,29 @@ 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 '
     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/errorable.rb

@@ -0,0 +1,22 @@
+module AuxiliaryRails
+  module Concerns
+    module Errorable
+      # 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
+        def error_class
+          AuxiliaryRails::Application::Error
+        end
+      end
+    end
+  end
+end

data/lib/auxiliary_rails/concerns/performable.rb

@@ -0,0 +1,128 @@
+require 'active_support/concern'
+require 'auxiliary_rails/concerns/errorable'
+
+module AuxiliaryRails
+  module Concerns
+    module Performable
+      extend ActiveSupport::Concern
+      include ActiveModel::Validations
+      include AuxiliaryRails::Concerns::Errorable
+
+      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!
+        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
+
+      # 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.1.6'.freeze
+  VERSION = '0.3.1'.freeze
 end

data/lib/generators/auxiliary_rails/api_resource_generator.rb

@@ -37,7 +37,12 @@ module AuxiliaryRails
 
     def create_api_resource_spec_file
       template 'api_resource_spec_template.rb.erb',
-        "spec/#{api_module_path}/#{plural_file_name}_resource_spec.rb"
+        "spec/#{api_module_path}/resources/#{plural_file_name}_resource_spec.rb"
+    end
+
+    def say_instructions
+      say "Mount resource in #{api_module_name}:"
+      say "    mount #{resource_class_name}"
     end
 
     private
@@ -59,5 +64,9 @@ module AuxiliaryRails
     def entity_class_name
       "#{api_module_name}::Entities::#{class_name}Entity"
     end
+
+    def resource_class_name
+      "#{api_module_name}::Resources::#{plural_name.camelize}Resource"
+    end
   end
 end

data/lib/generators/auxiliary_rails/command_generator.rb

@@ -0,0 +1,44 @@
+require 'rails'
+
+module AuxiliaryRails
+  class CommandGenerator < ::Rails::Generators::NamedBase
+    desc 'Stubs out a new Command and spec.'
+
+    source_root File.expand_path('templates/commands', __dir__)
+
+    class_option :path,
+      type: :string,
+      default: 'app/commands',
+      desc: 'Command location'
+
+    def create_command_file
+      FileUtils.mkdir_p(command_file_path)
+      template 'command_template.rb',
+        "#{command_file_path}/#{command_file_name}.rb"
+    end
+
+    def create_command_spec_file
+      FileUtils.mkdir_p(command_spec_path)
+      template 'command_spec_template.rb',
+        "#{command_spec_path}/#{command_file_name}_spec.rb"
+    end
+
+    private
+
+    def command_class_name
+      "#{class_name.gsub(/Command$/, '')}Command"
+    end
+
+    def command_file_name
+      command_class_name.underscore
+    end
+
+    def command_file_path
+      options[:path]
+    end
+
+    def command_spec_path
+      command_file_path.gsub(%r{^app/}, 'spec/')
+    end
+  end
+end

data/lib/generators/auxiliary_rails/install_commands_generator.rb

@@ -2,11 +2,16 @@ require 'rails'
 
 module AuxiliaryRails
   class InstallCommandsGenerator < ::Rails::Generators::Base
-    source_root File.expand_path('templates', __dir__)
+    source_root File.expand_path('templates/commands', __dir__)
 
     def copy_application_command_file
       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

data/lib/generators/auxiliary_rails/templates/apis/api_entity_template.rb.erb

@@ -1,6 +1,7 @@
 module <%= api_module_name %>::Entities
   class <%= class_name %>Entity < Grape::Entity
-    expose :id
+    expose :id,
+      documentation: { type: 'Integer' }
     # TODO: define `<%= class_name %>Entity` exposes
     expose :created_at, :updated_at
   end

data/lib/generators/auxiliary_rails/templates/apis/api_resource_spec_template.rb.erb

@@ -1,11 +1,18 @@
 require 'rails_helper'
 
-RSpec.describe <%= api_module_name %>::Resources::<%= plural_name.camelize %>Resource, type: :request do
+RSpec.describe <%= resource_class_name %>, type: :request do
   describe 'GET <%= api_url_path %>' do
     subject { get '<%= api_url_path %>' }
 
-    # TODO: write some tests
-    skip
+    it 'returns a list of <%= plural_name %>' do
+      create_list(:<%= singular_name %>, 2)
+
+      subject
+
+      expect_status :ok
+      expect_json_sizes 2
+      expect_json '0', id: <%= class_name %> %>.first.id
+    end
   end
 
   describe 'POST <%= api_url_path %>' do
@@ -16,17 +23,37 @@ RSpec.describe <%= api_module_name %>::Resources::<%= plural_name.camelize %>Res
   end
 
   describe 'GET <%= api_url_path %>/:id' do
-    # TODO: write some tests
-    skip
+    subject { get "<%= api_url_path %>/#{<%= singular_name %>.id}" }
+
+    let(:<%= singular_name %>) { create(:<%= singular_name %>) }
+
+    it 'returns a <%= singular_name %> by ID' do
+      subject
+
+      expect_status :ok
+      expect_json id: <%= singular_name %>.id
+    end
   end
 
   describe 'PUT <%= api_url_path %>/:id' do
-    # TODO: write some tests
-    skip
+    subject { put "<%= api_url_path %>/#{<%= singular_name %>.id}" }
+
+    let(:<%= singular_name %>) { create(:<%= singular_name %>) }
+
+    it 'updates a <%= singular_name %> by ID' do
+      skip
+    end
   end
 
   describe 'DELETE <%= api_url_path %>/:id' do
-    # TODO: write some tests
-    skip
+    subject { delete "<%= api_url_path %>/#{<%= singular_name %>.id}" }
+
+    let!(:<%= singular_name %>) { create(:<%= singular_name %>) }
+
+    it 'deletes a <%= singular_name %> by ID' do
+      expect { subject }.to change(<%= class_name %>, :count).by -1
+      expect_status 204
+      expect(response.body).to be_blank
+    end
   end
 end