fast_ignore 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6ccc7e9492f4e3b32cca4bbf1a758df089bfb1f3ae0f9a1f869b4aee8ce0666
-  data.tar.gz: fb760076616b071c946750ba77016e147c593fd9fc830eef4cb498cccbad6042
+  metadata.gz: a4c51ea85828e7c8659e7e67c6b4f72a577e463439412da55842d2ccdc8cb2be
+  data.tar.gz: c9cfdfcfa66b2df5b927ce0a53f094cf72c1a9db33f09cf992e7d1337fc9a37a
 SHA512:
-  metadata.gz: 1a96702300507bf80cc670011226ac905395e38115bf437ef8a6a46d13dea655022f9ea80e3ff02b206e12c3f8d2a9f3b174c8f29e3f8da6a2423d003c19c380
-  data.tar.gz: 56c3ce89f07434317bd45123a8dff81d66c1bf55652b0531ac4f17a96e3fd4428d1410b1a67a9a75573201c7f5ea30d7c0a543ae15a536df1f05883fd037ff5b
+  metadata.gz: f25671f6eff33fdd7a56cdda01941413b0de30fa35eca7aee5f495414335fb5b48eff2ed67c19a7c2638483c7e7ba10069e42e41ae099da577af9772b3c66680
+  data.tar.gz: 6b64940f041f0ce7edeb913ea01d030f92925fdae4ad454e4ca84ccd373e02779ac2b234d2645a9bab823547a9775c1f41547001077557c90fa33d83b5dc7a0c

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# v0.2.0
+- Considers rules relative to the location of the gitignore file instead of just relative to PWD
+- Can override the path to the gitignore file, using `FastIgnore.new(gitignore: path)`
+- Mention FastIgnore#allowed? in the documentation.
+
+# v0.1.0
+Initial Release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fast_ignore (0.1.0)
+    fast_ignore (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -52,11 +52,11 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.17)
   fast_ignore!
-  pry
+  pry (~> 0)
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop
-  rubocop-rspec
+  rubocop (~> 0)
+  rubocop-rspec (~> 1)
 
 BUNDLED WITH
    1.17.1

data/README.md

@@ -38,29 +38,39 @@ FastIgnore.new(relative: true).to_a
 
 You can specify other gitignore-style files to ignore as well. These rules will be appended after the gitignore file in order (order matters for negations)
 ```ruby
-FastIgnore.new(files: '/path/to/my/ignore/file').to_a
-FastIgnore.new(files: ['/path/to/my/ignore/file', '/and/another']).to_a
+FastIgnore.new(files: '/absolute/path/to/my/ignore/file').to_a
+FastIgnore.new(files: ['/absolute/path/to/my/ignore/file', '/and/another']).to_a
 ```
-
 You can also supply an array of rule lines. These rules will be appended after the gitignore and any other files in order (order matters for negations)
 ```ruby
 FastIgnore.new(rules: '.DS_Store').to_a
 FastIgnore.new(rules: ['.git', '.gitkeep']).to_a
 ```
 
-By default, FastIgnore will look in the directory the script is run in (PWD) for a gitignore file. If it's somewhere else,
+To only use another ignore file or set of rules, and not try to load a gitignore file:
+```ruby
+FastIgnore.new(files: 'absolute/path/to/my/ignore/file', gitignore: false)
+FastIgnore.new(rules: %w{my*rule /and/another !rule}, gitignore: false)
+```
+
+By default, FastIgnore will look in the directory the script is run in (PWD) for a gitignore file. If it's somewhere else:
 ```ruby
-FastIgnore.new(rules: '.git', files: '/path/to/.gitignore', gitignore: false).to_a
-FastIgnore.new(rules: '.git', files: ['/path/to/.gitignore', '/path/to/other/excludesfile'], gitignore: false).to_a
+FastIgnore.new(gitignore: '/absolute/path/to/.gitignore').to_a
+```
+Note that the location of the .gitignore file will affect things like rules beginning with `/` or ending in `/**`
+
+To check if a single file is allowed, use
+```ruby
+FastIgnore.new.allowed?('/absolute/path/to/file')
 ```
-(You need the rules: '.git' because we're excluding the normal gitignore file)
 
 ## Known issues/TODOs
-- Considers rules relative to the location of the gitignore file, to always be relative to PWD instead
-- Can't override path to gitignore file nicley, Ideally it would be `FastIgnore.new(gitignore: path)`
 - Doesn't take into account ignored project excludes in `.git/info/exclude`
 - Doesn't take into account globally ignored files in `git config core.excludesFile`
-
+  This is probably a wontfix, as you need git to read the config, and may as well just
+  ```ruby
+  `git ls-files`.split("\n")
+  ```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/fast_ignore.gemspec

@@ -10,14 +10,14 @@ Gem::Specification.new do |spec|
   spec.authors = ['Dana Sherson']
   spec.email = ['robot@dana.sh']
 
-  spec.summary = 'Parse gitignore files'
+  spec.summary = 'Parse gitignore files, quickly'
   spec.homepage = 'https://github.com/robotdana/fast_ignore'
   spec.license = 'MIT'
 
   if spec.respond_to?(:metadata)
     spec.metadata['homepage_uri'] = spec.homepage
     spec.metadata['source_code_uri'] = 'https://github.com/robotdana/fast_ignore'
-    spec.metadata['changelog_uri'] = 'https://github.com/robotdana/fast_ignore/CHANGELOG'
+    spec.metadata['changelog_uri'] = 'https://github.com/robotdana/fast_ignore/blob/master/CHANGELOG.md'
   end
 
   # Specify which files should be added to the gem when it is released.

data/lib/fast_ignore/file_rule_list.rb

@@ -4,8 +4,9 @@ require_relative './rule'
 
 class FastIgnore
   class FileRuleList < FastIgnore::RuleList
-    def initialize(file)
+    def initialize(file, root: File.dirname(file))
       @lines = IO.foreach(file)
+      @root = root
     end
   end
 end

data/lib/fast_ignore/gitignore_rule_list.rb

@@ -4,9 +4,17 @@ class FastIgnore
   class GitignoreRuleList
     include Enumerable
 
+    def initialize(file)
+      @file = file
+    end
+
     def each(&block)
       FastIgnore::RuleList.new('.git').each(&block)
-      FastIgnore::FileRuleList.new(File.join(Dir.pwd, '.gitignore')).each(&block)
+      FastIgnore::FileRuleList.new(file).each(&block)
     end
+
+    private
+
+    attr_reader :file
   end
 end

data/lib/fast_ignore/rule.rb

@@ -2,7 +2,8 @@
 
 class FastIgnore
   class Rule
-    def initialize(rule)
+    def initialize(rule, root: Dir.pwd)
+      @root = root
       @rule = rule
       strip!
       return if skip?
@@ -20,9 +21,11 @@ class FastIgnore
       @dir_only ||= @rule.end_with?('/')
     end
 
-    def match?(path, dir)
+    def match?(path, dir: File.directory?(path))
       return false if !dir && dir_only?
 
+      path = path.delete_prefix(root)
+
       File.fnmatch?(@rule, path, File::FNM_DOTMATCH | File::FNM_PATHNAME)
     end
 
@@ -40,6 +43,8 @@ class FastIgnore
 
     private
 
+    attr_reader :root
+
     def prefix
       @prefix ||= if @rule.start_with?('/')
         ''

data/lib/fast_ignore/rule_list.rb

@@ -4,8 +4,9 @@ class FastIgnore
   class RuleList
     include Enumerable
 
-    def initialize(*lines)
+    def initialize(*lines, root: Dir.pwd)
       @lines = lines
+      @root = root
     end
 
     def each(&block)
@@ -16,12 +17,12 @@ class FastIgnore
 
     private
 
-    attr_reader :lines
+    attr_reader :lines, :root
 
     def enumerator
       Enumerator.new do |yielder|
         lines.reverse_each do |rule|
-          rule = FastIgnore::Rule.new(rule)
+          rule = FastIgnore::Rule.new(rule, root: root)
           yielder << rule unless rule.skip?
         end
       end

data/lib/fast_ignore/version.rb

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

data/lib/fast_ignore.rb

@@ -10,19 +10,44 @@ require 'find'
 class FastIgnore
   include Enumerable
 
-  attr_reader :rules, :relative
+  attr_reader :rules
+  attr_reader :relative
   alias_method :relative?, :relative
+  attr_reader :root
 
-  def initialize(rules: nil, files: nil, gitignore: true, relative: false)
-    @relative = relative
+  def initialize(
+    rules: nil,
+    files: nil,
+    relative: false,
+    root: Dir.pwd,
+    gitignore: File.join(root, '.gitignore')
+  )
     @rules = []
     @rules += FastIgnore::RuleList.new(*Array(rules)).to_a
     Array(files).reverse_each do |file|
       @rules += FastIgnore::FileRuleList.new(file).to_a
     end
-    @rules += FastIgnore::GitignoreRuleList.new.to_a if gitignore
+    @rules += FastIgnore::GitignoreRuleList.new(gitignore).to_a if gitignore
+    @relative = relative
+    @root = root
+  end
+
+  def each(&block)
+    if block_given?
+      enumerator.each(&block)
+    else
+      enumerator
+    end
   end
 
+  def allowed?(path, dir: File.directory?(path))
+    return true if path == root
+
+    allowed?(File.dirname(path), dir: true) && pruned_allowed?(path, dir: dir)
+  end
+
+  private
+
   def enumerator
     Enumerator.new do |yielder|
       Find.find(root) do |path|
@@ -38,33 +63,9 @@ class FastIgnore
     end
   end
 
-  def root
-    @root ||= Dir.pwd
-  end
-
-  def allowed?(path, dir: File.directory?(path))
-    return true if path == root
-
-    allowed?(File.dirname(path), dir: true) && pruned_allowed?(path, dir: dir)
-  end
-
   def pruned_allowed?(path, dir: File.directory?(path))
-    path = path.delete_prefix(root)
-
     rules.each do |rule|
-      return rule.negation? if rule.match?(path, dir)
-    end
-  end
-
-  def each(&block)
-    if block_given?
-      enumerator.each(&block)
-    else
-      enumerator
+      return rule.negation? if rule.match?(path, dir: dir)
     end
   end
-
-  def files
-    to_a
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_ignore
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dana Sherson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-06 00:00:00.000000000 Z
+date: 2019-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,6 +106,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -126,7 +127,7 @@ 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/CHANGELOG
+  changelog_uri: https://github.com/robotdana/fast_ignore/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -146,5 +147,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Parse gitignore files
+summary: Parse gitignore files, quickly
 test_files: []