zombie_scout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd9585ab8fa23daa27c71cfc11fcf41ebc6a371c
+  data.tar.gz: dec2c2a121cc1fb3f3ab9bd9bafdccc1f865ad72
+SHA512:
+  metadata.gz: 43c329a1bdfd59df278b325ff65e1d9d879b9ee8dfa0e12195a5db39a63b516ef928e3ef8a7b0c5166f3e6e79e16612a05871d08d10709a81d2340514618eaf8
+  data.tar.gz: 1365f7a6b810c2ec97447d8efeb52d4c055f9f9a62dd688ba9587baa6308c11f365a7db9b0e2e1c73d078c9c47b8c6337d3bfb337097a97471ab596346ea538a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/.ruby-gemset

@@ -0,0 +1 @@
+zombie_scout

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.0

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'parser', '~> 2.1'
+gem 'thor', '~> 0.18'
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'fakefs', require: 'fakefs/safe'
+end
+

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (1.1.0)
+    diff-lcs (1.1.3)
+    fakefs (0.5.0)
+    parser (2.1.4)
+      ast (~> 1.1)
+      slop (~> 3.4, >= 3.4.5)
+    rake (10.1.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    slop (3.4.7)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakefs
+  parser (~> 2.1)
+  rake
+  rspec
+  thor (~> 0.18)

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,95 @@
+zombie_scout
+=============
+
+Find dead methods in your Ruby app
+
+**zom·bie code** *noun* Undead code that shambles around your repository, and
+eats your brains.
+
+You don't want zombie code around. But you can't spend all your time looking
+for it. So get yourself a Zombie Scout.
+
+Zombie Scout is light & quick. Its only tools are `parser` and `grep`.  It
+parses your code to find method declarations, and then greps through your
+project's source, looking for each method.  If Zombie Scout can't find any
+calls to a method, it presumes the method is dead, and reports back to you.
+
+### Fair Warning
+
+Zombie Scout isn't exhaustive or thorough - it's a scout, not a spy. (That
+could be another project, though - a Zombie Spy.)
+
+If you generate methods in a way that's hard to grep for...
+
+    method_name = ['s', 'e', 'c', 'r', 'e', 't']
+    object.send(method_name.join(''))
+
+...then Zombie Scout won't find it. Remember: light & quick.
+
+That said, it *will* find methods defined with `attr_reader` & friends, or
+`Forwardable` delegates, or Rails scopes.  Rails delegators are on the To-Do
+list.
+
+If you have methods that are used by another library - say, callbacks - Zombie
+Scout will probably think they're dead, because it's not looking at the source
+for that other library.
+
+Finally, if you have a method named after a common human-language word, and
+that word appears in (say) hard-coded strings or comments, Zombie Scout will
+think it's calling the method, and assume that the method is used.
+
+    # this is an awesome method!   <-- false positive right there
+    def awesome
+      'AWESOME!'
+    end
+
+Be wise.
+
+## Installation
+
+The basics:
+
+    gem install 'zombie_scout'
+
+Or, add this to your Gemfile:
+
+    gem 'zombie_scout', github: 'danbernier/zombie_scout'
+
+## Usage
+
+You can run it on a whole folder:
+
+    dan@aleph:~/projects/zombie_scout$ zombie_scout scout
+    Scouting out /home/dan/projects/zombie_scout!
+    lib/zombie_scout/method_finder.rb:23    on_def
+    lib/zombie_scout/method_finder.rb:29    on_defs
+    lib/zombie_scout/method_finder.rb:35    on_send
+    lib/zombie_scout/method_finder.rb:77    on_sym
+    Scouted 23 methods in 8 files. Found 4 potential zombies.
+
+(See what I meant about callbacks and false-positives?)
+
+Or you can run it on a given file or glob:
+
+    dan@aleph:~/projects/zombie_scout$ zombie_scout scout lib/zombie_scout.rb
+    Scouting out /home/dan/projects/zombie_scout!
+    Scouted 0 methods in 1 files. Found 0 potential zombies.
+
+## Code Status
+
+* [![Build Status](https://travis-ci.org/danbernier/zombie_scout.png?branch=master)](https://travis-ci.org/danbernier/zombie_scout)
+
+## TODOs
+
+* [x] parse for attr_reader/writer/accessors, & forwardables, & rails scopes
+* [ ] parse for rails delegators
+* [ ] let users configure: files to search for methods, files to search for calls...probably in `.zombie_scout`.
+
+ToThinkAbouts:
+* [ ] extract a hash-y report structure that can be used by whatever, from the default report
+* [ ] pass a method name, or a ruby class
+* [ ] rspec/mini-test drop-in tests that can be added easily, to fail your
+  build if the scout or spy finds dead code. (This is probably a bad idea.)
+
+Have ZombieScout make a hash-y report, & feed it to ZombieSpy, so the Spy knows where to focus.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/bin/zombie_scout

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby 
+require 'rubygems'
+require 'zombie_scout'
+
+ZombieScout::App.start(ARGV)

data/lib/zombie_scout/app.rb

@@ -0,0 +1,11 @@
+require 'thor'
+require 'zombie_scout/mission'
+
+module ZombieScout
+  class App < Thor
+    desc "scout", "scout for zombie code in current directory"
+    def scout(*globs)
+      Mission.new(globs).scout
+    end
+  end
+end

data/lib/zombie_scout/method_call_finder.rb

@@ -0,0 +1,29 @@
+module ZombieScout
+  class MethodCallFinder
+
+    def initialize(ruby_project)
+      @ruby_project = ruby_project
+    end
+
+    def count_calls(method_name)
+      method_name = method_name.to_s
+      method_name.sub!(/=$/, ' *=')
+      find_occurrances(method_name).size
+    end
+
+    private
+
+    def find_occurrances(method_name)
+      # TODO somehow expose some of this config for end-users
+      command = "grep -rnw --include=\"*.rb\" --include=\"*.erb\" --binary-files=without-match \"#{method_name}\" #{files_to_search} "
+      #  grep -r --include="*.rb" --include="*.erb" -nw PATTERN app lib
+
+      grep_lines = `#{command}`
+      grep_lines.split("\n")
+    end
+
+    def files_to_search
+      @ruby_project.folders.join(' ')
+    end
+  end
+end

data/lib/zombie_scout/method_finder.rb

@@ -0,0 +1,102 @@
+require 'parser/current'
+
+module ZombieScout
+  Method = Class.new(Struct.new(:name, :location))
+
+  class MethodFinder < Parser::AST::Processor
+    def initialize(ruby_source)
+      @ruby_source = ruby_source
+    end
+
+    def find_methods
+      @methods = []
+      @private_method_calls = []
+
+      node = Parser::CurrentRuby.parse(@ruby_source.source)
+      process(node)
+
+      @methods.reject { |method|
+        @private_method_calls.include?(method.name)
+      }
+    end
+
+    def on_def(node)
+      method_name, args, body = *node
+      stash_method(method_name, node)
+      process(body)
+    end
+
+    def on_defs(node)
+      self_node, method_name, args, body = *node
+      stash_method(method_name, node)
+      process(body)
+    end
+
+    def on_send(node)
+      receiver, method_name, *args = *node
+      if respond_to?(:"on_#{method_name}", true)
+        send(:"on_#{method_name}", args, node)
+      elsif receiver.nil?  # Then it's a private method call
+        @private_method_calls << method_name
+        process_all(args)
+      end
+    end
+
+    private
+
+    def on_attr_reader(args, node)
+      args.each do |arg|
+        attr_method_name = symbol(arg)
+        stash_method(attr_method_name, node)
+      end
+    end
+
+    def on_attr_writer(args, node)
+      args.each do |arg|
+        attr_method_name = symbol(arg)
+        stash_method(:"#{attr_method_name}=", node)
+      end
+    end
+
+    def on_attr_accessor(args, node)
+      args.each do |arg|
+        attr_method_name = symbol(arg)
+        stash_method(attr_method_name, node)
+        stash_method(:"#{attr_method_name}=", node)
+      end
+    end
+
+    def on_def_delegators(args, node)
+      args.drop(1).each do |arg|
+        attr_method_name = symbol(arg)
+        stash_method(attr_method_name, node)
+      end
+    end
+
+    def on_def_delegator(args, node)
+      attr_method_name = symbol(args.last)
+      stash_method(attr_method_name, node)
+    end
+
+    def on_scope(args, node)
+      attr_method_name = symbol(args.first)
+      stash_method(attr_method_name, node)
+    end
+
+    def symbol(node)
+      SymbolExtracter.new.process(node)
+    end
+
+    def stash_method(method_name, node)
+      line_number = node.location.line
+      location = [@ruby_source.path, line_number].join(":")
+      @methods << Method.new(method_name, location)
+    end
+  end
+
+  class SymbolExtracter < Parser::AST::Processor
+    def on_sym(node)
+      node.to_a[0]
+    end
+  end
+end

data/lib/zombie_scout/mission.rb

@@ -0,0 +1,43 @@
+require 'zombie_scout/ruby_project'
+require 'zombie_scout/method_finder'
+require 'zombie_scout/method_call_finder'
+
+module ZombieScout
+  class Mission
+    def initialize(globs)
+      puts "Scouting out #{Dir.pwd}!"
+      @ruby_project = RubyProject.new(*globs)
+    end
+
+    def scout
+      zombies.each do |zombie|
+        puts [zombie.location, zombie.name] * "\t"
+      end
+
+      puts "Scouted #{methods.size} methods in #{sources.size} files. Found #{zombies.size} potential zombies."
+    end
+
+    private
+
+    def zombies
+      @zombies ||= methods.select { |method|
+        might_be_dead?(method)
+      }
+    end
+
+    def methods
+      @methods ||= sources.map { |ruby_source|
+        MethodFinder.new(ruby_source).find_methods
+      }.flatten
+    end
+
+    def sources
+      @sources ||= @ruby_project.ruby_sources
+    end
+
+    def might_be_dead?(method)
+      @method_call_counter ||= MethodCallFinder.new(@ruby_project)
+      @method_call_counter.count_calls(method.name) < 2
+    end
+  end
+end

data/lib/zombie_scout/ruby_project.rb

@@ -0,0 +1,39 @@
+require 'zombie_scout/ruby_source'
+require 'pathname'
+
+module ZombieScout
+  class RubyProject
+
+    def initialize(*globs)
+      @globs = globs
+      @globs = %w[app config lib] if @globs.empty?
+    end
+
+    def ruby_sources
+      ruby_file_paths.map { |path| RubySource.new(path) }
+    end
+
+    def ruby_file_paths
+      globs.map { |glob| Dir.glob(glob) }.flatten.map { |path|
+        path.sub(/^\//, '')
+      }
+    end
+
+    def globs
+      pathnames = @globs.map { |g| Pathname.new(g) }
+      pathnames.map { |pathname|
+        if pathname.directory?
+          "#{pathname}/**/*.rb"
+        else
+          pathname.to_s
+        end
+      }
+    end
+
+    def folders  # TODO this is only called from Mission...weird?
+      %w[app config lib].select { |folder|
+        Dir.exist?(folder)
+      }
+    end
+  end
+end

data/lib/zombie_scout/ruby_source.rb

@@ -0,0 +1,13 @@
+module ZombieScout
+  class RubySource
+    def initialize(filename)
+      @path = filename
+    end
+
+    attr_reader :path
+
+    def source
+      @source ||= File.read(path)
+    end
+  end
+end

data/lib/zombie_scout/version.rb

@@ -0,0 +1,3 @@
+module ZombieScout
+  VERSION = "0.0.1"
+end

data/lib/zombie_scout.rb

@@ -0,0 +1 @@
+require 'zombie_scout/app'

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'fakefs/spec_helpers'

data/spec/zombie_scout/method_finder_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+require 'zombie_scout/method_finder'
+
+describe ZombieScout::MethodFinder, '#find_methods' do
+  let(:ruby_source) {
+    double(:ruby_source, path: 'lib/fizzbuzz.rb', source: ruby_code)
+  }
+  let(:zombies) {
+    ZombieScout::MethodFinder.new(ruby_source).find_methods.sort_by(&:name)
+  }
+
+  context 'when a ruby file has instance or class methods' do
+    let(:ruby_code) {
+      "class FizzBuzz
+         def fizz
+           'plop plop'
+         end
+
+         def self.buzz
+           'bzz bzz bzz'
+         end
+       end"
+    }
+
+    it 'can find the methods' do
+      expect(zombies[0].name).to eq :buzz
+      expect(zombies[0].location).to eq 'lib/fizzbuzz.rb:6'
+
+      expect(zombies[1].name).to eq :fizz
+      expect(zombies[1].location).to eq 'lib/fizzbuzz.rb:2'
+    end
+  end
+
+  context 'when a ruby file has attr_readers' do
+    let(:ruby_code) { 
+      "class Book
+         attr_reader :title, :author
+       end"
+    }
+
+    it 'can find attr_readers' do
+      expect(zombies.map(&:name)).to eq(%i[author title])
+    end
+  end
+
+  context 'when a ruby file has attr_writers' do
+    let(:ruby_code) { 
+      "class Book
+         attr_writer :title, :author
+       end"
+    }
+    it 'can find attr_writers' do
+      expect(zombies.map(&:name)).to eq(%i[author= title=])
+    end
+  end
+
+  context 'when a ruby file has attr_accessors' do
+    let(:ruby_code) {
+      "class Book
+         attr_accessor :title, :author
+       end"
+    }
+    it 'can find attr_accessors' do
+      expect(zombies.map(&:name)).to eq(%i[author author= title title=])
+    end
+  end
+
+  context 'when a ruby file uses Forwardable::def_delegator' do
+    let(:ruby_code) { 
+      "class RecordCollection
+         extend Forwardable
+         def_delegator :@records, :[], :record_number
+       end"
+    }
+    it 'can find methods created by def_delegator' do
+      expect(zombies.map(&:name)).to match_array([:record_number])
+    end
+  end
+
+  context 'when a ruby file uses Forwardable::def_delegators' do
+    let(:ruby_code) {
+      "class RecordCollection
+         extend Forwardable
+         def_delegators :@records, :size, :<<, :map
+       end"
+    }
+    it 'can find methods created by def_delegators' do
+      expect(zombies.map(&:name)).to eq(%i[<< map size])
+    end
+  end
+
+  context 'when a rails model has scopes' do
+    let(:ruby_code) {
+      "class Post
+         scope :published, -> { where(published: true) }
+         scope :draft, -> { where(published: true) }
+       end"
+    }
+    it 'can find scopes' do
+      expect(zombies.map(&:name)).to eq(%i[draft published])
+    end
+  end
+
+  context 'when a ruby file has private methods' do
+    let(:ruby_code) {
+      "class FizzBuzz
+         def fizz
+           magick_helper
+         end
+
+         private
+         def magick_helper
+           'magick sauce'
+         end
+      end"
+    }
+    it 'excludes private method calls, since we KNOW they are called' do
+      expect(zombies.map(&:name)).to match_array([:fizz])
+      expect(zombies.map(&:name)).not_to include :magick_helper
+    end
+  end
+end

data/spec/zombie_scout/ruby_project_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+require 'zombie_scout/ruby_project'
+
+describe ZombieScout::RubyProject, '#globs' do
+  include FakeFS::SpecHelpers
+  before do
+    FileUtils.mkdir('lib')
+    FileUtils.touch('lib/app.rb')
+  end
+
+  context 'when given a dirname' do
+    it 'appends **/*.rb' do
+      project = ZombieScout::RubyProject.new('lib')
+      expect(project.globs).to eq ['lib/**/*.rb']
+    end
+  end
+
+  context 'when given a globs' do
+    it 'leaves it alone' do
+      project = ZombieScout::RubyProject.new('lib/*.rb')
+      expect(project.globs).to eq ['lib/*.rb']
+    end
+  end
+
+  context 'when given a file path' do
+    it 'leaves it alone' do
+      project = ZombieScout::RubyProject.new('lib/app.rb')
+      expect(project.globs).to eq ['lib/app.rb']
+    end
+  end
+end
+
+describe ZombieScout::RubyProject, '#ruby_sources' do
+  include FakeFS::SpecHelpers
+
+  def touch(path)
+    FileUtils.mkdir_p(File.dirname(path))
+    FileUtils.touch(path)
+  end
+
+  context 'in a normal ruby project' do
+    let(:files) do
+      [
+        'lib/ironman/jarvis.rb',
+        'lib/ironman/suit.rb',
+        'lib/hulk/green/smash.rb',
+        'spec/ironman/jarvis_spec.rb',
+        'test/ironman/test_suit.rb'
+      ]
+    end
+    before do
+      files.each do |file|
+        touch(file)
+      end
+    end
+
+    context 'without globs' do
+      it 'returns a RubySource for each *.rb under the lib dir' do
+        sources = ZombieScout::RubyProject.new.ruby_sources
+        expect(sources.map(&:path).sort).to eq [
+          'lib/hulk/green/smash.rb',
+          'lib/ironman/jarvis.rb',
+          'lib/ironman/suit.rb',
+        ]
+      end
+    end
+
+    context 'with globs' do
+      it 'returns a RubySource for each *.rb matching the globs' do
+        sources = ZombieScout::RubyProject.new('lib/**/jarv*').ruby_sources
+        expect(sources.map(&:path)).to eq [
+          'lib/ironman/jarvis.rb'
+        ]
+      end
+    end
+
+    context 'with directory names' do
+      it 'returns a RubySource for each *.rb (recursively) in the dir' do
+        sources = ZombieScout::RubyProject.new('lib/hulk').ruby_sources
+        expect(sources.map(&:path)).to eq [
+          'lib/hulk/green/smash.rb'
+        ]
+      end
+    end
+  end
+
+  context 'in a rails project' do
+    it 'returns a RubySource for each *.rb under app, config, & lib' do
+      files = [
+        'app/models/suit.rb',
+        'app/controllers/suits_controller.rb',
+        'config/initializers/extensions.rb',
+        'spec/views/suit_view_spec.rb',
+        'test/models/test_suit.rb'
+      ]
+
+      files.each { |file| touch(file) }
+
+      sources = ZombieScout::RubyProject.new.ruby_sources
+      expect(sources.map(&:path).sort).to eq [
+        'app/controllers/suits_controller.rb',
+        'app/models/suit.rb',
+        'config/initializers/extensions.rb'
+      ]
+    end
+  end
+end

data/spec/zombie_scout/ruby_source_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'zombie_scout/ruby_source'
+
+describe ZombieScout::RubySource do
+  include FakeFS::SpecHelpers
+
+  let(:ruby_code) do
+    "
+    class RubyCode
+      def awesome?
+        true
+      end
+    end
+    "
+  end
+
+  let(:filename) { 'ruby_code.rb' }
+
+  subject do
+    File.open(filename, 'w') { |f| f << ruby_code }
+    ZombieScout::RubySource.new(filename)
+  end
+
+  its(:path) { should eq(filename) }
+  its(:source) { should eq(ruby_code) }
+end

data/zombie_scout.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zombie_scout/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'zombie_scout'
+  s.version     = ZombieScout::VERSION
+  s.date        = Date.today.to_s
+
+  s.summary     = "Find dead methods in your Ruby app"
+  s.description = "
+      zombie_scout finds methods in classes in your ruby project, 
+      and then searches for calls to them, and tells you which ones 
+      are never called.".strip.gsub(/^\s*/, '')
+  s.homepage    = 'https://github.com/danbernier/zombie_scout'
+  s.license     = 'ASL2'
+      
+  s.authors     = ["Dan Bernier"]
+  s.email       = ['danbernier@gmail.com']
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency('parser', '~> 2.1')
+  s.add_dependency('thor', '~> 0.18')
+  s.add_development_dependency "bundler", "~> 1.5"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: zombie_scout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Bernier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: "zombie_scout finds methods in classes in your ruby project, \nand then
+  searches for calls to them, and tells you which ones \nare never called."
+email:
+- danbernier@gmail.com
+executables:
+- zombie_scout
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/zombie_scout
+- lib/zombie_scout.rb
+- lib/zombie_scout/app.rb
+- lib/zombie_scout/method_call_finder.rb
+- lib/zombie_scout/method_finder.rb
+- lib/zombie_scout/mission.rb
+- lib/zombie_scout/ruby_project.rb
+- lib/zombie_scout/ruby_source.rb
+- lib/zombie_scout/version.rb
+- spec/spec_helper.rb
+- spec/zombie_scout/method_finder_spec.rb
+- spec/zombie_scout/ruby_project_spec.rb
+- spec/zombie_scout/ruby_source_spec.rb
+- zombie_scout.gemspec
+homepage: https://github.com/danbernier/zombie_scout
+licenses:
+- ASL2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Find dead methods in your Ruby app
+test_files:
+- spec/spec_helper.rb
+- spec/zombie_scout/method_finder_spec.rb
+- spec/zombie_scout/ruby_project_spec.rb
+- spec/zombie_scout/ruby_source_spec.rb