Commatose 0.0.1

data/README

@@ -0,0 +1,133 @@
+= Commatose Documentation
+
+Commatose makes it easy to insert commas into your numbers. It extends the Fixnum, Bignum and Float classes with a new method called "to_sc". The method name is short for "To string with comma". Using Commatose couldn't be easier. Let's take a look at a few examples.
+
+== Fixnums
+
+Commatose can convert fixnums like so:
+
+	require 'commatose'
+	puts "Example 1"
+	num = 1234567
+	puts "The number in this example is a #{num.class}."
+	puts "Before:\t#{num}"
+	puts "After:\t#{num.to_sc}"
+
+The code above returns:
+
+	Example 1
+	The number in this example is a Fixnum.
+	Before:	1234567
+	After:		1,234,567
+
+{Learn more}[link:/classes/Fixnum.html]
+
+== Bignums
+
+Commatose can also convert bignums:
+
+	require 'commatose'
+	puts "Example 2"
+	num = 1234567890
+	puts "The number in this example is a #{num.class}."
+	puts "Before:\t#{num}"
+	puts "After:\t#{num.to_sc}"
+
+The code above returns:
+
+	Example 2
+	The number in this example is a Bignum.
+	Before:	1234567890
+	After:		1,234,567,890
+
+{Learn more}[link:/classes/Bignum.html]
+
+== Floats
+
+Commatose also handles floats:
+
+	require 'commatose'
+	puts "Example 3"
+	num = 1234567.89
+	puts "The number in this example is a #{num.class}."
+	puts "Before:\t#{num}"
+	puts "After:\t#{num.to_sc}"
+
+The code above returns:
+
+	Example 3
+	The number in this example is a Float.
+	Before:	1234567.89
+	After:		1,234,567.89
+
+{Learn more}[link:/classes/Float.html]
+
+== Custom Delimiters
+
+Commatose also supports using a custom separator. Here's a fixnum that's split by underscores instead of commas.
+
+	require 'commatose'
+	puts "Example 4"
+	num = 1234567
+	puts "The number in this example is a #{num.class}."
+	puts "Before:\t#{num}"
+	puts "After:\t#{num.to_sc("_")}"
+
+The code above returns:
+
+	Example 4
+	The number in this example is a Fixnum.
+	Before:	1234567
+	After:		1_234_567
+
+Commatose can use any string as a separator, including the infamous "Chunky bacon".
+
+	require 'commatose'
+	puts "Example 5"
+	num = 1234567
+	puts "The number in this example is a #{num.class}."
+	puts "Before:\t#{num}"
+	puts "After:\t#{num.to_sc(" Chunky bacon! ")}"
+
+The code above returns:
+
+	Example 5
+	The number in this example is a Fixnum.
+	Before:	1234567
+	After:		1 Chunky bacon! 234 Chunky bacon! 567
+
+== Numbers per Section
+
+Commatose allows you to change the number of digits between separators.
+
+	require 'commatose'
+	puts "Example 6"
+	num = 1234567
+	puts "The number in this example is a #{num.class}."
+	puts "Before:\t#{num}"
+	puts "After:\t#{num.to_sc(",", 2)}"
+
+The code above returns:
+
+	Example 6
+	The number in this example is a Fixnum.
+	Before:	1234567
+	After:		1,23,45,67
+
+== Post Decimal Commatization
+
+By default, Commatose doesn't split numbers in a float that occur after the decimal point. You can force it to split after the decimal by specifying "true" as the second argument. Note that this only applies to a float.
+
+	require 'commatose'
+	puts "Example 7"
+	num = 1234.56789
+	puts "The number in this example is a #{num.class}."
+	puts "Before:\t#{num}"
+	puts "After:\t#{num.to_sc(",", 3, true)}"
+
+The code above returns:
+
+	Example 7
+	The number in this example is a Float.
+	Before:	1234.56789
+	After:		1,234.56,789

data/commatose.rb

@@ -0,0 +1,87 @@
+#= Commatose
+#Commatose makes it easy to insert commas into your Fixnums, Bignums and Floats. See below for more information.
+class Fixnum
+	#Converts the number to a string and splits it by commas.
+	#
+	#Example:
+	#	1234567.to_sc
+	#	>1,234,567
+	#
+	#You can change the delimiter by giving a string as an argument.
+	#
+	#Example:
+	#	1234567.to_sc("_")
+	#	>1_234_567
+	#
+	#Commatose can also change the number of digits between seperators.
+	#
+	#Example:
+	#	1234567.to_sc(",", 2)
+	#	>1,23,45,67
+	def to_sc(delimiter = ",", numbers_per_section = 3)
+		self.to_s.gsub(/(\d)(?=\d{#{numbers_per_section}}+(\.\d*)?$)/, '\1' + delimiter)
+	end
+end
+
+#= Commatose
+#Commatose makes it easy to insert commas into your Fixnums, Bignums and Floats. See below for more information.
+class Bignum
+	#Converts the number to a string and splits it by commas.
+	#
+	#Example:
+	#	1234567890.to_sc
+	#	>1,234,567,890
+	#
+	#You can change the delimiter by giving a string as an argument.
+	#
+	#Example:
+	#	1234567890.to_sc("_")
+	#	>1_234_567_890
+	#
+	#Commatose can also change the number of digits between seperators.
+	#
+	#Example:
+	#	1234567890.to_sc(",", 2)
+	#	>12,34,56,78,90
+	def to_sc(delimiter = ",", numbers_per_section = 3)
+		self.to_s.gsub(/(\d)(?=\d{#{numbers_per_section}}+(\.\d*)?$)/, '\1' + delimiter)
+	end
+end
+
+#= Commatose
+#Commatose makes it easy to insert commas into your Fixnums, Bignums and Floats. See below for more information.
+class Float
+	#Converts the number to a string and splits it by commas.
+	#
+	#Example:
+	#	12345.67.to_sc
+	#	>12,345.67
+	#
+	#You can change the delimiter by giving a string as an argument.
+	#
+	#Example:
+	#	12345,67.to_sc("_")
+	#	>12_345.67
+	#
+	#Commatose can also change the number of digits between seperators.
+	#
+	#Example:
+	#	12345.67.to_sc(",", 2)
+	#	>1,23,45.67
+	#
+	#Commatose normally doesn't split any numbers after a decimal point. You can override that behavior by making the second argument true.
+	#
+	#Example:
+	#	1234.56789.to_sc
+	#	>1,234.56789
+	#
+	#	1234.56789.to_sc(",", 3, true)
+	#	>1,234.56,789
+	def to_sc(delimiter = ",", numbers_per_section = 3, after_decimal = false)
+		if after_decimal then
+			self.to_s.gsub(/(\d)(?=\d{#{numbers_per_section}}+(\.\d*)?$)/, '\1' + delimiter)
+		else
+			self.to_s.split(".")[0].gsub(/(\d)(?=\d{#{numbers_per_section}}+(\.\d*)?$)/, '\1' + delimiter) + "." + self.to_s.split(".")[1]
+		end
+	end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification 
+name: Commatose
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Acts as Buffoon (A.K.A. Michael Tomer)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-03 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: Michael.Tomer@fnis.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- commatose.rb
+- README
+has_rdoc: true
+homepage: http://actsasbuffoon.wordpress.com
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- .
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Commatose makes it easy to split your numbers by commas.
+test_files: []
+