file_scanner 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb1ecb18e4ad80828cc4c294f551fd0382f35a36
-  data.tar.gz: 8de6b0ee60c7d9dc239bd277e783ba268443cecd
+  metadata.gz: d3b3798bb1314d4039d0508aaf7e3a067dd35985
+  data.tar.gz: 82177994587d8288ba5650e9fdfd2bd72dfa46fa
 SHA512:
-  metadata.gz: 7660c82c106d205c7dab1ca13e26b3a3692cb198c07b7343dff8f2c1daef989b3f6a802c3bda9a26aa88271fc859ebc29a956f5442627233493c2bae62375766
-  data.tar.gz: c864ae94eb9853123e90c04ac9f7660f9ba1992fa2f8d8956c10a0bbf17ed3bfdd6bb54ffe423f266c5a7abddcaed4b2dfe3f5ac68e126c448fb56f918aabe76
+  metadata.gz: 046f99929f5c43e475b5e4d8c6815712b112b3f0c873ef36257112fb17a06f37808e6985c1055ad35401543dc1c8cf50f0934211c20bee891beeba29051328b5
+  data.tar.gz: 734ddfae382c25e98e6bc2ff5bc9996c4f2ce083754a608ed93ae7ebed86aa7c7a73bbeb9fff4eb624c4d2306a621ef56b738370d5ee1aee5d22244946359c67

data/README.md

@@ -45,7 +45,7 @@ loader = FileScanner::Loader.new(path: ENV["HOME"], extensions: %w[html txt])
 The second step is to provide the filters list to select files for which the `call` method is truthy.  
 
 #### Default
-You can rely on existing filters that select files by:
+If you specify no filters the existing onee will select files by:
 * checking if file is older than *30 days* 
 * checking if file size is *smaller than 100 bytes*
 
@@ -66,7 +66,7 @@ filters << ->(file) { File.directory?(file) }
 ```
 
 ### Policies
-The third step is creating custom policies objects (no default exist) to be applied to the list of filtered paths.  
+The third step is creating custom policies objects (no defaults exist) to be applied to the list of filtered paths.  
 Again, it suffice the policy responds to the `call` method and accept an array of paths as an argument:
 ```ruby
 require "fileutils"
@@ -87,19 +87,21 @@ worker.call # apply all the specified policies to the filtered file paths
 ```
 
 #### Slice of files
-In case you are going to scan a large number of files, is better to work in batches.  
-This is exactly why the `Worker` class accept a `slice` attribute to distribute the work and avoid saturating the resources used by the specified policies:
+In case you are going to scan a large number of files, it is better to work in batches.  
+The `Worker` constructor accepts a `slice` attribute to better distribute loading (no sleep by default, use block syntax):
 ```ruby
-worker = FileScanner::Worker.new(loader: loader, filter: filter, policies: policies, slice: 1000)
-worker.call # call policies by slice of 1000 files
+worker = FileScanner::Worker.new(loader: loader, policies: policies, slice: 1000)
+worker.call # call policies by slice of 1000 files with default filters
 ```
 
-#### Policies by block
-In case you prefer to specify the policies as a block yielding the files slice, you can omit the `policies` argument at all:
+#### Block syntax
+In case you prefer to specify the policies inside a block for a more granular control on the slice of paths, you must omit the `policies` argument and use the block syntax:
 ```ruby
-worker = FileScanner::Worker.new(loader: loader, filter: filter)
+worker = FileScanner::Worker.new(loader: loader)
 worker.call do |slice|
-  ->(slice) { FileUtils.chmod_R(0700, slice) }.call
+  policy = ->(slice) { FileUtils.chmod_R(0700, slice) }
+  policy.call
+  sleep 10 # wait 10 seconds before slurping next slice 
 end
 ```
 
@@ -107,6 +109,8 @@ end
 If you dare to trace what the worker is doing (including errors), you can specify a logger to the worker class:
 ```ruby
 my_logger = Logger.new("my_file.log")
-worker = FileScanner::Worker.new(loader: loader, filter: filter, logger: my_logger)
-worker.call # will log worker actions to my_file.log
+worker = FileScanner::Worker.new(loader: loader, logger: my_logger)
+worker.call do |slice|
+  fail "Doh!" # will log error to my_file.log and re-raise exception
+end
 ```

data/lib/file_scanner/version.rb

@@ -1,3 +1,3 @@
 module FileScanner
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file_scanner
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - costajob