formatting 0.0.14 → 0.0.16

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzE3NDZkOGE2ODY0ZDgxNWViNGEzNGY0NTMyNjBmMjg5MTBhNTI1MA==
-  data.tar.gz: !binary |-
-    NmM1M2JjNjQ1NDA0N2FjYzI0NmU3ZTc1YWQ4M2FlYTgxZGJlNWEyNQ==
+SHA1:
+  metadata.gz: f8a92f61e13526876dc609e99cabc25252e14303
+  data.tar.gz: 804ee6b74f3f1521075dd601a8d90b169c2fa0f8
 SHA512:
-  metadata.gz: !binary |-
-    NTBiNDc1MTMzNzg5NmU2YjliNjhjZDYyOThjODhhMDVmM2ExNTAzZmQ3NDg4
-    MWU4YmNiNDcyODNhZjgwZDNmYzhiNDE3ZmI0OGQ5ZTNiMzU5OWYzNmNlNDBh
-    Y2YzYTQ3YTlhZjdkNDMzY2Y0MWM1ODllN2Y1NzllYzAxY2JmMzU=
-  data.tar.gz: !binary |-
-    YjI2YWRiYTBlZTY4ZjBlOWZkZDdiYTgwYTlhNDQ1NTA0YjE3MmI4MTM4Mjhk
-    NzhhMTk1OGUzYzNhM2NmNjc3MGJhNzEyMmFhYTE3OWZhYWNkYzZjYjZkNzQw
-    YWM1MzYzMDA5N2IyOWQxNDhkOGQwNzFkOTM3NzQxZTA4YmY4NDI=
+  metadata.gz: c3d5b1625686c2dc865841a1800d2b971604f951086570c80961acf75a72154dcd0747c54b54a11380fcd45f0be29163510a971ec99f9346846300d4093322c7
+  data.tar.gz: 591e74fcd72914b2f3afe535e13c0d31e6935b5930495f373ce1fd16194e158bd8204153b6cb7c5dc10992dfcd2f9e253814f6dca37c9afd91db888a33a42fb6

data/README.md

@@ -7,6 +7,7 @@ Will use the `i18n` library for formatting defaults if present, but it's not a r
 Formats:
   * Numbers
   * Currency
+  * Percent
 
 
 ## Usage
@@ -25,6 +26,9 @@ format_number(1234)  # => "1,234.00"
 
 include Formatting::Currency
 format_currency(item, :price)  # => "1,234.00 SEK"
+
+include Formatting::Percent
+format_percent(12.3)  # => "12.30%"
 ```
 
 
@@ -40,15 +44,16 @@ Formatting.format_number(1, explicit_sign: true)  # => "+1.00"
 
 #### 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`.
-decimals_on_integers    | `true`                                                                           | If `false`, integers won't include decimals.
+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`.
+decimals_on_integers           | `true`                                                                           | If `false`, integers won't include decimals.
+treat_zero_decimals_as_integer | `false`                                                                          | If `true`, a zero value in the decimal column formats the number like an integer.
 
 
 ### Currency
@@ -83,6 +88,20 @@ format          | `"<amount> <currency>"`
 skip_currency   | `false`                                                                        | If `true`, doesn't add the currency to the amount.
 
 
+### Percent
+
+#### Example usage
+
+``` ruby
+Formatting.format_percent(12.3)  # => "12.3%"
+```
+
+
+#### Options
+
+Passes on all the number options.
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/formatting.rb

@@ -4,10 +4,12 @@
 require "formatting/version"
 require "formatting/number"
 require "formatting/currency"
+require "formatting/percent"
 
 module Formatting
   NON_BREAKING_SPACE = "\xc2\xa0"
 
   extend Number
   extend Currency
+  extend Percent
 end

data/lib/formatting/number.rb

@@ -10,7 +10,7 @@ module Formatting
   class FormatNumber
     attr_private :input_number,
       :thousands_separator, :decimal_separator,
-      :round, :min_decimals, :decimals_on_integers, :explicit_sign, :blank_when_zero
+      :round, :min_decimals, :decimals_on_integers, :treat_zero_decimals_as_integer, :explicit_sign, :blank_when_zero
 
     def initialize(input_number, opts)
       @input_number = input_number
@@ -20,6 +20,7 @@ module Formatting
       @round                = opts.fetch(:round, 2)
       @min_decimals         = opts.fetch(:min_decimals, 2)
       @decimals_on_integers = opts.fetch(:decimals_on_integers, true)
+      @treat_zero_decimals_as_integer = opts.fetch(:treat_zero_decimals_as_integer, false)
       @explicit_sign        = opts.fetch(:explicit_sign, false)
       @blank_when_zero      = opts.fetch(:blank_when_zero, false)
     end
@@ -27,6 +28,10 @@ module Formatting
     def format
       number = input_number
 
+      if treat_zero_decimals_as_integer && number.modulo(1).zero?
+        number = number.to_i
+      end
+
       has_decimals = number.to_s.include?(".")
 
       if blank_when_zero

data/lib/formatting/percent.rb

@@ -0,0 +1,12 @@
+# http://en.wikipedia.org/wiki/Percent_sign#Spacing
+
+require "attr_extras"
+
+module Formatting
+  module Percent
+    def format_percent(number, opts = {})
+      formatted_number = Formatting.format_number(number, opts)
+      "#{formatted_number}%"
+    end
+  end
+end

data/lib/formatting/version.rb

@@ -1,3 +1,3 @@
 module Formatting
-  VERSION = "0.0.14"
+  VERSION = "0.0.16"
 end

data/spec/number_spec.rb

@@ -120,6 +120,16 @@ describe Formatting do
       end
     end
 
+    context "treat_zero_decimals_as_integer" do
+      it "defaults to false" do
+        expect_formatted(12.0, decimals_on_integers: false).to eq "12.00"
+      end
+
+      it "can be turned off" do
+        expect_formatted(12.0, decimals_on_integers: false, treat_zero_decimals_as_integer: true).to eq "12"
+      end
+    end
+
     context "explicit sign" do
       it "is not included by default" do
         expect_formatted(1).to eq "1.00"

data/spec/percent_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe Formatting::Percent do
+  it "can be included as a module" do
+    object = Object.new
+    object.extend Formatting::Percent
+    expect(object).to respond_to(:format_percent)
+  end
+end
+
+describe Formatting, ".format_percent" do
+  it "formats a number" do
+    expect_formatted(1.2).to eq "1.20%"
+  end
+
+  it "passes on number formatting options" do
+    expect_formatted(1.567, round: 2).to include "1.57"
+  end
+
+  def expect_formatted(number, opts = {})
+    expect(Formatting.format_percent(number, opts))
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formatting
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.16
 platform: ruby
 authors:
 - Henrik Nyh
@@ -9,20 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attr_extras
   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
@@ -43,28 +43,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: 
@@ -84,9 +84,11 @@ files:
 - lib/formatting.rb
 - lib/formatting/currency.rb
 - lib/formatting/number.rb
+- lib/formatting/percent.rb
 - lib/formatting/version.rb
 - spec/currency_spec.rb
 - spec/number_spec.rb
+- spec/percent_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -98,21 +100,22 @@ 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.2.1
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Rails-less formatting for your unit-testable code.
 test_files:
 - spec/currency_spec.rb
 - spec/number_spec.rb
+- spec/percent_spec.rb
 - spec/spec_helper.rb