gci-class-extensions 1.1.0 → 1.1.2

data/lib/gci-class-extensions.rb

@@ -42,3 +42,42 @@ module Enumerable
     counts
   end
 end
+
+class String
+  def is_valid_dollar_amount?
+    # Optional parentheses or negative sign before or after the optional dollar sign, any number of digits and commas, followed by optional . and 1 or 2 digits, and optional close parentheses, with nothing on either side
+    strip =~ /^[\(-]?\$?[\(-]?([\d,]+(\.\d{1,2})?|\.\d{1,2})\)?$/ ? true : false
+  end
+  
+  def scrubbed_dollar_amount
+    # first strip out dollar signs and commas, then convert "(12.34)" to "-12.34"
+    strip.gsub(/[\$,]/,"").gsub(/^\((.*)\)$/, '-\1')
+  end
+  
+  def scrubbed_dollar_amount_if_valid
+    is_valid_dollar_amount? ? scrubbed_dollar_amount : self
+  end
+  
+  # replaces ' with '' and \\ (two backslashes) with \\\\ (two escaped backslashes)
+  def escape_sql
+    self.gsub(/\\/, '\&\&').gsub(/'/, "''")
+  end
+  
+  def to_dollar_amount
+    is_valid_dollar_amount? ? scrubbed_dollar_amount.to_f.round(2) : 0.0
+  end
+end
+
+# TODO write a spec
+class Float
+  def to_percentage(precision=2)
+    (self * 100).round(precision)
+  end
+end
+
+class Fixnum
+  # we ignore the precision and just return itself as a float, since Float#to_f accepts this parameter
+  def round(precision=2)
+    to_f
+  end
+end

data/spec/gci-class-extensions_spec.rb

@@ -86,3 +86,102 @@ describe Enumerable, "counting itself" do
   end
 end
 
+describe String, "knowing whether it contains a valid dollar amount" do
+  valid_amounts = [
+    # less than a dollar
+    ".50", "0.50", ".25",
+    # simple numbers with dollar signs
+    "$123", "$123.45", "$123,456", "$123,456.78",
+    # simple numbers without dollar signs
+    "123", "123.45", "123,456", "123,456.78",
+    # simple negatives with dollar signs
+    "-$123", "-$123.45", "-$123,456", "-$123,456.78",
+    "$-123", "$-123.45", "$-123,456", "$-123,456.78",
+    # simple negatives without dollar signs
+    "-123", "-123.45", "-123,456", "-123,456.78",
+    # accounting negatives with dollar signs
+    "($123)", "($123.45)", "($123,456)", "($123,456.78)",
+    "$(123)", "$(123.45)", "$(123,456)", "$(123,456.78)",
+    # accounting negatives without dollar signs
+    "(123)", "(123.45)", "(123,456)", "(123,456.78)"
+  ]
+  
+  invalid_amounts = [
+    "", "$", "123.AB", "a", "123 456 789", "1-1-1",
+    # more than 2 digits after the period
+    "$123.456789"
+  ]
+  
+  valid_amounts.each do |valid_amount|
+    it "should accept #{valid_amount}" do
+      valid_amount.is_valid_dollar_amount?.should be_true
+    end
+  end
+  
+  invalid_amounts.each do |invalid_amount|
+    it "should not accept #{invalid_amount}" do
+      invalid_amount.is_valid_dollar_amount?.should be_false
+    end
+  end
+end
+
+describe String, "when scrubbing the dollar amounts to only the digits" do
+  it "should remove the dollar sign and commas" do
+    "$123,456.78".scrubbed_dollar_amount.should == "123456.78"
+  end
+  
+  it "should convert account negatives from using () to using -" do
+    "(123.45)".scrubbed_dollar_amount.should == "-123.45"
+  end
+  
+  it "should leave traditional negatives intact" do
+    "-$123.45".scrubbed_dollar_amount.should == "-123.45"
+  end
+  
+  it "should leave the string alone if has no dollar sign or commas" do
+    "123".scrubbed_dollar_amount.should == "123"
+  end
+  
+  it "should convert the string to a dollar with two decimals" do
+    '123.12'.to_dollar_amount.should == 123.12
+  end
+  
+  it "should return 0.0 if the string has > 2 decimal places" do
+    '123.1234'.to_dollar_amount.should == 0.0
+  end
+  
+  it "should return 0.0 if the string is not a valid $ amount" do
+    "xcv".to_dollar_amount.should == 0.0
+  end
+  
+end
+
+describe Fixnum, "accepting a parameter to round as float does" do
+  it "should ignore the parameter and just return itself" do
+    1.round(2).should == 1.0
+    7.round(9).should == 7.0
+    0.round(123456789).should == 0.0
+  end
+
+  it "should accept no parameter" do
+    1.round.should == 1.0
+    7.round.should == 7.0
+    0.round.should == 0.0
+  end
+end
+
+describe Float, "knowing its value as a percentage" do
+  it "should convert itself with the default precision" do
+    # when it rounds
+    (0.123456).to_percentage.should == 12.35
+    # when it doesn't round
+    (6.543212).to_percentage.should == 654.32
+  end
+  
+  it "should accept an optional precision parameter" do
+    # when it rounds
+    (0.123456).to_percentage(3).should == 12.346
+    # when it doesn't round
+    (6.543212).to_percentage(3).should == 654.321
+  end
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gci-class-extensions
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Patrick Byrne
@@ -9,29 +15,36 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-08 00:00:00 -05:00
-default_executable: 
+date: 2012-03-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: active_support
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: valid-date
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: 
 email: code@patrickbyrne.net
 executables: []
@@ -43,7 +56,7 @@ extra_rdoc_files:
 files: 
 - lib/gci-class-extensions.rb
 - README
-has_rdoc: true
+- spec/gci-class-extensions_spec.rb
 homepage: http://bitbucket.org/pbyrne/common-ruby-class-extensions/
 licenses: []
 
@@ -53,21 +66,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A gem used by our internal team for common class extensions, like not_blank? and not_nil? counterparts to blank? and nil?.