hash-utils 0.3.1 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/hash-utils.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hash-utils}
-  s.version = "0.3.1"
+  s.version = "0.4.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-20}
+  s.date = %q{2011-01-27}
   s.email = %q{martinkozak@martinkozak.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",

data/lib/hash-utils/array.rb

@@ -10,7 +10,7 @@ class Array
     ##
     # Moves selected values outside the array, so returns them.
     #
-    # Works similar to #reject!, but returns removed items instead 
+    # Works similar to +Hash#reject!+, but returns removed items instead 
     # of remaining items.
     #
     # @param [Proc] block selecting block
@@ -36,7 +36,7 @@ class Array
     # Checks, all values follow condition expressed in block.
     # Block must return Boolean.
     #
-    # If it's empty, returns <tt>true</tt>.
+    # If it's empty, returns +true+.
     #
     # @param [Proc] block checking block
     # @return [Boolean] 'true' if yes, 'false' in otherwise
@@ -75,5 +75,34 @@ class Array
         
         return false
     end
-
+    
+    ##
+    # Converts array to +Hash+.
+    #
+    # Works as alias for +Hash#[]+ method. If you specify the +:flat+ 
+    # mode, array items will be treaten as arguments to +Hash#[]+ 
+    # method.
+    #
+    # Should be noted, it cannot be named +#to_hash+, because #to_hash 
+    # is called by the +Hash#[]+ itself. Reasons why it's absolutely 
+    # undocumented call are unknown.
+	#
+    # @example Equivalent calls
+    #   [["aa", "bb"], ["bb", "aa"]].to_h
+    #   ["aa", "bb", "bb", "aa"].to_h(:flat)
+    #
+    # @param [Symbol] mode flat mode switch, can be +:flat+ or +nil+
+    # @return Hash new hash
+    # @see http://www.ruby-doc.org/core/classes/Hash.html#M000716
+    # @since 0.4.0
+    #
+    
+    def to_h(mode = nil)
+		if mode == :flat
+			Hash[*self]
+		else
+			Hash[self]
+		end
+    end
+    
 end

data/lib/hash-utils/hash.rb

@@ -9,7 +9,8 @@
 class Hash
 
     ##
-    # Defines hash by setting the default value or Proc and content.
+    # Defines hash by setting the default value or an +Proc+ 
+    # and content.
     #
     # @param [Hash] values  initial values
     # @param [Object] default  default value
@@ -94,8 +95,7 @@ class Hash
     end
 
     ##
-    # Returns a copy of <tt>self</tt> with all <tt>nil</tt> 
-    # elements removed.
+    # Returns a copy of +self+ with all +nil+ elements removed.
     #
     # @return [Hash] new hash
     # @since 0.1.0
@@ -106,8 +106,8 @@ class Hash
     end
     
     ##
-    # Removes <tt>nil</tt> elements from the hash. Returns <tt>nil</tt> 
-    # if no changes were made, otherwise returns <tt>self</tt>.
+    # Removes +nil+ elements from the hash. Returns +nil+ 
+    # if no changes were made, otherwise returns +self+.
     #
     # @return [Hash] new hash
     # @since 0.1.0
@@ -119,7 +119,7 @@ class Hash
     
     ##
     # Returns a new hash with the results of running block once for 
-    # every pair in <tt>self</tt>.
+    # every pair in +self+.
     #
     # @param [Proc] block evaluating block
     # @return [Hash] new hash
@@ -140,7 +140,7 @@ class Hash
     alias :collect_pairs :map_pairs
     
     ##
-    # Emulates #map_pairs on place. In fact, replaces old hash by 
+    # Emulates {#map_pairs} on place. In fact, replaces old hash by 
     # new one.
     #
     # @param [Proc] block evaluating block
@@ -155,7 +155,7 @@ class Hash
     
     ##
     # Returns a new hash with the results of running block once for 
-    # every key in <tt>self</tt>.
+    # every key in +self+.
     #
     # @param [Proc] block evaluating block
     # @return [Hash] new hash
@@ -171,7 +171,7 @@ class Hash
     alias :collect_keys :map_keys
     
     ##
-    # Emulates #map_keys on place. In fact, replaces old hash by 
+    # Emulates {#map_keys} on place. In fact, replaces old hash by 
     # new one.
     #
     # @param [Proc] block evaluating block
@@ -196,7 +196,7 @@ class Hash
     end
     
     ##
-    # Emulates #keys_to_sym on place. In fact, replaces old hash by 
+    # Emulates {#keys_to_sym} on place. In fact, replaces old hash by 
     # new one.
     #
     # @since 0.1.0
@@ -208,12 +208,12 @@ class Hash
     
     ##
     # Checks, all elements values follow condition expressed in block.
-    # Block must return Boolean.
+    # Block must return boolean.
     #
-    # If it's empty, returns <tt>true</tt>.
+    # 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
     #
     
@@ -233,12 +233,12 @@ class Hash
         
     ##
     # Checks, all elements follow condition expressed in block.
-    # Block must return Boolean.
+    # Block must return boolean.
     #
-    # If it's empty, returns <tt>true</tt>.
+    # 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
     #
     
@@ -258,10 +258,10 @@ class Hash
     
     ##
     # Checks, at least one element value follows condition expressed in 
-    # block. Block must return Boolean.
+    # 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
     #
     
@@ -277,10 +277,10 @@ class Hash
 
     ##
     # Checks, at least one element follows condition expressed in 
-    # block. Block must return Boolean.
+    # 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
     #
         
@@ -293,4 +293,15 @@ class Hash
         
         return false
     end
+    
+    ##
+    # Compatibility method with {Array#to_h}. Returns itself.
+    #
+    # @return [Hash] itself
+    # @since 0.4.0
+    #
+    
+    def to_h(mode = nil)
+        self
+    end
 end

data/lib/hash-utils/numeric.rb

@@ -7,10 +7,10 @@
 
 class Numeric
     ##
-    # Indicates numeric is in some object which supports #include?.
+    # Indicates numeric is in some object which supports +#include?+.
     #
     # @param [Object] range container for analyzing
-    # @param [Boolean] 'true' if yes, 'false' in otherwise
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
     # @since 0.3.0
     #
     

data/lib/hash-utils/string.rb

@@ -1,6 +1,9 @@
 # encoding: utf-8
 # (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
+require "hash-utils/array"
+require "hash-utils/hash"
+
 ##
 # String extension.
 #
@@ -13,10 +16,10 @@ class String
     NUMERIC = /^\s*-?\d+(?:\.\d+)?\s*$/
     
     ##
-    # Indicates string is in some object which supports #include?.
+    # Indicates string is in some object which supports +#include?+.
     #
     # @param [Object] range container for analyzing
-    # @param [Boolean] 'true' if yes, 'false' in otherwise
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
     # @since 0.3.0
     #
     
@@ -27,7 +30,7 @@ class String
     ##
     # Indicates, string is numeric, so consists of numbers only.
     #
-    # @return [Boolean] 'true' if yes, 'false' in otherwise
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
     # @since 0.3.0
     #
     
@@ -38,4 +41,80 @@ class String
             false
         end
     end
+    
+    ##
+    # Replaces set of substrings by another strings.
+    #
+    # It's equivalent of PHP +strtr()+ function. Supports all objects
+    # convertable to String, but in that case you must give him block
+    # which specifies how to map keys found in the string back to 
+    # keys in definition Hash or Array.
+    #
+    # If you specify the +:flat+ mode, definition array items will be 
+    # treaten as arguments to +Hash#[]+ method while internal conversion
+    # +Array+ to +Hash+, so then can then use plain array as base for 
+    # definitions. See {Array#to_h}. 
+    #
+    # @example Equivalent calls
+    #   "aa bb".tr("aa" => "bb", "bb" => "aa")
+    #   "aa bb".tr([["aa", "bb"], ["bb", "aa"]])
+    #   "aa bb".tr(["aa", "bb", "bb", "aa"], :flat)
+    # @example Use with symbols
+    # 	"aa bb".tr(:aa => "bb", :bb => "aa") { |s| s.to_sym }
+    #
+    # @param [Array, Hash] replacements replacements definition
+    # @param [Symbol] mode flat mode switch, can be +:flat+ or +nil+
+    # @param [Proc] block with keys mapping worker (see description)
+    # @return [String] string with applied replacements
+    # @see http://www.php.net/strtr
+    # @since 0.4.0
+    #
+    
+    def tr(defs, mode = nil, &block)
+        if block.nil?
+            block = Proc::new { |s| s }
+        end
+        
+        defs, matcher = __prepare_tr(defs, mode)
+        self.gsub(matcher) { |s| defs[block.call(s)] }
+    end
+    
+    ##
+    # Replaces set of substrings by another strings -- in place.
+    # See {#tr} for details.
+    #
+    # @param [Array, Hash] replacements replacements definition
+    # @param [Symbol] mode flat mode switch, can be +:flat+ or +nil+
+    # @param [Proc] block with keys mapping worker (see description)
+    # @return [String] string with applied replacements
+    # @see #tr
+    # @since 0.4.0
+    #
+    
+    def tr!(defs, mode = nil, &block)
+        if block.nil?
+            block = Proc::new { |s| s }
+        end
+        
+        defs, matcher = __prepare_tr(defs, mode)
+        self.gsub!(matcher) { |s| defs[block.call(s)] }
+    end
+    
+    
+    private
+    
+    ##
+    # Prepares matcher for #tr.
+    #
+    
+    def __prepare_tr(defs, mode = nil)
+        defs = defs.to_h(mode)
+        keys = defs.keys
+        keys.map! { |i| i.to_s }
+
+        matcher = Regexp::new("(" << keys.join("|") << ")")
+        return [defs, matcher]
+    end
+    
 end
+

data/lib/hash-utils/symbol.rb

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

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-20 00:00:00 +01:00
+date: 2011-01-27 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: -3792094260852597544
+      hash: -2173078949631025708
       segments: 
       - 0
       version: "0"