short_scale 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c5ce2c81bf4c7ec35a1e4373515738ce646e830
+  data.tar.gz: 98e60a39fb421131c7e9f4c6c9b24c7dfec0ece3
+SHA512:
+  metadata.gz: 34bf990fd9968ec0e3a7544003ee62dc04103d07071ace51cdbddba014ff6460be81e34a5caa0f2c4031d456051c85e6ad61ee38debce9e3fd3b93f1179f109b
+  data.tar.gz: 18a277ae8063ee5a2b57ddee2412b74ebc3245fc28bb8ea804f8f5338d983d65cc390260a21aecf57c2c87b9cb40a50c2e083a82d0683c681591d352eb0d1fe9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Érik Escobedo
+
+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,80 @@
+# ShortScale
+
+ShortScale provides a `Prettifier` class capable of display numbers in a
+"Short Scale" format (https://en.wikipedia.org/wiki/Long_and_short_scales).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'short_scale'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install short_scale
+
+## Usage
+
+```ruby
+require 'short_scale'
+
+# If no configuration is provided, it will use 'M' for 10^6, 'B' for 10^9 and 'T' for
+# 10^12 and bigger numbers.
+prettifier = ShortScale::Prettifier.new
+
+prettifier.prettify(1_000_000)         #=> '1M'
+prettifier.prettify(512.5)             #=> '512.5'
+prettifier.prettify(2_345_000.123)     #=> '2.3M'
+prettifier.prettify(123_456_789_123)   #=> '123.4B'
+prettifier.prettify(9_123_456_789_123) #=> '9.1T'
+
+
+# You can also provide a set of tiers in the following format
+prettifier = ShortScale::Prettifier.new(tiers: {
+  0 => ' units',
+  3 => ' thousands',
+  6 => ' millions',
+  9 => ' billions'
+})
+
+prettifier.prettify(1_000_000)         #=> '1 millions' (no support for singular/plural inflections)
+prettifier.prettify(5125.4)            #=> '5.1 thousands'
+prettifier.prettify(345.123)           #=> '345.1 units'
+prettifier.prettify(123_456_789_123)   #=> '123.4 billions'
+prettifier.prettify(9_123_456_789_123) #=> '9123.4 billions' (since trillions tier was not provided)
+
+# It also works with bases different than 10
+prettifier = ShortScale::Prettifier.new(base: 2, tiers: {
+  0  => 'B',
+  10 => 'KB',
+  20 => 'MB',
+  30 => 'GB',
+  40 => 'TB'
+})
+
+prettifier.prettify(1023)              #=> '1023B'
+prettifier.prettify(1024)              #=> '1KB'
+prettifier.prettify(1048064)           #=> '1023.5KB' 
+prettifier.prettify(1048576)           #=> '1MB'
+prettifier.prettify(9_123_456_789_123) #=> '8TB'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/erik-escobedo/short_scale/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 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "short_scale"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/short_scale/version.rb

@@ -0,0 +1,3 @@
+module ShortScale
+  VERSION = "0.1.3"
+end

data/lib/short_scale.rb

@@ -0,0 +1,7 @@
+require "short_scale/version"
+require "short_scale/formatter"
+require "short_scale/prettifier"
+require "short_scale/tier_calculator"
+
+module ShortScale
+end

data/short_scale.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'short_scale/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "short_scale"
+  spec.version       = ShortScale::VERSION
+  spec.authors       = ["Érik Escobedo"]
+  spec.email         = ["erik@codigojade.com"]
+
+  spec.summary       = %q{Prettify big numbers using Short Scale format.}
+  spec.description   = %q{Prettify big numbers using Short Scale format.}
+  spec.homepage      = "http://github.com/erik-escobedo/short_scale"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = Dir["lib/**/*.rb"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: short_scale
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- "Érik Escobedo"
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Prettify big numbers using Short Scale format.
+email:
+- erik@codigojade.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/short_scale.rb
+- lib/short_scale/version.rb
+- short_scale.gemspec
+homepage: http://github.com/erik-escobedo/short_scale
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib/short_scale/formatter.rb
+- lib/short_scale/prettifier.rb
+- lib/short_scale/tier_calculator.rb
+- lib/short_scale/version.rb
+- lib/short_scale.rb
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Prettify big numbers using Short Scale format.
+test_files: []