pathspec 0.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f259b8f0d32109d62b9bbc1a0f6a96c34f607cf9
-  data.tar.gz: 551a347443c3e6017eccee1b3ce7ca9cf1e51339
+SHA256:
+  metadata.gz: f4a1cfa48aaf8c4d91ccb2aff3b5c937f453309e77077e4fd3300dcc7d82aba1
+  data.tar.gz: 8b8a4d02f71b140bbbc6a88571e67d1fd04e2f5840361ee0b65d3a41ab87117b
 SHA512:
-  metadata.gz: df440335455b0deea4f7ca6f8b3566868d7d58f62be038217413628931b68acc3feb8899b38bd83b219676fa70aa8ad25d2e7e57d8ba65a6e56cc1bb908a0986
-  data.tar.gz: 1f20ff703cf2b7f725cf744139ec26c73e60a496014a929b8ff06dceb8794dea03a73e3884036be57c4dd0d04fc122f23701c7545a160a9756d9e89c7858ced0
+  metadata.gz: e08a0a2db398cd63b0033dfe32bd8da04bd5dbca8ef23a07273f3b9c773ce46e9e65f8fcb83680609171722cfaaad029008011ee8519f7fcf39080c35fc88073
+  data.tar.gz: 2834ced5a39cf995df9e21f3c0afbece56ae5a1eff03438d6ae0e1db42e20805dce9a1dfa9198cd1048d4c84454252b62e164ca385225f2e6abfc64f0a0aaedd

data/CHANGELOG.md

@@ -1,16 +1,31 @@
 # pathspec-ruby CHANGELOG
 
-## 0.1.2
+## 1.1.0 (Minor Release)
+
+- (Maint) Updated Supported Ruby Versions
+- (Maint) Linting corrections
+
+## Undocumented Releases (Sorry!)
+
+## 0.2.0 (Minor Release)
+- (Feature) A CLI tool, pathspec-rb, is now provided with the gem.
+- (API Change) New namespace for gem: `PathSpec`: Everything is now namespaced under `PathSpec`, to prevent naming collisions with other libraries. Thanks @tenderlove!
+- (License) License version updated to Apache 2. Thanks @kytrinyx!
+- (Maint) Pruned Supported Ruby Versions. We now test: 2.2.9, 2.3.6 and 2.4.3.
+- (Maint) Ruby 2.5.0 testing is blocked on Travis, but should work locally. Thanks @SumLare!
+- (Maint) Added Rubocop and made some corrections
+
+## 0.1.2 (Patch/Bug Fix Release)
 - Fix for regexp matching Thanks @incase! #16
 - File handling cleanup Thanks @martinandert! #13
 - `from_filename` actually works now! Thanks @martinandert! #12
 
-## 0.1.0
+## 0.1.0 (Minor Release)
 - Port new edgecase handling from [python-path-specification](https://github.com/cpburnz/python-path-specification/pull/8). Many thanks to @jdpace! :)
 - Removed EOL Ruby support
 - Added current Ruby stable to Travis testing
 
-## 0.0.2
+## 0.0.2 (Patch/Bug Fix Release)
 - Fixed issues with Ruby 1.8.7/2.1.1
 - Added more testing scripts
 - Fixed Windows path related issues

data/README.md

@@ -1,12 +1,14 @@
-pathspec-ruby
-=============
+# pathspec-ruby
 
-[![Build Status](https://travis-ci.org/highb/pathspec-ruby.svg?branch=master)](https://travis-ci.org/highb/pathspec-ruby) [![codecov](https://codecov.io/gh/highb/pathspec-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/highb/pathspec-ruby)
+[![Gem Version](https://badge.fury.io/rb/pathspec.svg)](https://badge.fury.io/rb/pathspec) [![Ruby](https://github.com/highb/pathspec-ruby/actions/workflows/ruby.yml/badge.svg)](https://github.com/highb/pathspec-ruby/actions/workflows/ruby.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/4f3b5917e01fb34f790d/maintainability)](https://codeclimate.com/github/highb/pathspec-ruby/maintainability) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=highb_pathspec-ruby&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=highb_pathspec-ruby)
 
-Supported Rubies:
-- 2.2.7 (Maintenance)
-- 2.3.4 (Stable)
-- 2.4.1 (Stable)
+[man Page as HTML](http://highb.github.io/pathspec-ruby/)
+
+[Supported Rubies](https://www.ruby-lang.org/en/downloads/):
+
+- 2.6 (Security Maintenance)
+- 2.7 (Stable, Tested)
+- 3.0 (Stable, Tested)
 
 Match Path Specifications, such as .gitignore, in Ruby!
 
@@ -15,18 +17,41 @@ 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
+➜ cat .gitignore
+*.swp
+/coverage/
+➜ bundle exec pathspec-rb specs_match "coverage/foo"
+/coverage/
+➜ bundle exec pathspec-rb specs_match "file.swp"
+*.swp
+➜ bundle exec pathspec-rb match "file.swp"
+➜ echo $?
+0
+➜ ls
+Gemfile      Gemfile.lock coverage     file.swp     source.rb
+➜ bundle exec pathspec-rb tree .
+./coverage
+./coverage/index.html
+./file.swp
+```
+
 ## 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')
+gitignore = PathSpec.from_filename('spec/files/gitignore_readme')
 
 # Our .gitignore in this example contains:
 # !**/important.txt
@@ -34,25 +59,69 @@ gitignore = Pathspec.new File.read('.gitignore', 'r')
 
 # true, matches "abc/**"
 gitignore.match 'abc/def.rb'
+# CLI equivalent: pathspec.rb -f spec/files/gitignore_readme match 'abc/def.rb'
 
 # false, because it has been negated using the line "!**/important.txt"
 gitignore.match 'abc/important.txt'
+# CLI equivalent: pathspec.rb -f spec/files/gitignore_readme 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'
+# CLI equivalent: pathspec.rb -f spec/files/gitignore_readme tree /src/repo
 
 # 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/']
+# There is no CLI equivalent to this.
+```
+
+## Example Usage in Gemspec
+
+```
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gemspec_pathspec_test/version"
+require 'pathspec'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gemspec_pathspec_test"
+  spec.version       = GemspecPathspecTest::VERSION
+  spec.authors       = ["Brandon High"]
+  spec.email         = ["highb@users.noreply.github.com"]
+
+  spec.summary = "whatever"
+
+  spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  ps = PathSpec.from_filename('.gitignore')
+  spec.files         = Dir['lib/*.rb'].reject { |f| ps.match(f) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end
 ```
 
 ## 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.
+
+## Releasing
+
+This is mainly a reminder to myself but the release process is:
+1. Make sure CI is passing
+2. Update the CHANGELOG with relevant changes to Gem consumers
+3. Update version in gemspec with correct SemVer bump for scope of changes
+4. Tag/release using GitHub UI and the Build & Push workflow should do the rest.

data/bin/pathspec-rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optionparser'
+require 'pathspec'
+options = {
+  spec_type: :git,
+  spec_filename: '.gitignore'
+}
+
+optparser = OptionParser.new do |opts|
+  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,
+          'A spec file to load. Default: .gitignore') do |filename|
+    unless File.readable?(filename)
+      puts "Error: I couldn't read #{filename}"
+      exit 2
+    end
+
+    options[:spec_filename] = filename
+  end
+  opts.on('-t', '--type [git|regex]', %i[git regex],
+          '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|
+    options[:verbose] = true
+  end
+end
+
+optparser.parse!
+
+command = ARGV[0]
+path = ARGV[1]
+if path
+  spec = PathSpec.from_filename(options[:spec_filename], options[:spec_type])
+else
+  puts optparser.help
+  exit 2
+end
+
+case command
+when 'specs_match'
+  if spec.match?(path)
+    puts "#{path} matches the following specs from #{options[:spec_filename]}:" if options[:verbose]
+    puts spec.specs_matching(path)
+  else
+    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.any?
+    puts "Files in #{path} that match #{options[:spec_filename]}" if options[:verbose]
+    puts tree_matches
+  else
+    puts "No file in #{path} matched #{options[:spec_filename]}" if options[:verbose]
+    exit 1
+  end
+when 'match', ''
+  if spec.match?(path)
+    puts "#{path} matches a spec in #{options[:spec_filename]}" if options[:verbose]
+  else
+    puts "#{path} does not match any specs in #{options[:spec_filename]}" if options[:verbose]
+    exit 1
+  end
+else
+  puts "Unknown sub-command #{command}."
+  puts optparser.help
+  exit 2
+end

data/docs/index.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