fast_ignore 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85adcabd5164bc3c1cf44af50ff5565b8ce00d6c69f8145eab0634fbaef551fb
-  data.tar.gz: de0192432d8423e5fee408aa7d3a052bc008d96b5cacadf7d2d6b66da3527030
+  metadata.gz: dc58ddc21668f583d8d2866415dd2654e20b6656c0efd959748be97c69e11018
+  data.tar.gz: 75b23ef5a9143a398ad68350c0a1700a2566e4cebd4311099d991e0b202a4af9
 SHA512:
-  metadata.gz: 8507d8f07c51e0cb2b00a0ea619683bc41ca85b0a89d7e4787f5b0aa9157d255ec261a4ffab130982c89f1c85b4a0dd5f7030bb18de20186362eaf894b816b65
-  data.tar.gz: 661628a1913544cc67d1833ddb84218db6b85de165ba11fb39dd1f62c014638b9fd72d8f3efe0bc8ce2f1379acf43a63a2bedf016e9ff5927d400e8c4932a57c
+  metadata.gz: 963cb997dcdb9f97dd9afdf7cea6eef408a0c225279bb80932e26cb3f495517e28bdd883cf1d45b66806efd39223775d719bd887a39fd6617575535d7ee528de
+  data.tar.gz: cef7f0d29b7715793d53519df4000fbf1dca04580e1df49ec8a996e96c092f110ac14d9729161e7ad5ba6a2dcc60108a642b30a9888e2271e1cbb8e011f2ac91

data/.rubocop.yml

@@ -14,6 +14,7 @@ AllCops:
     - vendor/**/*
   DisplayCopNames: true
   DisplayStyleGuide: true
+  TargetRubyVersion: 2.4
 
 # all of our layout customisations are because we prefer indentation to be
 # always consistently 2 spaces, for blocks, scopes, multiline expressions, etc
@@ -80,6 +81,9 @@ Layout/FirstArrayElementIndentation:
 Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
+Layout/LineLength:
+  Max: 120
+
 # to match our preference for consistent indentation
 # and hanging assignment looks lost
 Layout/MultilineAssignmentLayout:
@@ -114,9 +118,6 @@ Metrics/BlockLength:
     - context
     - shared_examples
 
-Metrics/LineLength:
-  Max: 120
-
 Metrics/CyclomaticComplexity:
   Enabled: false
 
@@ -200,3 +201,12 @@ Style/SymbolArray:
 
 Style/WordArray:
   Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/.travis.yml

@@ -3,9 +3,7 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3
   - 2.4
   - 2.5
   - 2.6
   - 2.7
-before_install: gem install bundler -v 1.17.3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.7.0
+- drop support for ruby 2.3. My plan is to only support supported ruby versions
+- add coverage to the pipeline. removed some methods, added some tests, and now we have 100% test coverage
+- deprecate using `gitignore: '/path/to/gitignore'`. please use `gitignore: false, ignore_files: '/path/to/gitignore'` instead.
+
 # v0.6.0
 - nicer argv handling
   - add `argv_rules:` option, which resolves paths and considers everything that doesn't start with a `*` to start with a `/`

data/Gemfile

@@ -5,4 +5,5 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in fast_ignore.gemspec
+
 gemspec

data/README.md

@@ -43,18 +43,21 @@ By default, FastIgnore will return full paths. To return paths relative to the c
 FastIgnore.new(relative: true).to_a
 ```
 
-You can specify other gitignore-style files to ignore as well. These rules will be appended after the gitignore file in order (order matters for negations)
+You can specify other gitignore-style files to ignore as well. Missing files will raise an `Errno::ENOENT` error.
+
 ```ruby
 FastIgnore.new(ignore_files: '/absolute/path/to/my/ignore/file').to_a
 FastIgnore.new(ignore_files: ['/absolute/path/to/my/ignore/file', '/and/another']).to_a
 ```
-You can also supply an array of rule strings. These rules will be appended after the gitignore and any other files in order (order matters for negations)
+
+You can also supply an array of rule strings.
+
 ```ruby
 FastIgnore.new(ignore_rules: '.DS_Store').to_a
 FastIgnore.new(ignore_rules: ['.git', '.gitkeep']).to_a
 ```
 
-To use only another ignore file or an array of rules, and not try to load a gitignore file:
+To use only another ignore file or an array of rules, and not even try to load a gitignore file:
 ```ruby
 FastIgnore.new(ignore_files: '/absolute/path/to/my/ignore/file', gitignore: false)
 FastIgnore.new(ignore_rules: %w{my*rule /and/another !rule}, gitignore: false)
@@ -62,11 +65,11 @@ FastIgnore.new(ignore_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:
 ```ruby
-FastIgnore.new(gitignore: '/absolute/path/to/.gitignore').to_a
+FastIgnore.new(ignore_file: '/absolute/path/to/.gitignore', gitignore: false).to_a
 ```
 Note that the location of the .gitignore file will affect rules beginning with `/` or ending in `/**`
 
-To raise if the gitignore file is not found use:
+To raise an `Errno::ENOENT` error if the .gitignore file is not found use:
 ```ruby
 FastIgnore.new(gitignore: true)
 ```
@@ -87,7 +90,7 @@ Building on the gitignore format, FastIgnore also accepts a list of allowed or i
 # a line like this means any files named foo will be included
 # as well as any files within directories named foo
 foo
-# a line beginning with a slash will be anything in a directory that is a child of the PWD
+# a line beginning with a slash will be anything in a directory that is a child of the $PWD
 /foo
 # a line ending in a slash will will include any files in any directories named foo
 # but not any files named foo
@@ -127,7 +130,7 @@ FastIgnore.new(include_files: StringIO.new([File.read('/my/path'), File.read('/a
 To use the additional ARGV handling rules mentioned above for files
 
 ```ruby
-FastIgnore.new(include_rules: ["my/rule", File.read('/my/path')])
+FastIgnore.new(argv_rules: ["my/rule", File.read('/my/path')])
 ```
 
 ## Known issues

data/fast_ignore.gemspec

@@ -14,6 +14,8 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/robotdana/fast_ignore'
   spec.license = 'MIT'
 
+  spec.required_ruby_version = '~> 2.4'
+
   if spec.respond_to?(:metadata)
     spec.metadata['homepage_uri'] = spec.homepage
     spec.metadata['source_code_uri'] = 'https://github.com/robotdana/fast_ignore'
@@ -28,9 +30,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '>= 1.17'
-  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'pry', '> 0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '>= 0.74.0'
   spec.add_development_dependency 'rubocop-rspec', '~> 1'
+  spec.add_development_dependency 'simplecov', '~> 0.18.5'
 end

data/lib/fast_ignore/rule.rb

@@ -17,12 +17,10 @@ class FastIgnore
       @negation = negation
     end
 
+    # :nocov:
     def inspect
       "#<Rule #{'!' if negation?}#{rule}#{'/' if dir_only?}>"
     end
-
-    def match?(path)
-      ::File.fnmatch?(@rule, path, 14)
-    end
+    # :nocov:
   end
 end

data/lib/fast_ignore/rule_parser.rb

@@ -5,15 +5,12 @@ require_relative 'backports'
 
 class FastIgnore
   class RuleParser
+    # :nocov:
     if ::FastIgnore::Backports.ruby_version_less_than?(2, 5)
       require_relative 'backports/delete_prefix_suffix'
       using ::FastIgnore::Backports::DeletePrefixSuffix
-
-      if ::FastIgnore::Backports.ruby_version_less_than?(2, 4)
-        require_relative 'backports/match'
-        using ::FastIgnore::Backports::Match
-      end
     end
+    # :nocov:
 
     # rule or nil
     class << self

data/lib/fast_ignore/rule_set_builder.rb

@@ -58,6 +58,8 @@ class FastIgnore
       when false
         nil
       else
+        warn 'Deprecation warning! supplying gitignore file path directly is deprecated. '\
+          'Please use gitignore: false and add your path to the ignore_files array'
         from_file(gitignore, project_root: root)
       end
     end

data/lib/fast_ignore/version.rb

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

data/lib/fast_ignore.rb

@@ -6,6 +6,7 @@ require_relative './fast_ignore/backports'
 class FastIgnore
   include ::Enumerable
 
+  # :nocov:
   if ::FastIgnore::Backports.ruby_version_less_than?(2, 5)
     require_relative 'fast_ignore/backports/delete_prefix_suffix'
     using ::FastIgnore::Backports::DeletePrefixSuffix
@@ -13,6 +14,7 @@ class FastIgnore
     require_relative 'fast_ignore/backports/dir_each_child'
     using ::FastIgnore::Backports::DirEachChild
   end
+  # :nocov:
 
   def initialize( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
     relative: false,
@@ -52,7 +54,6 @@ class FastIgnore
     path = ::File.expand_path(path)
     stat = ::File.stat(path)
     dir = stat.directory?
-    return false unless stat.readable?
     return false if dir
 
     @rule_sets.all? { |r| r.allowed_recursive?(path, dir) }
@@ -71,7 +72,6 @@ class FastIgnore
       begin
         child = path + child
         stat = ::File.stat(child)
-        next unless stat.readable?
 
         dir = stat.directory?
         next unless @rule_sets.all? { |r| r.allowed_unrecursive?(child, dir) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_ignore
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,14 +28,14 @@ dependencies:
   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
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
 description: 
 email:
 - robot@dana.sh
@@ -119,7 +133,6 @@ files:
 - lib/fast_ignore/backports.rb
 - lib/fast_ignore/backports/delete_prefix_suffix.rb
 - lib/fast_ignore/backports/dir_each_child.rb
-- lib/fast_ignore/backports/match.rb
 - lib/fast_ignore/rule.rb
 - lib/fast_ignore/rule_parser.rb
 - lib/fast_ignore/rule_set.rb
@@ -138,9 +151,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/fast_ignore/backports/match.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# This is a backport of ruby 2.4's match? method
-class FastIgnore
-  module Backports
-    module Match
-      refine ::String do
-        alias_method :match?, :match
-      end
-
-      refine ::Regexp do
-        alias_method :match?, :match
-      end
-    end
-  end
-end