fast_ignore 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02257f4f18a12cf4bae69ef8d4aa79c617f765726ae76a03bccf5391d920031e
-  data.tar.gz: 79fc7d4960118dbff36a42a6fae04d69890011842a2bb94c35966e7b9b1f8651
+  metadata.gz: 03c81966a545152071086c49d90057bc1950731affd0abdaabfe622c1b357d78
+  data.tar.gz: 312e624e3a542e3ee179d02f11070fe2a78d43cf7304b92a8420071ffdde75aa
 SHA512:
-  metadata.gz: be65dc38c204c7b1bfabd9cb61379a3516658c14bdbc242b396da79a247a1663e5d866194118f9da200410815f9888e946d9ac716e59ca9df9892cafede71da2
-  data.tar.gz: a6a4178e53e44c46f952e38aa66e7d5b92b90d449bacf449638afded35c82549c543ccd9aeebe1e53f505d0847f585c9be9fd0c13fcfa3f1344990f2faeee57d
+  metadata.gz: 98af14403dd1ba3dd9ac4800077324ed21d00a0a57e9761e3e720fe81e723de589e016ae78696c8ce173ab60e027361a37181c61492fbd8240a85657612b13ad
+  data.tar.gz: df3f1d628a6f42b8630ee6c8aacc23722720e88e782001809bb4106da68853e365f573b4796b3e0fa828fc640428ac7e820ab6b0eade1a8eee1affbea605118d

data/.gitignore

@@ -1,13 +1,6 @@
 /.bundle/
-/.yardoc
-/_yardoc/
 /coverage/
-/doc/
 /pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
 .rspec_status
 *.gem
 Gemfile.lock

data/.rubocop.yml

@@ -7,6 +7,7 @@ require: rubocop-rspec
 # Each override should have a comment (even if it's just "default is bad")
 
 AllCops:
+  NewCops: enable
   Exclude:
     - db/schema*
     - .bundle/**/*

data/.spellr.yml

@@ -0,0 +1,5 @@
+excludes:
+  - vendor
+languages:
+  english:
+    locale: [US, AU]

data/.spellr_wordlists/english.txt

@@ -0,0 +1,41 @@
+argv
+backports
+baz
+changelog
+codebase
+config
+cov
+cyclomatic
+enoent
+enumerables
+errno
+extensionless
+fancyignore
+gemfile
+github
+gitignore
+gitkeep
+hashbang
+klass
+nocov
+noninfringement
+params
+pathspec
+pwd
+rdoc
+regexp
+rspec
+rubo
+rubocop
+rubygems
+rulesets
+rvm
+sherson
+simplecov
+stdin
+sudo
+tmp
+toplevel
+txt
+unrecursive
+zsh

data/.spellr_wordlists/ruby.txt

@@ -0,0 +1 @@
+rspec

data/.spellr_wordlists/shell.txt

@@ -0,0 +1,3 @@
+env
+euo
+usr

data/CHANGELOG.md

@@ -1,5 +1,8 @@
+# v0.8.2
+- fix `include_rules` not matching filenames with no extension when using `include_shebangs:`
+
 # v0.8.1
-- `include_shebang:` can be given non array value
+- `include_shebangs:` can be given non array value
 
 # v0.8.0
 - drop support for ruby 2.3. My plan is to only support supported ruby versions
@@ -7,7 +10,7 @@
 - deprecate using `gitignore: '/path/to/gitignore'`. please use `gitignore: false, ignore_files: '/path/to/gitignore'` instead.
 
 # v0.7.0
-- add `include_shebang:` which filters by shebangs
+- add `include_shebangs:` which filters by shebangs
 
 # v0.6.0
 - nicer argv handling

data/README.md

@@ -77,6 +77,7 @@ FastIgnore.new(gitignore: true).to_a
 To filter by extensionless files shebang/hashbang/etc:
 ```ruby
 FastIgnore.new(include_rules: '*.rb', include_shebangs: 'ruby').to_a
+FastIgnore.new(include_rules: '*.sh', include_shebangs: ['sh', 'bash', 'zsh']).to_a
 ```
 
 To check if a single file is allowed, use

data/Rakefile

@@ -3,8 +3,10 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
+require 'spellr/rake_task'
 
 RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
+Spellr::RakeTask.generate_task
 
-task default: [:spec, :rubocop]
+task default: [:spec, :rubocop, :spellr]

data/fast_ignore.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '>= 0.74.0'
   spec.add_development_dependency 'rubocop-rspec', '~> 1'
   spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  spec.add_development_dependency 'spellr', '>= 0.8.1'
 end

data/lib/fast_ignore.rb

@@ -42,10 +42,11 @@ class FastIgnore
       gitignore: gitignore,
       include_rules: include_rules,
       include_files: include_files,
-      argv_rules: argv_rules,
-      and_no_ext: @shebang_pattern
+      argv_rules: argv_rules
     )
 
+    @include_rule_sets, @ignore_rule_sets = @rule_sets.partition(&:allow?)
+    @has_include_rule_sets = !@include_rule_sets.empty?
     @relative = relative
   end
 
@@ -59,13 +60,15 @@ class FastIgnore
 
   def allowed?(path)
     path = ::File.expand_path(path)
-    stat = ::File.stat(path)
-    dir = stat.directory?
-    return false if dir
+    dir = ::File.stat(path).directory? # equivalent to directory? and exist?
 
-    basename = ::File.basename(path)
+    return false if dir
+    return false unless @ignore_rule_sets.all? { |r| r.allowed_recursive?(path, dir) }
+    return @include_rule_sets.all? { |r| r.allowed_recursive?(path, dir) } unless @shebang_pattern
 
-    @rule_sets.all? { |r| r.allowed_recursive?(path, dir, basename) } && match_shebang?(path, basename)
+    (@has_include_rule_sets &&
+      @include_rule_sets.all? { |r| r.allowed_unrecursive?(path, false) }) ||
+      match_shebang?(path, ::File.basename(path))
   rescue Errno::ENOENT, Errno::EACCES, Errno::ENOTDIR, Errno::ELOOP, Errno::ENAMETOOLONG
     false
   end
@@ -76,21 +79,27 @@ class FastIgnore
     @relative ? path.delete_prefix(@root_trailing_slash) : path
   end
 
-  def each_allowed(path = @root_trailing_slash, &block) # rubocop:disable Metrics/MethodLength
+  def each_allowed(path = @root_trailing_slash, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     Dir.each_child(path) do |basename|
       begin
         child = path + basename
-        stat = ::File.stat(child)
-
-        dir = stat.directory?
+        dir = ::File.stat(child).directory? # equivalent to directory? and exist?
 
         if dir
-          next unless @rule_sets.all? { |r| r.allowed_unrecursive?(child, dir, nil) }
+          next unless @shebang_pattern || @rule_sets.all? { |r| r.allowed_unrecursive?(child, dir) }
 
           each_allowed("#{child}/", &block)
         else
-          unless @rule_sets.all? { |r| r.allowed_unrecursive?(child, dir, basename) } && match_shebang?(child, basename)
-            next
+          next unless @ignore_rule_sets.all? { |r| r.allowed_unrecursive?(child, dir) }
+
+          if @shebang_pattern
+            unless (@has_include_rule_sets &&
+                @include_rule_sets.all? { |r| r.allowed_unrecursive?(child, dir) }) ||
+                match_shebang?(child, basename)
+              next
+            end
+          else
+            next unless @include_rule_sets.all? { |r| r.allowed_unrecursive?(child, dir) }
           end
 
           yield prepare_path(child)
@@ -102,8 +111,7 @@ class FastIgnore
   end
 
   def match_shebang?(path, basename)
-    return true unless @shebang_pattern
-    return true if basename.include?('.')
+    return false if basename.include?('.')
 
     begin
       f = ::File.new(path)
@@ -111,7 +119,7 @@ class FastIgnore
       fragment = f.sysread(256)
       f.close
     rescue SystemCallError, EOFError
-      return
+      return false
     end
 
     @shebang_pattern.match?(fragment)
@@ -120,6 +128,9 @@ class FastIgnore
   def prepare_shebang_pattern(rules)
     return if !rules || (rules = Array(rules)).empty?
 
-    /\A#!.*\b(?:#{rules.flat_map { |s| s.to_s.split("\n") }.map { |s| Regexp.escape(s.to_s) }.join('|')})\b/.freeze
+    rules = rules.flat_map { |s| s.to_s.split("\n") }
+    rules_re = rules.map { |s| Regexp.escape(s.to_s) }.join('|')
+
+    /\A#!.*\b(?:#{rules_re})\b/.freeze
   end
 end

data/lib/fast_ignore/rule_set.rb

@@ -6,31 +6,25 @@ class FastIgnore
     attr_reader :allow
     alias_method :allow?, :allow
 
-    def initialize(project_root: Dir.pwd, allow: false, and_no_ext: false)
+    def initialize(project_root: Dir.pwd, allow: false)
       @dir_rules = []
       @file_rules = []
       @project_root = project_root
-      @and_no_ext = and_no_ext
 
       @any_not_anchored = false
       @allow = allow
       @default = true unless allow
     end
 
-    def allowed_recursive?(path, dir, basename)
+    def allowed_recursive?(path, dir)
       @allowed_recursive ||= { @project_root => true }
       @allowed_recursive.fetch(path) do
         @allowed_recursive[path] =
-          allowed_recursive?(::File.dirname(path), true, nil) && allowed_unrecursive?(path, dir, basename)
+          allowed_recursive?(::File.dirname(path), true) && allowed_unrecursive?(path, dir)
       end
     end
 
-    def allowed_unrecursive?(path, dir, basename)
-      if @and_no_ext
-        return true if dir
-        return true unless basename&.include?('.')
-      end
-
+    def allowed_unrecursive?(path, dir)
       (dir ? @dir_rules : @file_rules).reverse_each do |rule|
         # 14 = Rule::FNMATCH_OPTIONS
         return rule.negation? if ::File.fnmatch?(rule.rule, path, 14)

data/lib/fast_ignore/rule_set_builder.rb

@@ -9,32 +9,28 @@ class FastIgnore
       gitignore: :auto,
       include_rules: nil,
       include_files: nil,
-      argv_rules: nil,
-      and_no_ext: false
+      argv_rules: nil
     )
       rule_sets = [
         from_array(ignore_rules, root: root),
         *from_files(ignore_files, project_root: root),
         from_array('.git', root: root),
         from_gitignore_arg(gitignore, root: root),
-        from_array(include_rules, root: root, allow: true, and_no_ext: and_no_ext),
-        *from_files(include_files, allow: true, project_root: root, and_no_ext: and_no_ext),
-        from_array(argv_rules, root: root, allow: true, expand_path: true, and_no_ext: and_no_ext)
+        from_array(include_rules, root: root, allow: true),
+        *from_files(include_files, allow: true, project_root: root),
+        from_array(argv_rules, root: root, allow: true, expand_path: true)
       ]
 
       rule_sets.compact!
       rule_sets.reject!(&:empty?)
-      if and_no_ext && rule_sets.none?(&:allow?)
-        rule_sets << ::FastIgnore::RuleSet.new(project_root: root, allow: true, and_no_ext: and_no_ext)
-      end
       rule_sets.sort_by!(&:length)
       rule_sets
     end
 
-    def self.from_file(filename, allow: false, project_root: Dir.pwd, and_no_ext: false)
+    def self.from_file(filename, allow: false, project_root: Dir.pwd)
       filename = ::File.expand_path(filename)
       root = ::File.dirname(filename)
-      rule_set = ::FastIgnore::RuleSet.new(project_root: project_root, allow: allow, and_no_ext: and_no_ext)
+      rule_set = ::FastIgnore::RuleSet.new(project_root: project_root, allow: allow)
 
       ::IO.foreach(filename) do |rule_string|
         parse_rules(rule_string, allow: allow, rule_set: rule_set, root: root)
@@ -43,9 +39,9 @@ class FastIgnore
       rule_set
     end
 
-    def self.from_files(files, allow: false, project_root: Dir.pwd, and_no_ext: false)
+    def self.from_files(files, allow: false, project_root: Dir.pwd)
       Array(files).map do |file|
-        from_file(file, allow: allow, project_root: project_root, and_no_ext: and_no_ext)
+        from_file(file, allow: allow, project_root: project_root)
       end
     end
 
@@ -65,11 +61,11 @@ class FastIgnore
       end
     end
 
-    def self.from_array(rules, allow: false, expand_path: false, root: Dir.pwd, and_no_ext: false)
+    def self.from_array(rules, allow: false, expand_path: false, root: Dir.pwd)
       rules = Array(rules)
       return if rules.empty?
 
-      rule_set = ::FastIgnore::RuleSet.new(project_root: root, allow: allow, and_no_ext: and_no_ext)
+      rule_set = ::FastIgnore::RuleSet.new(project_root: root, allow: allow)
 
       rules.each do |rule_string|
         rule_string.to_s.each_line do |rule_line|

data/lib/fast_ignore/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_ignore
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: spellr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 description: 
 email:
 - robot@dana.sh
@@ -119,6 +133,10 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
+- ".spellr.yml"
+- ".spellr_wordlists/english.txt"
+- ".spellr_wordlists/ruby.txt"
+- ".spellr_wordlists/shell.txt"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile