janitor 0.1.2 → 0.2.0

data/README.mdown

@@ -31,3 +31,8 @@ Configure your app to load the Janitor rake tasks by adding the following to you
     # Code cleanup goodies
     require 'janitor/tasks'
 
+To Do
+=====
+
+* YML-ize the various search tasks to allow a project to specify the things that shouldn't be in the codebase.
+* Create a profanity filter

data/Rakefile

@@ -7,8 +7,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "janitor"
-    gem.summary = "janitor scans your code for leftover debug statements, consolr logs, and vulgarity"
-    gem.description = "ever leave a breakpoint in your code and do a deploy? not good, right? maybe you just want to remove the logger.info calls from your Rails project. janitor cleans your code"
+    gem.summary = "janitor scans your code for leftover debug statements, console.logs, and vulgarity"
+    gem.description = "ever leave a breakpoint in your code and do a deploy? not good, right? maybe you just want to remove the logger.info calls from your Rails project. janitor cleans your code."
     gem.email = "mike@mikekrisher.com"
     gem.homepage = "http://github.com/tjh/janitor"
     gem.authors = ["Tim Harvey", "Michael Krisher"]
@@ -17,7 +17,7 @@ begin
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+  raise "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/janitor.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{janitor}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tim Harvey", "Michael Krisher"]
   s.date = %q{2010-09-04}
-  s.description = %q{ever leave a breakpoint in your code and do a deploy? not good, right? maybe you just want to remove the logger.info calls from your Rails project. janitor cleans your code}
+  s.description = %q{ever leave a breakpoint in your code and do a deploy? not good, right? maybe you just want to remove the logger.info calls from your Rails project. janitor cleans your code.}
   s.email = %q{mike@mikekrisher.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -25,10 +25,10 @@ Gem::Specification.new do |s|
      "VERSION",
      "init.rb",
      "janitor.gemspec",
-     "lib/finder.rb",
      "lib/janitor.rb",
      "lib/janitor/finder.rb",
      "lib/janitor/janitor.rb",
+     "lib/janitor/rak_hit.rb",
      "lib/janitor/rak_result.rb",
      "lib/janitor/tasks.rb",
      "lib/tasks/tasks.rake",
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{janitor scans your code for leftover debug statements, consolr logs, and vulgarity}
+  s.summary = %q{janitor scans your code for leftover debug statements, console.logs, and vulgarity}
   s.test_files = [
     "spec/lib/finder_spec.rb",
      "spec/lib/janitor_spec.rb",

data/lib/janitor.rb

@@ -1,4 +1,4 @@
 require 'janitor/janitor'
 require 'janitor/finder'
-require 'janitor/tasks'
-require 'janitor/rak_result'
+require 'janitor/rak_result'
+require 'janitor/rak_hit'

data/lib/janitor/finder.rb

@@ -7,11 +7,16 @@ class Finder
   
   def number_of_matches(pattern)
     rak_result = search_by_regex(pattern)
-    rak_result.files.size
+    rak_result.hits.size
+  end
+  
+  def hits(pattern)
+    rak_result = search_by_regex(pattern)
+    rak_result.hits.collect { |hit| "#{hit.file_name}:#{hit.line_number}" }
   end
   
   def search_by_regex(pattern)
-    exec_rak(pattern, '-all')
+    exec_rak(pattern, '--all')
   end
   
   def exec_rak(pattern, options)

data/lib/janitor/janitor.rb

@@ -1,7 +1,11 @@
 class Janitor
   def self.count (pattern, path = "*")
     finder = Finder.new(path)
-    count = finder.number_of_matches(pattern)
-    raise "Found #{pattern} #{count} times in #{path}" if count > 0
+    finder.number_of_matches(pattern)
+  end
+  
+  def self.hits (pattern, path = "*")
+    finder = Finder.new(path)
+    finder.hits(pattern)
   end
 end

data/lib/janitor/rak_hit.rb

@@ -0,0 +1,17 @@
+# -----------------------------------------
+# This represents a single search hit from
+# the Rak gem. The raw output looks like:
+#
+#   lib/file_name.rb     10|require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+#
+# This is a file name, then line number, followed by
+# a pipe, then finally the context within that file
+# -----------------------------------------
+
+class RakHit
+  attr_accessor :file_name, :line_number, :context
+  
+  def initialize(raw_hit)
+    self.file_name, self.line_number, self.context = raw_hit.scan(/(.+?)\s*(\d+)\|\s*(.+)/).first
+  end
+end

data/lib/janitor/rak_result.rb

@@ -2,11 +2,14 @@ class RakResult
   attr_accessor :rak_output
   
   def initialize(rak_output)
-    self.rak_output = rak_output
+    self.rak_output = rak_output.strip
   end
   
-  def files
-    rows = rak_output.split("\n")
-    rows.select { |r| r.scan(/^[^\s]+/).size > 0 }
+  def file_names
+    hits.collect { |hit| hit.file_name }.uniq
   end
-end
+  
+  def hits
+    rak_output.split("\n").collect { |row| RakHit.new(row) }
+  end
+end

data/lib/janitor/tasks.rb

@@ -7,14 +7,50 @@ namespace :janitor do
     
     desc "Find any 'console.log' statements"
     task :console_log do
-      count = Janitor.count "console.log", "tmp/javascript"
-      raise "Found console.log statements" if count > 0
+      puts "Searching the current folder for 'console.log'"
+      count = Janitor.count "console.log"
+      if count > 0
+        puts "FAILED: Found #{count} console.log statements"
+      else
+        puts "Success...didn't find 'console.log'"
+      end
     end
     
     desc "Count 'debugger' statements"
     task :debugger do
+      puts "Searching the current folder for 'debugger'"
       count = Janitor.count "debugger"
-      raise "Found debugger statements" if count > 0
+      if count > 0
+        puts "FAILED: Found #{count} debugger statements"
+      else
+        puts "Success...didn't find 'debugger'"
+      end
+    end
+  end
+  
+  namespace :hits do
+    desc "Run all count tasks"
+    task :all => [:debugger, :console_log]
+    
+    desc "Find any 'console.log' statements"
+    task :console_log do
+      hits = Janitor.hits "console.log"
+      if hits.count > 0
+        puts hits
+        puts "FAILED: Found #{hits.count} console.log statements"
+      end
+    end
+    
+    desc "Count 'debugger' statements"
+    task :debugger do
+      puts "Searching the current folder for 'debugger'"
+      hits = Janitor.hits "debugger"
+      if hits.count > 0
+        puts hits
+        puts "FAILED: Found #{hits.count} debugger statements"
+      else
+        puts "Success...didn't find 'debugger'"
+      end
     end
   end
 end

data/spec/lib/finder_spec.rb

@@ -8,11 +8,34 @@ describe "Finder" do
     end
   end
   
+  describe " #number_of_matches" do
+    it "should do a search_by_regex, returning the number of hits the RakResult gives" do
+      pattern = 'a_regex'
+      finder = Finder.new
+      rak_result = mock('rak_result', :hits => ['janitor.rb:3'])
+      finder.should_receive(:search_by_regex).with(pattern).and_return(rak_result)
+      finder.number_of_matches(pattern).should == 1
+    end
+  end
+  
+  describe " #hits" do
+    it "should return the array of hits from the RakResult returned by exec_rak" do
+      pattern = 'a_regex'
+      hit        = mock('rak_hit', 
+        :file_name => "filename.rb",
+        :line_number => 10)
+      rak_result = mock('rak_result', :hits => [hit])
+      finder = Finder.new
+      finder.should_receive(:search_by_regex).and_return(rak_result)
+      finder.hits(pattern).should == ["filename.rb:10"]
+    end
+  end
+  
   describe " #search_by_regex" do
     it "should execute a rak search with the given pattern and -all" do
       pattern = 'a_regex'
       finder = Finder.new
-      finder.should_receive(:exec_rak).with(pattern, '-all')
+      finder.should_receive(:exec_rak).with(pattern, '--all')
       finder.search_by_regex(pattern)
     end
   end

data/spec/lib/janitor_spec.rb

@@ -5,19 +5,41 @@ describe "Janitor" do
     it "should call number_of_matches on Finder with the given path" do
       path    = "a_path"
       pattern = "a_pattern"
-      finder = mock('finder')
-      finder.should_receive(:number_of_matches).with(pattern).and_return(0)
-      Finder.should_receive(:new).with(path).and_return(finder)
-      Janitor.count(path, pattern)
+      mock_finder(pattern, path)
+      Janitor.count(pattern, path)
     end
     
-    it "should raise an exception when number_of_matches returns a non-zero count" do
+    it "should return the value returned by the call to number_of_matches" do
       path    = "a_path"
       pattern = "a_pattern"
-      finder = mock('finder')
-      finder.should_receive(:number_of_matches).with(pattern).and_return(1)
-      Finder.should_receive(:new).with(path).and_return(finder)
-      lambda { Janitor.count(path, pattern) }.should raise_error
+      mock_finder(pattern, path, :number_of_matches => 1)
+      Janitor.count(pattern, path).should == 1
     end
   end
+  
+  describe " #hits" do
+    it "should call #hits on Finder and return the result" do
+      path    = "a_path"
+      pattern = "a_pattern"
+      hits    = ['result']
+      mock_finder(pattern, path, :hits => hits)
+      Janitor.hits(pattern, path).should == hits
+    end
+  end
+  
+  describe " integration testing" do
+    it " should find debugger once in 'tmp/'" do
+      Janitor.count('console\.log', 'tmp/').should == 3
+    end
+  end
+  
+  def mock_finder(pattern, path, *args)
+    options = args.first ? args.first : {}
+    options = {:number_of_matches => 0}.merge options
+    options = {:hits              => 0}.merge options
+    finder = mock('finder', 
+      :number_of_matches => options[:number_of_matches],
+      :hits              => options[:hits])
+    Finder.should_receive(:new).and_return(finder)
+  end
 end

data/spec/lib/rak_result_spec.rb

@@ -3,26 +3,37 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 describe "RakResult" do
   before(:all) do
       @result = "
-lib/janitor.rb
-   1|require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-   9|end
-
-lib/finder.rb
-   7|Dir.glob(File.join(File.dirname(__FILE__), '../lib/*.rb')).each {|f| require f }
-   9|Spec::Runner.configure do |config|
-  11|end
+lib/janitor.rb   1|require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+lib/janitor.rb   9|end
+lib/finder.rb   7|Dir.glob(File.join(File.dirname(__FILE__), '../lib/*.rb')).each {|f| require f }
+lib/finder.rb   9|Spec::Runner.configure do |config|
+lib/finder.rb  11|end
 "
   end
   
+  before(:each) do
+    @rak_result = RakResult.new(@result)
+  end
+  
   describe " #initialize" do
     it "should store the given rak output string" do
       RakResult.new('a_result').rak_output.should == 'a_result'
     end
+    
+    it "should strip leading and trailing whitespace" do
+      @rak_result.rak_output.should == @result.strip
+    end
   end
   
-  describe " #file_matches" do
+  describe " #file_names" do
     it "should return an array of files that were matched" do
-      RakResult.new(@result).files.should == ['lib/janitor.rb', 'lib/finder.rb']
+      @rak_result.file_names.should == ['lib/janitor.rb', 'lib/finder.rb']
+    end
+  end
+  
+  describe " #hits" do
+    it "should return an array of RakHits objects" do
+      @rak_result.hits.first.should be_instance_of(RakHit)
     end
   end
 end

data/spec/spec.opts

@@ -1 +1,4 @@
---color
+--colour
+--format specdoc
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -3,8 +3,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'spec'
 require 'spec/autorun'
 
-# Require each of our libraries
-Dir.glob(File.join(File.dirname(__FILE__), '../lib/**/*.rb')).each {|f| require f }
+require 'janitor'
 
 Spec::Runner.configure do |config|
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: janitor
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tim Harvey
@@ -33,7 +33,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: ever leave a breakpoint in your code and do a deploy? not good, right? maybe you just want to remove the logger.info calls from your Rails project. janitor cleans your code
+description: ever leave a breakpoint in your code and do a deploy? not good, right? maybe you just want to remove the logger.info calls from your Rails project. janitor cleans your code.
 email: mike@mikekrisher.com
 executables: []
 
@@ -51,10 +51,10 @@ files:
 - VERSION
 - init.rb
 - janitor.gemspec
-- lib/finder.rb
 - lib/janitor.rb
 - lib/janitor/finder.rb
 - lib/janitor/janitor.rb
+- lib/janitor/rak_hit.rb
 - lib/janitor/rak_result.rb
 - lib/janitor/tasks.rb
 - lib/tasks/tasks.rake
@@ -97,7 +97,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: janitor scans your code for leftover debug statements, consolr logs, and vulgarity
+summary: janitor scans your code for leftover debug statements, console.logs, and vulgarity
 test_files: 
 - spec/lib/finder_spec.rb
 - spec/lib/janitor_spec.rb

data/lib/finder.rb

@@ -1,20 +0,0 @@
-class Finder
-  attr_reader :path
-  
-  def initialize(path = File.dirname(__FILE__))
-    @path = path
-  end
-  
-  def number_of_matches(pattern)
-    rak_result = search_by_regex(pattern)
-    rak_result.files.size
-  end
-  
-  def search_by_regex(pattern)
-    exec_rak(pattern, '-all')
-  end
-  
-  def exec_rak(pattern, options)
-    RakResult.new(%x{rak #{options} #{pattern} #{@path}})
-  end
-end