fast_ignore 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c51ea85828e7c8659e7e67c6b4f72a577e463439412da55842d2ccdc8cb2be
-  data.tar.gz: c9cfdfcfa66b2df5b927ce0a53f094cf72c1a9db33f09cf992e7d1337fc9a37a
+  metadata.gz: '078431fdfb48356146694f1fffba57803f876a1b67f52c6b8180ec5f9efe2f30'
+  data.tar.gz: 4c9e880bf30a6656382a7437b97847be095c4e4f77276979a52e11e421905cb6
 SHA512:
-  metadata.gz: f25671f6eff33fdd7a56cdda01941413b0de30fa35eca7aee5f495414335fb5b48eff2ed67c19a7c2638483c7e7ba10069e42e41ae099da577af9772b3c66680
-  data.tar.gz: 6b64940f041f0ce7edeb913ea01d030f92925fdae4ad454e4ca84ccd373e02779ac2b234d2645a9bab823547a9775c1f41547001077557c90fa33d83b5dc7a0c
+  metadata.gz: b986db1ce0dc3a0359cd7d556e52caaa5c9adc3f6ff0d513fed436f036b73db937546c981705c7da560fe9833c2f24fe2e521d428575bd1f3d05c8f15fb37535
+  data.tar.gz: d871816557a546cd2a43bc2206b5dbcab7fa3a4418ff8ffb98f85d36ea66cbe12dd9aac329bb30db9f4d7144c75b09423b8e2054597540caf2a6f42edf682478

data/.rubocop.yml

@@ -11,6 +11,7 @@ AllCops:
     - db/schema*
     - .bundle/**/*
     - tmp/**/*
+    - vendor/**/*
   DisplayCopNames: true
   DisplayStyleGuide: true
 
@@ -68,15 +69,15 @@ Layout/FirstHashElementLineBreak:
   Enabled: true
 
 # to match our preference for consistent indentation
-Layout/FirstParameterIndentation:
+Layout/IndentFirstArgument:
   EnforcedStyle: consistent
 
 # to match our preference for consistent indentation
-Layout/IndentArray:
+Layout/IndentFirstArrayElement:
   EnforcedStyle: consistent
 
 # to match our preference for consistent indentation
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 
 # to match our preference for consistent indentation

data/.travis.yml

@@ -3,5 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.5.1
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
 before_install: gem install bundler -v 1.17.3

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.3.0
+- Supports 2.3 - 2.6
+
 # v0.2.0
 - Considers rules relative to the location of the gitignore file instead of just relative to PWD
 - Can override the path to the gitignore file, using `FastIgnore.new(gitignore: path)`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fast_ignore (0.2.0)
+    fast_ignore (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -9,42 +9,40 @@ GEM
     ast (2.4.0)
     coderay (1.1.2)
     diff-lcs (1.3)
-    jaro_winkler (1.5.2)
+    jaro_winkler (1.5.3)
     method_source (0.9.2)
-    parallel (1.15.0)
-    parser (2.6.2.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    psych (3.1.0)
     rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.66.0)
+    rspec-support (3.8.2)
+    rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    rubocop-rspec (1.32.0)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.35.0)
       rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.5.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
@@ -59,4 +57,4 @@ DEPENDENCIES
   rubocop-rspec (~> 1)
 
 BUNDLED WITH
-   1.17.1
+   1.17.3

data/README.md

@@ -1,8 +1,11 @@
 # FastIgnore
 
-![travis](https://travis-ci.org/robotdana/fast_ignore.svg?branch=master)
+[![travis](https://travis-ci.org/robotdana/fast_ignore.svg?branch=master)](https://travis-ci.org/robotdana/fast_ignore)
 
-Filter a directory using a .gitignore file. Follows all the gitignore formatting rules including `!dir` and `/dir`
+Filter a directory tree using a .gitignore file. Recognises all of the gitignore rules.
+```ruby
+FastIgnore.new(relative: true).sort == `git ls-files`.split("\n").sort
+```
 
 ## Installation
 
@@ -13,19 +16,22 @@ gem 'fast_ignore'
 ```
 
 And then execute:
-
-    $ bundle
-
+```sh
+$ bundle
+```
 Or install it yourself as:
-
-    $ gem install fast_ignore
+```sh
+$ gem install fast_ignore
+```
 
 ## Usage
+
 ```ruby
 FastIgnore.new.each { |file| puts "#{file} is not ignored by the .gitignore" }
 ```
 
-Like many other enumerables, FastIgnore.new.each can return an enumerator
+Like many other enumerables, `FastIgnore#each` can return an enumerator
+
 ```ruby
 FastIgnore.new.each.with_index { |file, index| puts "#{file}#{index}" }
 ```
@@ -53,7 +59,7 @@ FastIgnore.new(files: 'absolute/path/to/my/ignore/file', gitignore: false)
 FastIgnore.new(rules: %w{my*rule /and/another !rule}, gitignore: false)
 ```
 
-By default, FastIgnore will look in the directory the script is run in (PWD) for a gitignore file. If it's somewhere else:
+By default, FastIgnore will look in the directory the script is run in (`PWD`) for a gitignore file. If it's somewhere else:
 ```ruby
 FastIgnore.new(gitignore: '/absolute/path/to/.gitignore').to_a
 ```
@@ -64,13 +70,17 @@ To check if a single file is allowed, use
 FastIgnore.new.allowed?('/absolute/path/to/file')
 ```
 
-## Known issues/TODOs
-- Doesn't take into account ignored project excludes in `.git/info/exclude`
+## Known issues
+- Doesn't take into account project excludes in `.git/info/exclude`
 - Doesn't take into account globally ignored files in `git config core.excludesFile`
-  This is probably a wontfix, as you need git to read the config, and may as well just
   ```ruby
   `git ls-files`.split("\n")
   ```
+- Doesn't follow this rule in the gitignore documentation because I don't understand what it means that isn't covered by other rules:
+  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)
+  if someone can explain it with examples [make an issue please](https://github.com/robotdana/fast_ignore/issues/new)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/fast_ignore/delete_prefix_suffix.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This is a backport of ruby 2.5's delete_prefix/delete_suffix methods
+module DeletePrefixSuffix
+  refine String do
+    def delete_prefix!(str)
+      slice!(0..(str.length - 1)) if start_with?(str)
+      self
+    end
+
+    def delete_suffix!(str)
+      slice!(-str.length..-1) if end_with?(str)
+      self
+    end
+
+    def delete_prefix(str)
+      dup.delete_prefix!(str)
+    end
+
+    def delete_suffix(str)
+      dup.delete_suffix!(str)
+    end
+  end
+end

data/lib/fast_ignore/rule.rb

@@ -2,6 +2,8 @@
 
 class FastIgnore
   class Rule
+    using DeletePrefixSuffix unless RUBY_VERSION >= '2.5'
+
     def initialize(rule, root: Dir.pwd)
       @root = root
       @rule = rule

data/lib/fast_ignore/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FastIgnore
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/fast_ignore.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative './fast_ignore/delete_prefix_suffix'
 require_relative './fast_ignore/rule'
 require_relative './fast_ignore/rule_list'
 require_relative './fast_ignore/file_rule_list'
@@ -9,6 +10,7 @@ require 'find'
 
 class FastIgnore
   include Enumerable
+  using DeletePrefixSuffix unless RUBY_VERSION >= '2.5'
 
   attr_reader :rules
   attr_reader :relative

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_ignore
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-07 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,7 +104,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -116,6 +115,7 @@ files:
 - bin/setup
 - fast_ignore.gemspec
 - lib/fast_ignore.rb
+- lib/fast_ignore/delete_prefix_suffix.rb
 - lib/fast_ignore/file_rule_list.rb
 - lib/fast_ignore/gitignore_rule_list.rb
 - lib/fast_ignore/rule.rb
@@ -143,8 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Parse gitignore files, quickly

data/.ruby-version

@@ -1 +0,0 @@
-2.5.1