formatting 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fee06b2bd9c054f9a95f99d0c32dbe00062eba7
-  data.tar.gz: 009dad129635e6941f3dfcfc1fde91aef601c13b
+  metadata.gz: f41d31f291d939056af4b95f837c90e6eccc94ae
+  data.tar.gz: 3061bd63d93f6c7b9d0082fff54dac279b072c34
 SHA512:
-  metadata.gz: 8cdb71265b3c0566c73e414ee907e2335cc4533042234462e82aadfc19a159558a36014ee5f53a39eaa274674cc82126dd0b0d5fe6f67c6e84af4c5164d5eb40
-  data.tar.gz: 9a446f71f65a60f67effac58f61ce6853c555a3336dec342d12522d93fafbb4d073405e1982eb42abbc7e2620c3d0ea149389f00d939c386845361bd17f5f950
+  metadata.gz: bf1788bf1924016ef909aa7f4fb51c5ee6205d6ad6700d50b32a44f3f5c7798d3edc6c854cf4d4a1c0ff44942cff344c72c4a68e635f10cb31845db488deb19d
+  data.tar.gz: 638b6e2ec4d7ad0eb97a5a53cd0afa208b2fbe819606dc92748f60b8768f4d082520f79868a59a914a5be5fce0e60684dafe01be7a7aeabc11c5fc2111d8cb1b

data/README.md

@@ -32,35 +32,58 @@ format_currency("SEK", 1234)  # => "1,234 SEK"
 
 ### Number
 
+#### Example usage
+
 ``` 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"
 ```
 
+#### Options
+
+name                | default                                                                          | explanation
+--------------------|----------------------------------------------------------------------------------|------------
+thousands_separator | `I18n.t("number.format.delimiter")` if available, otherwise a non-breaking space |
+decimal_separator   | `I18n.t("number.format.separator")` if available, otherwise `"."`                |
+round               | `2`                                                                              | Round to the given number of decimals. Don't round if given `false`.
+blank_when_zero     | `false`                                                                          | If `true`, returns `""` for a zero value.
+min_decimals        | `2`                                                                              | Show at least that number of decimals. Don't enforce if given `false`.
+explicit_sign       | `false`                                                                          | If `true`, prefixes positive values with a `"+"`. Doesn't prefix `0`.
+
+
 ### Currency
 
 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.
 
-``` ruby
-Formatting.format_currency("SEK", 1234)  # => "1,234 SEK"
+#### Example usage
 
+``` ruby
 item = Item.new(price: 1234, currency: "SEK")
-Formatting.format_currency(item, :price)  # => "1,234 SEK"
-Formatting.format_currency(company, item.price)  # => "1,234 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.defaults[:currency] = "SEK"
 item = Item.new(price: 1234)  # Does not respond to "currency"
-Formatting.format_currency(item, :price)  # => "1,234 SEK"
+Formatting.format_currency(item, :price)  # => "1,234.00 SEK"
 
-item = Item.new(price: 1234, currency: "SEK")
-Formatting.format_currency(item, :price, show_currency: false)  # => "1,234"
-Formatting.defaults[:show_currency] = false
-Formatting.format_currency(item, :price)  # => "1,234"
 ```
 
+#### 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.
+
 
 ## Installation
 

data/lib/formatting/currency.rb

@@ -12,10 +12,14 @@ module Formatting
       opts = Formatting.defaults.merge(opts)
 
       format_string = opts.fetch(:format, "<amount> <currency>")
+      skip_currency = opts.fetch(:skip_currency, false)
 
-      currency = opts.fetch(:currency) {
-        record.respond_to?(:currency) ? record.currency: nil
-      }
+      unless skip_currency
+        currency = opts.fetch(:currency) {
+          record.respond_to?(:currency) ? record.currency: nil
+        }
+        currency = nil if currency == false
+      end
 
       if amount_or_method.is_a?(Symbol)
         amount = record.public_send(amount_or_method)

data/lib/formatting/version.rb

@@ -1,3 +1,3 @@
 module Formatting
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/currency_spec.rb

@@ -64,6 +64,10 @@ describe Formatting do
       it "is not added if the record does not respond to #currency" do
         expect_formatted(item, 1).to eq space_to_nbsp("1.00")
       end
+
+      it "is not added if given as 'false'" do
+        expect_formatted(item, 1, currency: false).to eq space_to_nbsp("1.00")
+      end
     end
 
     context "format string option" do
@@ -83,6 +87,26 @@ describe Formatting do
           to eq space_to_nbsp("123.00")
       end
     end
+
+    context "skip_currency option" do
+      context "set to 'true'" do
+        it "doesn't add the currency" do
+          expect_formatted(item, 123, currency: "SEK", skip_currency: true).to eq space_to_nbsp("123.00")
+        end
+      end
+
+      context "set to 'false'" do
+        it "adds the currency" do
+          expect_formatted(item, 123, currency: "SEK", skip_currency: false).to eq space_to_nbsp("123.00 SEK")
+        end
+      end
+
+      context "by default" do
+        it "adds the currency" do
+          expect_formatted(item, 123, currency: "SEK").to eq space_to_nbsp("123.00 SEK")
+        end
+      end
+    end
   end
 
   def expect_formatted(record, value, opts = {})

data/spec/number_spec.rb

@@ -108,7 +108,6 @@ describe Formatting do
         expect_formatted(12.0, min_decimals: false).to eq "12.0"
         expect_formatted(12.3, min_decimals: false).to eq "12.3"
       end
-
     end
 
     context "explicit sign" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formatting
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-11 00:00:00.000000000 Z
+date: 2013-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler