ducalis 0.5.14 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dee09942e0904fe18f8abf7a345305cbdfd8989c
-  data.tar.gz: f93046f6e097760d0a5768dc3f2212b9d2cfe834
+  metadata.gz: c318246f914585d93588a49a31dfb31c7598b5f5
+  data.tar.gz: 8a4d1be3c918559feffab7275779250d76c60dfb
 SHA512:
-  metadata.gz: b039f3df86b92eb0ccda9d61c8eaa3ac32995d9de8cc60f9f372b5c6a50b524d7dfb37385de66d3d63dd4ae4a4d97f88950a26388a225057d533da62f98e5cf7
-  data.tar.gz: 1278017d4fafa60ff80a176e3c2d1a4fea13a76bf279c29a3879100c46a479b33a8691992e16ed96d520b4562d59d638120657a66ce540ce8498d4f3a2c137b5
+  metadata.gz: 319fb773559268eec362ae2a8f561d6f92a2f77d9d9b44825d4eb0fa70548173af97cdf266346677231ca152da5e9d416478b60a1b322845c1f576e55035b032
+  data.tar.gz: 4c81501488830a22fb562b31c32f4104f0d47d9dda9ab5102c2a0c9b149a328c30ead9a774f1368869af7cc128d8a86d3f2631be9f3783994fc993e0a2e0b732

data/Gemfile.lock

@@ -1,19 +1,18 @@
 PATH
   remote: .
   specs:
-    ducalis (0.5.14)
+    ducalis (0.6.0)
       git (~> 1.3, >= 1.3.0)
       policial (= 0.0.4)
       regexp-examples (~> 1.3, >= 1.3.2)
       rubocop (~> 0.46.0, >= 0.45.0)
-      thor (~> 0.20.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
-    ast (2.3.0)
+    ast (2.4.0)
     coderay (1.1.2)
     coffee-script (2.4.1)
       coffee-script-source
@@ -29,17 +28,17 @@ GEM
       multi_json (>= 1.3)
       rake
     execjs (2.7.0)
-    faraday (0.13.1)
+    faraday (0.14.0)
       multipart-post (>= 1.2, < 3)
     git (1.3.0)
     json (2.1.0)
     method_source (0.9.0)
-    multi_json (1.12.2)
+    multi_json (1.13.1)
     multipart-post (2.0.0)
     octokit (4.8.0)
       sawyer (~> 0.8.0, >= 0.5.3)
-    parser (2.4.0.2)
-      ast (~> 2.3)
+    parser (2.5.0.0)
+      ast (~> 2.4.0)
     policial (0.0.4)
       coffeelint (~> 1.14)
       eslintrb (~> 2.0)
@@ -49,11 +48,11 @@ GEM
     pry (0.11.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.1)
+    public_suffix (3.0.2)
     rainbow (2.2.2)
       rake
     rake (12.1.0)
-    regexp-examples (1.4.1)
+    regexp-examples (1.4.2)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -77,7 +76,6 @@ GEM
     sawyer (0.8.1)
       addressable (>= 2.3.5, < 2.6)
       faraday (~> 0.8, < 1.0)
-    thor (0.20.0)
     unicode-display_width (1.3.0)
 
 PLATFORMS

data/README.md

@@ -9,6 +9,8 @@ As __Ducalis__ isn't style checker and could sometimes be false-positive it's no
 necessary to follow all it rules, the main purpose of __Ducalis__ is help to find
 possible weak code parts.
 
+[Documentation](<https://ducalis-rb.github.io/>)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -77,7 +79,3 @@ 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/Rakefile

@@ -8,10 +8,5 @@ RuboCop::RakeTask.new do |task|
   task.options = %w(--auto-correct)
 end
 
-task :documentation do
-  require './lib/ducalis/documentation'
-  File.write('DOCUMENTATION.md', Documentation.new.call)
-end
-
 RSpec::Core::RakeTask.new(:spec)
 task default: %i(rubocop spec)

data/bin/ducalis

@@ -15,13 +15,18 @@ Env `GITHUB_TOKEN` should be available to receive PRs files."
   puts '    --all   [default] check all files in RuboCop style.'
   puts ''
 
-  Ducalis::CLI.start(ARGV)
-  RuboCop::CLI.new.run
+  Ducalis::CLI.new(ARGV).start
+  exit 0
+end
+
+if ARGV.any? { |arg| arg == '--docs' }
+  require 'ducalis/documentation'
+  File.write(ARGV[1] || 'DOCUMENTATION.md', Documentation.new.call)
   exit 0
 end
 
 if Ducalis::PassedArgs.ci_mode?
-  Ducalis::CLI.start(ARGV - %w(--ci))
+  Ducalis::CLI.new(ARGV - %w(--ci)).start
 else
   Ducalis::PassedArgs.process_args!
 

data/config/.ducalis.yml

@@ -1,6 +1,6 @@
 AllCops:
   DisabledByDefault: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: ~
   Exclude:
     - 'db/**/*'
     - 'node_modules/**/*'
@@ -20,6 +20,10 @@ Ducalis/BlackListSuffix:
     - Renderer
     - Loader
 
+Ducalis/EnforceNamespace:
+  Enabled: true
+  ServicePath: 'app/services'
+
 Ducalis/PreferableMethods:
   Enabled: true
 
@@ -29,9 +33,18 @@ Ducalis/CaseMapping:
 Ducalis/CallbacksActiverecord:
   Enabled: true
 
+Ducalis/DataAccessObjects:
+  Enabled: true
+
 Ducalis/PossibleTap:
   Enabled: false
 
+Ducalis/PublicSend:
+  Enabled: false
+
+Ducalis/FetchExpression:
+  Enabled: true
+
 Ducalis/ProtectedScopeCop:
   Enabled: true
   Exclude:
@@ -63,6 +76,9 @@ Ducalis/RestOnlyCop:
 Ducalis/KeywordDefaults:
   Enabled: true
 
+Ducalis/MultipleTimes:
+  Enabled: true
+
 Ducalis/OptionsArgument:
   Enabled: true
 
@@ -86,6 +102,9 @@ Ducalis/ControllersExcept:
 Ducalis/PrivateInstanceAssign:
   Enabled: true
 
+Ducalis/EvlisOverusing:
+  Enabled: true
+
 Ducalis/StandardMethods:
   Enabled: true
 

data/ducalis.gemspec

@@ -32,5 +32,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'policial', '0.0.4'
   spec.add_dependency 'regexp-examples', '~> 1.3', '>= 1.3.2'
   spec.add_dependency 'rubocop', '>= 0.45.0', '~> 0.46.0'
-  spec.add_dependency 'thor', '~> 0.20.0'
 end

data/lib/ducalis.rb

@@ -31,19 +31,26 @@ require 'ducalis/patched_rubocop/git_runner'
 require 'ducalis/patched_rubocop/git_turget_finder'
 require 'ducalis/patched_rubocop/rubo_cop'
 
+require 'ducalis/cops/extensions/type_resolving'
 require 'ducalis/cops/black_list_suffix'
 require 'ducalis/cops/callbacks_activerecord'
 require 'ducalis/cops/case_mapping'
 require 'ducalis/cops/controllers_except'
+require 'ducalis/cops/data_access_objects'
+require 'ducalis/cops/fetch_expression'
 require 'ducalis/cops/only_defs'
 require 'ducalis/cops/keyword_defaults'
 require 'ducalis/cops/module_like_class'
+require 'ducalis/cops/multiple_times'
+require 'ducalis/cops/evlis_overusing'
+require 'ducalis/cops/enforce_namespace'
 require 'ducalis/cops/options_argument'
 require 'ducalis/cops/params_passing'
 require 'ducalis/cops/possible_tap'
 require 'ducalis/cops/preferable_methods'
 require 'ducalis/cops/private_instance_assign'
 require 'ducalis/cops/protected_scope_cop'
+require 'ducalis/cops/public_send'
 require 'ducalis/cops/raise_without_error_class'
 require 'ducalis/cops/regex_cop'
 require 'ducalis/cops/rest_only_cop'

data/lib/ducalis/cli.rb

@@ -1,35 +1,96 @@
 # frozen_string_literal: true
 
-require 'thor'
+require 'optparse'
 
 module Ducalis
-  class CLI < Thor
+  class CLI
     ADAPTERS = {
       circle: Adapters::CircleCi,
       custom: Adapters::Custom
     }.freeze
     DEFAULT_ADAPTER = ADAPTERS.keys.last
-    default_task :start
-
-    desc '--ci', ''
-    option :adapter, required: true, default: DEFAULT_ADAPTER,
-                     desc: 'Describes how Ducalis will receive PR information'
-    option :id,   type: :numeric, desc: 'PR id, ex: 2347'
-    option :repo, type: :string,  desc: 'PR repository, ex: author/repo'
-    option :sha,  type: :string,  desc: 'Starting commit, can be skipped'
-    option :dry,  type: :boolean, default: false,
-                  desc: 'Allows user run dry mode, default: false'
+
+    def initialize(arguments)
+      @arguments = arguments
+      @options   = {}
+      @parser    = OptionParser.new
+      configure_parser!
+    end
+
     def start
-      adapter = ADAPTERS.fetch(options[:adapter].to_sym) do
-        raise "Unsupported adapter #{options[:adapter]}"
+      @parser.parse(@arguments)
+      Runner.new(adapter.new(@options)).call
+    end
+
+    private
+
+    def adapter
+      ADAPTERS.fetch(@options.fetch(:adapter, DEFAULT_ADAPTER)) do
+        raise "Unsupported adapter #{@options[:adapter]}"
+      end
+    end
+
+    def configure_parser!
+      @parser.banner = 'Usage: ducalis --ci --adapter=ADAPTER'
+      adapter_option_parsing
+      id_option_parsing
+      repo_option_parsing
+      sha_option_parsing
+      dry_option_parsing
+      help_command
+    end
+
+    def help_command
+      @parser.on_tail('--help', 'Show this message') do
+        puts @parser
+        RuboCop::CLI.new.run(@arguments)
+      end
+    end
+
+    def adapter_option_parsing
+      @parser.on(
+        '--adapter=ADAPTER',
+        'Describes how Ducalis will receive PR information. Default: custom'
+      ) do |adapter|
+        @options[:adapter] = adapter.to_sym
+      end
+    end
+
+    def id_option_parsing
+      @parser.on(
+        '--id=N',
+        'PR id, ex: 2347'
+      ) do |id|
+        @options[:id] = id
+      end
+    end
+
+    def repo_option_parsing
+      @parser.on(
+        '--repo=REPO',
+        'PR repository, ex: author/repo'
+      ) do |repo|
+        @options[:repo] = repo
+      end
+    end
+
+    def sha_option_parsing
+      @parser.on(
+        '--sha=SHA',
+        'Starting commit, can be omitted'
+      ) do |sha|
+        @options[:sha] = sha
       end
-      Runner.new(adapter.new(options)).call
     end
 
-    desc '--ci help', 'Describe available commands'
-    def help(command = nil, subcommand = false)
-      command ||= :start
-      super
+    def dry_option_parsing
+      @options[:dry] = false # default
+      @parser.on(
+        '--dry',
+        'Allows user to run dry mode, default: false'
+      ) do |_dry|
+        @options[:dry] = true
+      end
     end
   end
 end

data/lib/ducalis/commentators/console.rb

@@ -5,7 +5,7 @@ require 'logger'
 module Ducalis
   module Commentators
     class Console
-      DOCUMENTATION_PATH = 'https://github.com/ignat-zakrevsky/ducalis/blob/master/DOCUMENTATION.md'
+      DOCUMENTATION_PATH = 'https://ducalis-rb.github.io/'
 
       def initialize(config)
         @config = config

data/lib/ducalis/cops/black_list_suffix.rb

@@ -8,6 +8,9 @@ module Ducalis
       | Please, avoid using of class suffixes like `Meneger`, `Client` and so on. If it has no parts, change the name of the class to what each object is managing.
 
       | It's ok to use Manager as subclass of Person, which is there to refine a type of personal that has management behavior to it.
+    MESSAGE
+
+    DETAILS = <<-MESSAGE.gsub(/^ +\|\s/, '').strip
       | Related [article](<http://www.carlopescio.com/2011/04/your-coding-conventions-are-hurting-you.html>)
     MESSAGE
 

data/lib/ducalis/cops/callbacks_activerecord.rb

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
 require 'rubocop'
+require 'ducalis/cops/extensions/type_resolving'
 
 module Ducalis
   class CallbacksActiverecord < RuboCop::Cop::Cop
+    prepend TypeResolving
+
     OFFENSE = <<-MESSAGE.gsub(/^ +\|\s/, '').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
+    DETAILS = <<-MESSAGE.gsub(/^ +\|\s/, '').strip
+      | You can read more [here](https://medium.com/planet-arkency/a61fd75ab2d3).
+    MESSAGE
 
     METHODS_BLACK_LIST = %i(
       after_commit
@@ -36,20 +37,10 @@ module Ducalis
       before_validation
     ).freeze
 
-    def on_class(node)
-      _classdef_node, superclass, _body = *node
-      @triggered = superclass &&
-                   MODELS_CLASS_NAMES.include?(superclass.loc.expression.source)
-    end
-
     def on_send(node)
-      return unless @triggered
+      return unless in_model?
       return unless METHODS_BLACK_LIST.include?(node.method_name)
       add_offense(node, :selector, OFFENSE)
     end
-
-    private
-
-    attr_reader :triggered
   end
 end

data/lib/ducalis/cops/case_mapping.rb

@@ -13,7 +13,7 @@ module Ducalis
       | Usually `case when` statements are using for the next reasons:
 
       | I. Mapping between different values.
-      | ("A" => 1, "B" => 2, ...)
+      | `("A" => 1, "B" => 2, ...)`
 
       | This case is all about data representing. If you do not need to execute any code it's better to use data structure which represents it. This way you are separating concepts: code returns corresponding value and you have config-like data structure which describes your data.
 
@@ -25,12 +25,13 @@ module Ducalis
 
       | II. Code execution depending of parameter or type:
 
-      |   - a. (:attack => attack, :defend => defend)
-      |   - b. (Feet => value * 0.348, Meters => `value`)
+      |   - a. `(:attack => attack, :defend => defend)`
+      |   - b. `(Feet => value * 0.348, Meters => `value`)`
 
       | In this case code violates OOP and S[O]LID principle. Code shouldn't know about object type and classes should be open for extension, but closed for modification (but you can't do it with case-statements). This is a signal that you have some problems with architecture.
 
       |  a.
+
       | ```ruby
       | attack: -> { execute_attack }, defend: -> { execute_defend }
       | #{(action = '#{' + 'action' + '}') && '# or'}
@@ -38,13 +39,17 @@ module Ducalis
       | ```
 
       | b.
+
       | ```ruby
       | class Meters; def to_metters; value;         end
       | class Feet;   def to_metters; value * 0.348; end
       | ```
 
       | III. Code execution depending on some statement.
+
+      | ```ruby
       | (`a > 0` => 1, `a == 0` => 0, `a < 0` => -1)
+      | ```
 
       | This case is combination of I and II -- high code complexity and unit-tests complexity. There are variants how to solve it:
 

data/lib/ducalis/cops/controllers_except.rb

@@ -11,12 +11,6 @@ module Ducalis
     FILTERS = %i(before_filter after_filter around_filter
                  before_action after_action around_action).freeze
 
-    def on_class(node)
-      _classdef_node, superclass, _body = *node
-      return if superclass.nil?
-      @triggered = superclass.loc.expression.source =~ /Controller/
-    end
-
     def on_send(node)
       _, method_name, *args = *node
       hash_node = args.find { |subnode| subnode.type == :hash }
@@ -31,7 +25,5 @@ module Ducalis
     def decomposite_hash(args)
       args.to_a.first.children.to_a
     end
-
-    attr_reader :triggered
   end
 end