debride 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb39a05e306cbbcd061e35997220368ac0cbd964
-  data.tar.gz: 0704f659f6af475a29e97b424eeecb9ef66b1b8a
+  metadata.gz: 5a723b84c9a06468449e24ec4cf6f8911f1cfbc1
+  data.tar.gz: 7a135fd947b6cbd2905f4d4196aa526966f465e6
 SHA512:
-  metadata.gz: a33032ea66b7b298f0a922978bb3f70b1fdd983bf1147e442fddaf8188be6695b81be4430b32135a4130d1893281d437683e58d8a90b02a533e3909b768edb27
-  data.tar.gz: 0bcaa9a023b64733d5def8e8cec519328b21bb7a68fa8bf1da74aa7284e031ccc9fc2a4ec7692f037af5b0017400665772d88d9395bb3b5c08c28c16d953804e
+  metadata.gz: 6b43c1951aac3602c0ec3bbf1bb28e9aa14d976bb6cc4af7073000795dea551e78d58a20b924396cb2e09f5d422eb9af519d394b413964c541a17ddc46d23ac0
+  data.tar.gz: eae873a00409532767de144cea3d1f31249d4083a0823bb96ee38f89db7f4321bd4cbf54a977e4b494a55c4b66f531674a22f98bafdae7e51dbb1220207a7997

data/History.rdoc

@@ -1,3 +1,16 @@
+=== 1.3.0 / 2015-04-13
+
+* 4 minor enhancements:
+
+  * Add explicit #send support. (phiggins)
+  * Added --exclude for files and dirs. (ianlotinsky)
+  * Added --rails flag and rails-specific call transformations.
+  * Added methods to called list found in rails DSL methods. (phiggins)
+
+* 1 bug fix:
+
+  * Fixed bug with alias_method_chain. (phiggins)
+
 === 1.2.0 / 2015-03-26
 
 * 1 major enhancement:

data/README.rdoc

@@ -46,6 +46,11 @@ You can also use regexps in your whitelist by delimiting them with //'s.
 
 * sudo gem install debride
 
+== CONTRIBUTING:
+
+* sudo gem install minitest
+* ruby -Ilib:test test/test_debride.rb
+
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -18,7 +18,7 @@ end
 task :rails do
   ENV["GEM_HOME"] = "tmp/isolate/ruby-2.0.0"
   ENV["GEM_PATH"] = "../../debride-erb/dev/tmp/isolate/ruby-2.0.0"
-  ruby "-Ilib:../../debride-erb/dev/lib bin/debride ~/Work/git/seattlerb.org/{app,lib} --whitelist ~/Work/git/seattlerb.org/whitelist.txt"
+  ruby "-Ilib:../../debride-erb/dev/lib bin/debride --rails ~/Work/git/seattlerb.org/{app,lib} --whitelist ~/Work/git/seattlerb.org/whitelist.txt"
 end
 
 # vim: syntax=ruby

data/lib/debride.rb

@@ -9,7 +9,7 @@ require "set"
 # A static code analyzer that points out possible dead methods.
 
 class Debride < MethodBasedSexpProcessor
-  VERSION = "1.2.0" # :nodoc:
+  VERSION = "1.3.0" # :nodoc:
   PROJECT = "debride"
 
   def self.expand_dirs_to_files *dirs # TODO: push back up to sexp_processor
@@ -59,7 +59,11 @@ class Debride < MethodBasedSexpProcessor
     opt = parse_options args
 
     debride = Debride.new opt
-    debride.run expand_dirs_to_files(args)
+
+    files = expand_dirs_to_files(args)
+    files -= expand_dirs_to_files(debride.option[:exclude]) if debride.option[:exclude]
+
+    debride.run(files)
     debride
   end
 
@@ -111,10 +115,18 @@ class Debride < MethodBasedSexpProcessor
         exit
       end
 
+      opts.on("-e", "--exclude FILE1,FILE2,ETC", Array, "Exclude files or directories in comma-separated list.") do |list|
+        options[:exclude] = list
+      end
+
       opts.on("-w", "--whitelist FILE", String, "Whitelist these messages.") do |s|
         options[:whitelist] = File.read(s).split(/\n+/) rescue []
       end
 
+      opts.on("-r", "--rails", "Add some rails call conversions.") do
+        options[:rails] = true
+      end
+
       opts.on("-v", "--verbose", "Verbose. Show progress processing files.") do
         options[:verbose] = true
       end
@@ -182,8 +194,41 @@ class Debride < MethodBasedSexpProcessor
     case method_name
     when :new then
       method_name = :initialize
-    when :alias_method_chain
-      known[sexp[3]] << klass_name
+    when :alias_method_chain then
+      new_name = sexp[3]
+      new_name = new_name.last if Sexp === new_name # when is this NOT the case?
+      known[new_name] << klass_name if option[:rails]
+    when :send, :public_send, :__send__ then
+      sent_method = sexp[3]
+      if Sexp === sent_method && [:lit, :str].include?(sent_method.first)
+        called << sent_method.last.to_sym
+      end
+     when *RAILS_VALIDATION_METHODS then
+       if option[:rails]
+         possible_hash = sexp.last
+         if Sexp === possible_hash && possible_hash.first == :hash
+           possible_hash[1..-1].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]
+         new_name = sexp[3]
+         new_name = new_name.last if Sexp === new_name # when is this NOT the case?
+         called << new_name
+         possible_hash = sexp.last
+         if Sexp === possible_hash && possible_hash.first == :hash
+           possible_hash[1..-1].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 /_path$/ then
+      method_name = method_name.to_s[0..-6].to_sym if option[:rails]
     end
 
     called << method_name
@@ -210,6 +255,7 @@ class Debride < MethodBasedSexpProcessor
     not_called = known.keys - called.to_a
 
     whitelist_regexp = Regexp.union whitelist_regexps
+
     not_called.reject! { |s| whitelist_regexp =~ s }
 
     by_class = Hash.new { |h,k| h[k] = [] }
@@ -241,4 +287,46 @@ class Debride < MethodBasedSexpProcessor
       end
     end
   end
+
+  RAILS_DSL_METHODS = [
+    :after_action,
+    :around_action,
+    :before_action,
+
+    # http://api.rubyonrails.org/v4.2.1/classes/ActiveRecord/Callbacks.html
+    :after_commit,
+    :after_create,
+    :after_destroy,
+    :after_find,
+    :after_initialize,
+    :after_rollback,
+    :after_save,
+    :after_touch,
+    :after_update,
+    :after_validation,
+    :around_create,
+    :around_destroy,
+    :around_save,
+    :around_update,
+    :before_create,
+    :before_destroy,
+    :before_save,
+    :before_update,
+    :before_validation,
+  ]
+
+  # http://api.rubyonrails.org/v4.2.1/classes/ActiveModel/Validations/HelperMethods.html
+  RAILS_VALIDATION_METHODS = [
+    :validates,
+    :validates_absence_of,
+    :validates_acceptance_of,
+    :validates_confirmation_of,
+    :validates_exclusion_of,
+    :validates_format_of,
+    :validates_inclusion_of,
+    :validates_length_of,
+    :validates_numericality_of,
+    :validates_presence_of,
+    :validates_size_of,
+  ]
 end

data/test/test_debride.rb

@@ -31,11 +31,26 @@ class TestDebride < Minitest::Test
     assert_option %w[-v woot.rb], %w[woot.rb], :verbose => true
   end
 
+  def test_parse_options_exclude
+    assert_option %w[--exclude moot.rb],   %w[],    :exclude => %w[moot.rb]
+    assert_option %w[-e moot lib],         %w[lib], :exclude => %w[moot]
+    assert_option %w[-e moot,moot.rb lib], %w[lib], :exclude => %w[moot moot.rb]
+  end
+
   def test_parse_options_whitelist
     exp = File.readlines("Manifest.txt").map(&:chomp) # omg dumb
     assert_option %w[--whitelist Manifest.txt], %w[], :whitelist => exp
   end
 
+  def test_exclude_files
+    debride = Debride.run %w[--exclude test lib]
+
+    exp = [["Debride",
+            [:process_call, :process_defn, :process_defs, :process_rb, :report]]]
+
+    assert_equal exp, debride.missing
+  end
+
   def test_whitelist
     debride = Debride.run %w[lib]
     debride.option[:whitelist] = %w[process_defn]
@@ -54,4 +69,81 @@ class TestDebride < Minitest::Test
 
     assert_equal exp, debride.missing
   end
+
+  def test_alias_method_chain
+    file = Tempfile.new ["debride_test", ".rb"]
+
+    file.write <<-RUBY.strip
+      class QuarterPounder
+        def royale_with_cheese
+          1+1
+        end
+
+        alias_method_chain :royale, :cheese
+      end
+    RUBY
+
+    file.flush
+
+    debride = Debride.run [file.path, "--rails"]
+
+    exp = [["QuarterPounder", [:royale, :royale_with_cheese]]]
+
+    assert_equal exp, debride.missing
+  end
+
+  def test_method_send
+    file = Tempfile.new ["debride_test", ".rb"]
+
+    file.write <<-RUBY.strip
+      class Seattle
+        def self.raining?
+          true
+        end
+
+        def self.coffee
+          :good
+        end
+      end
+
+      Seattle.send :raining?
+      Seattle.__send__ "coffee"
+      Seattle.send "\#{foo}_bar"
+    RUBY
+
+    file.flush
+
+    debride = Debride.run [file.path]
+
+    exp = []
+
+    assert_equal exp, debride.missing
+  end
+
+  def test_rails_dsl_methods
+    file = Tempfile.new ["debride_test", ".rb"]
+
+    file.write <<-RUBY.strip
+      class RailsThing
+        def save_callback         ; 1 ; end
+        def action_filter         ; 1 ; end
+        def callback_condition    ; 1 ; end
+        def action_condition      ; 1 ; end
+        def string_condition      ; 1 ; end
+        def validation_condition  ; 1 ; end
+
+        before_save :save_callback, unless: :callback_condition
+        before_save :save_callback, if: 'string_condition'
+        before_action :action_filter, if: :action_condition, only: :new
+        after_save :save_callback, if: lambda {|r| true }
+        validates :database_column, if: :validation_condition
+      end
+    RUBY
+
+    file.flush
+
+    debride = Debride.run [file.path, "--rails"]
+
+    assert_equal [], debride.missing.sort
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -29,7 +29,7 @@ cert_chain:
   xJcC6UN6NHMOVMyAXsr2HR0gRRx4ofN1LoP2KhXzSr8UMvQYlwPmE0N5GQv1b5AO
   VpzF30vNaJK6ZT7xlIsIlwmH
   -----END CERTIFICATE-----
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
@@ -65,14 +65,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.6'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement