globby 0.0.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Jon Jensen
+
+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,34 @@
+# globby
+
+globby is a [.gitignore](http://www.kernel.org/pub/software/scm/git/docs/gitignore.html)-compatible file globber for ruby
+
+## Usage
+
+    Globby.new(rules).matches
+
+### An example:
+
+     > rules = File.read('.gitignore').split(/\n/)
+     > pp Globby.new(rules).matches
+    ["Gemfile.lock",
+     "doc/Foreigner.html",
+     "doc/Foreigner/Adapter.html",
+     "doc/Gemfile.html",
+     "doc/Immigrant.html",
+     ...
+     "immigrant-0.1.3.gem",
+     "immigrant-0.1.4.gem"]
+    => nil
+
+## Why on earth would I ever use this?
+
+* You're curious what is getting `.gitignore`'d and/or you want to do something
+  with those files.
+* You're writing a library/tool that will have its own list of ignored/tracked
+  files. My use case is for an I18n library that extracts strings from ruby
+  files... I need to provide users a nice configurable way to whitelist given
+  files/directories/patterns.
+
+## License
+
+Copyright (c) 2012 Jon Jensen, released under the MIT license

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/globby.rb

@@ -0,0 +1,54 @@
+require 'set'
+
+class Globby
+  def initialize(patterns = [])
+    @patterns = patterns
+  end
+
+  def matches
+    result = Set.new
+    @patterns.each do |pattern|
+      if pattern[0, 1] == '!'
+        result.subtract matches_for(pattern[1..-1])
+      else
+        result.merge matches_for(pattern)
+      end
+    end
+    result.to_a.sort
+  end
+
+  def matches_for(pattern)
+    return [] unless pattern = normalize(pattern)
+    expects_dir = pattern.sub!(/\/\z/, '')
+
+    files = Dir.glob(pattern, File::FNM_PATHNAME)
+    result = []
+    files.each do |file|
+      next if ['.', '..'].include?(File.basename(file))
+      if directory?(file)
+        result.concat matches_for("/" + file + "/**/{*,.*}")
+      elsif !expects_dir
+        result << file
+      end
+    end
+    result
+  end
+
+  def normalize(pattern)
+    pattern = pattern.strip
+    first = pattern[0, 1]
+    if pattern.empty? || first == '#'
+      nil
+    elsif first == '/'
+      pattern[1..-1] 
+    else
+      "**/" + pattern  # could be anywhere
+    end
+  end
+
+ protected
+
+  def directory?(pattern)
+    File.directory?(pattern) && !File.symlink?(pattern)
+  end
+end

data/spec/globby_spec.rb

@@ -0,0 +1,157 @@
+require 'globby'
+RSpec.configure { |config| config.mock_framework = :mocha }
+
+# A blank line matches no files, so it can serve as a separator for
+# readability.
+# 
+# A line starting with # serves as a comment.
+# 
+# An optional prefix ! which negates the pattern; any matching file excluded by
+# a previous pattern will become included again. If a negated pattern matches,
+# this will override lower precedence patterns sources.
+# 
+# If the pattern ends with a slash, it is removed for the purpose of the 
+# following description, but it would only find a match with a directory. In 
+# other words, foo/ will match a directory foo and paths underneath it, but
+# will not match a regular file or a symbolic link foo (this is consistent with
+# the way how pathspec works in general in git).
+# 
+# If the pattern does not contain a slash /, git treats it as a shell glob 
+# pattern and checks for a match against the pathname relative to the location
+# of the .gitignore file (relative to the toplevel of the work tree if not from
+# a .gitignore file).
+# 
+# Otherwise, git treats the pattern as a shell glob suitable for consumption by 
+# fnmatch(3) with the FNM_PATHNAME flag: wildcards in the pattern will not
+# match a / in the pathname. For example, "Documentation/*.html" matches 
+# "Documentation/git.html" but not "Documentation/ppc/ppc.html" or 
+# "tools/perf/Documentation/perf.html".
+# 
+# A leading slash matches the beginning of the pathname. For example, "/*.c" 
+# matches "cat-file.c" but not "mozilla-sha1/sha1.c".
+
+describe Globby do
+  describe "#matches_for" do
+
+    let(:globby) { Globby.new }
+  
+    context "a blank line" do
+      it "should return nothing" do
+        Dir.expects(:glob).never
+        globby.matches_for("").should == []
+      end
+    end
+
+    context "a comment" do
+      it "should return nothing" do
+        Dir.expects(:glob).never
+        globby.matches_for("#comment").should == []
+      end
+    end
+
+    context "a pattern ending in a slash" do
+      it "should return a matching directory's contents" do
+        globby.stubs(:directory?).returns true, false
+        Dir.expects(:glob).twice.returns ["foo"], ['foo/bar']
+        globby.matches_for("foo/").should == ['foo/bar']
+      end
+
+      it "should ignore symlinks and regular files" do
+        globby.stubs(:directory?).returns false
+        Dir.expects(:glob).once.returns ["foo"]
+        globby.matches_for("foo/").should == []
+      end
+    end
+
+    context "a pattern without a slash" do
+      it "should return all glob matches" do
+        Dir.expects(:glob).with{ |*args| args.first == "**/*rb"}.returns []
+        globby.matches_for("*rb")
+      end
+    end
+
+    context "a pattern with a slash" do
+      it "should return all glob matches" do
+        Dir.expects(:glob).with{ |*args| args.first == "**/foo/bar"}.returns []
+        globby.matches_for("foo/bar")
+      end
+    end
+
+    context "a pattern starting in a slash" do
+      it "should return all root glob matches" do
+        Dir.expects(:glob).with{ |*args| args.first == "foo/bar"}.returns []
+        globby.matches_for("/foo/bar")
+      end
+    end
+  end
+
+  describe "#matches" do
+    it "should match gitignore perfectly" do
+      require 'tmpdir'
+      require 'fileutils'
+
+      files = <<-FILES.strip.split(/\s+/)
+        .gitignore
+        foo.rb
+        foo.html
+        bar
+        baz/lol.txt
+        foo/.hidden
+        foo/bar.rb
+        foo/bar.html
+        foo/bar/baz.pdf
+        foobar/.hidden
+        foobar/baz.txt
+        foobar/baz.rb
+        foobar/baz/lol.wut
+      FILES
+
+      ignore = <<-IGNORE.gsub(/^ +/, '')
+        # here we go...
+
+        # some dotfiles
+        .hidden
+
+        # html, but just in the root
+        /*.html
+
+        # all rb files anywhere
+        *.rb
+
+        # except rb files immediately under foobar
+        !foobar/*.rb
+
+        # this will match foo/bar but not bar
+        bar/
+
+        # this will match nothing
+        foo*bar/baz.pdf
+
+        # this will match baz/ and foobar/baz/
+        baz
+      IGNORE
+
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir) do
+          File.open('.gitignore', 'w'){ |f| f.write ignore }
+          files.each do |file|
+            FileUtils.mkdir_p File.dirname(file)
+            FileUtils.touch file
+          end
+
+          `git init .`
+          untracked = `git status -uall`.gsub(/.*#\n|#\s+|^nothing.*/m, '').split(/\n/)
+
+          globby = Globby.new(ignore.split(/\n/))
+          ignored = globby.matches
+          
+          all_files = Dir.glob('**/*', File::FNM_DOTMATCH | File::FNM_PATHNAME).
+            reject{ |f| f =~ /^\.git\// }.
+            select{ |f| File.symlink?(f) || File.file?(f) }
+          
+          all_files.sort.should == (untracked + ignored).sort 
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: globby
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jon Jensen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-01-16 00:00:00 Z
+dependencies: []
+
+description: find files using .gitignore-style globs
+email: jenseng@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE.txt
+- Rakefile
+- README.md
+- lib/globby.rb
+- spec/globby_spec.rb
+homepage: http://github.com/jenseng/globby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 17
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: .gitignore-compatible file globber
+test_files: []
+
+has_rdoc: