ducalis 0.5.5 → 0.5.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ducalis (0.5.5)
+    ducalis (0.5.6)
       git (~> 1.3, >= 1.3.0)
       policial (= 0.0.4)
       regexp-examples (~> 1.3, >= 1.3.2)
@@ -38,8 +38,8 @@ GEM
     multipart-post (2.0.0)
     octokit (4.7.0)
       sawyer (~> 0.8.0, >= 0.5.3)
-    parser (2.4.0.0)
-      ast (~> 2.2)
+    parser (2.4.0.2)
+      ast (~> 2.3)
     policial (0.0.4)
       coffeelint (~> 1.14)
       eslintrb (~> 2.0)
@@ -49,11 +49,11 @@ GEM
     pry (0.11.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.0)
+    public_suffix (3.0.1)
     rainbow (2.2.2)
       rake
     rake (12.1.0)
-    regexp-examples (1.4.0)
+    regexp-examples (1.4.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/ducalis.svg)](https://badge.fury.io/rb/ducalis)
 [![Build Status](https://travis-ci.org/ignat-z/ducalis.svg?branch=master)](https://travis-ci.org/ignat-z/ducalis)
-[![Code Climate](https://codeclimate.com/github/ignat-z/ducalis/badges/gpa.svg)](https://codeclimate.com/github/ignat-z/ducalis)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d03d4e567e8728d2c58b/maintainability)](https://codeclimate.com/github/ignat-z/ducalis/maintainability)
 
 __Ducalis__ is RuboCop-based static code analyzer for enterprise Rails applications.
 As __Ducalis__ isn't style checker and could sometimes be false-positive it's not
@@ -58,3 +58,15 @@ rack application. All related files are located in the `client/` directory.
 In CLI modes you can provide yours `.ducalis.yml` file based on
 [default](https://github.com/ignat-z/ducalis/blob/master/config/.ducalis.yml) by
 `-c` flag or simply putting it in your project directory.
+
+## Contribution
+
+To pass your code through the all checks you simply need to run:
+
+```
+bundle exec rake
+```
+
+Please, do not edit
+[DOCUMENTATION.md](<https://github.com/ignat-z/ducalis/blob/master/DOCUMENTATION.md>),
+this file is generating by `bundle exec rake documentation` command.

data/lib/ducalis/cops/callbacks_activerecord.rb

@@ -4,11 +4,18 @@ require 'rubocop'
 
 module Ducalis
   class CallbacksActiverecord < RuboCop::Cop::Cop
-    OFFENSE = "Please, avoid using of callbacks for models. It's better to "\
-              'keep models small ("dumb") and instead use "builder" classes'\
-              '/services: to construct new objects. You can read more [here]'\
-              '(https://medium.com/planet-arkency/a61fd75ab2d3).'
-    MODELS_CLASS_NAMES = ['ApplicationRecord', 'ActiveRecord::Base'].freeze
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Please, avoid using of callbacks for models. It's better to
+      | keep models small ("dumb") and instead use "builder" classes
+      | / services: to construct new objects. You can read more
+      | [here](https://medium.com/planet-arkency/a61fd75ab2d3).
+    MESSAGE
+
+    MODELS_CLASS_NAMES = [
+      'ApplicationRecord',
+      'ActiveRecord::Base'
+    ].freeze
+
     METHODS_BLACK_LIST = %i(
       after_commit
       after_create

data/lib/ducalis/cops/case_mapping.rb

@@ -4,14 +4,15 @@ require 'rubocop'
 
 module Ducalis
   class CaseMapping < RuboCop::Cop::Cop
-    OFFENSE = %(
-Try to avoid `case when` statements. You can replace it with a sequence of
-`if... elsif... elsif... else`. For cases where you need to choose from a
-large number of possibilities, you can create a dictionary mapping case values
-to functions to call by `call`. It's nice to have prefix for the method
-names, i.e.: `visit_`.
-
-<details>
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Try to avoid `case when` statements. You can replace it with a sequence
+      | of `if... elsif... elsif... else`. For cases where you need to choose
+      | from a large number of possibilities, you can create a dictionary
+      | mapping case values to functions to call by `call`. It's nice to have
+      | prefix for the method names, i.e.: `visit_`.
+    MESSAGE
+
+    DETAILS = %(
 Usually `case when` statements are using for the next reasons:
 
 I. Mapping between different values.

data/lib/ducalis/cops/controllers_except.rb

@@ -3,14 +3,14 @@
 require 'rubocop'
 
 module Ducalis
-  class ControllersExcept < ::RuboCop::Cop::Cop
-    include RuboCop::Cop::DefNode
+  class ControllersExcept < RuboCop::Cop::Cop
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Prefer to use `:only` over `:except` in controllers because it's more
+      | explicit and will be easier to maintain for new developers.
+    MESSAGE
+
     FILTERS = %i(before_filter after_filter around_filter
                  before_action after_action around_action).freeze
-    OFFENSE = %(
-Prefer to use `:only` over `:except` in controllers because it's more explicit \
-and will be easier to maintain for new developers.
-    ).strip
 
     def on_class(node)
       _classdef_node, superclass, _body = *node

data/lib/ducalis/cops/keyword_defaults.rb

@@ -4,11 +4,10 @@ require 'rubocop'
 
 module Ducalis
   class KeywordDefaults < RuboCop::Cop::Cop
-    include RuboCop::Cop::DefNode
-    OFFENSE = %(
-Prefer to use keyword arguments for defaults. \
-It increases readability and reduces ambiguities.
-    ).strip
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Prefer to use keyword arguments for defaults. It increases readability
+      | and reduces ambiguities.
+    MESSAGE
 
     def on_def(node)
       args = node.type == :defs ? node.to_a[2] : node.to_a[1]

data/lib/ducalis/cops/module_like_class.rb

@@ -5,11 +5,10 @@ require 'rubocop'
 module Ducalis
   class ModuleLikeClass < RuboCop::Cop::Cop
     include RuboCop::Cop::DefNode
-
-    OFFENSE = %(
-Seems like it will be better to define initialize and pass %<args>s there \
-instead of each method.
-    ).strip
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Seems like it will be better to define initialize and pass %<args>s
+      | there instead of each method.
+    MESSAGE
 
     def on_class(node)
       _name, inheritance, body = *node

data/lib/ducalis/cops/params_passing.rb

@@ -4,12 +4,12 @@ require 'rubocop'
 
 module Ducalis
   class ParamsPassing < RuboCop::Cop::Cop
-    include RuboCop::Cop::DefNode
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | It's better to pass already preprocessed params hash to services. Or
+      | you can use `arcane` gem.
+    MESSAGE
+
     PARAMS_CALL = s(:send, nil, :params)
-    OFFENSE = %(
-It's better to pass already preprocessed params hash to services. Or you can use
-`arcane` gem
-    ).strip
 
     def on_send(node)
       _who, _what, *args = *node

data/lib/ducalis/cops/possible_tap.rb

@@ -4,20 +4,19 @@ require 'rubocop'
 
 module Ducalis
   class PossibleTap < RuboCop::Cop::Cop
-    include RuboCop::Cop::DefNode
-
-    OFFENSE = %(
-Consider of using `.tap`, default ruby \
-[method](<https://apidock.com/ruby/Object/tap>) which allows to replace \
-intermediate variables with block, by this you are limiting scope pollution \
-and make scope more clear. \
-[Related article](<http://seejohncode.com/2012/01/02/ruby-tap-that/>).
-    ).strip
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Consider of using `.tap`, default ruby
+      | [method](<https://apidock.com/ruby/Object/tap>)
+      | which allows to replace intermediate variables with block, by this you
+      | are limiting scope pollution and make scope more clear.
+      | [Related article](<http://seejohncode.com/2012/01/02/ruby-tap-that/>).
+    MESSAGE
 
     PAIRS = {
       lvar: :lvasgn,
       ivar: :ivasgn
     }.freeze
+
     ASSIGNS = PAIRS.keys
 
     def on_def(node)
@@ -49,11 +48,13 @@ and make scope more clear. \
 
     def return_var_call?(body)
       return unless body.children.last.respond_to?(:children)
-      subnodes(body.children.last).find { |node| ASSIGNS.include?(node.type) }
+      subnodes(body.children.last.to_a.first).find do |node|
+        ASSIGNS.include?(node.type)
+      end
     end
 
     def subnodes(node)
-      node.children.select { |child| child.respond_to?(:type) }
+      ([node] + node.children).select { |child| child.respond_to?(:type) }
     end
   end
 end

data/lib/ducalis/cops/preferable_methods.rb

@@ -3,21 +3,27 @@ require 'rubocop'
 
 module Ducalis
   class PreferableMethods < RuboCop::Cop::Cop
-    OFFENSE = %(
-Prefer to use %<alternative>s method instead of %<original>s because of
-%<reason>s.
-    ).strip
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Prefer to use %<alternative>s method instead of %<original>s because of
+      | %<reason>s.
+    MESSAGE
+
     ALWAYS_TRUE = ->(_who, _what, _args) { true }
+
     DELETE_CHECK = lambda do |who, _what, args|
-      !%i(sym str).include?(args.first&.type) &&
+      !%i(sym str).include?(args.first && args.first.type) &&
         args.count <= 1 && who.to_s !~ /file/
     end
+
     DESCRIPTION = {
       # Method => [Alternative, Reason, Callable condition]
       delete_all: [:destroy_all, 'it is not invoking callbacks', ALWAYS_TRUE],
       delete: [:destroy, 'it is not invoking callbacks', DELETE_CHECK]
     }.freeze
 
+    DETAILS = "Dangerous methods are:
+#{DESCRIPTION.keys.map { |name| "`#{name}`" }.join(', ')}."
+
     def on_send(node)
       who, what, *args = *node
       return unless DESCRIPTION.keys.include?(what)

data/lib/ducalis/cops/private_instance_assign.rb

@@ -5,15 +5,22 @@ require 'rubocop'
 module Ducalis
   class PrivateInstanceAssign < RuboCop::Cop::Cop
     include RuboCop::Cop::DefNode
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Don't use filters for setting instance variables, use them only for
+      | changing application flow, such as redirecting if a user is not
+      | authenticated. Controller instance variables are forming contract
+      | between controller and view. Keeping instance variables defined in one
+      | place makes it easier to: reason, refactor and remove old views, test
+      | controllers and views, extract actions to new controllers, etc.
+    MESSAGE
 
-    OFFENSE = %(
-Please, don't assign instance variables in controller's private methods. It's \
-make hard to understand what variables are available in views.
-).strip
     ADD_OFFENSE = %(
 If you want to memoize variable, please, add underscore to the variable name \
 start: `@_name`.
 ).strip
+
+    DETAILS = ADD_OFFENSE
+
     def on_class(node)
       _classdef_node, superclass, _body = *node
       return if superclass.nil?

data/lib/ducalis/cops/protected_scope_cop.rb

@@ -4,17 +4,17 @@ require 'rubocop'
 
 module Ducalis
   class ProtectedScopeCop < RuboCop::Cop::Cop
-    OFFENSE = %{
-Seems like you are using `find` on non-protected scope. Potentially it could
-lead to unauthorized access. It's better to call `find` on authorized resources
-scopes. Example:
-
-```ruby
-current_group.employees.find(params[:id])
-# better then
-Employee.find(params[:id])
-```
-    }.strip
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Seems like you are using `find` on non-protected scope. Potentially it
+      | could lead to unauthorized access. It's better to call `find` on
+      | authorized resources scopes. Example:
+      |
+      | ```ruby
+      | current_group.employees.find(params[:id])
+      | # better then
+      | Employee.find(params[:id])
+      | ```
+    MESSAGE
 
     def on_send(node)
       _, method_name, *args = *node

data/lib/ducalis/cops/raise_withour_error_class.rb

@@ -4,11 +4,10 @@ require 'rubocop'
 
 module Ducalis
   class RaiseWithourErrorClass < RuboCop::Cop::Cop
-    include RuboCop::Cop::DefNode
-    OFFENSE = %(
-It's better to add exception class as raise argument. It will make easier to \
-catch and process it later.
-    ).strip
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | It's better to add exception class as raise argument. It will make
+      | easier to catch and process it later.
+    MESSAGE
 
     def on_send(node)
       _who, what, *args = *node

data/lib/ducalis/cops/regex_cop.rb

@@ -5,15 +5,17 @@ require 'regexp-examples'
 
 module Ducalis
   class RegexCop < RuboCop::Cop::Cop
-    OFFENSE = %(
-It's better to move regex to constants with example instead of direct using it.
-It will allow you to reuse this regex and provide instructions for others.
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | It's better to move regex to constants with example instead of direct
+      | using it. It will allow you to reuse this regex and provide instructions
+      | for others.
+      |
+      |```ruby
+      |CONST_NAME = %<constant>s # "%<example>s"
+      |%<fixed_string>s
+      |```
+    MESSAGE
 
-```ruby
-CONST_NAME = %<constant>s # "%<example>s"
-%<fixed_string>s
-```
-    ).strip
     SELF_DESCRIPTIVE = %w(
       /[[:alnum:]]/
       /[[:alpha:]]/
@@ -31,6 +33,9 @@ CONST_NAME = %<constant>s # "%<example>s"
       /[[:ascii:]]/
     ).freeze
 
+    DETAILS = "Available regexes are:
+      #{SELF_DESCRIPTIVE.map { |name| "`#{name}`" }.join(', ')}"
+
     def on_regexp(node)
       return if node.parent.type == :casgn
       return if SELF_DESCRIPTIVE.include?(node.source)

data/lib/ducalis/cops/rest_only_cop.rb

@@ -5,11 +5,12 @@ require 'rubocop'
 module Ducalis
   class RestOnlyCop < RuboCop::Cop::Cop
     include RuboCop::Cop::DefNode
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | It's better for controllers to stay adherent to REST:
+      | http://jeromedalbert.com/how-dhh-organizes-his-rails-controllers/
+    MESSAGE
+
     WHITELIST = %i(index show new edit create update destroy).freeze
-    OFFENSE = %(
-It's better for controllers to stay adherent to REST:
-http://jeromedalbert.com/how-dhh-organizes-his-rails-controllers/
-    ).strip
 
     def on_class(node)
       _classdef_node, superclass, _body = *node

data/lib/ducalis/cops/rubocop_disable.rb

@@ -4,10 +4,11 @@ require 'rubocop'
 
 module Ducalis
   class RubocopDisable < RuboCop::Cop::Cop
-    OFFENSE = %(
-Please, do not suppress RuboCop metrics, may be you can introduce some \
-refactoring or another concept.
-    )
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Please, do not suppress RuboCop metrics, may be you can introduce some
+      | refactoring or another concept.
+    MESSAGE
+
     def investigate(processed_source)
       return unless processed_source.ast
       processed_source.comments.each do |comment_node|

data/lib/ducalis/cops/strings_in_activerecords.rb

@@ -4,12 +4,13 @@ require 'rubocop'
 require_relative './callbacks_activerecord'
 
 module Ducalis
-  class StringsInActiverecords < ::RuboCop::Cop::Cop
-    OFFENSE = %(
-Please, do not use strings as arguments for %<method_name>s argument.
-It's hard to test, grep sources, code highlighting and so on.
-Consider using of symbols or lambdas for complex expressions.
-    ).strip
+  class StringsInActiverecords < RuboCop::Cop::Cop
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Please, do not use strings as arguments for %<method_name>s argument.
+      | It's hard to test, grep sources, code highlighting and so on.
+      | Consider using of symbols or lambdas for complex expressions.
+    MESSAGE
+
     VALIDATEBLE_METHODS =
       ::Ducalis::CallbacksActiverecord::METHODS_BLACK_LIST + %i(
         validates

data/lib/ducalis/cops/uncommented_gem.rb

@@ -3,11 +3,12 @@
 require 'rubocop'
 
 module Ducalis
-  class UncommentedGem < ::RuboCop::Cop::Cop
-    OFFENSE = %(
-Please, add comment why are you including non-realized gem version for %<gem>s.
-It will increase [bus-factor](<https://en.wikipedia.org/wiki/Bus_factor>).
-    ).strip
+  class UncommentedGem < RuboCop::Cop::Cop
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | Please, add comment why are you including non-realized gem version for
+      | %<gem>s. It will increase
+      | [bus-factor](<https://en.wikipedia.org/wiki/Bus_factor>).
+    MESSAGE
 
     def investigate(processed_source)
       return unless processed_source.ast