magician 0.1.0 → 0.1.1

data/Gemfile

@@ -5,10 +5,10 @@ source :rubygems
 # 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.12.0'
+	gem 'yard', '~> 0.7'
+	gem 'rdoc', '~> 3.12'
+	gem 'bundler'
+	gem 'jeweler', '~> 1.8.4'
+	gem 'simplecov'
 end

data/README.md

@@ -4,13 +4,18 @@ A suite of handy methods for doing calculations in irb.
 
 ## 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 and/or contributed it.
+- 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
+	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.
-- 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.
+- Make sure to add tests for it. This is important so I don't break it in a
+	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.
 
 ## Copyright
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/magician/array.rb

@@ -55,7 +55,7 @@ class Array
 	# 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 freqeuntly (they must all have the same number of occurences)
+	# most frequently (they must all have the same number of occurrences)
 	def mode
 		return nil if self.empty?
 		occ = occurences
@@ -63,12 +63,12 @@ class Array
 		occ.select { |key, value| value == max_occ }.keys
 	end
 
-	# Gets a hash table with the number of occurences of each item from the
+	# 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 occurences of the associated key
+	# values are integers counting the number of occurrences of the associated key
 	# values.
 	#
-	# @return [Hash] a hash table of the occurences of each item from the original
+	# @return [Hash] a hash table of the occurrences of each item from the original
 	# array
 	def occurences
 		occurences = {}

data/lib/magician/integer.rb

@@ -3,7 +3,7 @@ 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).
+	# 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)
@@ -25,7 +25,7 @@ class Integer
 		until factors_old.length == 0
 			factors << self.abs/factors_old.pop
 		end
-		return factors
+		factors
 	end
 
 	# Gets the factorial of the integer, which is equivalent to the product of all
@@ -49,7 +49,7 @@ class Integer
 		for i in 2..Math.sqrt(self)
 			return false if self % i == 0
 		end
-		return true
+		true
 	end
 
 	# Returns true if the integer is evenly divisible by n. If n is 0, it returns

data/lib/magician/math.rb

@@ -6,7 +6,7 @@ module Math
 
 	# Solves a quadratic formula of the form "ax^2+bx+c=0" for x, where a is not
 	# 0. It asks for the three coefficients of the function (a, b, and c), and
-	# returns the two possible values for x.
+	# returns the two possible values for x. Returns nil if a is 0.
 	#
 	# @param [Numeric] a the first coefficient (must not be 0)
 	# @param [Numeric] b the second coefficient
@@ -30,7 +30,7 @@ module Math
 	# @return [Integer] the number of permutations
 	def permutations(n, k)
 		return nil if n < 0 or k < 0 or n < k
-		return n.factorial / (n-k).factorial
+		n.factorial / (n-k).factorial
 	end
 
 	# The number of size k unordered subsets of a set of size n. Equivalent to
@@ -42,28 +42,29 @@ module Math
 	# @return [Integer] the number of combinations
 	def combinations(n, k)
 		return nil if n < 0 or k < 0 or n < k
-		return n.factorial / (k.factorial * (n-k).factorial)
+		n.factorial / (k.factorial * (n-k).factorial)
 	end
 
 	# Get the number of steps it takes to get from integer n to 1 using the
-	# Collatz Conjecture (set http://en.wikipedia.org/wiki/Collatz_conjecture).
+	# Collatz conjecture (set http://en.wikipedia.org/wiki/Collatz_conjecture).
+	# Returns nil if n < 1.
 	#
-	# @param [Integer] n the number to put into the Collatz Conjecture initially
+	# @param [Integer] n the number to put into the Collatz conjecture initially
 	# @param [Integer] depth the number of steps that have passed so far (should
 	# not be modified unless this is being cached carefully)
 	#
 	# @return [Integer] the number of steps it takes to get from integer n to 1
-	# using the Collatz Conjecture (the depth)
+	# using the Collatz conjecture (the depth)
 	def collatz(n, depth=0)
 		return nil if n < 1
 		if n == 1
-			return depth
+			depth
 		elsif n % 2 == 0
 			depth += 1
-			return collatz(n/2, depth)
+			collatz(n/2, depth)
 		else
 			depth += 1
-			return collatz(3*n + 1, depth)
+			collatz(3*n + 1, depth)
 		end
 	end
 

data/magician.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "magician"
+  s.version = "0.1.1"
+
+  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.description = "A suite of handy methods for doing calculations in irb."
+  s.email = "thenickperson@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/magician.rb",
+    "lib/magician/array.rb",
+    "lib/magician/integer.rb",
+    "lib/magician/math.rb",
+    "lib/magician/numeric.rb",
+    "lib/magician/shortcuts.rb",
+    "lib/magician/string.rb",
+    "magician.gemspec",
+    "spec/array_spec.rb",
+    "spec/integer_spec.rb",
+    "spec/math_spec.rb",
+    "spec/numeric_spec.rb",
+    "spec/shortcuts_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/string_spec.rb"
+  ]
+  s.homepage = "http://github.com/thenickperson/magician"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A suite of handy methods for doing calculations in irb."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.12.0"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.12.0"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/spec/array_spec.rb

@@ -2,47 +2,47 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Array do
 
-	it 'should get the sum of a list' do
+	it 'should calculate its sum' do
 		[].sum.should == 0
 		[1].sum.should == 1
 		[1, 2, 3, 4].sum.should == 10
 		[-4, 0, 5].sum.should == 1
 	end
 
-	it 'should get the product of a list' do
+	it 'should calculate its product' do
 		[].product.should == 1
 		[1].product.should == 1
 		[5, 7, 2].product.should == 70
 	end
 
-	it 'should get the range of a list' do
+	it 'should calculate its range' do
 		[].range.should == nil
 		[4].range.should == 0
 		[5, 1, 10].range.should == 9
 	end
 
-	it 'should get the mean of a list' do
+	it 'should calculate its mean' do
 		[].mean.should == nil
 		[4].mean.should == 4
 		[-3, 0, 6].mean.should == 1
 		[1, 2, 3, 4, 5].mean.should == 3
 	end
 
-	it 'should get the median of a list' do
+	it 'should calculate its median' do
 		[].median.should == nil
 		[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 get the mode of a list' do
+	it 'should calculate its mode' do
 		[].mode.should == nil
 		[4].mode.should == [4]
 		[1, 2, 1, 3, 1, 4].mode.should == [1]
 		[1, 1, 1, 2, 2, 2, 3].mode.should == [1, 2]
 	end
 
-	it 'should get a hash with the number of occurences of items in a list' do
+	it 'should calculate a hash holding numbers of occurrences of its items' do
 		[].occurences.should == {}
 		[4].occurences.should == { 4=>1 }
 		[1, 2, 2, 5].occurences.should == { 1=>1, 2=>2, 5=>1 }

data/spec/integer_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Integer do
 
-	it 'should get the factors of an integer' do
+	it 'should calculate its factors' do
 		0.factors.should == nil
 		1.factors.should == [1]
 		6.factors.should == [1, 2, 3, 6]
@@ -12,7 +12,7 @@ describe Integer do
 		-7.factors.should == [1, 7]
 	end
 
-	it 'should get the factorial of an integer' do
+	it 'should calculate its factorial' do
 		0.factorial.should == 1
 		1.factorial.should == 1
 		-1.factorial.should == nil
@@ -20,7 +20,7 @@ describe Integer do
 		10.factorial.should == 3_628_800
 	end
 
-	it 'should determine if an integer is prime' do
+	it 'should determine if it is prime' do
 		0.prime?.should be_false
 		1.prime?.should be_false
 		2.prime?.should be_true
@@ -32,7 +32,7 @@ describe Integer do
 		-6.prime?.should be_false
 	end
 
-	it 'should determine if an integer is divisible by another number' 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

data/spec/math_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Math do
 
-	it 'should solve a quadratic formula' do
+	it 'should solve quadratic formulas' do
 		Math.quadratic(1, 2, 1).should == [-1.0, -1.0]
 		Math.quadratic(1, 1, 0).should == [-1.0, 0.0]
 		Math.quadratic(1, 0, 0).should == [0.0, 0.0]
@@ -12,7 +12,7 @@ describe Math do
 		#Math.quadratic(1, 1, 1).should == 'change me'
 	end
 
-	it 'should get the number of permutations with n and k' do
+	it 'should calculate permutations of n and k' do
 		Math.permutations(10, 5).should == 30_240
 		Math.permutations(5, 5).should == 120
 		Math.permutations(5, 0).should == 1
@@ -24,7 +24,7 @@ describe Math do
 		Math.permutations(-5, -5).should == nil
 	end
 
-	it 'should get the number of combinations with n and k' do
+	it 'should calculate combinations of n and k' do
 		Math.combinations(10, 5).should == 252
 		Math.combinations(5, 10).should == nil
 		Math.combinations(5, 5).should == 1
@@ -36,7 +36,7 @@ describe Math do
 		Math.combinations(-5, -5).should == nil
 	end
 
-	it 'should get the number of steps to finish the Collatz Conjecture' do
+	it 'should calculate the number of steps to finish the Collatz conjecture' do
 		Math.collatz(-1).should == nil
 		Math.collatz(0).should == nil
 		Math.collatz(1).should == 0
@@ -45,14 +45,14 @@ describe Math do
 		Math.collatz(100).should == 25
 	end
 
-	it 'should get the length of a hypotenuse with the Pythagorean theorem' do
+	it 'should calculate the lengths of hypotenuses' do
 		Math.hypotenuse(0, 0).should == 0
 		Math.hypotenuse(Math.sqrt(5), 2).should == 3
 		Math.hypotenuse(1, 1).should == Math.sqrt(2)
 		Math.hypotenuse(5, -5).should be_nil
 	end
 
-	it 'should determine if three given numbers form a Pythagorean triplet' do
+	it 'should determine if given numbers form Pythagorean triplets' do
 		Math.triplet?(3, 4, 5).should be_true
 		Math.triplet?(5, 12, 13).should be_true
 		Math.triplet?(7, 24, 25).should be_true
@@ -65,7 +65,7 @@ describe Math do
 		Math.triplet?(-1, -1, -1).should be_false
 	end
 
-	it 'should calculate a series of Fibonacci numbers of a specified length' do
+	it 'should calculate series of Fibonacci numbers of specified lengths' do
 		Math.fibs(-1).should == nil
 		Math.fibs(0).should == []
 		Math.fibs(1).should == [1]

data/spec/numeric_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Numeric do
 
-	it 'should get specific digits from a number' do
+	it 'should grab specific digits from different numbers' do
 		Math::PI.digits(0..-1).should == 3
 		12345.digits(0..2).should == 123
 		12345.digits(4).should == 5

data/spec/shortcuts_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe 'Shortcuts' do
 
-	it 'should properly alias certain values' do
+	it 'should properly alias certain values from Math' do
 		PI.should == Math::PI
 		E.should == Math::E
 	end

data/spec/string_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe String do
 
-	it 'should determine if a string is a palindrome' do
+	it 'should determine if it is a palindrome' do
 		''.palindrome?.should be_true
 		'a'.palindrome?.should be_true
 		'deed'.palindrome?.should be_true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magician
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2012-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -130,6 +130,7 @@ files:
 - lib/magician/numeric.rb
 - lib/magician/shortcuts.rb
 - lib/magician/string.rb
+- magician.gemspec
 - spec/array_spec.rb
 - spec/integer_spec.rb
 - spec/math_spec.rb
@@ -152,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3387386332341206942
+      hash: -2635961885196991731
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: