pathspec 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f31eacbf6d689413b94c4607b34f617d2ebee3a9458920ff5435a9e66232d976
-  data.tar.gz: 5eab0a8a120d842f5153d186a60e15a632d7fda9f3d67c418297ff755d68f014
+  metadata.gz: 959defcb28199d86bb69d1b7854937c677e37dc71521f44693a42411897acf01
+  data.tar.gz: dfa517e7b72d5aede4eb9daf642fda9266c1f82454bed03b3b776934f5c56c95
 SHA512:
-  metadata.gz: 220bfd684bc5b278bf1c4c40fbf85dbb515336ad561a334544fa257f8da810efb2bf4c2a3533610dade922d296cd003ede1125ee84e1e1231667c344c805f81d
-  data.tar.gz: b042eeb99b7f38c663cb0df25cc6e50490e640eb6644648765ed35df312ce8efd086548602d064b5c928399cd4a19f19d7967cbe7b19645f09c24b2e66c457ee
+  metadata.gz: b1824b7ce0c951017a51d501f5e18299d1fa0400ca0c6db54b9b774c4aa08a3587504d98cd578b99296cf34aad2e07593292563014a0fcc09f72697194b1327c
+  data.tar.gz: 96ab89b84afdc3f69b24f0f84bd5740c2ebee3048246ca5d482bc3f24f08dbda542b03f3a6efb02d33d6cdd225646e1ef2cadaa43be3d1069f1912cfa4f99da1

data/README.md

@@ -1,13 +1,12 @@
-pathspec-ruby
-=============
+# pathspec-ruby
 
 [![Gem Version](https://badge.fury.io/rb/pathspec.svg)](https://badge.fury.io/rb/pathspec) [![Build Status](https://travis-ci.org/highb/pathspec-ruby.svg?branch=master)](https://travis-ci.org/highb/pathspec-ruby) [![Maintainability](https://api.codeclimate.com/v1/badges/4f3b5917e01fb34f790d/maintainability)](https://codeclimate.com/github/highb/pathspec-ruby/maintainability)
 
 [Supported Rubies](https://www.ruby-lang.org/en/downloads/):
-- 2.2.9 (Maintenance)
-- 2.3.6 (Stable)
-- 2.4.3 (Stable)
-- 2.5.0 (Stable) [Disabled in Travis](https://github.com/travis-ci/travis-ci/issues/8969)
+
+- 2.4.6 (Maintenance)
+- 2.5.6 (Stable)
+- 2.6.4 (Stable)
 
 Match Path Specifications, such as .gitignore, in Ruby!
 
@@ -16,11 +15,13 @@ Follows .gitignore syntax defined on [gitscm](http://git-scm.com/docs/gitignore)
 .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
 ```
 
 ## CLI Usage
+
 ```bash
 ➜  test-pathspec cat .gitignore
 *.swp
@@ -41,6 +42,7 @@ Gemfile      Gemfile.lock coverage     file.swp     source.rb
 ```
 
 ## Usage
+
 ```ruby
 require 'pathspec'
 
@@ -74,10 +76,12 @@ 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 but who knows what cases I've missed.

data/bin/pathspec-rb

@@ -1,26 +1,25 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'optionparser'
 require 'pathspec'
-options = { 
+options = {
   spec_type: :git,
   spec_filename: '.gitignore'
 }
 
 optparser = OptionParser.new do |opts|
-  opts.banner = %q{Usage: pathspec-rb [options] [subcommand] [path]
+  opts.banner = 'Usage: pathspec-rb [options] [subcommand] [path]
 Subcommands:
   specs_match: Finds all specs matching path.
   tree: Finds all files under path matching the spec.
   match: Checks if the path matches any spec.
-
 EXIT STATUS:
   0   Matches found.
   1   No matches found.
   >1  An error occured.
-
-}
-  opts.on('-f', '--file FILENAME', String, 
+'
+  opts.on('-f', '--file FILENAME', String,
           'A spec file to load. Default: .gitignore') do |filename|
     unless File.readable?(filename)
       puts "Error: I couldn't read #{filename}"
@@ -33,12 +32,12 @@ EXIT STATUS:
           'Spec file type in FILENAME. Default: git. Available: git and regex.') do |type|
     options[:spec_type] = type
   end
-  opts.on('-v', '--verbose', 'Only output if there are matches.') do |verbose|
+  opts.on('-v', '--verbose', 'Only output if there are matches.') do |_verbose|
     options[:verbose] = true
   end
 end
 
-optsparsed = optparser.parse!
+optparser.parse!
 
 command = ARGV[0]
 path = ARGV[1]
@@ -51,39 +50,27 @@ end
 
 case command
 when 'specs_match'
-  if spec.match(path)
-    if options[:verbose]
-      puts "#{path} matches the following specs from #{options[:spec_filename]}:"
-    end
+  if spec.match?(path)
+    puts "#{path} matches the following specs from #{options[:spec_filename]}:" if options[:verbose]
     puts spec.specs_matching(path)
   else
-    if options[:verbose]
-      puts "#{path} does not match any specs from #{options[:spec_filename]}"
-    end
+    puts "#{path} does not match any specs from #{options[:spec_filename]}" if options[:verbose]
     exit 1
   end
 when 'tree'
   tree_matches = spec.match_tree(path)
-  if tree_matches.size > 0
-    if options[:verbose]
-      puts "Files in #{path} that match #{options[:spec_filename]}"
-    end
+  if tree_matches.any?
+    puts "Files in #{path} that match #{options[:spec_filename]}" if options[:verbose]
     puts tree_matches
   else
-    if options[:verbose]
-      puts "No file in #{path} matched #{options[:spec_filename]}"
-    end
+    puts "No file in #{path} matched #{options[:spec_filename]}" if options[:verbose]
     exit 1
   end
 when 'match', ''
-  if spec.match(path)
-    if options[:verbose]
-      puts "#{path} matches a spec in #{options[:spec_filename]}"
-    end
+  if spec.match?(path)
+    puts "#{path} matches a spec in #{options[:spec_filename]}" if options[:verbose]
   else
-    if options[:verbose]
-      puts "#{path} does not match any specs in #{options[:spec_filename]}"
-    end
+    puts "#{path} does not match any specs in #{options[:spec_filename]}" if options[:verbose]
     exit 1
   end
 else

data/docs/html/pathspec-rb.html

@@ -0,0 +1,82 @@
+<h1 id="pathspec-rb1">pathspec-rb(1)</h1>
+
+<h2 data-date="2020/01/04" id="name">NAME</h2>
+
+<p>pathspec - Test pathspecs against a specific path</p>
+
+<h2 id="synopsis">SYNOPSIS</h2>
+
+<p><code>pathspec-rb</code> [<code>OPTIONS</code>] [<code>SUBCOMMAND</code>] [<code>PATH</code>] NAME PATH</p>
+
+<h2 id="description">DESCRIPTION</h2>
+
+<p><code>pathspc-rb</code> is a tool that accompanies the pathspec-ruby library to help
+you test what match results the library would find using path specs. You can
+either find all specs matching a path, find all files matching specs, or
+verify that a path would match any spec.</p>
+
+<p>https://github.com/highb/pathspec-ruby</p>
+
+<h2 id="sub-commands">SUB-COMMANDS</h2>
+
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><em>specs_match</em></td>
+      <td>Find all specs matching path</td>
+    </tr>
+  </tbody>
+  <tbody>
+    <tr>
+      <td><em>tree</em></td>
+      <td>Find all files under path matching the spec</td>
+    </tr>
+  </tbody>
+  <tbody>
+    <tr>
+      <td><em>match</em></td>
+      <td>Check if the path matches any spec</td>
+    </tr>
+  </tbody>
+</table>
+
+<h2 id="options">OPTIONS</h2>
+
+<dl>
+  <dt><code>-f &lt;FILENAME&gt;</code>, <code>--file &lt;FILENAME&gt;</code></dt>
+  <dd>Load path specs from the file passed in as argument. If this option is not specified, <code>pathspec-rb</code> defaults to loading <code>.gitignore</code>.</dd>
+  <dt><code>-t [git|regex]</code>, <code>--type [git|regex]</code></dt>
+  <dd>Type of spec expected in the loaded specs file (see <code>-f</code> option). Defaults to <code>git</code>.</dd>
+  <dt><code>-v</code>, <code>--verbose</code></dt>
+  <dd>Only output if there are matches.</dd>
+</dl>
+
+<h2 id="example">EXAMPLE</h2>
+
+<p>Find all files ignored by git under your source directory:</p>
+
+<pre><code>  $ pathspec-rb tree src/
+</code></pre>
+
+<p>List all spec rules that would match for the specified path:</p>
+
+<pre><code>  $ pathspec-rb specs_match build/
+</code></pre>
+
+<p>Check that a path matches at least one of the specs in a new version of a
+gitignore file:</p>
+
+<pre><code>  $ pathspec-rb match -f .gitignore.new spec/fixtures/
+</code></pre>
+
+<h2 id="author">AUTHOR</h2>
+
+<p>Brandon High highb@users.noreply.github.com</p>
+
+<p>Gabriel Filion</p>

data/docs/man/pathspec-rb.man.1

@@ -0,0 +1,67 @@
+.\" generated by kramdown
+.TH "PATHSPEC\-RB" "1"
+.SH "NAME"
+pathspec \- Test pathspecs against a specific path
+.SH "SYNOPSIS"
+\fBpathspec\-rb\fP [\fBOPTIONS\fP] [\fBSUBCOMMAND\fP] [\fBPATH\fP] NAME PATH
+.SH "DESCRIPTION"
+\fBpathspc\-rb\fP is a tool that accompanies the pathspec\-ruby library to help you test what match results the library would find using path specs\. You can either find all specs matching a path, find all files matching specs, or verify that a path would match any spec\.
+.P
+https://github\.com/highb/pathspec\-ruby
+.SH "SUB\-COMMANDS"
+.TS
+box ;
+lb lb .
+Name	Description	
+=
+.T&
+l l .
+\fIspecs_match\fP	Find all specs matching path	
+_
+.T&
+l l .
+\fItree\fP	Find all files under path matching the spec	
+_
+.T&
+l l .
+\fImatch\fP	Check if the path matches any spec	
+.TE
+.sp
+.SH "OPTIONS"
+.TP
+\fB\-f <FILENAME>\fP, \fB\-\-file <FILENAME>\fP
+Load path specs from the file passed in as argument\. If this option is not specified, \fBpathspec\-rb\fP defaults to loading \fB\&\.gitignore\fP\&\.
+.TP
+\fB\-t [git|regex]\fP, \fB\-\-type [git|regex]\fP
+Type of spec expected in the loaded specs file (see \fB\-f\fP option)\. Defaults to \fBgit\fP\&\.
+.TP
+\fB\-v\fP, \fB\-\-verbose\fP
+Only output if there are matches\.
+.SH "EXAMPLE"
+Find all files ignored by git under your source directory:
+.sp
+.RS 4
+.EX
+  $ pathspec\-rb tree src/
+.EE
+.RE
+.P
+List all spec rules that would match for the specified path:
+.sp
+.RS 4
+.EX
+  $ pathspec\-rb specs_match build/
+.EE
+.RE
+.P
+Check that a path matches at least one of the specs in a new version of a gitignore file:
+.sp
+.RS 4
+.EX
+  $ pathspec\-rb match \-f \.gitignore\.new spec/fixtures/
+.EE
+.RE
+.SH "AUTHOR"
+Brandon High highb@users\.noreply\.github\.com
+.P
+Gabriel Filion

data/docs/pathspec-rb.md

@@ -0,0 +1,64 @@
+# pathspec-rb(1)
+
+{:data-date="2020/01/04"}
+
+## NAME
+
+pathspec - Test pathspecs against a specific path
+
+## SYNOPSIS
+
+`pathspec-rb` [`OPTIONS`] [`SUBCOMMAND`] [`PATH`] NAME PATH
+
+## DESCRIPTION
+
+`pathspc-rb` is a tool that accompanies the pathspec-ruby library to help
+you test what match results the library would find using path specs. You can
+either find all specs matching a path, find all files matching specs, or
+verify that a path would match any spec.
+
+https://github.com/highb/pathspec-ruby
+
+## SUB-COMMANDS
+
+|-
+| Name | Description
+|-
+| *specs_match* | Find all specs matching path
+|-
+| *tree* | Find all files under path matching the spec
+|-
+| *match* | Check if the path matches any spec
+|-
+
+## OPTIONS
+
+`-f <FILENAME>`, `--file <FILENAME>`
+: Load path specs from the file passed in as argument. If this option is not specified, `pathspec-rb` defaults to loading `.gitignore`.
+
+`-t [git|regex]`, `--type [git|regex]`
+: Type of spec expected in the loaded specs file (see `-f` option). Defaults to `git`.
+
+`-v`, `--verbose`
+: Only output if there are matches.
+
+## EXAMPLE
+
+Find all files ignored by git under your source directory:
+
+      $ pathspec-rb tree src/
+
+List all spec rules that would match for the specified path:
+
+      $ pathspec-rb specs_match build/
+
+Check that a path matches at least one of the specs in a new version of a
+gitignore file:
+
+      $ pathspec-rb match -f .gitignore.new spec/fixtures/
+
+## AUTHOR
+
+Brandon High highb@users.noreply.github.com
+
+Gabriel Filion

data/lib/pathspec.rb

@@ -63,7 +63,7 @@ class PathSpec
   end
 
   def drive_letter_to_path(path)
-    path.gsub(%r{^([a-zA-Z]):\/}, '/\1/')
+    path.gsub(%r{^([a-zA-Z]):/}, '/\1/')
   end
 
   # Generate specs from a filename, such as a .gitignore
@@ -101,9 +101,10 @@ class PathSpec
   end
 
   def spec_type(type)
-    if type == :git
+    case type
+    when :git
       GitIgnoreSpec
-    elsif type == :regex
+    when :regex
       RegexSpec
     else
       raise "Unknown spec type #{type}"

data/lib/pathspec/gitignorespec.rb

@@ -3,10 +3,9 @@ require 'pathspec/regexspec'
 class PathSpec
   # Class for parsing a .gitignore spec
   class GitIgnoreSpec < RegexSpec
-    attr_reader :regex
-    attr_reader :pattern
+    attr_reader :regex, :pattern
 
-    def initialize(original_pattern)
+    def initialize(original_pattern) # rubocop:disable Metrics/CyclomaticComplexity
       pattern = original_pattern.strip unless original_pattern.nil?
 
       # A pattern starting with a hash ('#') serves as a comment
@@ -18,19 +17,19 @@ class PathSpec
 
         # A blank pattern is a null-operation (neither includes nor
         # excludes files).
-      elsif pattern.empty?
+      elsif pattern.empty? # rubocop:disable Lint/DuplicateBranch
         @regex = nil
         @inclusive = nil
 
         # Patterns containing three or more consecutive stars are invalid and
         # will be ignored.
-      elsif pattern =~ /\*\*\*+/
+      elsif /\*\*\*+/.match?(pattern) # rubocop:disable Lint/DuplicateBranch
         @regex = nil
         @inclusive = nil
 
         # EDGE CASE: According to git check-ignore (v2.4.1)), a single '/'
         # does not match any file
-      elsif pattern == '/'
+      elsif pattern == '/' # rubocop:disable Lint/DuplicateBranch
         @regex = nil
         @inclusive = nil
 
@@ -43,14 +42,14 @@ class PathSpec
         if pattern.start_with?('!')
           @inclusive = false
           # Remove leading exclamation mark.
-          pattern = pattern[1..-1]
+          pattern = pattern[1..]
         else
           @inclusive = true
         end
 
         # Remove leading back-slash escape for escaped hash ('#') or
         # exclamation mark ('!').
-        pattern = pattern[1..-1] if pattern.start_with?('\\')
+        pattern = pattern[1..] if pattern.start_with?('\\')
 
         # Split pattern into segments. -1 to allow trailing slashes.
         pattern_segs = pattern.split('/', -1)
@@ -94,7 +93,8 @@ class PathSpec
         pattern_segs.each_index do |i|
           seg = pattern_segs[i]
 
-          if seg == '**'
+          case seg
+          when '**'
             # A pattern consisting solely of double-asterisks ('**')
             # will match every path.
             if i == 0 && i == regex_end
@@ -119,7 +119,7 @@ class PathSpec
             end
 
             # Match single path segment.
-          elsif seg == '*'
+          when '*'
             regex.concat(path_sep) if need_slash
 
             regex.concat("[^#{path_sep}]+")
@@ -146,16 +146,12 @@ class PathSpec
 
         regex.concat('$')
         super(regex)
-        
+
         # Copy original pattern
         @pattern = original_pattern.dup
       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
@@ -220,7 +216,8 @@ class PathSpec
             expr = '['
 
             # Braket expression needs to be negated.
-            if pattern[i].chr == '!'
+            case pattern[i].chr
+            when '!'
               expr += '^'
               i += 1
 
@@ -229,7 +226,7 @@ class PathSpec
               # `fnmatch.translate()` escapes the caret ('^') as a
               # literal. To maintain consistency with undefined behavior,
               # I am escaping the '^' as well.
-            elsif pattern[i].chr == '^'
+            when '^'
               expr += '\\^'
               i += 1
             end

data/lib/pathspec/regexspec.rb

@@ -15,7 +15,7 @@ class PathSpec
     end
 
     def match(path)
-      @regex.match(path) if @regex
+      @regex&.match(path)
     end
   end
 end

data/lib/pathspec/spec.rb

@@ -1,8 +1,7 @@
 class PathSpec
   # Abstract spec
   class Spec
-    attr_reader :regex
-    attr_reader :pattern
+    attr_reader :regex, :pattern
 
     def initialize(*_); end
 

data/spec/unit/pathspec_spec.rb

@@ -20,9 +20,10 @@ describe PathSpec do
     it { is_expected.to match('abc/def.rb') }
     it { is_expected.not_to match('abc/important.txt') }
     it do
-       expect(subject.match_paths(['/abc/123', '/abc/important.txt', '/abc/'])).to contain_exactly(
-         '/abc/123',
-         '/abc/')
+      expect(subject.match_paths(['/abc/123', '/abc/important.txt', '/abc/'])).to contain_exactly(
+        '/abc/123',
+        '/abc/'
+      )
     end
   end
 

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: pathspec
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Brandon High
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2018-01-11 00:00:00.000000000 Z
@@ -16,86 +16,100 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.21'
 description: Use to match path patterns such as gitignore
-email: bh@brandon-high.com
+email: highb@users.noreply.github.com
 executables:
 - pathspec-rb
 extensions: []
@@ -105,6 +119,9 @@ files:
 - LICENSE
 - README.md
 - bin/pathspec-rb
+- docs/html/pathspec-rb.html
+- docs/man/pathspec-rb.man.1
+- docs/pathspec-rb.md
 - lib/pathspec.rb
 - lib/pathspec/gitignorespec.rb
 - lib/pathspec/regexspec.rb
@@ -121,7 +138,7 @@ homepage: https://github.com/highb/pathspec-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,16 +146,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: 'PathSpec: for matching path patterns'
 test_files: