file_scanner 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04135b6ae88b32be621d587dfa0ec5a9021062ff
-  data.tar.gz: 87e4d6a63ac8febc2f106b32749d68f4a11848de
+  metadata.gz: c12f11f2f4e622c3b6004ea36c83e82e671e1395
+  data.tar.gz: 97d4d537ec6509e2f709afd9dfd17a0977b8cc9f
 SHA512:
-  metadata.gz: bfc804f77a62758da9e32c6a472e254a008f2a7de736b965d6a94775b9311c73b833da4ce475bf06eeeefbf128d88467a00e647f1b500e90f555be9cb259125f
-  data.tar.gz: 23418775678248e6f8e84a54c7dab42383af56efb9e88ee9b7fa92e1355d539fe7fa7ef353c91e159c24985bcad61b5f523e6e9bfbe3948436507eac30b73e37
+  metadata.gz: b6e038b6006fbbac3e25cfcf31277275b8046291c8557aee7f40cc92f554e392704014a57cdf29fca76c75ce6b9b8f2a1435b85348c5b9cd7c4947eead90ee27
+  data.tar.gz: 2bdf24965994cda568977723d6cbaafb8d3d19a49b78679233cc1a66327cc28db8b26753720ea57d2cae247ee4a1263b56c835491b64a2e9ca7b25d35407eddf

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 /.edgerc
 /*.gem
+/*.log

data/.travis.yml

@@ -5,4 +5,4 @@ rvm:
   - 2.2.2
   - 2.3.0
   - 2.4.0
-before_install: gem install bundler -v 1.15.2
+before_install: gem install bundler -v 1.15.3

data/README.md

@@ -11,6 +11,7 @@
   * [Worker](#worker)
     * [Batches](#batches)
     * [Logger](#logger)
+    * [Factory](#factory)
 
 ## Scope
 This gem is aimed to collect a set of file paths starting by a wildcard rule, filter them by any default/custom filters (access time, matching name and size range) and apply a set of actions via a block call.
@@ -83,7 +84,7 @@ The `Worker` constructor accepts a `slice` attribute to give you a chance to dis
 ```ruby
 worker = FileScanner::Worker.new(loader: loader, slice: 1000)
 worker.call do |slice|
-  # perform action on a slice of 1000 paths
+  # perform action 1000 paths per time
 end
 ```
 
@@ -96,3 +97,22 @@ 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
+```
+
+#### Factory
+You can create loader and worker instances at once by using the available factory:
+```ruby
+worker = FileScanner::Worker.factory(path: ENV["HOME"], extensions: %w[html txt], filters: filters, logger: my_logger, slice: 1000)
+worker.call do |slice, logger|
+  # perform action 1000 paths per time
+end
+```

data/lib/file_scanner/version.rb

@@ -1,3 +1,3 @@
 module FileScanner
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/lib/file_scanner/worker.rb

@@ -1,15 +1,22 @@
 require "logger"
+require "file_scanner/filters"
+require "file_scanner/loader"
 
 module FileScanner
   class Worker
-    attr_reader :filters
-
     def self.default_logger
       Logger.new(nil).tap do |logger|
         logger.level = Logger::ERROR
       end
     end
 
+    def self.factory(path:, extensions: [], filters: [], logger: default_logger, slice: nil)
+      loader = Loader.new(path: path, extensions: extensions)
+      new(loader: loader, filters: filters, logger: logger, slice: slice)
+    end
+
+    attr_reader :loader, :filters
+
     def initialize(loader:, filters: Filters::defaults, logger: self.class.default_logger, slice: nil)
       @loader = loader
       @filters = filters

data/lib/file_scanner.rb

@@ -1,4 +1,2 @@
-require "file_scanner/filters"
-require "file_scanner/loader"
 require "file_scanner/version"
 require "file_scanner/worker"

metadata

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