si 0.1.0

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 si.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Junegunn Choi
+
+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,71 @@
+# SI
+
+Formats a number with [SI prefix (Metric prefix)](http://en.wikipedia.org/wiki/SI_prefix).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'si'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install si
+
+## Usage
+
+### `si`
+
+```ruby
+0.9.si            # '900m'
+9.si              # '9'
+98.si             # '98'
+987.si            # '987'
+9876.si           # '9.88k'
+98765.si          # '98.8k'
+987654.si         # '988k'
+9876543.si        # '9.88M'
+98765432.si       # '98.8M'
+987654321.si      # '988M'
+9876543210.si     # '9.88G'
+98765432100.si    # '98.8G'
+987654321000.si   # '988G'
+9876543210000.si  # '9.88T'
+# ...
+
+```
+
+#### Options
+
+- `:length` Number of digits. (default: 3)
+- `:base` For [binary prefix](http://en.wikipedia.org/wiki/Binary_prefix), set this to 1024 instead of default 1000.
+- `:min_exp` Default: -8, down to <strong>y</strong>octo
+- `:max_exp` Default:  8, up to <strong>Y</strong>otta
+
+```ruby
+9876543210000.si(:length => 5)  # '9.8765T'
+```
+
+### `si_byte`
+
+`si_byte` is simply a shorcut for 
+
+```ruby
+number.si(:length => length, :base => 1024, :min_exp => 0) + 'B'
+```
+
+```ruby
+13255342817.si_byte(3)  # '12.3GB'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/lib/si.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require "si/version"
+
+module SI
+  PREFIXES = Hash[ -8.upto(8).zip(%[yzafpnμm kMGTPEZY].chars.map(&:strip)) ]
+  DEFAULT = {
+    :length  =>    3,
+    :base    => 1000,
+    :min_exp =>   -8,
+    :max_exp =>    8,
+  }
+
+  def si options = {}
+    options = DEFAULT.merge(options)
+    length,
+    min_exp,
+    max_exp = options.values_at(:length, :min_exp, :max_exp)
+    base    = options[:base].to_f
+    minus   = self < 0 ? '-' : ''
+    selfp   = self.abs
+
+    PREFIXES.keys.sort.reverse.select { |exp| (min_exp..max_exp).include? exp }.each do |exp|
+      denom = base ** exp
+      if selfp >= denom || exp == min_exp
+        val = selfp / denom
+        val = val.round [length - val.to_i.to_s.length, 0].max
+        val = val.to_i if exp == 0 && self.is_a?(Fixnum)
+        val = val.to_s.ljust(length + 1, '0') if val.is_a?(Float)
+
+        return "#{minus}#{val}#{PREFIXES[exp]}"
+      end
+    end
+
+    nil
+  end
+
+  def si_byte length = 3
+    self.si(:length => length, :base => 1024, :min_exp => 0) + 'B'
+  end
+end
+
+class Float
+  include SI
+end
+
+class Fixnum
+  include SI
+end
+
+class Bignum
+  include SI
+end
+

data/lib/si/version.rb

@@ -0,0 +1,3 @@
+module SI
+  VERSION = "0.1.0"
+end

data/si.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/si/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Junegunn Choi"]
+  gem.email         = ["junegunn.c@gmail.com"]
+  gem.description   = %q{Formats a number with SI prefix}
+  gem.summary       = %q{Formats a number with SI prefix (metric prefix)}
+  gem.homepage      = "https://github.com/junegunn/si"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "si"
+  gem.require_paths = ["lib"]
+  gem.version       = SI::VERSION
+end

data/test/test_si.rb

@@ -0,0 +1,180 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'test/unit'
+require 'si'
+
+class TestSI < Test::Unit::TestCase
+  def test_si
+    val = 0.000_000_000_000_000_000_000_000_0001234567
+
+    %w[
+      0.00012y
+      0.00123y
+      0.01235y
+      0.12346y
+
+      1.23457y
+      12.3457y
+      123.457y
+
+      1.23457z
+      12.3457z
+      123.457z
+
+      1.23457a
+      12.3457a
+      123.457a
+
+      1.23457f
+      12.3457f
+      123.457f
+
+      1.23457p
+      12.3457p
+      123.457p
+
+      1.23457n
+      12.3457n
+      123.457n
+
+      1.23457μ
+      12.3457μ
+      123.457μ
+
+      1.23457m
+      12.3457m
+      123.457m
+    
+      1.23457
+      12.3457
+      123.457
+    
+      1.23457k
+      12.3457k
+      123.457k
+    
+      1.23457M
+      12.3457M
+      123.457M
+    
+      1.23457G
+      12.3457G
+      123.457G
+    
+      1.23457T
+      12.3457T
+      123.457T
+    
+      1.23457P
+      12.3457P
+      123.457P
+    
+      1.23457E
+      12.3457E
+      123.457E
+
+      1.23457Z
+      12.3457Z
+      123.457Z
+
+      1.23457Y
+      12.3457Y
+      123.457Y
+
+      1234.57Y
+      12345.7Y
+      123457Y
+      1234567Y
+      12345670Y
+      123456700Y
+      1234567000Y
+    ].each do |ret|
+      assert_equal ret, val.si(:length => 6)
+      assert_equal '-' + ret, (-val).si(:length => 6)
+      val *= 10
+    end
+  end
+
+  def test_si_base
+    val = 807936
+    %w[
+      789k
+      789M
+      789G
+      789T
+      807936T
+      827326464T
+    ].each do |ret|
+      assert_equal ret, val.si(:base => 1024, :max_exp => 4)
+      val *= 1024
+    end
+  end
+
+  def test_si_byte
+    {
+      1234132             => '1.18MB',
+      123004132           => '117MB',
+      123004999132        => '115GB',
+      555123004999132     => '505TB',
+      5555123004999132    => '4.93PB',
+      3335555123004999132 => '2.89EB',
+      0.001               => '0.00B',
+      0.005               => '0.01B',
+      0.01                => '0.01B',
+      0.1                 => '0.10B',
+      0                   => '0B',
+      1                   => '1B',
+      1.0                 => '1.00B',
+      1.01                => '1.01B',
+      10                  => '10B',
+      10.0                => '10.0B',
+      100                 => '100B',
+      100.0               => '100B',
+      0.0                 => '0.00B',
+      0.123412            => '0.12B',
+      0.0123412           => '0.01B',
+      0.00123412          => '0.00B',
+    }.each do |val, ret|
+      assert_equal ret, val.si_byte
+
+      if val == 0
+        assert_equal ret, (-val).si_byte
+      else
+        assert_equal '-' + ret, (-val).si_byte unless val == 0
+      end
+    end
+  end
+
+  def test_readme
+    {
+      0.009         => '9.00m',
+      0.09          => '90.0m',
+      0.9           => '900m',
+      9             => '9',
+      98            => '98',
+      987           => '987',
+      9876          => '9.88k',
+      98765         => '98.8k',
+      987654        => '988k',
+      9876543       => '9.88M',
+      98765432      => '98.8M',
+      987654321     => '988M',
+      9876543210    => '9.88G',
+      98765432100   => '98.8G',
+      987654321000  => '988G',
+      9876543210000 => '9.88T',
+    }.each do |val, ret|
+      assert_equal ret, val.si
+    end
+
+    assert_equal '9.8765T', 9876543210000.si(:length => 5)
+    assert_equal '12.3GB', 13255342817.si_byte
+  end
+
+  def test_edge_cases
+    assert_equal '9.0000T', 9000000000001.si(:length => 5)
+  end
+end
+

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: si
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Junegunn Choi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-11 00:00:00.000000000 Z
+dependencies: []
+description: Formats a number with SI prefix
+email:
+- junegunn.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/si.rb
+- lib/si/version.rb
+- si.gemspec
+- test/test_si.rb
+homepage: https://github.com/junegunn/si
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Formats a number with SI prefix (metric prefix)
+test_files:
+- test/test_si.rb