auxiliary_rails 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e39f7911e03b9a60c783fd71827050e5fd5d0191a0eaa5f42ea4983cb2dd4832
-  data.tar.gz: b896ddeafdaff3304c9c354fa021962893674bad958d99f13f52fc68aada2c80
+  metadata.gz: 10bf9425fca5d5db8bc1165679479bb68235fca8d5b98e044c8fce1b9046d719
+  data.tar.gz: 1d5dae27ee43d35db611fca2fdda64a10f55d0d3b0570c341c33ed5a86237d9e
 SHA512:
-  metadata.gz: c1310a46790732284cd2605fa4dc75fe72184ee60909c189472393da8324b5989b44482ed770c912e15f64aa934d6c962310070ed1e08d63796a151a0fd1c756
-  data.tar.gz: 827f247c9cb836cdb84acb55a272843ceb7894024f7dd9ab32dcc8e666ec30c068293440cb333ef5d0254fae1ac7489426dcc91d70b22beb79ee8a97a071997c
+  metadata.gz: d1ff270855fee39b2cadf2043bcc50e8f8714c9ff24c35b6309391b074fdec0654566a3d9cd2dbc54c401a3c9d19ee2479d13afbefa9126bf81004ceb706f383
+  data.tar.gz: ee2960e8df4235fdaad9c879c21ff2753044f2064f1b7d4b8604ff5d47105bca682ce22f1c3f9d884bedadcdfb42783f4eb725cd643ddd01f60a633489506fce

data/.rubocop.yml

@@ -1,4 +1,5 @@
-inherit_from: .rubocop_todo.yml
+inherit_from:
+  - .rubocop_todo.yml
 
 require:
   - rubocop-performance
@@ -6,7 +7,6 @@ require:
 
 AllCops:
   Exclude:
-    # - auxiliary_rails.gemspec
     - vendor/bundle/**/* # fix for running on Travis CI
 
 #################### Layout ##############################
@@ -17,9 +17,8 @@ Layout/AlignArguments:
 #################### Metrics ##############################
 
 Metrics/BlockLength:
-  Exclude:
-    - auxiliary_rails.gemspec
-    - 'spec/**/*_spec.rb'
+  ExcludedMethods:
+    - describe
 
 #################### Style ###############################
 

data/.ruby-version

@@ -1 +1 @@
-2.6.2
+2.6.3

data/CHANGELOG.md

@@ -1,19 +1,24 @@
 # AuxiliaryRails Changelog
 
+## v0.1.6
+
+* API Resource generator
+* Command Object
+
 ## v0.1.5
 
 * Fix Gemfile.lock
 
 ## v0.1.4
 
-* Rename CLI comman `create_rails_app` to `new`
-* Code style updates in auxiliary_rails.gemspec
+* Rename CLI command `create_rails_app` to `new`
+* Code style updates in `auxiliary_rails.gemspec`
 * Fix order of gems in Rails template, rename template
 
 ## v0.1.3
 
 * Upgrate `rubocop` gem and its configs
-* `rubocop-rspec` and `rubocop-performance` gem itegration
+* `rubocop-rspec` and `rubocop-performance` gem iteration
 * Added basic Rails application template
 * CLI with `create_rails_app` command
 

data/Gemfile.lock

@@ -1,17 +1,82 @@
 PATH
   remote: .
   specs:
-    auxiliary_rails (0.1.5)
+    auxiliary_rails (0.1.6)
       thor
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
     ast (2.4.0)
+    builder (3.2.3)
     coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
     diff-lcs (1.3)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.2)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
     method_source (0.9.2)
+      ast (~> 2.4.0)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.4.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
@@ -19,6 +84,33 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     psych (3.1.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
@@ -47,8 +139,21 @@ GEM
     rubocop-rspec (1.32.0)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
     thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
     unicode-display_width (1.5.0)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
 
 PLATFORMS
   ruby
@@ -57,6 +162,7 @@ DEPENDENCIES
   auxiliary_rails!
   bundler (~> 2.0)
   pry
+  rails (~> 5.2)
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop
@@ -64,4 +170,4 @@ DEPENDENCIES
   rubocop-rspec
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/README.md

@@ -46,6 +46,11 @@ rails new APP_PATH --skip-action-cable --skip-coffee --skip-test --database=post
 ### Generators
 
 ```sh
+# install everything
+rails generate auxiliary_rails:install
+
+# install one by one
+rails generate auxiliary_rails:install_commands
 rails generate auxiliary_rails:install_errors
 rails generate auxiliary_rails:install_rubocop
 rails generate auxiliary_rails:install_rubocop --no-specify-gems

data/auxiliary_rails.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rails', '~> 5.2'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'

data/lib/auxiliary_rails.rb

@@ -1,4 +1,5 @@
 require 'auxiliary_rails/abstract_error'
+require 'auxiliary_rails/abstract_command'
 require 'auxiliary_rails/railtie' if defined?(Rails)
 require 'auxiliary_rails/version'
 

data/lib/auxiliary_rails/abstract_command.rb

@@ -0,0 +1,96 @@
+require 'active_model'
+
+module AuxiliaryRails
+  class AbstractCommand
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def call
+      raise NotImplementedError
+    end
+
+    def errors
+      @errors ||= ActiveModel::Errors.new(self)
+    end
+
+    def failure?
+      status?(:failure)
+    end
+
+    def status?(value)
+      ensure_execution!
+
+      status == value&.to_sym
+    end
+
+    def success?
+      status?(:success)
+    end
+
+    def transaction(&block)
+      ActiveRecord::Base.transaction(&block) if block_given?
+    end
+
+    # Method for ActiveModel::Errors
+    def read_attribute_for_validation(attr_name)
+      if attr_name == :command
+        self
+      else
+        attribute(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/version.rb

@@ -1,3 +1,3 @@
 module AuxiliaryRails
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.6'.freeze
 end

data/lib/generators/auxiliary_rails/api_resource_generator.rb

@@ -0,0 +1,63 @@
+require 'rails'
+
+module AuxiliaryRails
+  class ApiResourceGenerator < ::Rails::Generators::NamedBase
+    desc 'Stubs out a new API resource including an empty entity and spec.'
+
+    class_option :api_module,
+      type: :string,
+      default: 'app',
+      desc: 'API module name'
+    class_option :api_version,
+      type: :numeric,
+      default: 1,
+      desc: 'API version'
+    class_option :skip_helper,
+      type: :boolean,
+      default: true,
+      desc: 'Indicates if helper generation needs to be skipped'
+    source_root File.expand_path('templates/apis', __dir__)
+
+    def create_api_resource_file
+      template 'api_resource_template.rb.erb',
+        "app/#{api_module_path}/resources/#{plural_file_name}_resource.rb"
+    end
+
+    def create_api_entity_file
+      template 'api_entity_template.rb.erb',
+        "app/#{api_module_path}/entities/#{file_name}_entity.rb"
+    end
+
+    def create_api_helper_file
+      return if options[:skip_helper]
+
+      template 'api_helper_template.rb.erb',
+        "app/#{api_module_path}/helpers/#{plural_file_name}_api_helper.rb"
+    end
+
+    def create_api_resource_spec_file
+      template 'api_resource_spec_template.rb.erb',
+        "spec/#{api_module_path}/#{plural_file_name}_resource_spec.rb"
+    end
+
+    private
+
+    def api_module_name
+      "#{options[:api_module].camelize}V#{options[:api_version]}API"
+    end
+
+    def api_module_path
+      "apis/#{options[:api_module]}_v#{options[:api_version]}_api"
+    end
+
+    def api_url_path
+      api_name = 'api'
+      api_name += "-#{options[:api_module]}" if options[:api_module] != 'app'
+      "/#{api_name}/v#{options[:api_version]}/#{plural_name}"
+    end
+
+    def entity_class_name
+      "#{api_module_name}::Entities::#{class_name}Entity"
+    end
+  end
+end

data/lib/generators/auxiliary_rails/install_commands_generator.rb

@@ -0,0 +1,12 @@
+require 'rails'
+
+module AuxiliaryRails
+  class InstallCommandsGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    def copy_application_command_file
+      copy_file 'application_command_template.rb',
+        'app/commands/application_command.rb'
+    end
+  end
+end

data/lib/generators/auxiliary_rails/install_generator.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module AuxiliaryRails
+  class InstallGenerator < ::Rails::Generators::Base
+    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/install_rubocop_generator.rb

@@ -21,6 +21,7 @@ module AuxiliaryRails
       gem_group :development, :test do
         gem 'rubocop'
         gem 'rubocop-performance'
+        gem 'rubocop-rails'
         gem 'rubocop-rspec'
       end
     end

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

@@ -0,0 +1,7 @@
+module <%= api_module_name %>::Entities
+  class <%= class_name %>Entity < Grape::Entity
+    expose :id
+    # TODO: define `<%= class_name %>Entity` exposes
+    expose :created_at, :updated_at
+  end
+end

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

@@ -0,0 +1,5 @@
+module <%= api_module_name %>::Helpers
+  module <%= plural_name.camelize %>APIHelper
+    # TODO: define methods for `<%= plural_name.camelize %>Helper`
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'rails_helper'
+
+RSpec.describe <%= api_module_name %>::Resources::<%= plural_name.camelize %>Resource, type: :request do
+  describe 'GET <%= api_url_path %>' do
+    subject { get '<%= api_url_path %>' }
+
+    # TODO: write some tests
+    skip
+  end
+
+  describe 'POST <%= api_url_path %>' do
+    subject { post '<%= api_url_path %>' }
+
+    # TODO: write some tests
+    skip
+  end
+
+  describe 'GET <%= api_url_path %>/:id' do
+    # TODO: write some tests
+    skip
+  end
+
+  describe 'PUT <%= api_url_path %>/:id' do
+    # TODO: write some tests
+    skip
+  end
+
+  describe 'DELETE <%= api_url_path %>/:id' do
+    # TODO: write some tests
+    skip
+  end
+end

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

@@ -0,0 +1,70 @@
+module <%= api_module_name %>::Resources
+  class <%= plural_name.camelize %>Resource < Grape::API
+    helpers do
+      def collection
+        # TODO: add `policy_scope`?
+        @<%= plural_name %> ||= <%= class_name %>.all
+      end
+
+      def resource
+        @<%= singular_name %> ||= <%= class_name %>.find(params[:id])
+      end
+    end
+
+    resource :<%= plural_name %> do
+      desc 'Returns resource collection'
+      get do
+        # TODO: authorize resource, :index?
+        present collection,
+          with: <%= entity_class_name %>
+      end
+
+      desc 'Creates a <%= class_name %>'
+      params do
+        requires :<%= singular_name %>, type: Hash do
+          # TODO: define resource params or remove `params` block
+        end
+      end
+      post do
+        @<%= singular_name %> = <%= class_name %>.new(declared(params)[:<%= singular_name %>])
+        # TODO: authorize resource, :create?
+        resource.save!
+        present resource,
+          with: <%= entity_class_name %>
+      end
+
+      params do
+        requires :id, type: Integer, desc: '<%= class_name %> ID'
+      end
+      route_param :id do
+        desc 'Returns a <%= class_name %>'
+        get do
+          # TODO: authorize resource, :show?
+          present resource,
+            with: <%= entity_class_name %>
+        end
+
+        desc 'Updates a <%= class_name %>'
+        params do
+          requires :<%= singular_name %>, type: Hash do
+            # TODO: define resource params or remove `params` block
+          end
+        end
+        put do
+          resource.assign_attributes(declared(params)[:<%= singular_name %>])
+          # TODO: authorize resource, :update?
+          resource.save!
+          present resource,
+            with: <%= entity_class_name %>
+        end
+
+        desc 'Deletes a <%= class_name %>'
+        delete do
+          # TODO: authorize resource, :destroy?
+          resource.destroy!
+          body false
+        end
+      end
+    end
+  end
+end

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

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

data/lib/generators/auxiliary_rails/templates/rubocop/rubocop_auxiliary_rails_template.yml

@@ -1,12 +1,13 @@
 # AuxiliaryRails RuboCop Config
 # Homepage: https://github.com/ergoserv/auxiliary_rails
-# Version: 5
+# Version: 7
 
 AllCops:
   Exclude:
     - 'bin/*'
     - 'db/schema.rb'
     - 'db/migrate/*'
+    - 'node_modules/**/*'
     - 'vendor/**/*'
 
 #################### Layout ###############################
@@ -42,3 +43,9 @@ Style/IfUnlessModifier:
 
 Style/NegatedIf:
   EnforcedStyle: postfix
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit

data/lib/generators/auxiliary_rails/templates/rubocop/rubocop_template.yml

@@ -1,6 +1,7 @@
+inherit_from:
+  - .rubocop_auxiliary_rails.yml
+
 require:
   - rubocop-performance
+  - rubocop-rails
   - rubocop-rspec
-
-inherit_from:
-  - .rubocop_auxiliary_rails.yml

data/templates/rails/elementary.rb

@@ -11,9 +11,12 @@ gem 'auxiliary_rails',
 gem_group :development, :test do
   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'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auxiliary_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Dmitry Babenko
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-12 00:00:00.000000000 Z
+date: 2019-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,6 +39,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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -153,13 +167,22 @@ files:
 - bin/console
 - bin/setup
 - lib/auxiliary_rails.rb
+- lib/auxiliary_rails/abstract_command.rb
 - lib/auxiliary_rails/abstract_error.rb
 - lib/auxiliary_rails/cli.rb
 - lib/auxiliary_rails/railtie.rb
 - lib/auxiliary_rails/version.rb
 - lib/auxiliary_rails/view_helpers.rb
+- lib/generators/auxiliary_rails/api_resource_generator.rb
+- lib/generators/auxiliary_rails/install_commands_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/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
+- lib/generators/auxiliary_rails/templates/apis/api_resource_template.rb.erb
+- lib/generators/auxiliary_rails/templates/application_command_template.rb
 - lib/generators/auxiliary_rails/templates/application_error_template.rb
 - lib/generators/auxiliary_rails/templates/rubocop/rubocop_auxiliary_rails_template.yml
 - lib/generators/auxiliary_rails/templates/rubocop/rubocop_template.yml