pathspec 0.0.1

data/CHANGELOG.md

@@ -0,0 +1 @@
+0.0.1: Initial version.

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,49 @@
+pathspec-ruby
+=============
+
+Match Path Specifications (.gitignore) in Ruby with ease!
+
+Gitignore functionality ported from [Python pathspec](https://pypi.python.org/pypi/pathspec/0.2.2) by [@cpburnz](https://github.com/cpburnz/python-path-specification)
+
+## Build/Install from Rubygems
+```shell
+gem install pathspec
+```
+
+## Usage
+```ruby
+require 'pathspec'
+
+# Create a .gitignore-style Pathspec by giving it newline separated gitignore
+# lines, an array of gitignore lines, or any other enumable object that will
+# give strings matching the .gitignore-style (File, etc.)
+gitignore = Pathspec.new File.read('.gitignore', 'r')
+
+# Our .gitignore in this example contains:
+# !**/important.txt
+# abc/**
+
+# true, matches "abc/**"
+gitignore.match 'abc/def.rb'
+
+# false, because it has been negated using the line "!**/important.txt"
+gitignore.match 'abc/important.txt'
+
+# Give a path somewhere in the filesystem, and the Pathspec will return all
+# matching files underneath.
+# Returns ['/src/repo/abc/', '/src/repo/abc/123']
+gitignore.match_tree '/src/repo' # ['/src/repo/abc/', '/src/repo/abc/123']
+
+# Give an enumerable of paths, and Pathspec will return the ones that match.
+# Returns ['/abc/123', '/abc/']
+gitignore.match_paths ['/abc/123', '/abc/important.txt', '/abc/']
+```
+
+## Building/Installing from Source
+```shell
+git clone git@github.com:highb/pathspec-ruby.git
+cd pathspec-ruby && bash ./build_from_source.sh
+```
+
+## Contributing
+Pull requests, bug reports, and feature requests welcome! :smile: I've tried to write exhaustive tests (simplecov 100% coverage, woohoo!) but who knows what cases I've missed.

data/lib/pathspec.rb

@@ -0,0 +1,112 @@
+require 'pathspec/gitignorespec'
+require 'pathspec/regexspec'
+require 'find'
+require 'pathname'
+
+class PathSpec
+  attr_reader :specs
+
+  def initialize(lines=nil, type=:git)
+    @specs = []
+
+    if lines
+      add(lines, type)
+    end
+
+    self
+  end
+
+  # Check if a path matches the pathspecs described
+  # Returns true if there are matches and none are excluded
+  # Returns false if there aren't matches or none are included
+  def match(path)
+    matches = specs_matching(path.to_s)
+    !matches.empty? && matches.all? {|m| m.inclusive?}
+  end
+
+  def specs_matching(path)
+    @specs.select do |spec|
+      if spec.match(path)
+        spec
+      end
+    end
+  end
+
+  # Check if any files in a given directory or subdirectories match the specs
+  # Returns matched paths or nil if no paths matched
+  def match_tree(root)
+    root = Pathname.new(root)
+    matching = []
+
+    Find.find(root) do |path|
+      relpath = Pathname.new(path).relative_path_from(root).to_s
+      relpath += '/' if File.directory? path
+      if match(relpath)
+        matching << path
+      end
+    end
+
+    matching
+  end
+
+  def match_paths(paths, root='/')
+    root = Pathname.new(root)
+    matching = []
+
+    paths.each do |path|
+      relpath = Pathname.new(path).relative_path_from(root).to_s if root != '/'
+      relpath = relpath + '/' if path[-1] == '/'
+      if match(relpath)
+        matching << path
+      end
+    end
+
+    matching
+  end
+
+  # Generate specs from a filename, such as a .gitignore
+  def self.from_filename(filename, type=:git)
+    self.from_lines(File.open(filename, 'r'))
+  end
+
+  def self.from_lines(lines, type=:git)
+    self.new lines, type
+  end
+
+  # Generate specs from lines of text
+  def add(obj, type=:git)
+    spec_class = spec_type(type)
+
+    if obj.respond_to?(:each_line)
+      obj.each_line do |l|
+        spec = spec_class.new(l.rstrip)
+
+        if !spec.regex.nil? && !spec.inclusive?.nil?
+          @specs << spec
+        end
+      end
+    elsif obj.respond_to?(:each)
+      obj.each do |l|
+        add(l, type)
+      end
+    else
+      raise 'Cannot make Pathspec from non-string/non-enumerable object.'
+    end
+
+    self
+  end
+
+  def empty?
+    @specs.empty?
+  end
+
+  def spec_type(type)
+    if type == :git
+      GitIgnoreSpec
+    elsif type == :regex
+      RegexSpec
+    else
+      raise "Unknown spec type #{type}"
+    end
+  end
+end

data/lib/pathspec/gitignorespec.rb

@@ -0,0 +1,267 @@
+# encoding: utf-8
+
+require 'pathspec/regexspec'
+
+class GitIgnoreSpec < RegexSpec
+  attr_reader :regex
+
+  def initialize(pattern)
+    pattern = pattern.strip unless pattern.nil?
+
+    # A pattern starting with a hash ('#') serves as a comment
+    # (neither includes nor excludes files). Escape the hash with a
+    # back-slash to match a literal hash (i.e., '\#').
+    if pattern.start_with?('#')
+      @regex = nil
+      @inclusive = nil
+
+    # A blank pattern is a null-operation (neither includes nor
+    # excludes files).
+    elsif pattern.empty?
+      @regex = nil
+      @inclusive = nil
+
+    # Patterns containing three or more consecutive stars are invalid and
+    # will be ignored.
+    elsif pattern =~ /\*\*\*+/
+      @regex = nil
+      @inclusive = nil
+
+    # We have a valid pattern!
+    else
+      # A pattern starting with an exclamation mark ('!') negates the
+      # pattern (exclude instead of include). Escape the exclamation
+      # mark with a back-slash to match a literal exclamation mark
+      # (i.e., '\!').
+      if pattern.start_with?('!')
+        @inclusive = false
+        # Remove leading exclamation mark.
+        pattern = pattern[1..-1]
+      else
+        @inclusive = true
+      end
+
+      # Remove leading back-slash escape for escaped hash ('#') or
+      # exclamation mark ('!').
+      if pattern.start_with?('\\')
+        pattern = pattern[1..-1]
+      end
+
+      # Split pattern into segments. -1 to allow trailing slashes.
+      pattern_segs = pattern.split('/', -1)
+
+      # Normalize pattern to make processing easier.
+
+      # A pattern beginning with a slash ('/') will only match paths
+      # directly on the root directory instead of any descendant
+      # paths. So, remove empty first segment to make pattern relative
+      # to root.
+      if pattern_segs[0].empty?
+        pattern_segs.shift
+      else
+        # A pattern without a beginning slash ('/') will match any
+        # descendant path. This is equivilent to "**/{pattern}". So,
+        # prepend with double-asterisks to make pattern relative to
+        # root.
+        if pattern_segs.length == 1 && pattern_segs[0] != '**'
+          pattern_segs.insert(0, '**')
+        end
+      end
+
+      # A pattern ending with a slash ('/') will match all descendant
+      # paths of if it is a directory but not if it is a regular file.
+      # This is equivilent to "{pattern}/**". So, set last segment to
+      # double asterisks to include all descendants.
+      if pattern_segs[-1].empty?
+        pattern_segs[-1] = '**'
+      end
+
+      # Build regular expression from pattern.
+      regex = '^'
+      need_slash = false
+      regex_end = pattern_segs.size - 1
+      pattern_segs.each_index do |i|
+        seg = pattern_segs[i]
+
+        if seg == '**'
+          # A pattern consisting solely of double-asterisks ('**')
+          # will match every path.
+          if i == 0 && i == regex_end
+            regex.concat('.+')
+
+          # A normalized pattern beginning with double-asterisks
+          # ('**') will match any leading path segments.
+          elsif i == 0
+            regex.concat('(?:.+/)?')
+            need_slash = false
+
+          # A normalized pattern ending with double-asterisks ('**')
+          # will match any trailing path segments.
+          elsif i == regex_end
+            regex.concat('/.*')
+
+          # A pattern with inner double-asterisks ('**') will match
+          # multiple (or zero) inner path segments.
+          else
+            regex.concat('(?:/.+)?')
+            need_slash = true
+          end
+
+        # Match single path segment.
+        elsif seg == '*'
+          if need_slash
+            regex.concat('/')
+          end
+
+          regex.concat('[^/]+')
+          need_slash = true
+
+        else
+          # Match segment glob pattern.
+          if need_slash
+            regex.concat('/')
+          end
+
+          regex.concat(translate_segment_glob(seg))
+          need_slash = true
+        end
+      end
+
+      regex.concat('$')
+      super(regex)
+    end
+  end
+
+  def match(path)
+    super(path)
+  end
+
+  def translate_segment_glob(pattern)
+    """
+    Translates the glob pattern to a regular expression. This is used in
+    the constructor to translate a path segment glob pattern to its
+    corresponding regular expression.
+
+    *pattern* (``str``) is the glob pattern.
+
+    Returns the regular expression (``str``).
+    """
+    # NOTE: This is derived from `fnmatch.translate()` and is similar to
+    # the POSIX function `fnmatch()` with the `FNM_PATHNAME` flag set.
+
+    escape = false
+    regex = ''
+    i = 0
+
+    while i < pattern.size
+      # Get next character.
+      char = pattern[i]
+      i += 1
+
+      # Escape the character.
+      if escape
+        escape = false
+        regex += Regexp.escape(char)
+
+      # Escape character, escape next character.
+      elsif char == '\\'
+        escape = true
+
+      # Multi-character wildcard. Match any string (except slashes),
+      # including an empty string.
+      elsif char == '*'
+        regex += '[^/]*'
+
+      # Single-character wildcard. Match any single character (except
+      # a slash).
+      elsif char == '?'
+        regex += '[^/]'
+
+      # Braket expression wildcard. Except for the beginning
+      # exclamation mark, the whole braket expression can be used
+      # directly as regex but we have to find where the expression
+      # ends.
+      # - "[][!]" matchs ']', '[' and '!'.
+      # - "[]-]" matchs ']' and '-'.
+      # - "[!]a-]" matchs any character except ']', 'a' and '-'.
+      elsif char == '['
+        j = i
+        # Pass brack expression negation.
+        if j < pattern.size && pattern[j] == '!'
+          j += 1
+        end
+
+        # Pass first closing braket if it is at the beginning of the
+        # expression.
+        if j < pattern.size && pattern[j] == ']'
+          j += 1
+        end
+
+        # Find closing braket. Stop once we reach the end or find it.
+        while j < pattern.size && pattern[j] != ']'
+          j += 1
+        end
+
+
+        if j < pattern.size
+          expr = '['
+
+          # Braket expression needs to be negated.
+          if pattern[i] == '!'
+            expr += '^'
+            i += 1
+
+          # POSIX declares that the regex braket expression negation
+          # "[^...]" is undefined in a glob pattern. Python's
+          # `fnmatch.translate()` escapes the caret ('^') as a
+          # literal. To maintain consistency with undefined behavior,
+          # I am escaping the '^' as well.
+          elsif pattern[i] == '^'
+            expr += '\\^'
+            i += 1
+          end
+
+          # Escape brackets contained within pattern
+          if pattern[i] == ']' && i != j
+            expr += '\]'
+            i += 1
+          end
+
+
+          # Build regex braket expression. Escape slashes so they are
+          # treated as literal slashes by regex as defined by POSIX.
+          expr += pattern[i..j].sub('\\', '\\\\')
+
+          # Add regex braket expression to regex result.
+          regex += expr
+
+          # Found end of braket expression. Increment j to be one past
+          # the closing braket:
+          #
+          #  [...]
+          #   ^   ^
+          #   i   j
+          #
+          j += 1
+          # Set i to one past the closing braket.
+          i = j
+
+        # Failed to find closing braket, treat opening braket as a
+        # braket literal instead of as an expression.
+        else
+          regex += '\['
+        end
+
+      # Regular character, escape it for regex.
+      else
+        regex << Regexp.escape(char)
+      end
+    end
+
+    regex
+  end
+
+  def inclusive?
+    @inclusive
+  end
+end

data/lib/pathspec/regexspec.rb

@@ -0,0 +1,17 @@
+require 'pathspec/spec'
+
+class RegexSpec < Spec
+  def initialize(regex)
+    @regex = Regexp.compile regex
+
+    super
+  end
+
+  def inclusive?
+    true
+  end
+
+  def match(path)
+    @regex.match(path) if @regex
+  end
+end

data/lib/pathspec/spec.rb

@@ -0,0 +1,14 @@
+class Spec
+  attr_reader :regex
+
+  def initialize(*_)
+  end
+
+  def match(files)
+    raise "Unimplemented"
+  end
+
+  def inclusive?
+    true
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: pathspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brandon High
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use to match path patterns such as gitignore
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pathspec/gitignorespec.rb
+- lib/pathspec/regexspec.rb
+- lib/pathspec/spec.rb
+- lib/pathspec.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+homepage: https://github.com/highb/pathspec-ruby
+licenses:
+- Apache
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3379845117464924390
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ! 'PathSpec: for matching path patterns'
+test_files: []