fast_ignore 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3d94c089fb5c75d6c9d0650d2391d03425c487c81296495f44f35ed1f6d80ac
-  data.tar.gz: a9bba05df8121aa49d38b39c7aaaa0e3c7d2b30e4b874d083fe517fa36846b97
+  metadata.gz: 2dd945c76bf226766ac86086faf839eac44c4c0cce452e2a3a44e7c47964b7f5
+  data.tar.gz: a72de31878713db71c94aa8067c87b807f19833eb008a1a6d6e673fcdeff5a7a
 SHA512:
-  metadata.gz: e8954fbef86b13d7948744b2c803319b261d67b6afe83412f1e099a377b17adae2aa1106a3445e6f5604449130c8dfc815331fe104f205ca09b87f5ff8caa69e
-  data.tar.gz: e53891e9d8b056a62ede7399695deb2911d5836ad5b8442b2ef90d7876fb4d794f1665697df6e7eeecf616f828217fce841f96c9bdfd39e73ae6c89594a65d5c
+  metadata.gz: cff75a6418ecc958f2a839b9617554e3857763611248063aef27ec244dd0d1b433d61b81bfdb85a74dd8497fea8599f146ae723fd76023aef72285f53a620ecd
+  data.tar.gz: 39aeceb2cd078c8b873019b9763eccb01450e408a24c3fb04005f9451879e1a125bcd73f26a1c4e67e6c999e7d6d0f78b4a1b41abbc0a2650ec36bb1ac7adde6

data/.spellr_wordlists/english.txt

@@ -22,6 +22,7 @@ includefile
 janky
 klass
 llo
+memoize
 nocov
 noninfringement
 params
@@ -47,4 +48,5 @@ txt
 unrecursive
 upcase
 usr
+webpack
 zsh

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.10.2
+- add FastIgnore#=== as an alias for FastIgnore#allowed? so that FastIgnore objects can be used for case statements.
+- Fix shebangs in non-pwd-root situations
+
 # v0.10.1
 - Add option to follow symlinks (turns out i needed it)
 - performance improvements

data/README.md

@@ -49,8 +49,27 @@ Like other enumerables, `FastIgnore#each` can return an enumerator
 FastIgnore.new.each.with_index { |file, index| puts "#{file}#{index}" }
 ```
 
+### `#allowed?`
+
+To check if a single file is allowed, use
+```ruby
+FastIgnore.new.allowed?('relative/path')
+FastIgnore.new.allowed?('./relative/path')
+FastIgnore.new.allowed?('/absolute/path')
+FastIgnore.new.allowed?('~/home/path')
+```
+
+This is aliased as `===` so you can use the FastIgnore object in case statements.
+```ruby
+case my_path
+when FastIgnore.new then puts my_path
+end
+```
+
+It's recommended to memoize the FastIgnore.new object somehow to avoid having to parse the gitignore file repeatedly.
+
 ### `relative: true`
-By default, FastIgnore will return full paths. To return paths relative to the current working directory, or the supplied [`root:`](#root), use:
+By default, FastIgnore.each will yield full paths. To yield paths relative to the current working directory, or if supplied, [`root:`](#root), use:
 
 ```ruby
 FastIgnore.new(relative: true).to_a
@@ -116,16 +135,6 @@ FastIgnore.new(ignore_rules: ['.git', '.gitkeep']).to_a
 FastIgnore.new(ignore_rules: ".git\n.gitkeep").to_a
 ```
 
-# `#allowed?`
-
-To check if a single file is allowed, use
-```ruby
-FastIgnore.new.allowed?('relative/path')
-FastIgnore.new.allowed?('./relative/path')
-FastIgnore.new.allowed?('/absolute/path')
-FastIgnore.new.allowed?('~/home/path')
-```
-
 ### `include_files:` and `include_rules:`
 
 Building on the gitignore format, FastIgnore also accepts a list of allowed or included files.

data/bin/time

@@ -1,6 +1,9 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+# use mac terminal not vs code terminal
+# ensure nothing else is watching that dir in the filesystem e.g. webpack
+
 require 'open3'
 RUNS = 30
 SCRIPT = "time #{__dir__}/ls"

data/fast_ignore.gemspec

@@ -37,5 +37,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'
+  spec.add_development_dependency 'spellr', '>= 0.8.3'
 end

data/lib/fast_ignore.rb

@@ -6,6 +6,7 @@ require_relative './fast_ignore/rule_set_builder'
 require_relative './fast_ignore/rule_builder'
 require_relative './fast_ignore/rule_set'
 require_relative './fast_ignore/rule'
+require_relative './fast_ignore/shebang_rule'
 
 class FastIgnore
   class Error < StandardError; end
@@ -25,8 +26,7 @@ class FastIgnore
   def initialize(relative: false, root: nil, follow_symlinks: false, **rule_set_builder_args)
     @relative = relative
     @follow_symlinks = follow_symlinks
-    dir_pwd = Dir.pwd
-    @root = "#{::File.expand_path(root.to_s, dir_pwd)}/"
+    @root = "#{::File.expand_path(root.to_s, Dir.pwd)}/"
     @rule_sets = ::FastIgnore::RuleSetBuilder.build(root: @root, **rule_set_builder_args)
 
     freeze
@@ -57,10 +57,11 @@ class FastIgnore
     relative_path = full_path.delete_prefix(@root)
     filename = ::File.basename(relative_path)
 
-    @rule_sets.all? { |r| r.allowed_recursive?(relative_path, false, filename) }
+    @rule_sets.all? { |r| r.allowed_recursive?(relative_path, false, full_path, filename) }
   rescue ::Errno::ENOENT, ::Errno::EACCES, ::Errno::ENOTDIR, ::Errno::ELOOP, ::Errno::ENAMETOOLONG
     false
   end
+  alias_method :===, :allowed?
 
   private
 
@@ -71,7 +72,7 @@ class FastIgnore
         relative_path = parent_relative_path + filename
         dir = directory?(full_path)
 
-        next unless @rule_sets.all? { |r| r.allowed_unrecursive?(relative_path, dir, filename) }
+        next unless @rule_sets.all? { |r| r.allowed_unrecursive?(relative_path, dir, full_path, filename) }
 
         if dir
           each_recursive(full_path + '/', relative_path + '/', &block)

data/lib/fast_ignore/rule.rb

@@ -10,17 +10,17 @@ class FastIgnore
 
     attr_reader :negation
     alias_method :negation?, :negation
+    undef :negation
 
     attr_reader :dir_only
     alias_method :dir_only?, :dir_only
-
-    attr_reader :shebang
-    alias_method :file_only?, :shebang
+    undef :dir_only
 
     attr_reader :unanchored
     alias_method :unanchored?, :unanchored
+    undef :unanchored
 
-    def initialize(rule, unanchored, dir_only, negation, shebang = nil)
+    def initialize(rule, unanchored, dir_only, negation)
       @rule = rule
       @unanchored = unanchored
       @dir_only = dir_only
@@ -30,42 +30,22 @@ class FastIgnore
       freeze
     end
 
-    # :nocov:
-    def inspect
-      if shebang
-        "#<Rule #{'allow ' if @negation}#!:#{@shebang.to_s[15..-4]}>"
-      else
-        "#<Rule #{'!' if @negation}#{@rule}#{'/' if @dir_only}>"
-      end
+    def file_only?
+      false
     end
-    # :nocov:
 
-    def match?(path, filename)
-      if @shebang
-        match_shebang?(path, filename)
-      else
-        # 14 = FNMATCH_OPTIONS
-        ::File.fnmatch?(@rule, path, 14)
-      end
+    def shebang
+      nil
     end
 
-    def match_shebang?(path, filename)
-      return false if filename.include?('.')
-
-      first_line(path)&.match?(@shebang)
+    # :nocov:
+    def inspect
+      "#<Rule #{'!' if @negation}#{@rule}#{'/' if @dir_only}>"
     end
+    # :nocov:
 
-    def first_line(path)
-      file = ::File.new(path)
-      first_line = file.sysread(25)
-      first_line += file.sysread(50) until first_line.include?("\n")
-      file.close
-      first_line
-    rescue ::EOFError, ::SystemCallError
-      # :nocov:
-      file&.close
-      # :nocov:
-      first_line
+    def match?(relative_path, _, _)
+      ::File.fnmatch?(@rule, relative_path, 14)
     end
   end
 end

data/lib/fast_ignore/rule_builder.rb

@@ -2,7 +2,6 @@
 
 class FastIgnore
   module RuleBuilder
-    # rule or nil
     class << self
       # :nocov:
       if ::FastIgnore::Backports.ruby_version_less_than?(2, 5)
@@ -12,9 +11,9 @@ class FastIgnore
       # :nocov:
 
       def build(rule, allow, expand_path, file_root)
-        strip(rule)
-
         return shebang_rules(rule, allow) if remove_shebang(rule)
+
+        strip(rule)
         return [] if skip?(rule)
 
         gitignore_rules(rule, allow, expand_path, file_root)
@@ -36,7 +35,7 @@ class FastIgnore
       end
 
       def shebang_rules(rule, allow)
-        rules = [::FastIgnore::Rule.new(nil, true, false, allow, /\A#!.*\b#{Regexp.escape(rule)}\b/.freeze)]
+        rules = [::FastIgnore::ShebangRule.new(/\A#!.*\b#{Regexp.escape(rule)}\b/.freeze, allow)]
         return rules unless allow
 
         rules << ::FastIgnore::Rule.new('**/*', true, true, true)

data/lib/fast_ignore/rule_set.rb

@@ -20,16 +20,17 @@ class FastIgnore
       super
     end
 
-    def allowed_recursive?(path, dir, filename)
-      @allowed_recursive.fetch(path) do
-        @allowed_recursive[path] =
-          allowed_recursive?(::File.dirname(path), true, nil) && allowed_unrecursive?(path, dir, filename)
+    def allowed_recursive?(relative_path, dir, full_path, filename)
+      @allowed_recursive.fetch(relative_path) do
+        @allowed_recursive[relative_path] =
+          allowed_recursive?(::File.dirname(relative_path), true, nil, nil) &&
+          allowed_unrecursive?(relative_path, dir, full_path, filename)
       end
     end
 
-    def allowed_unrecursive?(path, dir, filename)
+    def allowed_unrecursive?(relative_path, dir, full_path, filename)
       (dir ? @dir_rules : @file_rules).reverse_each do |rule|
-        return rule.negation? if rule.match?(path, filename)
+        return rule.negation? if rule.match?(relative_path, full_path, filename)
       end
 
       (not @allow) || (dir && @any_not_anchored)

data/lib/fast_ignore/shebang_rule.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class FastIgnore
+  class ShebangRule
+    attr_reader :negation
+    alias_method :negation?, :negation
+    undef :negation
+
+    attr_reader :shebang
+
+    def initialize(shebang, negation)
+      @shebang = shebang
+      @negation = negation
+
+      freeze
+    end
+
+    def file_only?
+      true
+    end
+
+    def dir_only?
+      false
+    end
+
+    def unanchored?
+      true
+    end
+
+    # :nocov:
+    def inspect
+      "#<ShebangRule #{'allow ' if @negation}#!:#{@shebang.to_s[15..-4]}>"
+    end
+    # :nocov:
+
+    def match?(_, full_path, filename)
+      return false if filename.include?('.')
+
+      first_line(full_path)&.match?(@shebang)
+    end
+
+    private
+
+    def first_line(path)
+      file = ::File.new(path)
+      first_line = file.sysread(25)
+      first_line += file.sysread(50) until first_line.include?("\n")
+      file.close
+      first_line
+    rescue ::EOFError, ::SystemCallError
+      # :nocov:
+      file&.close
+      # :nocov:
+      first_line
+    end
+  end
+end

data/lib/fast_ignore/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_ignore
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.10.2
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2020-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.8.3
 description: 
 email:
 - robot@dana.sh
@@ -171,6 +171,7 @@ files:
 - lib/fast_ignore/rule_builder.rb
 - lib/fast_ignore/rule_set.rb
 - lib/fast_ignore/rule_set_builder.rb
+- lib/fast_ignore/shebang_rule.rb
 - lib/fast_ignore/version.rb
 homepage: https://github.com/robotdana/fast_ignore
 licenses: