hash-utils 0.15.0 → 0.16.0

data/Gemfile

@@ -1,12 +1,12 @@
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
-#   gem "multitype-introspection", ">= 0.1.0"
+  gem "ruby-version", ">= 0.1.0"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", ">= 1.5.2"
   gem "riot", ">= 0.12.3"
 end

data/Gemfile.lock

@@ -2,19 +2,23 @@ GEM
   remote: http://rubygems.org/
   specs:
     git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
+    hash-utils (0.16.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    rake (0.9.0)
-    riot (0.12.3)
+    rake (0.9.2)
+    riot (0.12.4)
       rr
     rr (1.0.2)
+    ruby-version (0.1.0)
+      hash-utils (>= 0.16.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
+  bundler (>= 1.0.0)
+  jeweler (>= 1.5.2)
   riot (>= 0.12.3)
+  ruby-version (>= 0.1.0)

data/README.md

@@ -1,18 +1,19 @@
 Hash Utils
 ==========
 
-**hash-utils** adds more than 95 useful and frequently rather 
+**hash-utils** adds more than 105 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` – 10 methods,
+- `Array` – 12 methods,
 - `File` – 2 methods,
-- `Hash` – 36 methods,
+- `Hash` – 38 methods,
 - `IO` – 1 method,
 - `Module` – 1 method,
-- `Object` – 6 methods,
+- `Numeric` – 4 method,
+- `Object` – 8 methods,
 - `String` – 34 methods,
 - `StringIO` – 1 method,
 - `Symbol` – 7 methods.

data/Rakefile

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require 'rubygems'
 require 'bundler'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -8,15 +9,16 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
 
+require 'rake'
 require 'jeweler'
+
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "hash-utils"
   gem.homepage = "http://github.com/martinkozak/hash-utils"
   gem.license = "MIT"
-  gem.summary = 'Adds more than 95 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 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.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"]
@@ -26,13 +28,3 @@ Jeweler::Tasks.new do |gem|
   #  gem.add_development_dependency 'rspec', '> 1.2.3'
 end
 Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "hash-utils #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +1 @@
-0.15.0
+0.16.0

data/hash-utils.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hash-utils}
-  s.version = "0.15.0"
+  s.version = "0.16.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-05-29}
+  s.date = %q{2011-06-23}
   s.email = %q{martinkozak@martinkozak.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -47,24 +47,27 @@ your code if you can and switch to Ruby's one.
 
 }
   s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.4}
-  s.summary = %q{Adds more than 95 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.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.}
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_runtime_dependency(%q<ruby-version>, [">= 0.1.0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.5.2"])
       s.add_development_dependency(%q<riot>, [">= 0.12.3"])
     else
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<ruby-version>, [">= 0.1.0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.5.2"])
       s.add_dependency(%q<riot>, [">= 0.12.3"])
     end
   else
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<ruby-version>, [">= 0.1.0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.5.2"])
     s.add_dependency(%q<riot>, [">= 0.12.3"])
   end
 end

data/lib/hash-utils.rb

@@ -6,6 +6,7 @@ require "hash-utils/file"
 require "hash-utils/hash"
 require "hash-utils/io"
 require "hash-utils/module"
+require "hash-utils/numeric"
 require "hash-utils/object"
 require "hash-utils/string"
 require "hash-utils/stringio"

data/lib/hash-utils/array.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 # (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
+require "ruby-version"
+
 ##
 # Array extension.
 #
@@ -171,4 +173,52 @@ class Array
         self[7]
     end
     
+    ##
+    # Returns sum of items in the array. If other than numeric type found,
+    # it will be normally conacenated if it's possible. 
+    #
+    # @example
+    #   array = [1, 2, 3]
+    #   array.sum                           # will return 6
+    #   array = ["a", "b", "c"]
+    #   array.sum                           # will return "abc"
+    #
+    # @return [Object] result of summing
+    # @since 0.16.0
+    #
+    
+    def sum
+        if RUBY_VERSION[0..2] == "1.9" or Ruby::Version >= [1, 8, 7]
+            self.inject(:+)
+        else
+            first = true
+            self.inject(self.first) do |sum, i|
+                if first
+                    first = false
+                    sum
+                else
+                    sum += i
+                end
+            end
+        end
+    end
+    
+    ##
+    # Returns average of items in the array. Numeric types are expected,
+    # but content of the array isn't checked.
+    #
+    # @example
+    #   array = [1, 2, 3]
+    #   array.avg                           # will return 2
+    #
+    # @return [Numeric] result of averaging
+    # @since 0.16.0
+    #
+    
+    def avg
+        self.sum.to_f / self.length
+    end
+    
+    alias :average :avg
+    
 end

data/lib/hash-utils/hash.rb

@@ -694,4 +694,42 @@ class Hash
         return result
     end
     
+    ##
+    # Returns sum of items in the hash. If other than numeric type found,
+    # it will be normally conacenated if it's possible. 
+    #
+    # @example
+    #   hash = {:a => 1, :b => 2, :c => 3}
+    #   hash.sum                            # will return 6
+    #   hash = {:a => "a", :b => "b", :c => "c"}
+    #   hash.sum                            # will return "abc"
+    #
+    # @return [Integer, Object] result of summing
+    # @see Array#sum
+    # @since 0.16.0
+    #
+    
+    def sum
+        self.values.sum
+    end
+    
+    ##
+    # Returns average of items in the hash. Numeric types are expected,
+    # but content of the hash isn't checked.
+    #
+    # @example
+    #   hash = {:a => 1, :b => 2, :c => 3}
+    #   hash.avg                           # will return 2
+    #
+    # @return [Numeric] result of averaging
+    # @since 0.16.0
+    #
+    
+    def avg
+        self.values.avg
+    end
+    
+    alias :average :avg
+    
+    
 end

data/lib/hash-utils/numeric.rb

@@ -2,3 +2,89 @@
 # (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
 
 require "hash-utils/object"
+
+##
+# Numeric extension.
+# @since 0.16.0
+#
+
+class Numeric
+
+    ##
+    # Compares numbers. Returns 1 if this is higher, 0 if they are the 
+    # same and -1 if it's lower.
+    #
+    # @param [Numeric] number number for comparsion
+    # @return [Integer] comparsion result, see above
+    # @since 0.16.0
+    #
+    
+    def compare(number)
+        comp = self - number
+        
+        if comp.zero?
+            0
+        elsif comp.positive?
+            1
+        else
+            -1
+        end
+    end
+    
+    ##
+    # Indicates, number is positive, so higher than 0.
+    #
+    # @return [Boolean] +true+ it it is
+    # @since 0.16.0
+    #
+    
+    def positive?
+        self > 0
+    end
+    
+    alias :positive :"positive?"
+    
+    ##
+    # Indicates, number is negative, so lower than 0.
+    #
+    # @return [Boolean] +true+ it it is
+    # @since 0.16.0
+    #
+    
+    def negative?
+        self < 0
+    end
+    
+    alias :negative :"negative?"
+    
+    ##
+    # Sets the positivity to +false+, so negates the number. +0+ will 
+    # be kept.
+    #
+    # @example
+    #   1.negative!   # will return -1
+    #
+    # @return [Numeric] negative number
+    # @since 0.16.0
+    #
+    
+    def negative!
+        -self.positive!
+    end
+    
+    alias :"negate!" :"negative!"
+    
+    ##
+    # Sets the positivity to +true+, so makes number positive. +0+ will 
+    # be kept.
+    #
+    # @example
+    #   -1.positive!   # will return 1
+    #
+    # @return [Numeric] positive number
+    # @since 0.16.0
+    #
+    
+    alias :"positive!" :abs
+    
+end

data/lib/hash-utils/object.rb

@@ -6,6 +6,55 @@
 #
 
 class Object
+  
+    ##
+    # Returns +true+ if object is an instance of the given classes. 
+    #
+    # @see #kind_of_any?
+    # @param [Array] classes array of class objects
+    # @return [Boolean] +true+ if it is, +false+ in otherwise
+    # @since 0.16.0
+    #
+    
+    def instance_of_any?(classes)
+        if not classes.kind_of? Array
+            raise Exception::new("Array expected.")
+        end
+        
+        classes.each do |cls|
+            if self.instance_of? cls
+                return true
+            end
+        end
+        
+        return false
+    end
+
+    ##
+    # Returns +true+ if one of classes are the class of object, 
+    # or if one of classes are one of the superclasses of object or 
+    # modules included in object.
+    #
+    # @param [Array] classes array of class objects
+    # @return [Boolean] +true+ if it is, +false+ in otherwise
+    # @since 0.16.0
+    #
+    
+    def kind_of_any?(classes)
+        if not classes.kind_of? Array
+            raise Exception::new("Array expected.")
+        end
+        
+        classes.each do |cls|
+            if self.kind_of? cls
+                return true
+            end
+        end
+        
+        return false
+    end
+    
+    alias :"is_a_any?" :"kind_of_any?"
 
     ##
     # Indicates object is in some object which supports +#include?+.

data/lib/hash-utils/symbol.rb

@@ -25,7 +25,7 @@ class Symbol
     # Returns a new +Symbol+ containing +other_str+ concatenated 
     # to +str+.
     #
-    # @param [Integer] other_str string for concatenating to
+    # @param [Symbol, String] other_str string or symbol for concatenating to
     # @return [Symbol] new symbol
     # @since 0.12.0
     #

data/test

@@ -8,14 +8,14 @@ require "hash-utils"
 require "riot"
 
 
-## FILE
+## ARRAY
 
 # Filozofové mají Kanta rádi. Matematici mají Kanta také rádi, jen si 
 # myslí, že většina z toho, co vymyslel, je blbost.
 #
 # doc. Jiří Souček
 
-context "File" do
+context "Array" do
     asserts("#second") do
         [1, 2, 3, 4, 5, 6, 7, 8].second == 2
     end
@@ -37,8 +37,16 @@ context "File" do
     asserts("#eighth") do
         [1, 2, 3, 4, 5, 6, 7, 8].eighth == 8
     end
+    asserts("#avg") do
+        [1, 2, 3].avg == 2
+    end
+    asserts("#sum") do
+        [1, 2, 3].sum == 6
+    end
 end
 
+## FILE
+
 context "File" do
     asserts("#touch") do 
         File.touch("./~test1")
@@ -61,7 +69,10 @@ context "Hash" do
     setup do 
         { :a => 1, :b => 2 }
     end
- 
+
+    asserts("#avg") do
+        topic.avg == 1.5
+    end 
     asserts("#compact") do
         t = { :a => 1, :b => nil }
         t = t.compact
@@ -114,6 +125,9 @@ context "Hash" do
         h.keys_to_sym! 
         h == {:a => "b", 2 => "c", :d => "e"}
     end
+    asserts("#sum") do
+        topic.sum == 3
+    end
     asserts("#take_pairs") do
         h = { :a => 1, :b => 2, :c => 3 }
         result = [ ]
@@ -154,6 +168,26 @@ context "Module" do
     end
 end
 
+## NUMERIC
+
+context "Numeric" do
+    asserts("#compare") do
+        5.compare(1) == 1 and 5.compare(5) == 0 and 5.compare(7) == -1
+    end
+    asserts("#negative?") do
+        not 5.negative? and -2.negative?
+    end
+    asserts("#negative!") do
+        5.negative! == -5 and -5.negative! == -5
+    end
+    asserts("#positive?") do
+        5.positive? and not -2.positive?
+    end
+    asserts("#positive!") do
+        5.positive! == 5 and -5.positive! ==  5
+    end
+end
+
 ## OBJECT
 
 context "Object" do
@@ -166,9 +200,15 @@ context "Object" do
     asserts("#in?") do
         5.in? 1..7
     end
+    asserts("#instance_of_any?") do
+        "".instance_of_any? [String, Symbol] and not "".instance_of_any? [Integer, Float]
+    end
     asserts("#io?") do
         not "".io?
     end
+    asserts("#kind_of_any?") do
+        "".kind_of_any? [String, Symbol] and not "".kind_of_any? [Integer, Float]
+    end
     asserts("#to_b") do
         (nil.to_b === false) and ("ab".to_b === true)
     end

metadata

@@ -2,7 +2,7 @@
 name: hash-utils
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -10,33 +10,44 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-29 00:00:00 Z
+date: 2011-06-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: ruby-version
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: riot
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,7 +55,7 @@ dependencies:
         version: 0.12.3
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id004
 description: 
 email: martinkozak@martinkozak.net
 executables: []
@@ -92,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2809892554201068801
+      hash: 3245774997071353458
       segments: 
       - 0
       version: "0"
@@ -105,9 +116,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.4
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Adds more than 95 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 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.
 test_files: []