rhash 0.0.1 → 0.0.3

data/lib/rhash.rb

@@ -14,18 +14,51 @@ class Info
 end
 	
 class RHash
+	#
+	# Returns a new, empty RHash.
+	# If a block is specified, it will be called with the RHash object and the key, 
+	# and should return the default value. It is the block‘s responsibility to 
+	# store the value in the RHash if required.
+	#
 	def initialize(&block)
 		@hash = []
+		@default = nil
 		@default = block if block_given?
 	end
 	
+	#
+	# Returns value corresponding to key. 
+	# If the key wasn't found, an IndexError exception will be raised.
+	#
+	#  my_hash = RHash.new
+	#
+	#  my_hash["cow"] = "mooo..." 
+	#
+	#  my_hash["cow"]               #=> "mooo..."
+	#
+	#  my_hash["chick"]             #=> nil
+	#
 	def [] key
 		@hash.each do |info|
 			return info.value if key == info.key
 		end
-		raise "Hash não possui key '#{key}'"
+		(@default.is_a? Proc)? @default.call : @default  
 	end	
 	
+	#
+	# Associates the value given by value with the key given by key.
+	# If already exists a key then key value will be updated.
+	#
+	#  my_hash = RHash.new
+	#
+	#  my_hash["cow"] = "mooo..."
+	#
+	#  my_hash["cow"]               #=> "mooo..."
+	#
+	#  my_hash["cow"] = "cocó..."
+	#
+	#  my_hash["cow"]               #=> "cocó..."
+	#
 	def []= key, value
 		info = Info.new
 		info.key = key
@@ -38,6 +71,9 @@ class RHash
 		end
 	end	
 	
+	#
+	# Return the contents of this hash as a string.
+	#
 	def inspect		
 		msg = '{'
 		@hash.each_with_index do |info, index|
@@ -48,71 +84,113 @@ class RHash
 		msg
 	end
 	
-	def sort
-		int_sort
+	#
+	# Returns a RHash orderned by key name or block.
+	# If block is given using Array#sort else sort by name.
+	#
+	def sort(&block)
+		sort_rhash = RHash.new
+		int_sort(&block).each do |info|
+			sort_rhash[info[0]] = info[1]
+		end
+		sort_rhash
 	end
 	
-	def sort!
-		new_hash = int_sort
-		@hash = new_hash
-		@hash
+	#
+	# Sorts self.
+	# If block is given using Array#sort else sort by name.
+	#
+	def sort!(&block)
+		sort_hash = int_sort(&block)
+		clear
+		sort_hash.each do |info|
+			self[info[0]] = info[1]
+		end
 	end	
 	
+	#
+	# Orderned RHash and calls block once for each key in RHash,
+	# passing the key and value to the block as a two-element array
+	#
 	def sort_each(&block)
 		new_hash = int_sort
 		new_hash.each do |info|
-			yield info if block_given?
+			yield [info.key, info.value] if block_given?
 		end
 	end
 	
+	#
+	# See Hash::each
+	#
 	def each(&block)
 		@hash.each do |info|
-			yield info if block_given?
+			yield [info.key, info.value] if block_given?
 		end
 	end
 	
+	#
+	# See Hash::each_pair
+	#
 	def each_pair(&block)
 		@hash.each do |info|
 			yield info.key, info.value if block_given?
 		end
 	end	
 	
+	#
+	# See Hash::each_value
+	#
 	def each_value(&block)
 		array(:value).each do |value|
 			yield value if block_given?
 		end	
 	end	
 	
+	#
+	# See Hash::each_key
+	#
 	def each_key(&block)
 		array(:key).each do |value|
 			yield value if block_given?
 		end	
 	end	
 	
+	#
+	# See Hash::select
+	#		
 	def select(&block)
 		selected_entries = []
 		@hash.each do |info|
 			if block_given?
 				if yield info 
-					selected_entries << info
+					selected_entries << [info.key, info.value]
 				end
 			end
 		end
 		selected_entries
 	end	
 	
+	#
+	# See Hash::keys
+	#
 	def keys
 		new_array = []
 		@hash.each{|info| new_array << info.key}
 		new_array
 	end	
 	
+	#
+	# See Hash::values
+	#
 	def values	
 		new_array = []
 		@hash.each{|info| new_array << info.value}
 		new_array
 	end	
 	
+	#
+	# See Hash::key?
+	#
 	def has_key?(key)
 		@hash.each{|info| return true if info.key == key}
 		false
@@ -120,16 +198,25 @@ class RHash
 	alias :key? :has_key?
 	alias :member? :has_key?
 	
+	#
+	# See Hash::value?
+	#
 	def has_value?(value)
 		@hash.each{|info| return true if info.value == value}
 		false
 	end		
 	alias :value? :has_value?
 	
+	#
+	# See Hash::delete_if
+	#
 	def delete_if(&block)
 		@hash.delete_if{|info| yield info.key, info.value if block_given?}
 	end
 	
+	#
+	# See Hash::delete
+	#
 	def delete(key, &block)
 		deleted = nil
 		@hash.delete_if{|info| info.key == key; deleted = info if info.key == key}
@@ -137,11 +224,18 @@ class RHash
 		return "Deleted: #{deleted.key.inspect} => #{deleted.value.inspect}" if deleted
 	end
 	
+	#
+	# See Hash::size
+	#
 	def size
 		@hash.size
 	end
+	
 	alias :length :size
 		
+	#
+	# See Hash::invert
+	#	
 	def invert
 		new_hash = RHash.new
 		@hash.each do |i|
@@ -149,11 +243,17 @@ class RHash
 		end
 		new_hash
 	end
-	
+
+	#
+	# See RHash::inspect
+	#	
 	def to_s
 		inspect
 	end
 	
+	#
+	# See Hash::merge
+	#	
 	def merge(rhash)
 		new_hash = RHash.new
 		raise "Não é uma Hash ou RHash" unless rhash.is_a? RHash or rhash.is_a? Hash
@@ -176,6 +276,9 @@ class RHash
 		new_hash
 	end	
 	
+	#
+	# See Hash::merge!
+	#	
 	def merge!(rhash)
 		raise "Não é uma Hash ou RHash" unless rhash.is_a? RHash or rhash.is_a? Hash
 		if rhash.is_a? RHash
@@ -189,14 +292,24 @@ class RHash
 		end
 	end
 	
+	#
+	# Returns an array with first key and value found in RHash. 
+	#
 	def first
-		@hash.first
+		first = @hash.first
+		[first.key, first.value]
 	end
 	
+	#
+	# Returns an array with last key and value found in RHash. 
+	#
 	def last 
 		@hash.last
 	end
 	
+	#
+	# See Hash::fetch
+	#
 	def fetch(key, msg='', &block)
 		value = select{|i| i.key == key}[0]
 	
@@ -207,14 +320,23 @@ class RHash
 		end	
 	end
 	
+	#
+	# See Hash::clear
+	#
 	def clear
 		@hash = []
 	end
 	
+	#
+	# See Hash::default=
+	#
 	def default=(value)
 		@default = value
 	end	
 	
+	#
+	# See Hash::default
+	#
 	def default(key)		
 		if @default.is_a? Proc
 			info = Info.new
@@ -229,19 +351,31 @@ class RHash
 		end
 	end	
 	
+	#
+	# See Hash::shift
+	#
 	def shift
 		shifted = @hash.shift
 		[shifted.key, shifted.value]
 	end		
 	
+	#
+	# See Hash::empty?
+	#
 	def empty?
 		@hash.empty?
 	end	
 	
+	#
+	# See Hash::store
+	#
 	def store(key, value)
 		self[key] = value
 	end	
 	
+	#
+	# See Hash::to_a
+	#
 	def to_a
 		array = []
 		@hash.each do |info|
@@ -250,6 +384,9 @@ class RHash
 		array
 	end	
 	
+	#
+	# See Hash::values_at
+	#
 	def values_at(*keys)
 		selected = []
 		@hash.each do |info|
@@ -258,7 +395,9 @@ class RHash
 		selected
 	end
 	
-	# Converte para hash
+	#
+	# Converts to a Hash.
+	#
 	def to_hash
 		pure_hash = {}
 		@hash.each do |info|
@@ -269,9 +408,17 @@ class RHash
 	
 	private
 	
-	def int_sort
+	def int_sort(&block)
 		new_hash = []
-		new_hash = @hash.sort_by{|info| info.key}
+		if !block_given?
+			new_hash = @hash.sort_by{|info| info.key}
+		else
+			aux = []
+			@hash.each do |info|
+				aux << [info.key, info.value]
+			end
+			new_hash = aux.sort(&block)
+		end		
 		new_hash
 	end
 	

data/test/test.rb

@@ -1,19 +1,26 @@
 require 'lib/rhash'
 
 n = RHash.new
-n[:g] = 5
-n[:a] = 8
-n[:x] = 105
-n[:xxx] = 105
+n['b'] = 400
+n['g'] = 5
+n["a"] = 8
+n["x"] = 105
+n["xx"] = 1054
 
-puts n.inspect
-n.sort!
-puts n.inspect
+#puts n.inspect
+#n.sort!{|i,j| i[0] <=> j[0]}
+#puts n.inspect
+#x = n.sort{|i,j| i[1] <=> j[1]}
+#puts x.class
+#puts x.inspect
+#puts n.inspect
+#puts n[:s] 
 #n.sort_each{|i| puts i}
+#n.each{|i| puts i}
 #n.each_pair{|i, j| puts i; puts j+1}
 #n.each_value{|i| puts i+10}
 #n.each_key{|i| puts i.inspect}
-#puts n.select{|i| i.value > 100}
+puts n.select{|i| i.value > 100}
 #puts n.keys.inspect
 #puts n.values.inspect
 #puts n.has_key?("a")

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rhash
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Rodrigo Mello Nardi
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-13 00:00:00 -03:00
+date: 2010-07-14 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -25,7 +31,7 @@ files:
 - lib/rhash.rb
 - test/test.rb
 has_rdoc: true
-homepage: 
+homepage: http://rubyhideoutprogramming.blogspot.com/
 licenses: []
 
 post_install_message: 
@@ -34,21 +40,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: an ordenable hash