hash-utils 0.4.1 → 0.5.0

data/README.md

@@ -1,56 +1,12 @@
 Hash Utils
 ==========
 
-**Hash Utils** adds some utility methods well known from [Array][1]
-class to [Hash][2] class. Extends them with following methods:
+**Hash Utils** adds a lot of useful fundamental utility methods which 
+are missing in Ruby, both to [Array][1] and [Hash][2] classes and 
+introduces some useful methods and syntactic sugar to [Numeric][7], 
+[Symbol][6] and [String][8] classes too.
 
-* [`#compact`][3] – rejects elements with `nil` values,
-* [`#compact!`][4]
-* `#map_pairs` – works as [Array#map][5], but for *whole pair*,
-* `#map_pairs!`
-* `#map_keys` – works as [Array#map][5], but for *keys only*,
-* `#map_keys!`
-* `#keys_to_sym` – converts all keys to [Symbols][6],
-* `#keys_to_sym!`
-* …
-
-All methods with `!` emulates work *in place*, but in fact they 
-replace old hash with new one. An example of use: 
-
-    foo = {"a" => 1, "b" => 2}
-    foo.map_keys! { |k| k.to_sym }
-    
-    # result will be
-    #   {:a => 1, :b => 2}
-    
-This is the same as `#keys_to_sym!` for example. And also introduces
-some methods known from Python to both [Array][1] and [Hash][2] class:
-
-* `some?` – returns `true` if *some* element follows condition in block,
-* `some_pairs?`
-* `all?` – returns `true` if *all* element follows condition in block,
-* `all_pairs?`
-
-For example:
-
-    foo = [:alfa, :beta, 5, :gama]
-    foo.some? { |i| i.kind_of? Numeric }    # returns true
-    foo.all? { |i| i.kind_of? Symbol }      # returns false
-    
-And finally introduces one method to [Numeric][7], [Symbol][6] and 
-[String][8]:
-
-* `in?` – returns `true` if value is in some Object which support 
-`include?` method
-
-For example:
-    
-    foo = [1, 2, 3, 5, 8]
-    5.in? foo       # returns true
-    5.in? 3..6      # returns true
-    
-As you can see, it's syntactic sugar, of sure, but useful in some cases.
-Except these, it adds many other useful metods. See documentation.
+For full reference and methods lists, see **[documentation][3]**.
 
 ### Modularization
 
@@ -78,9 +34,7 @@ further details.
 
 [1]: http://www.ruby-doc.org/core/classes/Array.html
 [2]: http://www.ruby-doc.org/core/classes/Hash.html
-[3]: http://www.ruby-doc.org/core/classes/Array.html#M000278
-[4]: http://www.ruby-doc.org/core/classes/Array.html#M000279
-[5]: http://www.ruby-doc.org/core/classes/Array.html#M000249
+[3]: http://rubydoc.info/gems/hash-utils
 [6]: http://www.ruby-doc.org/core/classes/Symbol.html
 [7]: http://www.ruby-doc.org/core/classes/Numeric.html
 [8]: http://www.ruby-doc.org/core/classes/String.html

data/Rakefile

@@ -16,7 +16,7 @@ Jeweler::Tasks.new do |gem|
   gem.name = "hash-utils"
   gem.homepage = "http://github.com/martinkozak/hash-utils"
   gem.license = "MIT"
-  gem.summary = 'Adds some useful well known methods similar to appropriate Array methods to Hash and some useful methods known from Python to both of them. Also defines some utility method for other data types.'
+  gem.summary = 'Adds a lot of useful fundamental utility methods which are missing in Ruby, both to Array and Hash classes and introduces some useful methods and syntactic sugar to Numeric, Symbol and String classes too.'
   gem.email = "martinkozak@martinkozak.net"
   gem.authors = ["Martin Kozák"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/hash-utils.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hash-utils}
-  s.version = "0.4.1"
+  s.version = "0.5.0"
 
   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-27}
+  s.date = %q{2011-02-08}
   s.email = %q{martinkozak@martinkozak.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -34,11 +34,10 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/martinkozak/hash-utils}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Adds some useful well known methods similar to appropriate Array methods to Hash and some useful methods known from Python to both of them. Also defines some utility method for other data types.}
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{Adds a lot of useful fundamental utility methods which are missing in Ruby, both to Array and Hash classes and introduces some useful methods and syntactic sugar to Numeric, Symbol and String classes too.}
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/hash-utils/array.rb

@@ -39,7 +39,7 @@ class Array
     # If it's empty, returns +true+.
     #
     # @param [Proc] block checking block
-    # @return [Boolean] 'true' if yes, 'false' in otherwise
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
     # @since 0.2.0
     #
     
@@ -62,7 +62,7 @@ class Array
     # block. Block must return Boolean.
     #
     # @param [Proc] block checking block
-    # @return [Boolean] 'true' if yes, 'false' in otherwise
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
     # @since 0.2.0
     #
     

data/lib/hash-utils/hash.rb

@@ -60,6 +60,7 @@ class Hash
     # Recreates the hash in place, so creates empty one, assigns
     # the same default values and replaces the old one.
     #
+    # @return [Hash] new hash
     # @since 0.3.0
     #
     
@@ -144,6 +145,7 @@ class Hash
     # new one.
     #
     # @param [Proc] block evaluating block
+    # @return [Hash] new hash
     # @since 0.1.0
     #
     
@@ -175,6 +177,7 @@ class Hash
     # new one.
     #
     # @param [Proc] block evaluating block
+    # @return [Hash] new hash
     # @since 0.1.0
     #
     
@@ -199,6 +202,7 @@ class Hash
     # Emulates {#keys_to_sym} on place. In fact, replaces old hash by 
     # new one.
     #
+    # @return [Hash] new hash
     # @since 0.1.0
     #
     
@@ -304,4 +308,109 @@ class Hash
     def to_h(mode = nil)
         self
     end
+    
+    ##
+    # Simulates sorting in place. In fact, replaces old one by new one.
+    #
+    # @param [Proc] block comparing block (see similar for #sort method)
+    # @return [Hash] new sorted hash
+    # @since 0.5.0
+    #
+    
+    def sort!(&block)
+        self.replace(Hash[self.sort(&block)])
+    end
+    
+    ##
+    # Sorts hash according to keys. It's equivalent of PHP ksort().
+    #
+    # Be warn, this method have sense in Ruby 1.9 only. Ruby 1.8 doesn't
+    # maintain pair order in Hashes.
+    #
+    # @param [Proc] block comparing block (see similar for #sort method)
+    # @return [Hash] new sorted hash
+    # @see http://www.igvita.com/2009/02/04/ruby-19-internals-ordered-hash/
+    # @see http://www.php.net/ksort
+    # @since 0.5.0
+    #
+    
+    def ksort(&block)
+        if block.nil?
+           block =  Proc::new { |a, b| a <=> b }
+        end
+        Hash[self.sort { |a, b| block.call(a[0], b[0]) }]
+    end
+    
+    ##
+    # Sorts hash according to keys, replaces the original one.
+    # 
+    # @param [Proc] block comparing block (see similar for #sort method)
+    # @return [Hash] new sorted hash
+    # @see #ksort
+    # @since 0.5.0
+    #
+
+    def ksort!(&block)
+        self.replace(self.ksort(&block))
+    end
+    
+    ##
+    # Sorts hash according to values. Keeps key associations.
+    # It's equivalent of PHP asort().
+    #
+    # Be warn, this method have sense in Ruby 1.9 only. Ruby 1.8 doesn't
+    # maintain pair order in Hashes. 
+    #
+    # @param [Proc] block comparing block (see similar for #sort method)
+    # @return [Hash] new sorted hash
+    # @see http://www.igvita.com/2009/02/04/ruby-19-internals-ordered-hash/
+    # @see http://www.php.net/asort
+    # @since 0.5.0
+    #
+    
+    def asort(&block)
+        if block.nil?
+           block =  Proc::new { |a, b| a <=> b }
+        end
+        Hash[self.sort { |a, b| block.call(a[1], b[1]) }]
+    end
+    
+    ##
+    # Sorts hash according to values, replaces the original one.
+    # 
+    # @param [Proc] block comparing block (see similar for #sort method)
+    # @return [Hash] reversed hash
+    # @see #asort
+    # @since 0.5.0
+    #
+    
+    def asort!(&block)
+        self.replace(self.asort(&block))
+    end
+    
+    ##
+    # Reverses order of the hash pairs.
+    #
+    # Be warn, this method have sense in Ruby 1.9 only. Ruby 1.8 doesn't
+    # maintain pair order in Hashes.
+    #
+    # @return [Hash] reversed hash
+    # @since 0.5.0
+    #
+    
+    def reverse
+        Hash[self.to_a.reverse]
+    end
+    
+    ##
+    # Reverses order of the hash pairs, replaces the original one.
+    #
+    # @return [Hash] reversed hash
+    # @since 0.5.0
+    #
+    
+    def reverse!
+        self.replace(self.reverse)
+    end
+    
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: hash-utils
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 4
-  - 1
-  version: 0.4.1
+  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-27 00:00:00 +01:00
+date: 2011-02-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,10 +20,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
   type: :development
   prerelease: false
@@ -39,10 +31,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 2
         version: 1.5.2
   type: :development
   prerelease: false
@@ -85,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1545650960635711712
+      hash: 1593935056152751223
       segments: 
       - 0
       version: "0"
@@ -94,15 +82,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: Adds some useful well known methods similar to appropriate Array methods to Hash and some useful methods known from Python to both of them. Also defines some utility method for other data types.
+summary: Adds a lot of useful fundamental utility methods which are missing in Ruby, both to Array and Hash classes and introduces some useful methods and syntactic sugar to Numeric, Symbol and String classes too.
 test_files: []