stowaway 0.1.6 → 0.1.8

data/README.md

@@ -1,10 +1,22 @@
 # Stowaway
 
-Stowaway is a gem that searches a web project for files that aren't being used.  By default it will search in the directory of your choice for files that have the following extension:
+Stowaway will search through the source code of a web project and find all
+of the images, scripts and stylesheets that aren't being used.  To use,
+simply provide the path to the directory you wish to search.  
 
- * .jpg 
- * .gif 
- * .png 
+***Please read the _warning_ section at the end before using***
+
+## Example
+    stowaway ~/repos/rails/my_rails_app/
+
+Stowaway, by default, will search for the most common file types. Using the
+**-t** flag, you can tell stowaway to use custom file types.
+
+## Default Types
+
+ * .jpg
+ * .gif
+ * .png
  * .ico
  * .js
  * .css
@@ -13,6 +25,35 @@ Stowaway is a gem that searches a web project for files that aren't being used.
 
     sudo gem install stowaway
 
+## Matching
+
+Stowaway assumes the path you provide is the root for your web application
+and will have no problem matching root-relative links to the actual files.
+
+The example below will result in a positive match:
+
+    # path to file: /my_app/images/foo.jpg
+    # image tag: <img src="/images/foo.jpg" />
+
+Stowaway currently recognizes the following as valid references:
+
+    src="/file.jpg"
+    href="/file.jpg"
+    :src => "file.jpg"
+    :href => "file.jpg"
+    = javascript_include_tag "file"
+    = javascript_include_tag "file.js"
+    = javascript_include_tag "file.js", "foo/bar.js"
+    = stylesheet_link_tag "file"
+    = stylesheet_link_tag "file.css"
+    = stylesheet_link_tag "file.css", "foo/bar.css"
+    url("/file.jpg")
+
+## Partial Matching
+
+As a fall back, stowaway will match on file name.  It will
+report the number of files that were matched by name only at the end of a run.
+
 ## Usages
 
     # basic usage
@@ -24,7 +65,11 @@ Stowaway is a gem that searches a web project for files that aren't being used.
     # with file types
     stowaway -t .js .css path/to/site
 
-## Note
+## Warning
 
-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.  
+Stowaway is useful for maintaining a tidy source tree, but it's not perfect.
+I probably don't need to say this, but a good VCS is mandatory.  So before you
+start deleting files, make sure all your awesome changes have been committed and
+that you double-check stowaway's result against your own manual process.
 
+This gem only works on ruby 1.9 ATM

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 6
+:patch: 8
 :build: 

data/lib/stowaway/matcher.rb

@@ -38,7 +38,7 @@ module Stowaway
 
     def rails_helper_ref?(helper_name, directory, extension)
       expression = Regexp.new(/=\s?(%s_tag)?\s(["|'])(.+)(\2)/.to_s % helper_name)
-      return false unless @line =~ expression
+      return false if @line !~ expression
       params = $3.gsub(/[\s|"|']/, "").split(",")
       params.each do |f|
           return true if "/public/#{directory}/#{f}" == @file.root_path ||

data/lib/stowaway/runner.rb

@@ -22,19 +22,19 @@ module Stowaway
     
     private
 
-    def respond(results)
-      if results[:files_to_find].empty?
+    def respond(result)
+      if result.files.empty?
         print "Zero stowaways found. You run a tight ship.\n\n"
       else
-        print "\nYou have #{results[:files_to_find].length} stowaway(s) ... shameful\n\n"
+        print "\nYou have #{result.files.length} stowaway(s) ... shameful\n\n"
 
-        unless results[:name_only].empty?
-          p "Warning: #{results[:name_only].length} file(s) partially matched on name only"
+        unless result.name_only_matches.empty?
+          p "Warning: #{result.name_only_matches.length} file(s) partially matched on name only"
         end
 
         60.times { print "-" }
         print "\n\n"
-        results[:files_to_find].each_with_index { |f, i| print "#{i+1}: #{f.root_path}\n" }
+        result.files.each_with_index { |f, i| print "#{i+1}: #{f.root_path}\n" }
         print "\n"
       end
     end

data/lib/stowaway/sweeper.rb

@@ -2,16 +2,18 @@ require_relative "fshelpyhelp"
 require_relative "status"
 require_relative "matcher"
 require_relative "file"
+require "ostruct"
 
 module Stowaway
   class Sweeper
     include FSHelpyHelp
 
-    def initialize(files_to_find, status = Status.new, ext_to_ignore = nil)
-      @results = { :files_to_find => files_to_find, :name_only => []}
-      @ignore = ext_to_ignore || [/^\.|\.jpg$|\.gif$|.png$|.ico$/i]
+    def initialize(files, status = Status.new, matcher = Matcher.new, ext_to_ignore = [])
+      @result = OpenStruct.new({ :files => files, :name_only_matches => []})
       @status = status
-      @matcher = Matcher.new
+      @matcher = matcher
+      @ignore = ext_to_ignore || []
+      @ignore += [/^\.|\.jpg$|\.jpeg$|\.gif$|\.png$|\.ico$|\.bmp$/i]
     end
 
     def sweep(path)
@@ -28,7 +30,7 @@ module Stowaway
           inspect_file(file)
         end
       end
-      @results
+      @result
     end
 
     private
@@ -44,11 +46,11 @@ module Stowaway
     end
 
     def remove_match(line)
-      @results[:files_to_find].delete_if do |file|
+      @result.files.delete_if do |file|
         if @matcher.match?(line, file)
           true
         elsif line.include?(file.name)
-          @results[:name_only] << file
+          @result.name_only_matches << file
           true
         end
       end

data/spec/lib/sweeper_spec.rb

@@ -1,12 +1,12 @@
 require "spec/spec_helper"
 require "lib/stowaway/file"
 require "lib/stowaway/sweeper"
+require "lib/stowaway/matcher"
 
 describe Stowaway::Sweeper do
   
   def sweeper(ignore = nil)
-    ig = ignore || [/^\./]
-    @sweeper ||= Stowaway::Sweeper.new(@files, @status_mock, ig)
+    @sweeper ||= Stowaway::Sweeper.new(@files, @status_mock, Stowaway::Matcher.new, ignore)
   end
 
   before(:each) do
@@ -14,83 +14,22 @@ describe Stowaway::Sweeper do
     @status_mock = mock("status_mock", :null_object => true)
   end
   
-  it "should match images referenced in a src attribute" do
+  it "should remove files when a reference to the file is found in source" do
     @files << Stowaway::FileObj.new("/fake/path1/button.jpg")
     sweeper.sweep("spec/data")
     @files.should be_empty
   end
-  
-  it "should match images referenced in an href attribute" do
-    @files << Stowaway::FileObj.new("/fake/path/photo.jpg")
-    sweeper.sweep("spec/data")
-    @files.should be_empty
-  end
-
-  it "should match images referenced in a src attribute when files are stored in public folder" do
-    @files << Stowaway::FileObj.new("/public/fake/path1/button.jpg")
-    sweeper.sweep("spec/data")
-    @files.should be_empty
-  end
-
-  it "should match images referenced in an haml href attribute" do
-    @files << Stowaway::FileObj.new("/images/haml.jpg")
-    sweeper.sweep("spec/data")
-    @files.should be_empty
-  end
-  
-  it "should match images referenced in a haml src attribute" do
-    @files << Stowaway::FileObj.new("/images/file.jpg")
-    sweeper.sweep("spec/data")
-    @files.should be_empty
-  end
-
-  it "should match images referenced in a haml src attribute when files are stored in public folder" do
-    @files << Stowaway::FileObj.new("/public/images/file.jpg")
-    sweeper.sweep("spec/data")
-    @files.should be_empty
-  end
 
-  it "should match scripts referenced in a src attribute" do
-    @files << Stowaway::FileObj.new("/fake/path/file.js")
-    sweeper.sweep("spec/data")
-    @files.should be_empty
-  end
-
-  it "should match scripts referenced in a rails javascript_include_tag helper" do
-    @files << Stowaway::FileObj.new("/public/javascripts/file.js")
-    sweeper([/^\.|\.rb$|testfile2/]).sweep("spec/data")
-    @files.should be_empty
-  end
-
-  it "should match scripts referenced in a rails javascript_include_tag helper when no extension is given" do
-    @files << Stowaway::FileObj.new("/public/javascripts/application.js")
-    sweeper([/^\.|\.rb$|testfile2/]).sweep("spec/data")
-    @files.should be_empty
-  end
-
-  it "should match multiple scripts referenced in a rails javascript_include_tag helper" do
-    @files << Stowaway::FileObj.new("/public/javascripts/jquery.js")
-    @files << Stowaway::FileObj.new("/public/javascripts/home/index.js")
-    sweeper([/^\.|\.rb$|testfile2/]).sweep("spec/data")
-    @files.should be_empty
-  end
-
-  it "should match css files referenced in a rails stylesheet_link_tag helper" do
-    @files << Stowaway::FileObj.new("/public/stylesheets/file.css")
-    sweeper([/^\.|\.rb$|testfile2/]).sweep("spec/data")
-    @files.should be_empty
-  end
-
-  it "should match multiple css files referenced in a rails stylesheet_link_tag helper" do
-    @files << Stowaway::FileObj.new("/public/stylesheets/reset.css")
-    @files << Stowaway::FileObj.new("/public/stylesheets/common.css")
-    sweeper([/^\.|\.rb$|testfile2/]).sweep("spec/data")
-    @files.should be_empty
+  it "should return an OpenStruct with the result of the sweeping" do
+    result = sweeper.sweep("spec/data")
+    result.files.should be_an_instance_of Array
+    result.name_only_matches.should be_an_instance_of Array
   end
 
   it "should not sweep through ignored file types" do
-#    @files << Stowaway::FileObj.new("/public/stylesheets/reset.css")
-#    sweeper([/^\.|\.rb$|testfile1/]).sweep("spec/data").length.should == 1
+    @files << Stowaway::FileObj.new("/fake/path1/button.jpg")
+    sweeper([/^\.|\.rb$|\.txt$/]).sweep("spec/data")
+    @files.length.should == 1
   end
   
   it "should output a message when sweeping through a file" do 
@@ -103,18 +42,23 @@ describe Stowaway::Sweeper do
     sweeper([/^\.|\.rb$|testfile2/]).sweep("spec/data")
   end
 
-  it "should find images of the same name but with different paths" do
+  it "should files of the same name but with different paths as last resort" do
     @files << Stowaway::FileObj.new("/fake/path1/button.jpg")
     @files << Stowaway::FileObj.new("/fake/path2/button.jpg")
     sweeper([/^\.|\.rb$/]).sweep("spec/data")
     @files.should be_empty
   end
 
-#  it "should remove matches and leave files that were not found" do
-#    @files << Stowaway::FileObj.new("/a/stowaway/file.txt")
-#    sweeper([/^\.|\.rb$/]).sweep("spec/data")
-#    @files.should_not be_empty
-#    @files.first.fullpath.should == "/a/stowaway/file.txt"
-#  end
+  it "should add a file matched on name only to an array of partially matched files" do
+    @files << Stowaway::FileObj.new("/missing/button.jpg")
+    sweeper([/^\.|\.rb$/]).sweep("spec/data").should have(1).name_only_matches
+  end
+
+  it "should not remove files that were not found" do
+    @files << Stowaway::FileObj.new("/a/stowaway.txt")
+    sweeper([/^\.|\.rb$/]).sweep("spec/data")
+    @files.should_not be_empty
+    @files.first.fullpath.should == "/a/stowaway.txt"
+  end
   
 end

data/stowaway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stowaway}
-  s.version = "0.1.6"
+  s.version = "0.1.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emilio Cavazos"]
-  s.date = %q{2010-02-20}
+  s.date = %q{2010-02-21}
   s.default_executable = %q{stowaway}
   s.email = %q{ejcavazos@gmail.com}
   s.executables = ["stowaway"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stowaway
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors: 
 - Emilio Cavazos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-20 00:00:00 -08:00
+date: 2010-02-21 00:00:00 -08:00
 default_executable: stowaway
 dependencies: []