file_glob 0.0.1

data/README.markdown

@@ -0,0 +1,35 @@
+FileGlob
+========
+
+Quacks like a Regexp, tastes like Dir.glob.
+
+Use this with any library that expects a regular expression.  Use FileGlob in place of a Regexp when [shell pattern matching ](http://www.ruby-doc.org/core-1.9.3/File.html#method-c-fnmatch) makes more sense.
+
+Usage 
+-----
+
+Filter a set of file paths:
+
+    glob = FileGlob.new("test/**/*_test.rb")
+    paths.select{|path| path =~ glob }
+    
+Perform different actions for different file types:
+    
+    image = FileGlob.new("*.{png,jpg,gif}")
+    text  = FileGlob.new("*.txt")
+    
+    case path
+    when image then process_image(path)
+    when text  then process_text(path)
+    end
+    
+Installation
+------------
+
+Install with rubygems:
+
+    gem install file_glob
+
+-----
+
+Adam Sanderson, http://www.monkeyandcrow.com

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+desc "Run tests"
+task :default => :test

data/lib/file_glob.rb

@@ -0,0 +1,71 @@
+class FileGlob
+  attr_reader :pattern
+  
+  def initialize(pattern)
+    @pattern = pattern
+  end
+  
+  def =~ path
+    0 if File.fnmatch?(pattern, path)
+  end
+  
+  def === path
+    File.fnmatch?(pattern, path)
+  end
+  
+  def match(path)
+    GlobMatchData.new(path) if self =~ path
+  end
+  
+  def to_s
+    pattern
+  end
+  
+  def inspect
+    "<#FileGlob #{pattern}>"
+  end
+  
+  private
+  
+  # Interface that quacks like Regexp's MatchData.
+  # It should cover most common cases.
+  class GlobMatchData
+    attr_reader :string
+    
+    def intialize(string)
+      @string = string
+    end
+    
+    def [] i
+      check_index!(i)
+      string
+    end
+    
+    def begin(i)
+      check_index!(i)
+      0
+    end
+    
+    def end
+      check_index!(i)
+      string.length
+    end
+    
+    def size
+      1
+    end
+    
+    alias_method :length, :size
+    
+    def names
+      []
+    end
+    
+    private
+    
+    def check_index!(i)
+      throw IndexError.new("FileGlob only matches once") if i > 0
+    end
+    
+  end
+end

data/test/file_glob_interface_test.rb

@@ -0,0 +1,18 @@
+require "minitest/autorun"
+require_relative "./matcher_mixin"
+require_relative "../lib/file_glob"
+
+# Ensure our interface matches the "matcher" duck type of Regexp.
+# 
+class FileGlobInterfaceTest < MiniTest::Unit::TestCase
+  include MatcherMixin
+  
+  def setup
+    @matcher = FileGlob.new("*.rb")
+  end
+  
+  def matching_example
+    "file.rb"
+  end
+  
+end

data/test/file_glob_test.rb

@@ -0,0 +1,38 @@
+require "minitest/autorun"
+require_relative "../lib/file_glob"
+
+class FileGlobTest < MiniTest::Unit::TestCase
+  MATCH    = "file.rb"
+  NO_MATCH = "file.yml"
+  
+  def setup
+    @glob = FileGlob.new '*.rb'
+  end
+  
+  def test_matches_with_squiggle_operator
+    assert @glob =~ MATCH
+  end
+  
+  def test_only_matches_when_pattern_matches
+    assert !(@glob =~ NO_MATCH)
+  end
+  
+  def test_can_be_used_on_righthand_side
+    assert MATCH =~ @glob
+  end
+  
+  def test_matches_with_match
+    assert @glob.match(MATCH)
+  end
+  
+  def test_only_matches_with_match_when_pattern_matches
+    assert !@glob.match(NO_MATCH)
+  end
+  
+  def test_can_be_used_in_a_case_statement
+    case MATCH
+    when @glob then assert(true)
+    else flunk "Should define ==="
+    end
+  end
+end

data/test/matcher_mixin.rb

@@ -0,0 +1,36 @@
+# These tests minimaly verify the interface of a "matcher" object.
+# They ensure that it behaves like a regexp for matching purposes.
+# 
+# For tests around behavior, see file_glob_test.rb
+#
+module MatcherMixin
+  
+  def setup
+    raise NotImplementedError.new "Setup must define @matcher"
+  end
+  
+  def matching_example
+    raise NotImplementedError.new "Provide a string that matches @matcher"
+  end
+  
+  def test_responds_to_matching_methods
+    assert @matcher.respond_to? :"=~"
+    assert @matcher.respond_to? :match
+    assert @matcher.respond_to? :"==="
+  end
+  
+  def test_squiggle_operator_returns_an_index
+    i = @matcher =~ matching_example
+    
+    assert_kind_of Fixnum, i
+  end
+  
+  def test_match_returns_a_match_data_like_object
+    data = @matcher.match(matching_example)
+    
+    assert data.respond_to? :[]
+    assert data.respond_to? :string
+    assert data.respond_to? :length
+  end
+  
+end

data/test/regexp_interface_test.rb

@@ -0,0 +1,19 @@
+require "minitest/autorun"
+require_relative "./matcher_mixin"
+
+# Verify that Regexp quacks like a "matcher".
+# 
+# This might seem silly, but it ensures that the duck type we are attempting to
+# match actually matches our expectations.
+# 
+class RegexpInterfaceTest < MiniTest::Unit::TestCase
+  include MatcherMixin
+  
+  def setup
+    @matcher = /.+\.rb/
+  end
+  
+  def matching_example
+    "file.rb"
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: file_glob
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Sanderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-15 00:00:00.000000000Z
+dependencies: []
+description: Use FileGlob in place of a Regexp when shell pattern matching makes more
+  sense.
+email:
+- netghost@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/file_glob.rb
+- test/file_glob_interface_test.rb
+- test/file_glob_test.rb
+- test/matcher_mixin.rb
+- test/regexp_interface_test.rb
+- README.markdown
+- Rakefile
+homepage: https://github.com/adamsanderson/file_glob
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Quacks like a Regexp, tastes like your shell's a file glob.
+test_files: []