fast_ignore 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f467113b0ee03faf028758ac176c59b3e51465684f8ffe144d432ba75133c10f
-  data.tar.gz: 2f6f0ce0babec00977a55595baa7ec806d7a9a3f1fec86df46f29475b41238cc
+  metadata.gz: 45d98b9329a3cf9935ad9bda95f89ffcea7776c19acde46b4f758cf03bad654b
+  data.tar.gz: ec33228d9d25f5e82a8deed045c5dc2f1885e7fcf05779e079ab4a1460f981f2
 SHA512:
-  metadata.gz: 3a7698e54ab0897b6b50c8638d41f3243bd3ba4ced559a5c7e01f6d365b6fb875b906a1924e96641572815748479eb793dfabc91da6f3bec62115f98ff39a392
-  data.tar.gz: 7e8b85ff838d04d1c16cd3eca5a480d6948342a07667760782840b0e36a706c02db2bb4e09e3370b3ccc1cdc2f38f9e893707c9f2128652a8a4aae4cdb8dd3d0
+  metadata.gz: 6d03cc0337b2b5bb4b7f90adaeedf645e6fcc01a299c873cbdec743f2d13a7a6820c2269a4193d1723907e3f7de00ec4aa76d90a52efba9c022462edb5e129fe
+  data.tar.gz: 9771665b209531cd704c8603b9791755e054f5a3f72214ef43d23dfb403263f5c00f5ebe9be27b94a63503c85e35dc3d6c4293822cf93bd8ef4dc60b6b2b7715

data/.spellr_wordlists/english.txt

@@ -11,18 +11,21 @@ enumerables
 env
 errno
 esque
+excludesfile
 extensionless
 fancyignore
 filesystem
 fnmatch
 frotz
 gemfile
+gitconfig
 github
 gitignore
 gitkeep
 hashbang
 includefile
 janky
+jruby
 klass
 llo
 memoize
@@ -43,6 +46,7 @@ rvm
 sherson
 simplecov
 stdin
+subdir
 substring
 sudo
 symlinks
@@ -53,4 +57,6 @@ unrecursive
 upcase
 usr
 webpack
+xconfig
+xdg
 zsh

data/.travis.yml

@@ -8,3 +8,4 @@ rvm:
   - 2.5
   - 2.6
   - 2.7
+  - jruby

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.12.0
+- Reads all relevant gitignore files (nested .gitignore files, global .gitignore referred to in .gitconfig, and .git/info/exclude)
+
 # v0.11.0
 - major performance improvement (use regexp rather than fnmatch)
 - optionally pass directory: and content: into allowed? if these are already loaded.

data/README.md

@@ -14,12 +14,13 @@ FastIgnore.new(relative: true).sort == `git ls-files`.split("\n").sort
 ## Features
 
 - Fast (faster than using `` `git ls-files`.split("\n") `` for small repos (because it avoids the overhead of ``` `` ```))
-- Supports ruby 2.4 - 2.7
+- Supports ruby 2.4 - 2.7 & jruby
 - supports all gitignore rule patterns
 - doesn't require git to be installed
 - supports a gitignore-esque "include" patterns. (`include_rules:`/`include_files:`)
 - supports an expansion of include patterns, matching expanded paths (`argv_rules:`)
 - supports matching by shebang rather than filename for extensionless files: `#!:`
+- in addition to .gitignore, reads .git/info/excludes and the ignore file mentioned in your ~/.gitconfig
 
 ## Installation
 
@@ -98,10 +99,12 @@ FastIgnore.new(follow_symlinks: true).to_a
 
 By default, root is PWD (the current working directory)
 This directory is used for:
-- looking for .gitignore files
-- as the root directory for array rules starting with `/` or ending with `/**`
+- the location of .git/core/exclude
+- the outermost directory that project .gitignore files are looked for
+- the root directory for array rules starting with `/` or ending with `/**`
 - and the path that relative is relative to
-- which files get checked
+- the ancestor of which files get checked
+- the ancestor of all include_files and ignore_files
 
 To use a different directory:
 ```ruby
@@ -111,7 +114,8 @@ FastIgnore.new(root: '../relative/path/to/root').to_a
 
 ### `gitignore:`
 
-By default, the .gitignore file in root directory is loaded.
+By default, the .gitignore file in the root directory is loaded, plus any .gitignore files in subdirectories, the global ignore file, and .git/info/exclude.
+
 To not do this use
 ```ruby
 FastIgnore.new(gitignore: false).to_a
@@ -124,7 +128,7 @@ FastIgnore.new(gitignore: true).to_a
 
 If the gitignore file is somewhere else
 ```ruby
-FastIgnore.new(ignore_file: '/absolute/path/to/.gitignore', gitignore: false).to_a
+FastIgnore.new(ignore_file: '/absolute/path/to/.gitignore').to_a
 ```
 Note that the location of the .gitignore file will affect rules beginning with `/` or ending in `/**`
 
@@ -133,7 +137,7 @@ 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: 'relative/path/to/my/ignore/file').to_a
 FastIgnore.new(ignore_files: ['/absolute/path/to/my/ignore/file', '/and/another']).to_a
 ```
 
@@ -235,8 +239,6 @@ This is not required, and if FastIgnore does have to go to the filesystem for th
 
 
 ## 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`.
 - Doesn't know what to do if you change the current working directory inside the `FastIgnore#each` block.
   So don't do that.
 

data/Rakefile

@@ -11,4 +11,8 @@ RSpec::Core::RakeTask.new(:spec)
 Spellr::RakeTask.generate_task
 Leftovers::RakeTask.generate_task
 
-task default: [:spec, :rubocop, :spellr, :leftovers]
+if RUBY_PLATFORM == 'java'
+  task default: :spec
+else
+  task default: [:spec, :rubocop, :spellr, :leftovers]
+end

data/bin/ls_seconds

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby --disable-all
+# frozen_string_literal: true
+
+require_relative '../lib/fast_ignore'
+
+t1 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+new_a = FastIgnore.new(relative: true, argv_rules: ARGV).to_a
+t2 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+puts "new #{new_a.count}: #{t2 - t1}"
+fi = FastIgnore.new(relative: true, argv_rules: ARGV)
+fi.to_a
+t3 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+cached_a = fi.to_a
+t4 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+puts "cached #{cached_a.count}: #{t4 - t3}"
+t5 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+git_a = `git ls-files`.split("\n")
+t6 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+puts "git ls-files #{git_a.count}: #{t6 - t5}"
+
+exit 1 unless new_a.length == cached_a.length && new_a.length == git_a.length

data/lib/fast_ignore.rb

@@ -2,6 +2,7 @@
 
 require_relative './fast_ignore/backports'
 
+require 'set'
 require_relative './fast_ignore/rule_set_builder'
 require_relative './fast_ignore/rule_builder'
 require_relative './fast_ignore/rule_set'
@@ -19,11 +20,13 @@ class FastIgnore
   using ::FastIgnore::Backports::DirEachChild if defined?(::FastIgnore::Backports::DirEachChild)
   # :nocov:
 
-  def initialize(relative: false, root: nil, follow_symlinks: false, **rule_set_builder_args)
+  def initialize(relative: false, root: nil, gitignore: :auto, follow_symlinks: false, **rule_set_builder_args)
     @relative = relative
     @follow_symlinks = follow_symlinks
+    @gitignore_enabled = gitignore
+    @loaded_gitignore_files = Set[''] if gitignore
     @root = "#{::File.expand_path(root.to_s, Dir.pwd)}/"
-    @rule_sets = ::FastIgnore::RuleSetBuilder.build(root: @root, **rule_set_builder_args)
+    @rule_sets = ::FastIgnore::RuleSetBuilder.build(root: @root, gitignore: gitignore, **rule_set_builder_args)
 
     freeze
   end
@@ -43,6 +46,8 @@ class FastIgnore
     return false if directory.nil? ? directory?(full_path) : directory
 
     relative_path = full_path.delete_prefix(@root)
+    load_gitignore_recursive(relative_path) if @gitignore_enabled
+
     filename = ::File.basename(relative_path)
 
     @rule_sets.all? { |r| r.allowed_recursive?(relative_path, false, full_path, filename, content) }
@@ -61,8 +66,30 @@ class FastIgnore
     end
   end
 
-  def each_recursive(parent_full_path, parent_relative_path, &block) # rubocop:disable Metrics/MethodLength
-    ::Dir.each_child(parent_full_path) do |filename|
+  def load_gitignore_recursive(path)
+    paths = []
+    while (path = ::File.dirname(path)) != '.'
+      paths << path
+    end
+
+    paths.reverse_each(&method(:load_gitignore))
+  end
+
+  def load_gitignore(parent_path, soft: true)
+    return if @loaded_gitignore_files.include?(parent_path)
+
+    ::FastIgnore::RuleSetBuilder.append_gitignore(
+      @rule_sets, project_root: @root, relative_path: parent_path + '.gitignore', soft: soft
+    )
+    @loaded_gitignore_files << parent_path
+  end
+
+  def each_recursive(parent_full_path, parent_relative_path, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    children = ::Dir.children(parent_full_path)
+
+    load_gitignore(parent_relative_path, soft: false) if @gitignore_enabled && children.include?('.gitignore')
+
+    children.each do |filename|
       begin
         full_path = parent_full_path + filename
         relative_path = parent_relative_path + filename

data/lib/fast_ignore/backports.rb

@@ -6,12 +6,8 @@ class FastIgnore
     unless ruby_major.to_i > 2 || ruby_major.to_i == 2 && ruby_minor.to_i > 5
       module DirEachChild
         refine ::Dir.singleton_class do
-          def each_child(path, &block)
-            Dir.entries(path).each do |entry|
-              next if entry == '.' || entry == '..'
-
-              block.call entry
-            end
+          def children(path)
+            Dir.entries(path) - ['.', '..']
           end
         end
       end

data/lib/fast_ignore/rule_set.rb

@@ -2,7 +2,11 @@
 
 class FastIgnore
   class RuleSet
-    def initialize(rules, allow)
+    attr_reader :gitignore
+    alias_method :gitignore?, :gitignore
+    undef :gitignore
+
+    def initialize(rules, allow, gitignore)
       @dir_rules = squash_rules(rules.reject(&:file_only?)).freeze
       @file_rules = squash_rules(rules.reject(&:dir_only?)).freeze
       @any_not_anchored = rules.any?(&:unanchored?)
@@ -10,8 +14,18 @@ class FastIgnore
 
       @allowed_recursive = { '.' => true }
       @allow = allow
+      @gitignore = gitignore
+
+      freeze unless gitignore?
+    end
 
-      freeze
+    def <<(other)
+      return unless other
+
+      @any_not_anchored ||= other.any_not_anchored
+      @has_shebang_rules ||= other.has_shebang_rules
+      @dir_rules += other.dir_rules
+      @file_rules += other.file_rules
     end
 
     def allowed_recursive?(relative_path, dir, full_path, filename, content = nil)
@@ -47,5 +61,9 @@ class FastIgnore
     def empty?
       @dir_rules.empty? && @file_rules.empty?
     end
+
+    protected
+
+    attr_reader :dir_rules, :file_rules, :any_not_anchored, :has_shebang_rules
   end
 end

data/lib/fast_ignore/rule_set_builder.rb

@@ -27,6 +27,19 @@ class FastIgnore
         ]
       end
 
+      def append_gitignore(rule_sets, project_root:, relative_path:, soft: true)
+        new_gitignore = from_file(relative_path, project_root: project_root, gitignore: true, soft: soft)
+        return unless new_gitignore
+
+        base_gitignore = rule_sets.find(&:gitignore?)
+        if base_gitignore
+          base_gitignore << new_gitignore
+        else
+          rule_sets << new_gitignore
+          prepare(rule_sets)
+        end
+      end
+
       private
 
       def prepare(rule_sets)
@@ -36,12 +49,15 @@ class FastIgnore
         rule_sets
       end
 
-      def from_file(filename, project_root:, allow: false)
+      def from_file(filename, project_root:, allow: false, file_root: nil, gitignore: false, soft: false) # rubocop:disable Metrics/ParameterLists
         filename = ::File.expand_path(filename, project_root)
-        raise FastIgnore::Error, "#{filename} is not within #{project_root}" unless filename.start_with?(project_root)
+        return if soft && !::File.exist?(filename)
+        unless file_root || filename.start_with?(project_root)
+          raise FastIgnore::Error, "#{filename} is not within #{project_root}"
+        end
 
-        file_root = "#{::File.dirname(filename)}/".delete_prefix(project_root)
-        build_rule_set(::File.readlines(filename), allow, file_root: file_root)
+        file_root ||= "#{::File.dirname(filename)}/".delete_prefix(project_root)
+        build_rule_set(::File.readlines(filename), allow, file_root: file_root, gitignore: gitignore)
       end
 
       def from_files(files, project_root:, allow: false)
@@ -51,12 +67,38 @@ class FastIgnore
       end
 
       def from_gitignore_arg(gitignore, project_root:)
-        default_path = ::File.join(project_root, '.gitignore')
-        case gitignore
-        when :auto
-          from_file(default_path, project_root: project_root) if ::File.exist?(default_path)
-        when true
-          from_file(default_path, project_root: project_root)
+        return unless gitignore
+
+        gi = ::FastIgnore::RuleSet.new([], false, true)
+        gi << from_gitignore_file(gitconfig_global_gitignore_path || default_global_gitignore_path)
+        gi << from_gitignore_file(::File.join(project_root, '.git/info/exclude'))
+        gi << from_gitignore_file(::File.join(project_root, '.gitignore'), soft: gitignore == :auto)
+        gi
+      end
+
+      def from_gitignore_file(path, soft: true)
+        return if soft && !::File.exist?(path)
+
+        build_rule_set(::File.readlines(path), false, file_root: '', gitignore: true)
+      end
+
+      def gitconfig_global_gitignore_path
+        config_path = ::File.expand_path('~/.gitconfig')
+        return unless ::File.exist?(config_path)
+
+        ignore_path = ::File.readlines(config_path).find { |l| l.start_with?("\texcludesfile = ") }
+        return unless ignore_path
+
+        ignore_path.delete_prefix!("\texcludesfile = ")
+        ignore_path.strip!
+        ::File.expand_path(ignore_path)
+      end
+
+      def default_global_gitignore_path
+        if ENV['XDG_CONFIG_HOME'] && !ENV['XDG_CONFIG_HOME'].empty?
+          ::File.expand_path('git/ignore', ENV['XDG_CONFIG_HOME'])
+        else
+          ::File.expand_path('~/.config/git/ignore')
         end
       end
 
@@ -72,12 +114,12 @@ class FastIgnore
         build_rule_set(rules, allow, expand_path: expand_path)
       end
 
-      def build_rule_set(rules, allow, expand_path: false, file_root: nil)
+      def build_rule_set(rules, allow, expand_path: false, file_root: nil, gitignore: false)
         rules = rules.flat_map do |rule|
           ::FastIgnore::RuleBuilder.build(rule, allow, expand_path, file_root)
         end
 
-        ::FastIgnore::RuleSet.new(rules, allow).freeze
+        ::FastIgnore::RuleSet.new(rules, allow, gitignore)
       end
     end
   end

data/lib/fast_ignore/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_ignore
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-02 00:00:00.000000000 Z
+date: 2020-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,6 +160,7 @@ files:
 - Rakefile
 - bin/console
 - bin/ls
+- bin/ls_seconds
 - bin/setup
 - bin/time
 - fast_ignore.gemspec