pathname-glob 0.1.20170628

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3ec02f39ad57d3a9145f5c5351fe5465b644b65
+  data.tar.gz: '0186eac3b450b872b2462abfea27c8b2a0e85c34'
+SHA512:
+  metadata.gz: 6754c95223973ec62b6f9caf32465c9666b869909e909cee2771d6c9eff25c8cdaee4bc95344a8dab288b2e21a46a10ae8a596a6c91e0c16dd277f1e577afd2a
+  data.tar.gz: d87cf2fdcd9086d4bcb68f6d2d88ab08358510d54c2d0d596f3b78ddfda910477c6c70720f528314958b1e9a7370aa8b562b8ccf73edf92b18d4ec9d4fa1d154

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -0,0 +1,36 @@
+Implements a much needed `Pathname#glob` method.
+
+To install run `gem install pathname-glob`, and then `require "pathname-glob"` in your code.
+
+## Usage
+
+It supports similar interface to `Dir.glob` and `Pathname::glob`.
+
+```ruby
+Pathname("foo").glob("*.txt")
+Pathname("foo").glob("*.txt", File::FNM_DOTMATCH)
+Pathname("foo").glob(["*.txt", "*.html"])
+Pathname("foo").glob("*.txt") do |path|
+  # yields Pathname objects  
+end # returns nil
+```
+
+## What's the advantage over other globbing methods?
+
+For simple case these are equivalent:
+
+```ruby
+Pathname("/foo/bar").glob("*.txt")
+Pathname.glob("/foo/bar/*.txt")
+Dir.glob("/foo/bar/*.txt").map{|path| Pathname(path)}
+```
+
+However in addition to greater convenience, `Pathname#glob` is the only one that can handle special characters in folder name:
+
+```ruby
+Pathname("very*special*folder/{real} [special] ? yes!").glob("*.txt")
+```
+
+`Dir.glob` and `Pathname.glob` inherently can't as they don't know where folder name ends and pattern begins.
+
+If you're dealing with user data, running into special characters like that is pretty much guaranteed.

data/Rakefile

@@ -0,0 +1,23 @@
+task "default" => "spec"
+task "test" => "spec"
+
+desc "Run tests"
+task "spec" do
+  system "rspec"
+end
+
+desc "Clean up"
+task "clean" do
+  system "trash pathname-glob-*.gem"
+end
+
+desc "Build gem"
+task "gem:build" do
+  system "gem build pathname-glob.gemspec"
+end
+
+desc "Upload gem"
+task "gem:push" => "gem:build" do
+  gem_file = Dir["pathname-glob-*.gem"][-1] or raise "No gem found"
+  system "gem", "push", gem_file
+end

data/lib/pathname-glob.rb

@@ -0,0 +1,13 @@
+require "pathname"
+
+class Pathname
+  def glob(pattern, options=0, &block)
+    self_pat = self.to_s.gsub(/([\[\]\{\}\\\*\?])/, "\\\\\\1")
+    if pattern.is_a?(Array)
+      pattern = pattern.map{|subpattern| File.join(self_pat, subpattern) }
+    else
+      pattern = File.join(self_pat, pattern)
+    end
+    Pathname::glob(pattern, options, &block)
+  end
+end

data/spec/pathname_glob_spec.rb

@@ -0,0 +1,132 @@
+describe "Pathname#glob" do
+  let(:files) {[
+    "foo/1.txt",
+    "foo/2.txt",
+    "foo/3.html",
+    "bar/4.html",
+    "bar/abc/5.html",
+    "bar/6.gif",
+    "lol/[]{}/?*?*?*?!\\\\?\\/lol/1.txt",
+    "lol/[]{}/?*?*?*?!\\\\?\\/lol/2.gif",
+    "lol/[]{}/?*?*?*?!\\\\?\\/lol/3.txt",
+  ]}
+  let(:tmpdir) {
+    Pathname(@dir)
+  }
+  let(:result) {
+    (tmpdir+base_path).glob(*args).map{|path| path.relative_path_from(tmpdir)}
+  }
+
+  before(:each) do
+    @dir = Dir.mktmpdir
+    files.each do |path|
+      (tmpdir+path).parent.mkpath
+      FileUtils.touch (tmpdir+path)
+    end
+  end
+
+  after(:each) do
+    FileUtils.remove_entry(@dir)
+  end
+
+  describe do
+    let(:base_path) { "foo" }
+    let(:args) { ["*.txt"] }
+    it do
+      expect(result).to eq([
+        Pathname("foo/1.txt"),
+        Pathname("foo/2.txt"),
+      ])
+    end
+  end
+
+  describe do
+    let(:base_path) { "bar" }
+    let(:args) { ["*.html"] }
+    it do
+      expect(result).to eq([
+        Pathname("bar/4.html"),
+      ])
+    end
+  end
+
+  describe do
+    let(:base_path) { "bar" }
+    let(:args) { ["**/*.html"] }
+    it do
+      expect(result).to eq([
+        Pathname("bar/4.html"),
+        Pathname("bar/abc/5.html"),
+      ])
+    end
+  end
+
+  describe "array of arguments" do
+    let(:base_path) { "foo" }
+    let(:args) { [["?.html", "?.txt"]] }
+    it do
+      expect(result).to eq([
+        Pathname("foo/3.html"),
+        Pathname("foo/1.txt"),
+        Pathname("foo/2.txt"),
+      ])
+    end
+  end
+
+  describe "options" do
+    let(:base_path) { "foo" }
+    let(:args) { ["*", 0] }
+    it do
+      expect(result).to eq([
+        Pathname("foo/1.txt"),
+        Pathname("foo/2.txt"),
+        Pathname("foo/3.html"),
+      ])
+    end
+  end
+
+  describe "options" do
+    let(:base_path) { "foo" }
+    let(:args) { ["*", File::FNM_DOTMATCH] }
+    it do
+      expect(result).to eq([
+        Pathname("foo"), # .
+        Pathname("."), # ..
+        Pathname("foo/1.txt"),
+        Pathname("foo/2.txt"),
+        Pathname("foo/3.html"),
+      ])
+    end
+  end
+
+  # Special characters as per dir.c in ruby sources:
+  # hard special (unescapable): / \0
+  # unix: { } \ [ ] * ?
+  # There's also something about Win32 and . and ~ that I don't really get
+  describe "escaping" do
+    let(:base_path) { "lol/[]{}/?*?*?*?!\\\\?\\/lol" }
+    let(:args) { ["*.txt"] }
+    it do
+      expect(result).to eq([
+        Pathname("lol/[]{}/?*?*?*?!\\\\?\\/lol/1.txt"),
+        Pathname("lol/[]{}/?*?*?*?!\\\\?\\/lol/3.txt",),
+      ])
+    end
+  end
+
+  describe "block" do
+    let(:base_path) { "foo" }
+    let(:args) { ["*.txt"] }
+    it do
+      yields = []
+      result = (tmpdir+base_path).glob(*args){|*x|
+        yields << x
+      }
+      expect(result).to eq(nil)
+      expect(yields).to eq([
+        [tmpdir + "foo/1.txt"],
+        [tmpdir + "foo/2.txt"],
+      ])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require_relative "../lib/pathname-glob"
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: pathname-glob
+version: !ruby/object:Gem::Version
+  version: 0.1.20170628
+platform: ruby
+authors:
+- Tomasz Wegrzanowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Find files under certain path
+email: Tomasz.Wegrzanowski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- lib/pathname-glob.rb
+- spec/pathname_glob_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/taw/pathname-glob
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Pathname#glob method
+test_files: []