magician 0.1.1 → 0.2.0

data/.document

@@ -3,3 +3,4 @@ bin/*
 - 
 features/**/*.feature
 LICENSE.txt
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+## 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
+- 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
+
+## 0.1.1
+- Minor code style improvements
+- Improved documentation
+	- Fix spelling errors
+	- Document all nil returns
+
+## 0.1.0
+- Initial release

data/README.md

@@ -2,8 +2,40 @@
 
 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).
+
+## Examples
+```ruby
+>> require 'magician'
+=> true
+>> [1,2,3].sum
+=> 6
+>> [1,2,3].mean
+=> 2.0
+>> [1,100,5].range
+=> 99
+>> [1,2,2,3,3,3].occurences
+=> {1=>1, 2=>2, 3=>3}
+>> 6.factors
+=> [1, 2, 3, 6]
+>> 6.divisible? 3
+=> true
+>> 7.prime?
+=> true
+>> 5.factorial
+=> 120
+>> Math.combinations(10,5)
+=> 252
+>> Math.triplet?(3,4,5)
+=> true
+>> Math.quadratic(2,1,0)
+=> [-0.5, 0.0]
+>> 'racecar'.palindrome?
+=> true
+```
+
 ## 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.
 - Check out the issue tracker to make sure someone already hasn't requested it
@@ -18,6 +50,4 @@ A suite of handy methods for doing calculations in irb.
 	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) 2012 Nicolas McCurdy. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/magician/array.rb

@@ -1,53 +1,69 @@
 # Magician's extensions to the Array class.
 class Array
 
-	# Gets the sum of the numbers in the array. The sum of an empty array is 0.
+	# 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
-		return 0 if self.empty?
-		inject(:+)
+		nums = numerics
+		return 0 if nums.empty?
+		nums.inject(:+)
 	end
 
-	# Gets the product of the numbers in the array. The product of an empty array
-	# is 1.
+	# 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
-		return 1 if self.empty?
-		inject(:*)
+		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 empty array is nil.
+	# an array with no numbers is nil.
 	#
 	# @return [Numeric] the range of the numbers in the array
 	def range
-		return nil if self.empty?
-		max - min
+		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 empty
-	# array is nil.
+	# 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
-		return nil if self.empty?
-		sum.to_f / size
+		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). If the array has an even length, the middle
-	# two values are averaged. The median of an empty array is nil.
+	# 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
-		return nil if self.empty?
-		sorted = sort
+		nums = numerics
+		return nil if nums.empty?
+		sorted = nums.sort
 		if sorted.length.odd?
-			self[length/2]
+			nums[nums.length/2]
 		else
-			(self[length/2-1] + self[length/2]) / 2.0
+			(nums[nums.length/2-1] + nums[nums.length/2]) / 2.0
 		end
 	end
 
@@ -57,7 +73,7 @@ class Array
 	# @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 self.empty?
+		return nil if empty?
 		occ = occurences
 		max_occ = occ.values.max
 		occ.select { |key, value| value == max_occ }.keys
@@ -72,8 +88,8 @@ class Array
 	# array
 	def occurences
 		occurences = {}
-		self.each { |item| occurences[item] = 0 }
-		self.each { |item| occurences[item] += 1 }
+		each { |item| occurences[item] = 0 }
+		each { |item| occurences[item] += 1 }
 		occurences
 	end
 

data/lib/magician/integer.rb

@@ -9,12 +9,12 @@ class Integer
 	# order, including 1 and the integer itself)
 	def factors
 		return nil if self == 0
-		return [1] if self.abs == 1
+		return [1] if abs == 1
 		#first half
 		factors = []
-		for i in 1..self.abs
-			if self.abs % i == 0
-				if i < self.abs/i
+		for i in 1..abs
+			if abs % i == 0
+				if i < abs/i
 					factors << i
 				else break
 				end
@@ -23,7 +23,7 @@ class Integer
 		#second half
 		factors_old = factors.dup
 		until factors_old.length == 0
-			factors << self.abs/factors_old.pop
+			factors << abs/factors_old.pop
 		end
 		factors
 	end
@@ -52,15 +52,4 @@ class Integer
 		true
 	end
 
-	# Returns true if the integer is evenly divisible by n. If n is 0, it returns
-	# false, since numbers cannot be divided by 0 in real number arithmetic.
-	#
-	# @param [Numeric] n the number the integer should be divided by
-	#
-	# @return [Boolean] true if the integer is evenly divisible by n
-	def divisible? n
-		return false if n.zero?
-		(self % n).zero?
-	end
-
 end

data/lib/magician/numeric.rb

@@ -1,7 +1,19 @@
 # Magician's extensions to the Numeric class (affects Integers and Floats).
 class Numeric
 
-	# Performs self.to_s[selection].to_i on the number. Note that for floats, the
+	# Returns true if the number is evenly divisible by n. If n is equal to 0, it
+	# returns false, since numbers cannot be divided by 0 in real number
+	# arithmetic.
+	#
+	# @param [Numeric] n the number that this number (self) should be divided by
+	#
+	# @return [Boolean] true if the number is evenly divisible by n
+	def divisible? n
+		return false if n.zero?
+		(self % n).zero?
+	end
+
+	# Performs to_s[selection].to_i on the number. Note that for floats, the
 	# decimal counts as a digit within the string.
 	# TODO: Let this intelligently convert back to an Integer or Float.
 	#
@@ -11,7 +23,7 @@ class Numeric
 	# @return [Integer] substring of the number (using []), converted to an
 	# Integer
 	def digits selection
-		self.to_s[selection].to_i
+		to_s[selection].to_i
 	end
 
 end

data/magician.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "magician"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nicolas McCurdy"]
-  s.date = "2012-12-01"
+  s.date = "2012-12-03"
   s.description = "A suite of handy methods for doing calculations in irb."
   s.email = "thenickperson@gmail.com"
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     ".travis.yml",
+    "CHANGELOG.md",
     "Gemfile",
     "LICENSE.txt",
     "README.md",

data/spec/array_spec.rb

@@ -2,28 +2,43 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Array do
 
+	it 'should return all of its Numerics in order' do
+		[1, 2.0, -3].numerics.should == [1, 2.0, -3]
+		['string'].numerics.should == []
+		[].numerics.should == []
+		[1, 'two', 3, 'four'].numerics.should == [1, 3]
+	end
+
 	it 'should calculate its sum' do
 		[].sum.should == 0
+		['string'].sum.should == 0
 		[1].sum.should == 1
+		['string', 1].sum.should == 1
 		[1, 2, 3, 4].sum.should == 10
 		[-4, 0, 5].sum.should == 1
 	end
 
 	it 'should calculate its product' do
 		[].product.should == 1
+		['string'].product.should == 1
 		[1].product.should == 1
+		['string', 1].product.should == 1
 		[5, 7, 2].product.should == 70
 	end
 
 	it 'should calculate its range' do
 		[].range.should == nil
+		['string'].range.should == nil
 		[4].range.should == 0
+		['string', 4].range.should == 0
 		[5, 1, 10].range.should == 9
 	end
 
 	it 'should calculate its mean' do
 		[].mean.should == nil
+		['string'].mean.should == nil
 		[4].mean.should == 4
+		['string', 4].mean.should == 4
 		[-3, 0, 6].mean.should == 1
 		[1, 2, 3, 4, 5].mean.should == 3
 	end
@@ -31,20 +46,25 @@ describe Array do
 	it 'should calculate its median' do
 		[].median.should == nil
 		[4].median.should == 4.0
+		['string', 4].median.should == 4.0
 		[2, 1, 3, 5, 4].median.should == 3.0
 		[1, 2, 3, 4].median.should == 2.5
 	end
 
 	it 'should calculate its mode' do
 		[].mode.should == nil
+		['string'].mode.should == ['string']
 		[4].mode.should == [4]
+		['string', 4].mode.should == ['string',4]
 		[1, 2, 1, 3, 1, 4].mode.should == [1]
 		[1, 1, 1, 2, 2, 2, 3].mode.should == [1, 2]
 	end
 
 	it 'should calculate a hash holding numbers of occurrences of its items' do
 		[].occurences.should == {}
+		['string'].occurences.should == { 'string'=>1 }
 		[4].occurences.should == { 4=>1 }
+		['string', 4].occurences.should == { 'string'=>1, 4=>1 }
 		[1, 2, 2, 5].occurences.should == { 1=>1, 2=>2, 5=>1 }
 	end
 

data/spec/integer_spec.rb

@@ -32,14 +32,4 @@ describe Integer do
 		-6.prime?.should be_false
 	end
 
-	it 'should determine if it is divisible by another number' do
-		0.divisible?(5).should be_true
-		1.divisible?(6).should be_false
-		-1.divisible?(1).should be_true
-		12.divisible?(6).should be_true
-		6.divisible?(5).should be_false
-		9.divisible?(1.5).should be_true
-		10.divisible?(0).should be_false
-	end
-
 end

data/spec/numeric_spec.rb

@@ -2,6 +2,19 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Numeric do
 
+	it 'should determine if it is divisible by another number' do
+		0.divisible?(5).should be_true
+		1.divisible?(6).should be_false
+		-1.divisible?(1).should be_true
+		12.divisible?(6).should be_true
+		6.divisible?(5).should be_false
+		10.divisible?(0).should be_false
+		9.divisible?(1.5).should be_true
+		9.0.divisible?(1.5).should be_true
+		10.5.divisible?(1.5).should be_true
+		10.5.divisible?(1).should be_false
+	end
+
 	it 'should grab specific digits from different numbers' do
 		Math::PI.digits(0..-1).should == 3
 		12345.digits(0..2).should == 123

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magician
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-01 00:00:00.000000000 Z
+date: 2012-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -118,6 +118,7 @@ files:
 - .document
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -153,7 +154,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2635961885196991731
+      hash: -956776375334094677
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: