ducalis 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a11daa74e66a48aa5dcf55449524a52ce95ccfe
-  data.tar.gz: be32ea0b59dcbaf77839929724d98ce64562407e
+  metadata.gz: 2287c52a483de43813b38fd3dbbb76dbe3780655
+  data.tar.gz: 70aabac07f3332f1f93066e8b62a0735e10d312c
 SHA512:
-  metadata.gz: d1d720cf2eb513ce4073c5ed10ab6c96314efa49e3d416a1ae55bdba86530b8362da4bd49717322a161b04bbad5d134b38fe62885b498873cc4aec8e1af9d83c
-  data.tar.gz: f81669117b7f2ddb1c29d536cbe70823c8f435a25e93f517c712ed6f387a9a6aec4f42db6e4460ed266151350e5873de06b3fb03c0a80e1ff321222c10ae44f1
+  metadata.gz: c83807a339d46e105dd31d431676215d3e5096ec1a4e24001f2d2f04b9b986a436a4d8f4cce5190d048472d0a52ff0dd98230842be0ec044eca77a37e4a479cd
+  data.tar.gz: 7141de63c1e561a7a509d37b461a9bbba0f77da84c1f7e45cb6b181fd6f8162789e23de5edbd473ffeee8a6a3ddd014877ae60d62e8b92762572b02272162685

data/DOCUMENTATION.md

@@ -1,3 +1,35 @@
+## Ducalis::BlackListSuffix
+
+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.
+ Related [article](<http://www.carlopescio.com/2011/04/your-coding-conventions-are-hurting-you.html>)
+
+![](https://placehold.it/10/f03c15/000000?text=+) raises on classes with suffixes from black list
+```ruby
+
+class ListSorter
+end
+
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) ignores classes with okish suffixes
+```ruby
+
+class SortedList
+end
+
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) ignores classes with full match
+```ruby
+
+class Manager
+end
+
+```
 ## Ducalis::CallbacksActiverecord
 
 Please, avoid using of callbacks for models. It's better to
@@ -449,7 +481,7 @@ end
 ![](https://placehold.it/10/2cbe4e/000000?text=+) ignores methods which return some statement
 ```ruby
 
-  def stop_terminated_employee
+def stop_terminated_employee
   if current_user && current_user.terminated?
     sign_out current_user
     redirect_to new_user_session_path
@@ -459,13 +491,45 @@ end
 
 ```
 
-![](https://placehold.it/10/2cbe4e/000000?text=+) ignores methods which simply returns instance var without changes
+![](https://placehold.it/10/2cbe4e/000000?text=+) [bugfix] calling methods on possible tap variable
+```ruby
+
+def create_message_struct(message)
+  objects = message.map { |object| process(object) }
+  Auditor::Message.new(message.process, objects)
+end
+
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) [bugfix] methods which simply returns instance var without changes
 ```ruby
 
 def employee
   @employee
 end
 
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) [bugfix] methods which ends with if condition
+```ruby
+
+def complete=(value, complete_at)
+  value = value.to_b
+  self.complete_at = complete_at if complete && value
+  self.complete_at = nil unless value
+end
+
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) [bugfix] methods with args without children nodes
+```ruby
+
+def filtered_admins(reducers)
+  reducers
+    .map { |reducer| @base_scope.public_send(reducer) }
+    .order("admin_users.created_at DESC")
+end
+
 ```
 ## Ducalis::PreferableMethods
 
@@ -500,9 +564,9 @@ tempfile.delete
 ```
 ## Ducalis::PrivateInstanceAssign
 
-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
+Don't use controller's filter methods 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.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ducalis (0.5.6)
+    ducalis (0.5.7)
       git (~> 1.3, >= 1.3.0)
       policial (= 0.0.4)
       regexp-examples (~> 1.3, >= 1.3.2)

data/config/.ducalis.yml

@@ -5,6 +5,20 @@ AllCops:
     - 'node_modules/**/*'
     - 'vendor/bundle/**/*'
 
+Ducalis/BlackListSuffix:
+  Enabled: true
+  BlackList:
+    - Sorter
+    - Manager
+    - Client
+    - Object
+    - Handler
+    - Processor
+    - Organizer
+    - Analyzer
+    - Renderer
+    - Loader
+
 Ducalis/PreferableMethods:
   Enabled: true
 

data/lib/ducalis/cops/black_list_suffix.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Ducalis
+  class BlackListSuffix < RuboCop::Cop::Cop
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|/, '').strip
+      | 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.
+      | Related [article](<http://www.carlopescio.com/2011/04/your-coding-conventions-are-hurting-you.html>)
+    MESSAGE
+
+    def on_class(node)
+      classdef_node, _superclass, _body = *node
+      return unless with_blacklisted_suffix?(classdef_node.source)
+      add_offense(node, :expression, OFFENSE)
+    end
+
+    private
+
+    def with_blacklisted_suffix?(name)
+      return if cop_config['BlackList'].to_a.empty?
+      cop_config['BlackList'].any? { |suffix| name =~ /#{suffix}\Z/ }
+    end
+  end
+end

data/lib/ducalis/cops/possible_tap.rb

@@ -47,14 +47,20 @@ module Ducalis
     end
 
     def return_var_call?(body)
-      return unless body.children.last.respond_to?(:children)
-      subnodes(body.children.last.to_a.first).find do |node|
+      return unless last_child(body).respond_to?(:children)
+      return if last_child(body).type == :if
+      subnodes(last_child(body).to_a.first).find do |node|
         ASSIGNS.include?(node.type)
       end
     end
 
     def subnodes(node)
+      return [] unless node.respond_to?(:children)
       ([node] + node.children).select { |child| child.respond_to?(:type) }
     end
+
+    def last_child(body)
+      body.children.last
+    end
   end
 end

data/lib/ducalis/cops/private_instance_assign.rb

@@ -6,9 +6,9 @@ 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
+      | Don't use controller's filter methods 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.

data/lib/ducalis/documentation.rb

@@ -62,7 +62,7 @@ class Documentation
   SIGNAL_WORD = 'raises'
 
   def call
-    Dir['./lib/ducalis/cops/*.rb'].map do |f|
+    Dir['./lib/ducalis/cops/*.rb'].sort.map do |f|
       present_cop(klass_const_for(f), spec_cases_for(f))
     end.flatten.join("\n")
   end

data/lib/ducalis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ducalis
-  VERSION = '0.5.6'
+  VERSION = '0.5.7'
 end

data/lib/ducalis.rb

@@ -31,6 +31,7 @@ require 'ducalis/patched_rubocop/git_runner'
 require 'ducalis/patched_rubocop/git_turget_finder'
 require 'ducalis/patched_rubocop/rubo_cop'
 
+require 'ducalis/cops/black_list_suffix'
 require 'ducalis/cops/callbacks_activerecord'
 require 'ducalis/cops/case_mapping'
 require 'ducalis/cops/controllers_except'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ducalis
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Ignat Zakrevsky
@@ -130,6 +130,7 @@ files:
 - lib/ducalis/cli.rb
 - lib/ducalis/commentators/console.rb
 - lib/ducalis/commentators/github.rb
+- lib/ducalis/cops/black_list_suffix.rb
 - lib/ducalis/cops/callbacks_activerecord.rb
 - lib/ducalis/cops/case_mapping.rb
 - lib/ducalis/cops/controllers_except.rb