formatting 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0eedbb12f830e0efcd539953a2161c5e56b521fe
+  data.tar.gz: 27a038999934b49bce503907e1aec13307729c56
+SHA512:
+  metadata.gz: ee6f14dcfc48e9ad749c57e86fb221227bda44312ae1dbc20072bbd58d4afec0e1ec8f22a567ff98671133dfbf6da642b08b6021523f11423067a4fc03356cd9
+  data.tar.gz: 1228b163c277ee2d7f85e833fa9c92c975876e56e9a8f4dbb7d1bf395eb62d7d09d88a57376544710141c9e94928f0088b93e1b80f294d331e9ecaf6d4d29b07

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in formatting.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Barsoom AB
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# Formatting
+
+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.
+
+Formats:
+  * Numbers
+  * Currency
+
+
+## Usage
+
+Call methods on `Formatting`:
+
+``` ruby
+Formatting.format_number(1234.567)  # => "1,234.57"
+```
+
+Or include the modules you want:
+
+``` ruby
+include Formatting::Number
+format_number(1234)  # => "1,234"
+
+include Formatting::Currency
+format_currency("SEK", 1234)  # => "1,234 SEK"
+```
+
+
+### Number
+
+``` 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"
+```
+
+### 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"
+
+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.defaults[:currency] = "SEK"
+item = Item.new(price: 1234)  # Does not respond to "currency"
+Formatting.format_currency(item, :price)  # => "1,234 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"
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'formatting'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install formatting
+
+
+## TODO
+
+* Actually use i18n for separators
+* Don't depend on `i18n`?
+* Rename? This name is boring and also generic enough that collisions seem likely.
+* Document options

data/Rakefile

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

data/formatting.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'formatting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "formatting"
+  spec.version       = Formatting::VERSION
+  spec.authors       = ["Henrik Nyh"]
+  spec.email         = ["henrik@nyh.se"]
+  spec.summary       = %q{Rails-less formatting for your unit-testable code.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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.add_dependency "i18n"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/formatting/currency.rb

@@ -0,0 +1,35 @@
+module Formatting
+  module Currency
+    include Number
+
+    def format_currency(record, amount_or_method, opts = {})
+      opts = Formatting.defaults.merge(opts)
+
+      format_string = opts.fetch(:format, "<amount> <currency>")
+
+      currency = opts.fetch(:currency) {
+        record.respond_to?(:currency) ? record.currency: nil
+      }
+
+      if amount_or_method.is_a?(Symbol)
+        amount = record.public_send(amount_or_method)
+      else
+        amount = amount_or_method
+      end
+
+      amount = format_number(amount, opts)
+      apply_format_string(format_string, amount, currency)
+    end
+
+    private
+
+    def apply_format_string(format_string, amount, currency)
+      out = format_string.dup
+      out.gsub!("<amount>", amount)
+      out.gsub!("<currency>", currency.to_s)
+      out.strip!
+      out.gsub!(" ", NON_BREAKING_SPACE)
+      out
+    end
+  end
+end

data/lib/formatting/number.rb

@@ -0,0 +1,40 @@
+module Formatting
+  module Number
+    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)
+      explicit_sign   = opts.fetch(:explicit_sign, false)
+      blank_when_zero = opts.fetch(:blank_when_zero, false)
+
+      if blank_when_zero
+        return "" if number.zero?
+      end
+
+      # Avoid negative zero.
+      number = 0 if number.zero?
+
+      if round
+        number = number.round(round)
+      end
+
+      integer, decimals = number.to_s.split(".")
+      decimals ||= "0"
+
+      integer.gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{thousands_separator}")
+
+      if explicit_sign
+        integer = "+#{integer}" if number > 0
+      end
+
+      if min_decimals
+        decimals = decimals.ljust(min_decimals, "0")
+      end
+
+      [integer, decimals].join(decimal_separator)
+    end
+  end
+end

data/lib/formatting/version.rb

@@ -0,0 +1,3 @@
+module Formatting
+  VERSION = "0.0.1"
+end

data/lib/formatting.rb

@@ -0,0 +1,16 @@
+require "formatting/version"
+require "formatting/number"
+require "formatting/currency"
+
+module Formatting
+  NON_BREAKING_SPACE = "\xc2\xa0"
+
+  class << self
+    attr_accessor :defaults
+  end
+
+  self.defaults = {}
+
+  extend Number
+  extend Currency
+end

data/spec/currency_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+
+describe Formatting::Currency do
+  it "can be included as a module" do
+    object = Object.new
+    object.extend Formatting::Currency
+    expect(object).to respond_to(:format_currency)
+  end
+end
+
+describe Formatting do
+  describe ".format_currency" do
+    let(:item) { double }
+
+    context "method signature" do
+      it "can take a record and a value" do
+        expect_formatted(item, 1).to eq space_to_nbsp("1.0")
+      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")
+      end
+    end
+
+    context "formatting" do
+      it "formats numbers" do
+        expect_formatted(item, 1234.56).to include space_to_nbsp("1 234.56")
+      end
+
+      it "passes on number formatting options" do
+        expect_formatted(item, 1.567, round: 2).to include "1.57"
+      end
+
+      it "applies default options" do
+        Formatting.defaults = { currency: "FOO" }
+        expect_formatted(item, 1).to eq space_to_nbsp("1.0 FOO")
+      end
+    end
+
+    context "currency option" do
+      it "is added if provided" do
+        expect_formatted(item, 1234.56, currency: "XYZ").to eq space_to_nbsp("1 234.56 XYZ")
+      end
+
+      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")
+      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")
+      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")
+      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")
+      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"
+      end
+
+      it "is stripped" do
+        expect_formatted(item, 123, format: "<amount> <currency>", currency: nil).
+          to eq space_to_nbsp("123.0")
+      end
+    end
+  end
+
+  def expect_formatted(record, value, opts = {})
+    expect(Formatting.format_currency(record, value, opts))
+  end
+end

data/spec/formatting_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe Formatting do
+  describe "defaults" do
+    it "starts out as an empty hash" do
+      expect(Formatting.defaults).to eq({})
+    end
+
+    it "can get and set them" do
+      Formatting.defaults = { hello: "world" }
+      expect(Formatting.defaults).to eq({ hello: "world" })
+    end
+  end
+end

data/spec/number_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+describe Formatting::Number do
+  it "can be included as a module" do
+    object = Object.new
+    object.extend Formatting::Number
+    expect(object).to respond_to(:format_number)
+  end
+end
+
+describe Formatting do
+  describe ".format_number" do
+    it "groups thousands" do
+      expect_formatted(1234567.89).to eq space_to_nbsp("1 234 567.89")
+    end
+
+    it "applies default options" do
+      Formatting.defaults = { round: 3 }
+      expect_formatted(12.3456789).to eq "12.346"
+    end
+
+    context "rounding" do
+      it "doesn't round by default" do
+        expect_formatted(12.3456789).to eq "12.3456789"
+      end
+
+      it "rounds to the given number of decimals" do
+        expect_formatted(12.3456789, round: 2).to eq "12.35"
+      end
+    end
+
+    context "blanking when zero" do
+      it "does not happen by default" do
+        expect_formatted(0).to eq "0.0"
+      end
+
+      it "can be enforced" do
+        expect_formatted(0, blank_when_zero: true).to eq ""
+      end
+    end
+
+
+    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"
+      end
+
+      it "can be enforced" do
+        expect_formatted(12.3, min_decimals: 2).to eq "12.30"
+      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"
+      end
+
+      it "never shows 0 as negative" do
+        expect_formatted(-0.0).to eq "0.0"
+      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"
+      end
+    end
+  end
+
+  def expect_formatted(value, opts = {})
+    expect(Formatting.format_number(value, opts))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "formatting"
+
+module Helpers
+  def space_to_nbsp(value)
+    value.gsub(" ", "\xc2\xa0")
+  end
+end
+
+RSpec.configure do |config|
+  config.include Helpers
+
+  config.before do
+    Formatting.defaults = {}
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: formatting
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Henrik Nyh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-09 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
+    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: 
+email:
+- henrik@nyh.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- formatting.gemspec
+- lib/formatting.rb
+- lib/formatting/currency.rb
+- lib/formatting/number.rb
+- lib/formatting/version.rb
+- spec/currency_spec.rb
+- spec/formatting_spec.rb
+- spec/number_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Rails-less formatting for your unit-testable code.
+test_files:
+- spec/currency_spec.rb
+- spec/formatting_spec.rb
+- spec/number_spec.rb
+- spec/spec_helper.rb
+has_rdoc: