hash-that-tree 0.0.9 → 0.1.0

data/.gitignore

@@ -1,19 +1,19 @@
-*.gem
-*.rbc
-.bundle
-.config
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-doc
-# YARD artifacts
-.yardoc
-_yardoc
-.project
-*~
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+doc
+# YARD artifacts
+.yardoc
+_yardoc
+.project
+*~

data/Gemfile.lock

@@ -1,17 +1,17 @@
-PATH
-  remote: .
-  specs:
-    hash-that-tree (0.0.8)
-      thor
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    thor (0.16.0)
-
-PLATFORMS
-  ruby
-  x86-mingw32
-
-DEPENDENCIES
-  hash-that-tree!
+PATH
+  remote: .
+  specs:
+    hash-that-tree (0.0.9)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    thor (0.16.0)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  hash-that-tree!

data/README.md

@@ -1,66 +1,69 @@
-#hash-that-tree
-A ruby command line app that compares the MD5 hashes of the files in different folders
-
-It allows the user to enter folder locations, then iterats through the files, creating and comparing the MD5 hashes of the files with the same name
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'hash-that-tree'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install hash-that-tree
-
-## Usage
-	# to view help	
-	hashthattree help
-	
-	# run the app on the test files
-	hashthattree compare spec/testfiles/1 spec/testfiles/2
-
-	
-## Creating Documentation
-	Run the following command to generate the documantation
-	
-	rdoc --exclude spec/testfiles
-
-## Create a gem
-	
-	Build and Test Locally
-	-gem build hash-that-tree.gemspec
-	-gem install hash-that-tree-X.X.X # where X.X.X is the version of the compiled gemspec
-	-hashthattree
-	
-	Build and deploy to rubygems.org
-	-gem update --system
-	-gem build hash-that-tree.gemspec
-	-gem push hash-that-tree-0.0.1.gem # where X.X.X is the version of the compiled gemspec
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-##References
-	
-	Looking into bundling with https://github.com/radar/guides/blob/master/gem-development.md
-	http://whatisthor.com/
-
-## TODO
-
-	I have a few items to do in upcoming releases
-	* Add Unit Tests
-	* Allow to be used as an API as well as a Command Line Tool
-	* Allow multiple folders to be specified
-	* Add folder recursion option
-	* Add SHA1 
-
+#hash-that-tree
+A ruby command line app that compares the MD5 hashes of the files in different folders
+
+It allows the user to enter folder locations, then iterats through the files, creating and comparing the MD5 hashes of the files with the same name
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hash-that-tree'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hash-that-tree
+
+## Usage
+	# to view help	
+	hashthattree help
+	
+	# run the app on the test files
+	hashthattree compare ./spec/testfiles/1 ./spec/testfiles/2
+	hashthattree compare ./spec/testfiles/1 ./spec/testfiles/2 csv
+	hashthattree compare ./spec/testfiles/1 ./spec/testfiles/2 html
+	hashthattree compare ./spec/testfiles/1 ./spec/testfiles/2 json
+
+	
+## Creating Documentation
+	Run the following command to generate the documantation
+	
+	rdoc --exclude spec/testfiles
+
+## Create a gem
+	
+	Build and Test Locally
+	-gem build hash-that-tree.gemspec
+	-gem install hash-that-tree-X.X.X # where X.X.X is the version of the compiled gemspec
+	-hashthattree
+	
+	Build and deploy to rubygems.org
+	-gem update --system
+	-gem build hash-that-tree.gemspec
+	-gem push hash-that-tree-0.0.1.gem # where X.X.X is the version of the compiled gemspec
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+##References
+	
+	Looking into bundling with https://github.com/radar/guides/blob/master/gem-development.md
+	http://whatisthor.com/
+
+## TODO
+
+	I have a few items to do in upcoming releases
+	* Add Unit Tests
+	* Allow to be used as an API as well as a Command Line Tool
+	* Allow multiple folders to be specified
+	* Add folder recursion option
+	* Add SHA1 
+

data/bin/hashthattree

@@ -1 +1 @@
-require_relative '../lib/cli'
+require_relative '../lib/cli'

data/hash-that-tree.gemspec

@@ -1,21 +1,22 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-Gem::Specification.new do |gem|
-  gem.name          = "hash-that-tree"
-  gem.version       = "0.0.9"
-  gem.authors       = ["John Ryan"]
-  gem.email         = ["555john@gmail.com"]
-  gem.description   = "Command line app that compares the MD5 hashes of the files in different folders"
-  gem.summary       = "Allows the user to enter folder locations iterating through the files, creating and comparing the MD5 hashes of the files with the same name"
-  gem.homepage      = "http://github.com/jnyryan/hash-that-tree"
-  gem.extra_rdoc_files = [    "LICENSE.txt",    "README.md"  ]
-  gem.files         = `git ls-files`.split($/)
-  #gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.file(f) }
-  gem.executable   = 'hashthattree'
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-  
-  gem.add_dependency "thor"
-end
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "hash-that-tree"
+  gem.version       = "0.1.0"
+  gem.authors       = ["John Ryan"]
+  gem.email         = ["555john@gmail.com"]
+  gem.description   = "Command line app that compares the MD5 hashes of the files in different folders"
+  gem.summary       = "Allows the user to enter folder locations iterating through the files, creating and comparing the MD5 hashes of the files with the same name"
+  gem.homepage      = "http://github.com/jnyryan/hash-that-tree"
+  gem.extra_rdoc_files = [    "LICENSE.txt",    "README.md"  ]
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executable   = 'hashthattree'
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.rdoc_options << '--title' << 'Rake -- Ruby Make' << '--main' << 'README' << '--line-numbers'
+  
+  gem.add_dependency "thor"
+end

data/lib/cli.rb

@@ -1,21 +1,19 @@
-require 'thor'
-require_relative 'compare'
-
-# Command Line Program that  takes two directories and creates a MD5 hash for every file contained within.<br/>
-# It then builds a result set that compares files with the same name and allows for them to be outputted
-# as a csv string
-module HashThatTree
-  class CLI < Thor
-  	option :recurse
-  
-    desc "compare FOLDER1 FOLDER2", "Create a hash of all files in the folders, compare them and output the results in CSV format"
-    def compare(folder1, folder2)
-      htt = CompareMD5.new(folder1, folder2)
-      htt.compare
-      htt.display_results       
-    end
-  end
-  
-  CLI.start(ARGV)
-  
+require 'thor'
+require_relative 'compare'
+
+# Command Line Program that  takes two directories and creates a MD5 hash for every file contained within.<br/>
+# It then builds a result set that compares files with the same name and allows for them to be outputted
+# as a csv string
+module HashThatTree
+  #This class controls the Command Line Interface
+  class CLI < Thor
+  	#Create a hash of all files in the folders, compare them and output the results in CSV format
+    desc "compare FOLDER1 FOLDER2", "Create a hash of all files in the folders, compare them and output the results in the specified format"
+    def compare(folder1, folder2, output=:csv)
+      htt = CompareMD5.new(folder1, folder2, output)
+      htt.compare
+      htt.display_results
+      end
+  end  
+  CLI.start(ARGV)
 end

data/lib/compare.rb

@@ -1,81 +1,120 @@
-require 'digest/md5'
-
-# Author::    John Ryan  (mailto:555john@gmail.com)
-# Copyright:: Copyright (c) 2012 John Ryan
-# License::   Distributes under the same terms as Ruby
-
-module HashThatTree
-  
-  # This class accepts two folders and provides methods to iterate
-  # through them creating a hash of each file within and can display 
-  # the results for analysis 
-
-	class CompareMD5
-    attr_accessor :folder1, :folder2
-	 
-	    #initialize the class with the folders to be compared
-  		def initialize(folder1, folder2)
-  			@folder1 = folder1
-  			@folder2 = folder2
-  			@filehash = Hash.new
-			validate
-		end
-	
-		
-		# Validates the input ensuring the arguments are both valid folders
-		def validate
-			if(folder1==nil) || (folder1=="") || !Dir.exists?(folder1)
-				puts "a valid folder path is required as argument 1"
-				exit
-			end
-					
-			if(folder2==nil) || (folder2=="")  || !Dir.exists?(folder2)
-				puts "a valid folder path is required as argument 2"
-				exit
-			end
-			
-		end
-		
-		# Iterates through the folders and creates a FileHashResults object containing the
-		# results of the comparisson
-		def compare
-			
-			Dir.foreach(@folder1) do |item|
-				next if item == '.' or item == '..'
-				the_hash = Digest::MD5.hexdigest(File.read(File.join(@folder1, item)))
-				item = item.downcase
-				filedata = FileHashResults.new(item, the_hash, nil)
-				@filehash[item] = filedata
-			end
-
-			Dir.foreach(@folder2) do |item|
-				next if item == '.' or item == '..'
-				the_hash = Digest::MD5.hexdigest(File.read(File.join(@folder2, item)))
-				item = item.downcase
-        if(@filehash[item]==nil)
-					filedata = FileHashResults.new(item, nil, the_hash)
-					@filehash[item] = filedata
-					next
-				end
-				@filehash[item.downcase].file_hash2 = the_hash	
-			end
-		end
-
-    #Dumps the contents of the FileHashResults object in csv form to standard out 
-		def display_results
-			puts "FileName,#{@folder1},#{@folder2},Are Equal"
-			@filehash.each{ |key, value| puts "#{value.file_name},#{value.file_hash1},#{value.file_hash2}, #{value.file_hash1==value.file_hash2}" }
-		end
-		
-	end
-	
-	#Container for the results of the file comparisson 
-	class FileHashResults
-   attr_accessor :file_name, :file_hash1, :file_hash2
-   def initialize(file_name, file_hash1, file_hash2)
-    @file_name = file_name
-    @file_hash1 = file_hash1
-    @file_hash2 = file_hash2
-    end
-  end
-end
+require 'digest/md5'
+
+# Author::    John Ryan  (mailto:555john@gmail.com)
+# Copyright:: Copyright (c) 2012 John Ryan
+# License::   Distributes under the same terms as Ruby
+
+module HashThatTree
+  
+  # This class accepts two folders and provides methods to iterate
+  # through them creating a hash of each file within and can display 
+  # the results for analysis 
+	class CompareMD5
+    attr_accessor :folder1 #path to folder containing files to hash
+    attr_accessor :folder2 #path to folder containing files to hash to be compared to folder1
+	  attr_accessor :format  #the format to output the results to. csv, html or json
+	   
+	   #initialize the class with the folders to be compared
+  	 def initialize(folder1, folder2, format)
+  	   @folder1 = folder1
+  	   @folder2 = folder2
+  	   @format = format
+  	   @filehash = Hash.new
+			 validate
+		end
+	
+		
+		# Validates the input ensuring the arguments are both valid folders
+		def validate
+			if(folder1==nil) || (folder1=="") || !Dir.exists?(folder1)
+				puts "a valid folder path is required as argument 1"
+				exit
+			end
+					
+			if(folder2==nil) || (folder2=="")  || !Dir.exists?(folder2)
+				puts "a valid folder path is required as argument 2"
+				exit
+			end
+			
+		end
+		
+		# Iterates through the folders and creates a FileHashResults object containing the
+		# results of the comparisson
+		def compare
+			
+			Dir.foreach(@folder1) do |item|
+				begin
+  				next if item == '.' or item == '..'
+  				fullfilename = File.expand_path(@folder1, item)
+  				the_hash = Digest::MD5.hexdigest(File.read(File.join(File.expand_path(@folder1), item)))
+  				item = item.downcase
+  				filedata = FileHashResults.new(item, the_hash, nil)
+  				@filehash[item] = filedata
+  			rescue
+  			  #puts "Skipped:#{item.inspect}"
+  			end
+			end
+
+			Dir.foreach(@folder2) do |item|
+			  begin
+  				next if item == '.' or item == '..'
+  				the_hash = Digest::MD5.hexdigest(File.read(File.join(@folder2, item)))
+  				item = item.downcase
+          if(@filehash[item]==nil)
+  					filedata = FileHashResults.new(item, nil, the_hash)
+  					@filehash[item] = filedata
+  					next
+  				end
+  				@filehash[item.downcase].file_hash2 = the_hash
+  			rescue
+          #puts "Skipped:#{item.inspect}"
+        end	
+			end
+		end
+
+    #print the contents of the FileHashResults object standard out in the format specified. Default is csv
+		def display_results()
+		   case @format
+        when "csv"
+          display_results_csv
+        when "html"
+          display_results_html
+        when "json"
+          display_results_json
+        else
+          display_results_csv
+        end
+    end
+    
+    #Prints the results to standard out in the csv format specified.
+		def display_results_csv
+			puts "FileName,#{@folder1},#{@folder2},Are Equal"
+			@filehash.each{ |key, value| puts "#{value.file_name},#{value.file_hash1},#{value.file_hash2}, #{value.file_hash1==value.file_hash2}" }
+		end
+		
+		#Prints the results to standard out in the csv format specified.
+    def display_results_html
+		  output ="<!DOCTYPE html><html xmlns=\"http://www.w3.org/1999/xhtml\"><head><title></title></head><body>"
+		  output.concat("<table><thead><tr><td>FileName</td></tr><tr><td>#{@folder1}</td></tr><tr><td>#{@folder2}</td></tr><tr><td>Equal</td></tr></thead>")
+      @filehash.each{ |key, value| output.concat("<tbody><tr><td>#{value.file_name}</td></tr><tr><td>#{value.file_hash1}</td></tr><tr><td>#{value.file_hash2}</td></tr><tr><td>#{value.file_hash1==value.file_hash2}</td></tr>")}
+      output.concat("</tbody></table></body></html>")
+      puts output
+    end
+    
+    #Prints the results to standard out in the csv format specified.
+    def display_results_json
+      puts @filehash 
+    end
+		
+	end
+	
+	#Container for the results of the file comparisson 
+	class FileHashResults
+   attr_accessor :file_name, :file_hash1, :file_hash2
+   def initialize(file_name, file_hash1, file_hash2)
+    @file_name = file_name
+    @file_hash1 = file_hash1
+    @file_hash2 = file_hash2
+    end
+  end
+end

data/spec/testfiles/1/file3.txt

@@ -1 +1 @@
-hello
+hello

data/spec/testfiles/1/file4.txt

@@ -1 +1 @@
-hello
+hello

data/spec/testfiles/2/file3.txt

@@ -1,2 +1,2 @@
-hello
-Hello
+hello
+Hello

data/spec/testfiles/2/file4.txt

@@ -1,2 +1,2 @@
-hello
-goodbye
+hello
+goodbye

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash-that-tree
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -48,43 +48,6 @@ files:
 - hash-that-tree.gemspec
 - lib/cli.rb
 - lib/compare.rb
-- spec/doc/created.rid
-- spec/doc/images/brick.png
-- spec/doc/images/brick_link.png
-- spec/doc/images/bug.png
-- spec/doc/images/bullet_black.png
-- spec/doc/images/bullet_toggle_minus.png
-- spec/doc/images/bullet_toggle_plus.png
-- spec/doc/images/date.png
-- spec/doc/images/find.png
-- spec/doc/images/loadingAnimation.gif
-- spec/doc/images/macFFBgHack.png
-- spec/doc/images/package.png
-- spec/doc/images/page_green.png
-- spec/doc/images/page_white_text.png
-- spec/doc/images/page_white_width.png
-- spec/doc/images/plugin.png
-- spec/doc/images/ruby.png
-- spec/doc/images/tag_green.png
-- spec/doc/images/wrench.png
-- spec/doc/images/wrench_orange.png
-- spec/doc/images/zoom.png
-- spec/doc/index.html
-- spec/doc/js/darkfish.js
-- spec/doc/js/jquery.js
-- spec/doc/js/quicksearch.js
-- spec/doc/js/thickbox-compressed.js
-- spec/doc/rdoc.css
-- spec/doc/testfiles/1/file1_txt.html
-- spec/doc/testfiles/1/file2_txt.html
-- spec/doc/testfiles/1/file3_txt.html
-- spec/doc/testfiles/1/file4_txt.html
-- spec/doc/testfiles/2/file1_txt.html
-- spec/doc/testfiles/2/file2_txt.html
-- spec/doc/testfiles/2/file3_txt.html
-- spec/doc/testfiles/2/file4_txt.html
-- spec/doc/testfiles/2/fileA_txt.html
-- spec/doc/testfiles/2/fileB_txt.html
 - spec/testfiles/1/file1.txt
 - spec/testfiles/1/file2.txt
 - spec/testfiles/1/file3.txt
@@ -98,7 +61,12 @@ files:
 homepage: http://github.com/jnyryan/hash-that-tree
 licenses: []
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --title
+- Rake -- Ruby Make
+- --main
+- README
+- --line-numbers
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -121,43 +89,6 @@ specification_version: 3
 summary: Allows the user to enter folder locations iterating through the files, creating
   and comparing the MD5 hashes of the files with the same name
 test_files:
-- spec/doc/created.rid
-- spec/doc/images/brick.png
-- spec/doc/images/brick_link.png
-- spec/doc/images/bug.png
-- spec/doc/images/bullet_black.png
-- spec/doc/images/bullet_toggle_minus.png
-- spec/doc/images/bullet_toggle_plus.png
-- spec/doc/images/date.png
-- spec/doc/images/find.png
-- spec/doc/images/loadingAnimation.gif
-- spec/doc/images/macFFBgHack.png
-- spec/doc/images/package.png
-- spec/doc/images/page_green.png
-- spec/doc/images/page_white_text.png
-- spec/doc/images/page_white_width.png
-- spec/doc/images/plugin.png
-- spec/doc/images/ruby.png
-- spec/doc/images/tag_green.png
-- spec/doc/images/wrench.png
-- spec/doc/images/wrench_orange.png
-- spec/doc/images/zoom.png
-- spec/doc/index.html
-- spec/doc/js/darkfish.js
-- spec/doc/js/jquery.js
-- spec/doc/js/quicksearch.js
-- spec/doc/js/thickbox-compressed.js
-- spec/doc/rdoc.css
-- spec/doc/testfiles/1/file1_txt.html
-- spec/doc/testfiles/1/file2_txt.html
-- spec/doc/testfiles/1/file3_txt.html
-- spec/doc/testfiles/1/file4_txt.html
-- spec/doc/testfiles/2/file1_txt.html
-- spec/doc/testfiles/2/file2_txt.html
-- spec/doc/testfiles/2/file3_txt.html
-- spec/doc/testfiles/2/file4_txt.html
-- spec/doc/testfiles/2/fileA_txt.html
-- spec/doc/testfiles/2/fileB_txt.html
 - spec/testfiles/1/file1.txt
 - spec/testfiles/1/file2.txt
 - spec/testfiles/1/file3.txt

data/spec/doc/created.rid

@@ -1,11 +0,0 @@
-Mon, 05 Nov 2012 10:44:16 +0000
-./testfiles/2/file3.txt	Mon, 05 Nov 2012 10:07:10 +0000
-./testfiles/2/fileA.txt	Mon, 05 Nov 2012 10:07:28 +0000
-./testfiles/2/file1.txt	Mon, 05 Nov 2012 10:05:23 +0000
-./testfiles/2/file2.txt	Mon, 05 Nov 2012 10:05:23 +0000
-./testfiles/2/file4.txt	Mon, 05 Nov 2012 10:07:22 +0000
-./testfiles/2/fileB.txt	Mon, 05 Nov 2012 10:07:28 +0000
-./testfiles/1/file3.txt	Mon, 05 Nov 2012 10:06:38 +0000
-./testfiles/1/file1.txt	Mon, 05 Nov 2012 10:05:23 +0000
-./testfiles/1/file2.txt	Mon, 05 Nov 2012 10:05:23 +0000
-./testfiles/1/file4.txt	Mon, 05 Nov 2012 10:06:44 +0000