hash-utils 0.3.0 → 0.3.1

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/hash-utils.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hash-utils}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Martin Kozák"]
-  s.date = %q{2011-01-12}
+  s.date = %q{2011-01-20}
   s.email = %q{martinkozak@martinkozak.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",

data/lib/hash-utils/array.rb

@@ -1,6 +1,10 @@
 # encoding: utf-8
 # (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
+##
+# Array extension.
+#
+
 class Array
 
     ##
@@ -9,6 +13,10 @@ class Array
     # Works similar to #reject!, but returns removed items instead 
     # of remaining items.
     #
+    # @param [Proc] block selecting block
+    # @return [Array] removed values
+    # @since 0.3.0
+    #
     
     def remove!(&block)
         result = [ ]
@@ -30,6 +38,10 @@ class Array
     #
     # If it's empty, returns <tt>true</tt>.
     #
+    # @param [Proc] block checking block
+    # @return [Boolean] 'true' if yes, 'false' in otherwise
+    # @since 0.2.0
+    #
     
     def all?(&block)
         if self.empty?
@@ -49,6 +61,10 @@ class Array
     # Checks, at least one value follows condition expressed in 
     # block. Block must return Boolean.
     #
+    # @param [Proc] block checking block
+    # @return [Boolean] 'true' if yes, 'false' in otherwise
+    # @since 0.2.0
+    #
     
     def some?(&block)
         self.each do |v|

data/lib/hash-utils/hash.rb

@@ -1,11 +1,22 @@
 # encoding: utf-8
 # (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
+
+##
+# Hash extension.
+#
+
 class Hash
 
     ##
     # Defines hash by setting the default value or Proc and content.
     #
+    # @param [Hash] values  initial values
+    # @param [Object] default  default value
+    # @param [Proc] block  default block
+    # @return [Hash] new hash
+    # @since 0.3.0
+    #
     
     def self.define(values = { }, default = nil, &block) 
         hash = self[values]
@@ -15,6 +26,12 @@ class Hash
     ##
     # Creates hash by setting default settings in one call.
     #
+    # @param [Hash] values  initial values
+    # @param [Object] default  default value
+    # @param [Proc] block  default block
+    # @return [Hash] new hash
+    # @since 0.3.0
+    #
     
     def self.create(default = nil, hash = { }, &block)
         hash.default = default
@@ -30,6 +47,9 @@ class Hash
     # Recreates the hash, so creates empty one and assigns
     # the same default values.
     #
+    # @return [Hash] new hash
+    # @since 0.3.0
+    #
     
     def recreate
         self.class::create(self.default, &self.default_proc)
@@ -39,6 +59,8 @@ class Hash
     # Recreates the hash in place, so creates empty one, assigns
     # the same default values and replaces the old one.
     #
+    # @since 0.3.0
+    #
     
     def recreate!
         self.replace(self.recreate)
@@ -48,6 +70,10 @@ class Hash
     # Moves selected pairs outside the hash, so returns them.
     # Output hash has the same default settings.
     #
+    # @param [Proc] block selecting block
+    # @return [Hash] removed selected pairs
+    # @since 0.3.0
+    #
     
     def remove!(&block)
         result = self.recreate
@@ -71,6 +97,9 @@ class Hash
     # Returns a copy of <tt>self</tt> with all <tt>nil</tt> 
     # elements removed.
     #
+    # @return [Hash] new hash
+    # @since 0.1.0
+    #
 
     def compact
         self.reject { |k, v| v.nil? }
@@ -78,7 +107,10 @@ class Hash
     
     ##
     # Removes <tt>nil</tt> elements from the hash. Returns <tt>nil</tt> 
-    # if no changes were made, otherwise returns <tt>self</self>.
+    # if no changes were made, otherwise returns <tt>self</tt>.
+    #
+    # @return [Hash] new hash
+    # @since 0.1.0
     #
     
     def compact!
@@ -88,6 +120,10 @@ class Hash
     ##
     # Returns a new hash with the results of running block once for 
     # every pair in <tt>self</tt>.
+    #
+    # @param [Proc] block evaluating block
+    # @return [Hash] new hash
+    # @since 0.1.0
     # 
     
     def map_pairs(&block)
@@ -107,6 +143,9 @@ class Hash
     # Emulates #map_pairs on place. In fact, replaces old hash by 
     # new one.
     #
+    # @param [Proc] block evaluating block
+    # @since 0.1.0
+    #
     
     def map_pairs!(&block)
         self.replace(self.map_pairs(&block))
@@ -118,6 +157,10 @@ class Hash
     # Returns a new hash with the results of running block once for 
     # every key in <tt>self</tt>.
     #
+    # @param [Proc] block evaluating block
+    # @return [Hash] new hash
+    # @since 0.1.0
+    #
     
     def map_keys(&block)
         self.map_pairs do |k, v|
@@ -131,6 +174,9 @@ class Hash
     # Emulates #map_keys on place. In fact, replaces old hash by 
     # new one.
     #
+    # @param [Proc] block evaluating block
+    # @since 0.1.0
+    #
     
     def map_keys!(&block)
         self.replace(self.map_keys(&block))
@@ -141,6 +187,9 @@ class Hash
     ##
     # Converts all keys to symbols.
     #
+    # @return [Hash] new hash
+    # @since 0.1.0
+    #
     
     def keys_to_sym
         self.map_keys { |k| k.to_sym }
@@ -150,6 +199,8 @@ class Hash
     # Emulates #keys_to_sym on place. In fact, replaces old hash by 
     # new one.
     #
+    # @since 0.1.0
+    #
     
     def keys_to_sym!
         self.replace(self.keys_to_sym)
@@ -161,6 +212,10 @@ class Hash
     #
     # If it's empty, returns <tt>true</tt>.
     #
+    # @param [Proc] block checking block
+    # @return [Boolean] 'true' if yes, 'false' in otherwise 
+    # @since 0.2.0
+    #
     
     def all?(&block)
         if self.empty?
@@ -182,6 +237,10 @@ class Hash
     #
     # If it's empty, returns <tt>true</tt>.
     #
+    # @param [Proc] block checking block
+    # @return [Boolean] 'true' if yes, 'false' in otherwise 
+    # @since 0.2.0
+    #
     
     def all_pairs?(&block)
         if self.empty?
@@ -201,6 +260,10 @@ class Hash
     # Checks, at least one element value follows condition expressed in 
     # block. Block must return Boolean.
     #
+    # @param [Proc] block checking block
+    # @return [Boolean] 'true' if yes, 'false' in otherwise 
+    # @since 0.2.0
+    #
     
     def some?(&block)
         self.each_value do |v|
@@ -216,6 +279,10 @@ class Hash
     # Checks, at least one element follows condition expressed in 
     # block. Block must return Boolean.
     #
+    # @param [Proc] block checking block
+    # @return [Boolean] 'true' if yes, 'false' in otherwise 
+    # @since 0.2.0
+    #
         
     def some_pairs?(&block)
         self.each_pair do |k, v|

data/lib/hash-utils/numeric.rb

@@ -1,10 +1,18 @@
 # encoding: utf-8
 # (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
+##
+# Numeric extension.
+#
+
 class Numeric
     ##
     # Indicates numeric is in some object which supports #include?.
     #
+    # @param [Object] range container for analyzing
+    # @param [Boolean] 'true' if yes, 'false' in otherwise
+    # @since 0.3.0
+    #
     
     def in?(range)
         range.include? self

data/lib/hash-utils/string.rb

@@ -1,6 +1,10 @@
 # encoding: utf-8
 # (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
+##
+# String extension.
+#
+
 class String
     ##
     # Holds numeric matcher.
@@ -11,6 +15,10 @@ class String
     ##
     # Indicates string is in some object which supports #include?.
     #
+    # @param [Object] range container for analyzing
+    # @param [Boolean] 'true' if yes, 'false' in otherwise
+    # @since 0.3.0
+    #
     
     def in?(range)
         range.include? self
@@ -19,6 +27,9 @@ class String
     ##
     # Indicates, string is numeric, so consists of numbers only.
     #
+    # @return [Boolean] 'true' if yes, 'false' in otherwise
+    # @since 0.3.0
+    #
     
     def numeric?
         if self.match(self.class::NUMERIC)

data/lib/hash-utils/symbol.rb

@@ -1,10 +1,19 @@
 # encoding: utf-8
 # (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
+
+##
+# Symbol extension.
+#
+
 class Symbol
     ##
     # Indicates symbol is in some object which supports #include?.
     #
+    # @param [Object] range container for analyzing
+    # @param [Boolean] 'true' if yes, 'false' in otherwise
+    # @since 0.3.0
+    #
     
     def in?(range)
         range.include? self

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 +01:00
+date: 2011-01-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -85,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3600041208124521153
+      hash: -3792094260852597544
       segments: 
       - 0
       version: "0"