formatting 0.0.13 → 0.0.18

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YWI5ZTFkMTdmMTc0NGJhYTdlYzJjMTU2NDFhZTAwNTliNjUyYTRkZQ==
-  data.tar.gz: !binary |-
-    OGU1OWE2YWY5Y2ZmMThjYTZhMDQzMzgyNDQ1ZDNiOTNkMTFmYmY5Yw==
+SHA256:
+  metadata.gz: bc0d48715ff358482643c0ab965fcd3965399fb78eec281e109142917d0e249c
+  data.tar.gz: 74079c3f59a8f5c7e925ba627f1213c7956a7be5b5e23a7e0f5a9ad7dee19447
 SHA512:
-  metadata.gz: !binary |-
-    NzQ5MGY5MDQ0ZDIxMzc3ZGE3YzcyNDQxZDU5MmJmM2IyNTBlYWIxYTgwYWNi
-    YTdlMWMwOWZlNzI1Y2MzY2Q2MzUyMzNiMjIwOGYxMDg1MTdmYTEyMjgzZDgw
-    MzQ4NmRmMTY5MjU2OTY1ODJkNmFhOWEyOGJiOTNlZmE3NGI0YmQ=
-  data.tar.gz: !binary |-
-    Yjc3MDk0NTY5YTM4ZmM5YWI1ZGM3ZTkyMTAzNTdiYmY3Y2UzNjk4YzhmNDUz
-    MjNlZDA3ODc3MzkzZmFkMTVmZTQ4MzQ3MDMwNzEwNTEwNzQ1MDQ2NWY5ZGVj
-    MTEzOTIxODkzYTJlMDc4ODFlYzAzNmI0Zjc5ZDJmNGU2NjIzOTk=
+  metadata.gz: 1fa29df5ceb15a52ff8630678295306dd88cc2de04f0aa2ca46bf2a636bfe56dcd0afd6fc7356ba68229e1c33ba7171bcdf6fe339bee209b7f407d44930aaf08
+  data.tar.gz: 5d43ba483c1d4b0c1e5805e70d6689242b8ff4261d8b4089372eac01115cb382a3f1cf147ad29c4667d35610cdba811a49be12d8173db58dd926c3a656349203

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "2.7", "2.6", "2.5"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rspec_results

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+    - "tmp/**/*"
+inherit_gem:
+  barsoom_utils: shared_rubocop.yml

data/Gemfile

@@ -1,4 +1,14 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in formatting.gemspec
 gemspec
+
+group :development do
+  gem "barsoom_utils", github: "barsoom/barsoom_utils"
+  gem "bundler"
+  gem "rake"
+  gem "rspec"
+  gem "rubocop"
+end

data/README.md

@@ -1,3 +1,5 @@
+[![Ruby CI](https://github.com/barsoom/formatting/actions/workflows/ci.yml/badge.svg)](https://github.com/barsoom/formatting/actions/workflows/ci.yml)
+
 # Formatting
 
 Rails-less formatting for your unit-testable code.
@@ -7,6 +9,7 @@ Will use the `i18n` library for formatting defaults if present, but it's not a r
 Formats:
   * Numbers
   * Currency
+  * Percent
 
 
 ## Usage
@@ -25,6 +28,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,14 +46,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`.
+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
@@ -82,6 +90,24 @@ 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 and also takes these:
+
+name            | default                                           | explanation
+----------------|---------------------------------------------------|------------
+format          | `"<number>%"` or `<number> %` depending on locale | A format string.
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/formatting.gemspec

@@ -1,24 +1,22 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'formatting/version'
+require "formatting/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "formatting"
   spec.version       = Formatting::VERSION
-  spec.authors       = ["Henrik Nyh", "Tomas Skogberg"]
-  spec.email         = ["henrik@barsoom.se", "tomas@barsoom.se"]
+  spec.authors       = [ "Henrik Nyh", "Tomas Skogberg" ]
+  spec.email         = [ "henrik@barsoom.se", "tomas@barsoom.se" ]
   spec.summary       = %q{Rails-less formatting for your unit-testable code.}
   spec.homepage      = ""
   spec.license       = "MIT"
+  spec.metadata      = { "rubygems_mfa_required" => "true" }
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = [ "lib" ]
 
   spec.add_dependency "attr_extras"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
 end

data/lib/formatting/currency.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "attr_extras"
 
 module Formatting

data/lib/formatting/number.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "attr_extras"
 
 module Formatting
@@ -10,22 +12,28 @@ module Formatting
   class FormatNumber
     attr_private :input_number,
       :thousands_separator, :decimal_separator,
-      :round, :min_decimals, :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
 
-      @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)
+      @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)
+      @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
 
     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
@@ -33,7 +41,7 @@ module Formatting
       end
 
       # Avoid negative zero.
-      number = 0 if number.zero?
+      number = number.abs if number.zero?
 
       if round
         number = number.round(round) if has_decimals
@@ -48,12 +56,12 @@ module Formatting
         integer = "+#{integer}" if number > 0
       end
 
-      if min_decimals
+      if min_decimals && (has_decimals || decimals_on_integers)
         decimals ||= "0"
         decimals = decimals.ljust(min_decimals, "0")
       end
 
-      [integer, decimals].compact.join(decimal_separator)
+      [ integer, decimals ].compact.join(decimal_separator)
     end
 
     private
@@ -67,7 +75,7 @@ module Formatting
     end
 
     def t_format(key, default)
-      if defined?(I18n)
+      if defined?(I18n) && I18n.respond_to?(:t)
         I18n.t(key, scope: "number.format", default: default)
       else
         default

data/lib/formatting/percent.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "attr_extras"
+
+module Formatting
+  module Percent
+    def format_percent(number, opts = {})
+      format_string = opts.fetch(:format) { default_percent_format_string }
+      formatted_number = Formatting.format_number(number, opts)
+      format_string.gsub("<number>", formatted_number)
+    end
+
+    private
+
+    # http://en.wikipedia.org/wiki/Percent_sign#Spacing
+    # Rails i18n doesn't have a conventional format string for this.
+    def default_percent_format_string
+      locale = defined?(I18n) && I18n.locale
+
+      case locale
+      when :sv, :fi, :fr, :de
+        "<number>#{Formatting::NON_BREAKING_SPACE}%"
+      else
+        "<number>%"
+      end
+    end
+  end
+end

data/lib/formatting/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Formatting
-  VERSION = "0.0.13"
+  VERSION = "0.0.18"
 end

data/lib/formatting.rb

@@ -1,13 +1,16 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 # ^ so NON_BREAKING_SPACE is treated as UTF-8 in Ruby 1.9.
 
 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/spec/currency_spec.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
-describe Formatting::Currency do
+RSpec.describe Formatting::Currency do
   it "can be included as a module" do
     object = Object.new
     object.extend Formatting::Currency
@@ -8,7 +10,7 @@ describe Formatting::Currency do
   end
 end
 
-describe Formatting do
+RSpec.describe Formatting do
   describe ".format_currency" do
     let(:item) { double }
 
@@ -18,7 +20,7 @@ describe Formatting do
       end
 
       it "can take a record and a method name" do
-        item.stub(price: 2)
+        allow(item).to receive(:price).and_return(2)
         expect_formatted(item, :price).to eq space_to_nbsp("2.00")
       end
 
@@ -48,12 +50,12 @@ describe Formatting do
       end
 
       it "is read from the record's #currency if present" do
-        item.stub(currency: "SEK")
+        allow(item).to receive(:currency).and_return("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: "")
+        allow(item).to receive(:currency).and_return("")
         expect_formatted(item, 1).to eq space_to_nbsp("1.00")
       end
 
@@ -68,8 +70,8 @@ describe Formatting do
 
     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.00")
+        expect_formatted(item, 123, format: "C: <currency> A: <amount>", currency: "XYZ")
+          .to eq space_to_nbsp("C: XYZ A: 123.00")
       end
 
       it "will have spaces turned into non-breaking spaces" do
@@ -79,8 +81,8 @@ describe Formatting do
       end
 
       it "is stripped" do
-        expect_formatted(item, 123, format: "<amount> <currency>", currency: nil).
-          to eq space_to_nbsp("123.00")
+        expect_formatted(item, 123, format: "<amount> <currency>", currency: nil)
+          .to eq space_to_nbsp("123.00")
       end
     end
 

data/spec/number_spec.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
-describe Formatting::Number do
+RSpec.describe Formatting::Number do
   it "can be included as a module" do
     object = Object.new
     object.extend Formatting::Number
@@ -8,7 +10,7 @@ describe Formatting::Number do
   end
 end
 
-describe Formatting do
+RSpec.describe Formatting do
   describe ".format_number" do
     it "formats a number" do
       expect_formatted(1234567.89).to eq space_to_nbsp("1 234 567.89")
@@ -25,9 +27,9 @@ describe Formatting do
 
         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(i18n).to receive(:t)
+            .with(:delimiter, scope: "number.format", default: space_to_nbsp(" "))
+            .and_return(";")
           expect_formatted(1234).to include "1;234"
         end
       end
@@ -90,7 +92,6 @@ describe Formatting do
       end
     end
 
-
     context "minimum number of decimals" do
       it "defaults to two decimals" do
         expect_formatted(12).to eq "12.00"
@@ -110,6 +111,26 @@ describe Formatting do
       end
     end
 
+    context "decimals on integers" do
+      it "defaults to adding decimals" do
+        expect_formatted(12).to eq "12.00"
+      end
+
+      it "can be turned off" do
+        expect_formatted(12, decimals_on_integers: false).to eq "12"
+      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,40 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.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
+
+RSpec.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: 1).to include "1.6"
+  end
+
+  context "format string option" do
+    it "is used if provided" do
+      expect_formatted(1, format: "%<number>%").to eq "%1.00%"
+    end
+
+    context "if I18n.locale is available" do
+      let(:i18n) { stub_const("I18n", double) }
+
+      it "defaults sensibly for some locales that require spacing the sign" do
+        allow(i18n).to receive(:locale).and_return(:sv)
+        expect_formatted(1).to eq space_to_nbsp("1.00 %")
+      end
+    end
+  end
+
+  def expect_formatted(number, opts = {})
+    expect(Formatting.format_percent(number, opts))
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "formatting"
 
 module Helpers
@@ -8,4 +10,10 @@ end
 
 RSpec.configure do |config|
   config.include Helpers
+
+  config.example_status_persistence_file_path = ".rspec_results"
+  config.disable_monkey_patching!
+
+  config.order = :random
+  Kernel.srand config.seed
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formatting
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.18
 platform: ruby
 authors:
 - Henrik Nyh
@@ -9,62 +9,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2021-11-19 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
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  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: 
@@ -75,7 +33,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,35 +44,38 @@ 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:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 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: 3.2.31
 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