stowaway 0.0.4 → 0.0.6

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+.svn
+*~
+*.swp
+pkg

data/README.md

@@ -12,7 +12,18 @@ Stowaway is a gem that searches a web project for files that aren't being used.
 ## Installing
 
     sudo gem install stowaway
-    
+
+## Usages
+
+    # basic usage
+    stowaway path/to/site
+
+    # from directory
+    stowaway .
+
+    # with file types
+    stowaway -t .js .css path/to/site
+
 ## Note
 
 I'll be adding support for matching on relative and absolute paths (Comparing by path will preserve the uniqueness of the file).  Currently, only file names are being checked for matches.  If you have two files with the same name but they reside in different directories, they will be treated as one.  In other words, if you have multiple files with the *same name*, stowaway won't work right.  

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 0
-:patch: 4
+:patch: 6

data/lib/stowaway/runner.rb

@@ -10,9 +10,11 @@ module Stowaway
     end
     
     def run
+      p "Locating files ..."
       locator = Stowaway::Locator.new(@options.file_types)
       files = locator.find_all @options.path
-
+      p "#{files.size} files located"
+      
       fs = Stowaway::Sweeper.new files
       respond fs.sweep @options.path
     end

data/lib/stowaway/status.rb

@@ -0,0 +1,14 @@
+module Stowaway
+  class Status
+    RESET = "\r\e[0K"
+    def out(msg)
+      print "#{RESET}#{msg}"
+    end
+
+    def flush
+      sleep(0.12)
+      print RESET 
+      $stdout.flush
+    end
+  end
+end

data/lib/stowaway/sweeper.rb

@@ -1,25 +1,16 @@
 require_relative 'fshelpyhelp'
+require_relative 'status'
 
 module Stowaway
   class Sweeper
     include FSHelpyHelp
 
-    def initialize(files_to_find, ext_to_ignore = nil)
+    def initialize(files_to_find, status = Status.new, ext_to_ignore = nil)
       @files_to_find = files_to_find
       @ignore = ext_to_ignore || [/^\.|\.jpg$|\.gif$|.png$/i]
+      @status = status
     end
   
-    def inspect_file(file)
-      File.open(file, 'r') do |i|
-        while line = i.gets
-          remove_match(line)
-        end
-      end
-    end
-
-    def remove_match(line)
-      @files_to_find.delete_if { |file| line.include?(file.name) }
-    end
   
     def sweep(path)
       dir = Dir.new(path)
@@ -38,5 +29,19 @@ module Stowaway
       @files_to_find
     end
 
+    private
+    def inspect_file(file)
+      @status.out "Sweeping: #{file}"
+      File.open(file, 'r') do |i|
+        while line = i.gets
+          remove_match(line)
+        end
+      end
+      @status.flush
+    end
+
+    def remove_match(line)
+      @files_to_find.delete_if { |file| line.include?(file.name) }
+    end
   end
-end
+end

data/spec/lib/sweeper_spec.rb

@@ -4,34 +4,42 @@ require 'lib/stowaway/sweeper'
 
 describe Stowaway::Sweeper do
   
+  def sweeper(ignore = nil)
+    ig = ignore || [/^\./]
+    @sweeper ||= Stowaway::Sweeper.new(@files, @status_mock, ig)
+  end
+
   before(:each) do
     @f1 = Stowaway::FileObj.new('/fake/file1.jpg')
     @f2 = Stowaway::FileObj.new('/fake/file2.gif')
     @f3 = Stowaway::FileObj.new('/fake/file3.js')
     @f4 = Stowaway::FileObj.new('/fake/also/file3.js')
     @files = [@f1, @f2, @f3, @f4]
-    @sweeper = Stowaway::Sweeper.new(@files)
+    @status_mock = mock('status_mock', :null_object => true)
   end
   
-  it "should sweep through directory structure looking for matches" do
-    @sweeper.sweep('.')
+  it "should sweep through directory looking for matches" do
+    sweeper.sweep('.')
     @files.should be_empty
   end
   
-  it "should not examine ignored file types" do
-    @sweeper = Stowaway::Sweeper.new(@files, ["^\\.", ".rb", "testfile1"])
-    @sweeper.sweep('.').length.should == 2
+  it "should not sweep through ignored file types" do
+    sweeper([/^\.|\.rb$|testfile1/]).sweep('spec/data').length.should == 2
+  end
+  
+  it "should output a message when sweeping through a file" do 
+    @status_mock.should_receive(:out).with("Sweeping: spec/data/testfile1.txt").once
+    sweeper([/^\.|\.rb$|testfile2/]).sweep('spec/data')
   end
 
-  it "should read through the file looking for matches" do
-    @sweeper.inspect_file('spec/data/testfile1.txt')
-    @files.should == [@f3, @f4]
+  it "should flush the output after sweeping through a file" do 
+    @status_mock.should_receive(:flush).once
+    sweeper([/^\.|\.rb$|testfile2/]).sweep('spec/data')
   end
-  
-  it "should remove matches from the list of files to find" do
-    line = 'file2.gif, file3.js'
-    @sweeper.remove_match line
-    @files.should == [@f1]
+
+  it "should remove matches and leave files that were not found" do
+    sweeper([/^\.|\.rb$|testfile1/]).sweep('spec/data')
+    @files.should == [@f1, @f2]
   end
   
-end
+end

data/stowaway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stowaway}
-  s.version = "0.0.4"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emilio Cavazos"]
-  s.date = %q{2009-10-02}
+  s.date = %q{2009-10-07}
   s.default_executable = %q{stowaway}
   s.email = %q{ejcavazos@gmail.com}
   s.executables = ["stowaway"]
@@ -18,20 +18,20 @@ Gem::Specification.new do |s|
      "README.md"
   ]
   s.files = [
-    "LICENSE",
+    ".gitignore",
+     "LICENSE",
      "README.md",
      "Rakefile",
      "TODO.txt",
      "VERSION.yml",
-     "bin/.stowaway.swp",
      "bin/stowaway",
      "lib/stowaway/file.rb",
      "lib/stowaway/fshelpyhelp.rb",
      "lib/stowaway/locator.rb",
      "lib/stowaway/options.rb",
      "lib/stowaway/runner.rb",
+     "lib/stowaway/status.rb",
      "lib/stowaway/sweeper.rb",
-     "pkg/stowaway-0.0.1.gem",
      "spec/data/testfile1.txt",
      "spec/data/testfile2.txt",
      "spec/lib/file_spec.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stowaway
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors: 
 - Emilio Cavazos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-02 00:00:00 -07:00
+date: 2009-10-07 00:00:00 -07:00
 default_executable: stowaway
 dependencies: []
 
@@ -23,20 +23,20 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files: 
+- .gitignore
 - LICENSE
 - README.md
 - Rakefile
 - TODO.txt
 - VERSION.yml
-- bin/.stowaway.swp
 - bin/stowaway
 - lib/stowaway/file.rb
 - lib/stowaway/fshelpyhelp.rb
 - lib/stowaway/locator.rb
 - lib/stowaway/options.rb
 - lib/stowaway/runner.rb
+- lib/stowaway/status.rb
 - lib/stowaway/sweeper.rb
-- pkg/stowaway-0.0.1.gem
 - spec/data/testfile1.txt
 - spec/data/testfile2.txt
 - spec/lib/file_spec.rb