fast_ignore 0.15.2 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9992ae13ee95ee05f55cceda56e5bd1c4210d5817be17d9116193787ac658d38
-  data.tar.gz: '093e221a737476e92c0c6cf1b6632abb4da103ea01ee3d0f66acf067011f092c'
+  metadata.gz: 88d6249cc842976d1b5c0e984816cfc260cc3edcbe4774ea4580e934bedcf925
+  data.tar.gz: 3ab13efc019bee9b5cadcb45f485021132f07787bce73d66bb9ef63b76bc51ca
 SHA512:
-  metadata.gz: 78db62b2bfa57b7b509b6f326f3b4f3f7371336bf30caa46c2d1b3ccc4086e2bbdb7abf3cc843700d4a93ff82f368a829e0c05da0ceae52f0e8ab2af4eaa32bd
-  data.tar.gz: c0df1d280a71bb7140076d39774a96728f2a1c8e29b756216211467a05eb93f7a3001c4472dc47155d0b57ec40d4d65f83c0f4f813014c01f55f7b9e03ffac67
+  metadata.gz: 853124ae1ddf1fc599e8a422580ee84ff705907a70c7ece17db72502a4468ca0d5479f918c175f91dc1915c7cccb5ad4cd7eaa956adf2d7b0a5e2fa024821c3d
+  data.tar.gz: b90c827caa6c24c3491237ec5fb538b828b2daea879a4d94d6bc3ac4368807c7040bc0d6ea6405b8e9712483d00fddfb6d43e1a970786f374144a4d6165f59ee

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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
 

data/README.md

@@ -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-3.0.0.preview1 & 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))

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/global_gitignore.rb

@@ -15,13 +15,13 @@ class FastIgnore
 
       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

data/lib/fast_ignore/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class FastIgnore
-  VERSION = '0.15.2'
+  VERSION = '0.16.0'
 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:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_ignore
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.16.0
 platform: ruby
 authors:
 - Dana Sherson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.93.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -94,6 +97,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.93.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +128,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 +156,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.3
-description: 
+description:
 email:
 - robot@dana.sh
 executables: []
@@ -149,6 +169,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
@@ -168,7 +189,7 @@ 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/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,8 +204,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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: []