Oompa-euler 1.0.2 → 1.0.3

data/History.txt

@@ -0,0 +1,10 @@
+=== 1.0.3 / 2008-08-26
+* Now added Rakefile for easy development.
+* Restructured gemspec
+* Added unit tests to gemspec
+
+=== 1.0.2 / 2008-08-25
+* Removed redundant files…
+
+=== 1.0.0 / 2008-08-25
+* Initial Release!

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/euler.rb
+test/test_euler.rb
+test/tc_integer_methods.rb
+test/tc_module.rb

data/{LICENSE → README.txt}

@@ -1,3 +1,33 @@
+= euler
+
+== DESCRIPTION:
+
+libeuler is a simple library you can include in your code to take away some of the boring repetitive parts of solving Project Euler problems.
+
+== FEATURES:
+
+* Adds various methods to the Integer class, such as factorial, prime?, is_fibonacci?, etc.
+* Provides various module methods, such as generate_sieve, get_primes, etc.
+
+== SYNOPSIS:
+
+	require 'rubygems'
+	require 'euler'
+	
+	5.factorial # => 120
+
+== REQUIREMENTS:
+
+* none
+
+== INSTALL:
+
+* sudo gem install euler
+
+== LICENSE:
+
+(BSD License)
+
 Copyright (c) 2008, Mike "Oompa" Skalnik ("THE AUTHOR")
 All rights reserved. mike.skalnik@gmail.com
 
@@ -22,3 +52,4 @@ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/lib/euler.rb

@@ -1,13 +1,6 @@
-=begin rdoc
-libeuler is a simple library you can simply +require+ in your code.
-It's goal is to help reduce the repetativeness of some Project
-Euler problems.
-
-Author:: Mike Skalnik(mailto:mike.skalnik@gmail.com)
-Copyright:: 2008, Mike Skalnik; All Rights Reserved
-License:: See LICENSE file
-=end
+# The module that contains all the methods.
 module Euler
+  VERSION = "1.0.3"
   extend self
   attr_reader :primes, :sieve, :fibonaccis
   # Several methods for the Integer class.
@@ -25,10 +18,10 @@ module Euler
     def prime_factors
       return [self] if self.prime?
       current, to_factor, factors, max = 2, self, [], 0
-      # current is the value currently being tested
-      # to_factor is the value being factored (slowly moves to a prime value)
-      # factors is the array of prime factors
-      # max is the maximum value of any factor set after the next loop
+      # current is the value currently being tested to_factor is the value
+      # being factored (slowly moves to a prime value) factors is the array of
+      # prime factors max is the maximum value of any factor set after the
+      # next loop
       while to_factor % current == 0
         factors << 2
         to_factor /= current
@@ -47,8 +40,7 @@ module Euler
       return factors
     end
   
-    # Returns +true+ or +false+ depending on the primality of
-    # +self+
+    # Returns a boolean which gives the primality of +self+
     #   2.prime? # => true
     #   4.prime? # => false
     def prime?
@@ -65,9 +57,8 @@ module Euler
       return true
     end
   
-    # Compares +self+ and +x+ and returns +true+
-    # if the values are permutations, and +false+
-    # otherwise.
+    # Compares +self+ and +x+ and returns +true+ if the values are 
+    # permutations, and +false+ otherwise.
     #   123.is_permutation?(312) # => true
     #   312.is_permutation?(281) # => false
     def is_permutation?(x)
@@ -88,8 +79,7 @@ module Euler
       return s_total == x_total
     end
   
-    # Checks to see if +self+ is a pandigital with the range
-    # of x
+    # Checks to see if +self+ is a pandigital with the range of x
     #   0192837465.is_pandigital?(0..9) # => true
     #   0192837465.is_pandigital?(1..9) # => false
     def is_pandigital?(x)
@@ -100,8 +90,7 @@ module Euler
       return true
     end
   
-    # Checks to see if +self+ is contained in the fibonacci
-    # sequence.
+    # Checks to see if +self+ is contained in the fibonacci sequence.
     #   1.is_fibonacci? # => true
     #   4.is_fibonacci? # => true
     def is_fibonacci?
@@ -123,9 +112,8 @@ module Euler
     end
   end
 
-  # A basic prime sieve. Sets Euler.sieve to an array of
-  # boolean values that indicate if that index if prime
-  # or not.
+  # A basic prime sieve. Sets Euler.sieve to an array of boolean values that
+  # indicate if that index if prime or not.
   #   Euler.generate_sieve(50)
   #   Euler::sieve[2] # => true
   #   Euler::sieve[4] # => false
@@ -140,8 +128,7 @@ module Euler
     }
   end
 
-  # A more advanced prime sieve. Generates an n amount of
-  # prime values.
+  # A more advanced prime sieve. Generates an n amount of prime values.
   #   Euler.get_primes(50)
   #   Euler::primes[0] # => 2
   #   Euler::primes[2] # => 5
@@ -176,8 +163,8 @@ module Euler
     a**2 + b**2 == c**2
   end
   
-  # Given two values of a pythagorean triplet, and nil for the missing
-  # value, it returns the missing value.
+  # Given two values of a pythagorean triplet, and nil for the missing value,
+  # it returns the missing value.
   #   Euler.find_missing_pyth_value(nil, 4, 5) # => 3
   def find_missing_pyth_value(a, b, c)
     return Math.sqrt(c**2 - b**2) if a.nil?

data/test/tc_integer_methods.rb

@@ -0,0 +1,44 @@
+require "test/unit"
+
+require "euler"
+
+class TestIntegerMethods < Test::Unit::TestCase
+  def test_factorial
+    assert_equal(0, 0.factorial, "0! == 0")
+    assert_equal(1, 1.factorial, "1! == 1")
+    assert_equal(120, 5.factorial, "5! == 120")
+  end
+  
+  def test_prime_factors
+    assert_equal([2, 5], 10.prime_factors, "10 factors into 2 and 5.")
+    assert_equal([2, 2, 5], 20.prime_factors, "20 factors into 2, 2, and 5.")
+  end
+  
+  def test_primality
+    assert(!1.prime?, "1 is not a prime.")
+    assert(2.prime?, "2 is the first prime.")
+    assert(3.prime?, "3 is the second prime.")
+    assert(29.prime?, "29 is the tenth prime.")
+    assert(!77.prime?, "77 is not a prime.")
+  end
+  
+  def test_permutations
+    assert(132.is_permutation?(123), "132 is a permutation of 123.")
+    assert(!3344.is_permutation?(3444), "3344 is not a permutation of 3444.")
+  end
+  
+  def test_pandigitial
+    assert(1234567890.is_pandigital?(0..9), "124567890 is a 0 to 9 pandigital.")
+    assert(!123456789.is_pandigital?(0..9), "12346789 is not a 0 to 9 pandigital.");
+  end
+  
+  def test_fibonacci
+    assert(1.is_fibonacci?, "1 is the first & second fibonacci numbers")
+    assert(8.is_fibonacci?, "8 is the sixth fibonacci number")
+  end
+  
+  def test_length
+    assert_equal(2, 10.length, "10 has a length of 2")
+    assert_equal(4, 4563.length, "4563 has a length of 4")
+  end
+end

data/test/tc_module.rb

@@ -0,0 +1,40 @@
+require "test/unit"
+
+require "euler"
+
+class TestModule < Test::Unit::TestCase
+  def test_sieve
+    Euler.generate_sieve(50)
+    assert_equal(50, Euler::sieve.length, "Euler.sieve(50) should make Euler::sieve an array of length 50.")
+    assert(!Euler::sieve[0], "O is not prime.")
+    assert(!Euler::sieve[1], "1 is not prime.")
+    assert(Euler::sieve[2], "2 is the first prime.")
+    assert(Euler::sieve[3], "3 is the second prime.")
+    assert(Euler::sieve[29], "29 is the tenth prime.")
+    assert(!Euler::sieve[50], "50 is not prime.")
+  end
+
+  def test_get_primes
+    Euler.get_primes(50)
+    assert_equal(50, Euler::primes.length, "Euler.get_primes(50) should make Euler::primes an array of length 50")
+    assert_equal(2, Euler::primes[0], "2 is the first prime.")
+    assert_equal(29, Euler::primes[9], "29 is the tenth prime.")
+  end
+  
+  def test_get_fibonaccis
+    Euler.get_fibonaccis(50)
+    assert_equal(2, Euler::fibonaccis[2], "2 is the third fibonaccis number.")
+    assert_equal(39088169, Euler::fibonaccis[37], "39088169 is the thirty eighth fibonacci number.")
+  end
+  
+  def test_pythagorean_triplet
+    assert(Euler.is_pythagorean_triplet?(3, 4, 5), "3, 4, 5 is the smallest pythagorean triplet.")
+    assert(!Euler.is_pythagorean_triplet?(1, 2, 3), "1, 2, 3 is not a pythagorean triplet.")
+  end
+  
+  def test_find_missing_pyth_value
+    assert_equal(3, Euler.find_missing_pyth_value(nil, 4, 5))
+    assert_equal(4, Euler.find_missing_pyth_value(3, nil, 5))
+    assert_equal(5, Euler.find_missing_pyth_value(3, 4, nil))
+  end
+end

data/test/test_euler.rb

@@ -0,0 +1,4 @@
+#!/usr/bin/ruby
+require 'test/unit/testsuite'
+require 'tc_integer_methods.rb'
+require 'tc_module.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Oompa-euler
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - Mike Skalnik
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-25 00:00:00 -07:00
+date: 2008-08-26 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -20,14 +20,15 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.mkdn
-- LICENSE
+- README.txt
+- History.txt
 files: 
-- LICENSE
-- README.mkdn
+- README.txt
+- History.txt
+- Manifest.txt
 - lib/euler.rb
 has_rdoc: true
-homepage: http://theoompa.com
+homepage: http://www.github.com/Oompa/euler
 post_install_message: 
 rdoc_options: []
 
@@ -47,10 +48,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: euler
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: A gem that provides a small library to help in the solving of Project Euler problems.
-test_files: []
-
+summary: A small library to help solve Projet Euler problems.
+test_files: 
+- test/tc_integer_methods.rb
+- test/tc_module.rb
+- test/test_euler.rb

data/README.mkdn

@@ -1,5 +0,0 @@
-Read me
-========
-
-## What is libeuler?
-libeuler is a simple library you can include in your code to take away some of the boring repetitive parts of solving Project Euler problems.