huffman 0.0.1

data/spec/lib/huffman_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper.rb"
+
+module Huffman
+	describe "HuffmanCoder" do 
+		it "decode an encoded string and get back the original string" do
+			 txt = "La vie est un long fleuve tranquille avec des impasses, des courants de mer"	
+	  		 encoded_text, dictionnary = Huffman.encode_text(txt)
+	  		 new_txt = Huffman.decode_text(encoded_text,dictionnary)
+	  		 new_txt.should == txt
+		end
+
+		it "decode an encoded file and get back the original file" do
+			
+			file_name = "spec/data/miserables.txt"  
+			original_content = File.read(file_name)
+			Huffman.encode_file(file_name)
+			Huffman.decode_file(file_name+".huffman-encoded",file_name+".huffman-dictionnary")
+			original_content_after_decoding = File.read(file_name+".huffman-encoded-back-to-original")
+			original_content.should == original_content_after_decoding		 
+		end
+	end	
+end

data/spec/lib/letter_frequency_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper.rb"
+
+describe "LetterFrequency" do 
+
+	it "get the sorted frequencies of the characters of a text" do
+
+		# Create an hash (associative array) with random letters frequencies
+		#
+		# a => 1
+		# b => 8
+		# c => 9
+
+		frequencies = {} 
+		('a'..'z').each{|c| frequencies[c] = rand(1..100) }
+		# Create a string from the frequencies hash
+		txt = frequencies.map{|letter,freq| letter*freq}.join.split('').shuffle.join
+		# Test
+		# On tries les frequences pour pouvoir comparer les hashs
+		Huffman::LetterFrequency.get_frequencies(txt).sort_by{|h| [h[1], h[0]]}.should == frequencies.sort_by{|h| [h[1], h[0]]}
+
+	end
+
+end

data/spec/lib/node_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper.rb"
+
+module Huffman
+
+	describe Node do 
+
+		context "with a particular binary tree" do
+			# We consider the tree example in the Readme
+			# 	      1
+			# 	   /     \
+			# 	  2       3
+			#    / \       \ 	
+			# 	4	5	    6	
+			# 	   / \     /
+			# 	  7   8   9
+
+			# Left part 
+			n7 = Node.new(7)
+			n8 = Node.new(8)
+			n5 = Node.new(5,nil,n7,n8)
+			n4 = Node.new(4)
+			n2 = Node.new(2,nil,n4,n5)
+			# Right part
+			n9 = Node.new(9,nil)
+			n6 = Node.new(6,nil,n9)
+			n3 = Node.new(3,nil,nil,n6)
+			# Tree
+			tree = Node.new(1,nil,n2,n3)
+
+			it "can be visited by the preorder algorithm" do 
+				tree.visit_and_map(:preorder){|node| node.value}.should == [1, 2, 4, 5, 7, 8, 3, 6, 9] 
+			end
+			it "can be visited by the inorder algorithm" do
+			 tree.visit_and_map(:inorder){|node| node.value}.should == [4, 2, 7, 5, 8, 1, 3, 9, 6] 
+			end
+			it "can be visited by the postorder algorithm" do
+			 tree.visit_and_map(:postorder){|node| node.value}.should == [4, 7, 8, 5, 2, 9, 6, 3, 1] 
+			end
+
+		end
+	end
+	
+end

data/spec/lib/tree_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper.rb"
+
+module Huffman
+	describe Tree do 
+		context "with an expected binary tree" do
+			txt = "ABBCCCDDDEEEEE"
+			# Fréquences : A1 B2 C3 D3 E5
+			frequencies = LetterFrequency.get_frequencies(txt)
+			tree = Tree.new(frequencies)
+			# 	     14
+			# 	   /    \
+			# 	  6      8
+			#    / \    / \ 	
+			# 	3	3  3   5	
+			# 	   / \     
+			# 	  1   2   
+			node3 = Node.new(3,nil,Node.new(1),Node.new(2))
+			node6 = Node.new(6,nil,Node.new(3),node3) 
+			node8 = Node.new(8,nil,Node.new(3),Node.new(5))
+			expected_tree = Node.new(14,nil,node6,node8)
+
+			xit "build a tree from frequencies" do
+				tree.visit_and_map(:postorder){|node| node.value}.should == expected_tree.visit_and_map(:postorder){|node| node.value}
+			
+				# Important, en fait il est difficile et plus compliquer de comparer deux arbres binaires
+				# dans le contexte d'un codage de Huffman
+				# Car deux arbres peuvent êtres structurellement différents mais pareil pour le codage de Huffman
+				# Cela dépend donc dans quel ordre a été triés les noeuds de même valeur
+				# Celà influence sur la structure de l'arbre
+			end
+
+			it "build and get the right dictionnary" do
+				dict = tree.dictionnary
+
+				#expected_dict = {"00"=>"C", "01"=>"D", "100"=>"A", "101"=>"B", "11"=>"E"}
+				expected_dict = {"00"=>"C", "010"=>"A", "011"=>"B", "10"=>"D", "11"=>"E"}
+				dict.should == expected_dict
+			end
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require "huffman.rb"
+#require 'simplecov'
+#SimpleCov.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: huffman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Lagrange
+- Bastien Jorge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: PriorityQueue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem allow you to encode and decode a text using the Huffman encoding
+  compression algorithm. It can also generate and visualize the huffman tree as a
+  png file.
+email:
+- lagrangemartin@gmail.com
+- bastien.jorge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitattributes
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- huffman.gemspec
+- lib/.DS_Store
+- lib/huffman.rb
+- lib/huffman/binary_stream.rb
+- lib/huffman/letter_frequency.rb
+- lib/huffman/log.rb
+- lib/huffman/node.rb
+- lib/huffman/tree.rb
+- lib/huffman/version.rb
+- spec/.DS_Store
+- spec/data/.DS_Store
+- spec/data/miserables.txt
+- spec/data/miserables.txt.huffman-dictionnary
+- spec/data/miserables.txt.huffman-encoded
+- spec/data/miserables.txt.huffman-encoded-back-to-original
+- spec/lib/huffman_spec.rb
+- spec/lib/letter_frequency_spec.rb
+- spec/lib/node_spec.rb
+- spec/lib/tree_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/lagrangemartin/huffman
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Encode and decode a text using the Huffman encoding compression algorithm.
+test_files:
+- spec/.DS_Store
+- spec/data/.DS_Store
+- spec/data/miserables.txt
+- spec/data/miserables.txt.huffman-dictionnary
+- spec/data/miserables.txt.huffman-encoded
+- spec/data/miserables.txt.huffman-encoded-back-to-original
+- spec/lib/huffman_spec.rb
+- spec/lib/letter_frequency_spec.rb
+- spec/lib/node_spec.rb
+- spec/lib/tree_spec.rb
+- spec/spec_helper.rb