nairda-ruby-util 0.1.0

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2008 Adrian Pacała
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README

@@ -0,0 +1,12 @@
+Some random Ruby core extensions that I use for my own projects.
+
+So far the following functions are implemented:
+
+* Enumerable:
+  * Calculating product, sum, inverted sum, reverse sum, and square root sum.
+  * Calculating means: arithmetic, geometric, harmonic, and root mean square.
+* Float:
+  * Rounding, ceiling, and flooring to specified decimal places.
+  * Converting to percent with given decimal places.
+* Math
+  * Calculating roots.

data/lib/ruby-util.rb

@@ -0,0 +1,3 @@
+require 'pathname'
+
+Dir[Pathname(__FILE__).dirname.expand_path + 'ruby-util/**/*.rb'].sort.each { |path| require path }

data/lib/ruby-util/enumerable.rb

@@ -0,0 +1,50 @@
+module Enumerable
+  # Calculates sum of the collection.
+  def sum
+    inject(nil) { |sum, x| sum ? sum + x : x }
+  end
+
+  # Calculates inversed sum of the collection.
+  def inversed_sum
+    1.0 / sum
+  end
+
+  # Calculates reverse sum of the collection.
+  def reverse_sum
+    sum.to_i > 0 ? inject(nil) { |sum, x| sum ? sum + 1.0 / x : 1.0 / x } : 0
+  end
+
+  # Calculates square root sum of the collection.
+  def square_root_sum
+    inject(nil) { |sum, x| sum ? sum + x ** 2 : x ** 2 }
+  end
+
+  # Multiplicates all elements of the collection.
+  def product
+    inject(nil) { |mul, x| mul ? mul * x : x }
+  end
+
+  alias_method :multiply, :product
+
+  # Calculates arithmectic mean of all elements in the collection.
+  def arithmetic_mean
+    size > 0 ? sum.to_f / size : 0
+  end
+
+  alias_method :average, :arithmetic_mean
+
+  # Calculates geometric mean of all elements in the collection.
+  def geometric_mean
+    size > 0 ? Math.root(product, size) : 0
+  end
+
+  # Calculates harmonic mean of all elements in the collection.
+  def harmonic_mean
+    size > 0 ? size / reverse_sum : 0
+  end
+
+  # Calculates root mean square of all elements in the collection.
+  def root_mean_square
+    size > 0 ? Math.sqrt(square_root_sum / size) : 0
+  end
+end

data/lib/ruby-util/float.rb

@@ -0,0 +1,21 @@
+class Float
+  # Rounds Float to +n+ decimal places.
+  def round_to(n)
+    (self * 10 ** n).round.to_f / 10 ** n
+  end
+
+  # Rounds Float up to +n+ decimal places.
+  def ceil_to(n)
+    (self * 10 ** n).ceil.to_f / 10 ** n
+  end
+
+  # Rounds Float down to +n+ decimal places.
+  def floor_to(n)
+    (self * 10 ** n).floor.to_f / 10 ** n
+  end
+
+  # Converts Float to percent with +n+ decimal places.
+  def to_percent(n = 0)
+    n > 0 ? (self * 100).round_to(n) : (self * 100).round
+  end
+end

data/lib/ruby-util/math.rb

@@ -0,0 +1,8 @@
+module Math
+  class << self
+    # Calculates the +nth+ root of a +x+.
+    def root(x, n)
+      x ** (1.0 / n)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'pathname'
+require 'rubygems'
+require 'spec'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/ruby-util'

data/spec/unit/enumerable_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+# Danger! Might cause a black hole!
+Infinity = 1.0 / 0
+
+describe Enumerable do
+  it 'should calculate sum' do
+    [0, 1, 2, 4, 8, 16].sum.should equal(31)
+  end
+
+  it 'should calculate inversed sum' do
+    [0, 1, 2, 3, 4].inversed_sum.should eql(0.1)
+  end
+
+  it 'should calculate reverse sum' do
+    [2, 4].reverse_sum.should eql(0.75)
+    [-1, -2, -3].reverse_sum.should equal(0)
+  end
+
+  it 'should not calculate reverse sum' do
+    [0, 1].reverse_sum.should eql(Infinity)
+  end
+
+  it 'should calculate square root sum' do
+    [1, 2, 3, 4, 5].square_root_sum.should equal(55)
+  end
+
+  it 'should multiply all elements' do
+    [1, 2, 3, 4, 5].product.should equal(120)
+  end
+
+  it 'should calculate arithmetic mean' do
+    [2, 4, 6, 8, 10].arithmetic_mean.should eql(6.0)
+  end
+
+  it 'should calculate geometric mean' do
+    [3, 3, 3].geometric_mean.should eql(3.0)
+  end
+
+  it 'should calculate harmonic mean' do
+    [4, 4, 4].harmonic_mean.should eql(4.0)
+  end
+
+  it 'should calculate root mean square' do
+    [5, 5, 5].root_mean_square.should eql(5.0)
+  end
+
+  it 'should not calculate any mean of empty collection' do
+    [].arithmetic_mean.should equal(0)
+    [].geometric_mean.should eql(0)
+    [].harmonic_mean.should eql(0)
+    [].root_mean_square.should eql(0)
+  end
+end

data/spec/unit/float_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Float do
+  it 'should round number to 5 decimal places' do
+    Math::PI.round_to(5).should eql(3.14159)
+  end
+
+  it 'should ceil number to 4 decimal places' do
+    Math::PI.ceil_to(5).should eql(3.1416)
+  end
+
+  it 'should floor number to 5 decimal places' do
+    Math::PI.floor_to(5).should eql(3.14159)
+  end
+
+  it 'should calculate percent of given number' do
+    0.123.to_percent.should eql(12)
+  end
+
+  it 'should calculate rounded percent of given number' do
+    0.12345.to_percent(3).should eql(12.345)
+  end
+end

data/spec/unit/math_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Math do
+  it 'should calculate the 2nd root of 4' do
+    Math.root(4, 2).should eql(Math.sqrt(4))
+  end
+
+  it 'should calculate the 3rd root of 27' do
+    Math.root(27, 3).should eql(3.0)
+  end
+
+  it 'should calculate the 10th root of 1024' do
+    Math.root(1024, 10).should eql(2.0)
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: nairda-ruby-util
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Adrian Paca\xC5\x82a"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-13 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: adrian@zenbe.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- README
+- LICENSE
+- lib/ruby-util.rb
+- lib/ruby-util/math.rb
+- lib/ruby-util/float.rb
+- lib/ruby-util/enumerable.rb
+- spec/unit/enumerable_spec.rb
+- spec/unit/math_spec.rb
+- spec/unit/float_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nairda/ruby-util
+post_install_message: 
+rdoc_options: 
+- --line-numbers--inline-source--charsetutf-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Simple Ruby class for simulating dice rolls.
+test_files: []
+