fast_ignore 0.10.2 → 0.14.0

data/lib/fast_ignore/rule_set.rb

@@ -2,38 +2,53 @@
 
 class FastIgnore
   class RuleSet
-    def initialize(rules, allow)
-      @dir_rules = rules.reject(&:file_only?).freeze
-      @file_rules = rules.reject(&:dir_only?).freeze
-      @any_not_anchored = rules.any?(&:unanchored?)
-      @has_shebang_rules = rules.any?(&:shebang)
+    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
+      @has_shebang_rules = rules.any?(&:shebang?)
+
       @allowed_recursive = { '.' => true }
       @allow = allow
+      @gitignore = gitignore
 
-      freeze
+      freeze unless gitignore?
     end
 
-    def freeze
-      @dir_rules.freeze
-      @file_rules.freeze
+    def <<(other)
+      return unless other
 
-      super
+      @has_shebang_rules ||= other.has_shebang_rules
+      @dir_rules = squash_rules(@dir_rules + other.dir_rules)
+      @file_rules = squash_rules(@file_rules + other.file_rules)
     end
 
-    def allowed_recursive?(relative_path, dir, full_path, filename)
+    def allowed_recursive?(relative_path, dir, full_path, filename, content = nil)
       @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)
+          allowed_recursive?(::File.dirname(relative_path), true, nil, nil, nil) &&
+          allowed_unrecursive?(relative_path, dir, full_path, filename, content)
       end
     end
 
-    def allowed_unrecursive?(relative_path, dir, full_path, filename)
+    def allowed_unrecursive?(relative_path, dir, full_path, filename, content)
       (dir ? @dir_rules : @file_rules).reverse_each do |rule|
-        return rule.negation? if rule.match?(relative_path, full_path, filename)
+        return rule.negation? if rule.match?(relative_path, full_path, filename, content)
       end
 
-      (not @allow) || (dir && @any_not_anchored)
+      not @allow
+    end
+
+    def squash_rules(rules)
+      rules.chunk_while { |a, b| a.squashable_type == b.squashable_type }.map do |chunk|
+        first = chunk.first
+        next first if chunk.length == 1
+
+        first.squash(chunk)
+      end
     end
 
     def weight
@@ -43,5 +58,9 @@ class FastIgnore
     def empty?
       @dir_rules.empty? && @file_rules.empty?
     end
+
+    protected
+
+    attr_reader :dir_rules, :file_rules, :has_shebang_rules
   end
 end

data/lib/fast_ignore/rule_sets.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+class FastIgnore
+  class RuleSets
+    # :nocov:
+    using ::FastIgnore::Backports::DeletePrefixSuffix if defined?(::FastIgnore::Backports::DeletePrefixSuffix)
+    # :nocov:
+
+    def initialize( # rubocop:disable Metrics/ParameterLists
+      root:,
+      ignore_rules: nil,
+      ignore_files: nil,
+      gitignore: true,
+      include_rules: nil,
+      include_files: nil,
+      argv_rules: nil
+    )
+      @array = []
+      @project_root = root
+      append_root_gitignore(gitignore)
+      append_set_from_array(ignore_rules)
+      append_set_from_array(include_rules, allow: true)
+      append_set_from_array(argv_rules, allow: true, expand_path_with: @project_root)
+      append_sets_from_files(ignore_files)
+      append_sets_from_files(include_files, allow: true)
+      @array.sort_by!(&:weight)
+      @array.freeze if @gitignore_rule_set
+    end
+
+    def allowed_recursive?(relative_path, full_path, filename, content)
+      @array.all? { |r| r.allowed_recursive?(relative_path, false, full_path, filename, content) }
+    end
+
+    def allowed_unrecursive?(relative_path, dir, full_path, filename)
+      @array.all? { |r| r.allowed_unrecursive?(relative_path, dir, full_path, filename, nil) }
+    end
+
+    def append_subdir_gitignore(relative_path:, check_exists: true)
+      new_gitignore = build_set_from_file(relative_path, gitignore: true, check_exists: check_exists)
+      return if !new_gitignore || new_gitignore.empty?
+
+      if @gitignore_rule_set
+        @gitignore_rule_set << new_gitignore
+      else
+        @array << new_gitignore
+        @gitignore_rule_set = new_gitignore
+        @array.sort_by!(&:weight) && @array.freeze
+      end
+      new_gitignore
+    end
+
+    private
+
+    def append_and_return_if_present(value)
+      return unless value && !value.empty?
+
+      @array << value
+      value
+    end
+
+    def append_root_gitignore(gitignore)
+      return @gitignore_rule_set = nil unless gitignore
+
+      append_set_from_array('.git')
+      gi = ::FastIgnore::RuleSet.new([], false, true)
+      gi << build_from_root_gitignore_file(::FastIgnore::GlobalGitignore.path(root: @project_root))
+      gi << build_from_root_gitignore_file("#{@project_root}.git/info/exclude")
+      gi << build_from_root_gitignore_file("#{@project_root}.gitignore")
+      @gitignore_rule_set = append_and_return_if_present(gi)
+    end
+
+    def build_from_root_gitignore_file(path)
+      return unless ::File.exist?(path)
+
+      build_rule_set(::File.readlines(path), false, gitignore: true)
+    end
+
+    def build_rule_set(rules, allow, expand_path_with: nil, file_root: nil, gitignore: false)
+      rules = rules.flat_map do |rule|
+        ::FastIgnore::RuleBuilder.build(rule, allow, expand_path_with, file_root)
+      end
+
+      ::FastIgnore::RuleSet.new(rules, allow, gitignore)
+    end
+
+    def build_set_from_file(filename, allow: false, file_root: nil, gitignore: false, check_exists: false)
+      filename = ::File.expand_path(filename, @project_root)
+      return if check_exists && !::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, gitignore: gitignore)
+    end
+
+    def append_sets_from_files(files, allow: false)
+      Array(files).each do |file|
+        append_and_return_if_present(build_set_from_file(file, allow: allow))
+      end
+    end
+
+    def append_set_from_array(rules, allow: false, expand_path_with: nil)
+      return unless rules
+
+      rules = Array(rules).flat_map { |string| string.to_s.lines }
+      return if rules.empty?
+
+      append_and_return_if_present(build_rule_set(rules, allow, expand_path_with: expand_path_with))
+    end
+  end
+end

data/lib/fast_ignore/shebang_rule.rb

@@ -6,12 +6,20 @@ class FastIgnore
     alias_method :negation?, :negation
     undef :negation
 
-    attr_reader :shebang
+    attr_reader :rule
 
-    def initialize(shebang, negation)
-      @shebang = shebang
+    attr_reader :squashable_type
+
+    def squash(rules)
+      ::FastIgnore::ShebangRule.new(::Regexp.union(rules.map(&:rule)).freeze, negation?)
+    end
+
+    def initialize(rule, negation)
+      @rule = rule
       @negation = negation
 
+      @squashable_type = negation ? 3 : 2
+
       freeze
     end
 
@@ -23,28 +31,36 @@ class FastIgnore
       false
     end
 
-    def unanchored?
-      true
-    end
-
     # :nocov:
     def inspect
-      "#<ShebangRule #{'allow ' if @negation}#!:#{@shebang.to_s[15..-4]}>"
+      "#<ShebangRule #{'allow ' if @negation}#!:#{@rule.to_s[15..-4]}>"
     end
     # :nocov:
 
-    def match?(_, full_path, filename)
+    def match?(_, full_path, filename, content)
       return false if filename.include?('.')
 
-      first_line(full_path)&.match?(@shebang)
+      (content || first_line(full_path))&.match?(@rule)
+    end
+
+    def shebang?
+      true
     end
 
     private
 
-    def first_line(path)
+    def first_line(path) # rubocop:disable Metrics/MethodLength
       file = ::File.new(path)
-      first_line = file.sysread(25)
-      first_line += file.sysread(50) until first_line.include?("\n")
+      first_line = new_fragment = file.sysread(64)
+      if first_line.start_with?('#!')
+        until new_fragment.include?("\n")
+          new_fragment = file.sysread(64)
+          first_line += new_fragment
+        end
+      else
+        file.close
+        return
+      end
       file.close
       first_line
     rescue ::EOFError, ::SystemCallError

data/lib/fast_ignore/unmatchable_rule.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class FastIgnore
+  class UnmatchableRule
+    class << self
+      def squash(_)
+        self
+      end
+
+      def squashable_type
+        5
+      end
+
+      def dir_only?
+        false
+      end
+
+      def file_only?
+        false
+      end
+
+      def shebang?
+        false
+      end
+
+      # :nocov:
+      def inspect
+        '#<UnmatchableRule>'
+      end
+      # :nocov:
+
+      def match?(_, _, _, _)
+        false
+      end
+    end
+  end
+end

data/lib/fast_ignore/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_ignore
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.14.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-26 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,35 +143,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".leftovers.yml"
-- ".rspec"
-- ".rubocop.yml"
-- ".simplecov"
-- ".spellr.yml"
-- ".spellr_wordlists/english.txt"
-- ".spellr_wordlists/ruby.txt"
-- ".spellr_wordlists/shell.txt"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/ls
-- bin/setup
-- bin/time
-- fast_ignore.gemspec
 - lib/fast_ignore.rb
 - lib/fast_ignore/backports.rb
-- lib/fast_ignore/backports/delete_prefix_suffix.rb
-- lib/fast_ignore/backports/dir_each_child.rb
+- lib/fast_ignore/gitignore_rule_builder.rb
+- lib/fast_ignore/global_gitignore.rb
 - lib/fast_ignore/rule.rb
 - lib/fast_ignore/rule_builder.rb
 - lib/fast_ignore/rule_set.rb
-- lib/fast_ignore/rule_set_builder.rb
+- lib/fast_ignore/rule_sets.rb
 - lib/fast_ignore/shebang_rule.rb
+- lib/fast_ignore/unmatchable_rule.rb
 - lib/fast_ignore/version.rb
 homepage: https://github.com/robotdana/fast_ignore
 licenses:

data/.gitignore

@@ -1,6 +0,0 @@
-/.bundle/
-/coverage/
-/pkg/
-.rspec_status
-*.gem
-Gemfile.lock

data/.leftovers.yml

@@ -1,5 +0,0 @@
-exclude_paths:
-  - vendor
-rules:
-  - names: allowed? # public api
-    skip: true

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,216 +0,0 @@
-require: rubocop-rspec
-
-# Reference:
-# https://rubocop.readthedocs.io/en/latest/
-
-# Keep this in alphabetical order.
-# Each override should have a comment (even if it's just "default is bad")
-
-AllCops:
-  NewCops: enable
-  Exclude:
-    - db/schema*
-    - .bundle/**/*
-    - tmp/**/*
-    - vendor/**/*
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  TargetRubyVersion: 2.4
-
-# all of our layout customisations are because we prefer indentation to be
-# always consistently 2 spaces, for blocks, scopes, multiline expressions, etc
-# e.g.
-# class Klass
-#   def method(arg1,
-#     arg2)
-#     value = if arg1 == 'value' && arg2 == 'value'
-#       method2
-#         .method(arg_a, arg_b,
-#           arg_c, arg_d, keyword1: true,
-#           keyword2: true) do
-#             @last = [
-#               arg_a, arg_b,
-#               arg_c, arg_d
-#             ]
-#           end
-#     end
-#     value
-#   end
-# end
-
-# to match our preference for consistent indentation
-Layout/HashAlignment:
-  EnforcedLastArgumentHashStyle: always_ignore
-
-# to match our preference for consistent indentation
-Layout/ParameterAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-# to match our preference for consistent indentation
-Layout/BlockAlignment:
-  EnforcedStyleAlignWith: start_of_block
-
-# to match our preference for consistent indentation
-Layout/CaseIndentation:
-  EnforcedStyle: end
-
-# to match our preference for consistent indentation
-Layout/EndAlignment:
-  EnforcedStyleAlignWith: start_of_line
-
-# Aligning Assignments, etc makes diffs noisy
-Layout/ExtraSpacing:
-  AllowForAlignment: false
-
-# to match our preference for consistent indentation
-Layout/FirstArrayElementLineBreak:
-  Enabled: true
-
-# to match our preference for consistent indentation
-Layout/FirstHashElementLineBreak:
-  Enabled: true
-
-# to match our preference for consistent indentation
-Layout/FirstArgumentIndentation:
-  EnforcedStyle: consistent
-
-# to match our preference for consistent indentation
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-
-# to match our preference for consistent indentation
-Layout/FirstHashElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/LineLength:
-  Max: 120
-
-# to match our preference for consistent indentation
-# and hanging assignment looks lost
-Layout/MultilineAssignmentLayout:
-  EnforcedStyle: same_line
-
-# this changes our preferred:
-#   value = if thing1 &&
-#     thing2
-# to:
-#   value = if thing1 &&
-#       thing2
-# even though the IndentationWidth is 2
-# but it's right most of the time so I put up with it
-Layout/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-# Temporarily disable this spec as a recent change has broken it for us:
-# https://github.com/rubocop-hq/rubocop/issues/6254
-Layout/RescueEnsureAlignment:
-  Enabled: false
-
-Metrics:
-  CountComments: false
-
-Metrics/BlockLength:
-  ExcludedMethods:
-    - configure
-    - describe
-    - context
-    - shared_examples
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-RSpec:
-  Enabled: true
-  Include:
-    - 'spec/**/*.rb'
-
-RSpec/DescribeClass:
-  Enabled: false
-
-# I misuse matchers often
-RSpec/ExpectActual:
-  Enabled: false
-
-RSpec/FilePath:
-  Enabled: false
-
-# Multiple expectations are useful
-# checking you've partially achieved something on the way to completely achieving it is useful for debugging failures
-RSpec/MultipleExpectations:
-  Enabled: false
-
-# It should be obvious from context. Chill out rubocop
-RSpec/NamedSubject:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Max: 7
-
-# This matches the style we've been using all along (ever so slightly more frequently)
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/CollectionMethods:
-  Enabled: true
-
-# we don't rdoc
-Style/Documentation:
-  Enabled: false
-
-# this can mess with the balance of symmetric cases
-Style/IfInsideElse:
-  Enabled: false
-
-# [a, b].include?(x) is more unclear than a == x || b == x
-Style/MultipleComparison:
-  Enabled: false
-
-# it's microscopically faster
-Style/Not:
-  Enabled: false
-
-# we use %w{} pretty frequently
-Style/PercentLiteralDelimiters:
-  PreferredDelimiters:
-    default: '{}'
-    '%w': '{}'
-    '%W': '{}'
-    '%i': '{}'
-    '%I': '{}'
-    '%r': '{}'
-
-# We want this to warn to force consistency within the codebase.
-Style/SafeNavigation:
-  Enabled: true
-
-# different methods calls that do exactly the same thing are a smell, regardless of semantics
-Style/SignalException:
-  EnforcedStyle: only_raise
-
-# this wants less descriptive names
-Style/SingleLineBlockParams:
-  Enabled: false
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/WordArray:
-  Enabled: false
-
-Style/HashEachMethods:
-  Enabled: true
-
-Style/HashTransformKeys:
-  Enabled: true
-
-Style/HashTransformValues:
-  Enabled: true
-
-Style/CommentedKeyword:
-  Enabled: false