formatter-number 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a958ca48f69073a657bda85bb491bc08ac9b4322
+  data.tar.gz: 7c665188d484612937c86c3c79fa8f278074bc6e
+SHA512:
+  metadata.gz: 8cdb4b416ecec80cf80ce3a2d4e57bbbb0e2c7c05b247bd22c691401a8eec18a2a432dff4861437c7956fa666a8b01ca8219f0f46c76a6cdc48d7a9c2b85da59
+  data.tar.gz: 561e37d6b49006736c18e5e87701990b34a5b354c0d434574d72fda4f06542e8e6d5a548da2ea2f33ac8f193ebab717151df9aba7907be76413a581c1fb8fc7c

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,80 @@
+AllCops:
+  Exclude:
+    - Gemfile
+    - bin/**/*
+    - vendor/**/*
+
+Encoding:
+  Enabled: true
+
+Documentation:
+  Enabled: true
+  Exclude:
+    - test/**/*
+
+LineLength:
+  Max: 82
+
+# Class
+ClassLength:
+  Max: 80
+
+EmptyLinesAroundAccessModifier:
+  Enabled: false
+
+AccessModifierIndentation:
+  EnforcedStyle: indent
+
+# Error
+RaiseArgs:
+  EnforcedStyle: exploded
+
+SignalException:
+  EnforcedStyle: semantic
+
+# Method
+MethodLength:
+  Max: 10
+
+SingleLineMethods:
+  AllowIfMethodIsEmpty: false
+
+CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    reduce: 'inject'
+    detect: 'find'
+    find_all: 'select'
+
+FormatString:
+  Enabled: false
+
+# Parameter
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+BracesAroundHashParameters:
+  Enabled: false
+  EnforcedStyle: braces
+
+# Block
+BlockNesting:
+  Max: 3
+
+# Brackets
+SpaceInsideBrackets:
+  Enabled: true
+
+# Hash
+IndentHash:
+  EnforcedStyle: consistent
+
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: space
+
+# String
+StringLiterals:
+  EnforcedStyle: single_quotes

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+script: 'bundle exec rake ci'
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - jruby-19mode
+  - rbx-2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Terje Larsen
+
+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,49 @@
+# formatter-number
+
+Format numbers
+
+[![Gem Version](https://badge.fury.io/rb/formatter-number.svg)](http://badge.fury.io/rb/formatter-number)
+[![Build
+Status](https://travis-ci.org/terlar/formatter-number.svg)](https://travis-ci.org/terlar/formatter-number)
+[![Code Climate](https://codeclimate.com/github/terlar/formatter-number.png)](https://codeclimate.com/github/terlar/formatter-number)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'formatter-number'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install formatter-number
+
+## Usage
+
+```ruby
+formatter = Formatter::Number.new
+formatter.format(10.556)  # "10.56"
+formatter.format(505_000) # "505,000"
+
+formatter = Formatter::Number.new(grouping: 2)
+formatter.format(10_000)  # "10,000"
+formatter.format(505_000) # "5,05,000"
+
+formatter = Formatter::Number.new(grouping: 4)
+formatter.format(100_004)    # "10,0004"
+formatter.format(10_050_026) # "1005,0026"
+
+formatter = Formatter::Number.new(delimiter: ' ')
+formatter.format(10_000)  # "10 000"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/terlar/formatter-number/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: :test
+task test: 'test:all'
+task ci: %w(rubocop test:all)
+
+namespace :test do
+  desc 'Run all tests'
+  Rake::TestTask.new :all do |t|
+    t.test_files = Rake::FileList['test/*_test.rb']
+  end
+
+  desc 'Run unit tests'
+  Rake::TestTask.new :unit do |t|
+    t.test_files = Rake::FileList['test/unit_test.rb']
+  end
+
+  desc 'Run integration tests'
+  Rake::TestTask.new :integration do |t|
+    t.test_files = Rake::FileList['test/integration_test.rb']
+  end
+end

data/formatter-number.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/formatter/number/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'formatter-number'
+  gem.version       = Formatter::Number::VERSION.dup
+  gem.authors       = ['Terje Larsen']
+  gem.email         = 'terlar@gmail.com'
+  gem.description   = 'Number formatter'
+  gem.summary       = gem.description
+  gem.homepage      = 'https://github.com/terlar/formatter-number'
+  gem.license       = 'MIT'
+
+  gem.require_paths = %w(lib)
+  gem.files         = `git ls-files`.split($RS)
+  gem.test_files    = gem.files.grep(/^test\//)
+  gem.extra_rdoc_files = %w(LICENSE README.md)
+
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.add_development_dependency 'bundler', '~> 1.6'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'rubocop'
+end

data/lib/formatter/number/version.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+module Formatter
+  # Gem version
+  class Number
+    VERSION = '0.1.0'
+  end
+end

data/lib/formatter/number.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+
+module Formatter
+  # Number formatter
+  class Number
+    DEFAULTS = {
+      decimals: 2,
+      fixed: false,
+      separator: '.',
+      grouping: 3,
+      delimiter: ','
+    }.freeze
+
+    # Initialize a formatter with the desired options.
+    #
+    # @param [Hash] options the options to create a formatter with
+    # @option options [Integer] :decimals (2) Number of decimal points
+    # @option options [Boolean] :fixed (false) Fixed decimal places
+    # @option options [String] :separator ('.') Decimal mark
+    # @option options [Integer] :grouping (3) Number of digits per group
+    # @option options [String] :delimiter (',') Delimiter between groups
+    def initialize(options = { }.freeze)
+      @options = defaults.merge(options)
+    end
+
+    def format(number)
+      case number
+      when Float then format_float(number)
+      when Integer then format_integer(number)
+      else fail ArgumentError
+      end
+    end
+
+    private
+    def format_float(number)
+      if fixed?
+        number = "%0.0#{decimals}f" % number
+      else
+        number = number.round(decimals)
+      end
+
+      number = number.to_s.gsub('.', separator)
+
+      delimit(number)
+    end
+
+    def format_integer(number)
+      delimit(number)
+    end
+
+    def delimit(number)
+      if grouping == 2
+        # When grouped by two the first group is by three and the rest of them
+        # are grouped by two. This is according to the Indian Numbering System.
+        number.to_s.gsub(/(\d+?)(?=(\d\d)+(\d)(?!\d))(\.\d+)?/, "\\1#{delimiter}")
+      else
+        group = '\d' * grouping
+        number.to_s.gsub(/(\d)(?=(#{group})+(?!\d))/, "\\1#{delimiter}")
+      end
+    end
+
+    def defaults
+      DEFAULTS
+    end
+
+    def decimals
+      @options.fetch :decimals
+    end
+
+    def fixed?
+      @options.fetch :fixed
+    end
+
+    def separator
+      @options.fetch :separator
+    end
+
+    def grouping
+      @options.fetch :grouping
+    end
+
+    def delimiter
+      @options.fetch :delimiter
+    end
+  end
+end

data/lib/formatter-number.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+require 'formatter/number'

data/test/integration_test.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+
+require_relative 'test_helper'
+
+class IntegrationTest < Minitest::Test
+  attr_reader :options
+
+  def setup
+    @options = { }
+  end
+
+  def format(number)
+    Formatter::Number.new(options).format(number)
+  end
+
+  def test_fails_with_invalid_number
+    assert_raises ArgumentError do
+      format('invalid number')
+    end
+  end
+
+  def test_decimals_defaults_to_two
+    assert_equal '10.56', format(10.556)
+  end
+
+  def test_can_set_decimals
+    @options[:decimals] = 3
+
+    assert_equal '10.556', format(10.556)
+  end
+
+  def test_decimals_are_not_fixed_by_default
+    assert_equal '10.5', format(10.5)
+  end
+
+  def test_can_set_fixed_to_make_decimals_fixed
+    @options[:fixed] = true
+
+    assert_equal '10.50', format(10.5)
+  end
+
+  def test_separator_defaults_to_dot
+    assert_equal '10.53', format(10.53)
+  end
+
+  def test_can_set_separator_delimiter
+    @options[:separator] = ','
+
+    assert_equal '10,53', format(10.53)
+  end
+
+  def test_grouping_defaults_to_three
+    assert_equal '100', format(100)
+    assert_equal '10,000', format(10_000)
+    assert_equal '505,000', format(505_000)
+    assert_equal '121,212,123', format(121_212_123)
+    assert_equal '7,000,000,000', format(7_000_000_000)
+  end
+
+  def test_can_set_the_grouping_with_2
+    @options[:grouping] = 2
+
+    assert_equal '100', format(100)
+    assert_equal '10,000', format(10_000)
+    assert_equal '5,05,000', format(505_000)
+    assert_equal '12,12,12,123', format(121_212_123)
+    assert_equal '7,00,00,00,000', format(7_000_000_000)
+  end
+
+  def test_can_set_the_grouping_with_4
+    @options[:grouping] = 4
+    assert_equal '10,0004', format(100_004)
+    assert_equal '1005,0026', format(10_050_026)
+    assert_equal '12,3456,7890,2345', format(12_345_678_902_345)
+  end
+
+  def test_delimiter_defaults_to_comma
+    assert_equal '10,000', format(10_000)
+  end
+
+  def test_can_set_the_delimiter
+    @options[:delimiter] = ' '
+
+    assert_equal '10 000', format(10_000)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'bundler/setup'
+require 'formatter-number'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: formatter-number
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Terje Larsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: minitest
+  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: rubocop
+  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: Number formatter
+email: terlar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- formatter-number.gemspec
+- lib/formatter-number.rb
+- lib/formatter/number.rb
+- lib/formatter/number/version.rb
+- test/integration_test.rb
+- test/test_helper.rb
+homepage: https://github.com/terlar/formatter-number
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Number formatter
+test_files:
+- test/integration_test.rb
+- test/test_helper.rb