file_scanner 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 478c7732cd0abb2981102eefe125cd22b9a20817
-  data.tar.gz: 3e2b952a497d05a4922391e9cbcb8ece65547878
+  metadata.gz: 4603c0a4323560155dedb12615cb60ed38b81cf6
+  data.tar.gz: 7852a338f0f88218649424d36a464ec7488b2ef5
 SHA512:
-  metadata.gz: 1dc2e81cec24ffde8024dc70b72afe8f4f749fbc911d2da201ec2129221852f66b98054ecc3e9767c32e7c75526bc7822018ce2bfaf9810ab4847d144c8093a5
-  data.tar.gz: 80083baacc776549ecbe1575256459eba93bff72935b55428652ee42e8706d9e95b9a2dfd826f274dc29b685c4ffde6d90f1208e399f6bff013e2f4ca0904327
+  metadata.gz: 4b730537560c4060a437e03c81df4bb21838d7bbcbf13e80e41949f1591586cd7bdfbe6ea9577098b8de21b3c3b64f9699ddcbc6156000bcda414fdec1bdbae6
+  data.tar.gz: 7e93e56d4a2e3c760be967fcc8d92c4d7ab14c6c071d03989e94bccf43c248123a971ff012d8765261d9921ba3eb2546f3a71893a5f93d9186fa618f194d7a03

data/README.md

@@ -9,16 +9,17 @@
     * [Custom](#custom)
   * [Worker](#worker)
     * [Enumerator](#enumerator)
-    * [Block](#block)
+    * [Consuming results](#consuming-results)
     * [Mode](#mode)
     * [Check](#check)
     * [Logger](#logger)
 
 ## Scope
-This gem is aimed to collect a set of file paths starting by a wildcard rule, filter them by any/all default/custom filters (access time, matching name and size range) and apply a set of actions via a block call.
+This gem is aimed to lazily collect a list of files by path and a set of filters.
 
 ## Motivation
-This gem is helpful to purge obsolete files or to promote relevant ones, by calling external services (CDN APIs) and/or local file system actions (copy, move, delete, etc).
+This gem is helpful to purge obsolete files or to promote relevant ones, by calling external services (CDN APIs) and/or local file system actions (copy, move, delete, etc).  
+By working lazily, this library is aimed to work with a subset of large files list: just remember to apply a subset method to the final enumerator.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -65,19 +66,17 @@ filters << ->(file) { File.directory?(file) }
 The second step is to create the `Worker` instance by providing the path to scan and the list of filters to apply.  
 
 #### Enumerator
-The `call` method of the worker return a lazy enumerator with the filtered elements, sliced by the specified number (default to 1000):
+The `call` method of the worker return a lazy enumerator with the filtered elements:
 ```ruby
 worker = FileScanner::Worker.new(path: "~/Downloads", filters: filters, slice: 35)
 p worker.call
 => #<Enumerator::Lazy: ...
 ```
 
-#### Block
-To perform actions on each of the sliced paths just pass a block:
+#### Consuming results
+To leverage on the lazy behaviour remember to call a subset operator on the resulting enumerator:
 ```ruby
-worker.call do |slice|
-  # perform actions on a slice of at max 35 elements
-end
+worker.call.take(1000)
 ```
 
 #### Mode
@@ -101,17 +100,4 @@ If you dare to trace what the worker is doing (including errors), you can specif
 ```ruby
 my_logger = Logger.new("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
-```
-
-If you want to easily pass the same logger instance to the actions you are performing, it's available as the second argument of the block:
-```ruby
-require "fileutils"
-
-worker.call do |slice, logger|
-  logger.info { "going to remove #{slice.size} files from disk!" }
-  FileUtils.rm_rf(slice)
-end
 ```

data/Rakefile

@@ -7,4 +7,10 @@ Rake::TestTask.new(:spec) do |t|
   t.test_files = FileList["spec/**/*_spec.rb"]
 end
 
+Rake::TestTask.new(:bench) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_bench.rb"]
+end
+
 task :default => :spec

data/lib/file_scanner/version.rb

@@ -1,3 +1,3 @@
 module FileScanner
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/lib/file_scanner/worker.rb

@@ -4,7 +4,6 @@ require "file_scanner/filters"
 
 module FileScanner
   class Worker
-    SLICE = 1000
     ALL = :all?
     ANY = :any?
 
@@ -12,23 +11,18 @@ module FileScanner
 
     def initialize(path:, 
                    filters: Filters::defaults, 
-                   slice: SLICE, 
                    all: false, 
                    check: false,
                    logger: Logger.new(nil))
       @path = File.expand_path(path)
       @filters = filters
-      @slice = slice.to_i
       @mode = mode(all)
       @check = check
       @logger = logger
     end
 
     def call
-      return slices unless block_given?
-      slices.each do |slice|
-        yield(slice, @logger)
-      end
+      paths.lazy.select { |file| valid?(file) && filter(file) }
     rescue StandardError => e
       @logger.error { e.message }
       raise e
@@ -53,13 +47,5 @@ module FileScanner
     private def paths
       Find.find(@path)
     end
-
-    private def filtered
-      paths.lazy.select { |file| valid?(file) && filter(file) }
-    end
-
-    private def slices
-      filtered.each_slice(@slice)
-    end
   end
 end

metadata

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