magician 0.2.1 → 0.3.0

data/.travis.yml

@@ -1,8 +1,6 @@
-language: ruby
-rvm:
-- 1.9.3
-- jruby-19mode # JRuby in 1.9 mode
-- rbx-19mode # Rubinius in 1.9 mode
-branches:
-  only:
-    - master
+language: ruby
+rvm:
+- 1.9.3
+- jruby-19mode # JRuby in 1.9 mode
+- rbx-19mode # Rubinius in 1.9 mode
+- 2.0

data/CHANGELOG.md

@@ -1,19 +1,47 @@
+## 0.3.0
+- Features
+  - Add Math.primes, which implements a fast prime sieve
+  - Add Array#numerics, which finds all Numerics in an Array
+  - Add Array#middle, an unsorted version of Array#median
+  - Add Numeric#to_radians and Numeric#to_degrees for conversion
+  - Add #boolean, #coin, and #die class/instance methods to the Random class
+  - Add an alias for Complex::I
+- Changes
+  - If an Array method that uses Numerics is called on an Array with non-Numeric
+    objects, magician will raise a RuntimeError instead of filtering out
+    non-Numeric objects without warning
+  - Methods will now tend to prefer raising descriptive errors over returning
+    nil without warning
+  - Support making Math.fibs start with any set of two or more terms
+  - Simplify and clean up some of the source code
+- Fixes
+  - Fix several issues with Integer#pandigital?
+  - Update the changelog to include changes in previous version 0.2.1
+
+## 0.2.1
+- Fix an issue with Array#median giving inaccurate results (it wasn't sorting
+  the list)
+- Performance improvements
+- Add Integer#pandigital?
+- Deprecate Numeric#digits
+- Add a shortcut for the golden ratio
+
 ## 0.2.0
 - Create this changelog
 - Add examples to the readme, along with a link to magician's docs
 - Minor code style improvements
 - Move the divisible? instance method from Integer to Numeric so it can be used
-	on more types of numbers
+  on more types of numbers
 - New Array#numerics instance method
 - Several of Array's instance methods will now intelligently filter out
-	non-numbers so that these methods can be used with arrays that don't just
-	contain Numeric objects
+  non-numbers so that these methods can be used with arrays that don't just
+  contain Numeric objects
 
 ## 0.1.1
 - Minor code style improvements
 - Improved documentation
-	- Fix spelling errors
-	- Document all nil returns
+  - Fix spelling errors
+  - Document all nil returns
 
 ## 0.1.0
 - Initial release

data/Gemfile

@@ -1,14 +1,14 @@
-source :rubygems
+source 'https://rubygems.org'
 
 # Add dependencies required to use your gem here.
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-	gem 'rspec', '~> 2.12.0'
-	gem 'yard', '~> 0.7'
-	gem 'rdoc', '~> 3.12'
-	gem 'bundler'
-	gem 'jeweler', '~> 1.8.4'
-	gem 'simplecov'
+  gem 'rspec', '~> 2.13'
+  gem 'yard', '~> 0.7'
+  gem 'rdoc', '~> 4.0'
+  gem 'bundler', '~> 1.2'
+  gem 'jeweler', '~> 1.8'
+  gem 'simplecov', '~> 0.7'
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Nicolas McCurdy
+Copyright (c) 2013 Nicolas McCurdy
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,15 @@
-# magician [![Build Status](https://secure.travis-ci.org/thenickperson/magician.png?branch=master)](http://travis-ci.org/thenickperson/magician) [![Dependency Status](https://gemnasium.com/thenickperson/magician.png)](https://gemnasium.com/thenickperson/magician) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/thenickperson/magician)
+# magician [![Gem Version](https://badge.fury.io/rb/magician.png)](http://badge.fury.io/rb/magician) [![Build Status](https://secure.travis-ci.org/thenickperson/magician.png?branch=master)](http://travis-ci.org/thenickperson/magician) [![Dependency Status](https://gemnasium.com/thenickperson/magician.png)](https://gemnasium.com/thenickperson/magician) [![Code Climate](https://codeclimate.com/github/thenickperson/magician.png)](https://codeclimate.com/github/thenickperson/magician)
 
 A suite of handy methods for doing calculations in irb.
 
-For detailed documentation, see
-[magician on RubyDoc.info](http://rubydoc.info/github/thenickperson/magician/frames).
+## [Documentation](http://rubydoc.info/github/thenickperson/magician/frames)
+
+## A note on Ruby 2.0 support
+With the latest release of magician, all tests pass on Ruby 1.9 and 2.0.
+However, magician depends on jeweler to work, which unfortunately does not seem
+to be compatible with Ruby 2.0 yet. As a result, magician will most likely not
+work on Ruby 2.0 at this point. If you come up with any fixes for this, please
+feel free to send me a pull request.
 
 ## Examples
 ```ruby
@@ -37,17 +43,17 @@ For detailed documentation, see
 
 ## Contributing to magician
 - Check out the latest master to make sure the feature hasn't been implemented
-	or the bug hasn't been fixed yet.
+  or the bug hasn't been fixed yet.
 - Check out the issue tracker to make sure someone already hasn't requested it
-	and/or contributed it.
+  and/or contributed it.
 - Fork the project.
 - Start a feature/bugfix branch.
 - Commit and push until you are happy with your contribution.
 - Make sure to add tests for it. This is important so I don't break it in a
-	future version unintentionally.
+  future version unintentionally.
 - Please try not to mess with the Rakefile, version, or history. If you want to
-	have your own version, or is otherwise necessary, that is fine, but please
-	isolate to its own commit so I can cherry-pick around it.
+  have your own version, or is otherwise necessary, that is fine, but please
+  isolate to its own commit so I can cherry-pick around it.
 
 ## Copyright
-Copyright (c) 2012 Nicolas McCurdy. See LICENSE.txt for further details.
+Copyright (c) 2013 Nicolas McCurdy. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/magician/array.rb

@@ -1,97 +1,138 @@
 # Magician's extensions to the Array class.
 class Array
 
-	# Returns all numbers from the array, in order. This is done by choosing all
-	# objects from the array that are instances of Numeric or one of its
-	# subclasses.
-	#
-	# @return [Array] a new array containing only Numerics
-	def numerics
-		select { |item| item.class <= Numeric }
-	end
-
-	# Gets the sum of the numbers in the array. The sum of an array with no
-	# numbers is 0.
-	#
-	# @return [Numeric] the sum of the numbers in the array
-	def sum
-		nums = numerics
-		return 0 if nums.empty?
-		nums.inject(:+)
-	end
-
-	# Gets the product of the numbers in the array. The product of an array with
-	# no numbers is 1.
-	#
-	# @return [Numeric] the product of the numbers in the array
-	def product
-		nums = numerics
-		return 1 if nums.empty?
-		nums.inject(:*)
-	end
-
-	# Gets the range of the numbers in the array (maximum - minimum). The range of
-	# an array with no numbers is nil.
-	#
-	# @return [Numeric] the range of the numbers in the array
-	def range
-		nums = numerics
-		return nil if nums.empty?
-		nums.max - nums.min
-	end
-
-	# Gets the mean (average) of the numbers in the array. The mean of an array
-	# with no numbers is nil.
-	#
-	# @return [Float] the mean (average) of the numbers in the array
-	def mean
-		nums = numerics
-		return nil if nums.empty?
-		nums.sum.to_f / nums.size
-	end
-
-	# Gets the median of the numbers in the array (the value in the middle of a
-	# sorted version of the array, numbers only). If the array has an even number
-	# of numbers, the middle two numbers will be averaged. The median of an array
-	# with no numbers is nil.
-	#
-	# @return [Numeric] the median of the numbers in the array
-	def median
-		sorted = numerics.sort
-		return nil if sorted.empty?
-		if sorted.length.odd?
-			sorted[sorted.length/2]
-		else
-			(sorted[sorted.length/2-1] + sorted[sorted.length/2]) / 2.0
-		end
-	end
-
-	# Gets the mode(s) of the items in the array (the item(s) that occur(s) most
-	# frequently). The mode of an empty array is nil.
-	#
-	# @return [Array] an array of all of the items in the array that occur the
-	# most frequently (they must all have the same number of occurrences)
-	def mode
-		return nil if empty?
-		occ = occurences
-		max_occ = occ.values.max
-		occ.select { |key, value| value == max_occ }.keys
-	end
-
-	# Gets a hash table with the number of occurrences of each item from the
-	# original array. The keys are the items from the original array, and the
-	# values are integers counting the number of occurrences of the associated key
-	# values.
-	#
-	# @return [Hash] a hash table of the occurrences of each item from the original
-	# array
-	def occurences
-		occurences = Hash.new(0)
-		each { |item| occurences[item] += 1 }
-		occurences
-	end
-
-	# Alias average to mean.
-	alias :average :mean
+  # Returns all numbers from the array, in order. This is done by choosing all
+  # objects from the array that are instances of Numeric or one of its
+  # subclasses.
+  #
+  # @return [Array] a new array containing only Numerics
+  def numerics
+    select { |item| item.class <= Numeric }
+  end
+
+  # Gets the sum of the array elements. The sum of an empty array is 0. The
+  # array must only contain Numerics or a RuntimeError will be raised.
+  #
+  # @return [Numeric] the sum of the elements of the array
+  #
+  # @raise [RuntimeError] if the Array contains non-Numeric objects
+  def sum
+    require_numerics
+
+    empty? ? 0 : reduce(:+)
+  end
+
+  # Gets the product of the array elements. The product of an empty array is 1.
+  # The array must only contain Numerics or a RuntimeError will be raised.
+  #
+  # @return [Numeric] the product of the elements of the array
+  #
+  # @raise [RuntimeError] if the Array contains non-Numeric objects
+  def product
+    require_numerics
+
+    empty? ? 1 : reduce(:*)
+  end
+
+  # Finds the middle element of the array. If the array has an even number of
+  # elements, the middle two elements will be averaged. The middle of an empty
+  # array is nil. The array must only contain Numerics or a RuntimeError will be
+  # raised.
+  #
+  # @return [Numeric, nil] the middle of the elements of the array
+  #
+  # @raise [RuntimeError] if the Array contains non-Numeric objects
+  def middle
+    require_numerics
+    return nil if empty?
+
+    middle_index = length / 2
+    length.odd? ? slice(middle_index) : [slice(middle_index-1), slice(middle_index)].mean
+  end
+
+  # Gets the range of the elements of the array (maximum - minimum). The range
+  # of an empty array is nil. The array must only contain Numerics or a
+  # RuntimeError will be raised.
+  #
+  # @return [Numeric, nil] the range of the elements of the array
+  #
+  # @raise [RuntimeError] if the Array contains non-Numeric objects
+  def range
+    require_numerics
+
+    empty? ? nil : max - min
+  end
+
+  # Gets the mean (average) of the elements of the array. The mean of an empty
+  # array is nil. The array must only contain Numerics or a RuntimeError will be
+  # raised.
+  #
+  # @return [Float, nil] the mean (average) of the elements of the array
+  #
+  # @raise [RuntimeError] if the Array contains non-Numeric objects
+  def mean
+    require_numerics
+
+    empty? ? nil : sum.to_f / length
+  end
+
+  # Sorts the array and finds the element in the middle. The exact same
+  # functionality can be achieved by sorting the array and then running the
+  # middle method on it. The array must only contain Numerics or a RuntimeError
+  # will be raised.
+  #
+  # @see middle
+  #
+  # @return [Numeric, nil] the median of the elements of the array
+  #
+  # @raise [RuntimeError] if the Array contains non-Numeric objects
+  def median
+    require_numerics
+
+    sort.middle
+  end
+
+  # Gets the mode(s) of the items in the array (the item(s) that occur(s) most
+  # frequently). The mode of an empty array is nil.
+  #
+  # @return [Array, nil] an array of all of the items in the array that occur
+  #   the most frequently (they must all have the same number of occurrences)
+  def mode
+    return nil if empty?
+
+    occ = occurences
+    max_occ = occ.values.max
+
+    occ.select { |key, value| value == max_occ }.keys
+  end
+
+  # Gets a hash table with the number of occurrences of each item from the
+  # original array. The keys are the items from the original array, and the
+  # values are integers counting the number of occurrences of the associated key
+  # values.
+  #
+  # @return [Hash] a hash table of the occurrences of each item from the original
+  #   array
+  def occurences
+    occurences = Hash.new 0
+    each { |item| occurences[item] += 1 }
+    occurences
+  end
+
+  # Alias average to mean.
+  alias :average :mean
+
+  private
+
+  # Requires that all objects in the Array are instances of Numeric (or one of
+  # its subclasses), and raises an error if they are not.
+  #
+  # @raise [RuntimeError] if the Array contains non-Numeric objects
+  def require_numerics
+    unless all? { |item| item.class <= Numeric }
+      calling_method = caller[0][/`.*'/][1..-2]
+      raise RuntimeError, "Array##{calling_method} requires that the Array only contains Numeric objects."
+    end
+  end
 
 end

data/lib/magician/integer.rb

@@ -1,55 +1,49 @@
 # Magician's extensions to the Integer class.
 class Integer
 
-	# Gets all of the factors of the current integer. If the current integer is
-	# negative, it will be treated as if it were positive (so the results will
-	# never contain negative integers). Returns nil if the integer is 0.
-	#
-	# @return [Array] an array of all of the factors of the current integer (in
-	# order, including 1 and the integer itself)
-	def factors
-		return nil if self == 0
-		return [1] if abs == 1
-		#first half
-		factors = [1]
-		2.upto((abs/2).to_i) do |i|
-			if abs%i == 0
-				factors << i 
-			end
-		end
-		factors << abs
-	end
-
-	# Gets the factorial of the integer, which is equivalent to the product of all
-	# integers from 1 to the integer (inclusive). When the integer is 0, it is
-	# equivalent to 1.
-	#
-	# @return [Integer] factorial of the integer
-	def factorial
-		return 1 if self == 0
-		(1..self).inject(:*)
-	end
-
-	# Returns true if the integer is prime (that is, if it is not divisible by any
-	# integer between 1 and the integer itself, exclusive). 0 and 1 are not prime
-	# numbers, though 2 is prime. Negative numbers are never considered prime in
-	# this implementation.
-	#
-	# @return [Boolean] true if the integer is prime
-	def prime?
-		return false if self <= 1
-		(2..Math.sqrt(self)).each do |i|
-			return false if self % i == 0
-		end
-		true
-	end
-
-	# Returns true if the number is pandigital. That is the number contains the
-	# each of the digits 1 through 9 exactly once.
-	#
-	# @return [Boolean] true if pandigital
-	def pandigital?
-		to_s.split(//).sort!.join.to_i == 123456789
-	end
+  # Gets all of the factors of the current integer. If the current integer is
+  # negative, it will be treated as if it were positive (so the results will
+  # never contain negative integers).
+  #
+  # @return [Array] an array of all of the factors of the current integer (in
+  #   order, including 1 and the integer itself)
+  #
+  # @raise [ArgumentError] if the integer is 0, since 0 has infinite factors
+  def factors
+    raise ArgumentError, '0 has infinite factors, so the Array of its factors cannot be computed in finite time' if zero?
+
+    1.upto(abs/2).select { |i| abs % i == 0 } << abs
+  end
+
+  # Gets the factorial of the integer, which is equivalent to the product of all
+  # integers from 1 to the integer (inclusive). When the integer is 0, it is
+  # equivalent to 1.
+  #
+  # @return [Integer] factorial of the integer
+  def factorial
+    return 1 if zero?
+
+    downto(1).reduce :*
+  end
+
+  # Returns true if the integer is prime (that is, if it is not divisible by any
+  # integer between 1 and the integer itself, exclusive). 0 and 1 are not prime
+  # numbers, though 2 is prime. Negative numbers are never considered prime in
+  # this implementation.
+  #
+  # @return [Boolean] true if the integer is prime
+  def prime?
+    return false if self <= 1
+
+    not 2.upto(Math.sqrt self).any? { |i| modulo(i) == 0 }
+  end
+
+  # Returns true if the integer is pandigital. That is, the integer contains
+  # each of the digits from 1 to 9 exactly once.
+  #
+  # @return [Boolean] true if the integer is pandigital
+  def pandigital?
+    to_s.split(//).sort.join == '123456789'
+  end
 
 end