file_scanner 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3b3798bb1314d4039d0508aaf7e3a067dd35985
-  data.tar.gz: 82177994587d8288ba5650e9fdfd2bd72dfa46fa
+  metadata.gz: 33dbedb22e72fe24ab4758275639094feab57a47
+  data.tar.gz: 770ef5bf18c0c94569051ab6bbefef12b0878464
 SHA512:
-  metadata.gz: 046f99929f5c43e475b5e4d8c6815712b112b3f0c873ef36257112fb17a06f37808e6985c1055ad35401543dc1c8cf50f0934211c20bee891beeba29051328b5
-  data.tar.gz: 734ddfae382c25e98e6bc2ff5bc9996c4f2ce083754a608ed93ae7ebed86aa7c7a73bbeb9fff4eb624c4d2306a621ef56b738370d5ee1aee5d22244946359c67
+  metadata.gz: 5fdf0d4b098155ce1d5218ff31aeac4fac0a6e0313e9206279a099438cc3fc3d8be12d2d82487640869f377eec2aa2ed295c724d44c35ef90402f2e0ca846f86
+  data.tar.gz: 1e2c0cac747c3c68868991628ccf3a3c51e75604d95bcb79c09c90a11dd5e1180d4cbfcfbc6322aaf984bc8370961515667075614c4edc538e701b464c9a283b

data/README.md

@@ -10,7 +10,7 @@
   * [Worker](#worker)
 
 ## Scope
-This gem is aimed to collect a set of file paths starting by a wildcard rule, filter them by 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, size range) and apply a set of custom policies to them.
 
 ## 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,32 +42,36 @@ loader = FileScanner::Loader.new(path: ENV["HOME"], extensions: %w[html txt])
 ```
 
 ### Filters
-The second step is to provide the filters list to select files for which the `call` method is truthy.  
+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.
 
 #### Default
-If you specify no filters the existing onee will select files by:
+If you specify no filters the existing ones will select files by:
 * checking if file is older than *30 days* 
-* checking if file size is *smaller than 100 bytes*
+* checking if file size is within *0KB and 5KB*
+* checking if file *basename matches* the specified *regexp* (if any)
 
-You can configure default behaviour by passing different arguments:
+You can update default behaviours by passing custom arguments:
 ```ruby
-accessed_a_week_ago = FileScanner::Filters::LastAccess.new(Time.now-7*24*3600)
-one_to_two_mega = FileScanner::Filters::SizeRange.new(min: 1024**2, max: 2*1024**2)
+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 << accessed_a_week_ago
-filters << one_to_two_mega
+filters << a_week_ago
+filters << one_two_mb
+filters << hidden
 ```
 
 #### Custom
-It is convenient to create custom filters by just relying on `Proc` instances that satisfy the `callable` protocol:
+It is convenient to create custom filters by creating `Proc` instances that satisfy the `callable` protocol:
 ```ruby
 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 accept an array of paths as an argument:
+Again, it suffice the policy responds to the `call` method and accepts an array of paths as unique argument:
 ```ruby
 require "fileutils"
 
@@ -109,6 +113,7 @@ 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, logger: my_logger)
 worker.call do |slice|
   fail "Doh!" # will log error to my_file.log and re-raise exception

data/lib/file_scanner/filters.rb

@@ -1,4 +1,7 @@
+require "file_scanner/refinements"
+
 module FileScanner
+  using Refinements
   module Filters
     def self.defaults
       constants.map do |name|
@@ -18,8 +21,24 @@ module FileScanner
       end
     end
 
+    class MatchingName
+      def initialize(regexp = nil)
+        @regexp = compile(regexp)
+      end
+
+      def call(file)
+        return unless @regexp
+        File.basename(file).matches?(@regexp)
+      end
+
+      private def compile(regexp)
+        return unless regexp
+        Regexp.compile(regexp.to_s)
+      end
+    end
+
     class SizeRange
-      def initialize(min: 100, max: Float::INFINITY)
+      def initialize(min: 0, max: 5*1024)
         @range = min..max
       end
 

data/lib/file_scanner/loader.rb

@@ -1,7 +1,7 @@
 module FileScanner
   class Loader
     def initialize(path:, extensions: [])
-      @path = path
+      @path = File.expand_path(path)
       @extensions = extensions
     end
 

data/lib/file_scanner/refinements.rb

@@ -0,0 +1,10 @@
+module FileScanner
+  module Refinements
+    refine(String) do
+      def matches?(re)
+        return match?(re) if defined?("".match?)
+        !!match(re)
+      end
+    end
+  end
+end

data/lib/file_scanner/version.rb

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

data/lib/file_scanner/worker.rb

@@ -4,7 +4,15 @@ module FileScanner
   class Worker
     attr_reader :filters, :policies
 
-    def initialize(loader:, filters: Filters::defaults, policies: [], logger: Logger.new(nil), slice: nil)
+    def self.default_logger
+      Logger.new(nil).tap do |logger|
+        logger.level = Logger::ERROR
+      end
+    end
+
+    def initialize(loader:, 
+                   filters: Filters::defaults, policies: [], 
+                   logger: self.class.default_logger, slice: nil)
       @loader = loader
       @filters = filters
       @policies = policies
@@ -16,7 +24,7 @@ module FileScanner
       slices.each do |slice|
         yield(slice) if block_given? && policies.empty?
         policies.each do |policy|
-          @logger.info { "applying \e[1m#{policy}\e[0m to \e[1m#{slice.size}\e[0m files" }
+          @logger.info { "applying \e[33m#{policy}\e[0m to #{slice.size} files" }
           policy.call(slice)
         end
       end
@@ -26,9 +34,9 @@ module FileScanner
     end
 
     private def files
-      @files ||= Array(@loader.call).select do |f|
-        @filters.all? do |filter|
-          @logger.info { "applying \e[1m#{filter.class}\w[0m to \e[1m#{File.basename(f)}\e[0m" }
+      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
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file_scanner
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - costajob
@@ -70,6 +70,7 @@ files:
 - lib/file_scanner.rb
 - lib/file_scanner/filters.rb
 - lib/file_scanner/loader.rb
+- lib/file_scanner/refinements.rb
 - lib/file_scanner/version.rb
 - lib/file_scanner/worker.rb
 homepage: https://github.com/costajob/file_scanner