adamh-glob_fu 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 adamh
+
+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.rdoc

@@ -0,0 +1,55 @@
+= glob_fu
+
+Matches files using Dir.glob... and so much more.
+
+== Usage
+
+Some examples:
+
+  # Finds /home/adam/x -- same as Dir.glob
+  GlobFu.find('/home/adam/x')
+
+  # Finds /home/adam/* -- same as Dir.glob
+  GlobFu.find('/home/adam/*')
+
+  # Iterates over /home/adam/* -- same as Dir.glob
+  GlobFu.find('/home/adam/*') { |f| puts f }
+
+  # Finds /home/adam/.../x -- same as Dir.glob
+  GlobFu.find('/home/adam/**/x')
+
+  # Finds /home/adam/*
+  GlobFu.find('*', :root => '/home/adam')
+
+  # Finds /home/adam/* and /home/adam/subdir/*
+  GlobFu.find('*', 'subdir/*', :root => '/home/adam')
+
+  # Finds /*.txt but not /*.anything.txt
+  GlobFu.find('/*', :suffix => 'txt')
+
+  # Finds /*.txt, including /*.anything.txt -- just don't use :suffix
+  GlobFu.find('/*.txt')
+
+  # Finds /*.txt(.gz)?, preferring .gz but falling back to plain .txt
+  GlobFu.find('/*', :suffix => 'txt', :optional_suffix => 'gz')
+
+  # Finds /*.something.txt
+  GlobFu.find('/*', :suffix => 'txt', :extra_suffix => 'something')
+
+== Features
+
+* Removes duplicates
+* Sorts each glob alphabetically, for consistent results
+
+== Copyright
+
+I believe in software freedom, not any abomination thereof. This project is
+released under the Public Domain, meaning I relinquish my copyright (to any
+extend the law allows) and grant you all rights to use, modify, sell, or
+otherwise take advantage of my software.
+
+However, I do kindly request that, as a favor, you refrain from using my
+software as part of an evil plan involving velociraptors and mind-controlling
+robots (even though I would not be legally entitled to sue you for doing so). 
+
+- Adam Hooper

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "glob_fu"
+    gem.summary = %Q{TODO}
+    gem.email = "adam@adamhooper.com"
+    gem.homepage = "http://github.com/adamh/glob_fu"
+    gem.authors = ["adamh"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+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.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "glob_fu #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/glob_fu.gemspec

@@ -0,0 +1,50 @@
+# 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{glob_fu}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["adamh"]
+  s.date = %q{2009-08-19}
+  s.email = %q{adam@adamhooper.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "glob_fu.gemspec",
+     "lib/glob_fu.rb",
+     "spec/glob_fu_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/adamh/glob_fu}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{TODO}
+  s.test_files = [
+    "spec/glob_fu_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/glob_fu.rb

@@ -0,0 +1,65 @@
+module GlobFu
+  class << self
+    def find(*args, &block)
+      options = if Hash === args.last
+        args.pop
+      else
+        {}
+      end
+      results = do_find(args, options)
+
+      if block
+        results.each(&block)
+      end
+      results
+    end
+
+    private
+
+    def do_find(args, options)
+      if [:root, :suffix].any? { |k| options[k] }
+        args = args.dup
+      end
+
+      if options[:root]
+        args.collect! { |a| File.join(options[:root], a) }
+      end
+
+      if options[:suffix]
+        args.collect! { |a| "#{a}.*" }
+      end
+
+      ret = args.inject([]) { |r,a| r.concat(do_single_find(a, options)) }
+      ret.uniq!
+      ret
+    end
+
+    def do_single_find(path, options)
+      ret = Dir[path]
+
+      if options[:suffix]
+        n_dots = File.basename(path).count('.')
+        basename_regex = (['[^\.]+'] * n_dots).join('\.')
+
+        suffix_regex = ""
+        if options[:extra_suffix]
+          suffix_regex << "\.#{Regexp.quote(options[:extra_suffix])}"
+        end
+        suffix_regex << "\.#{Regexp.quote(options[:suffix])}"
+        if options[:optional_suffix]
+          suffix_regex << "(\.#{Regexp.quote(options[:optional_suffix])})?"
+        end
+
+        regex = %r{(/|^)#{basename_regex}#{suffix_regex}$}
+        ret.reject! { |f| !(f =~ regex) }
+        if options[:optional_suffix]
+          ret.reject! { |f| f =~ /\.#{Regexp.quote(options[:suffix])}$/ && File.exist?("#{f}.#{options[:optional_suffix]}") }
+        end
+      end
+
+      ret.sort!
+
+      ret
+    end
+  end
+end

data/spec/glob_fu_spec.rb

@@ -0,0 +1,126 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe(GlobFu) do
+  after(:each) do
+    wipe_fs
+  end
+
+  describe('#find') do
+    it('should find /full/path/to/x') do
+      fs('x')
+      f("#{prefix}/x").should == ["#{prefix}/x"]
+    end
+
+    it('should order x before y') do
+      Dir.should_receive(:[]).and_return(["#{prefix}/y", "#{prefix}/x"])
+      f("#{prefix}/*").should == ["#{prefix}/x", "#{prefix}/y"]
+    end
+
+    it('should order first-glob before second-glob') do
+      fs('y', 'x')
+      f('y', 'x', :root => prefix).should == ["#{prefix}/y", "#{prefix}/x"]
+    end
+
+    it('should find /full/path/to/*') do
+      fs('x')
+      f("#{prefix}/*").should == ["#{prefix}/x"]
+    end
+
+    it('should iterate over results') do
+      fs('x')
+      yielded = nil
+      f("#{prefix}/x") { |f| yielded = f }
+      yielded.should == "#{prefix}/x"
+    end
+
+    it('should glob "**"') do
+      fs('x/y')
+      f("#{prefix}/**/y").should == ["#{prefix}/x/y"]
+    end
+
+    it('should use :root') do
+      fs('x')
+      f('x', :root => prefix).should == ["#{prefix}/x"]
+    end
+
+    it('should allow two arguments') do
+      fs('x', 'y')
+      f('x', 'y', :root => prefix).should == ["#{prefix}/x", "#{prefix}/y"]
+    end
+
+    it('should remove duplicates') do
+      fs('x')
+      f('x', 'x', :root => prefix).should == ["#{prefix}/x"]
+    end
+
+    it('should use :suffix') do
+      fs('x.txt')
+      f('x', :root => prefix, :suffix => 'txt').should == ["#{prefix}/x.txt"]
+    end
+
+    it('should ignore double-suffixed when using :suffix') do
+      fs('x.X.txt')
+      f('*', :root => prefix, :suffix => 'txt').should == []
+    end
+
+    it('should use :optional_suffix to find files') do
+      fs('x.txt.gz')
+      f('x', :root => prefix, :suffix => 'txt', :optional_suffix => 'gz').should == ["#{prefix}/x.txt.gz"]
+    end
+
+    it('should prefer :optional_suffix over other') do
+      fs('x.txt', 'x.txt.gz')
+      f('x', :root => prefix, :suffix => 'txt', :optional_suffix => 'gz').should == ["#{prefix}/x.txt.gz"]
+    end
+
+    it('should fall back to non-:optional_suffix if it is not there') do
+      fs('x.txt')
+      f('x', :root => prefix, :suffix => 'txt', :optional_suffix => 'gz').should == ["#{prefix}/x.txt"]
+    end
+
+    it('should allow :extra_suffix') do
+      fs('x.X.txt')
+      f('x', :root => prefix, :suffix => 'txt', :extra_suffix => 'X').should == ["#{prefix}/x.X.txt"]
+    end
+
+    it('should ignore un-:extra_suffixed') do
+      fs('x.txt')
+      f('x', :root => prefix, :suffix => 'txt', :extra_suffix => 'X').should == []
+    end
+
+    it('should allow :extra_suffix and :optional_suffix in combination') do
+      fs('x.X.txt.gz')
+      f('x', :root => prefix, :suffix => 'txt', :extra_suffix => 'X', :optional_suffix => 'gz').should == ["#{prefix}/x.X.txt.gz"]
+    end
+  end
+
+  private
+
+  def f(*args, &block)
+    GlobFu.find(*args, &block)
+  end
+
+  def prefix
+    @prefix ||= File.dirname(__FILE__) + '/deleteme'
+  end
+
+  def fs(*files)
+    wipe_fs
+    FileUtils.mkdir(prefix)
+
+    files.each do |file|
+      path = File.join(prefix, file)
+      dir = File.dirname(path)
+      unless File.exist?(dir)
+        FileUtils.mkdir_p(dir)
+      end
+      File.open(path, 'w') { |f| f.write("stub\n") }
+    end
+  end
+
+  def wipe_fs
+    if File.exist?(prefix)
+      FileUtils.rm_r(prefix)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/glob_fu'

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: adamh-glob_fu
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- adamh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: adam@adamhooper.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- glob_fu.gemspec
+- lib/glob_fu.rb
+- spec/glob_fu_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/adamh/glob_fu
+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: 2
+summary: TODO
+test_files: 
+- spec/glob_fu_spec.rb
+- spec/spec_helper.rb