stowaway 0.1.9 → 0.1.10

data/TODO.txt

@@ -4,6 +4,5 @@
   the files that were only partially matched on name.
 * ignore vendor folder
 * ignore spec folder
-* move appropriate sweeper tests to matcher
+* DRY options.rb
 * specify runner.rb
-  * clean up it's dependencies

data/VERSION.yml

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

data/bin/stowaway

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

data/lib/stowaway/locator.rb

@@ -4,29 +4,22 @@ require_relative 'file'
 module Stowaway
   class Locator
     include FSHelpyHelp
-  
+
     def initialize(extensions)
       @extensions = extensions
       @ignore = [/^\./]
     end
-  
-    def type?(file)
-      @extensions.each do |e|
-        return true if file.match(/#{e}$/)
-      end
-      false
-    end
-  
+
     def find_all(path, files = [])
       @root = path if @root.nil?
 
       dir = Dir.new(path)
-    
+
       dir.each do |f|
         next if ignore?(f)
-        
+
         file = File.join(dir.path, f)
-        
+
         if File.directory?(file) 
           find_all file, files
         elsif type?(f)
@@ -35,6 +28,12 @@ module Stowaway
       end
       files
     end
-    
+
+    def type?(file)
+      @extensions.each do |e|
+        return true if file.match(/#{e}$/)
+      end
+      false
+    end
   end
 end

data/lib/stowaway/options.rb

@@ -8,34 +8,41 @@ module Stowaway
     
     def initialize(argv)
       @file_types = DEFAULT_FILE_TYPES
-      parse(argv)
-      @path = argv[0]
+      @argv = argv
+      parse
     end
     
     private
+    def parse
+      OptionParser.new do |opts|
+        opts.banner = "Usage: stowaway [ options ] path/to/site"
 
-    def parse(argv) 
-      OptionParser.new do |opts| 
-        opts.banner = "Usage: stowaway [ options ] path/to/site" 
-        
-        opts.on("-t", "--types <TYPES>", String, "File types to search for (ex: .jpg .gif)") do |ext| 
-          @file_types = ext.split(' ')
-        end
+        parse_types(opts)
+        parse_help(opts)
 
-        opts.on("-h", "--help", "Show this message") do
-          puts opts 
-          exit 
-        end 
-        
         begin 
-          argv = ["-h"] if argv.empty? 
-          opts.parse!(argv) 
+          @argv = ["-h"] if @argv.empty?
+          opts.parse!(@argv) 
         rescue OptionParser::ParseError => e 
           STDERR.puts e.message, "\n", opts 
           exit(-1) 
         end 
-        
+
+        @path = @argv[0]
       end 
     end 
-  end 
+
+    def parse_types opts
+      opts.on("-t", "--types <TYPES>", String, "File types to search for (ex: .jpg .gif)") do |ext| 
+        @file_types = ext.split(' ')
+      end
+    end
+
+    def parse_help opts
+      opts.on("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+    end
+  end
 end 

data/lib/stowaway/runner.rb

@@ -5,19 +5,18 @@ require_relative 'sweeper'
 module Stowaway
   class Runner
     
-    def initialize(argv)
-      @options = Options.new(argv)
+    def initialize(options, locator, sweeper)
+      @options = options
+      @locator = locator
+      @sweeper = sweeper
     end
     
     def run
+      path = @options.path
       print "\nLocating files ... "
-      locator = Stowaway::Locator.new(@options.file_types)
-      files = locator.find_all @options.path
-      @total = files.length
-      p "#{@total} files located"
-      
-      fs = Stowaway::Sweeper.new files
-      respond fs.sweep @options.path
+      files = @locator.find_all(path)
+      print "#{files.length} files located\n"
+      respond @sweeper.sweep(path, files)
     end
     
     private

data/lib/stowaway/sweeper.rb

@@ -5,18 +5,24 @@ require_relative "file"
 require "ostruct"
 
 module Stowaway
+
+  # Sweeper will sweep through a directory recursively (path) and try to find
+  # references to files in the array of FileObjs passed in as the second
+  # parameter.
+
   class Sweeper
     include FSHelpyHelp
 
-    def initialize(files, status = Status.new, matcher = Matcher.new, ext_to_ignore = [])
-      @result = OpenStruct.new({ :files => files, :name_only_matches => []})
+    def initialize(status = Status.new, matcher = Matcher.new, ext_to_ignore = [])
       @status = status
       @matcher = matcher
       @ignore = ext_to_ignore || []
       @ignore += [/^\.|\.jpg$|\.jpeg$|\.gif$|\.png$|\.ico$|\.bmp$/i]
     end
 
-    def sweep(path)
+    def sweep(path, files=nil)
+      @result ||= OpenStruct.new({ :files => files, :name_only_matches => []})
+
       dir = Dir.new(path)
 
       dir.each do |f|

data/spec/lib/sweeper_spec.rb

@@ -6,59 +6,58 @@ require "lib/stowaway/matcher"
 describe Stowaway::Sweeper do
   
   def sweeper(ignore = nil)
-    @sweeper ||= Stowaway::Sweeper.new(@files, @status_mock, Stowaway::Matcher.new, ignore)
+    @sweeper ||= Stowaway::Sweeper.new(@status_mock, Stowaway::Matcher.new, ignore)
   end
 
   before(:each) do
-    @files = []
     @status_mock = mock("status_mock", :null_object => true)
   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.should be_empty
+    files = [Stowaway::FileObj.new("/fake/path1/button.jpg")]
+    sweeper.sweep("spec/data", 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("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("/fake/path1/button.jpg")
-    sweeper([/^\.|\.rb$|\.txt$/]).sweep("spec/data")
-    @files.length.should == 1
+    files = [Stowaway::FileObj.new("/fake/path1/button.jpg")]
+    sweeper([/^\.|\.rb$|\.txt$/]).sweep("spec/data", files)
+    files.length.should == 1
   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")
+    sweeper([/^\.|\.rb$|testfile2/]).sweep("spec/data", [])
   end
 
   it "should flush the output after sweeping through a file" do 
     @status_mock.should_receive(:flush).once
-    sweeper([/^\.|\.rb$|testfile2/]).sweep("spec/data")
+    sweeper([/^\.|\.rb$|testfile2/]).sweep("spec/data", [])
   end
 
   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
+    files = [Stowaway::FileObj.new("/fake/path1/button.jpg"),
+             Stowaway::FileObj.new("/fake/path2/button.jpg")]
+    sweeper([/^\.|\.rb$/]).sweep("spec/data", files)
+    files.should be_empty
   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
+  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([/^\.|\.rb$/]).sweep("spec/data", 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([/^\.|\.rb$/]).sweep("spec/data")
-    @files.should_not be_empty
-    @files.first.fullpath.should == "/a/stowaway.txt"
+    files = [Stowaway::FileObj.new("/a/stowaway.txt")]
+    sweeper([/^\.|\.rb$/]).sweep("spec/data", files)
+    files.should_not be_empty
+    files.first.fullpath.should == "/a/stowaway.txt"
   end
   
 end

data/spec/runner_spec.rb

@@ -2,7 +2,29 @@ require 'spec/spec_helper'
 require 'lib/stowaway/runner'
 
 describe Stowaway::Runner do
-  it "should be tested :)" do
-    
+
+  before(:each) do
+    @argv = []
+  end
+
+  def runner
+    options = Stowaway::Options.new(@argv)
+    locator = Stowaway::Locator.new(options.file_types)
+    sweeper = Stowaway::Sweeper.new
+    @runner ||= Stowaway::Runner.new(options, locator, sweeper)
+  end
+
+  it "should notify user that file location has begun" do
+    @argv << "."
+    runner.should_receive(:print).with("\nLocating files ... ")
+    runner.should_receive(:print).any_number_of_times
+    runner.run
+  end
+
+  it "should notify user of the total number of files that were found" do
+    @argv << "."
+    runner.should_receive(:print).with("0 files located\n").any_number_of_times
+    runner.should_receive(:print).any_number_of_times
+    runner.run
   end
-end
+end

data/stowaway.gemspec

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