ducalis 0.5.11 → 0.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e9545be92ee4417db0ef82c0becd1ccb5c7a8cd
-  data.tar.gz: a11c6683e3364627615fcaec02444e21100aadb8
+  metadata.gz: cc58534f3d61b3f00faf32d15c18fd4ade02b01d
+  data.tar.gz: e2e5523eab7bd5dfe942f0e09722e718148ff6c4
 SHA512:
-  metadata.gz: 21529fb2e38466c9c011bf2310811db2bc35b197d178e8c87ab2067a67a35ef2987a1920dcc6f54bc41945c774c84d90fdbf4ca1561defc1d3f55dc1fe089356
-  data.tar.gz: 6d8d1be1aeda6b342d594f87bb9a68037712aea33b13802b7637d8c5055c608a9686e5d44647e41f3595ece8f9d6e2a2387307b21f9975c175657cd2bd7dbf84
+  metadata.gz: d84c6cbef793f301ce284c6325f992ea20672f6f01938f9a0feeef6cc76b8b564992aa552d1433a6960e893c08d3aada0682ec6a1eb3f28a8c0d942797f4c6e5
+  data.tar.gz: cbf69b4a43714b164e21ea3f19b08634504c563ca7f008b030fa625bed221bea0efba9f14bb917e96af25d4c1e180c53634bd9fb0f01f0fd73c443bd26bfdffb

data/DOCUMENTATION.md

@@ -294,10 +294,60 @@ class TaskJournal
   end
 end
 
+```
+## Ducalis::OnlyDefsCope
+
+Prefer object instances to class methods because class methods resist refactoring. Begin with an object instance, even if it doesn’t have state or multiple methods right away. If you come back to change it later, you will be more likely to refactor. If it never changes, the difference between the class method approach and the instance is negligible, and you certainly won’t be any worse off.
+Related article: https://codeclimate.com/blog/why-ruby-class-methods-resist-refactoring/
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) ignores classes with one instance method
+```ruby
+
+class TaskJournal
+  def initialize(task)
+    # ...
+  end
+
+  def call(args)
+    # ...
+  end
+end
+
+```
+
+![](https://placehold.it/10/2cbe4e/000000?text=+) ignores classes with mixed methods
+```ruby
+
+class TaskJournal
+  def self.find(task)
+    # ...
+  end
+
+  def call(args)
+    # ...
+  end
+end
+
+```
+
+![](https://placehold.it/10/f03c15/000000?text=+) raises error for class with ONLY class methods
+```ruby
+
+class TaskJournal
+
+  def self.call(task)
+    # ...
+  end
+
+  def self.find(args)
+    # ...
+  end
+end
+
 ```
 ## Ducalis::OptionsArgument
 
-Default options argument isn't good idea. It's better to explicitly pass which keys are you interested in as keyword arguments. You can use split operator to support hash arguments.
+Default `options` (or `args`) argument isn't good idea. It's better to explicitly pass which keys are you interested in as keyword arguments. You can use split operator to support hash arguments.
 
 Compare:
 
@@ -308,7 +358,10 @@ def generate_1(document, options = {})
   # ...
   [format, limit, options]
 end
-generate_1(1, format: 'csv', limit: 5, useless_arg: :value)
+
+options = { format: 'csv', limit: 5, useless_arg: :value }
+generate_1(1, options) #=> ["csv", 5, {:useless_arg=>:value}]
+generate_1(1, format: 'csv', limit: 5, useless_arg: :value) #=> ["csv", 5, {:useless_arg=>:value}]
 
 # vs
 
@@ -316,7 +369,11 @@ def generate_2(document, format:, limit: 20, **options)
   # ...
   [format, limit, options]
 end
-generate_2(1, format: 'csv', limit: 5, useless_arg: :value)
+
+options = { format: 'csv', limit: 5, useless_arg: :value }
+generate_2(1, **options) #=> ["csv", 5, {:useless_arg=>:value}]
+generate_2(1, format: 'csv', limit: 5, useless_arg: :value) #=> ["csv", 5, {:useless_arg=>:value}]
+
 ```
 
 ![](https://placehold.it/10/f03c15/000000?text=+) raises if method accepts default options argument
@@ -339,6 +396,15 @@ end
 
 ```
 
+![](https://placehold.it/10/f03c15/000000?text=+) raises if method accepts args argument
+```ruby
+
+def log(record, args)
+  # ...
+end
+
+```
+
 ![](https://placehold.it/10/2cbe4e/000000?text=+) ignores passing options with split operator
 ```ruby
 

data/Gemfile.lock

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

data/config/.ducalis.yml

@@ -51,6 +51,9 @@ Ducalis/TooLongWorkers:
   Enabled: true
   Max: 25
 
+Ducalis/OnlyDefsCope:
+  Enabled: true
+
 Ducalis/UselessOnly:
   Enabled: true
 

data/lib/ducalis/cops/callbacks_activerecord.rb

@@ -18,8 +18,11 @@ module Ducalis
       after_commit
       after_create
       after_destroy
+      after_find
+      after_initialize
       after_rollback
       after_save
+      after_touch
       after_update
       after_validation
       around_create

data/lib/ducalis/cops/only_defs_cope.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module Ducalis
+  class OnlyDefsCope < RuboCop::Cop::Cop
+    include RuboCop::Cop::DefNode
+
+    OFFENSE = <<-MESSAGE.gsub(/^ +\|\s/, '').strip
+      | Prefer object instances to class methods because class methods resist refactoring. Begin with an object instance, even if it doesn’t have state or multiple methods right away. If you come back to change it later, you will be more likely to refactor. If it never changes, the difference between the class method approach and the instance is negligible, and you certainly won’t be any worse off.
+    MESSAGE
+
+    DETAILS = <<-MESSAGE.gsub(/^ +\|\s/, '').strip
+      | Related article: https://codeclimate.com/blog/why-ruby-class-methods-resist-refactoring/
+    MESSAGE
+
+    def on_class(node)
+      _name, inheritance, body = *node
+      return if !inheritance.nil? || body.nil?
+      instance_methods = children(body).select(&public_method_definition?)
+      class_methods    = children(body).select(&class_method_definition?)
+
+      return unless instance_methods.empty? && class_methods.any?
+      add_offense(node, :expression, OFFENSE)
+    end
+
+    private
+
+    def public_method_definition?
+      lambda do |node|
+        node.type == :def && !non_public?(node) && !initialize?(node)
+      end
+    end
+
+    def class_method_definition?
+      lambda do |node|
+        node.type == :defs && !non_public?(node) && !initialize?(node)
+      end
+    end
+
+    def children(body)
+      (body.type != :begin ? s(:begin, body) : body).children
+    end
+
+    def_node_search :initialize?, '(def :initialize ...)'
+  end
+end

data/lib/ducalis/cops/options_argument.rb

@@ -5,7 +5,7 @@ require 'rubocop'
 module Ducalis
   class OptionsArgument < RuboCop::Cop::Cop
     OFFENSE = <<-MESSAGE.gsub(/^ +\|\s/, '').strip
-      | Default options argument isn't good idea. It's better to explicitly pass which keys are you interested in as keyword arguments. You can use split operator to support hash arguments.
+      | Default `options` (or `args`) argument isn't good idea. It's better to explicitly pass which keys are you interested in as keyword arguments. You can use split operator to support hash arguments.
 
       | Compare:
 
@@ -16,7 +16,10 @@ module Ducalis
       |   # ...
       |   [format, limit, options]
       | end
-      | generate_1(1, format: 'csv', limit: 5, useless_arg: :value)
+
+      | options = { format: 'csv', limit: 5, useless_arg: :value }
+      | generate_1(1, options) #=> ["csv", 5, {:useless_arg=>:value}]
+      | generate_1(1, format: 'csv', limit: 5, useless_arg: :value) #=> ["csv", 5, {:useless_arg=>:value}]
 
       | # vs
 
@@ -24,10 +27,19 @@ module Ducalis
       |   # ...
       |   [format, limit, options]
       | end
-      | generate_2(1, format: 'csv', limit: 5, useless_arg: :value)
+
+      | options = { format: 'csv', limit: 5, useless_arg: :value }
+      | generate_2(1, **options) #=> ["csv", 5, {:useless_arg=>:value}]
+      | generate_2(1, format: 'csv', limit: 5, useless_arg: :value) #=> ["csv", 5, {:useless_arg=>:value}]
+
       | ```
     MESSAGE
 
+    BLACK_LIST = %i(
+      options
+      args
+    ).freeze
+
     def on_def(node)
       _name, args, _body = *node
       return unless default_options?(args)
@@ -36,13 +48,17 @@ module Ducalis
 
     private
 
-    def_node_search :options_arg?, '(arg :options)'
-    def_node_search :options_arg_with_default?, '(optarg :options ...)'
+    def_node_search :options_arg?, '(arg #blacklisted?)'
+    def_node_search :options_arg_with_default?, '(optarg #blacklisted? ...)'
 
     def default_options?(args)
       args.children.any? do |node|
         options_arg?(node) || options_arg_with_default?(node)
       end
     end
+
+    def blacklisted?(name)
+      BLACK_LIST.include?(name)
+    end
   end
 end

data/lib/ducalis/version.rb

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

data/lib/ducalis.rb

@@ -35,13 +35,14 @@ require 'ducalis/cops/black_list_suffix'
 require 'ducalis/cops/callbacks_activerecord'
 require 'ducalis/cops/case_mapping'
 require 'ducalis/cops/controllers_except'
+require 'ducalis/cops/only_defs_cope'
 require 'ducalis/cops/keyword_defaults'
 require 'ducalis/cops/module_like_class'
 require 'ducalis/cops/options_argument'
 require 'ducalis/cops/params_passing'
 require 'ducalis/cops/possible_tap'
-require 'ducalis/cops/private_instance_assign'
 require 'ducalis/cops/preferable_methods'
+require 'ducalis/cops/private_instance_assign'
 require 'ducalis/cops/protected_scope_cop'
 require 'ducalis/cops/raise_without_error_class'
 require 'ducalis/cops/regex_cop'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ducalis
 version: !ruby/object:Gem::Version
-  version: 0.5.11
+  version: 0.5.12
 platform: ruby
 authors:
 - Ignat Zakrevsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-07 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -136,6 +136,7 @@ files:
 - lib/ducalis/cops/controllers_except.rb
 - lib/ducalis/cops/keyword_defaults.rb
 - lib/ducalis/cops/module_like_class.rb
+- lib/ducalis/cops/only_defs_cope.rb
 - lib/ducalis/cops/options_argument.rb
 - lib/ducalis/cops/params_passing.rb
 - lib/ducalis/cops/possible_tap.rb