stowaway 0.1.2 → 0.1.5

data/TODO.txt

@@ -1,6 +1,9 @@
 == Future
 
-* when locator returns duplicate filenames, the files should be matched on path+name in order to retain uniqueness
-  * currently, two files with the same name in different directories will be treated as the same file
+* add verbose option to output file names of the files that weren't found and
+  the files that were only partially matched on name.
+* ignore vendor folder
+* ignore spec folder
+* move appropriate sweeper tests to matcher
 * specify runner.rb
-  * clean up it's dependencies
+  * clean up it's dependencies

data/VERSION.yml

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

data/bin/stowaway

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'stowaway/runner' 
+require 'lib/stowaway/runner' 
 runner = Stowaway::Runner.new(ARGV) 
 runner.run

data/lib/stowaway/file.rb

@@ -2,8 +2,9 @@ module Stowaway
   class FileObj
     attr :fullpath
     
-    def initialize(fullpath)
+    def initialize(fullpath, root = nil)
       @fullpath = fullpath
+      @root = root || Dir.pwd
     end
     
     def name
@@ -13,9 +14,14 @@ module Stowaway
     def path
       File.split(@fullpath)[0]
     end
+
+    def root_path
+      root = @root.split("/").last
+      @fullpath.sub(/^.+\/#{root}/, "")
+    end
     
     def ==(fileObj)
       self.fullpath == fileObj.fullpath
     end
   end
-end
+end

data/lib/stowaway/locator.rb

@@ -18,7 +18,8 @@ module Stowaway
     end
   
     def find_all(path, files = [])
-    
+      @root = path if @root.nil?
+
       dir = Dir.new(path)
     
       dir.each do |f|
@@ -29,7 +30,7 @@ module Stowaway
         if File.directory?(file) 
           find_all file, files
         elsif type?(f)
-          files << FileObj.new(file)
+          files << FileObj.new(file, @root)
         end
       end
       files

data/lib/stowaway/matcher.rb

@@ -2,47 +2,58 @@ module Stowaway
   class Matcher
     def match?(line, file)
       @line, @file = line, file
-      return true if html_attr_ref?
-      return true if haml_attr_ref?
-      return true if rails_js_ref?
-      return true if rails_css_ref?
+      html_attr_ref? ||
+      haml_attr_ref? ||
+      rails_js_ref?  ||
+      rails_css_ref? ||
+      css_url_ref?
     end
 
     private
 
     def html_attr_ref?
-      @line =~ /(src|link|href|:href)\s?[=|=>]\s?(["|'])(#{@file.fullpath})(\2)/
+      exp = /(src|link|href|:href)\s?[=|=>]\s?(["|'])(%s)(\2)/
+      direct_or_public_dir_match?(exp)
     end
 
     def haml_attr_ref?
-      @line =~ /(:src|:link|:href)(\s?=>\s?)(["|'])(#{@file.fullpath})(\3)/
+      exp = /(:src|:link|:href)(\s?=>\s?)(["|'])(%s)(\3)/
+      direct_or_public_dir_match?(exp)
     end
 
     def rails_js_ref?
-      return false unless @line =~ /=?\s(javascript_include_tag)?\s(["|'])(.+)(\2)/
-      params = $3.gsub(/[\s|"]/, "").split(",")
-      params.each do |f|
-        if f =~ /\.js$/
-          return true if "/public/javascripts/#{f}" == @file.fullpath
-        else
-          return true if "/public/javascripts/#{f}.js" == @file.fullpath
-        end
-      end
-      false
+      rails_helper_ref?("javascript_include", "javascripts", "js")
     end
 
     def rails_css_ref?
-      return false unless @line =~ /=?\s(stylesheet_link_tag)?\s(["|'])(.+)(\2)/
+      rails_helper_ref?("stylesheet_link", "stylesheets", "css")
+    end
+
+    def css_url_ref?
+      exp = /url\(["|']?(%s)\)/
+      direct_or_public_dir_match?(exp)
+    end
+
+    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
       params = $3.gsub(/[\s|"]/, "").split(",")
       params.each do |f|
-        if f =~ /\.css$/
-          return true if "/public/stylesheets/#{f}" == @file.fullpath
-        else
-          return true if "/public/stylesheets/#{f}.css" == @file.fullpath
-        end
+          return true if "/public/#{directory}/#{f}" == @file.root_path ||
+                         "/public/#{directory}/#{f}.#{extension}" == @file.root_path
       end
       false
     end
 
+    def direct_or_public_dir_match?(expression)
+      @line =~ Regexp.new(expression.to_s % @file.fullpath) ||
+      @line =~ Regexp.new(expression.to_s % trim_public)
+    end
+
+    def trim_public
+      # remove /public from the beginning of the path
+      @file.root_path.sub(/\/public/, "")
+    end
+
   end
 end

data/lib/stowaway/runner.rb

@@ -10,10 +10,11 @@ module Stowaway
     end
     
     def run
-      p "Locating files ..."
+      print "\nLocating files ... "
       locator = Stowaway::Locator.new(@options.file_types)
       files = locator.find_all @options.path
-      p "#{files.size} files located"
+      @total = files.length
+      p "#{@total} files located"
       
       fs = Stowaway::Sweeper.new files
       respond fs.sweep @options.path
@@ -21,13 +22,19 @@ module Stowaway
     
     private
 
-    def respond(not_found)
-      if not_found.empty?
+    def respond(results)
+      if results[:files_to_find].empty?
         print "Zero stowaways found. You run a tight ship.\n\n"
       else
-        print "\nYou have #{not_found.length} stowaway(s)\n"
-        print "--------------------------\n\n"
-        not_found.each_with_index { |f, i| print "#{i+1}: #{f.fullpath}\n" }
+        print "\nYou have #{results[:files_to_find].length} stowaway(s) ... shameful\n\n"
+
+        unless results[:name_only].empty?
+          p "Warning: #{results[:name_only].length} file(s) partially matched on name only"
+        end
+
+        100.times { print "-" }
+        print "\n\n"
+        results[:files_to_find].each_with_index { |f, i| print "#{i+1}: #{f.root_path}\n" }
         print "\n"
       end
     end

data/lib/stowaway/status.rb

@@ -6,7 +6,6 @@ module Stowaway
     end
 
     def flush
-      sleep(0.12)
       print RESET 
       $stdout.flush
     end

data/lib/stowaway/sweeper.rb

@@ -7,15 +7,14 @@ module Stowaway
     include FSHelpyHelp
 
     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]
+      @results = { :files_to_find => files_to_find, :name_only => []}
+      @ignore = ext_to_ignore || [/^\.|\.jpg$|\.gif$|.png$|.ico$/i]
       @status = status
       @matcher = Matcher.new
     end
 
     def sweep(path)
       dir = Dir.new(path)
-      @root = path if @root.nil?
 
       dir.each do |f|
         next if ignore?(f)
@@ -28,7 +27,7 @@ module Stowaway
           inspect_file(file)
         end
       end
-      @files_to_find
+      @results
     end
 
     private
@@ -37,14 +36,21 @@ module Stowaway
       @status.out "Sweeping: #{file}"
       File.open(file, 'r') do |i|
         while line = i.gets
-          remove_match(line)
+          remove_match(line) #rescue nil
         end
       end
       @status.flush
     end
 
     def remove_match(line)
-      @files_to_find.delete_if { |file| @matcher.match?(line, file) }
+      @results[:files_to_find].delete_if do |file|
+        if @matcher.match?(line, file)
+          true
+        elsif line.include?(file.name)
+          @results[:name_only] << file
+          true
+        end
+      end
     end
 
   end

data/spec/data/testfile1.txt

@@ -1,11 +1,17 @@
 this is a line of test text.
 this filename on this line should be ignored: file1.js.
+
 = javascript_include_tag "file.js"
 = javascript_include_tag "jquery.js", "home/index.js"
 = javascript_include_tag "application"
 = stylesheet_link_tag "file.css"
 = stylesheet_link_tag "reset", "common"
+
 %a{ :href => "/images/haml.jpg", :title => "haml" }
 %img{ :src => "/images/file.jpg", :alt => "file" }
 
+background: url("/images/header.png") no-repeat
+background: url('/images/header.png') no-repeat
+background: url(/images/header.png) no-repeat
+
 the end.

data/spec/lib/sweeper_spec.rb

@@ -26,18 +26,30 @@ describe Stowaway::Sweeper do
     @files.should be_empty
   end
 
-  it "should match images referenced in an href attribute when using haml" do
-    @files << Stowaway::FileObj.new("/images/haml.jpg")
+  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 a src attribute when using haml" do
+  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")

data/stowaway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stowaway}
-  s.version = "0.1.2"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emilio Cavazos"]
-  s.date = %q{2010-02-15}
+  s.date = %q{2010-02-19}
   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.2
+  version: 0.1.5
 platform: ruby
 authors: 
 - Emilio Cavazos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-15 00:00:00 -08:00
+date: 2010-02-19 00:00:00 -08:00
 default_executable: stowaway
 dependencies: []