zombie_scout 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1d48e23ce3d846d2a1bb64d2c5a698386a7ccbb
-  data.tar.gz: dec98dc4fcf229576c71c080c00e4a24e1afa7d1
+  metadata.gz: 3017624103d8c386a942a3653769d1e62b93175e
+  data.tar.gz: 4051fd1c51e9626ff04846945c7d9d22a58b4788
 SHA512:
-  metadata.gz: 989aedb17a61b6aa6dc899a3b9426117dc771fece220a5fb1505d5b21b36e40dde5a06af2e17a424e438fffb212b765e4500aa227f3bec11c9350081ab6e1d91
-  data.tar.gz: 973b0f339bbfef34d128924df0d66902be6c929ac96c617516f230c28c7b2ebce8761026376a11cb6b5efcf104a22a914574bbf62e24fb5c4c4c03d9ebf810e5
+  metadata.gz: 0bee3360ff18f1c4363d605612a0b48f574b8390607ee975f51a84cab76f9544bf6334429d6133f770ef97ea179ee5349760edbb3d55e0a6adb66f2260283354
+  data.tar.gz: 49dec6d09b9d3f62538a93072bd6a6cf3619a2c1366b778154a2a0b4a20f68fab4557854a966c6cb895bbfb632e2b6cb177de168fe14caaf52caa4abff8e70c1

data/README.md

@@ -81,20 +81,22 @@ Or, add this to your Gemfile:
 You can run it on a whole folder:
 
     dan@aleph:~/projects/zombie_scout$ zombie_scout scout
-    Scouted 43 methods in 9 files, in 1.096459054 seconds.
-    Found 11 potential zombies, with a combined flog score of 51.5.
-
-    lib/zombie_scout/parser.rb:29   on_send 8.3
-    lib/zombie_scout/parser.rb:23   on_defs 5.9
-    lib/zombie_scout/parser.rb:65   handle_def_delegators   5.8
-    lib/zombie_scout/parser.rb:56   handle_attr_accessor    5.6
-    lib/zombie_scout/parser.rb:17   on_def  4.9
-    lib/zombie_scout/parser.rb:48   handle_attr_writer      4.3
-    lib/zombie_scout/parser.rb:40   handle_attr_reader      4.3
-    lib/zombie_scout/parser.rb:73   handle_def_delegator    3.8
-    lib/zombie_scout/parser.rb:79   handle_scope    3.8
-    lib/zombie_scout/parser.rb:100  on_sym  2.4
-    lib/zombie_scout/mission.rb:34  zombie_count    2.4
+    Scouted 48 methods in 10 files, in 1.470468836 seconds.
+    Found 13 potential zombies, with a combined flog score of 66.9.
+
+    lib/zombie_scout/parser.rb:45   ZombieScout::Parser#on_send     8.3
+    lib/zombie_scout/parser.rb:17   ZombieScout::Parser#on_class    7.9
+    lib/zombie_scout/parser.rb:25   ZombieScout::Parser#on_module   7.2
+    lib/zombie_scout/parser.rb:39   ZombieScout::Parser#on_defs     5.9
+    lib/zombie_scout/parser.rb:81   ZombieScout::Parser#handle_def_delegators       5.8
+    lib/zombie_scout/parser.rb:72   ZombieScout::Parser#handle_attr_accessor        5.6
+    lib/zombie_scout/parser.rb:33   ZombieScout::Parser#on_def      4.9
+    lib/zombie_scout/parser.rb:56   ZombieScout::Parser#handle_attr_reader  4.3
+    lib/zombie_scout/parser.rb:64   ZombieScout::Parser#handle_attr_writer  4.3
+    lib/zombie_scout/parser.rb:89   ZombieScout::Parser#handle_def_delegator        3.8
+    lib/zombie_scout/parser.rb:95   ZombieScout::Parser#handle_scope        3.8
+    lib/zombie_scout/parser.rb:122  ZombieScout::ConstExtracter#on_const    2.7
+    lib/zombie_scout/parser.rb:116  ZombieScout::SymbolExtracter#on_sym     2.4
 
 (See what I meant about callbacks and false-positives?)
 
@@ -108,17 +110,19 @@ ZombieScout will also report in CSV, if you like:
 
     dan@aleph:~/projects/zombie_scout$ zombie_scout scout --format csv
     location,name,flog_score
-    lib/zombie_scout/parser.rb:29,on_send,8.3
-    lib/zombie_scout/parser.rb:23,on_defs,5.9
-    lib/zombie_scout/parser.rb:65,handle_def_delegators,5.8
-    lib/zombie_scout/parser.rb:56,handle_attr_accessor,5.6
-    lib/zombie_scout/parser.rb:17,on_def,4.9
-    lib/zombie_scout/parser.rb:48,handle_attr_writer,4.3
-    lib/zombie_scout/parser.rb:40,handle_attr_reader,4.3
-    lib/zombie_scout/parser.rb:73,handle_def_delegator,3.8
-    lib/zombie_scout/parser.rb:79,handle_scope,3.8
-    lib/zombie_scout/parser.rb:100,on_sym,2.4
-    lib/zombie_scout/mission.rb:34,zombie_count,2.4
+    lib/zombie_scout/parser.rb:45,ZombieScout::Parser#on_send,8.3
+    lib/zombie_scout/parser.rb:17,ZombieScout::Parser#on_class,7.9
+    lib/zombie_scout/parser.rb:25,ZombieScout::Parser#on_module,7.2
+    lib/zombie_scout/parser.rb:39,ZombieScout::Parser#on_defs,5.9
+    lib/zombie_scout/parser.rb:81,ZombieScout::Parser#handle_def_delegators,5.8
+    lib/zombie_scout/parser.rb:72,ZombieScout::Parser#handle_attr_accessor,5.6
+    lib/zombie_scout/parser.rb:33,ZombieScout::Parser#on_def,4.9
+    lib/zombie_scout/parser.rb:56,ZombieScout::Parser#handle_attr_reader,4.3
+    lib/zombie_scout/parser.rb:64,ZombieScout::Parser#handle_attr_writer,4.3
+    lib/zombie_scout/parser.rb:89,ZombieScout::Parser#handle_def_delegator,3.8
+    lib/zombie_scout/parser.rb:95,ZombieScout::Parser#handle_scope,3.8
+    lib/zombie_scout/parser.rb:122,ZombieScout::ConstExtracter#on_const,2.7
+    lib/zombie_scout/parser.rb:116,ZombieScout::SymbolExtracter#on_sym,2.4
 
 ### In Ruby
 
@@ -131,14 +135,20 @@ thing:
      => true
     irb> > pp ZombieScout::Mission.new('.').scout
     [{:location=>"./lib/zombie_scout/parser.rb:17",
+      :file_path=>"./lib/zombie_scout/parser.rb",
+      :name=>:on_class,
+      :full_name=>"ZombieScout::Parser#on_class",
+      :flog_score=>7.9},
+     {:location=>"./lib/zombie_scout/parser.rb:25",
+      :file_path=>"./lib/zombie_scout/parser.rb",
+      :name=>:on_module,
+      :full_name=>"ZombieScout::Parser#on_module",
+      :flog_score=>7.2},
+     {:location=>"./lib/zombie_scout/parser.rb:33",
+      :file_path=>"./lib/zombie_scout/parser.rb",
       :name=>:on_def,
-      :flog_score=>4.9},
-     {:location=>"./lib/zombie_scout/parser.rb:23",
-      :name=>:on_defs,
-      :flog_score=>5.9},
-     {:location=>"./lib/zombie_scout/parser.rb:29",
-      :name=>:on_send,
-      :flog_score=>8.3}, ...]
+      :full_name=>"ZombieScout::Parser#on_def",
+      :flog_score=>4.9}, ...]
 
 ## Code Status
 
@@ -150,6 +160,7 @@ thing:
 * [ ] parse for rails delegators
 * [ ] let users configure: files to search for methods, files to search for calls...probably in `.zombie_scout`.
 * [x] option for CSV output
+* [ ] if 2 classes have a method w/ the same name, you can't tell (right now, easily) whether it's dead - so don't grep for it.
 
 ToThinkAbouts:
 * [x] extract a hash-y report structure that can be used by whatever, from the default report

data/lib/zombie_scout/app.rb

@@ -4,27 +4,27 @@ require 'zombie_scout/mission'
 module ZombieScout
   class App < Thor
     desc "scout", "scout for zombie code in current directory"
-    option :format, default: 'report'
+    option :format, enum: %w(report csv), default: 'report'
     def scout(*globs)
       mission = Mission.new(globs)
-      report = mission.scout.sort_by { |z| -z[:flog_score] }
+      report = mission.scout.sort_by { |z| [z[:file_path], -z[:flog_score]] }
 
       if options[:format] == 'report'
         total_flog_score = report.map { |z| z[:flog_score] }.reduce(0, :+)
 
         puts "Scouted #{mission.defined_method_count} methods in #{mission.source_count} files, in #{mission.duration} seconds."
-        puts "Found #{report.size} potential zombies, with a combined flog score of #{total_flog_score.round(1)}."
+        puts "Found #{mission.zombie_count} potential zombies, with a combined flog score of #{total_flog_score.round(1)}."
         puts
 
         report.each do |zombie|
-          puts [zombie[:location], zombie[:name], zombie[:flog_score]] * "\t"
+          puts [zombie[:location], zombie[:full_name], zombie[:flog_score]] * "\t"
         end
       elsif options[:format] == 'csv'
         require 'csv'
         CSV do |csv|
           csv << %w(location name flog_score)
           report.each do |zombie|
-            csv << [zombie[:location], zombie[:name], zombie[:flog_score]]
+            csv << [zombie[:location], zombie[:full_name], zombie[:flog_score]]
           end
         end
       end

data/lib/zombie_scout/method.rb

@@ -0,0 +1,11 @@
+module ZombieScout
+  class Method < Struct.new(:name, :class_name, :file_path, :line_number)
+    def full_name
+      [class_name, '#', name].join('')
+    end
+
+    def location
+      [file_path, line_number].join(':')
+    end
+  end
+end

data/lib/zombie_scout/mission.rb

@@ -15,7 +15,9 @@ module ZombieScout
       @start_time = Time.now
       zombies.map { |zombie|
         { location: zombie.location,
+          file_path: zombie.file_path,
           name: zombie.name,
+          full_name: zombie.full_name,
           flog_score: flog_score(zombie.location)
         }
       }.tap {

data/lib/zombie_scout/parser.rb

@@ -1,8 +1,7 @@
 require 'parser/current'
+require 'zombie_scout/method'
 
 module ZombieScout
-  Method = Class.new(Struct.new(:name, :location))
-
   class Parser < Parser::AST::Processor
     attr_reader :defined_methods, :called_methods
 
@@ -10,10 +9,27 @@ module ZombieScout
       @ruby_source = ruby_source
       @defined_methods = []
       @called_methods = []
+      @class_module_stack = []
       node = ::Parser::CurrentRuby.parse(@ruby_source.source)
       process(node)
     end
 
+    def on_class(node)
+      classname_const, superclass, body = *node
+      classname = ConstExtracter.new.process(classname_const)
+      @class_module_stack.push(classname)
+      process(body)
+      @class_module_stack.pop
+    end
+
+    def on_module(node)
+      modulename_const, body = *node
+      modulename = ConstExtracter.new.process(modulename_const)
+      @class_module_stack.push(modulename)
+      process(body)
+      @class_module_stack.pop
+    end
+
     def on_def(node)
       method_name, args, body = *node
       stash_method(method_name, node)
@@ -91,8 +107,8 @@ module ZombieScout
 
     def stash_method(method_name, node)
       line_number = node.location.line
-      location = [@ruby_source.path, line_number].join(":")
-      @defined_methods << Method.new(method_name, location)
+      class_name = @class_module_stack.join('::')
+      @defined_methods << Method.new(method_name, class_name, @ruby_source.path, line_number)
     end
   end
 
@@ -101,4 +117,10 @@ module ZombieScout
       node.to_a[0]
     end
   end
+
+  class ConstExtracter < ::Parser::AST::Processor
+    def on_const(node)
+      node.to_a[1]
+    end
+  end
 end

data/lib/zombie_scout/version.rb

@@ -1,3 +1,3 @@
 module ZombieScout
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/zombie_scout/parser_spec.rb

@@ -2,8 +2,9 @@ require 'spec_helper'
 require 'zombie_scout/parser'
 
 describe ZombieScout::Parser do
+  let(:file_name) { 'lib/fizzbuzz.rb' }
   let(:ruby_source) {
-    double(:ruby_source, path: 'lib/fizzbuzz.rb', source: ruby_code)
+    double(:ruby_source, path: file_name, source: ruby_code)
   }
 
   describe '#called_methods' do
@@ -32,31 +33,86 @@ describe ZombieScout::Parser do
     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"
+           def fizz
+             'plop plop'
+           end
+
+           def self.buzz
+             'bzz bzz bzz'
+           end
+         end"
       }
 
-      it 'can find the methods' do
+      it 'can find the methods, and the class and file they belong to' do
+        expect(defined_methods.size).to eq 2
+
         expect(defined_methods[0].name).to eq :buzz
+        expect(defined_methods[0].full_name).to eq 'FizzBuzz#buzz'
         expect(defined_methods[0].location).to eq 'lib/fizzbuzz.rb:6'
 
         expect(defined_methods[1].name).to eq :fizz
+        expect(defined_methods[1].full_name).to eq 'FizzBuzz#fizz'
         expect(defined_methods[1].location).to eq 'lib/fizzbuzz.rb:2'
       end
     end
 
+    context 'when a ruby file has methods in a module' do
+      let(:file_name) { 'fizz.rb' }
+      let(:ruby_code) {
+        "module Fizz
+           def berries
+             'fizz berries?'
+           end
+         end"
+      }
+      it 'can find the methods, and the module they belong to' do
+        expect(defined_methods.size).to eq 1
+        expect(defined_methods[0].name).to eq :berries
+        expect(defined_methods[0].full_name).to eq 'Fizz#berries'
+        expect(defined_methods[0].location).to eq 'fizz.rb:2'
+      end
+    end
+
+    context 'when a ruby file has a class nested in a module' do
+      let(:file_name) { 'zombie.rb' }
+      let(:ruby_code) {
+        "module Zombie
+           class Report
+             def info
+               'all clear!'
+             end
+           end
+         end"
+      }
+      it 'will record the nesting in the classname' do
+        expect(defined_methods.size).to eq 1
+        expect(defined_methods[0].name).to eq :info
+        expect(defined_methods[0].full_name).to eq 'Zombie::Report#info'
+        expect(defined_methods[0].location).to eq 'zombie.rb:3'
+      end
+    end
+
+    context 'when a ruby file has a class nested in another class' do
+      let(:ruby_code) {
+        "class Person
+           class Address
+             def street
+               '123 main'
+             end
+           end
+         end"
+      }
+      it 'will record the nesting in the classname' do
+        expect(defined_methods[0].full_name).to eq 'Person::Address#street'
+      end
+    end
+
     context 'when a ruby file has attr_readers' do
       context "when they're declared with symbols, the normal way" do
         let(:ruby_code) {
           "class Book
-           attr_reader :title, :author
-         end"
+             attr_reader :title, :author
+           end"
         }
         it 'can find attr_readers' do
           expect(defined_methods.map(&:name)).to match_array(%i[author title])
@@ -65,9 +121,9 @@ describe ZombieScout::Parser do
       context "when they're declare with a splat from an array of symbols" do
         let(:ruby_code) {
           "class Book
-           attributes = %i(title author)
-           attr_reader *attributes
-         end"
+             attributes = %i(title author)
+             attr_reader *attributes
+           end"
         }
         it 'will ignore them' do
           expect(defined_methods).to be_empty
@@ -79,8 +135,8 @@ describe ZombieScout::Parser do
       context "when they're declared with symbols, the normal way" do
         let(:ruby_code) {
           "class Book
-           attr_writer :title, :author
-         end"
+             attr_writer :title, :author
+           end"
         }
         it 'can find attr_writers' do
           expect(defined_methods.map(&:name)).to match_array(%i[author= title=])
@@ -89,9 +145,9 @@ describe ZombieScout::Parser do
       context "when they're declare with a splat from an array of symbols" do
         let(:ruby_code) {
           "class Book
-           attributes = %i(title author)
-           attr_reader *attributes
-         end"
+             attributes = %i(title author)
+             attr_reader *attributes
+           end"
         }
         it 'will ignore them' do
           expect(defined_methods).to be_empty
@@ -103,8 +159,8 @@ describe ZombieScout::Parser do
       context "when they're declared with symbols, the normal way" do
         let(:ruby_code) {
           "class Book
-           attr_accessor :title, :author
-         end"
+             attr_accessor :title, :author
+           end"
         }
         it 'can find attr_accessors' do
           expect(defined_methods.map(&:name)).to match_array(%i[author author= title title=])
@@ -113,9 +169,9 @@ describe ZombieScout::Parser do
       context "when they're declare with a splat from an array of symbols" do
         let(:ruby_code) {
           "class Book
-           attributes = %i(title author)
-           attr_accessor *attributes
-         end"
+             attributes = %i(title author)
+             attr_accessor *attributes
+           end"
         }
         it 'will ignore them' do
           expect(defined_methods).to be_empty
@@ -126,9 +182,9 @@ describe ZombieScout::Parser do
     context 'when a ruby file uses Forwardable::def_delegator' do
       let(:ruby_code) {
         "class RecordCollection
-         extend Forwardable
-         def_delegator :@records, :[], :record_number
-       end"
+           extend Forwardable
+           def_delegator :@records, :[], :record_number
+         end"
       }
       it 'can find methods created by def_delegator' do
         expect(defined_methods.map(&:name)).to match_array([:record_number])
@@ -138,9 +194,9 @@ describe ZombieScout::Parser do
     context 'when a ruby file uses Forwardable::def_delegators' do
       let(:ruby_code) {
         "class RecordCollection
-         extend Forwardable
-         def_delegators :@records, :size, :<<, :map
-       end"
+           extend Forwardable
+           def_delegators :@records, :size, :<<, :map
+         end"
       }
       it 'can find methods created by def_delegators' do
         expect(defined_methods.map(&:name)).to match_array(%i[<< map size])
@@ -150,9 +206,9 @@ describe ZombieScout::Parser do
     context 'when a rails model has scopes' do
       let(:ruby_code) {
         "class Post
-         scope :published, -> { where(published: true) }
-         scope :draft, -> { where(published: true) }
-       end"
+           scope :published, -> { where(published: true) }
+           scope :draft, -> { where(published: true) }
+         end"
       }
       it 'can find scopes' do
         expect(defined_methods.map(&:name)).to match_array(%i[draft published])
@@ -162,19 +218,19 @@ describe ZombieScout::Parser do
     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
-
-         def other_helper
-           'boo'
-         end
-      end"
+           def fizz
+             magick_helper
+           end
+
+           private
+           def magick_helper
+             'magick sauce'
+           end
+
+           def other_helper
+             'boo'
+           end
+         end"
       }
       it 'excludes private method calls, since we KNOW they are called' do
         expect(defined_methods.map(&:name)).to match_array([:fizz, :magick_helper, :other_helper])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zombie_scout
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Dan Bernier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -91,6 +91,7 @@ files:
 - lib/zombie_scout.rb
 - lib/zombie_scout/app.rb
 - lib/zombie_scout/flog_scorer.rb
+- lib/zombie_scout/method.rb
 - lib/zombie_scout/method_call_finder.rb
 - lib/zombie_scout/mission.rb
 - lib/zombie_scout/parser.rb