file-digests 0.0.13 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b587b7a9fd95e7a09b488041e0e80ee91e95f685b32b159f80c0bf494eabc77b
-  data.tar.gz: 8b261afd681d6d6213b03c7dc65391e7533f04896e4e13f3c1bd73ddebca74a7
+  metadata.gz: d69e75a52c05cbc2caf912491be9fbaaadb5136a2dfc723920a9010d3e4c2592
+  data.tar.gz: f90deae82f2581d301d1cb7ba7c730e684b24f5c9582d6deb2581b9f2e6fa557
 SHA512:
-  metadata.gz: aa76de6ec0bae260aa6bf289ead5a1443769f7823ae8886c2730b1235fbc9721eb39b8be56167ce654e41f6df5c5e6a10c8f1c08c03282cb32d580c09749e398
-  data.tar.gz: a6ecefb33487aa3738b42922004d4b671b39172448a0af37d183ad6f41cf4c99be80083390bf28d695ba01badf2940a5e89cf4bf9220eca8ac9b00cba3faaa24
+  metadata.gz: 5ad20e936d21d42f56ed20250728eb0b7c2b9a034877e764f528c6e297853bb7724d6780a56b7c0f11a3df975c1d51fed04852ddb3f3ff9848f4c546167902e8
+  data.tar.gz: 27f86166310f420ac5858fa86c0233af666bbb2af40f53501a9f8e02205a3753151db5cfd6777558bbf0040e2472f9bc296d9382afebb8dd45f65fb981fc173b

data/bin/file-digests

@@ -1,8 +1,5 @@
 #!/usr/bin/env ruby
 
-QUIET = (ENV["QUIET"] == "true")
-TEST_ONLY = (ENV["TEST_ONLY"] == "true")
-
 require 'file-digests'
 
 FileDigests.perform_check

data/bin/file-digests-auto

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+ENV["AUTO"] = "true"
+
+require 'file-digests'
+
+FileDigests.perform_check

data/bin/file-digests-test

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
-QUIET = (ENV["QUIET"] == "true")
-TEST_ONLY = true
+ENV["TEST_ONLY"] = "true"
 
 require 'file-digests'
 

data/lib/file-digests.rb

@@ -1,4 +1,3 @@
-
 require 'date'
 require 'set'
 require 'digest'
@@ -8,34 +7,20 @@ require 'sqlite3'
 
 module FileDigests
 
-  def self.ensure_dir_exists path
-    if File.exist?(path)
-      unless File.directory?(path)
-        raise "#{path} is not a directory"
-      end
-    else
-      FileUtils.mkdir_p path
-    end
-  end
-
-  def self.measure_time
-    start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-    yield
-    elapsed = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start).to_i
-    puts "Elapsed time: #{elapsed / 3600}h #{(elapsed % 3600) / 60}m #{elapsed % 60}s" unless QUIET
-  end
-
-  def self.patch_path_string path
-    Gem.win_platform? ? path.gsub(/\\/, '/') : path
-  end
-
   def self.perform_check
-    checker = Checker.new ARGV[0], ARGV[1]
+    options = {
+      auto: (ENV["AUTO"] == "true"),
+      quiet: (ENV["QUIET"] == "true"),
+      test_only: (ENV["TEST_ONLY"] == "true")
+    }
+    checker = Checker.new ARGV[0], ARGV[1], options
     checker.perform_check
   end
 
   class DigestDatabase
-    def initialize path
+    def initialize path, options = {}
+      @options = options
+
       @db = SQLite3::Database.new path.to_s
       @db.results_as_hash = true
 
@@ -76,8 +61,8 @@ module FileDigests
 
         if found['digest'] == digest
           counters[:good] += 1
-          # puts "GOOD: #{file_path}" unless QUIET
-          unless TEST_ONLY
+          # puts "GOOD: #{file_path}" unless @options[:quiet]
+          unless @options[:test_only]
             if found['mtime'] == mtime
               touch_digest_check_time found['id']
             else
@@ -90,47 +75,50 @@ module FileDigests
             STDERR.puts "LIKELY DAMAGED: #{file_path}"
           else
             counters[:updated] += 1
-            puts "UPDATED: #{file_path}" unless QUIET
-            unless TEST_ONLY
+            puts "UPDATED: #{file_path}" unless @options[:quiet]
+            unless @options[:test_only]
               update_mtime_and_digest mtime, digest, found['id']
             end
           end
         end
       else
         counters[:new] += 1
-        puts "NEW: #{file_path}" unless QUIET
-        unless TEST_ONLY
+        puts "NEW: #{file_path}" unless @options[:quiet]
+        unless @options[:test_only]
           @new_files[file_path] = digest
           insert file_path, mtime, digest
         end
       end
     end
 
-    def process_missing_files counters
+    def track_renames counters
       @missing_files.delete_if do |filename, digest|
         if @new_files.value?(digest)
           counters[:renamed] += 1
-          unless TEST_ONLY
+          unless @options[:test_only]
             delete_by_filename filename
           end
           true
         end
       end
+      counters[:missing] = @missing_files.length
+    end
 
-      if (counters[:missing] = @missing_files.length) > 0
-        puts "\nMISSING FILES:"
-        @missing_files.sort.to_h.each do |filename, digest|
-          puts filename
-        end
-        unless TEST_ONLY
-          puts "Remove missing files from the database (y/n)?"
-          if STDIN.gets.strip.downcase == "y"
-            @db.transaction do
-              @missing_files.each do |filename, digest|
-                delete_by_filename filename
-              end
-            end
-          end
+    def any_missing_files?
+      @missing_files.length > 0
+    end
+
+    def print_missing_files
+      puts "\nMISSING FILES:"
+      @missing_files.sort.to_h.each do |filename, digest|
+        puts filename
+      end
+    end
+
+    def remove_missing_files
+      @db.transaction do
+        @missing_files.each do |filename, digest|
+          delete_by_filename filename
         end
       end
     end
@@ -151,14 +139,15 @@ module FileDigests
   end
 
   class Checker
-    def initialize files_path, digest_database_path
-      @files_path = Pathname.new(FileDigests::patch_path_string(files_path || ".")).cleanpath
+    def initialize files_path, digest_database_path, options = {}
+      @options = options
+      @files_path = cleanup_path(files_path || ".")
       @prefix_to_remove = @files_path.to_s + '/'
 
       raise "Files path must be a readable directory" unless (File.directory?(@files_path) && File.readable?(@files_path))
 
       @digest_database_path = if digest_database_path
-        Pathname.new(FileDigests::patch_path_string(digest_database_path)).cleanpath
+        cleanup_path(digest_database_path)
       else
         @files_path + '.file-digests.sqlite'
       end
@@ -171,24 +160,32 @@ module FileDigests
         @skip_file_digests_sqlite = true
       end
 
-      FileDigests::ensure_dir_exists @digest_database_path.dirname
+      ensure_dir_exists @digest_database_path.dirname
 
+      # Please do not use this flag, support for sha512 is here for backward compatibility, and one day it will be removed.
       if File.exist?(@digest_database_path.dirname + '.file-digests.sha512')
         @use_sha512 = true
       end
 
-      @digest_database = DigestDatabase.new @digest_database_path
+      @digest_database = DigestDatabase.new @digest_database_path, @options
       @counters = {good: 0, updated: 0, new: 0, missing: 0, renamed: 0, likely_damaged: 0, exceptions: 0}
     end
 
     def perform_check
-      FileDigests::measure_time do
+      measure_time do
         walk_files do |filename|
           process_file filename
         end
       end
 
-      @digest_database.process_missing_files @counters
+      @digest_database.track_renames @counters
+
+      if @digest_database.any_missing_files?
+        @digest_database.print_missing_files
+        if !@options[:test_only] && (@options[:auto] || confirm("Remove missing files from the database"))
+          @digest_database.remove_missing_files
+        end
+      end
 
       if @counters[:likely_damaged] > 0 || @counters[:exceptions] > 0
         STDERR.puts "ERRORS WERE OCCURRED"
@@ -197,9 +194,13 @@ module FileDigests
       puts @counters.inspect
     end
 
-    def walk_files
-      Dir.glob(@files_path + '**' + '*', File::FNM_DOTMATCH) do |filename|
-        yield filename
+    private
+
+
+    def confirm text
+      if STDIN.tty? && STDOUT.tty?
+        puts "#{text} (y/n)?"
+        STDIN.gets.strip.downcase == "y"
       end
     end
 
@@ -233,7 +234,31 @@ module FileDigests
         )
     rescue => exception
       @counters[:exceptions] += 1
-      STDERR.puts "EXCEPTION: #{filename}: #{exception.message}"
+      STDERR.puts "EXCEPTION: #{filename.encode('utf-8', universal_newline: true)}: #{exception.message}"
+    end
+
+    def patch_path_string path
+      Gem.win_platform? ? path.gsub(/\\/, '/') : path
+    end
+
+    def cleanup_path path
+      Pathname.new(patch_path_string(path)).cleanpath
+    end
+
+    def ensure_dir_exists path
+      if File.exist?(path)
+        unless File.directory?(path)
+          raise "#{path} is not a directory"
+        end
+      else
+        FileUtils.mkdir_p path
+      end
+    end
+
+    def walk_files
+      Dir.glob(@files_path + '**' + '*', File::FNM_DOTMATCH) do |filename|
+        yield filename
+      end
     end
 
     def get_file_digest filename
@@ -247,5 +272,12 @@ module FileDigests
       end
     end
 
+    def measure_time
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      yield
+      elapsed = (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start).to_i
+      puts "Elapsed time: #{elapsed / 3600}h #{(elapsed % 3600) / 60}m #{elapsed % 60}s" unless @options[:quiet]
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: file-digests
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.18
 platform: ruby
 authors:
 - Stanislav Senotrusov
@@ -28,11 +28,13 @@ description: Calculate file digests and check for the possible file corruption
 email: stan@senotrusov.com
 executables:
 - file-digests
+- file-digests-auto
 - file-digests-test
 extensions: []
 extra_rdoc_files: []
 files:
 - bin/file-digests
+- bin/file-digests-auto
 - bin/file-digests-test
 - lib/file-digests.rb
 homepage: https://github.com/senotrusov/file-digests