dir_glob_ignore 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59f6e0762503ccdb5cb8d469b478d1c3b90bb649
-  data.tar.gz: 8858c71953e0bd37cf8cf6df55c458a3041d07cc
+  metadata.gz: 838a9f500e255b82b53cca8d8786611597295240
+  data.tar.gz: faafb565245cbf90825c35e50f8a61892440d90c
 SHA512:
-  metadata.gz: 780257e567922428c89887c77f614a4cd0bbb4db1afc1fa84abc42f4faf1fb3e6846d99558686835b254ae7773899ecf983de4d285bddc15f0de6558b1e5644c
-  data.tar.gz: b7110afe8f51c0a841c1ac548d853c48a515c71293327dd3279d75fa7bb9026a72661a5b1349cadf336ca31f1310cd92626bc9d1d6ad3ea72a164a7ec2a5b3ae
+  metadata.gz: df38cbaba3a85a3163573bb4c021c60c6944ac7021b424ac7ca6b4ce21d5bc4a8cd8dd9d38db1ef53702216528ffca89629ef9584bd6c08385266ef0cd21f1e1
+  data.tar.gz: c0d9632f42fb4aef93a87f762a5a6503daa45cf9cfb036cb31876c45d0b740effdcdb152f4c9e6509ce8e522c0c7639eeb02c5a67fef02c0a830cca7dcc7e1ee

data/README.md

@@ -1,6 +1,7 @@
 # DirGlobIgnore
 
-Enable file globbing with a-la-git ignore files management. 
+Adds _a-la-git_ features to `Dir::glob`, so that file selection will
+take in account custom _ignore_ files.
 
 ## Installation
 
@@ -20,10 +21,10 @@ Or install it yourself as:
 
 ## Usage
 
-Once required this gem patches the `Dir` Ruby core class by adding a new method `glob_with_ignore_file`
- which allows to specify  _a-la-git_ ignore files
+Once required this gem patches the `Dir` Ruby core class by adding a new method `::glob_with_ignore_file`
+ which allows to specify _a-la-git_ ignore files.
  
-Like with Git, there can be multiple ignore files in sub-directories
+Like with Git, there can be multiple ignore files in sub-directories...
 
 ```ruby
 require 'dir_glob_ignore'
@@ -31,19 +32,26 @@ require 'dir_glob_ignore'
 Dir.glob_with_ignore_file '.my_ignore_file', '/a/root/directory', *standard_glob_options
 ```
 
-* The first parameter specifies the name of the ignore files to look for.
+* The first parameter specifies the name (without path) of the ignore files to look for.
 * The second parameter specifies a root directory for ignore files. This is not a root directory 
 for the glob function but actually defines where to search ignore files.
 * Then the remaining parameters are identical to the ones you could pass to `Dir::glob`
  
 ## Ignore files format
 
-The format is really simple, inspired by `.gitignore` file format (except you can't specify 
-"_positive_" exceptions with "!").
+The format is really simple, inspired by `.gitignore` file format:
 
-You can specify comment lines with "#". Blank lines are ignored.
+* You can specify comment lines with "#".
+* Blank lines are ignored.
+* Patterns are actually any `Dir::glob` valid pattern
 
-Patterns are actually any `Dir::glob` valid pattern
+## Current limitations and TODOs
+
+### Positive patterns
+
+Currently you can't specify a "_positive_" pattern like in `.gitignore` files (using "!").
+
+PR welcome...
 
 ## Contributing
 

data/lib/dir_glob_ignore.rb

@@ -1,7 +1,4 @@
 require 'dir_glob_ignore/version'
-require 'dir_glob_ignore/ignore_file_list'
+require 'dir_glob_ignore/ignore_file_lists'
 require 'dir_glob_ignore/dir_patch'
 
-module DirGlobIgnore
-  # Your code goes here...
-end

data/lib/dir_glob_ignore/dir_patch.rb

@@ -1,11 +1,11 @@
 class Dir
 
   def self.glob_with_ignore_file(ignore_file, base_dir, *glob_args, &block)
-    filter = DirGlobIgnore::IgnoreFileList.new base_dir
-    filter.ignore_file_name =ignore_file
+    filter = DirGlobIgnore::IgnoreFileLists.new base_dir
+    filter.ignore_file_name = ignore_file
     filter.load_ignore_files
     Dir.glob(*glob_args).reject do |file|
-      if filter.ignore_list.include? File.expand_path(file)
+      if filter.ignore_file? file
         true
       else
         yield file if block_given?

data/lib/dir_glob_ignore/{ignore_file_list.rb → ignore_file_lists.rb}

@@ -1,11 +1,10 @@
 module DirGlobIgnore
 
-  class IgnoreFileList
+  class IgnoreFileLists
 
     DEFAULT_FILE_NAME = '.ignore'.freeze
 
     attr_writer :ignore_file_name, :base_dir
-    attr_reader :ignore_list
 
     def initialize(base_dir = nil)
       self.base_dir = base_dir
@@ -22,23 +21,32 @@ module DirGlobIgnore
     def load_ignore_files
       @cache = {}
       ignore_files.each do |ignore_file|
-        cache[File.expand_path File.dirname ignore_file] = load_ignore_file ignore_file
+        cache[File.expand_path File.dirname ignore_file] = {
+            ignore_file: ignore_file,
+            patterns: load_ignore_file(ignore_file),
+            ignored_files: []
+        }
       end
-      build_ignore_list
+      build_cached_ignore_lists
+    end
+
+    def ignore_file?(file)
+      cache.values.each do |info|
+        return true if info[:ignored_files].include? File.expand_path(file)
+      end
+      false
     end
 
     private
 
     attr_reader :cache
 
-    def build_ignore_list
-      ignore_list = []
-      cache.each do |dir, patterns|
-        patterns.each do |pattern|
-          ignore_list.concat Dir.glob(File.join(dir, pattern), File::FNM_DOTMATCH)
+    def build_cached_ignore_lists
+      cache.each do |dir, info|
+        info[:patterns].each do |pattern|
+          info[:ignored_files].concat Dir.glob(File.join(dir, pattern), File::FNM_DOTMATCH)
         end
       end
-      @ignore_list = ignore_list.sort.uniq
     end
 
     def load_ignore_file(ignore_file)

data/lib/dir_glob_ignore/version.rb

@@ -1,3 +1,3 @@
 module DirGlobIgnore
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dir_glob_ignore
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
+date: 2017-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,7 +72,7 @@ files:
 - dir_glob_ignore.gemspec
 - lib/dir_glob_ignore.rb
 - lib/dir_glob_ignore/dir_patch.rb
-- lib/dir_glob_ignore/ignore_file_list.rb
+- lib/dir_glob_ignore/ignore_file_lists.rb
 - lib/dir_glob_ignore/version.rb
 homepage: https://github.com/lbriais/dir_glob_ignore.git
 licenses: