fast_ignore 0.15.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f96030c8670a5d709139689212b3a78a0eb0b5266cbd0057954863ae89e11745
-  data.tar.gz: a2815ec68f6c367a4450efce8799aa359adeee1ad1aaa971b589cd8612ddbb61
+  metadata.gz: 7952045a743c12fa1963ffba7aa81a8ca3cc81aec40b0bfc9c0e6bb6424e9433
+  data.tar.gz: dcacd0bdd1873638156c9b2323263cf1ee7fc349b012f40c28caa4fe10d82f91
 SHA512:
-  metadata.gz: 5c22c6c79a6605473156a041d5ddb5b81f943605dc4360dd8577acd56718c928c106e044169b13bc73c7e884ffcc5516c7a6b5d6134fee9aaa4aa73d0178b791
-  data.tar.gz: 1d165e44b50d9b1c301c5cad8ff3c443bfb2f9134be09e28a4e90539c960a269083485f6ff30bc6df6e2ec82347630187ebf0082cd2d06ba7416e9c70f37ea6f
+  metadata.gz: 35c9fedb895b3e30632b29aab2eba3369ec6512bd6c5b9cfa563156c4c0c291b5c7854877aa4c8da063b54ed97a6f132c5d903622d2a6e2fc69c57c708150c33
+  data.tar.gz: ca894c9a8e11471d3c1f81f959862cd16a60db784898ef0d0e4da880e063257334fdf6aad061d95c23850c726ffde781076e6c248ebecfa808701d0731fbb125

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# v0.16.1
+- respect GIT_CONFIG_SYSTEM, GIT_CONFIG_NOSYSTEM and GIT_CONFIG_GLOBAL env vars the same way git does
+- make the tests more resilient to whatever global config is going on.
+
+# v0.16.0
+- Entirely rewrite the way that git config files are read. previously it was just a regexp. now we actually parse git config files according to the same rules as git.
+- Add ruby 3 to the test matrix
+
+# v0.15.2
+- Updated methods with multiple `_` arguments to have different names to make sorbet happy
+
+# v0.15.1
+- Updated dependencies to allow running on ruby 3.0.0.preview1
+
 # v0.15.0
 - fixed a handful of character class edge cases to match git behavior
   - mostly ranges with - or / as one end of the range

data/README.md

@@ -1,6 +1,6 @@
 # FastIgnore
 
-[![travis](https://travis-ci.com/robotdana/fast_ignore.svg?branch=master)](https://travis-ci.com/robotdana/fast_ignore)
+[![travis](https://travis-ci.com/robotdana/fast_ignore.svg?branch=main)](https://travis-ci.com/robotdana/fast_ignore)
 [![Gem Version](https://badge.fury.io/rb/fast_ignore.svg)](https://rubygems.org/gems/fast_ignore)
 
 This started as a way to quickly and natively ruby-ly parse gitignore files and find matching files.
@@ -15,7 +15,7 @@ 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 & jruby
+- Supports ruby 2.4-3.0.x & jruby
 - supports all [gitignore rule patterns](https://git-scm.com/docs/gitignore#_pattern_format)
 - doesn't require git to be installed
 - supports a gitignore-esque "include" patterns. ([`include_rules:`](#include_rules)/[`include_files:`](#include_files))
@@ -309,6 +309,7 @@ This is not required, and if FastIgnore does have to go to the filesystem for th
   (It does handle changing the current working directory between [`FastIgnore#allowed?`](#allowed) calls)
 - FastIgnore always matches patterns case-insensitively. (git varies by filesystem).
 - FastIgnore always outputs paths as literal UTF-8 characters. (git depends on your core.quotepath setting but by default outputs non ascii paths with octal escapes surrounded by quotes).
+- git has a system-wide config file installed at `$(prefix)/etc/gitconfig`, where `prefix` is defined for git at install time. FastIgnore assumes that it will always be `/usr/local/etc/gitconfig`. if it's important your system config file is looked at, as that's where you have the core.excludesfile defined, use git's built-in way to override this by adding `export GIT_CONFIG_SYSTEM='/the/actual/location'` to your shell profile.
 - Because git looks at its own index objects and FastIgnore looks at the file system there may be some differences between FastIgnore and `git ls-files`. To avoid these differences you may want to use the [`git_ls`](https://github.com/robotdana/git_ls) gem instead
   - Tracked files that were committed before the matching ignore rule was committed will be returned by `git ls-files`, but not by FastIgnore.
   - Untracked files will be returned by FastIgnore, but not by `git ls-files`

data/lib/fast_ignore/gitconfig_parser.rb

@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require 'strscan'
+class FastIgnore
+  class GitconfigParseError < FastIgnore::Error; end
+
+  class GitconfigParser # rubocop:disable Metrics/ClassLength
+    def self.parse(file, root: Dir.pwd, nesting: 1)
+      new(file, root: root, nesting: nesting).parse
+    end
+
+    def initialize(path, root: Dir.pwd, nesting: 1)
+      @path = path
+      @root = root
+      @nesting = nesting
+    end
+
+    def parse
+      raise ::FastIgnore::GitconfigParseError if nesting >= 10
+
+      read_file(path)
+      return unless value
+
+      value
+    end
+
+    private
+
+    attr_reader :nesting
+    attr_reader :path
+    attr_reader :root
+    attr_accessor :value
+    attr_accessor :within_quotes
+    attr_accessor :section
+
+    def read_file(path) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      return unless ::File.readable?(path)
+
+      file = StringScanner.new(::File.read(path))
+
+      until file.eos?
+        if file.skip(/(\s+|[#;].*\n)/)
+          # skip
+        elsif file.skip(/\[core\]/i)
+          self.section = :core
+        elsif file.skip(/\[include\]/i)
+          self.section = :include
+        elsif file.skip(/\[(?i:includeif) +"/)
+          self.section = include_if(file) ? :include : :not_include
+        elsif file.skip(/\[[\w.]+( "([^\0\\"]|\\(\\{2})*"|\\{2}*)+")?\]/)
+          self.section = :other
+        elsif section == :core && file.skip(/excludesfile\s*=(\s|\\\n)*/i)
+          self.value = scan_value(file)
+        elsif section == :include && file.skip(/path\s*=(\s|\\\n)*/)
+          include_path = scan_value(file)
+
+          value = ::FastIgnore::GitconfigParser.parse(
+            ::File.expand_path(include_path, ::File.dirname(path)),
+            root: root,
+            nesting: nesting + 1
+          )
+          self.value = value if value
+          self.section = :include
+        elsif file.skip(/[a-zA-Z0-9]\w*\s*([#;].*)?\n/)
+          nil
+        elsif file.skip(/[a-zA-Z0-9]\w*\s*=(\s|\\\n)*/)
+          skip_value(file)
+        else
+          raise ::FastIgnore::GitconfigParseError
+        end
+      end
+    end
+
+    def scan_condition_value(file)
+      if file.scan(/([^\0\\\n"]|\\(\\{2})*"|\\{2}*)+(?="\])/)
+        value = file.matched
+        file.skip(/"\]/)
+        value
+      else
+        raise ::FastIgnore::GitconfigParseError
+      end
+    end
+
+    def skip_condition_value(file)
+      raise ::FastIgnore::GitconfigParseError unless file.skip(/([^\0\\\n"]|\\(\\{2})*"|\\{2}*)+"\]/)
+    end
+
+    def include_if(file)
+      if file.skip(/onbranch:/)
+        on_branch?(scan_condition_value(file))
+      elsif file.skip(/gitdir:/)
+        gitdir?(scan_condition_value(file), path: path)
+      elsif file.skip(%r{gitdir/i:})
+        gitdir?(scan_condition_value(file), case_insensitive: true, path: path)
+      else
+        skip_condition_value(file)
+        false
+      end
+    end
+
+    def on_branch?(branch_pattern)
+      branch_pattern += '**' if branch_pattern.end_with?('/')
+      current_branch = ::File.readable?("#{root}/.git/HEAD") && ::File.read("#{root}/.git/HEAD").sub!(
+        %r{\Aref: refs/heads/}, ''
+      )
+      return unless current_branch
+
+      # goddamit git what does 'a pattern with standard globbing wildcards' mean
+      ::File.fnmatch(branch_pattern, current_branch, ::File::FNM_PATHNAME | ::File::FNM_DOTMATCH)
+    end
+
+    def gitdir?(gitdir, path:, case_insensitive: false)
+      gitdir += '**' if gitdir.end_with?('/')
+      gitdir.sub!(%r{\A~/}, ENV['HOME'] + '/')
+      gitdir.sub!(/\A\./, path + '/')
+      gitdir = "**/#{gitdir}" unless gitdir.start_with?('/')
+      options = ::File::FNM_PATHNAME | ::File::FNM_DOTMATCH
+      options |= ::File::FNM_CASEFOLD if case_insensitive
+      ::File.fnmatch(gitdir, ::File.join(root, '.git'), options)
+    end
+
+    def scan_value(file) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      value = +''
+      until file.eos?
+        if file.skip(/\\\n/)
+          # continue
+        elsif file.skip(/\\\\/)
+          value << '\\'
+        elsif file.skip(/\\n/)
+          value << "\n"
+        elsif file.skip(/\\t/)
+          value << "\t"
+        elsif file.skip(/\\b/)
+          value.chop!
+        elsif file.skip(/\\"/)
+          value << '"'
+        elsif file.skip(/\\/)
+          raise ::FastIgnore::GitconfigParseError
+        elsif within_quotes
+          if file.skip(/"/)
+            self.within_quotes = false
+          elsif file.scan(/[^"\\\n]+/)
+            value << file.matched
+          elsif file.skip(/\n/)
+            raise ::FastIgnore::GitconfigParseError
+          # :nocov:
+          else
+            raise "Unmatched #{file.rest}"
+            # :nocov:
+          end
+        elsif file.skip(/"/)
+          self.within_quotes = true
+        elsif file.scan(/[^;#"\s\\]+/)
+          value << file.matched
+        elsif file.skip(/\s*[;#\n]/)
+          break
+        elsif file.scan(/\s+/) # rubocop:disable Lint/DuplicateBranch
+          value << file.matched
+        # :nocov:
+        else
+          raise "Unmatched #{file.rest}"
+          # :nocov:
+        end
+      end
+
+      raise ::FastIgnore::GitconfigParseError if within_quotes
+
+      value
+    end
+
+    def skip_value(file) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      until file.eos?
+        if file.skip(/\\(?:\n|\\|n|t|b|")/)
+          nil
+        elsif file.skip(/\\/)
+          raise ::FastIgnore::GitconfigParseError
+        elsif within_quotes
+          if file.skip(/"/)
+            self.within_quotes = false
+          elsif file.skip(/[^"\\\n]+/)
+            nil
+          elsif file.scan(/\n/)
+            raise ::FastIgnore::GitconfigParseError
+          # :nocov:
+          else
+            raise "Unmatched #{file.rest}"
+            # :nocov:
+          end
+        elsif file.skip(/"/)
+          self.within_quotes = true
+        elsif file.skip(/[^;#"\s\\]+/) # rubocop:disable Lint/DuplicateBranch
+          nil
+        elsif file.skip(/\s*[;#\n]/)
+          break
+        elsif file.skip(/\s+/) # rubocop:disable Lint/DuplicateBranch
+          nil
+        # :nocov:
+        else
+          raise "Unmatched #{file.rest}"
+          # :nocov:
+        end
+      end
+
+      raise ::FastIgnore::GitconfigParseError if within_quotes
+    end
+  end
+end

data/lib/fast_ignore/gitignore_rule_builder.rb

@@ -100,7 +100,7 @@ class FastIgnore
       end
     end
 
-    def process_character_class # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def process_character_class # rubocop:disable Metrics/MethodLength
       return unless @s.character_class_start?
 
       @re.append_character_class_open

data/lib/fast_ignore/global_gitignore.rb

@@ -4,46 +4,84 @@ class FastIgnore
   module GlobalGitignore
     class << self
       def path(root:)
-        gitconfig_gitignore_path(::File.expand_path('.git/config', root)) ||
-          gitconfig_gitignore_path(::File.expand_path('~/.gitconfig')) ||
-          gitconfig_gitignore_path(xdg_config_path) ||
-          gitconfig_gitignore_path('/etc/gitconfig') ||
+        ignore_path = gitconfigs_gitignore_path(root) ||
           default_global_gitignore_path
+
+        ignore_path unless ignore_path.empty?
       end
 
       private
 
+      def gitconfigs_gitignore_path(root)
+        gitconfig_gitignore_path(repo_config_path(root)) ||
+          gitconfig_gitignore_path(global_config_path) ||
+          gitconfig_gitignore_path(default_user_config_path) ||
+          gitconfig_gitignore_path(system_config_path)
+      rescue ::FastIgnore::GitconfigParseError
+        ''
+      end
+
       def gitconfig_gitignore_path(config_path)
         return unless config_path
-        return unless ::File.exist?(config_path)
+        return unless ::File.readable?(config_path)
 
-        ignore_path = ::File.readlines(config_path).find { |l| l.sub!(/\A\s*excludesfile\s*=/, '') }
+        ignore_path = ::FastIgnore::GitconfigParser.parse(config_path)
         return unless ignore_path
 
         ignore_path.strip!
-        return ignore_path if ignore_path.empty? # don't expand path in this case
+        return '' if ignore_path.empty? # don't expand path in this case
 
         ::File.expand_path(ignore_path)
       end
 
-      def xdg_config_path
-        xdg_config_home? && ::File.expand_path('git/config', xdg_config_home)
+      def default_user_config_path
+        return if env('GIT_CONFIG_GLOBAL')
+
+        ::File.expand_path('git/config', default_config_home)
       end
 
       def default_global_gitignore_path
-        if xdg_config_home?
-          ::File.expand_path('git/ignore', xdg_config_home)
+        ::File.expand_path('git/ignore', default_config_home)
+      end
+
+      def repo_config_path(root)
+        ::File.expand_path('.git/config', root)
+      end
+
+      def global_config_path
+        ::File.expand_path(env('GIT_CONFIG_GLOBAL', '~/.gitconfig'))
+      end
+
+      def system_config_path
+        return if env?('GIT_CONFIG_NOSYSTEM')
+
+        ::File.expand_path(env('GIT_CONFIG_SYSTEM', '/usr/local/etc/gitconfig'))
+      end
+
+      def default_config_home
+        env('XDG_CONFIG_HOME', '~/.config')
+      end
+
+      def env(env_var, default = nil)
+        value = ::ENV[env_var]
+
+        if value && (not value.empty?)
+          value
         else
-          ::File.expand_path('~/.config/git/ignore')
+          default
         end
       end
 
-      def xdg_config_home
-        ::ENV['XDG_CONFIG_HOME']
-      end
+      def env?(env_var)
+        value = ::ENV[env_var]
 
-      def xdg_config_home?
-        xdg_config_home && (not xdg_config_home.empty?)
+        if value&.match?(/\A(yes|on|true|1)\z/i)
+          true
+        elsif !value || value.match?(/\A(no|off|false|0|)\z/i)
+          false
+        else
+          raise ::FastIgnore::GitconfigParseError
+        end
       end
     end
   end

data/lib/fast_ignore/rule.rb

@@ -58,7 +58,7 @@ class FastIgnore
     end
     # :nocov:
 
-    def match?(relative_path, _, _, _)
+    def match?(relative_path, _full_path, _filename, _content)
       @rule.match?(relative_path)
     end
   end

data/lib/fast_ignore/rule_sets.rb

@@ -73,7 +73,7 @@ class FastIgnore
     end
 
     def build_from_root_gitignore_file(path)
-      return unless ::File.exist?(path)
+      return unless path && ::File.exist?(path)
 
       build_rule_set(::File.readlines(path), false, gitignore: true)
     end

data/lib/fast_ignore/shebang_rule.rb

@@ -46,9 +46,9 @@ class FastIgnore
     end
     # :nocov:
 
-    def match?(path, full_path, filename, content)
+    def match?(relative_path, full_path, filename, content)
       return false if filename.include?('.')
-      return false unless (not @file_path_pattern) || @file_path_pattern.match?(path)
+      return false unless (not @file_path_pattern) || @file_path_pattern.match?(relative_path)
 
       (content || first_line(full_path))&.match?(@rule)
     end

data/lib/fast_ignore/unmatchable_rule.rb

@@ -33,7 +33,7 @@ class FastIgnore
       end
       # :nocov:
 
-      def match?(_, _, _, _)
+      def match?(_relative_path, _full_path, _filename, _content)
         false
       end
     end

data/lib/fast_ignore/version.rb

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

data/lib/fast_ignore.rb

@@ -4,22 +4,24 @@ require_relative './fast_ignore/backports'
 
 require 'set'
 require 'strscan'
-require_relative './fast_ignore/rule_sets'
-require_relative './fast_ignore/rule_set'
-require_relative './fast_ignore/global_gitignore'
-require_relative './fast_ignore/rule_builder'
-require_relative './fast_ignore/gitignore_rule_builder'
-require_relative './fast_ignore/gitignore_include_rule_builder'
-require_relative './fast_ignore/gitignore_rule_regexp_builder'
-require_relative './fast_ignore/gitignore_rule_scanner'
-require_relative './fast_ignore/file_root'
-require_relative './fast_ignore/rule'
-require_relative './fast_ignore/unmatchable_rule'
-require_relative './fast_ignore/shebang_rule'
 
 class FastIgnore
   class Error < StandardError; end
 
+  require_relative './fast_ignore/rule_sets'
+  require_relative './fast_ignore/rule_set'
+  require_relative './fast_ignore/global_gitignore'
+  require_relative './fast_ignore/rule_builder'
+  require_relative './fast_ignore/gitignore_rule_builder'
+  require_relative './fast_ignore/gitignore_include_rule_builder'
+  require_relative './fast_ignore/gitignore_rule_regexp_builder'
+  require_relative './fast_ignore/gitignore_rule_scanner'
+  require_relative './fast_ignore/file_root'
+  require_relative './fast_ignore/rule'
+  require_relative './fast_ignore/unmatchable_rule'
+  require_relative './fast_ignore/shebang_rule'
+  require_relative './fast_ignore/gitconfig_parser'
+
   include ::Enumerable
 
   # :nocov:
@@ -86,7 +88,7 @@ class FastIgnore
     @loaded_gitignore_files << parent_path
   end
 
-  def each_recursive(parent_full_path, parent_relative_path, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+  def each_recursive(parent_full_path, parent_relative_path, &block) # rubocop:disable Metrics/MethodLength
     children = ::Dir.children(parent_full_path)
     load_gitignore(parent_relative_path, check_exists: false) if @gitignore_enabled && children.include?('.gitignore')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_ignore
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.1
 platform: ruby
 authors:
 - Dana Sherson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-18 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +86,48 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 0.93.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 0.93.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.44.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 1.44.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +142,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.5
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  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
   name: spellr
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +170,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.3
-description: 
+description:
 email:
 - robot@dana.sh
 executables: []
@@ -149,6 +183,7 @@ files:
 - lib/fast_ignore.rb
 - lib/fast_ignore/backports.rb
 - lib/fast_ignore/file_root.rb
+- lib/fast_ignore/gitconfig_parser.rb
 - lib/fast_ignore/gitignore_include_rule_builder.rb
 - lib/fast_ignore/gitignore_rule_builder.rb
 - lib/fast_ignore/gitignore_rule_regexp_builder.rb
@@ -167,24 +202,24 @@ licenses:
 metadata:
   homepage_uri: https://github.com/robotdana/fast_ignore
   source_code_uri: https://github.com/robotdana/fast_ignore
-  changelog_uri: https://github.com/robotdana/fast_ignore/blob/master/CHANGELOG.md
-post_install_message: 
+  changelog_uri: https://github.com/robotdana/fast_ignore/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Parse gitignore files, quickly
 test_files: []