fingerprint 1.4.0 → 3.0.1

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test)
+
+task :default => :test

data/bin/fingerprint

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -20,201 +20,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'optparse'
-require 'pathname'
-require 'fingerprint'
-require 'fileutils'
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
 
-OPTIONS = {
-	:root => "./",
-	:mode => :scan,
-	:output => $stdout,
-	:verbose => false,
-	:force => false,
-	:name => "index.fingerprint",
-	:extended => false,
-	:checksums => Fingerprint::DEFAULT_CHECKSUMS,
-	:additions => false,
-	:failures => :ignore,
-}
+require_relative '../lib/fingerprint/command'
 
-ARGV.options do |o|
-	script_name = File.basename($0)
-
-	o.banner = "Usage: #{script_name} [options] [path]"
-	o.define_head "This script is used to create and compare file system fingerprints."
-
-	o.separator ""
-	o.separator "Directory analysis and verification:"
-	
-	o.on("-a", "--analyze [path]", String, "Generage a fingerprint of the given path and save it for later verification.") do |path|
-		OPTIONS[:mode] = :analyze
-		OPTIONS[:root] = path if path
-	end
-	
-	o.on("-v", "--verify [path]", String, "Verify a given path based on a previously saved fingerprint.") do |path|
-		OPTIONS[:mode] = :verify
-		OPTIONS[:root] = path if path
-	end
-	
-	o.on("-n name", String, "Specify the name of the fingerprint file.", "Default: #{OPTIONS[:name]}") do |name|
-		OPTIONS[:name] = name
-	end
-	
-	o.on("-f", "Force any operation to complete despite warnings.") do
-		OPTIONS[:force] = true
-	end
-	
-	o.separator ""
-	
-	o.on("-x", "Include additional extended information about files and directories.") do
-		OPTIONS[:extended] = true
-	end
-	
-	o.on("-s [checksum1,checksum2]", "Provide a list of the checksum algorithms to use.", "Available: #{Fingerprint::CHECKSUMS.keys.join(', ')}; Default: #{OPTIONS[:checksums].join(', ')}") do |checksums|
-		OPTIONS[:checksums] = checksums.split(/[\s,]+/)
-	end
-	
-	o.separator ""
-	o.separator "Compare fingerprints:"
-
-	o.on("-c", "Compare the given fingerprints. Check that the second fingerprint is a superset of the first.") do
-		 OPTIONS[:mode] = :check
-	end
-	
-	o.on("-A", "Report files that have been added to the second fingerprint.") do
-		OPTIONS[:additions] = true
-	end
-	
-	o.separator ""
-	o.separator "Output manipulation:"
-	
-	o.on("-o [output-path]", String, "Write the fingerprint output to the given file.") do |path|
-		OPTIONS[:output] = File.open(path, "w")
-	end
-	
-	o.on("--verbose", "Verbose output, include additional details in the file transcript.") do
-		OPTIONS[:verbose] = true
-	end
-	
-	o.on("--progress", "Print percentage progress to standard error.") do
-		OPTIONS[:progress] = true
-	end
-	
-	o.on("--die", "Give a non-zero exit code if errors are detected by check or verify.") do
-		OPTIONS[:failures] = :die
-	end
-	
-	o.separator ""
-	o.separator "Help and Copyright information:"
-
-	o.on_tail("--copy", "Display copyright and warranty information") do
-		$stderr.puts "#{script_name} v#{Fingerprint::VERSION}. Copyright (c) 2011 Samuel Williams."
-		$stderr.puts "This software is released under the MIT license and comes with ABSOLUTELY NO WARRANTY."
-		$stderr.puts "See http://www.oriontransfer.co.nz/ for more information."
-		exit
-	end
-
-	o.on_tail("-h", "--help", "Show this help message.") do
-		$stderr.puts o
-		exit
-	end
-end.parse!
-
-unless File.directory? OPTIONS[:root]
-	$stderr.puts "Path #{OPTIONS[:root]} doesn't exist!"
-	exit(255)
-end
-
-if OPTIONS[:checksums].size == 0
-	OPTIONS[:checksums] = ['MD5', 'SHA2.256']
-end
-
-def finish_check(error_count)
-	if error_count == 0
-		$stderr.puts "Data verified, 0 errors found."
-		exit(0)
-	else
-		$stderr.puts "Data inconsistent, #{error_count} errors found!"
-		exit(OPTIONS[:failures] == :die ? 1 : 0)
-	end
-end
-
-case (OPTIONS[:mode])
-when :analyze
-	output_file = Pathname.new(OPTIONS[:root]) + OPTIONS[:name]
-
-	if output_file.exist? && !OPTIONS[:force]
-		$stderr.puts "Output file #{output_file} already exists. Aborting."
-		exit(2)
-	end
-
-	options = OPTIONS.dup
-	options[:excludes] = [OPTIONS[:name]]
-
-	finished = false
-	begin
-		File.open(output_file, "w") do |io|
-			options[:output] = io
-
-			Fingerprint::Scanner.scan_paths([OPTIONS[:root]], options)
-		end
-		finished = true
-	ensure
-		FileUtils.rm(output_file) unless finished
-	end		
-when :verify
-	error_count = 0
-
-	input_file = Pathname.new(OPTIONS[:root]) + OPTIONS[:name]
-
-	unless File.exist? input_file
-		$stderr.puts "Can't find index #{input_file}. Aborting."
-		exit(3)
-	end
-
-	options = OPTIONS.dup
-
-	master = Fingerprint::RecordSet.new
-
-	File.open(input_file, "r") do |io|
-		master.parse(io)
-	end
-
-	if master.configuration
-		options.merge!(master.configuration.options)
-	end
-
-	scanner = Fingerprint::Scanner.new([OPTIONS[:root]], options)
-	copy = Fingerprint::SparseRecordSet.new(scanner)
-
-	error_count += Fingerprint::Checker::verify(master, copy, options)
-
-	finish_check(error_count)
-when :scan
-	roots = ARGV
-	roots << Dir.pwd if roots.size == 0
-
-	# Check that all supplied paths exist
-	roots.delete_if do |root|
-		if File.exist? root
-			false
-		else
-			$stderr.puts "Path #{root} doesn't exist, skipping!"
-			true
-		end
-	end
-
-	options = OPTIONS.dup
-
-	# Discard output once it has been written to disk:
-	options[:recordset] = nil
-
-	Fingerprint::Scanner.scan_paths(roots, options)
-when :check
-	options = OPTIONS.dup
-
-	error_count = Fingerprint::Checker.check_files(ARGV[0], ARGV[1], options)
-
-	finish_check(error_count)
-end
+Fingerprint::Command.call

data/fingerprint.gemspec

@@ -1,7 +1,5 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'fingerprint/version'
+
+require_relative 'lib/fingerprint/version'
 
 Gem::Specification.new do |spec|
 	spec.name          = "fingerprint"
@@ -20,8 +18,11 @@ Gem::Specification.new do |spec|
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 	spec.require_paths = ["lib"]
 
-	spec.add_development_dependency "bundler", "~> 1.3"
-	spec.add_development_dependency "rake"
+	spec.add_dependency "samovar", "~> 2.0"
+	spec.add_dependency "build-files", "~> 1.2"
 
-	spec.add_dependency "lockfile"
+	spec.add_development_dependency "covered"
+	spec.add_development_dependency "bundler"
+	spec.add_development_dependency "rspec", "~> 3.4"
+	spec.add_development_dependency "rake"
 end

data/lib/fingerprint.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2011, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -25,7 +25,7 @@ require 'fingerprint/checker'
 
 module Fingerprint
 	# A helper function to check two paths for consistency. Provides callback from +Fingerprint::Checker+.
-	def self.check_paths(master_path, copy_path, &block)
+	def self.check_paths(master_path, copy_path, **options, &block)
 		master = Scanner.new([master_path])
 		copy = Scanner.new([copy_path])
 		
@@ -34,10 +34,23 @@ module Fingerprint
 		
 		master.scan(master_recordset)
 		
-		checker = Checker.new(master_recordset, copy_recordset)
+		checker = Checker.new(master_recordset, copy_recordset, **options)
 		
 		checker.check(&block)
 		
 		return checker
 	end
+	
+	# Returns true if the given paths contain identical files. Useful for expectations, e.g. `expect(Fingerprint).to be_identical(source, destination)`
+	def self.identical?(source, destination, &block)
+		failures = 0
+		
+		check_paths(source, destination) do |record, name, message|
+			failures += 1
+			
+			yield(record) if block_given?
+		end
+		
+		return failures == 0
+	end
 end

data/lib/fingerprint/checker.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2011, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -31,7 +31,7 @@ module Fingerprint
 	#
 	# Master and copy are +IO+ objects corresponding to the output produced by +Fingerprint::Scanner+.
 	class Checker
-		def initialize(master, copy, options = {})
+		def initialize(master, copy, **options)
 			@master = master
 			@copy = copy
 			
@@ -42,7 +42,7 @@ module Fingerprint
 		attr :copy
 
 		# Run the checking process.
-		def check (&block)
+		def check(&block)
 			# For every file in the src, we check that it exists
 			# in the destination:
 			total_count = @master.records.count
@@ -95,7 +95,7 @@ module Fingerprint
 		# A list of files which either did not exist in the copy, or had the wrong checksum.
 		attr :failures
 
-		def self.check_files(master, copy, options = {}, &block)
+		def self.check_files(master, copy, **options, &block)
 			# New API that takes two RecordSets...
 			
 			File.open(master) do |master_file|
@@ -106,13 +106,13 @@ module Fingerprint
 					copy_recordset = RecordSet.new
 					copy_recordset.parse(copy_file)
 
-					verify(master_recordset, copy_recordset, options, &block)
+					verify(master_recordset, copy_recordset, **options, &block)
 				end
 			end
 		end
 
 		# Helper function to check two fingerprint files.
-		def self.verify(master, copy, options = {}, &block)
+		def self.verify(master, copy, **options, &block)
 			error_count = 0 
 
 			errors = options.delete(:recordset) || RecordSet.new
@@ -120,7 +120,7 @@ module Fingerprint
 				errors = RecordSetPrinter.new(errors, options[:output])
 			end
 
-			checker = Checker.new(master, copy, options)
+			checker = Checker.new(master, copy, **options)
 
 			checker.check do |record, result, message|
 				error_count += 1

data/lib/fingerprint/checksums.rb

@@ -0,0 +1,33 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
+
+require 'samovar'
+
+module Fingerprint
+	module Checksums
+		def self.call(result)
+			result.split(/\s*,\s*/)
+		end
+	end
+end

data/lib/fingerprint/command.rb

@@ -0,0 +1,90 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
+
+require 'samovar'
+
+require_relative 'scanner'
+
+require_relative 'command/scan'
+require_relative 'command/analyze'
+require_relative 'command/verify'
+require_relative 'command/compare'
+require_relative 'command/duplicates'
+
+module Fingerprint
+	module Command
+		def self.call(*args)
+			Top.call(*args)
+		end
+		
+		class Top < Samovar::Command
+			self.description = "A file checksum analysis and verification tool."
+			
+			options do
+				option '--root <path>', "Work in the given root directory."
+				
+				option '-o/--output <path>', "Output the transcript to a specific file rather than stdout."
+				
+				option '-h/--help', "Print out help information."
+				option '-v/--version', "Print out the application version."
+			end
+			
+			def chdir(&block)
+				if root = @options[:root]
+					Dir.chdir(root, &block)
+				else
+					yield
+				end
+			end
+			
+			def output
+				if path = @options[:output]
+					File.open(path, "w")
+				else
+					$stdout
+				end
+			end
+			
+			nested :command, {
+				'scan' => Scan,
+				'analyze' => Analyze,
+				'verify' => Verify,
+				'compare' => Compare,
+				'duplicates' => Duplicates
+			}, default: 'analyze'
+			
+			def call
+				if @options[:version]
+					puts "fingerprint v#{VERSION}"
+				elsif @options[:help]
+					self.print_usage(program_name)
+				else
+					chdir do
+						@command.call
+					end
+				end
+			end
+		end
+	end
+end