utilities 0.0.15 → 0.0.16

data/README.md

@@ -0,0 +1,109 @@
+Utilities
+=========
+Utilities provides a handful of useful goodies including statistics, numeric arrays and the well-known raiser.
+
+Installation
+------------
+    gem install utilities
+
+Test
+----
+    rspec test/test_utilities
+
+Usage
+-----
+#### Array
+* to_numerics
+
+        ["3", 4, "7.9"].to_numerics #=> [3.0, 4.0, 7.9]
+    
+* numerics?
+
+        [1, 2.0, 3].numerics? #=> true
+    
+* reverse_sort
+
+        [1,8,3].reverse_sort #=> [8,3,1]
+
+#### Enumerable
+* collect_first
+
+        {:a=>1, :b=>2, :c=>3}.collect_first{|k,v| [k, v * 3] if v == 2 } #=> [:b, 6]
+
+#### Hash
+* collect_keys
+
+        {:a=>1, :b=>2, :c=>3}.collect_keys{|k| k.to_s.upcase } #=> {"A"=>1, "B"=>2, "C"=>3}
+    
+* collect_values
+
+        {:a=>1, :b=>2, :c=>3}.collect_values{|v| v * -1 } #=> {:a=>-1, :b=>-2, :c=>-3}
+
+* symbolize_keys
+
+        {"a"=>1, "b"=>2}.symbolize_keys #=> {:a=>1, :b=>2}
+
+#### Kernel
+* raiser
+
+        raiser 1, Hash.new, Array.new #=> RuntimeError "1, {}, []"
+
+#### Numeric
+* degrees
+
+        180.degrees == Math::PI #=> true
+
+* square
+
+        2.square #=> 4
+
+* hour_to_string
+
+        14.5.hour_to_string #=> "14:30"
+
+* sqrt
+
+        9.sqrt #=> 3
+
+* rank
+
+        5.rank(3, 9) #=> 0.3333...
+
+* to_decimals
+
+        1.759.to_decimals(2) #=> 1.76
+
+* percentage_of
+
+        48.percentage_of(50) #=> 96
+
+##### Utilities
+* Statistics
+
+    This module is intended to provide basic statistic functionnalities to numeric arrays. You may either
+    call [].to_stats or extend an existing array with Utilities::Statistics module.
+
+    ** sum
+    
+        [1,2,3].sum #=> 6
+    
+    ** squares
+        
+        [1,2,3].squares #=> [1,4,9]
+    
+    ** sqrts
+    
+        [9,16,25].sqrts #=> [3,4,5]
+    
+    ** mean
+    
+        [1,2,3,4,5].mean #=> 3
+    
+    ** frequences
+    
+        [1,1,2,3,3,3,4].frequences #=> {1=>2, 2=>1, 3=>3, 4=>1}
+    
+    ** modes
+    
+        [1,2,3,3,4,4,4,5].modes #=> {4=>3}
+

data/lib/utilities/array.rb

@@ -6,9 +6,9 @@ class Array
   alias_method :numeric?, :numerics?
   alias_method :narray?, :numerics?
   
-  # Transforms an array
-  def to_numerics
-    map{ |x| x.to_f }
+  # Transforms an array to an array of float values
+  def to_numerics( allow_nil = false )
+    map{ |x| allow_nil && x.nil? ? nil : x.to_f }
   end
   alias_method :to_numeric, :to_numerics
   alias_method :to_narray, :to_numerics

data/lib/utilities/utilities.rb

@@ -112,10 +112,10 @@ module Utilities
       a.last_quartile - a.first_quartile
     end
     
-    # Return an array of modes with their corresponding occurences
+    # Return a hash of modes with their corresponding occurences
     def modes
       fre = frequences
-      max = freq.values.max
+      max = fre.values.max
       fre.select{ |k, f| f == max }
     end
     

data/lib/version.rb

@@ -1,7 +1,7 @@
 class Utilities
   MAJOR = 0
   MINOR = 0
-  BUILD = 15
+  BUILD = 16
 
   VERSION = "#{MAJOR}.#{MINOR}.#{BUILD}"
 end

data/test/test_utilities.rb

@@ -1,20 +1,59 @@
+require "date"
 require File.join(File.dirname(__FILE__), "..", "lib", "utilities")
 
-describe Range do
-  it "#intersection should returns a range containing elements common to the two ranges, with no duplicates" do
-    (1..10).intersection(5..15).should == (5..10)
-    (1..10).intersection(15..25).should == nil
+describe Array do
+  it "#numerics? should returns true if given Array contains only numeric values" do
+    [].numerics?.should == true
+    [1,2,3,4,5].numerics?.should == true
+    [1,2,3,4,nil].numerics?.should == false
+    [1,2,3,4,nil].numerics?(true).should == true
   end
   
-  it "#empty? should returns true if given Range is empty" do
-    # Can a range be empty?
+  it "#to_numerics should returns a new array with only numeric elements" do
+    [].to_numerics.should == []
+    ["3", 4, nil].to_numerics.should == [3.0, 4.0, 0.0]
+    ["3", 4, nil].to_numerics(true).should == [3.0, 4.0, nil]
   end
   
-  it "#overlap? should returns true if the given Range overlaps the other" do
-    (1..5).overlap?(10..20).should == false
-    (1..5).overlap?(4..9).should == true
-    (1..5).overlap?(5..10).should == true
-    (1...5).overlap?(5..10).should == false
+  it "#reverse_sort should reverse sort the given array" do
+    [1,2,3,4].reverse_sort.should == [4,3,2,1]
+    [4,3,2,1].reverse_sort.should == [4,3,2,1]
+    ["f", "3", "z"].reverse_sort.should == ["z", "f", "3"]
+  end
+  
+  it "#to_stat should extends given array with module Utilities::Statistics" do
+    [].methods.include?(:statistics).should == false
+    [].to_stat.methods.include?(:statistics).should == true
+  end
+end
+
+describe Enumerable do
+  it "#collect_first should return the first collected elements" do
+    h = {:a => 1, :b => 2, :c => 3}
+    h.collect_first{|k, v| v if v == 2}.should == 2
+    h.collect_first(1){|k, v| v}.should == [1]
+    h.collect_first(2){|k, v| v}.should == [1, 2]
+  end
+end
+
+describe Hash do
+  it "#collect_keys should returns a new hash with the results of running block once for every key in self" do
+    {"a"=>1, "b"=>2, "c"=>3}.collect_keys{|k| k + "z"}.should == {"az"=>1, "bz"=>2, "cz"=>3}
+  end
+  
+  it "#collect_values should returns a new hash with the results of running block once for every value in self" do
+    {"a"=>1, "b"=>2, "c"=>3}.collect_values{|v| v**2}.should == {"a"=>1, "b"=>4, "c"=>9}
+  end
+  
+  it "#symbolize_keys should returns a new hash where all keys have been symbolized" do
+    {"a"=>1, "b"=>2, "c"=>3}.symbolize_keys.should == {:a=>1, :b=>2, :c=>3}
+  end
+end
+
+describe Kernel do
+  it "#raiser should raise given object.inspect" do
+    lambda{ raiser(1) }.should raise_error( RuntimeError, '1' )
+    lambda{ raiser([:a, :b], 3, "test") }.should raise_error( RuntimeError, '[:a, :b], 3, "test"' )
   end
 end
 
@@ -32,6 +71,12 @@ describe Numeric do
     end
   end
   
+  it "#hour_to_string should returns a formatted string of format HH:MM" do
+    14.5.hour_to_string.should == "14:30"
+    3.2.hour_to_string('h').should == "3h12"
+    19.hour_to_string.should == "19:00"
+  end
+  
   it "#sqrt should returns the square root of any given Numeric (based on Math::sqrt)" do
     (1..25).each do |i|
       i.sqrt.should == Math::sqrt(i)
@@ -58,29 +103,25 @@ describe Numeric do
     1.percentage_of(50).should == 2
     1.percentage_of(1).should == 100
     1.percentage_of(50, 50).should == 1
+    18.percentage_of(20, 5).should == 4.5
     100.percentage_of(50).should == 200
   end
 end
 
-describe Hash do
-  it "#collect_keys should returns a new hash with the results of running block once for every key in self" do
-    {"a"=>1, "b"=>2, "c"=>3}.collect_keys{|k| k + "z"}.should == {"az"=>1, "bz"=>2, "cz"=>3}
+describe Range do
+  it "#intersection should returns a range containing elements common to the two ranges, with no duplicates" do
+    (1..10).intersection(5..15).should == (5..10)
+    (1..10).intersection(15..25).should == nil
   end
   
-  it "#collect_values should returns a new hash with the results of running block once for every value in self" do
-    {"a"=>1, "b"=>2, "c"=>3}.collect_values{|v| v**2}.should == {"a"=>1, "b"=>4, "c"=>9}
+  it "#empty? should returns true if given Range is empty" do
+    # Can a range be empty?
   end
   
-  it "#symbolize_keys should returns a new hash where all keys have been symbolized" do
-    {"a"=>1, "b"=>2, "c"=>3}.symbolize_keys.should == {:a=>1, :b=>2, :c=>3}
-  end
-end
-
-describe Enumerable do
-  it "#collect_first should return the first collected elements" do
-    h = {:a => 1, :b => 2, :c => 3}
-    h.collect_first{|k, v| v if v == 2}.should == 2
-    h.collect_first(1){|k, v| v}.should == [1]
-    h.collect_first(2){|k, v| v}.should == [1, 2]
+  it "#overlap? should returns true if the given Range overlaps the other" do
+    (1..5).overlap?(10..20).should == false
+    (1..5).overlap?(4..9).should == true
+    (1..5).overlap?(5..10).should == true
+    (1...5).overlap?(5..10).should == false
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utilities
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-28 00:00:00.000000000Z
+date: 2011-09-02 00:00:00.000000000Z
 dependencies: []
 description: Few utilities include in all my projects, including a module for statistics,
   some to_date and to_time functions as well as intersection method for Range object.
@@ -23,7 +23,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- README
+- README.md
 - lib/utilities.rb
 - lib/utilities/array.rb
 - lib/utilities/datetime.rb
@@ -38,7 +38,7 @@ files:
 - lib/utilities/utilities.rb
 - lib/version.rb
 - test/test_utilities.rb
-- utilities-0.0.14.gem
+- utilities-0.0.15.gem
 - utilities.gemspec
 homepage: http://github.com/christianblais/utilities
 licenses: []