debride 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9e867eaaa0e3d510c124de19d4ea6ab0fa818e5
-  data.tar.gz: 39740af34dbd97eb9e1286ab0a1ca51437aec120
+  metadata.gz: 9997dcf31c73430147cd74d4365cacc011a9ddf9
+  data.tar.gz: 0d52faa989d72642bfc90eb59efe69c1eb29bd85
 SHA512:
-  metadata.gz: ee65c75009da3d4f6c8760c5fe0b493929008d42f81be3db3cb19e6cf3c8e30f89483eb30088c95d1174880e91b9895e72ecf5f31c5c6fa36d9930f374291d72
-  data.tar.gz: ce1b919309e8790d5a320675721ed82116a1312440ff678fb002f00130247ca7369e71358ad3d379749ac2c6048b6e6a7e109b1405d478055daa30e5881f24ff
+  metadata.gz: '090808da18149228a64261245d549cb50fa78141b73428a913fe606b61f700bec4ada3de220c5b9ff01e48b1f15f94daa93a4296f570d8da65f6cea7bf53e124'
+  data.tar.gz: 73af8d47c93780a568590bc7bf34b4ff4df80dd6ce9e877d01347b232ca2907274b7d1cb4b090481a5aaab13e23f2e3575324a02e9f49c10bffb513c7817086b

data/History.rdoc

@@ -1,3 +1,13 @@
+=== 1.8.0 / 2017-05-09
+
+* 1 minor enhancement:
+
+  * Updated rails support. (phiggins)
+
+* 1 bug fix:
+
+  * Fixed regression reporting class methods caused by 1.7.0. (marcinruszkiewicz/etagwerker)
+
 === 1.7.0 / 2016-11-30
 
 * 1 minor enhancement:

data/README.rdoc

@@ -52,6 +52,11 @@ debride-haml :: Plugin to allow debride to parse Haml files.
 debride-curly :: A plugin for the Curly templating language
 debride-slim :: Extends debride to analyze Slim files
 
+== EDITOR INTEGRATION:
+
+TextMate 2 :: * {Debride-Rails.tmbundle}[https://github.com/jjuliano/Debride-Rails.tmbundle] - Debride with Rails support 
+              * {Debride.tmbundle}[https://github.com/jjuliano/Debride-Rails.tmbundle] - Debride for Ruby
+
 == REQUIREMENTS:
 
 * sexp_processor

data/lib/debride.rb

@@ -22,7 +22,7 @@ end
 # A static code analyzer that points out possible dead methods.
 
 class Debride < MethodBasedSexpProcessor
-  VERSION = "1.7.0" # :nodoc:
+  VERSION = "1.8.0" # :nodoc:
   PROJECT = "debride"
 
   def self.load_plugins proj = PROJECT
@@ -262,29 +262,27 @@ class Debride < MethodBasedSexpProcessor
       if Sexp === msg_arg && [:lit, :str].include?(msg_arg.sexp_type) then
         called << msg_arg.last.to_sym
       end
-     when *RAILS_VALIDATION_METHODS then
-       if option[:rails]
-         possible_hash = sexp.last
-         if Sexp === possible_hash && possible_hash.sexp_type == :hash
-           possible_hash.sexp_body.each_slice(2) do |key, val|
-             called << val.last        if val.first == :lit
-             called << val.last.to_sym if val.first == :str
-           end
-         end
-       end
-     when *RAILS_DSL_METHODS then
-       if option[:rails]
-         # s(:call, nil, :before_save, s(:lit, :save_callback), s(:hash, ...))
-         _, _, _, (_, new_name), possible_hash = sexp
-         called << new_name
-         if Sexp === possible_hash && possible_hash.sexp_type == :hash
-           possible_hash.sexp_body.each_slice(2) do |key, val|
-             next unless Sexp === val
-             called << val.last        if val.first == :lit
-             called << val.last.to_sym if val.first == :str
-           end
-         end
-       end
+    when *RAILS_DSL_METHODS, *RAILS_VALIDATION_METHODS then
+      if option[:rails]
+        # s(:call, nil, :before_save, s(:lit, :save_callback), s(:hash, ...))
+        if RAILS_DSL_METHODS.include?(method_name)
+          _, _, _, (_, new_name), * = sexp
+          called << new_name if new_name
+        end
+        possible_hash = sexp.last
+        if Sexp === possible_hash && possible_hash.sexp_type == :hash
+          possible_hash.sexp_body.each_slice(2) do |key, val|
+            next unless Sexp === val
+            called << val.last        if val.first == :lit
+            called << val.last.to_sym if val.first == :str
+          end
+        end
+      end
+    when *RAILS_MACRO_METHODS
+      # s(:call, nil, :has_one, s(:lit, :has_one_relation), ...)
+      _, _, _, (_, name), * = sexp
+      file, line = sexp.file, sexp.line
+      record_method name, file, line
     when /_path$/ then
       method_name = method_name.to_s[0..-6].to_sym if option[:rails]
     end
@@ -398,7 +396,9 @@ class Debride < MethodBasedSexpProcessor
 
     missing.each do |klass, meths|
       bad = meths.map { |meth|
-        location = method_locations["#{klass}##{meth}"]
+        location =
+          method_locations["#{klass}##{meth}"] ||
+          method_locations["#{klass}::#{meth}"]
         path = location[/(.+):\d+$/, 1]
 
         next if focus and not File.fnmatch(focus, path)
@@ -414,12 +414,16 @@ class Debride < MethodBasedSexpProcessor
     end
   end
 
+  ##
+  # Rails' macro-style methods that setup method calls to happen during a rails
+  # app's execution.
+
   RAILS_DSL_METHODS = [
     :after_action,
     :around_action,
     :before_action,
 
-    # http://api.rubyonrails.org/v4.2.1/classes/ActiveRecord/Callbacks.html
+    # http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html
     :after_commit,
     :after_create,
     :after_destroy,
@@ -444,8 +448,12 @@ class Debride < MethodBasedSexpProcessor
     :validate,
   ]
 
-  # http://api.rubyonrails.org/v4.2.1/classes/ActiveModel/Validations/HelperMethods.html
+  ##
+  # Rails' macro-style methods that count as method calls if their options
+  # include +:if+ or +:unless+.
+
   RAILS_VALIDATION_METHODS = [
+    # http://api.rubyonrails.org/classes/ActiveModel/Validations/HelperMethods.html
     :validates,
     :validates_absence_of,
     :validates_acceptance_of,
@@ -458,4 +466,15 @@ class Debride < MethodBasedSexpProcessor
     :validates_presence_of,
     :validates_size_of,
   ]
+
+  ##
+  # Rails' macro-style methods that define methods dynamically.
+
+  RAILS_MACRO_METHODS = [
+    :belongs_to,
+    :has_and_belongs_to_many,
+    :has_many,
+    :has_one,
+    :scope,
+  ]
 end

data/test/test_debride.rb

@@ -223,12 +223,57 @@ class TestDebride < Minitest::Test
         after_save :save_callback, if: lambda {|r| true }
         validates :database_column, if: :validation_condition
         validate :some_validation_method
+
+        before_save do
+          foo.bar
+        end
       end
     RUBY
 
     assert_process [], ruby, :rails => true
   end
 
+  def test_rails_dsl_macro_definitions
+    ruby = <<-RUBY.strip
+      class RailsModel
+        has_one :has_one_relation
+        has_one :uncalled_has_one_relation
+        belongs_to :belongs_to_relation
+        belongs_to :uncalled_belongs_to_relation
+        has_many :has_many_relation
+        has_many :uncalled_has_many_relation
+        has_and_belongs_to_many :has_and_belongs_to_many_relation
+        has_and_belongs_to_many :uncalled_has_and_belongs_to_many_relation
+        scope :scope_method
+        scope :uncalled_scope_method
+
+        def instance_method_caller
+          has_one_relation
+          belongs_to_relation
+          has_many_relation
+          has_and_belongs_to_many_relation
+        end
+
+        def self.class_method_caller
+          scope_method
+        end
+
+        class_method_caller
+        new.instance_method_caller
+      end
+    RUBY
+
+    unused_methods = [
+      :uncalled_belongs_to_relation,
+      :uncalled_has_and_belongs_to_many_relation,
+      :uncalled_has_many_relation,
+      :uncalled_has_one_relation,
+      :uncalled_scope_method,
+    ]
+
+    assert_process [["RailsModel", unused_methods]], ruby, :rails => true
+  end
+
   def test_constants
     ruby = <<-RUBY.strip
       class Constants
@@ -259,6 +304,10 @@ class TestDebride < Minitest::Test
           self.a2 = 'Bar'
           self.w1 = 'W'
         end
+
+        def self.class_method
+          puts "bazinga"
+        end
       end
 
       object = AttributeAccessor.new
@@ -267,7 +316,7 @@ class TestDebride < Minitest::Test
       object.a3 = 'Baz'
     RUBY
 
-    d = assert_process [["AttributeAccessor", [:a1=, :a2, :a3, :r2, :w2=]]], ruby
+    d = assert_process [["AttributeAccessor", [:a1=, :a2, :a3, :class_method, :r2, :w2=]]], ruby
 
     exp = {
            "AttributeAccessor#a1"         => "(io):2",
@@ -280,7 +329,8 @@ class TestDebride < Minitest::Test
            "AttributeAccessor#w2="        => "(io):3",
            "AttributeAccessor#r1"         => "(io):4",
            "AttributeAccessor#r2"         => "(io):4",
-           "AttributeAccessor#initialize" => "(io):5",
+           "AttributeAccessor#initialize" => "(io):5-7",
+           "AttributeAccessor::class_method" => "(io):10-11"
           }
 
     assert_equal exp, d.method_locations

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -30,78 +30,78 @@ cert_chain:
   E4oJcnPkJAr0rw504JGtlZtONZQblwmRJOIdXzolaE3NRGUzGVOUSptZppAKiavY
   fO6tdKQc/5RfA8oQEkg8hrxA5PQSz4TOFJGLpFvIapEk6tMruQ0bHgkhr9auXg==
   -----END CERTIFICATE-----
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2017-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.5'
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
   name: path_expander
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
+        version: '3.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.15'
+        version: '3.16'
 description: Analyze code for potentially uncalled / dead methods, now with auto-removal.
 email:
 - ryand-ruby@zenspider.com
@@ -115,7 +115,7 @@ extra_rdoc_files:
 - Manifest.txt
 - README.rdoc
 files:
-- .autotest
+- ".autotest"
 - History.rdoc
 - Manifest.txt
 - README.rdoc
@@ -131,23 +131,23 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --main
+- "--main"
 - README.rdoc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Analyze code for potentially uncalled / dead methods, now with auto-removal.