fast_ignore 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc58ddc21668f583d8d2866415dd2654e20b6656c0efd959748be97c69e11018
-  data.tar.gz: 75b23ef5a9143a398ad68350c0a1700a2566e4cebd4311099d991e0b202a4af9
+  metadata.gz: 58d10e2bb7f504f6ff41d4ad3fbea902df56aa785d45a78e160a40ea5795a1a0
+  data.tar.gz: 16a77bf6dbdbb76f8e8f08793dd5a81d21147dcf9d77e72c4403de377025d4f3
 SHA512:
-  metadata.gz: 963cb997dcdb9f97dd9afdf7cea6eef408a0c225279bb80932e26cb3f495517e28bdd883cf1d45b66806efd39223775d719bd887a39fd6617575535d7ee528de
-  data.tar.gz: cef7f0d29b7715793d53519df4000fbf1dca04580e1df49ec8a996e96c092f110ac14d9729161e7ad5ba6a2dcc60108a642b30a9888e2271e1cbb8e011f2ac91
+  metadata.gz: 1de15ac6a8ce01bd18077bc402026cddbfeae82e33bbbd1e0e587d1ff3d898ac0fa43abc211bcf007cf2cec7c1fe00c2b60375760a767818330efc4164b2bf67
+  data.tar.gz: 7daed034a210e0f56be064400e7264c182f3abaeda13cd857b9d81f5fc6dc8c397195d087dc539a03f21787f65f24e39e87c4a5d182c419c80b00e5848148756

data/.simplecov

@@ -0,0 +1,6 @@
+SimpleCov.start do
+  add_filter '/backports'
+  add_filter '/spec/'
+  enable_coverage(:branch)
+  minimum_coverage 100
+end

data/CHANGELOG.md

@@ -1,8 +1,11 @@
-# v0.7.0
+# v0.8.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.7.0
+- add `include_shebang:` which filters by shebangs
+
 # 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/README.md

@@ -71,7 +71,12 @@ Note that the location of the .gitignore file will affect rules beginning with `
 
 To raise an `Errno::ENOENT` error if the .gitignore file is not found use:
 ```ruby
-FastIgnore.new(gitignore: true)
+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
 ```
 
 To check if a single file is allowed, use

data/bin/ls-shebangs

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/fast_ignore'
+
+puts FastIgnore.new(relative: true, include_shebangs: ARGV).to_a

data/fast_ignore.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 1.17'
   spec.add_development_dependency 'pry', '> 0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '>= 0.74.0'
   spec.add_development_dependency 'rubocop-rspec', '~> 1'

data/lib/fast_ignore/rule_parser.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'rule'
-require_relative 'backports'
-
 class FastIgnore
   class RuleParser
     # :nocov:

data/lib/fast_ignore/rule_set.rb

@@ -1,31 +1,37 @@
 # frozen_string_literal: true
 
-require_relative 'rule_parser'
-
 class FastIgnore
   class RuleSet
     attr_reader :rules
+    attr_reader :allow
+    alias_method :allow?, :allow
 
-    def initialize(project_root: Dir.pwd, allow: false)
-      @rules = []
-      @non_dir_only_rules = []
+    def initialize(project_root: Dir.pwd, allow: false, and_no_ext: 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)
+    def allowed_recursive?(path, dir, basename)
       @allowed_recursive ||= { @project_root => true }
       @allowed_recursive.fetch(path) do
         @allowed_recursive[path] =
-          allowed_recursive?(::File.dirname(path), true) && allowed_unrecursive?(path, dir)
+          allowed_recursive?(::File.dirname(path), true, nil) && allowed_unrecursive?(path, dir, basename)
       end
     end
 
-    def allowed_unrecursive?(path, dir)
-      (dir ? @rules : @non_dir_only_rules).reverse_each do |rule|
+    def allowed_unrecursive?(path, dir, basename)
+      if @and_no_ext
+        return true if dir
+        return true unless basename&.include?('.')
+      end
+
+      (dir ? @dir_rules : @file_rules).reverse_each do |rule|
         # 14 = Rule::FNMATCH_OPTIONS
         return rule.negation? if ::File.fnmatch?(rule.rule, path, 14)
       end
@@ -35,18 +41,18 @@ class FastIgnore
 
     def append_rules(anchored, rules)
       rules.each do |rule|
-        @rules << rule
-        @non_dir_only_rules << rule unless rule.dir_only?
+        @dir_rules << rule
+        @file_rules << rule unless rule.dir_only?
         @any_not_anchored ||= !anchored
       end
     end
 
     def length
-      @rules.length
+      @dir_rules.length
     end
 
     def empty?
-      @rules.empty?
+      @dir_rules.empty?
     end
   end
 end

data/lib/fast_ignore/rule_set_builder.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'rule_set'
-require_relative 'rule_parser'
-
 class FastIgnore
   class RuleSetBuilder
     def self.from_args( # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
@@ -12,28 +9,32 @@ class FastIgnore
       gitignore: :auto,
       include_rules: nil,
       include_files: nil,
-      argv_rules: nil
+      argv_rules: nil,
+      and_no_ext: false
     )
       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),
-        *from_files(include_files, allow: true, project_root: root),
-        from_array(argv_rules, root: root, allow: true, expand_path: true)
+        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)
       ]
 
       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)
+    def self.from_file(filename, allow: false, project_root: Dir.pwd, and_no_ext: false)
       filename = ::File.expand_path(filename)
       root = ::File.dirname(filename)
-      rule_set = ::FastIgnore::RuleSet.new(project_root: project_root, allow: allow)
+      rule_set = ::FastIgnore::RuleSet.new(project_root: project_root, allow: allow, and_no_ext: and_no_ext)
 
       ::IO.foreach(filename) do |rule_string|
         parse_rules(rule_string, allow: allow, rule_set: rule_set, root: root)
@@ -42,9 +43,9 @@ class FastIgnore
       rule_set
     end
 
-    def self.from_files(files, allow: false, project_root: Dir.pwd)
+    def self.from_files(files, allow: false, project_root: Dir.pwd, and_no_ext: false)
       Array(files).map do |file|
-        from_file(file, allow: allow, project_root: project_root)
+        from_file(file, allow: allow, project_root: project_root, and_no_ext: and_no_ext)
       end
     end
 
@@ -64,11 +65,11 @@ class FastIgnore
       end
     end
 
-    def self.from_array(rules, allow: false, expand_path: false, root: Dir.pwd)
+    def self.from_array(rules, allow: false, expand_path: false, root: Dir.pwd, and_no_ext: false)
       rules = Array(rules)
       return if rules.empty?
 
-      rule_set = ::FastIgnore::RuleSet.new(project_root: root, allow: allow)
+      rule_set = ::FastIgnore::RuleSet.new(project_root: root, allow: allow, and_no_ext: and_no_ext)
 
       rules.each_with_object(rule_set) do |rule_string, set|
         rule_string.each_line do |rule_line|

data/lib/fast_ignore/version.rb

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

data/lib/fast_ignore.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
-require_relative './fast_ignore/rule_set_builder'
 require_relative './fast_ignore/backports'
 
+require_relative './fast_ignore/rule_parser'
+require_relative './fast_ignore/rule_set_builder'
+require_relative './fast_ignore/rule_set'
+require_relative './fast_ignore/rule'
+
 class FastIgnore
   include ::Enumerable
 
@@ -24,10 +28,12 @@ class FastIgnore
     gitignore: :auto,
     include_rules: nil,
     include_files: nil,
+    include_shebangs: nil,
     argv_rules: nil
   )
     @root = root.delete_suffix('/')
     @root_trailing_slash = "#{@root}/"
+    @shebang_pattern = prepare_shebang_pattern(include_shebangs)
 
     @rule_sets = ::FastIgnore::RuleSetBuilder.from_args(
       root: @root,
@@ -36,7 +42,8 @@ class FastIgnore
       gitignore: gitignore,
       include_rules: include_rules,
       include_files: include_files,
-      argv_rules: argv_rules
+      argv_rules: argv_rules,
+      and_no_ext: @shebang_pattern
     )
 
     @relative = relative
@@ -56,7 +63,9 @@ class FastIgnore
     dir = stat.directory?
     return false if dir
 
-    @rule_sets.all? { |r| r.allowed_recursive?(path, dir) }
+    basename = ::File.basename(path)
+
+    @rule_sets.all? { |r| r.allowed_recursive?(path, dir, basename) } && match_shebang?(path, basename)
   rescue Errno::ENOENT, Errno::EACCES, Errno::ENOTDIR, Errno::ELOOP, Errno::ENAMETOOLONG
     false
   end
@@ -68,17 +77,22 @@ class FastIgnore
   end
 
   def each_allowed(path = @root_trailing_slash, &block) # rubocop:disable Metrics/MethodLength
-    Dir.each_child(path) do |child|
+    Dir.each_child(path) do |basename|
       begin
-        child = path + child
+        child = path + basename
         stat = ::File.stat(child)
 
         dir = stat.directory?
-        next unless @rule_sets.all? { |r| r.allowed_unrecursive?(child, dir) }
 
         if dir
+          next unless @rule_sets.all? { |r| r.allowed_unrecursive?(child, dir, nil) }
+
           each_allowed("#{child}/", &block)
         else
+          unless @rule_sets.all? { |r| r.allowed_unrecursive?(child, dir, basename) } && match_shebang?(child, basename)
+            next
+          end
+
           yield prepare_path(child)
         end
       rescue Errno::ENOENT, Errno::EACCES, Errno::ENOTDIR, Errno::ELOOP, Errno::ENAMETOOLONG
@@ -86,4 +100,26 @@ class FastIgnore
       end
     end
   end
+
+  def match_shebang?(path, basename)
+    return true unless @shebang_pattern
+    return true if basename.include?('.')
+
+    begin
+      f = ::File.new(path)
+      # i can't imagine a shebang being longer than 20 characters, lets multiply that by 10 just in case.
+      fragment = f.sysread(256)
+      f.close
+    rescue SystemCallError, EOFError
+      return
+    end
+
+    @shebang_pattern.match?(fragment)
+  end
+
+  def prepare_shebang_pattern(rules)
+    return if !rules || rules.empty?
+
+    /\A#!.*\b(?:#{rules.map { |s| Regexp.escape(s.to_s) }.join('|')})\b/.freeze
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_ignore
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2020-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".simplecov"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -127,6 +128,7 @@ files:
 - bin/console
 - bin/ls
 - bin/ls-disable-gems
+- bin/ls-shebangs
 - bin/setup
 - fast_ignore.gemspec
 - lib/fast_ignore.rb