ducalis 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32df7c2136c9843336bff23949966d6a557932631bc0d143a0b76111981aef71
-  data.tar.gz: 0b05601c199203849589a13c5469dccc3a6017dfbe07661c96d5f073846507d7
+  metadata.gz: 452d05fc9f37618eee52ef036528d6c931a24a012c41725c1cf2d31e85218815
+  data.tar.gz: dcb1cce57dbed25a8bb811cac2e18ff449554e60156345dd8bd0a64e0d400316
 SHA512:
-  metadata.gz: 7b2362aacc03c71f192f5fe671c8dd6270311a39f8be31b9fa712b9e67be36a114590ced0c21cd82a0d846d47a6d150592c63d7bf46ee691cd8c821220ace4e8
-  data.tar.gz: c49866725411c9e47a40967b171338651a0a8fc9ff8d1288c8d688be178e8ec80598971371fa1281dac5efbc94cfbbafc50287c2e20741714e711f39f8911530
+  metadata.gz: 522c28511c7ee1c9c8fd951b1cbfe097c8afb8d2f472b281d602ec9de6e5090d225790757ebea7a8a0e747930ca27fb06a32fd56522c86a47ee5906180cc28d0
+  data.tar.gz: 0db1d6f104b52f5dfb23f1953d1415e1578736d8743f358839ea310a7ac4a6218301a5333fc59b21ed328742a34a5ef2996951450e1849bb058cf040191fd2f3

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.1
+  TargetRubyVersion: 2.2
   UseCache: false
   Exclude:
     - 'client/vendor/bundle/**/*'

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.1
   - 2.2.9
   - 2.3.6
   - 2.4.3

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    ducalis (0.10.0)
+    ducalis (0.11.0)
       git (~> 1.3, >= 1.3.0)
-      octokit (>= 4.1.0)
+      octokit (>= 4.7.0)
       regexp-examples (~> 1.3, >= 1.3.2)
       rubocop (>= 0.45.0)
 
@@ -15,24 +15,25 @@ GEM
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
-    faraday (0.15.1)
+    faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
-    git (1.3.0)
+    git (1.4.0)
+    jaro_winkler (1.5.1)
     method_source (0.9.0)
     multipart-post (2.0.0)
-    octokit (4.6.0)
+    octokit (4.9.0)
       sawyer (~> 0.8.0, >= 0.5.3)
     parallel (1.12.1)
-    parser (2.5.0.0)
+    parser (2.5.1.2)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
+    powerpack (0.1.2)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (3.0.2)
     rainbow (3.0.0)
     rake (12.3.0)
-    regexp-examples (1.4.2)
+    regexp-examples (1.4.3)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -46,19 +47,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    rubocop (0.52.1)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
+    ruby-progressbar (1.10.0)
     sawyer (0.8.1)
       addressable (>= 2.3.5, < 2.6)
       faraday (~> 0.8, < 1.0)
     single_cov (1.0.3)
-    unicode-display_width (1.3.2)
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby

data/bin/ducalis

@@ -9,7 +9,7 @@ require 'benchmark'
 cli_arguments = Ducalis::CliArguments.new
 
 if cli_arguments.help_command?
-  puts 'You can start Ducalis in the next modes:'
+  puts 'You can start Ducalis in the following modes:'
   puts ' --branch   check files in RuboCop style against branch.'
   puts '  --index   check files in RuboCop style against index.'
   puts '    --all   [default] check all files in RuboCop style.'

data/config/.ducalis.yml

@@ -9,16 +9,17 @@ AllCops:
 Ducalis/BlackListSuffix:
   Enabled: true
   BlackList:
-    - Sorter
-    - Manager
+    - Analyzer
     - Client
-    - Object
     - Handler
-    - Processor
+    - Loader
+    - Manager
+    - Object
     - Organizer
-    - Analyzer
+    - Processor
     - Renderer
-    - Loader
+    - Service
+    - Sorter
 
 Ducalis/EnforceNamespace:
   Enabled: true
@@ -27,9 +28,16 @@ Ducalis/EnforceNamespace:
 Ducalis/PreferableMethods:
   Enabled: true
 
+Ducalis/Recursion:
+  Enabled: true
+
 Ducalis/CaseMapping:
   Enabled: true
 
+Ducalis/FacadePattern:
+  Enabled: true
+  MaxInstanceVariables: 4
+
 Ducalis/CallbacksActiverecord:
   Enabled: true
 

data/ducalis.gemspec

@@ -1,7 +1,6 @@
-
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ducalis/version'
 
@@ -29,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 
   spec.add_dependency 'git', '~> 1.3', '>= 1.3.0'
-  spec.add_dependency 'octokit', '>= 4.1.0'
+  spec.add_dependency 'octokit', '>= 4.7.0'
   spec.add_dependency 'regexp-examples', '~> 1.3', '>= 1.3.2'
   spec.add_dependency 'rubocop', '>= 0.45.0'
 end

data/lib/ducalis.rb

@@ -39,6 +39,7 @@ require 'ducalis/cops/descriptive_block_names'
 require 'ducalis/cops/enforce_namespace'
 require 'ducalis/cops/evlis_overusing'
 require 'ducalis/cops/extensions/type_resolving'
+require 'ducalis/cops/facade_pattern'
 require 'ducalis/cops/fetch_expression'
 require 'ducalis/cops/keyword_defaults'
 require 'ducalis/cops/module_like_class'
@@ -52,6 +53,7 @@ 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/recursion'
 require 'ducalis/cops/regex_cop'
 require 'ducalis/cops/rest_only_cop'
 require 'ducalis/cops/rubocop_disable'

data/lib/ducalis/commentators/github.rb

@@ -53,7 +53,7 @@ module Ducalis
       end
 
       def commented_offenses
-        @_commented_offenses ||= Utils.octokit.pull_request_comments(@repo, @id)
+        @commented_offenses ||= Utils.octokit.pull_request_comments(@repo, @id)
       end
     end
   end

data/lib/ducalis/cops/descriptive_block_names.rb

@@ -5,7 +5,7 @@ require 'rubocop'
 module Ducalis
   class DescriptiveBlockNames < RuboCop::Cop::Cop
     OFFENSE = <<-MESSAGE.gsub(/^ +\|\s/, '').strip
-      | Please, use descriptive names as block arguments. There is no any sanse to save on letters.
+      | Please, use descriptive names as block arguments. There is no any sense to save on letters.
     MESSAGE
 
     def on_block(node)

data/lib/ducalis/cops/facade_pattern.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'ducalis/cops/extensions/type_resolving'
+
+module Ducalis
+  class FacadePattern < RuboCop::Cop::Cop
+    include RuboCop::Cop::DefNode
+    prepend TypeResolving
+
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|\s/, '').strip
+      | There are too many instance variables for one controller action. It's beetter to refactor it with Facade pattern to simplify the controller.
+    MESSAGE
+
+    DETAILS = <<-MESSAGE.gsub(/^ +\|\s/, '').strip
+      | Good article about [Facade](<https://medium.com/kkempin/facade-design-pattern-in-ruby-on-rails-710aa88326f>).
+    MESSAGE
+
+    def on_def(node)
+      return unless in_controller?
+      return if non_public?(node)
+      return if instance_variables_matches(node).count < max_instance_variables
+      add_offense(node, :expression, OFFENSE)
+    end
+
+    private
+
+    def max_instance_variables
+      cop_config.fetch('MaxInstanceVariables')
+    end
+
+    def_node_search :instance_variables_matches, '(ivasgn ...)'
+  end
+end

data/lib/ducalis/cops/preferable_methods.rb

@@ -69,7 +69,7 @@ module Ducalis
 
     def on_send(node)
       who, what, *args = *node
-      return unless DESCRIPTION.keys.include?(what)
+      return unless DESCRIPTION.key?(what)
       alternative, reason, condition = DESCRIPTION.fetch(what)
       return unless condition.call(who, what, args)
       add_offense(node, :expression, format(OFFENSE, original: what,

data/lib/ducalis/cops/recursion.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Ducalis
+  class Recursion < RuboCop::Cop::Cop
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|\s/, '').strip
+      It seems like you are using recursion in your code. In common, it is not a bad idea, but try to keep your business logic layer free from refursion code.
+    MESSAGE
+
+    def on_def(node)
+      @method_name, _args, body = *node
+      return unless body
+      return unless send_call?(body) || send_self_call?(body)
+      add_offense(node, :expression, OFFENSE)
+    end
+
+    private
+
+    def call_itself?(call_name)
+      @method_name == call_name
+    end
+
+    def_node_search :send_call?, '(send nil? #call_itself? ...)'
+    def_node_search :send_self_call?, '(send (self) #call_itself? ...)'
+  end
+end

data/lib/ducalis/documentation.rb

@@ -79,8 +79,8 @@ class Documentation
   end
 
   def call
-    cops.map do |f|
-      present_cop(klass_const_for(f), spec_cases_for(f))
+    cops.map do |file|
+      present_cop(klass_const_for(file), spec_cases_for(file))
     end.flatten.join("\n")
   end
 
@@ -103,12 +103,12 @@ class Documentation
       end
   end
 
-  def prepare(it)
-    it.sub("#{RULE_WORD} ", '')
+  def prepare(it_description)
+    it_description.sub("#{RULE_WORD} ", '')
   end
 
-  def mention(it)
-    it.include?(SIGNAL_WORD) ? '# bad' : '# good'
+  def mention(it_description)
+    it_description.include?(SIGNAL_WORD) ? '# bad' : '# good'
   end
 
   def message(klass)
@@ -118,10 +118,10 @@ class Documentation
     ].join("\n")
   end
 
-  def spec_cases_for(f)
+  def spec_cases_for(file)
     source_code = File.read(
-      f.sub('/lib/', '/spec/')
-       .sub(/.rb$/, '_spec.rb')
+      file.sub('/lib/', '/spec/')
+          .sub(/.rb$/, '_spec.rb')
     )
     SpecsProcessor.new.tap do |processor|
       processor.process(Parser::CurrentRuby.parse(source_code))
@@ -133,9 +133,9 @@ class Documentation
     desc.include?(RULE_WORD)
   end
 
-  def klass_const_for(f)
-    require f
-    Ducalis.const_get(camelize(File.basename(f).sub(/.rb$/, '')))
+  def klass_const_for(file)
+    require file
+    Ducalis.const_get(camelize(File.basename(file).sub(/.rb$/, '')))
   end
 
   def camelize(snake_case_word)

data/lib/ducalis/git_access.rb

@@ -28,18 +28,18 @@ class GitAccess
   end
 
   def for(path)
-    find(path)
+    find(Pathname.new(path).relative_path_from(Pathname.new(Dir.pwd)).to_s)
   end
 
   private
 
   def under_git?
-    @_under_git ||= Dir.exist?(File.join(Dir.pwd, GIT_DIR))
+    @under_git ||= Dir.exist?(File.join(Dir.pwd, GIT_DIR))
   end
 
   def changes
     return default_value if flag.nil? || !under_git?
-    @_changes ||= patch_diffs
+    @changes ||= patch_diffs
   end
 
   def patch_diffs

data/lib/ducalis/utils.rb

@@ -9,7 +9,9 @@ module Ducalis
     def octokit
       @octokit ||= begin
         token = ENV.fetch('GITHUB_TOKEN') { raise MissingToken }
-        Octokit::Client.new(access_token: token)
+        Octokit::Client.new(access_token: token).tap do |client|
+          client.auto_paginate = true
+        end
       end
     end
 

data/lib/ducalis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ducalis
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.11.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ducalis
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Ignat Zakrevsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-13 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.7.0
 - !ruby/object:Gem::Dependency
   name: regexp-examples
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +117,7 @@ files:
 - lib/ducalis/cops/enforce_namespace.rb
 - lib/ducalis/cops/evlis_overusing.rb
 - lib/ducalis/cops/extensions/type_resolving.rb
+- lib/ducalis/cops/facade_pattern.rb
 - lib/ducalis/cops/fetch_expression.rb
 - lib/ducalis/cops/keyword_defaults.rb
 - lib/ducalis/cops/module_like_class.rb
@@ -130,6 +131,7 @@ files:
 - lib/ducalis/cops/protected_scope_cop.rb
 - lib/ducalis/cops/public_send.rb
 - lib/ducalis/cops/raise_without_error_class.rb
+- lib/ducalis/cops/recursion.rb
 - lib/ducalis/cops/regex_cop.rb
 - lib/ducalis/cops/rest_only_cop.rb
 - lib/ducalis/cops/rubocop_disable.rb