file-digests 0.0.12 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b7e14619d7b7a27805bd7cf3a27240df66b3e6144063d356f04912df21be688
-  data.tar.gz: 0ee51f824ffb7b159ef4f147aaa46e239f367388e3531440918fda3756340002
+  metadata.gz: 27ef5c07b544bb7e63a8b9ca9d8b99d0b46588b45311ef940d7431691178b99c
+  data.tar.gz: b1febf1fbdabab014eca65a86e3beee4cfaf4478ead18a5da071b045ae0ab56a
 SHA512:
-  metadata.gz: 80debef1838828adc8eefcc1c16f8a4467d4b7f871475d26af80a07bace18541673ae331260908a66e4942dd396d997a383dd9a3a4a1e73a5ff9fa253b87fe94
-  data.tar.gz: f1df92ff7323f09673dcb81cdaf33511cf4cdd0ffbc78b1c84955885bad6408c693e6abca1b4d39ea9bbfe4ea70d1cf82d62d91c6c65c130c96422c77b8f8a17
+  metadata.gz: f4d0db5b5ca2a29adaac1fa9aaefd276977f39d0c6e7e17e5432586d63a91a5bb20bd4af8c955e4e5c625460102ae1431b33947e5c40cc9351c5bb858f28974b
+  data.tar.gz: 3dc1ec4ac2224a84d1cc914b81314ccfba5580a11ca179ac9b4ca9201a599f57a52edb997af8adc369861124a733d1030f5dcb2a234dbf3c10a68b03690a5b3a

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-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,40 +139,53 @@ 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
 
+      if File.directory?(@digest_database_path)
+        @digest_database_path = @digest_database_path + '.file-digests.sqlite'
+      end
+
       if @files_path == @digest_database_path.dirname
         @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"
@@ -193,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
 
@@ -229,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
@@ -243,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.12
+  version: 0.0.17
 platform: ruby
 authors:
 - Stanislav Senotrusov