formatting 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3955f66b2db50346419ee47e7504648cf7b521f9
-  data.tar.gz: fe2d09e425d414518a440950da09e68516091d90
+  metadata.gz: 0fee06b2bd9c054f9a95f99d0c32dbe00062eba7
+  data.tar.gz: 009dad129635e6941f3dfcfc1fde91aef601c13b
 SHA512:
-  metadata.gz: d67d72c11459baa553c190d991fc4eee953d7e3f523f2ca71a6cd3aff8e3d1c6915bf4c80c4d9b9ae7f0b30149c3fde1472394215cb6dd38813466af68809b71
-  data.tar.gz: 049d9d2cce7c44b6a20e8f611d07215241de9b5521090a28a0d19b25faade22a169bd019ee80be316be9365e0464cf295295df05accba251cd7435a10b6272eb
+  metadata.gz: 8cdb71265b3c0566c73e414ee907e2335cc4533042234462e82aadfc19a159558a36014ee5f53a39eaa274674cc82126dd0b0d5fe6f67c6e84af4c5164d5eb40
+  data.tar.gz: 9a446f71f65a60f67effac58f61ce6853c555a3336dec342d12522d93fafbb4d073405e1982eb42abbc7e2620c3d0ea149389f00d939c386845361bd17f5f950

data/README.md

@@ -79,8 +79,6 @@ Or install it yourself as:
 
 ## TODO
 
-* Actually use i18n for separators
-* Don't depend on `i18n`?
-* Rename? This name is boring and also generic enough that collisions seem likely.
+* Use real i18n in specs so they're less fragile and ugly
 * Document options
-* Change some defaults: round: 2, min_decimals: 2
+* Rename? This name is boring and also generic enough that collisions seem likely.

data/formatting.gemspec

@@ -17,8 +17,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "i18n"
-
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/lib/formatting/currency.rb

@@ -23,7 +23,7 @@ module Formatting
         amount = amount_or_method
       end
 
-      amount = 0 if amount.nil?
+      return "" if amount.nil?
 
       amount = format_number(amount, opts)
       apply_format_string(format_string, amount, currency)

data/lib/formatting/number.rb

@@ -3,13 +3,15 @@ module Formatting
     def format_number(number, opts = {})
       opts = Formatting.defaults.merge(opts)
 
-      thousands_separator = opts.fetch(:thousands_separator, NON_BREAKING_SPACE)
-      decimal_separator   = opts.fetch(:decimal_separator, ".")
-      round           = opts.fetch(:round, nil)
-      min_decimals    = opts.fetch(:min_decimals, nil)
+      thousands_separator = opts.fetch(:thousands_separator) { default_thousands_separator }
+      decimal_separator   = opts.fetch(:decimal_separator) { default_decimal_separator }
+      round           = opts.fetch(:round, 2)
+      min_decimals    = opts.fetch(:min_decimals, 2)
       explicit_sign   = opts.fetch(:explicit_sign, false)
       blank_when_zero = opts.fetch(:blank_when_zero, false)
 
+      has_decimals = number.to_s.include?(".")
+
       if blank_when_zero
         return "" if number.zero?
       end
@@ -18,11 +20,10 @@ module Formatting
       number = 0 if number.zero?
 
       if round
-        number = number.round(round)
+        number = number.round(round) if has_decimals
       end
 
       integer, decimals = number.to_s.split(".")
-      decimals ||= "0"
 
       integer.gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{thousands_separator}")
 
@@ -31,10 +32,29 @@ module Formatting
       end
 
       if min_decimals
+        decimals ||= "0"
         decimals = decimals.ljust(min_decimals, "0")
       end
 
-      [integer, decimals].join(decimal_separator)
+      [integer, decimals].compact.join(decimal_separator)
+    end
+
+    private
+
+    def default_thousands_separator
+      t_format(:delimiter, NON_BREAKING_SPACE)
+    end
+
+    def default_decimal_separator
+      t_format(:separator, ".")
+    end
+
+    def t_format(key, default)
+      if defined?(I18n)
+        I18n.t(key, scope: "number.format", default: default)
+      else
+        default
+      end
     end
   end
 end

data/lib/formatting/version.rb

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

data/spec/currency_spec.rb

@@ -14,12 +14,12 @@ describe Formatting do
 
     context "method signature" do
       it "can take a record and a value" do
-        expect_formatted(item, 1).to eq space_to_nbsp("1.0")
+        expect_formatted(item, 1).to eq space_to_nbsp("1.00")
       end
 
       it "can take a record and a method name" do
         item.stub(price: 2)
-        expect_formatted(item, :price).to eq space_to_nbsp("2.0")
+        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
@@ -27,8 +27,8 @@ describe Formatting do
       end
     end
 
-    it "treats nil as 0" do
-      expect_formatted(item, nil).to include space_to_nbsp("0.0")
+    it "returns an empty string for nil" do
+      expect_formatted(item, nil).to eq ""
     end
 
     context "formatting" do
@@ -42,7 +42,7 @@ describe Formatting do
 
       it "applies default options" do
         Formatting.defaults = { currency: "FOO" }
-        expect_formatted(item, 1).to eq space_to_nbsp("1.0 FOO")
+        expect_formatted(item, 1).to eq space_to_nbsp("1.00 FOO")
       end
     end
 
@@ -53,34 +53,34 @@ describe Formatting do
 
       it "is read from the record's #currency if present" do
         item.stub(currency: "SEK")
-        expect_formatted(item, 1).to eq space_to_nbsp("1.0 SEK")
+        expect_formatted(item, 1).to eq space_to_nbsp("1.00 SEK")
       end
 
       it "is not added if the record's #currency is blank" do
         item.stub(currency: "")
-        expect_formatted(item, 1).to eq space_to_nbsp("1.0")
+        expect_formatted(item, 1).to eq space_to_nbsp("1.00")
       end
 
       it "is not added if the record does not respond to #currency" do
-        expect_formatted(item, 1).to eq space_to_nbsp("1.0")
+        expect_formatted(item, 1).to eq space_to_nbsp("1.00")
       end
     end
 
     context "format string option" do
       it "is used if provided" do
         expect_formatted(item, 123, format: "C: <currency> A: <amount>", currency: "XYZ").
-          to eq space_to_nbsp("C: XYZ A: 123.0")
+          to eq space_to_nbsp("C: XYZ A: 123.00")
       end
 
       it "will have spaces turned into non-breaking spaces" do
         expect_actual = expect_formatted(item, 123, format: "<amount> <currency>", currency: "XYZ")
-        expect_actual.to eq space_to_nbsp("123.0 XYZ")
-        expect_actual.not_to eq "123.0 XYZ"
+        expect_actual.to eq space_to_nbsp("123.00 XYZ")
+        expect_actual.not_to eq "123.00 XYZ"
       end
 
       it "is stripped" do
         expect_formatted(item, 123, format: "<amount> <currency>", currency: nil).
-          to eq space_to_nbsp("123.0")
+          to eq space_to_nbsp("123.00")
       end
     end
   end

data/spec/number_spec.rb

@@ -10,7 +10,7 @@ end
 
 describe Formatting do
   describe ".format_number" do
-    it "groups thousands" do
+    it "formats a number" do
       expect_formatted(1234567.89).to eq space_to_nbsp("1 234 567.89")
     end
 
@@ -19,19 +19,70 @@ describe Formatting do
       expect_formatted(12.3456789).to eq "12.346"
     end
 
+    context "thousands separator" do
+      context "with I18n" do
+        let(:i18n) { stub_const("I18n", double) }
+
+        it "uses I18n.t('number.format.delimiter') if present" do
+          allow(i18n).to receive(:t).with(:separator, instance_of(Hash))
+          expect(i18n).to receive(:t).
+            with(:delimiter, scope: "number.format", default: space_to_nbsp(" ")).
+            and_return(";")
+          expect_formatted(1234).to include "1;234"
+        end
+      end
+
+      context "without I18n" do
+        it "defaults to a non-breaking space" do
+          expect_formatted(1234).to include space_to_nbsp("1 234")
+          expect_formatted(1234).not_to include "1 234"
+        end
+      end
+
+      it "can be customized" do
+        expect_formatted(1234, thousands_separator: ":").to include "1:234"
+      end
+    end
+
+    context "decimal separator" do
+      context "with I18n" do
+        let(:i18n) { stub_const("I18n", double) }
+
+        it "uses I18n.t('number.format.separator') if present" do
+          allow(i18n).to receive(:t).with(:delimiter, instance_of(Hash))
+          expect(i18n).to receive(:t).with(:separator, scope: "number.format", default: ".").and_return(";")
+          expect_formatted(1.2).to eq "1;20"
+        end
+      end
+
+      context "without I18n" do
+        it "defaults to ." do
+          expect_formatted(1.2).to eq "1.20"
+        end
+      end
+
+      it "can be customized" do
+        expect_formatted(1.2, decimal_separator: ":").to eq "1:20"
+      end
+    end
+
     context "rounding" do
-      it "doesn't round by default" do
-        expect_formatted(12.3456789).to eq "12.3456789"
+      it "rounds to 2 decimals by defaults" do
+        expect_formatted(12.3456789).to eq "12.35"
       end
 
       it "rounds to the given number of decimals" do
-        expect_formatted(12.3456789, round: 2).to eq "12.35"
+        expect_formatted(12.3456789, round: 3).to eq "12.346"
+      end
+
+      it "doesn't round if given false" do
+        expect_formatted(12.3456789, round: false).to eq "12.3456789"
       end
     end
 
     context "blanking when zero" do
       it "does not happen by default" do
-        expect_formatted(0).to eq "0.0"
+        expect_formatted(0).to eq "0.00"
       end
 
       it "can be enforced" do
@@ -41,31 +92,40 @@ describe Formatting do
 
 
     context "minimum number of decimals" do
-      it "is not enforced by default" do
-        expect_formatted(12).to eq "12.0"
-        expect_formatted(12.3).to eq "12.3"
+      it "defaults to two decimals" do
+        expect_formatted(12).to eq "12.00"
+        expect_formatted(12.3).to eq "12.30"
       end
 
       it "can be enforced" do
-        expect_formatted(12.3, min_decimals: 2).to eq "12.30"
+        expect_formatted(12.3, min_decimals: 3).to eq "12.300"
       end
+
+      it "is not enforced if given false" do
+        expect_formatted(0, min_decimals: false).to eq "0"
+        expect_formatted(12, min_decimals: false).to eq "12"
+        expect_formatted(0.0, min_decimals: false).to eq "0.0"
+        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
       it "is not included by default" do
-        expect_formatted(1).to eq "1.0"
-        expect_formatted(0).to eq "0.0"
-        expect_formatted(-1).to eq "-1.0"
+        expect_formatted(1).to eq "1.00"
+        expect_formatted(0).to eq "0.00"
+        expect_formatted(-1).to eq "-1.00"
       end
 
       it "never shows 0 as negative" do
-        expect_formatted(-0.0).to eq "0.0"
+        expect_formatted(-0.0).to eq "0.00"
       end
 
       it "can be enforced" do
-        expect_formatted(1, explicit_sign: true).to eq "+1.0"
-        expect_formatted(0, explicit_sign: true).to eq "0.0"
-        expect_formatted(-1, explicit_sign: true).to eq "-1.0"
+        expect_formatted(1, explicit_sign: true).to eq "+1.00"
+        expect_formatted(0, explicit_sign: true).to eq "0.00"
+        expect_formatted(-1, explicit_sign: true).to eq "-1.00"
       end
     end
   end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: formatting
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors:
 - Henrik Nyh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement