hash-that-tree 0.1.2 → 0.1.4

data/Gemfile.lock

@@ -1,13 +1,17 @@
 PATH
   remote: .
   specs:
-    hash-that-tree (0.0.9)
+    hash-that-tree (0.1.4)
+      mustache
       thor
+      yard
 
 GEM
   remote: https://rubygems.org/
   specs:
+    mustache (0.99.4)
     thor (0.16.0)
+    yard (0.8.3)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,7 +1,27 @@
 #hash-that-tree
-A ruby command line app that compares the MD5 hashes of the files in different folders
+A ruby command line app prints the MD5 hashes all of the files in an array of folders. 
+The output can be in standard text, csv, html or json. 
 
-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
+Also has a compare functionthat takes 2 folder, then iterates through the files and comparing the MD5 hashes of the files with the same name
+
+## Usage
+	# to view help	
+	hashthattree help
+	
+	# Get the hash of all files in a folder (with optional formatting)
+	hashthattree hashit ./spec/testfiles/1 
+	hashthattree hashit ./spec/testfiles/1 -o=csv
+	hashthattree hashit ./spec/testfiles/1 -o=html
+	hashthattree hashit ./spec/testfiles/1 -o=json
+	
+	# Get the hash of all files in multiple folders 
+	hashthattree hashit ./spec/testfiles/1 
+	
+	# run the app on the test files in two folders (this will soon be depreciated)
+	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
 
 ## Installation
 
@@ -17,17 +37,6 @@ 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
 	
@@ -63,7 +72,6 @@ Or install it yourself as:
 	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/hash-that-tree.gemspec

@@ -4,11 +4,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = %q{hash-that-tree}
-  gem.version       = "0.1.2"
+  gem.version       = "0.1.4"
   gem.authors       = ["John Ryan"]
   gem.email         = ["555john@gmail.com"]
-  gem.description   = %q{Command line app that compares the MD5 hashes of the files in different folders}
-  gem.summary       = %q{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.description   = %q{Command line app that produces the MD5 hash of all files in a set of folders}
+  gem.summary       = %q{A ruby command line app prints the MD5 hashes all of the files in an array of folders, the output can be in standard text, csv, html or json}
   gem.homepage      = %q{http://github.com/jnyryan/hash-that-tree}
   
   gem.extra_rdoc_files = ["LICENSE.txt","README.md"  ]
@@ -20,7 +20,8 @@ Gem::Specification.new do |gem|
   
   gem.rdoc_options << '--exclude spec/testfiles'
   
-  gem.add_dependency "redcarpet"
+  gem.add_dependency "mustache"
   gem.add_dependency "thor"
   gem.add_dependency "yard"
+  
 end

data/lib/cli.rb

@@ -1,7 +1,9 @@
 require 'thor'
 require_relative 'compare'
+require_relative 'hashit'
+require_relative 'display'
 
-# Command Line Program that  takes two directories and creates a MD5 hash for every file contained within.<br/>
+# Command Line Program that  takes multiple 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
@@ -9,11 +11,26 @@ module HashThatTree
   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)
+    method_option :output, :aliases => "-o", :default => :csv, :desc => "Choose the format to display the results in - csv, json or html"
+    def compare(folder1, folder2)
+      htt = CompareMD5.new(folder1, folder2, options)
       htt.compare
       htt.display_results
-      end
+    end
+    
+    desc "hashit FOLDERS", "Create a hash of all files in all folders supplied and display as standard, json, csv or html"
+    method_option :errors, :aliases => "-e", :type => :boolean, :default => false, :desc => "true = display files that could not be processed, false = do not display skipped files"
+    #method_option :hashtype, :aliases => "-h", :default => "cmd5", :desc => "Choose the hash algorithm to use - md5 or sha"
+    method_option :output, :aliases => "-o", :default => "standard", :desc => "Choose the format to display the results in - standard(default), csv, json or html"
+    #method_option :recursive, :aliases => "-r", :type => :boolean, :default => "false", :desc => "true = recurse through sub directories, false = only do top directory"
+    def hashit(*folders)
+      htt = HashIt.new(options, folders)
+      htt.create_hash_results
+      dis = Display.new(options, htt.error_data, htt.file_data)
+      dis.display_results()
+    end
+    
   end  
-  CLI.start(ARGV)
+  #CLI.start(ARGV)
+  CLI.start()
 end

data/lib/compare.rb

@@ -15,10 +15,10 @@ module HashThatTree
 	  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)
+  	 def initialize(folder1, folder2, options)
   	   @folder1 = folder1
   	   @folder2 = folder2
-  	   @format = format
+  	   @format = options['output']
   	   @filehash = Hash.new
 			 validate
 		end

data/lib/display.rb

@@ -0,0 +1,73 @@
+require 'digest/md5'
+require 'mustache'
+require 'json'
+require_relative '../templates/displaytemplates'
+
+# Author::    John Ryan  (mailto:555john@gmail.com)
+# Copyright:: Copyright (c) 2012 John Ryan
+# License::   Distributes under the same terms as Ruby
+module HashThatTree
+  
+	class Display
+    attr_accessor :format  #the format to output the results to. csv, html or json
+    attr_accessor :file_data #array of files and associated hashes
+    attr_accessor :error_data #array of files that could not be processed
+     
+	   #initialize the class with the folders to be compared
+  	 def initialize(options, error_data, *file_data )
+  	   @format = options['output']
+  	   @displayerrors = options['errors']
+  	   @file_data = file_data
+  	   @error_data = error_data
+  	   p @error_data
+		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_std
+        end
+    end
+    
+    #Prints the results to standard out in the csv format specified.
+    def display_results_std
+      puts Mustache.render(StandardTemplate,  :filedetails => @file_data[0]);
+      if(@displayerrors)
+        puts Mustache.render(StandardTemplate,  :errordetails => @error_data[0]);
+      end
+    end
+    
+    #Prints the results to standard out in the csv format specified.
+		def display_results_csv
+      puts Mustache.render(CsvTemplate,  :filedetails => @file_data[0]);
+      if(@displayerrors)
+        puts Mustache.render(CsvTemplate,  :filedetails => @error_data[0]);
+      end
+		end
+		
+		#Prints the results to standard out in the csv format specified.
+    def display_results_html
+		  puts Mustache.render(HtmlTemplate,  :filedetails => @file_data[0]);
+      if(@displayerrors)
+        puts Mustache.render(HtmlTemplate,  :filedetails => @error_data[0]);
+      end
+    end
+    
+    #Prints the results to standard out in the csv format specified.
+    def display_results_json
+      puts JSON.pretty_generate(@file_data) 
+      if(@displayerrors)
+        puts JSON.pretty_generate(@error_data) 
+      end
+    end
+		
+	end
+end

data/lib/hashit.rb

@@ -0,0 +1,53 @@
+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 a folder array and provides methods to iterate
+  # through all files in the folder creating a hash of each file within.
+  # The results are displayed to Standard Out in csv, html, json or standard format 
+	class HashIt
+    attr_accessor :format         #the format to output the results to - standard, csv, html or json
+    attr_accessor :folders        #path to folder containing files to hash
+    attr_accessor :file_data      #the container for the hashing results
+    attr_accessor :error_data   #the container for the files that could not be processed
+     
+	   #initialize the class with the folders to be processed
+  	 def initialize(options, folders )
+  	   @format = options['output']
+  	   @folders = folders
+  	   @file_data = []
+  	   @error_data = []
+			 validate
+		end
+		
+		# Validates the supplied folders ensuring they exist
+		def validate
+			@folders.each do |item|
+        if(item==nil) || (item=="") || !Dir.exists?(item)
+          puts "a valid folder path is required as argument #{item}"
+          exit
+        end
+      end
+		end
+		
+		# Iterates through the folders and creates a FileHashResults object containing the
+    # results of the comparisson
+    def create_hash_results
+      
+      @folders.each do |folder|
+        Dir.foreach(folder) do |item|
+          begin
+            next if item == '.' or item == '..'
+            fullfilename = File.expand_path(folder, item)
+            the_hash = Digest::MD5.hexdigest(File.read(File.join(File.expand_path(folder), item.downcase)))
+            @file_data << {:filename=>item, :folder=>folder, :filehash => the_hash}
+          rescue
+            @error_data << {:error=>"Skipped#{File.expand_path(folder, item)}"}
+          end
+        end
+      end
+    end
+	end 
+end

data/templates/displaytemplates.rb

@@ -0,0 +1,38 @@
+StandardTemplate =<<-TEMPLATE
+File Hash\t\t\t\tFile Name\t\t\tFolder
+{{#filedetails}}
+{{filehash}}\t{{filename}}\t\t{{folder}}
+{{/filedetails}} 
+TEMPLATE
+
+HtmlTemplate =<<-TEMPLATE
+<!DOCTYPE html>
+<html xmlns=\"http://www.w3.org/1999/xhtml\">
+  <head>
+    <title></title>
+  </head>
+  <body>
+        <table>
+            <tr>
+                  <th>File Hash</th>
+                  <th>File Name</th>
+                  <th>Folder</th>
+            </tr>
+           {{#filedetails}}
+            <tr>
+                 <td>{{filehash}}</td>
+                 <td>{{filename}}</td>
+                 <td>{{folder}}</td>
+            </tr>
+            {{/filedetails}} 
+        </table>
+  </body>
+</html>    
+TEMPLATE
+
+CsvTemplate=<<-TEMPLATE
+File Hash,File Name,Folder,
+{{#filedetails}}
+{{filehash}},{{filename}},{{folder}},
+{{/filedetails}} 
+TEMPLATE

data/test.htm

@@ -0,0 +1,94 @@
+"./spec/testfiles/1"
+"./spec/testfiles/2"
+Skipped:"fileA.txt"
+Skipped:"fileB.txt"
+Skipped:"fileA.txt"
+Skipped:"fileB.txt"
+        <table>
+            <tr>
+                  <th>File Name</th>
+                  <th>Folder</th>
+                  <th>File Hash</th>
+            </tr>
+            <tr>
+                 <td>file3.txt</td>
+                 <td>./spec/testfiles/1</td>
+                 <td>b1946ac92492d2347c6235b4d2611184</td>
+            </tr>
+            <tr>
+                 <td>file1.txt</td>
+                 <td>./spec/testfiles/1</td>
+                 <td>d41d8cd98f00b204e9800998ecf8427e</td>
+            </tr>
+            <tr>
+                 <td>file2.txt</td>
+                 <td>./spec/testfiles/1</td>
+                 <td>d41d8cd98f00b204e9800998ecf8427e</td>
+            </tr>
+            <tr>
+                 <td>file4.txt</td>
+                 <td>./spec/testfiles/1</td>
+                 <td>b1946ac92492d2347c6235b4d2611184</td>
+            </tr>
+            <tr>
+                 <td>file3.txt</td>
+                 <td>./spec/testfiles/2</td>
+                 <td>d164cd9dcf2b16147c4fe8ca3db49a45</td>
+            </tr>
+            <tr>
+                 <td>file1.txt</td>
+                 <td>./spec/testfiles/2</td>
+                 <td>d41d8cd98f00b204e9800998ecf8427e</td>
+            </tr>
+            <tr>
+                 <td>file2.txt</td>
+                 <td>./spec/testfiles/2</td>
+                 <td>d41d8cd98f00b204e9800998ecf8427e</td>
+            </tr>
+            <tr>
+                 <td>file4.txt</td>
+                 <td>./spec/testfiles/2</td>
+                 <td>6e175f736c6eb485932e8f3b8fda535a</td>
+            </tr>
+            <tr>
+                 <td>file3.txt</td>
+                 <td>./spec/testfiles/1</td>
+                 <td>b1946ac92492d2347c6235b4d2611184</td>
+            </tr>
+            <tr>
+                 <td>file1.txt</td>
+                 <td>./spec/testfiles/1</td>
+                 <td>d41d8cd98f00b204e9800998ecf8427e</td>
+            </tr>
+            <tr>
+                 <td>file2.txt</td>
+                 <td>./spec/testfiles/1</td>
+                 <td>d41d8cd98f00b204e9800998ecf8427e</td>
+            </tr>
+            <tr>
+                 <td>file4.txt</td>
+                 <td>./spec/testfiles/1</td>
+                 <td>b1946ac92492d2347c6235b4d2611184</td>
+            </tr>
+            <tr>
+                 <td>file3.txt</td>
+                 <td>./spec/testfiles/2</td>
+                 <td>d164cd9dcf2b16147c4fe8ca3db49a45</td>
+            </tr>
+            <tr>
+                 <td>file1.txt</td>
+                 <td>./spec/testfiles/2</td>
+                 <td>d41d8cd98f00b204e9800998ecf8427e</td>
+            </tr>
+            <tr>
+                 <td>file2.txt</td>
+                 <td>./spec/testfiles/2</td>
+                 <td>d41d8cd98f00b204e9800998ecf8427e</td>
+            </tr>
+            <tr>
+                 <td>file4.txt</td>
+                 <td>./spec/testfiles/2</td>
+                 <td>6e175f736c6eb485932e8f3b8fda535a</td>
+            </tr>
+ 
+        </table>        

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash-that-tree
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: mustache
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -59,7 +59,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Command line app that compares the MD5 hashes of the files in different
+description: Command line app that produces the MD5 hash of all files in a set of
   folders
 email:
 - 555john@gmail.com
@@ -80,6 +80,8 @@ files:
 - hash-that-tree.gemspec
 - lib/cli.rb
 - lib/compare.rb
+- lib/display.rb
+- lib/hashit.rb
 - spec/testfiles/1/file1.txt
 - spec/testfiles/1/file2.txt
 - spec/testfiles/1/file3.txt
@@ -90,6 +92,8 @@ files:
 - spec/testfiles/2/file4.txt
 - spec/testfiles/2/fileA.txt
 - spec/testfiles/2/fileB.txt
+- templates/displaytemplates.rb
+- test.htm
 homepage: http://github.com/jnyryan/hash-that-tree
 licenses: []
 post_install_message: 
@@ -114,8 +118,8 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 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
+summary: A ruby command line app prints the MD5 hashes all of the files in an array
+  of folders, the output can be in standard text, csv, html or json
 test_files:
 - spec/testfiles/1/file1.txt
 - spec/testfiles/1/file2.txt