short_scale 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c5ce2c81bf4c7ec35a1e4373515738ce646e830
-  data.tar.gz: 98e60a39fb421131c7e9f4c6c9b24c7dfec0ece3
+  metadata.gz: ade3c051fef9388f4ed7481cabe77f192ba935c7
+  data.tar.gz: bd5f3901df0430c003544303cba6413207cba78f
 SHA512:
-  metadata.gz: 34bf990fd9968ec0e3a7544003ee62dc04103d07071ace51cdbddba014ff6460be81e34a5caa0f2c4031d456051c85e6ad61ee38debce9e3fd3b93f1179f109b
-  data.tar.gz: 18a277ae8063ee5a2b57ddee2412b74ebc3245fc28bb8ea804f8f5338d983d65cc390260a21aecf57c2c87b9cb40a50c2e083a82d0683c681591d352eb0d1fe9
+  metadata.gz: 278e4c436fd2cda493856809a704c51d6fedcafc661140efdad241d82a8ebd9d64fb5997b954e378bacfcba708e857ad42c16dce833ce8a82af0f45d00fac8a5
+  data.tar.gz: 35613b3786fe92417ef4d7747526661bd9017810b02bdfb1607ec8a40a09513ca099b87a4b23871bf4566d79be31341516cbcb73d6730aa474db83b0a8be028d

data/lib/short_scale/formatter.rb

@@ -0,0 +1,20 @@
+module ShortScale
+  class Formatter
+    def initialize(config = {})
+      @base = config[:base]
+      @tier = config[:tier]
+    end
+
+    def format(number)
+      value(number) + @tier[:unit]
+    end
+
+    private
+    def value(number)
+      # This truncates n to a single decimal and remove .0 when necessary
+      n = number / @base ** (@tier[:magnitude] - 1)
+
+      "#{n.to_i / @base.to_f}".sub('.0', '')
+    end
+  end
+end

data/lib/short_scale/prettifier.rb

@@ -0,0 +1,20 @@
+module ShortScale
+  class Prettifier
+    def initialize(config = {})
+      # Default base is decimal
+      @base = config[:base] || 10
+
+      @tier_calc = ShortScale::TierCalculator.new(config)
+    end
+
+    def prettify(number)
+      negative  = number < 0
+      number *= -1 if negative
+
+      tier = @tier_calc.tier(number)
+      formatter = ShortScale::Formatter.new(base: @base, tier: tier)
+
+      "#{'-' if negative}" + formatter.format(number)
+    end
+  end
+end

data/lib/short_scale/tier_calculator.rb

@@ -0,0 +1,44 @@
+module ShortScale
+  class TierCalculator
+    @@default_config = {
+      base: 10,
+      tiers: {
+        6  => 'M',
+        9  => 'B',
+        12 => 'T'
+      }
+    }
+
+    def initialize(config = {})
+      # Prioritize provided configuration over default
+      @base  = config[:base]  || @@default_config[:base]
+      @tiers = config[:tiers] || @@default_config[:tiers]
+
+      # Add zero magnitude tier (units) if not provided
+      @tiers[0] ||= ''
+    end
+
+    # Calculates the tier for a given number
+    def tier(number)
+      _magnitude = magnitude(number)
+
+      # If provided number is lesser than 1 then magnitude defaults to zero
+      if _magnitude > 0
+        tier_magnitude = @tiers.keys.select { |limit| limit <= _magnitude }.max
+      else
+        tier_magnitude = 0
+      end
+
+      {
+        magnitude: tier_magnitude,
+        unit: @tiers[tier_magnitude]
+      }
+    end
+
+    private
+    # Calculates the magnitude of a number if a given base
+    def magnitude(number)
+      Math.log10(number) / Math.log10(@base)
+    end
+  end
+end

data/lib/short_scale/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: short_scale
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - "Érik Escobedo"
@@ -59,17 +59,11 @@ 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/formatter.rb
+- lib/short_scale/prettifier.rb
+- lib/short_scale/tier_calculator.rb
 - lib/short_scale/version.rb
-- short_scale.gemspec
 homepage: http://github.com/erik-escobedo/short_scale
 licenses:
 - MIT
@@ -77,11 +71,7 @@ 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
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +0,0 @@
-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

@@ -1,80 +0,0 @@
-# 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

@@ -1 +0,0 @@
-require "bundler/gem_tasks"

data/bin/console

@@ -1,14 +0,0 @@
-#!/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

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

data/short_scale.gemspec

@@ -1,25 +0,0 @@
-# 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