formatting 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35af947641623b8cf80b8323106412901717087e
-  data.tar.gz: 41ff76fcf71cac124cd77f1b58d0c70a21fdf0a1
+  metadata.gz: 8491d72d7e09b9a42a8c97708417a144262245a4
+  data.tar.gz: 9a2be257d8fef3a05d78945223bde008c89ca9b4
 SHA512:
-  metadata.gz: 4c49acfa52b48b08f6309e3e5eb2db8d55705c7c67b2aabc8ca9245084ecaadf3b55e5b641c3b983cc4b1fe7b665e3abb7fc16467c4bb9b336e468f04e48dd18
-  data.tar.gz: 9a223c7ed6d58d67f74eb0a5cfb0898b0f68980ff1f31f2e59888b0c454cadaea6052a72b1ccd4481922fd6e8cebb2182090b777fdbdf6dfe01a3921eb597d8d
+  metadata.gz: d603a5393ff8b04fa33a0a9c9752e8b43f4d5a7dd0334702e6fbeafa32261a9a13ed887ac111740268561029af2a0e2da9411c0ceb51b659b6ffc672f21c7e1c
+  data.tar.gz: 20f56e657f8898923ee5f218f448e45bd6a4f65ad7da863725dcb6eaa7a42733d24acac6f4b5fc7a572c95b090c49ca6a02c94c47010f3663100019aa1045d5a

data/README.md

@@ -2,9 +2,7 @@
 
 Rails-less formatting for your unit-testable code.
 
-*Does* currently depend on the `i18n` library for number separators.
-
-Very much a work in progress currently.
+Will use the `i18n` library for formatting defaults if present, but it's not a requirement.
 
 Formats:
   * Numbers
@@ -23,10 +21,10 @@ Or include the modules you want:
 
 ``` ruby
 include Formatting::Number
-format_number(1234)  # => "1,234"
+format_number(1234)  # => "1,234.00"
 
 include Formatting::Currency
-format_currency("SEK", 1234)  # => "1,234 SEK"
+format_currency(item, :price)  # => "1,234.00 SEK"
 ```
 
 
@@ -37,7 +35,7 @@ format_currency("SEK", 1234)  # => "1,234 SEK"
 ``` ruby
 Formatting.format_number(1234.567)  # => "1,234.57"
 Formatting.format_number(0, blank_when_zero: true)  # => ""
-Formatting.format_number(1, explicit_sign: true)  # => "+1"
+Formatting.format_number(1, explicit_sign: true)  # => "+1.00"
 ```
 
 #### Options
@@ -58,6 +56,9 @@ The currency formatter should usually be passed some object that
 the currency can be determined from. The idea is that even if you
 only have one currency now, you may add more later.
 
+But you can also pass an explicit currency, as the first argument
+or as the `currency` option.
+
 #### Example usage
 
 ``` ruby
@@ -65,19 +66,20 @@ item = Item.new(price: 1234, currency: "SEK")
 Formatting.format_currency(item, :price)  # => "1,234.00 SEK"
 Formatting.format_currency(company, item.price)  # => "1,234.00 SEK"
 Formatting.format_currency(company, 4567)  # => "4,567.00 SEK"
-
 Formatting.format_currency(company, 4567, currency: false)  # => "4,567.00"
+Formatting.format_currency("SEK", 4567)  # => "4,567.00 SEK"
 ```
 
+
 #### Options
 
 Passes on all the number options and also takes these:
 
-name            | default                                | explanation
-----------------|----------------------------------------|------------
-currency        | `first_argument.currency` if available | E.g. `"USD"`. Can be `false`.
-format          | `"<amount> <currency>"`                | A format string. Any spaces become non-breaking spaces.
-skip_currency   | `false`                                | If `true`, doesn't add the currency to the amount.
+name            | default                                                                        | explanation
+----------------|--------------------------------------------------------------------------------|------------
+currency        | `first_argument.currency` if available, or `first_argument` if it's a currency | E.g. `"USD"`. Can be `false`.
+format          | `"<amount> <currency>"`                                                        | A format string. Any spaces become non-breaking spaces.
+skip_currency   | `false`                                                                        | If `true`, doesn't add the currency to the amount.
 
 
 ## Installation
@@ -98,5 +100,4 @@ Or install it yourself as:
 ## TODO
 
 * Use real i18n in specs so they're less fragile and ugly
-* Document options
 * Rename? This name is boring and also generic enough that collisions seem likely.

data/lib/formatting/currency.rb

@@ -1,26 +1,25 @@
 module Formatting
-  class NotARecordError < StandardError; end
-
   module Currency
     include Number
 
-    def format_currency(record, amount_or_method, opts = {})
-      if record.is_a?(Symbol)
-        raise NotARecordError, "Expected an object that could tell us its currency; got #{record.inspect}"
-      end
-
+    def format_currency(record_or_currency, amount_or_method, opts = {})
       format_string = opts.fetch(:format, "<amount> <currency>")
       skip_currency = opts.fetch(:skip_currency, false)
 
       unless skip_currency
         currency = opts.fetch(:currency) {
-          record.respond_to?(:currency) ? record.currency: nil
+          case record_or_currency
+          when String, Symbol
+            record_or_currency
+          else
+            record_or_currency.respond_to?(:currency) ? record_or_currency.currency : nil
+          end
         }
         currency = nil if currency == false
       end
 
       if amount_or_method.is_a?(Symbol)
-        amount = record.public_send(amount_or_method)
+        amount = record_or_currency.public_send(amount_or_method)
       else
         amount = amount_or_method
       end

data/lib/formatting/version.rb

@@ -1,3 +1,3 @@
 module Formatting
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/currency_spec.rb

@@ -22,8 +22,9 @@ describe Formatting do
         expect_formatted(item, :price).to eq space_to_nbsp("2.00")
       end
 
-      it "complains if the 'record' looks like a method name (a likely mistake)" do
-        expect { Formatting.format_currency(:item, 123) }.to raise_error(Formatting::NotARecordError)
+      it "can take a currency string or symbol and a value" do
+        expect_formatted("SEK", 2).to eq space_to_nbsp("2.00 SEK")
+        expect_formatted(:SEK, 2).to eq space_to_nbsp("2.00 SEK")
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formatting
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2014-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,28 +28,28 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -82,17 +82,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Rails-less formatting for your unit-testable code.
@@ -100,4 +100,3 @@ test_files:
 - spec/currency_spec.rb
 - spec/number_spec.rb
 - spec/spec_helper.rb
-has_rdoc: