hash-utils 0.16.0 → 0.17.0

data/README.md

@@ -1,22 +1,24 @@
 Hash Utils
 ==========
 
-**hash-utils** adds more than 105 useful and frequently rather 
+**hash-utils** adds more than 125 useful and frequently rather 
 fundamental methods which are missing in Ruby programming language, 
 to several core classes. It tries to be similar project to 
 [Ruby Facets][1] on principle, but less complex, more practical, 
 non-atomic and organized by better way.
 
 - `Array` – 12 methods,
+- `FalseClass` – 3 methods,
 - `File` – 2 methods,
 - `Hash` – 38 methods,
 - `IO` – 1 method,
 - `Module` – 1 method,
-- `Numeric` – 4 method,
-- `Object` – 8 methods,
-- `String` – 34 methods,
+- `Numeric` – 5 method,
+- `Object` – 12 methods,
+- `TrueClass` – 3 methods,
+- `String` – 35 methods,
 - `StringIO` – 1 method,
-- `Symbol` – 7 methods.
+- `Symbol` – 8 methods.
 
 For full reference and methods lists, see **[documentation][3]**.
 

data/Rakefile

@@ -18,7 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.name = "hash-utils"
   gem.homepage = "http://github.com/martinkozak/hash-utils"
   gem.license = "MIT"
-  gem.summary = 'Adds more than 105 useful and frequently rather fundamental methods which are missing in Ruby programming language, to Array, File, Hash, Module, Object, String and Symbol classes. It tries to be similar project to Ruby Facets on principle, but less complex, more practical, non-atomic and organized by better way.'
+  gem.summary = 'Adds more than 125 useful and frequently rather fundamental methods which are missing in Ruby programming language, to Array, File, Hash, Module, Object, String and Symbol classes. It tries to be similar project to Ruby Facets on principle, but less complex, more practical, non-atomic and organized by better way.'
   gem.post_install_message = "\nHASH UTILS: Be warn, Hash#all? has been removed since version 0.15.0 because of\nconflict with built-in one with in fact equivalent functionallity. Please, check\nyour code if you can and switch to Ruby's one.\n\n"
   gem.email = "martinkozak@martinkozak.net"
   gem.authors = ["Martin Kozák"]

data/VERSION

@@ -1 +1 @@
-0.16.0
+0.17.0

data/hash-utils.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hash-utils}
-  s.version = "0.16.0"
+  s.version = "0.17.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Martin Kozák}]
-  s.date = %q{2011-06-23}
+  s.date = %q{2011-06-24}
   s.email = %q{martinkozak@martinkozak.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "hash-utils.gemspec",
     "lib/hash-utils.rb",
     "lib/hash-utils/array.rb",
+    "lib/hash-utils/boolean.rb",
     "lib/hash-utils/file.rb",
     "lib/hash-utils/hash.rb",
     "lib/hash-utils/io.rb",
@@ -48,7 +49,7 @@ your code if you can and switch to Ruby's one.
 }
   s.require_paths = [%q{lib}]
   s.rubygems_version = %q{1.8.5}
-  s.summary = %q{Adds more than 105 useful and frequently rather fundamental methods which are missing in Ruby programming language, to Array, File, Hash, Module, Object, String and Symbol classes. It tries to be similar project to Ruby Facets on principle, but less complex, more practical, non-atomic and organized by better way.}
+  s.summary = %q{Adds more than 125 useful and frequently rather fundamental methods which are missing in Ruby programming language, to Array, File, Hash, Module, Object, String and Symbol classes. It tries to be similar project to Ruby Facets on principle, but less complex, more practical, non-atomic and organized by better way.}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/hash-utils.rb

@@ -2,6 +2,7 @@
 # (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
 require "hash-utils/array"
+require "hash-utils/boolean"
 require "hash-utils/file"
 require "hash-utils/hash"
 require "hash-utils/io"

data/lib/hash-utils/array.rb

@@ -221,4 +221,15 @@ class Array
     
     alias :average :avg
     
+    ##
+    # Indicates, object is +Array+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def array?
+        true
+    end
+    
 end

data/lib/hash-utils/boolean.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+##
+# +TrueClass+ extension.
+# @since 0.17.0
+#
+
+class TrueClass
+    
+    ##
+    # Indicates, object is boolean.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def boolean?
+        true
+    end
+    
+    ##
+    # Indicates, object is pure +false+, so +FalseClass+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.15.0
+    #
+    
+    def false?
+        false
+    end
+    
+    ##
+    # Indicates, object is pure +true+, so +TrueClass+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.15.0
+    #
+    
+    def true?
+        true
+    end
+    
+end
+
+##
+# +FalseClass+ extension.
+# @since 0.17.0
+#
+
+class FalseClass
+    
+    ##
+    # Indicates, object is boolean.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def boolean?
+        true
+    end
+    
+    ##
+    # Indicates, object is pure +false+, so +FalseClass+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.15.0
+    #
+    
+    def false?
+        true
+    end
+    
+    ##
+    # Indicates, object is pure +true+, so +TrueClass+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.15.0
+    #
+    
+    def true?
+        false
+    end
+    
+end

data/lib/hash-utils/hash.rb

@@ -238,6 +238,8 @@ class Hash
         end
     end
     
+    alias :symbolize_keys :keys_to_sym
+    
     ##
     # Emulates {#keys_to_sym} on place. In fact, replaces old hash by 
     # new one.
@@ -250,6 +252,8 @@ class Hash
         self.replace(self.keys_to_sym)
     end
     
+    alias :"symbolize_keys!" :"keys_to_sym!"
+    
     ##
     # Checks, all elements values follow condition expressed in block.
     # Block must return boolean.
@@ -730,6 +734,27 @@ class Hash
     end
     
     alias :average :avg
+
+    ##
+    # Indicates, object is +Array+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
     
+    def array?
+        self.kind_of? Array
+    end
     
+    ##
+    # Indicates, object is +Hash+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def hash?
+        true
+    end
+        
 end

data/lib/hash-utils/numeric.rb

@@ -85,6 +85,18 @@ class Numeric
     # @since 0.16.0
     #
     
-    alias :"positive!" :abs
+    alias :"positive!" :abs    
+    
+    ##
+    # Indicates, object is +Numeric+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def number?
+        true
+    end
+
     
 end

data/lib/hash-utils/object.rb

@@ -126,4 +126,70 @@ class Object
         self.kind_of? FalseClass
     end
     
+    ##
+    # Indicates, object is +String+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def string?
+        self.kind_of? String
+    end
+    
+    ##
+    # Indicates, object is +Symbol+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def symbol?
+        self.kind_of? Symbol
+    end
+    
+    ##
+    # Indicates, object is +Numeric+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def number?
+        self.kind_of? Numeric
+    end
+    
+    ##
+    # Indicates, object is boolean.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def boolean?
+        self.true? or self.false?
+    end
+    
+    ##
+    # Indicates, object is +Array+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def array?
+        self.kind_of? Array
+    end
+    
+    ##
+    # Indicates, object is +Hash+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def hash?
+        self.kind_of? Hash
+    end
+        
 end

data/lib/hash-utils/string.rb

@@ -571,6 +571,18 @@ class String
         return self
     end
     
+    ##
+    # Indicates, object is +String+.
+    #
+    # @return [Boolean] +true+ if yes, +false+ in otherwise
+    # @since 0.17.0
+    #
+    
+    def string?
+        true
+    end
+    
+    
     
     private
     

data/lib/hash-utils/symbol.rb

@@ -111,5 +111,18 @@ class Symbol
             i.to_sym
         end
     end
+    
+    ##
+    # Strips whitespace from symbol. It seems non-sense, but it's useful
+    # if you convert some data with problematic white-space heterogenity
+    # to symbols -- for example large CSV files or so.
+    #
+    # @return [Symbol] new symbol without whitespace
+    # @since 0.17.0
+    #
+    
+    def strip
+        self.to_s.strip!.to_sym
+    end
         
 end

data/test

@@ -3,6 +3,8 @@
 # (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
 $:.push("./lib")
+$:.unshift("./lib")
+
 require "stringio"
 require "hash-utils"
 require "riot"
@@ -40,11 +42,28 @@ context "Array" do
     asserts("#avg") do
         [1, 2, 3].avg == 2
     end
+    asserts("#array?") do
+        [1, 2, 3].array?
+    end
     asserts("#sum") do
         [1, 2, 3].sum == 6
     end
 end
 
+## FALSECLASS
+
+context "FalseClass" do
+    asserts("#boolean?") do
+        false.boolean?
+    end
+    asserts("#false?") do
+        false.false?
+    end
+    asserts("#true?") do
+        not false.true?
+    end
+end
+
 ## FILE
 
 context "File" do
@@ -97,6 +116,9 @@ context "Hash" do
         h = { :a => 1, :b => 2, :c => 3 }
         h.get_values(:a, :c, :d) == [1, 3]
     end
+    asserts("#get_values") do
+        { :a => 1, :b => 2, :c => 3 }.hash?
+    end
     asserts("#map_values") do
         topic.map_values { |i| i + 1 } == { :a => 2, :b => 3 }
     end
@@ -180,6 +202,9 @@ context "Numeric" do
     asserts("#negative!") do
         5.negative! == -5 and -5.negative! == -5
     end
+    asserts("#number?") do
+        5.number?
+    end
     asserts("#positive?") do
         5.positive? and not -2.positive?
     end
@@ -194,11 +219,20 @@ context "Object" do
     asserts("#**") do
         "ab" ** 5 == ["ab", "ab", "ab", "ab", "ab"]
     end
+    asserts("#array?") do
+        not "".array? and [].array?
+    end
+    asserts("#boolean?") do
+        true.boolean? and false.boolean? and not "".boolean?
+    end
     asserts("#false?") do
         (false.false? == true) and ("string".false? == false)
     end
+    asserts("#hash?") do
+        not "".hash? and {}.hash?
+    end
     asserts("#in?") do
-        5.in? 1..7
+        5.in? 1..7 and not 9.in? 1..7
     end
     asserts("#instance_of_any?") do
         "".instance_of_any? [String, Symbol] and not "".instance_of_any? [Integer, Float]
@@ -209,6 +243,15 @@ context "Object" do
     asserts("#kind_of_any?") do
         "".kind_of_any? [String, Symbol] and not "".kind_of_any? [Integer, Float]
     end
+    asserts("#number?") do
+        not :abcd.number? and 5.number?
+    end
+    asserts("#string?") do
+        "".string? and not 5.string?
+    end
+    asserts("#symbol?") do
+        :abcd.symbol? and not 5.symbol?
+    end
     asserts("#to_b") do
         (nil.to_b === false) and ("ab".to_b === true)
     end
@@ -330,6 +373,9 @@ context "String" do
         res &= str.shift_lines(2) == ["a\n", "b\n"]
         res &= str = "c\nd\n"
     end
+    asserts("#string?") do
+        "abcd".string?
+    end
     asserts("#ucfirst") do
         str = "abcd"
         str.ucfirst == "Abcd" and str == "abcd"
@@ -394,4 +440,21 @@ context "Symbol" do
     asserts("#start_with?") do
         :abcde.start_with? "ghi", "abc"
     end
+    asserts("#strip") do
+        :"  a  ".strip == :a
+    end
+end
+
+## TRUECLASS
+
+context "TrueClass" do
+    asserts("#boolean?") do
+        true.boolean?
+    end
+    asserts("#false?") do
+        not true.false?
+    end
+    asserts("#true?") do
+        true.true?
+    end
 end

metadata

@@ -2,7 +2,7 @@
 name: hash-utils
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-23 00:00:00 Z
+date: 2011-06-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ruby-version
@@ -77,6 +77,7 @@ files:
 - hash-utils.gemspec
 - lib/hash-utils.rb
 - lib/hash-utils/array.rb
+- lib/hash-utils/boolean.rb
 - lib/hash-utils/file.rb
 - lib/hash-utils/hash.rb
 - lib/hash-utils/io.rb
@@ -103,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3245774997071353458
+      hash: 3233431478987707592
       segments: 
       - 0
       version: "0"
@@ -119,6 +120,6 @@ rubyforge_project:
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Adds more than 105 useful and frequently rather fundamental methods which are missing in Ruby programming language, to Array, File, Hash, Module, Object, String and Symbol classes. It tries to be similar project to Ruby Facets on principle, but less complex, more practical, non-atomic and organized by better way.
+summary: Adds more than 125 useful and frequently rather fundamental methods which are missing in Ruby programming language, to Array, File, Hash, Module, Object, String and Symbol classes. It tries to be similar project to Ruby Facets on principle, but less complex, more practical, non-atomic and organized by better way.
 test_files: []