zombie_scout 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3017624103d8c386a942a3653769d1e62b93175e
-  data.tar.gz: 4051fd1c51e9626ff04846945c7d9d22a58b4788
+  metadata.gz: 24fef05906d9243f5b7ccc8f5d527162f5a38c5f
+  data.tar.gz: a56de0fbd3d1e9cb5369a2b24bcbd76b5c728931
 SHA512:
-  metadata.gz: 0bee3360ff18f1c4363d605612a0b48f574b8390607ee975f51a84cab76f9544bf6334429d6133f770ef97ea179ee5349760edbb3d55e0a6adb66f2260283354
-  data.tar.gz: 49dec6d09b9d3f62538a93072bd6a6cf3619a2c1366b778154a2a0b4a20f68fab4557854a966c6cb895bbfb632e2b6cb177de168fe14caaf52caa4abff8e70c1
+  metadata.gz: e5111aa9eff93beb078907b74c24242c053227b71a5b50b8f4a3cc21835519bf58f845111907b8e0d76de39a2419bac3a077a81d76fc2f4bb1f4c6f2d61850ac
+  data.tar.gz: 2c19bbd09b45ae27af15d44f2bfd05795365d063cf42dbfb9732c5fc70c0101c1baf97caa2118584e7bb82229904ff4fcf0f77bb9fe08b111a0d0ce18d97a43e

data/.gitignore

@@ -2,6 +2,8 @@
 *.rbc
 .bundle
 .config
+.zombie_scout
+.zombie_scout_whitelist
 coverage
 InstalledFiles
 lib/bundler/man

data/README.md

@@ -153,6 +153,7 @@ thing:
 ## Code Status
 
 * [![Build Status](https://travis-ci.org/danbernier/zombie_scout.png?branch=master)](https://travis-ci.org/danbernier/zombie_scout)
+* [![Code Climate](https://codeclimate.com/github/danbernier/zombie_scout.png)](https://codeclimate.com/github/danbernier/zombie_scout)
 
 ## TODOs
 
@@ -161,6 +162,7 @@ thing:
 * [ ] 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.
+* [ ] look for db/schema.rb & db/structure.sql, parse out columns, & look for those.
 
 ToThinkAbouts:
 * [x] extract a hash-y report structure that can be used by whatever, from the default report

data/lib/zombie_scout/app.rb

@@ -1,5 +1,6 @@
 require 'thor'
 require 'zombie_scout/mission'
+require 'zombie_scout/formatter'
 
 module ZombieScout
   class App < Thor
@@ -9,25 +10,7 @@ module ZombieScout
       mission = Mission.new(globs)
       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 #{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[: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[:full_name], zombie[:flog_score]]
-          end
-        end
-      end
+      puts ZombieScout::Formatter.format(options[:format], mission, report)
     end
   end
 end

data/lib/zombie_scout/flog_scorer.rb

@@ -2,8 +2,9 @@ require 'flog'
 
 module ZombieScout
   class FlogScorer
-    def initialize(zombie_location)
-      @zombie_location = zombie_location
+    def initialize(zombie, flog=nil)
+      @zombie = zombie
+      @flog = flog || Flog.new(methode: true, quiet: true, score: false)
     end
 
     def score
@@ -12,16 +13,19 @@ module ZombieScout
 
     private
 
+    attr_reader :flog
+
     def raw_score
-      flog = Flog.new(methods: true, quiet: true, score:false)
       all_scores = flog.flog(zombie_path)
-      method_locations = flog.instance_variable_get(:@method_locations)
-      scores = all_scores.fetch(method_locations.invert.fetch(@zombie_location, {}), {})  # default to {} in case there is no score. (it's a 0)
+
+      # default to {} in case there is no score. (it's a 0)
+      scores = all_scores.fetch(@zombie.full_name, {})
+
       flog.score_method(scores)
     end
 
     def zombie_path
-      @zombie_location.sub(/\:\d+$/, '')
+      @zombie.location.sub(/\:\d+$/, '')
     end
   end
 end

data/lib/zombie_scout/formatter.rb

@@ -0,0 +1,46 @@
+module ZombieScout
+  module Formatter
+    def self.format(format, mission, report)
+      case format
+      when 'report'
+        ReportFormatter.new(mission, report).to_s
+      when 'csv'
+        CsvFormatter.new(mission, report).to_s
+      end
+    end
+
+    class BaseFormatter
+      attr_reader :mission, :report
+      def initialize(mission, report)
+        @mission, @report = mission, report
+      end
+    end
+
+    class ReportFormatter < BaseFormatter
+      def to_s
+        one = "Scouted #{mission.defined_method_count} methods in #{mission.source_count} files, in #{mission.duration} seconds."
+        two = "Found #{mission.zombie_count} potential zombies, with a combined flog score of #{total_flog_score.round(1)}."
+
+        ([one, two, "\n"] + report.map { |zombie|
+          [zombie[:location], zombie[:full_name], zombie[:flog_score]] * "\t"
+        }) * "\n"
+      end
+
+      def total_flog_score
+        report.map { |z| z[:flog_score] }.reduce(0, :+)
+      end
+    end
+
+    class CsvFormatter < BaseFormatter
+      def to_s
+        require 'csv'
+        CSV.generate do |csv|
+          csv << %w(location name flog_score)
+          report.each do |zombie|
+            csv << [zombie[:location], zombie[:full_name], zombie[:flog_score]]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/zombie_scout/method_call_finder.rb

@@ -7,7 +7,10 @@ module ZombieScout
 
     def count_calls(method_name)
       method_name = method_name.to_s
-      method_name.sub!(/=$/, ' *=')
+
+      # zero-or-more spaces, =, and NOT a > (so we don't match hashrockets)
+      method_name.sub!(/=$/, ' *=[^>]')
+
       find_occurrances(method_name).size
     end
 
@@ -15,13 +18,17 @@ module ZombieScout
 
     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
-
+      command = "grep -rnw #{includes} --binary-files=without-match \"#{method_name}\" #{files_to_search} Rakefile"
       grep_lines = `#{command}`
       grep_lines.split("\n")
     end
 
+    def includes
+      %w(*.rb *.erb *.rake Rakefile).map { |inc|
+        "--include=\"#{inc}\""
+      }.join(' ')
+    end
+
     def files_to_search
       @ruby_project.folders.join(' ')
     end

data/lib/zombie_scout/mission.rb

@@ -1,4 +1,5 @@
 require 'zombie_scout/ruby_project'
+require 'zombie_scout/whitelist'
 require 'zombie_scout/parser'
 require 'zombie_scout/method_call_finder'
 require 'zombie_scout/flog_scorer'
@@ -9,6 +10,7 @@ module ZombieScout
 
     def initialize(globs)
       @ruby_project = RubyProject.new(*globs)
+      @whitelist = Whitelist.new
     end
 
     def scout
@@ -18,7 +20,7 @@ module ZombieScout
           file_path: zombie.file_path,
           name: zombie.name,
           full_name: zombie.full_name,
-          flog_score: flog_score(zombie.location)
+          flog_score: flog_score(zombie)
         }
       }.tap {
         @end_time = Time.now
@@ -43,15 +45,15 @@ module ZombieScout
       @sources ||= @ruby_project.ruby_sources
     end
 
-    def flog_score(zombie_location)
-      ZombieScout::FlogScorer.new(zombie_location).score
+    def flog_score(zombie)
+      ZombieScout::FlogScorer.new(zombie).score
     end
 
     def zombies
       return @zombies unless @zombies.nil?
 
       scout!
-      @zombies ||= @defined_methods.select { |method|
+      @zombies = @defined_methods.select { |method|
         might_be_dead?(method)
       }
     end
@@ -74,8 +76,14 @@ module ZombieScout
     end
 
     def might_be_dead?(method)
-      @method_call_counter ||= MethodCallFinder.new(@ruby_project)
-      @method_call_counter.count_calls(method.name) < 2
+      unless whitelisted?(method)
+        @method_call_counter ||= MethodCallFinder.new(@ruby_project)
+        @method_call_counter.count_calls(method.name) < 2
+      end
+    end
+
+    def whitelisted?(method)
+      @whitelist.include?(method.full_name)
     end
   end
 end

data/lib/zombie_scout/version.rb

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

data/lib/zombie_scout/whitelist.rb

@@ -0,0 +1,15 @@
+module ZombieScout
+  class Whitelist
+    def initialize
+      @whitelist = if File.exist?('.zombie_scout_whitelist')
+                     File.read('.zombie_scout_whitelist')
+                   else
+                     []
+                   end
+    end
+
+    def include?(zombie_full_name)
+      @whitelist.include?(zombie_full_name)
+    end
+  end
+end

data/spec/zombie_scout/flog_scorer_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'zombie_scout/flog_scorer'
+
+describe ZombieScout::FlogScorer do
+  let(:full_name) { 'ClassName#method_name' }
+  let(:method_score) { :whatever }
+  let(:class_scores) {
+    {full_name => method_score}
+  }
+
+  let(:zombie_path) { 'lib/foo.rb' }
+
+  let(:flog) {
+    flog = double(:flog)
+    flog.stub(:flog).with(zombie_path).and_return(class_scores)
+    flog.stub(:score_method).with(method_score).and_return(38.293)
+    flog
+  }
+  let(:zombie) {
+    double(:zombie, location: "#{zombie_path}:42", full_name: full_name)
+  }
+
+  it 'should call some methods on Flog, and round the result' do
+    scorer = ZombieScout::FlogScorer.new(zombie, flog)
+    expect(scorer.score).to eq(38.3)
+  end
+end

data/spec/zombie_scout/formatter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'zombie_scout/formatter'
+
+describe ZombieScout::Formatter do
+  let(:mission) {
+    double(:mission, defined_method_count: 123,
+                     source_count: 97,
+                     zombie_count: 42,
+                     duration: 55)
+  }
+
+  let(:report) {
+    [
+      { flog_score: 23.4,
+        location: 'foo.rb:42',
+        full_name: 'Foo#bar' },
+      { flog_score: 43.2,
+        location: 'bar.rb:99',
+        full_name: 'Bar#none' }
+    ]
+  }
+
+  context 'for "report" format' do
+    it 'formats it correctly' do
+      output = ZombieScout::Formatter.format('report', mission, report)
+
+      expect(output).to include "Scouted 123 methods in 97 files"
+      expect(output).to include "in 55 seconds"
+      expect(output).to include "Found 42 potential zombies"
+      expect(output).to include "combined flog score of 66.6"
+      expect(output).to include "foo.rb:42\tFoo#bar\t23.4"
+      expect(output).to include "bar.rb:99\tBar#none\t43.2"
+    end
+  end
+
+  context 'for "csv" format' do
+    it 'formats it correctly' do
+      output = ZombieScout::Formatter.format('csv', mission, report)
+
+      lines = output.split("\n").map(&:chomp)
+      expect(lines).to eq([
+        'location,name,flog_score',
+        'foo.rb:42,Foo#bar,23.4',
+        'bar.rb:99,Bar#none,43.2'
+      ])
+    end
+  end
+end

data/spec/zombie_scout/whitelist_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'zombie_scout/whitelist'
+
+describe ZombieScout::Whitelist do
+  include FakeFS::SpecHelpers
+
+  def clear_whitelist!
+    if File.exist?('.zombie_scout_whitelist')
+      File.delete('.zombie_scout_whitelist')
+    end
+  end
+
+  def whitelist!(*names)
+    File.open('.zombie_scout_whitelist', 'w') do |f|
+      f.puts names.join("\n")
+    end
+  end
+
+  let(:whitelist) { ZombieScout::Whitelist.new }
+
+  describe '#include?' do
+    it 'only includes methods listed in .zombie_scout_whitelist' do
+      whitelist! 'Foo#bar', 'Iron#man'
+      expect(whitelist).to include('Foo#bar')
+      expect(whitelist).to include('Iron#man')
+      expect(whitelist).not_to include('Cran#berry')
+      expect(whitelist).not_to include('Boot#laces')
+    end
+
+    it 'includes nothing when .zombie_scout_whitelist does not exist' do
+      clear_whitelist!
+      expect(whitelist).not_to include('Foo#bar')
+      expect(whitelist).not_to include('Iron#man')
+      expect(whitelist).not_to include('Cran#berry')
+      expect(whitelist).not_to include('Boot#laces')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zombie_scout
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Dan Bernier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
+date: 2014-03-28 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/formatter.rb
 - lib/zombie_scout/method.rb
 - lib/zombie_scout/method_call_finder.rb
 - lib/zombie_scout/mission.rb
@@ -98,10 +99,14 @@ files:
 - lib/zombie_scout/ruby_project.rb
 - lib/zombie_scout/ruby_source.rb
 - lib/zombie_scout/version.rb
+- lib/zombie_scout/whitelist.rb
 - spec/spec_helper.rb
+- spec/zombie_scout/flog_scorer_spec.rb
+- spec/zombie_scout/formatter_spec.rb
 - spec/zombie_scout/parser_spec.rb
 - spec/zombie_scout/ruby_project_spec.rb
 - spec/zombie_scout/ruby_source_spec.rb
+- spec/zombie_scout/whitelist_spec.rb
 - zombie_scout.gemspec
 homepage: https://github.com/danbernier/zombie_scout
 licenses:
@@ -129,6 +134,9 @@ specification_version: 4
 summary: Find dead methods in your Ruby app
 test_files:
 - spec/spec_helper.rb
+- spec/zombie_scout/flog_scorer_spec.rb
+- spec/zombie_scout/formatter_spec.rb
 - spec/zombie_scout/parser_spec.rb
 - spec/zombie_scout/ruby_project_spec.rb
 - spec/zombie_scout/ruby_source_spec.rb
+- spec/zombie_scout/whitelist_spec.rb