file_scanner 3.2.1 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb4e842377393a5dcea9c34c6de8407a51399605
-  data.tar.gz: 9fc5acff042a51db73d9cd7a069e4340acde3f29
+  metadata.gz: 06a7dc00a6fc9f3a0c04dd86e9a412478b339cb7
+  data.tar.gz: 97d28bee119ac7f840e1c55c4f9872b33e679e2f
 SHA512:
-  metadata.gz: 45322898db24dcd13bda1488137769f4e0a5eb14aab8c6af1acb8f1fb0823cb7fcf5003fdfee05e454a547fcb735fa8372a5ade7c666b38a7694324c8c70e41b
-  data.tar.gz: ce70343fa5ccd3eb8521de6c2fb9c07c572c52655958b8dce36809e0f97cdb2bba055e7ca484bcfa2bdc4d2582e328f818ca8c0f10ca4f29d01d7bd5ab2b4525
+  metadata.gz: e42a649dcbe3b49b3bd3c13ba3dae2c9ba7e7a3cdeb4e1294a8951c07071e62415bdb554faa581f4e70d2b1422a4206f47ec48bed5dee8bc981d106228bb5311
+  data.tar.gz: 0ec10cadb7c8d9688ac98e02f9d8a4bb1c7389e5ba468da420e16970cd571b0f504fdd99c1d9cd255030ddb82b279855213b0000440e605d8e54ee24e89e5b70

data/README.md

@@ -11,7 +11,7 @@
     * [Enumerator](#enumerator)
     * [Consuming results](#consuming-results)
     * [Mode](#mode)
-    * [Check](#check)
+    * [File check](#file-check)
     * [Logger](#logger)
 
 ## Scope
@@ -48,7 +48,7 @@ If you specify no filters the default ones are loaded, selecting files by:
 * checking if file size is within *0KB and 5KB*
 * checking if file *basename matches* the specified *regexp* (if any)
 
-You can update default filters behaviours by passing custom arguments:
+You can update default filters behaviour by passing custom arguments:
 ```ruby
 a_week_ago = FileScanner::Filters::LastAccess.new(Time.now-7*24*3600)
 one_two_mb = FileScanner::Filters::SizeRange.new(min: 1024**2, max: 2*1024**2)
@@ -74,25 +74,27 @@ p worker.call
 ```
 
 #### Consuming results
-To leverage on the lazy behaviour remember to call a subset operator on the resulting enumerator:
+To leverage on the lazy behaviour remember to call a subset method on the resulting enumerator:
 ```ruby
-worker.call.take(1000)
+worker.call.take(1000).each do |file|
+  # perform action on filtered files
+end
 ```
 
 #### Mode
-By default the worker will select paths by applying any of the matching filters: this is it, it suffice just one of the specified filters to be true to grab the path.  
+By default the worker does select paths by applying any of the matching filters: it suffice just one of the filters to match to grab the path.  
 In case you want restrict paths selection by all matching filters, just specify the `all` option:
 ```ruby
 worker = FileScanner::Worker.new(loader: loader, filters: filters, all: true)
 worker.call # will filter by applying all? predicate
 ```
 
-#### Check
-By default the worker will scan for both directories and files. 
-In case you want restrict paths selection by files only, just specify the `check` option:
+#### File check
+By default the worker does collect both directories and files. 
+In case you want restrict selction by files only, just specify the `filecheck` option:
 ```ruby
-worker = FileScanner::Worker.new(loader: loader, filters: filters, check: true)
-worker.call # will skip directories
+worker = FileScanner::Worker.new(loader: loader, filters: filters, filecheck: true)
+worker.call # skip directories
 ```
 
 #### Logger

data/lib/file_scanner/version.rb

@@ -1,3 +1,3 @@
 module FileScanner
-  VERSION = "3.2.1"
+  VERSION = "3.2.2"
 end

data/lib/file_scanner/worker.rb

@@ -12,16 +12,17 @@ module FileScanner
     def initialize(path:, 
                    filters: Filters::defaults, 
                    all: false, 
-                   check: false,
+                   filecheck: false,
                    logger: Logger.new(nil))
       @path = File.expand_path(path)
       @filters = filters
       @mode = mode(all)
-      @check = check
+      @filecheck = filecheck
       @logger = logger
     end
 
     def call
+      @logger.debug { "skipping directories" } if @filecheck
       paths.lazy.select { |file| valid?(file) && filter(file) }
     rescue StandardError => e
       @logger.error { e.message }
@@ -33,13 +34,14 @@ module FileScanner
     end
 
     private def valid?(file)
-      return true unless @check
+      return true unless @filecheck
       FileTest.file?(file)
     end
 
     private def filter(file)
+      @logger.debug { "filters applied by \e[35m#{@mode}\e[0m" }
       @filters.send(@mode) do |filter|
-        @logger.debug { "filtering by \e[33m#{@mode}\e[0m with \e[33m#{filter}\e[0m on #{File.basename(file)}" }
+        @logger.debug { "filtering on \e[33m#{File.basename(file)}\e[0m" }
         filter.call(file)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_scanner
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.2.2
 platform: ruby
 authors:
 - costajob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-25 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler