stowaway 0.2.2 → 0.2.5

data/VERSION.yml

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

data/bin/stowaway

@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-require 'lib/stowaway/runner' 
+require "lib/stowaway/runner"
 
 options = Stowaway::Options.new(ARGV)
 locator = Stowaway::Locator.new(options.file_types)
 sweeper = Stowaway::Sweeper.new
-runner  = Stowaway::Runner.new(options, locator, sweeper) 
+runner  = Stowaway::Runner.new(options, locator, sweeper)
 runner.run

data/lib/stowaway/{file.rb → file_marker.rb}

@@ -1,5 +1,5 @@
 module Stowaway
-  class FileObj
+  class FileMarker
     attr :fullpath
 
     def initialize(fullpath, root = nil)
@@ -25,3 +25,4 @@ module Stowaway
     end
   end
 end
+

data/lib/stowaway/locator.rb

@@ -1,5 +1,5 @@
-require_relative 'fshelpyhelp'
-require_relative 'file'
+require_relative "fshelpyhelp"
+require_relative "file_marker"
 
 module Stowaway
   class Locator
@@ -10,18 +10,18 @@ module Stowaway
       @ignore = [/^\./]
     end
 
-    def find_all(path)
-      @root = path
+    def find_all(target_context)
+      @context = target_context
       @files = []
-      ignore_special_directories(@root)
-      recursively(path) do |file_p|
+      ignore_special_directories(@context.root)
+      recursively(@context.root) do |file_p|
         push_if_ext_match(file_p)
       end
       @files
     end
 
     def push_if_ext_match(file_p)
-      @files << FileObj.new(file_p, @root) if type?(file_p)
+      @files << FileMarker.new(file_p, @context.root) if type?(file_p)
     end
 
     def type?(file)

data/lib/stowaway/matcher.rb

@@ -1,4 +1,4 @@
-require_relative "File"
+require_relative "file_marker"
 
 module Stowaway
   class Matcher

data/lib/stowaway/runner.rb

@@ -1,30 +1,37 @@
-require_relative 'options'
-require_relative 'locator'
-require_relative 'sweeper'
+require_relative "options"
+require_relative "locator"
+require_relative "sweeper"
+require_relative "target_context"
 
 module Stowaway
   class Runner
-    
+
     def initialize(options, locator, sweeper)
       @options = options
       @locator = locator
       @sweeper = sweeper
     end
-    
+
+    #TODO: clean-up all the print and puts methods and use
     def run
-      path = @options.path
+      context = TargetContext.new(@options.path)
+      assets = locate_assets(context)
+      Dir.chdir(context.root)
+      puts "sweeping: #{Dir.pwd}"
+      display_results(@sweeper.sweep(context, assets))
+    end
+
+    private
+
+    def locate_assets(context)
       print "\nLocating files ... "
-      assets = @locator.find_all(path)
+      assets = @locator.find_all(context)
       print "#{assets.length} files located"
       blank_lines
-      Dir.chdir(@options.path)
-      puts "sweeping: #{Dir.pwd}"
-      respond @sweeper.sweep(path, assets)
+      assets
     end
-    
-    private
 
-    def respond(result)
+    def display_results(result)
       files = result.files
       name_only_matches = result.name_only_matches
 
@@ -37,23 +44,22 @@ module Stowaway
         blank_lines
         return
       end
-      
+
       damage(result)
     end
-    
+
     def damage(result)
       files = result.files
       name_only_matches = result.name_only_matches
 
       print "\nYou have #{files.length} stowaway(s) ... scurvy dogs!\n"
-      warn name_only_matches
+      warn name_only_matches unless name_only_matches.empty?
       60.times { print "-" }
       blank_lines
       files.each_with_index { |f, i| print "#{i+1}: #{f.root_path}\n" }
     end
 
     def warn name_only_matches
-        return if name_only_matches.empty?
         print "WARNING: #{name_only_matches.length} file(s) partially matched on name only\n"
     end
 

data/lib/stowaway/sweeper.rb

@@ -1,7 +1,7 @@
 require_relative "fshelpyhelp"
 require_relative "output"
 require_relative "matcher"
-require_relative "file"
+require_relative "file_marker"
 require "ostruct"
 
 module Stowaway
@@ -14,24 +14,23 @@ module Stowaway
     include FSHelpyHelp
     include Output
 
-    def initialize(matcher = Matcher.new, ext_to_ignore = [])
+    def initialize(matcher = Matcher.new)
       @matcher = matcher
-      @ignore = ext_to_ignore
-      @ignore << /^\.|\.jpg$|\.jpeg$|\.gif$|\.png$|\.ico$|\.bmp$/i
+      @ignore = [/^\.|\.jpg$|\.jpeg$|\.gif$|\.png$|\.ico$|\.bmp$/i]
     end
 
-    def sweep(path, files)
-      @root = path
+    def sweep(target_context, files)
+      @context = target_context
       @result = OpenStruct.new({ :files => files, :name_only_matches => []})
-      ignore_special_directories(@root)
-      recursively(path) { |fp| inspect_file(fp) }
+      ignore_special_directories(@context.root)
+      recursively(@context.root) { |fp| inspect_file(fp) }
       @result
     end
 
     private
 
     def inspect_file(file_p)
-      clr_print("  => #{path_relative_to_root(file_p)}")
+      clr_print("  => #{@context.path_relative_to_root(file_p)}")
       File.open(file_p, "r") do |i|
         while line = i.gets
           next unless line.valid_encoding?
@@ -41,11 +40,6 @@ module Stowaway
       flush
     end
 
-    def path_relative_to_root(file_p)
-      root = @root.split("/").last
-      file_p.sub(/^.+\/(#{root})/, "")
-    end
-
     def remove_match(line)
       @result.files.delete_if do |file|
         if @matcher.match?(line, file)

data/lib/stowaway/target_context.rb

@@ -0,0 +1,14 @@
+module Stowaway
+  class TargetContext
+    def initialize(root)
+      @root = root
+    end
+
+    attr_reader :root
+
+    def path_relative_to_root(file_p)
+      root = @root.split("/").last
+      file_p.sub(/^.+\/(#{root})/, "")
+    end
+  end
+end

data/spec/lib/file_spec.rb

@@ -1,10 +1,9 @@
-require 'spec/spec_helper'
-require 'lib/stowaway/file'
+require "spec/spec_helper"
+require "lib/stowaway/file_marker"
 
-describe Stowaway::FileObj do
-  
+describe Stowaway::FileMarker do
   before(:all) do
-    @file = Stowaway::FileObj.new('/fake/path/test.rb')
+    @file = Stowaway::FileMarker.new('/fake/path/test.rb')
   end
   
   it "should return full path" do
@@ -19,11 +18,11 @@ describe Stowaway::FileObj do
     @file.path.should == '/fake/path'
   end
   
-  it "should be == if paths are the same" do
-    @file.should == Stowaway::FileObj.new('/fake/path/test.rb')
+  it "should be equal if paths are the same" do
+    @file.should == Stowaway::FileMarker.new('/fake/path/test.rb')
   end
   
-  it "should not be == if paths are differet" do
-    @file.should_not == Stowaway::FileObj.new('/blah/test.rb')
+  it "should not be equal if paths are different" do
+    @file.should_not == Stowaway::FileMarker.new('/blah/test.rb')
   end
-end
+end

data/spec/lib/locator_spec.rb

@@ -1,34 +1,34 @@
-require 'spec/spec_helper'
-require 'lib/stowaway/file'
-require 'lib/stowaway/locator'
+require "spec/spec_helper"
+require "lib/stowaway/file_marker"
+require "lib/stowaway/locator"
+require "lib/stowaway/target_context"
 
 describe Stowaway::Locator do
   
-  def locator
-    @locator ||= Stowaway::Locator.new(%w{.txt})
-  end
-  
+  let(:locator) { Stowaway::Locator.new(%w{.txt}) }
+  let(:context) { Stowaway::TargetContext.new("spec/data") }
+
   it "should be initialized with an array of file extensions to locate" do
-    locator.find_all('spec/data/').length.should == 2
+    locator.find_all(context).length.should == 2
   end
   
-  it "should return an array of FileObj" do
-    @f1 = Stowaway::FileObj.new('spec/data/testfile1.txt')
-    locator.find_all('spec/data')[1].instance_of?(Stowaway::FileObj).should be_true
+  it "should return an array of FileMarker" do
+    @f1 = Stowaway::FileMarker.new("spec/data/testfile1.txt")
+    locator.find_all(context)[1].instance_of?(Stowaway::FileMarker).should be_true
   end
   
   it "should return all matched files" do
-    @f1 = Stowaway::FileObj.new('spec/data/testfile1.txt', "spec/data")
-    @f2 = Stowaway::FileObj.new('spec/data/testfile2.txt', "spec/data")
-    locator.find_all('spec/data/').should == [@f1, @f2]
+    @f1 = Stowaway::FileMarker.new("spec/data/testfile1.txt", "spec/data")
+    @f2 = Stowaway::FileMarker.new("spec/data/testfile2.txt", "spec/data")
+    locator.find_all(context).should == [@f1, @f2]
   end
   
   it "should return true when file has the correct extension" do
-    locator.type?('poop.txt').should be_true
+    locator.type?("poop.txt").should be_true
   end
   
   it "should return false when file doesn't have the correct extension" do
-    locator.type?('poop.stink').should be_false
+    locator.type?("poop.stink").should be_false
   end
   
 end

data/spec/lib/matcher_spec.rb

@@ -1,5 +1,5 @@
 require "spec/spec_helper"
-require "lib/stowaway/file"
+require "lib/stowaway/file_marker"
 require "lib/stowaway/matcher"
 
 describe Stowaway::Matcher do
@@ -11,25 +11,25 @@ describe Stowaway::Matcher do
   describe "when given html" do
     it "should match files referenced from a src attribute" do
       line = "test html: <img src='/images/foo.jpg' />"
-      file = Stowaway::FileObj.new("/images/foo.jpg")
+      file = Stowaway::FileMarker.new("/images/foo.jpg")
       @matcher.match?(line, file).should be_true
     end
 
     it "should match files stored in /public referenced from a src attribute" do
       line = "test html: <img src='/images/foo.jpg' />"
-      file = Stowaway::FileObj.new("/public/images/foo.jpg")
+      file = Stowaway::FileMarker.new("/public/images/foo.jpg")
       @matcher.match?(line, file).should be_true
     end
 
     it "should match files referenced from an href attribute" do
       line = "test html: <a href='/images/foo.gif'>bar</a>"
-      file = Stowaway::FileObj.new("/images/foo.gif")
+      file = Stowaway::FileMarker.new("/images/foo.gif")
       @matcher.match?(line, file).should be_true
     end
 
     it "should match files stored in /public referenced from an href attribute" do
       line = "test html: <a href='/images/foo.gif'>bar</a>"
-      file = Stowaway::FileObj.new("/public/images/foo.gif")
+      file = Stowaway::FileMarker.new("/public/images/foo.gif")
       @matcher.match?(line, file).should be_true
     end
   end
@@ -37,25 +37,25 @@ describe Stowaway::Matcher do
   describe "when given haml" do
     it "should match files referenced from a src attribute" do
       line = "test haml: %img{ :src => '/images/foo.jpg', :alt => 'foo' }"
-      file = Stowaway::FileObj.new("/images/foo.jpg")
+      file = Stowaway::FileMarker.new("/images/foo.jpg")
       @matcher.match?(line, file).should be_true
     end
 
     it "should match files stored in /public referenced from a src attribute" do
       line = "test haml: %img{ :src => '/images/foo.jpg', :alt => 'foo' }"
-      file = Stowaway::FileObj.new("/public/images/foo.jpg")
+      file = Stowaway::FileMarker.new("/public/images/foo.jpg")
       @matcher.match?(line, file).should be_true
     end
 
     it "should match files referenced from an href attribute" do
       line = "%link{:href => '/styles/reset.css', :type => 'text/css'}"
-      file = Stowaway::FileObj.new("/styles/reset.css")
+      file = Stowaway::FileMarker.new("/styles/reset.css")
       @matcher.match?(line, file).should be_true
     end
 
     it "should match files stored in /public referenced from a href attribute" do
       line = "%link{:href => '/styles/reset.css', :type => 'text/css'}"
-      file = Stowaway::FileObj.new("/public/styles/reset.css")
+      file = Stowaway::FileMarker.new("/public/styles/reset.css")
       @matcher.match?(line, file).should be_true
     end
   end
@@ -63,13 +63,13 @@ describe Stowaway::Matcher do
   describe "when given javascript_include_tag" do
     it "should match files referenced" do
       line = "test rails: %=javascript_include_tag 'foo.js'"
-      file = Stowaway::FileObj.new("/public/javascripts/foo.js")
+      file = Stowaway::FileMarker.new("/public/javascripts/foo.js")
       @matcher.match?(line, file).should be_true
     end
 
     it "should match files referenced with multiple arguments" do
       line = "test rails: =javascript_include_tag 'foo.js', 'test/bar.js'"
-      file = Stowaway::FileObj.new("/public/javascripts/test/bar.js")
+      file = Stowaway::FileMarker.new("/public/javascripts/test/bar.js")
       @matcher.match?(line, file).should be_true
     end
   end
@@ -77,32 +77,32 @@ describe Stowaway::Matcher do
   describe "when given stylesheet_link_tag" do
     it "should match files referenced" do
       line = "test rails: %=stylesheet_link_tag 'foo.css'"
-      file = Stowaway::FileObj.new("/public/stylesheets/foo.css")
+      file = Stowaway::FileMarker.new("/public/stylesheets/foo.css")
       @matcher.match?(line, file).should be_true
     end
 
     it "should match files referenced" do
       line = "test rails: %=stylesheet_link_tag 'foo.css', 'to/file/bar.css'"
-      file = Stowaway::FileObj.new("/public/stylesheets/to/file/bar.css")
+      file = Stowaway::FileMarker.new("/public/stylesheets/to/file/bar.css")
       @matcher.match?(line, file).should be_true
     end
 
     describe "when given css" do
       it "should match files referenced in url()" do
         line = "background: url('/images/foo.png') no-repeat"
-        file = Stowaway::FileObj.new("/images/foo.png")
+        file = Stowaway::FileMarker.new("/images/foo.png")
         @matcher.match?(line, file).should be_true
       end
 
       it "should match files stored in /public referenced in url()" do
         line = "background: url(\"/images/foo.png\") no-repeat"
-        file = Stowaway::FileObj.new("/public/images/foo.png")
+        file = Stowaway::FileMarker.new("/public/images/foo.png")
         @matcher.match?(line, file).should be_true
       end
 
       it "should match files referenced in url() without quotes" do
         line = "background: url(/images/foo.png) no-repeat"
-        file = Stowaway::FileObj.new("/images/foo.png")
+        file = Stowaway::FileMarker.new("/images/foo.png")
         @matcher.match?(line, file).should be_true
       end
     end

data/spec/lib/sweeper_spec.rb

@@ -1,76 +1,79 @@
 require "spec/spec_helper"
-require "lib/stowaway/file"
+require "lib/stowaway/file_marker"
 require "lib/stowaway/sweeper"
 require "lib/stowaway/matcher"
+require "lib/stowaway/target_context"
 require "spec/lib/io_mock.rb"
 
 describe Stowaway::Sweeper do
 
-  Stowaway::Output.class_eval do
-    def print str;end
-  end
-
-  let(:sweeper) { Stowaway::Sweeper.new(Stowaway::Matcher.new, @ignore) }
+  let(:sweeper) { Stowaway::Sweeper.new(Stowaway::Matcher.new) }
+  let(:context) { Stowaway::TargetContext.new("spec/data") }
 
   before(:each) do
-    @ignore = [/^\.|\.rb$/]
+    ignore(/^\.|\.rb$/)
+    sweeper.extend Silencer
+  end
+
+  def ignore(pattern)
+    sweeper.instance_eval { @ignore << pattern }
   end
   
   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)
+    files = [Stowaway::FileMarker.new("/fake/path1/button.jpg")]
+    sweeper.sweep(context, files)
     files.should be_empty
   end
 
   it "should return an OpenStruct with the result of the sweeping" do
-    result = sweeper.sweep("spec/data", [])
+    result = sweeper.sweep(context, [])
     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
-    @ignore << /\.txt$/
-    files = [Stowaway::FileObj.new("/fake/path1/button.jpg")]
-    sweeper.sweep("spec/data", files)
+    ignore(/\.txt$/)
+    files = [Stowaway::FileMarker.new("/fake/path1/button.jpg")]
+    sweeper.sweep(context, files)
     files.length.should == 1
   end
   
   it "should print the path to the file (relative to root) being swept through" do 
-    @ignore << /testfile2/
+    ignore(/testfile2/)
     sweeper.should_receive(:clr_print).once.with("  => /testfile1.txt")
-    sweeper.sweep("spec/data", [])
+    sweeper.sweep(context, [])
   end
 
   it "should flush the output after sweeping through a file" do 
-    @ignore << /testfile2/
+    ignore(/testfile2/)
     sweeper.should_receive(:flush).once
-    sweeper.sweep("spec/data", [])
+    sweeper.sweep(context, [])
   end
 
   it "should files of the same name but with different paths as last resort" do
-    files = [Stowaway::FileObj.new("/fake/path1/button.jpg"),
-             Stowaway::FileObj.new("/fake/path2/button.jpg")]
-    sweeper.sweep("spec/data", files)
+    files = [Stowaway::FileMarker.new("/fake/path1/button.jpg"),
+             Stowaway::FileMarker.new("/fake/path2/button.jpg")]
+    sweeper.sweep(context, files)
     files.should be_empty
   end
 
   it "should add a file to an array of partially matched files when matched on name only" do
-    files = [Stowaway::FileObj.new("/missing/button.jpg")]
-    sweeper.sweep("spec/data", files).should have(1).name_only_matches
+    files = [Stowaway::FileMarker.new("/missing/button.jpg")]
+    sweeper.sweep(context, files).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.sweep("spec/data", files)
+    files = [Stowaway::FileMarker.new("/a/stowaway.txt")]
+    sweeper.sweep(context, files)
     files.should_not be_empty
     files.first.fullpath.should == "/a/stowaway.txt"
   end
 
   it "should ignore lines with invalid encoding" do
-    files = [Stowaway::FileObj.new("/fake/path1/button.jpg")]
+    files = [Stowaway::FileMarker.new("/fake/path1/button.jpg")]
     File.stub!(:open).and_yield(IOMock.new)
     sweeper.should_not_receive(:remove_match)
-    sweeper.sweep("spec/data", files)
+    sweeper.sweep(context, files)
   end
 
 end

data/spec/lib/target_context_spec.rb

@@ -0,0 +1,22 @@
+require "spec/spec_helper"
+require "lib/stowaway/target_context"
+
+describe Stowaway::TargetContext do
+  
+  let(:context) do
+    Stowaway::TargetContext.new(@root)
+  end
+
+  before(:each) do
+    @root = "/fake/path/to/root/"
+  end
+
+  it "should return the path the object was intialized with" do
+    context.root.should == @root
+  end
+
+  it "should transform path to be relative to the root directory" do
+    file_p = @root + "public/images/monkey_skull.gif"
+    context.path_relative_to_root(file_p).should == "/public/images/monkey_skull.gif"
+  end
+end

data/spec/runner_spec.rb

@@ -1,11 +1,5 @@
-require 'spec/spec_helper'
-require 'lib/stowaway/runner'
-
-class Stowaway::Status
-  # mock so I don't look at noise
-  def out(msg); end
-  def flush; end
-end
+require "spec/spec_helper"
+require "lib/stowaway/runner"
 
 describe Stowaway::Runner do
 
@@ -18,6 +12,7 @@ describe Stowaway::Runner do
   def runner
     sweeper = Stowaway::Sweeper.new
     @runner ||= Stowaway::Runner.new(@options, @locator, sweeper)
+    @runner.extend Silencer
   end
 
   describe "output" do
@@ -47,7 +42,7 @@ describe Stowaway::Runner do
   end
 
   it "should locate all assets" do
-    @locator.should_receive(:find_all).with(".").and_return([])
+    @locator.should_receive(:find_all).and_return([])
     runner.run
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,10 @@
 require 'spec'
 require 'spec/autorun'
-require 'spec/interop/test'
+require 'spec/interop/test'
+
+module Silencer
+  def print str;end
+  def puts str;end
+  def p str;end
+end
+

data/stowaway.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{stowaway}
-  s.version = "0.2.2"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emilio Cavazos"]
-  s.date = %q{2010-03-04}
+  s.date = %q{2010-03-06}
   s.default_executable = %q{stowaway}
   s.email = %q{ejcavazos@gmail.com}
   s.executables = ["stowaway"]
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
      "TODO.txt",
      "VERSION.yml",
      "bin/stowaway",
-     "lib/stowaway/file.rb",
+     "lib/stowaway/file_marker.rb",
      "lib/stowaway/fshelpyhelp.rb",
      "lib/stowaway/locator.rb",
      "lib/stowaway/matcher.rb",
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
      "lib/stowaway/output.rb",
      "lib/stowaway/runner.rb",
      "lib/stowaway/sweeper.rb",
+     "lib/stowaway/target_context.rb",
      "spec/data/testfile1.txt",
      "spec/data/testfile2.txt",
      "spec/lib/file_spec.rb",
@@ -42,6 +43,7 @@ Gem::Specification.new do |s|
      "spec/lib/options_spec.rb",
      "spec/lib/output_spec.rb",
      "spec/lib/sweeper_spec.rb",
+     "spec/lib/target_context_spec.rb",
      "spec/runner_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
@@ -60,6 +62,7 @@ Gem::Specification.new do |s|
      "spec/lib/options_spec.rb",
      "spec/lib/output_spec.rb",
      "spec/lib/sweeper_spec.rb",
+     "spec/lib/target_context_spec.rb",
      "spec/runner_spec.rb",
      "spec/spec_helper.rb"
   ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stowaway
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors: 
 - Emilio Cavazos
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-04 00:00:00 -08:00
+date: 2010-03-06 00:00:00 -08:00
 default_executable: stowaway
 dependencies: []
 
@@ -30,7 +30,7 @@ files:
 - TODO.txt
 - VERSION.yml
 - bin/stowaway
-- lib/stowaway/file.rb
+- lib/stowaway/file_marker.rb
 - lib/stowaway/fshelpyhelp.rb
 - lib/stowaway/locator.rb
 - lib/stowaway/matcher.rb
@@ -38,6 +38,7 @@ files:
 - lib/stowaway/output.rb
 - lib/stowaway/runner.rb
 - lib/stowaway/sweeper.rb
+- lib/stowaway/target_context.rb
 - spec/data/testfile1.txt
 - spec/data/testfile2.txt
 - spec/lib/file_spec.rb
@@ -47,6 +48,7 @@ files:
 - spec/lib/options_spec.rb
 - spec/lib/output_spec.rb
 - spec/lib/sweeper_spec.rb
+- spec/lib/target_context_spec.rb
 - spec/runner_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -87,5 +89,6 @@ test_files:
 - spec/lib/options_spec.rb
 - spec/lib/output_spec.rb
 - spec/lib/sweeper_spec.rb
+- spec/lib/target_context_spec.rb
 - spec/runner_spec.rb
 - spec/spec_helper.rb