fortyk 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nick Hammond
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,48 @@
+= fortyk
+
+Take your long numbers and convert them to their shorter version.
+
+== Install
+
+  sudo gem install fortyk
+  
+In your environment.rb file add
+
+  config.gem 'fortyk'
+  
+== Usage
+
+You can convert any string or number into it's shortened version, just called shorten_number or shorten_money depending on what you want.
+
+  40000.shorten_number # 40K
+  "$1,000,000".shorten_money # $1M
+  "40000".shorten_money $ $40K
+  1000.shorten_number # 1K
+  1500.shorten_number # 1.5K
+  "123,334,000,234".shorten_number # "123.3B"
+  
+shorten_money just prepends a "$" sign to the shortened number. If you want to use a different currency just pass in the symbol for it to the shorten_money method
+
+  "$3,500".shorten_money(:currency => "£")
+  
+See the tests and examples for more uses
+
+== TODO
+
+* Support precision options
+* Improve upon number parsing
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Nick Hammond. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fortyk"
+    gem.summary = %Q{Shortens long numbers. i.e. 40000 => 40K}
+    gem.description = %Q{Converts long numbers to their shorter form}
+    gem.email = "nick@nickhammond.com"
+    gem.homepage = "http://github.com/nrhammond/fortyk"
+    gem.authors = ["Nick Hammond"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fortyk #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/fortyk.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{fortyk}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nick Hammond"]
+  s.date = %q{2010-03-22}
+  s.description = %q{Converts long numbers to their shorter form}
+  s.email = %q{nick@nickhammond.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "fortyk.gemspec",
+     "lib/TODO",
+     "lib/fortyk.rb",
+     "test/examples.rb",
+     "test/helper.rb",
+     "test/test_fortyk.rb"
+  ]
+  s.homepage = %q{http://github.com/nrhammond/fortyk}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Shortens long numbers. i.e. 40000 => 40K}
+  s.test_files = [
+    "test/examples.rb",
+     "test/helper.rb",
+     "test/test_fortyk.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/TODO

@@ -0,0 +1,2 @@
+* options for precision
+* better parsing

data/lib/fortyk.rb

@@ -0,0 +1,50 @@
+module Fortyk
+  def shorten_number
+    if self.is_a?(String)
+      self.gsub!(/[a-zA-z$,]/,"")
+    end
+    num = self.to_i
+    string = num.to_s
+    length = string.length
+    
+    case length
+    when 4..6 
+      label = "K"
+      upper = 4
+      lower = -3
+    when 7..9 
+      label = "M"
+      upper = 7
+      lower = -6
+    when 10..12 
+      label = "B"
+      upper = 10
+      lower = -9
+    else
+      label = nil
+    end
+    
+    if label
+      first = string[0..length - upper].to_i
+      last = string[lower..lower+2].to_i * 0.001
+      last = sprintf("%.1f", last).to_f
+      num = first + last
+      num = num.round if last.zero? || last == 1
+    end
+    
+    "#{num}#{label}"
+  end
+  
+  def shorten_money(options = {})
+    options[:currency] ||= "$"
+    "#{options[:currency]}#{self.shorten_number}"
+  end
+end
+
+class Numeric # :nodoc:
+  include Fortyk
+end
+
+class String # :nodoc:
+  include Fortyk
+end

data/test/examples.rb

@@ -0,0 +1,24 @@
+EXAMPLES = [
+  [40000, "40K"],
+  [40450, "40.5K"],
+  [40324, "40.3K"],
+  [40950, "41K"],
+  [41950, "42K"],
+  [4000,  "4K"],
+  [3890, "3.9K"],
+  [3222, "3.2K"],
+  [3522, "3.5K"],
+  ["$3,512", "3.5K"],
+  ["$3500", "3.5K"],
+  ["$300", "300"],
+  ["$10,000,000", "10M"],
+  [10500000, "10.5M"],
+  [100000999, "100M"],
+  ["$95,000,000", "95M"],
+  ["$2,000.00", "2K"],
+  ["$4,700,000", "4.7M"],
+  ["$4,695,000", "4.7M"],
+  ["$217,000", "217K"],
+  ["123,334,000,234", "123.3B"]
+]
+

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fortyk'
+require 'examples'
+
+class Test::Unit::TestCase
+end

data/test/test_fortyk.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class TestFortyk < Test::Unit::TestCase
+  context "default shorten number examples" do
+    EXAMPLES.each do |example|
+      should "convert #{example[0]} to #{example[1]}" do
+        assert_equal example[0].shorten_number, example[1]
+      end
+    end    
+  end
+  context "currency" do
+    should "put the $ sign in front" do
+      assert_equal 4000.shorten_money, "$4K"
+      assert_equal 4000.shorten_money(:currency => "$"), "$4K"
+    end
+    
+    should "put the # sign in front" do
+      assert_equal 4000.shorten_money(:currency => "#"), "#4K"
+    end
+    
+    should "display 1 point" do 
+      assert_equal 4100.shorten_money, "$4.1K"
+    end
+  end
+  context "precision" do
+    should "display 1 point" do
+      assert_equal 4100.shorten_number, "4.1K"
+    end
+    should "display 0 points" do 
+      assert_equal 4000.shorten_number, "4K"
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: fortyk
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Nick Hammond
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Converts long numbers to their shorter form
+email: nick@nickhammond.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- fortyk.gemspec
+- lib/TODO
+- lib/fortyk.rb
+- test/examples.rb
+- test/helper.rb
+- test/test_fortyk.rb
+has_rdoc: true
+homepage: http://github.com/nrhammond/fortyk
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Shortens long numbers. i.e. 40000 => 40K
+test_files: 
+- test/examples.rb
+- test/helper.rb
+- test/test_fortyk.rb