janitor 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+
+tmp/

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Tim Harvey and Michael Krisher
+
+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/README.mdown

@@ -0,0 +1,33 @@
+Janitor Gem
+=============
+
+Tim Harvey
+
+Mike Krisher
+
+
+Details
+=======
+
+Need a code janitor? Someone to scan your code base and look
+for leftover debug statements, console logs, and gasp, vulgarity!
+
+Simple to use, point it at your code base, and run janitor report
+
+To learn more about Ack:
+[http://betterthangrep.com][]
+
+[http://betterthangrep.com/]: http://betterthangrep.com
+
+Installation
+============
+
+Install the gem.
+
+    gem install janitor
+
+Configure your app to load the Janitor rake tasks by adding the following to you Rakefile:
+
+    # Code cleanup goodies
+    require 'janitor/tasks'
+

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+$:.unshift 'lib'
+
+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.email = "mike@mikekrisher.com"
+    gem.homepage = "http://github.com/tjh/janitor"
+    gem.authors = ["Tim Harvey", "Michael Krisher"]
+    gem.add_dependency "rak"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/janitor.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{janitor}
+  s.version = "0.1.2"
+
+  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.email = %q{mike@mikekrisher.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.mdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.mdown",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "janitor.gemspec",
+     "lib/finder.rb",
+     "lib/janitor.rb",
+     "lib/janitor/finder.rb",
+     "lib/janitor/janitor.rb",
+     "lib/janitor/rak_result.rb",
+     "lib/janitor/tasks.rb",
+     "lib/tasks/tasks.rake",
+     "nails/init.rb",
+     "spec/lib/finder_spec.rb",
+     "spec/lib/janitor_spec.rb",
+     "spec/lib/rak_result_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tjh/janitor}
+  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.test_files = [
+    "spec/lib/finder_spec.rb",
+     "spec/lib/janitor_spec.rb",
+     "spec/lib/rak_result_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rak>, [">= 0"])
+    else
+      s.add_dependency(%q<rak>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rak>, [">= 0"])
+  end
+end
+

data/lib/finder.rb

@@ -0,0 +1,20 @@
+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

data/lib/janitor.rb

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

data/lib/janitor/finder.rb

@@ -0,0 +1,20 @@
+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

data/lib/janitor/janitor.rb

@@ -0,0 +1,7 @@
+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
+  end
+end

data/lib/janitor/rak_result.rb

@@ -0,0 +1,12 @@
+class RakResult
+  attr_accessor :rak_output
+  
+  def initialize(rak_output)
+    self.rak_output = rak_output
+  end
+  
+  def files
+    rows = rak_output.split("\n")
+    rows.select { |r| r.scan(/^[^\s]+/).size > 0 }
+  end
+end

data/lib/janitor/tasks.rb

@@ -0,0 +1,20 @@
+require 'janitor'
+
+namespace :janitor do
+  namespace :count do
+    desc "Run all count tasks"
+    task :all => [:debugger, :console_log]
+    
+    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
+    end
+    
+    desc "Count 'debugger' statements"
+    task :debugger do
+      count = Janitor.count "debugger"
+      raise "Found debugger statements" if count > 0
+    end
+  end
+end

data/lib/tasks/tasks.rake

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'janitor', 'tasks'))

data/spec/lib/finder_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Finder" do
+  describe " #initialize" do
+    it "should store the given path" do
+      finder = Finder.new('a_path')
+      finder.path.should == 'a_path'
+    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.search_by_regex(pattern)
+    end
+  end
+  
+  describe " #exec_rak" do
+    it "should return a RakResult instance" do
+      pattern = 'a_regex'
+      finder = Finder.new
+      finder.exec_rak('search', 'option').should be_instance_of(RakResult)
+    end
+  end
+end

data/spec/lib/janitor_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Janitor" do
+  describe " #count" 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)
+    end
+    
+    it "should raise an exception when number_of_matches returns a non-zero count" 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
+    end
+  end
+end

data/spec/lib/rak_result_spec.rb

@@ -0,0 +1,28 @@
+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
+"
+  end
+  
+  describe " #initialize" do
+    it "should store the given rak output string" do
+      RakResult.new('a_result').rak_output.should == 'a_result'
+    end
+  end
+  
+  describe " #file_matches" do
+    it "should return an array of files that were matched" do
+      RakResult.new(@result).files.should == ['lib/janitor.rb', 'lib/finder.rb']
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$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 }
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: janitor
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Tim Harvey
+- Michael Krisher
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-04 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rak
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        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
+email: mike@mikekrisher.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.mdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.mdown
+- Rakefile
+- VERSION
+- init.rb
+- janitor.gemspec
+- lib/finder.rb
+- lib/janitor.rb
+- lib/janitor/finder.rb
+- lib/janitor/janitor.rb
+- lib/janitor/rak_result.rb
+- lib/janitor/tasks.rb
+- lib/tasks/tasks.rake
+- nails/init.rb
+- spec/lib/finder_spec.rb
+- spec/lib/janitor_spec.rb
+- spec/lib/rak_result_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tjh/janitor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+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
+test_files: 
+- spec/lib/finder_spec.rb
+- spec/lib/janitor_spec.rb
+- spec/lib/rak_result_spec.rb
+- spec/spec_helper.rb