stowaway 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Emilio Cavazos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+# 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:
+
+ * .jpg 
+ * .gif 
+ * .png 
+ * .ico
+ * .js
+ * .css
+
+## Installing
+
+    sudo gem install ecavazos-stowaway
+    
+## Note
+
+I'll be adding support for matching on relative and absolute paths.  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.  Comparing by path will preserve the uniqueness of the file.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rake'
+ 
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stowaway"
+    gem.summary = "Locate files in a web project that aren't being used."
+    gem.authors = ["Emilio Cavazos"]
+    gem.email = "ejcavazos@gmail.com"
+    gem.homepage = "http://www.iamneato.com"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "test-jeweler #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO.txt

@@ -0,0 +1,6 @@
+== 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
+* specify runner.rb
+  * clean up it's dependencies

data/VERSION.yml

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

data/bin/stowaway

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

data/lib/stowaway/file.rb

@@ -0,0 +1,21 @@
+module Stowaway
+  class FileObj
+    attr :fullpath
+    
+    def initialize(fullpath)
+      @fullpath = fullpath
+    end
+    
+    def name
+      File.basename(@fullpath)
+    end
+    
+    def path
+      File.split(@fullpath)[0]
+    end
+    
+    def ==(fileObj)
+      self.fullpath == fileObj.fullpath
+    end
+  end
+end

data/lib/stowaway/fshelpyhelp.rb

@@ -0,0 +1,10 @@
+module FSHelpyHelp
+  def ignore? file
+    @ignore.each do |s|
+      if file.match(/#{s}/i)
+        return true
+      end
+    end
+    false
+  end
+end

data/lib/stowaway/locator.rb

@@ -0,0 +1,39 @@
+require_relative 'fshelpyhelp'
+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 = [])
+    
+      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)
+          files << FileObj.new(file)
+        end
+      end
+      files
+    end
+    
+  end
+end

data/lib/stowaway/options.rb

@@ -0,0 +1,40 @@
+require 'optparse'
+
+module Stowaway
+  class Options
+    DEFAULT_FILE_TYPES = %w{.jpg .gif .png .ico .js .css}
+    
+    attr_reader :path, :file_types
+    
+    def initialize(argv)
+      @file_types = DEFAULT_FILE_TYPES
+      parse(argv)
+      @path = argv[0]
+    end
+    
+    private
+    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
+
+        opts.on("-h", "--help", "Show this message") do
+          puts opts 
+          exit 
+        end 
+        
+        begin 
+          argv = ["-h"] if argv.empty? 
+          opts.parse!(argv) 
+        rescue OptionParser::ParseError => e 
+          STDERR.puts e.message, "\n", opts 
+          exit(-1) 
+        end 
+        
+      end 
+    end 
+  end 
+end 

data/lib/stowaway/runner.rb

@@ -0,0 +1,32 @@
+require_relative 'options'
+require_relative 'locator'
+require_relative 'sweeper'
+
+module Stowaway
+  class Runner
+    
+    def initialize(argv)
+      @options = Options.new(argv)
+    end
+    
+    def run
+      locator = Stowaway::Locator.new(@options.file_types)
+      files = locator.find_all @options.path
+
+      fs = Stowaway::Sweeper.new files
+      respond fs.sweep @options.path
+    end
+    
+    private
+    def respond(not_found)
+      if not_found.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 "\n"
+      end
+    end
+  end
+end

data/lib/stowaway/sweeper.rb

@@ -0,0 +1,42 @@
+require_relative 'fshelpyhelp'
+
+module Stowaway
+  class Sweeper
+    include FSHelpyHelp
+
+    def initialize(files_to_find, ext_to_ignore = nil)
+      @files_to_find = files_to_find
+      @ignore = ext_to_ignore || ["^\\.", ".png", ".gif", ".jpg"]
+    end
+  
+    def inspect_file(file)
+      File.open(file, 'r') do |i|
+        while line = i.gets
+          remove_matches(line)
+        end
+      end
+    end
+
+    def remove_matches(line)
+      @files_to_find.delete_if { |file| line.include?(file.name) }
+    end
+  
+    def sweep(path)
+      dir = Dir.new(path)
+    
+      dir.each do |f|
+        next if ignore?(f)
+      
+        file = File.join(dir.path, f)
+      
+        if File.directory?(file)
+          sweep(file)
+        else
+          inspect_file(file)
+        end
+      end
+      @files_to_find
+    end
+
+  end
+end

data/spec/data/testfile1.txt

@@ -0,0 +1,4 @@
+this is a line of test text.
+this line has the name of a file: file1.jpg.
+this line also has the name of a file (file2.gif) and it is so awesome.
+the end.

data/spec/data/testfile2.txt

@@ -0,0 +1,2 @@
+Hello, I'm test data:
+file3.js

data/spec/lib/file_spec.rb

@@ -0,0 +1,29 @@
+require 'spec/spec_helper'
+require 'lib/stowaway/file'
+
+describe Stowaway::FileObj do
+  
+  before(:all) do
+    @file = Stowaway::FileObj.new('/fake/path/test.rb')
+  end
+  
+  it "should return full path" do
+    @file.fullpath.should == '/fake/path/test.rb'
+  end
+  
+  it "should return name of file" do
+    @file.name.should == 'test.rb'
+  end
+  
+  it "should return path to file" 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')
+  end
+  
+  it "should not be == if paths are differet" do
+    @file.should_not == Stowaway::FileObj.new('/blah/test.rb')
+  end
+end

data/spec/lib/options_spec.rb

@@ -0,0 +1,25 @@
+require 'spec/spec_helper'
+require 'lib/stowaway/options'
+
+describe Stowaway::Options do
+  
+  it "should use the the default file types when none are provided" do
+    opts = Stowaway::Options.new(['fake/path'])
+    Stowaway::Options::DEFAULT_FILE_TYPES.should == %w{.jpg .gif .png .ico .js .css}
+  end
+  
+  it "should use the file types provided by user" do
+    opts = Stowaway::Options.new(['-t', '.png .jpg', 'fake/path'])
+    opts.file_types.should == %w{.png .jpg}
+  end
+  
+  it "should parse path provided by user when file types are provided" do
+    opts = Stowaway::Options.new(['-t', '.png .jpg', 'fake/path'])
+    opts.path.should == 'fake/path'
+  end
+  
+  it "should parse path provided by user when no file types are provided" do
+    opts = Stowaway::Options.new(['fake/path'])
+    opts.path.should == 'fake/path'
+  end
+end

data/spec/lib/sweeper_spec.rb

@@ -0,0 +1,36 @@
+require 'spec/spec_helper'
+require 'lib/stowaway/file'
+require 'lib/stowaway/sweeper'
+
+describe Stowaway::Sweeper do
+  
+  before(:each) do
+    @f1 = Stowaway::FileObj.new('/fake/file1.jpg')
+    @f2 = Stowaway::FileObj.new('/fake/file2.gif')
+    @f3 = Stowaway::FileObj.new('/fake/file3.js')
+    @files = [@f1, @f2, @f3]
+    @sweeper = Stowaway::Sweeper.new(@files)
+  end
+  
+  it "should sweep through directory structure 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
+  end
+
+  it "should read through the file looking for matches" do
+    @sweeper.inspect_file('spec/data/testfile1.txt')
+    @files.should == [@f3]
+  end
+  
+  it "should remove matches from the list of files to find" do
+    line = 'file2.gif, file3.js'
+    @sweeper.remove_matches line
+    @files.should == [@f1]
+  end
+  
+end

data/spec/runner_spec.rb

@@ -0,0 +1,8 @@
+require 'spec/spec_helper'
+require 'lib/stowaway/runner'
+
+describe Stowaway::Runner do
+  it "should be tested" do
+    
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'spec'
+require 'spec/autorun'
+require 'spec/interop/test'

data/stowaway.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stowaway}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Emilio Cavazos"]
+  s.date = %q{2009-09-30}
+  s.default_executable = %q{stowaway}
+  s.email = %q{ejcavazos@gmail.com}
+  s.executables = ["stowaway"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.md",
+     "Rakefile",
+     "TODO.txt",
+     "VERSION.yml",
+     "bin/stowaway",
+     "lib/stowaway/file.rb",
+     "lib/stowaway/fshelpyhelp.rb",
+     "lib/stowaway/locator.rb",
+     "lib/stowaway/options.rb",
+     "lib/stowaway/runner.rb",
+     "lib/stowaway/sweeper.rb",
+     "spec/data/testfile1.txt",
+     "spec/data/testfile2.txt",
+     "spec/lib/file_spec.rb",
+     "spec/lib/locator_spec.rb",
+     "spec/lib/options_spec.rb",
+     "spec/lib/sweeper_spec.rb",
+     "spec/runner_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "stowaway.gemspec"
+  ]
+  s.homepage = %q{http://www.iamneato.com}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Locate files in a web project that aren't being used.}
+  s.test_files = [
+    "spec/lib/file_spec.rb",
+     "spec/lib/locator_spec.rb",
+     "spec/lib/options_spec.rb",
+     "spec/lib/sweeper_spec.rb",
+     "spec/runner_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: stowaway
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Emilio Cavazos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-30 00:00:00 -07:00
+default_executable: stowaway
+dependencies: []
+
+description: 
+email: ejcavazos@gmail.com
+executables: 
+- stowaway
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- TODO.txt
+- VERSION.yml
+- bin/stowaway
+- lib/stowaway/file.rb
+- lib/stowaway/fshelpyhelp.rb
+- lib/stowaway/locator.rb
+- lib/stowaway/options.rb
+- lib/stowaway/runner.rb
+- lib/stowaway/sweeper.rb
+- spec/data/testfile1.txt
+- spec/data/testfile2.txt
+- spec/lib/file_spec.rb
+- spec/lib/locator_spec.rb
+- spec/lib/options_spec.rb
+- spec/lib/sweeper_spec.rb
+- spec/runner_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- stowaway.gemspec
+has_rdoc: true
+homepage: http://www.iamneato.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Locate files in a web project that aren't being used.
+test_files: 
+- spec/lib/file_spec.rb
+- spec/lib/locator_spec.rb
+- spec/lib/options_spec.rb
+- spec/lib/sweeper_spec.rb
+- spec/runner_spec.rb
+- spec/spec_helper.rb