file_scanner 1.1.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33dbedb22e72fe24ab4758275639094feab57a47
-  data.tar.gz: 770ef5bf18c0c94569051ab6bbefef12b0878464
+  metadata.gz: 04135b6ae88b32be621d587dfa0ec5a9021062ff
+  data.tar.gz: 87e4d6a63ac8febc2f106b32749d68f4a11848de
 SHA512:
-  metadata.gz: 5fdf0d4b098155ce1d5218ff31aeac4fac0a6e0313e9206279a099438cc3fc3d8be12d2d82487640869f377eec2aa2ed295c724d44c35ef90402f2e0ca846f86
-  data.tar.gz: 1e2c0cac747c3c68868991628ccf3a3c51e75604d95bcb79c09c90a11dd5e1180d4cbfcfbc6322aaf984bc8370961515667075614c4edc538e701b464c9a283b
+  metadata.gz: bfc804f77a62758da9e32c6a472e254a008f2a7de736b965d6a94775b9311c73b833da4ce475bf06eeeefbf128d88467a00e647f1b500e90f555be9cb259125f
+  data.tar.gz: 23418775678248e6f8e84a54c7dab42383af56efb9e88ee9b7fa92e1355d539fe7fa7ef353c91e159c24985bcad61b5f523e6e9bfbe3948436507eac30b73e37

data/README.md

@@ -6,11 +6,14 @@
 * [Usage](#usage)
   * [Loader](#loader)
   * [Filters](#filters)
-  * [Policies](#policies)
+    * [Defaults](#defaults)
+    * [Custom](#custom)
   * [Worker](#worker)
+    * [Batches](#batches)
+    * [Logger](#logger)
 
 ## 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, size range) and apply a set of custom policies to them.
+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.
 
 ## 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).
@@ -42,25 +45,21 @@ loader = FileScanner::Loader.new(path: ENV["HOME"], extensions: %w[html txt])
 ```
 
 ### Filters
-The second step is to provide the filters list to select file paths for which the `call` method is truthy.  
-Selection is done with the `any?` predicate, so also one matching filter will select the path.
+The second step is to provide the filters list to select file paths for which the `call` method is *truthy*.  
+Selection is done with the `any?` predicate, so also one matching filter will do the selection.
 
-#### Default
-If you specify no filters the existing ones will select files by:
+#### Defaults
+If you specify no filters the default ones are loaded, selecting files by:
 * checking if file is older than *30 days* 
 * checking if file size is within *0KB and 5KB*
 * checking if file *basename matches* the specified *regexp* (if any)
 
-You can update default behaviours by passing custom arguments:
+You can update default filters behaviours 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)
 hidden = FileScanner::Filters::MatchingName.new(/^\./)
-
-filters = []
-filters << a_week_ago
-filters << one_two_mb
-filters << hidden
+filters = [a_week_ago, one_two_mb, hidden]
 ```
 
 #### Custom
@@ -69,51 +68,29 @@ It is convenient to create custom filters by creating `Proc` instances that sati
 filters << ->(file) { File.directory?(file) }
 ```
 
-### Policies
-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 accepts an array of paths as unique argument:
-```ruby
-require "fileutils"
-
-remove_from_disk = ->(paths) do
-  FileUtils.rm_rf(paths)
-end
-
-policies = []
-policies << remove_from_disk
-```
-
 ### Worker
-Now that you have all of the collaborators in place, you can create the `Worker` instance:
-```ruby
-worker = FileScanner::Worker.new(loader: loader, filters: filters, policies: policies)
-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, 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):
+Now that you have all of the collaborators in place, you can create the `Worker` instance to performs actions on the filtered paths:
 ```ruby
-worker = FileScanner::Worker.new(loader: loader, policies: policies, slice: 1000)
-worker.call # call policies by slice of 1000 files with default filters
+worker = FileScanner::Worker.new(loader: loader, filters: filters)
+worker.call do |paths|
+  # do whatever you want with the paths list
+end
 ```
 
-#### 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:
+#### Batches
+In case you are going to scan a large number of files, it is suggested to work in batches.  
+The `Worker` constructor accepts a `slice` attribute to give you a chance to distribute loading:
 ```ruby
-worker = FileScanner::Worker.new(loader: loader)
+worker = FileScanner::Worker.new(loader: loader, slice: 1000)
 worker.call do |slice|
-  policy = ->(slice) { FileUtils.chmod_R(0700, slice) }
-  policy.call
-  sleep 10 # wait 10 seconds before slurping next slice 
+  # perform action on a slice of 1000 paths
 end
 ```
 
-#### Use a logger
+#### Logger
 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, logger: my_logger)
 worker.call do |slice|
   fail "Doh!" # will log error to my_file.log and re-raise exception

data/file_scanner.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler", "~> 1.15"
   s.add_development_dependency "rake", "~> 10.0"
   s.add_development_dependency "minitest", "~> 5.0"
+  s.add_development_dependency "benchmark-ips", "~> 2.7"
 end

data/lib/file_scanner/version.rb

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

data/lib/file_scanner/worker.rb

@@ -2,7 +2,7 @@ require "logger"
 
 module FileScanner
   class Worker
-    attr_reader :filters, :policies
+    attr_reader :filters
 
     def self.default_logger
       Logger.new(nil).tap do |logger|
@@ -10,23 +10,16 @@ module FileScanner
       end
     end
 
-    def initialize(loader:, 
-                   filters: Filters::defaults, policies: [], 
-                   logger: self.class.default_logger, slice: nil)
+    def initialize(loader:, filters: Filters::defaults, logger: self.class.default_logger, slice: nil)
       @loader = loader
       @filters = filters
-      @policies = policies
       @slice = slice.to_i
       @logger = logger
     end
 
     def call
       slices.each do |slice|
-        yield(slice) if block_given? && policies.empty?
-        policies.each do |policy|
-          @logger.info { "applying \e[33m#{policy}\e[0m to #{slice.size} files" }
-          policy.call(slice)
-        end
+        yield(slice, @logger) if block_given?
       end
     rescue StandardError => e
       @logger.error { e.message }
@@ -34,11 +27,14 @@ module FileScanner
     end
 
     private def files
-      Array(@loader.call).select do |f|
-        @filters.any? do |filter|
-          @logger.info { "applying \e[35m#{filter}\e[0m to #{File.basename(f)}" }
-          filter.call(f)
-        end
+      paths = @loader.call
+      paths.select! { |file| filter(file) } || paths
+    end
+
+    private def filter(file)
+      @filters.any? do |filter|
+        @logger.info { "applying \e[33m#{filter}\e[0m to #{File.basename(file)}" }
+        filter.call(file)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: file_scanner
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.1
 platform: ruby
 authors:
 - costajob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-08 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 description: 
 email:
 - costajob@gmail.com