debride 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6abab211f7ada7517c61d2ed301cc1b9762d435d
+  data.tar.gz: c2b904f36e9275028ad3966b74ce9fb53ca9d639
+SHA512:
+  metadata.gz: ba06f6b5951e6094f242191706c9f1fbe6de90ae609bdd869ce0560eb3d7c855f1164cdfc62602feb55e2c87d8596181469eb81c2761350ad65a94c85f08850d
+  data.tar.gz: df82696ec8ffcf55b1b2ad0985a31ab211909ec977ef983329d4cab824ce6164aa3f1b2834085c57f8ad8565868c53bfbdbcc6e5fa0cd83fe69f276a79531890

data/.autotest

@@ -0,0 +1,26 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = "minitest/autorun"
+  at.add_exception "tmp"
+
+  # at.extra_files << "../some/external/dependency.rb"
+  #
+  # at.libs << ":../some/external"
+  #
+  # at.add_exception "vendor"
+  #
+  # at.add_mapping(/dependency.rb/) do |f, _|
+  #   at.files_matching(/test_.*rb$/)
+  # end
+  #
+  # %w(TestA TestB).each do |klass|
+  #   at.extra_class_map[klass] = "test/test_misc.rb"
+  # end
+end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2015-03-09
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bin/debride
+lib/debride.rb
+test/test_debride.rb

data/README.rdoc

@@ -0,0 +1,56 @@
+= debride
+
+home :: https://github.com/seattlerb/debride
+rdoc :: http://docs.seattlerb.org/debride
+
+== DESCRIPTION:
+
+Analyze code for potentially uncalled / dead methods.
+
+== FEATURES/PROBLEMS:
+
+* Static analysis of code. Can be easily hooked up to a CI.
+* As with all static analysis tools of dynamic languages, can't be 100%.
+
+== SYNOPSIS:
+
+  % debride lib test
+
+  These methods MIGHT not be called:
+
+  MyClass
+    method!                            lib/some/file.rb:16
+  ...
+
+== REQUIREMENTS:
+
+* ruby 1.8+
+
+== INSTALL:
+
+* sudo gem install debride
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) Ryan Davis, seattle.rb
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require "rubygems"
+require "hoe"
+
+Hoe.plugin :isolate
+Hoe.plugin :seattlerb
+Hoe.plugin :rdoc
+
+Hoe.spec "debride" do
+  developer "Ryan Davis", "ryand-ruby@zenspider.com"
+  license "MIT"
+
+  dependency "sexp_processor", "~> 4.4"
+  dependency "ruby_parser", "~> 3.6"
+end
+
+# vim: syntax=ruby

data/bin/debride

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "debride"
+
+Debride.run(ARGV).report

data/lib/debride.rb

@@ -0,0 +1,167 @@
+#!/usr/bin/ruby -w
+
+$:.unshift "../../sexp_processor/dev/lib"
+
+require "ruby_parser"
+require "sexp_processor"
+require "optparse"
+require "set"
+
+##
+# A static code analyzer that points out possible dead methods.
+
+class Debride < MethodBasedSexpProcessor
+  VERSION = "1.0.0" # :nodoc:
+
+  ##
+  # Top level runner for bin/debride.
+
+  def self.run args
+    opt = parse_options args
+
+    callers = Debride.new opt
+
+    expand_dirs_to_files(args).each do |path|
+      warn "processing: #{path}" if opt[:verbose]
+      parser = RubyParser.new
+      callers.process parser.process File.read(path), path
+    end
+
+    callers
+  end
+
+  ##
+  # Parse command line options and return a hash of parsed option values.
+
+  def self.parse_options args
+    options = {}
+
+    OptionParser.new do |opts|
+      opts.banner  = "debride [options] files_or_dirs"
+      opts.version = Debride::VERSION
+
+      opts.separator ""
+      opts.separator "Specific options:"
+      opts.separator ""
+
+      opts.on("-h", "--help", "Display this help.") do
+        puts opts
+        exit
+      end
+
+      # opts.on("-e", "--exclude FILE", String, "Exclude these messages.") do |s|
+      #   options[:exclude] = s
+      # end
+
+      opts.on("-v", "--verbose", "Verbose. Show progress processing files.") do
+        options[:verbose] = true
+      end
+
+      opts.parse! args
+    end
+
+    options
+  end
+
+  ##
+  # A collection of know methods, mapping method name to implementing classes.
+
+  attr_accessor :known
+
+  ##
+  # A set of called method names.
+
+  attr_accessor :called
+
+  ##
+  # Command-line options.
+
+  attr_accessor :option
+  attr_accessor :map # :nodoc: # TODO: retire and use method_locations
+
+  ##
+  # Create a new Debride instance w/ +options+
+
+  def initialize options = {}
+    self.option = options
+    self.known  = Hash.new { |h,k| h[k] = Set.new }
+    self.called = Set.new
+    self.map    = Hash.new { |h,k| h[k] = {} }
+    super()
+  end
+
+  def klass_name # :nodoc:
+    super.to_s
+  end
+
+  def method_name # :nodoc:
+    super.to_s.sub(/^::|#/, "").to_sym
+  end
+
+  def process_defn sexp # :nodoc:
+    super do
+      map[klass_name][method_name] = signature
+      known[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
+      process_until_empty sexp
+    end
+  end
+
+  def process_call sexp # :nodoc:
+    method_name = sexp[2]
+    method_name = :initialize if method_name == :new
+
+    if method_name == :alias_method_chain
+      known[sexp[3]] << klass_name
+    end
+
+    called << method_name
+
+    process_until_empty sexp
+
+    sexp
+  end
+
+  ##
+  # Calculate the difference between known methods and called methods.
+
+  def missing
+    not_called = known.keys - called.to_a
+
+    by_class = Hash.new { |h,k| h[k] = [] }
+
+    not_called.each do |meth|
+      known[meth].each do |klass|
+        by_class[klass] << meth
+      end
+    end
+
+    by_class.each do |klass, meths|
+      by_class[klass] = meths.sort_by(&:to_s)
+    end
+
+    by_class.sort_by { |k,v| k }
+  end
+
+  ##
+  # Print out a report of suspects.
+
+  def report
+    puts "These methods MIGHT not be called:"
+
+    missing.each do |klass, meths|
+      puts
+      puts klass
+      meths.each do |meth|
+        puts "  %-35s %s" % [meth, method_locations[map[klass][meth]]]
+      end
+    end
+  end
+end

data/test/test_debride.rb

@@ -0,0 +1,38 @@
+require "minitest/autorun"
+require "debride"
+
+class TestDebride < Minitest::Test
+  def test_sanity
+    debride = nil
+
+    assert_silent do
+      debride = Debride.run %w[lib]
+    end
+
+    exp = [["Debride",
+            [:process_call, :process_defn, :process_defs, :report, :run]]]
+
+    assert_equal exp, debride.missing
+  end
+
+  def assert_option arg, rest, exp_opt
+    opt = Debride.parse_options arg
+
+    assert_equal exp_opt, opt
+    assert_equal rest, arg
+  end
+
+  def test_parse_options
+    assert_option %w[], %w[], {}
+
+    assert_option %w[--verbose],  %w[],        :verbose => true
+    assert_option %w[-v],         %w[],        :verbose => true
+    assert_option %w[-v woot.rb], %w[woot.rb], :verbose => true
+  end
+
+  def test_parse_options_exclude
+    skip "not yet"
+
+    assert_option %w[--exclude path], %w[], :exclude => "path"
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: debride
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Davis
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDPjCCAiagAwIBAgIBAjANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
+  GRYDY29tMB4XDTE0MDkxNzIzMDcwN1oXDTE1MDkxNzIzMDcwN1owRTETMBEGA1UE
+  AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
+  JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
+  b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
+  taCPaLmfYIaFcHHCSY4hYDJijRQkLxPeB3xbOfzfLoBDbjvx5JxgJxUjmGa7xhcT
+  oOvjtt5P8+GSK9zLzxQP0gVLS/D0FmoE44XuDr3iQkVS2ujU5zZL84mMNqNB1znh
+  GiadM9GHRaDiaxuX0cIUBj19T01mVE2iymf9I6bEsiayK/n6QujtyCbTWsAS9Rqt
+  qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
+  gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
+  HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
+  AQAFoDJRokCQdxFfOrmsKX41KOFlU/zjrbDVM9hgB/Ur999M6OXGSi8FitXNtMwY
+  FVjsiAPeU7HaWVVcZkj6IhINelTkXsxgGz/qCzjHy3iUMuZWw36cS0fiWJ5rvH+e
+  hD7uXxJSFuyf1riDGI1aeWbQ74WMwvNstOxLUMiV5a1fzBhlxPqb537ubDjq/M/h
+  zPUFPVYeL5KjDHLCqI2FwIk2sEMOQgjpXHzl+3NlD2LUgUhHDMevmgVua0e2GT1B
+  xJcC6UN6NHMOVMyAXsr2HR0gRRx4ofN1LoP2KhXzSr8UMvQYlwPmE0N5GQv1b5AO
+  VpzF30vNaJK6ZT7xlIsIlwmH
+  -----END CERTIFICATE-----
+date: 2015-03-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.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !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.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Analyze code for potentially uncalled / dead methods.
+email:
+- ryand-ruby@zenspider.com
+executables:
+- debride
+extensions: []
+extra_rdoc_files:
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+files:
+- .autotest
+- .gemtest
+- History.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/debride
+- lib/debride.rb
+- test/test_debride.rb
+homepage: https://github.com/seattlerb/debride
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --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
+signing_key: 
+specification_version: 4
+summary: Analyze code for potentially uncalled / dead methods.
+test_files: []