debride 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6fb60e6abb914cdca253c8f91a87ee9f29b9573
-  data.tar.gz: c277e27c75a4a571e22cc647fe4d98063f944256
+  metadata.gz: 8f2ef4f667b2008a96704a15a62f41bc993f0872
+  data.tar.gz: 68ee77d6fd2c8687ef8392cbbd910ae959b251c5
 SHA512:
-  metadata.gz: dc8279ae3e71097d6b57ade1054d80c596b76e6b47878b8269fd931abca6b497da3780cf85cff3860563b307a2c01f727fe11f1bc03a11287242e3bd376c75d7
-  data.tar.gz: 560722e6f9d07d1dff4bab14e912cec2d9a019046ee4a5dcfc7a6394e98c9f933e0ff1c4c9dc9b85f2cdd1ad2093889acd2926fb05246bfc96c3bd89bbf477a7
+  metadata.gz: 4f226eb6901be45033201a3ceb29498d253b13fe20c998bdbe8c1200d6401f3785111690437e47f10ecb87919c2c0c73b057a68a8d9a0a630d92ab6e4f067276
+  data.tar.gz: ad86dccb33825e6157c33ec72f919dc9f2e3d9730b6a67c35664814fdf4517c27b3f1ca214579c83c4b1a448e4e38a97b1d2282e0215148c21426cdcd57cded0

checksums.yaml.gz.sig

@@ -1,3 +1,2 @@
-qX4R�uDGV���B����gN
-SL&�:�;ˑL����Z�ȝ�2��d�=&|�)H��6�KB���V�.�y�^Ӹ�>��2!{H?�K�ųf�8t8�Z4̀`�h3sMD�������u�h��u۔�E<�.�*�(C��F���L|H��"�*�[��K�
-��Jc���}����
+̸H+
+�n:Tၑ��k,!m	�h#xk:dd!���L�ȱC���R�8��(�#=��Bsaq�_���
�(K8����i���B`��;�׳���O�|�v�U%�i�&QWwaωޞ�7x�o]��������iiK�4���1B���-/��*���9������:�Ғ��3�X��V>0n�>-����3���˾bI���Q�	�5#��h�meǗ��2�a,�k:��N,x��9.�4��}�6;~t

data/History.rdoc

@@ -1,3 +1,20 @@
+=== 1.5.0 / 2015-06-14
+
+* 6 minor enhancements:
+
+  * Added --focus <path> to filter report on focused path. (phiggins)
+  * Added debride_rails_whitelist to help generate emperical whitelists from logs.
+  * Added validate to rails methods. (jeremyf)
+  * Extended debride to understand attr_* methods. (jeremyf)
+  * Extended debride_rails_whitelist to be able to scan compressed logs (gzip/bzip)
+  * Improved output of debride_rails_whitelist so you know what's going on. (amerine)
+
+* 3 bug fixes:
+
+  * Fixed handling of uncalled attr_* methods in reports.
+  * Fixed improper recording of locations of consts and alias_method_chain.
+  * Fixed recording of method names.
+
 === 1.4.0 / 2015-05-27
 
 * 1 major enhancement:

data/Manifest.txt

@@ -4,5 +4,6 @@ Manifest.txt
 README.rdoc
 Rakefile
 bin/debride
+bin/debride_rails_whitelist
 lib/debride.rb
 test/test_debride.rb

data/bin/debride_rails_whitelist

@@ -0,0 +1,70 @@
+#!/usr/bin/ruby -w
+
+route  = ARGV.shift
+routes = {}
+verbs  = "(?:GET|POST|PUT|PATCH|DELETE)"
+
+unless route then
+  cmd = File.basename $0
+  warn "error: no files given"
+  warn "usage:"
+  warn "  rake routes > routes.txt"
+  warn "  #{cmd} routes.txt logfiles... | sort -u > whitelist.txt"
+  abort
+end
+
+File.foreach route do |line|
+  case line.chomp
+  when /^\s+Prefix/, "" then
+    # ignore
+  when /^Routes for /
+    break
+  when /^\s*(\w+) (#{verbs})\s+(\S+)\s+([\w\/]+#\w+)/ then
+    _, verb, path, action = $1, $2, $3, $4
+    path.sub!(/..:format./, '\\/?')
+    path.sub!(/:id/, '\\d+')
+    routes[/^#{verb} #{path}$/] = action.split(/#/).last
+  when /^\s*(GET|POST|PUT|PATCH|DELETE)\s+(\S+)\s+([\w\/]+#\w+)/ then
+    verb, path, action = $1, $2, $3
+    path.sub!(/..:format./, '')
+    path.sub!(/:id/, '\\d+')
+    routes[/^#{verb} #{path}$/] = action.split(/#/).last
+  else
+    # warn "unparsed: #{line.chomp}"
+  end
+end
+
+warn "NOTE: No logs provided. Scanning stdin." if ARGV.empty?
+
+ARGV.each do |path|
+  warn path
+  cmd = case path
+        when /\.gz$/ then
+          "gzcat"
+        when /\.bz2?$/ then
+          "bzcat"
+        else
+          "cat"
+        end
+
+  IO.popen [cmd, path] do |io|
+    io.each_line do |line|
+      $stderr.print "." if $. % 10_000 == 0
+      case line
+      when /Processing by (\w+)#(\w+) as/ then
+        _, action = $1, $2
+        puts action
+      when /Started (#{verbs}) \"([^"]+)\"/, /method=(#{verbs}) path="([^"]+)"/ then
+        verb, path = $1, $2
+
+        _, action = routes.find { |k,v| "#{verb} #{path}" =~ k }
+
+        puts action if action
+      else
+        # warn "unparsed: #{line.chomp}"
+      end
+    end
+  end
+end
+
+warn "done"

data/lib/debride.rb

@@ -19,7 +19,7 @@ end
 # A static code analyzer that points out possible dead methods.
 
 class Debride < MethodBasedSexpProcessor
-  VERSION = "1.4.0" # :nodoc:
+  VERSION = "1.5.0" # :nodoc:
   PROJECT = "debride"
 
   def self.expand_dirs_to_files *dirs # TODO: push back up to sexp_processor
@@ -100,7 +100,7 @@ class Debride < MethodBasedSexpProcessor
 
   def process_rb path_or_io
     begin
-      warn "processing: #{path}" if option[:verbose]
+      warn "Processing ruby: #{path_or_io}" if option[:verbose]
 
       case path_or_io
       when String then
@@ -147,6 +147,16 @@ class Debride < MethodBasedSexpProcessor
         options[:whitelist] = File.read(s).split(/\n+/) rescue []
       end
 
+      opts.on("-f", "--focus PATH", String, "Only report against this path") do |s|
+        unless File.exist? s then
+          abort "ERROR: --focus path #{s} doesn't exist."
+        end
+
+        s = "#{s.chomp "/"}/*" if File.directory?(s)
+
+        options[:focus] = s
+      end
+
       opts.on("-r", "--rails", "Add some rails call conversions.") do
         options[:rails] = true
       end
@@ -154,13 +164,18 @@ class Debride < MethodBasedSexpProcessor
       opts.on("-v", "--verbose", "Verbose. Show progress processing files.") do
         options[:verbose] = true
       end
-
-      opts.parse! args
     end
 
+    op.parse! args
+
     abort op.to_s if args.empty?
 
     options
+  rescue OptionParser::InvalidOption => e
+    warn op.to_s
+    warn ""
+    warn e.message
+    exit 1
   end
 
   ##
@@ -194,17 +209,111 @@ class Debride < MethodBasedSexpProcessor
     super.to_s
   end
 
-  def method_name # :nodoc:
-    super.to_s.sub(/^::|#/, "").to_sym
+  def plain_method_name # :nodoc:
+    method_name.to_s.sub(/^::|#/, "").to_sym
+  end
+
+  def process_attrasgn(sexp)
+    method_name = sexp[2]
+    method_name = method_name.last if Sexp === method_name
+    called << method_name
+    process_until_empty sexp
+    sexp
+  end
+
+  def record_method name, file, line
+    signature = "#{klass_name}##{name}"
+    method_locations[signature] = "#{file}:#{line}"
+    map[klass_name][name] = signature
+    known[name] << klass_name
+  end
+
+  def process_call sexp # :nodoc:
+    method_name = sexp[2]
+
+    case method_name
+    when :new then
+      method_name = :initialize
+    when :alias_method_chain then
+      # s(:call, nil, :alias_method_chain, s(:lit, :royale), s(:lit, :cheese))
+      _, _, _, (_, new_name), _ = sexp
+      if option[:rails] then
+        file, line = sexp.file, sexp.line
+        record_method new_name, file, line
+      end
+    when :attr_accessor then
+      # s(:call, nil, :attr_accessor, s(:lit, :a1), ...)
+      _, _, _, *args = sexp
+      file, line = sexp.file, sexp.line
+      args.each do |(_, name)|
+        record_method name, file, line
+        record_method "#{name}=".to_sym, file, line
+      end
+    when :attr_writer then
+      # s(:call, nil, :attr_writer, s(:lit, :w1), ...)
+      _, _, _, *args = sexp
+      file, line = sexp.file, sexp.line
+      args.each do |(_, name)|
+        record_method "#{name}=".to_sym, file, line
+      end
+    when :attr_reader then
+      # s(:call, nil, :attr_reader, s(:lit, :r1), ...)
+      _, _, _, *args = sexp
+      file, line = sexp.file, sexp.line
+      args.each do |(_, name)|
+        record_method name, file, line
+      end
+    when :send, :public_send, :__send__ then
+      # s(:call, s(:const, :Seattle), :send, s(:lit, :raining?))
+      _, _, _, msg_arg, * = sexp
+      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 /_path$/ then
+      method_name = method_name.to_s[0..-6].to_sym if option[:rails]
+    end
+
+    called << method_name
+
+    process_until_empty sexp
+
+    sexp
   end
 
   def process_cdecl exp # :nodoc:
     _, name, val = exp
     process val
 
-    map[klass_name][name] = "#{klass_name}::#{name}"
+    signature = "#{klass_name}::#{name}"
+    map[klass_name][name] = signature
     known[name] << klass_name
 
+    file, line = exp.file, exp.line
+    method_locations[signature] = "#{file}:#{line}"
+
     exp
   end
 
@@ -235,70 +344,20 @@ class Debride < MethodBasedSexpProcessor
 
   def process_defn sexp # :nodoc:
     super do
-      map[klass_name][method_name] = signature
-      known[method_name] << klass_name
+      map[klass_name][plain_method_name] = signature
+      known[plain_method_name] << klass_name
       process_until_empty sexp
     end
   end
 
   def process_defs sexp # :nodoc:
     super do
-      map[klass_name][method_name] = signature
-      known[method_name] << klass_name
+      map[klass_name][plain_method_name] = signature
+      known[plain_method_name] << klass_name
       process_until_empty sexp
     end
   end
 
-  def process_call sexp # :nodoc:
-    method_name = sexp[2]
-
-    case method_name
-    when :new then
-      method_name = :initialize
-    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
-
-    process_until_empty sexp
-
-    sexp
-  end
-
   ##
   # Calculate the difference between known methods and called methods.
 
@@ -338,14 +397,30 @@ class Debride < MethodBasedSexpProcessor
   # Print out a report of suspects.
 
   def report
+    focus = option[:focus]
+
+    if focus then
+      puts "Focusing on #{focus}"
+      puts
+    end
+
     puts "These methods MIGHT not be called:"
 
     missing.each do |klass, meths|
+      bad = meths.map { |meth|
+        location = method_locations[map[klass][meth]]
+        path = location[/(.+):\d+$/, 1]
+
+        next if focus and not File.fnmatch(focus, path)
+
+        "  %-35s %s" % [meth, location]
+      }
+      bad.compact!
+      next if bad.empty?
+
       puts
       puts klass
-      meths.each do |meth|
-        puts "  %-35s %s" % [meth, method_locations[map[klass][meth]]]
-      end
+      puts bad.join "\n"
     end
   end
 
@@ -374,6 +449,9 @@ class Debride < MethodBasedSexpProcessor
     :before_save,
     :before_update,
     :before_validation,
+
+    # http://api.rubyonrails.org/classes/ActiveModel/Validations/ClassMethods.html#method-i-validate
+    :validate,
   ]
 
   # http://api.rubyonrails.org/v4.2.1/classes/ActiveModel/Validations/HelperMethods.html

data/test/test_debride.rb

@@ -23,6 +23,7 @@ class TestDebride < Minitest::Test
     debride.process debride.process_rb io
 
     assert_equal exp, debride.missing
+    debride
   end
 
   def test_sanity
@@ -35,7 +36,9 @@ class TestDebride < Minitest::Test
     end
 
     exp = [["Debride",
-            [:process_call, :process_defn, :process_defs, :process_rb, :report]]]
+            [:process_attrasgn, :process_call, :process_cdecl, :process_colon2,
+             :process_colon3, :process_const, :process_defn, :process_defs,
+             :process_rb, :report]]]
 
     assert_equal exp, debride.missing
   end
@@ -65,6 +68,17 @@ class TestDebride < Minitest::Test
     assert_option %w[-e moot,moot.rb lib],   %w[lib], :exclude => %w[moot moot.rb]
   end
 
+  def test_parse_options_focus
+    assert_option %w[-f lib lib], %w[lib], :focus => "lib/*"
+    assert_option %w[--focus lib lib], %w[lib], :focus => "lib/*"
+
+    e = assert_raises RuntimeError do
+      assert_option %w[-f missing lib], %w[], :verbose => true
+    end
+
+    assert_includes e.message, "ERROR: --focus path missing doesn't exist."
+  end
+
   def test_parse_options_whitelist
     exp = File.readlines("Manifest.txt").map(&:chomp) # omg dumb
     assert_option %w[--whitelist Manifest.txt lib], %w[lib], :whitelist => exp
@@ -76,7 +90,9 @@ class TestDebride < Minitest::Test
     debride = Debride.run %w[--exclude test lib]
 
     exp = [["Debride",
-            [:process_call, :process_defn, :process_defs, :process_rb, :report]]]
+            [:process_attrasgn, :process_call, :process_cdecl, :process_colon2,
+             :process_colon3, :process_const, :process_defn, :process_defs,
+             :process_rb, :report]]]
 
     assert_equal exp, debride.missing
   end
@@ -199,12 +215,14 @@ class TestDebride < Minitest::Test
         def action_condition      ; 1 ; end
         def string_condition      ; 1 ; end
         def validation_condition  ; 1 ; end
+        def some_validation_method; 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
+        validate :some_validation_method
       end
     RUBY
 
@@ -230,4 +248,86 @@ class TestDebride < Minitest::Test
 
     assert_process [["Constants", [:UNUSED]]], ruby
   end
+
+  def test_attr_accessor
+    ruby = <<-RUBY.strip
+      class AttributeAccessor
+        attr_accessor :a1, :a2, :a3
+        attr_writer :w1, :w2
+        attr_reader :r1, :r2
+        def initialize
+          self.a2 = 'Bar'
+          self.w1 = 'W'
+        end
+      end
+
+      object = AttributeAccessor.new
+      object.a1
+      object.r1
+      object.a3 = 'Baz'
+    RUBY
+
+    d = assert_process [["AttributeAccessor", [:a1=, :a2, :a3, :r2, :w2=]]], ruby
+
+    exp = {
+           "AttributeAccessor" => {
+                                   :a1         => "AttributeAccessor#a1",
+                                   :a1=        => "AttributeAccessor#a1=",
+                                   :a2         => "AttributeAccessor#a2",
+                                   :a2=        => "AttributeAccessor#a2=",
+                                   :a3         => "AttributeAccessor#a3",
+                                   :a3=        => "AttributeAccessor#a3=",
+                                   :w1=        => "AttributeAccessor#w1=",
+                                   :w2=        => "AttributeAccessor#w2=",
+                                   :r1         => "AttributeAccessor#r1",
+                                   :r2         => "AttributeAccessor#r2",
+                                   :initialize => "AttributeAccessor#initialize"
+                                  }
+          }
+
+    assert_equal exp, d.map
+
+    exp = {
+           "AttributeAccessor#a1"         => "(io):2",
+           "AttributeAccessor#a1="        => "(io):2",
+           "AttributeAccessor#a2"         => "(io):2",
+           "AttributeAccessor#a2="        => "(io):2",
+           "AttributeAccessor#a3"         => "(io):2",
+           "AttributeAccessor#a3="        => "(io):2",
+           "AttributeAccessor#w1="        => "(io):3",
+           "AttributeAccessor#w2="        => "(io):3",
+           "AttributeAccessor#r1"         => "(io):4",
+           "AttributeAccessor#r2"         => "(io):4",
+           "AttributeAccessor#initialize" => "(io):5",
+          }
+
+    assert_equal exp, d.method_locations
+
+    out, err = capture_io do
+      d.report
+    end
+
+    assert_match(/AttributeAccessor/, out)
+    assert_match(/a1=/, out)
+    assert_empty err
+  end
+
+  def test_attr_accessor_with_hash_default_value
+    ruby = <<-RUBY.strip
+      class AttributeAccessor
+        attr_accessor :a1
+        def initialize(options = {})
+          self.a1 = options.fetch(:a1) { default_a1 }
+        end
+
+        def default_a1
+          'the default_a1'
+        end
+      end
+
+      object = AttributeAccessor.new
+    RUBY
+
+    assert_process [["AttributeAccessor", [:a1]]], ruby
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debride
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -29,7 +29,7 @@ cert_chain:
   xJcC6UN6NHMOVMyAXsr2HR0gRRx4ofN1LoP2KhXzSr8UMvQYlwPmE0N5GQv1b5AO
   VpzF30vNaJK6ZT7xlIsIlwmH
   -----END CERTIFICATE-----
-date: 2015-05-27 00:00:00.000000000 Z
+date: 2015-06-15 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.6'
+        version: '5.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '5.7'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,7 @@ email:
 - ryand-ruby@zenspider.com
 executables:
 - debride
+- debride_rails_whitelist
 extensions: []
 extra_rdoc_files:
 - History.rdoc
@@ -119,6 +120,7 @@ files:
 - README.rdoc
 - Rakefile
 - bin/debride
+- bin/debride_rails_whitelist
 - lib/debride.rb
 - test/test_debride.rb
 homepage: https://github.com/seattlerb/debride

metadata.gz.sig

@@ -1 +1 @@
-��S��m=X��?t]���<�8R�I��B�KC?ʓ�g����ʯ���1
+��Q����|�u�I;常EE�`��
}������,���0�Y_�O���S7a��
��N=IvaYMB��c/���1��0��l���̻N��oq�5u���g�-z���@k6�}