si 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3d6c6cb24a8ed364c310019d4ad39af6f6bdc0c9ffeba7915854ef72a3de125
-  data.tar.gz: e67d999cd37a2f6d2cfb0c05994bb43d447e18bbc0e3aa9f0ee953f026772007
+  metadata.gz: 5504e33c6ff5bd548c433862a31d08370e2696928c7348326174799b35f6b836
+  data.tar.gz: defc061bb3cb96a3d54768ce99392713308244305ca5d84277ca675481da3575
 SHA512:
-  metadata.gz: c379c44a26d41a4d9e80448f6e9ced1b24723b9bb7b9300b2a71ec244c97c7fe98ea428e607c395d5940ea7b5a70f6b96a81cc0e0f770aa743c46b7c78fbe94a
-  data.tar.gz: d447b4d285805e5947d2f03caec9764f6547aebaa1b7feeacbe2f416a954e32f30559a9d8a55867a9aa3559c6f0ff318561ec742ff6d24e60f6054d5d483f177
+  metadata.gz: f23c952660cd2c9bfad5f20916dbf6c73da4161b7aab7152adba78737b7b8fc6ed188ae70d4f6ee9c7129a430009e62a5a03c86f44fa12f47f9de8f959cd1556
+  data.tar.gz: 5396036c1b5fddd02fd4ecccc9be9a1c200782e4d0048d1067b9ad345a9a59e2ca44ad70c977d35b1a6be9249d57128f82e0c1ee4e69a7917621bb313234aea8

data/.gitignore

@@ -14,3 +14,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+Gemfile.lock

data/README.md

@@ -45,33 +45,42 @@ require 'si'
 
 #### Options
 
-| Option     | Default | Description                                                                                               |
-|------------|---------|-----------------------------------------------------------------------------------------------------------|
-| `:length`  |       3 | Number of digits                                                                                          |
-| `:base`    |    1000 | For [binary prefix](http://en.wikipedia.org/wiki/Binary_prefix), set this to 1024 instead of default 1000 |
-| `:min_exp` |      -8 | Down to <strong>y</strong>octo                                                                            |
-| `:max_exp` |       8 | Up to <strong>Y</strong>otta                                                                              |
+| Option       | Default   | Description                                                                                                 |
+| ------------ | --------- | ----------------------------------------------------------------------------------------------------------- |
+| `:length`    | 3         | Number of digits                                                                                            |
+| `:base`      | 1000      | For [binary prefix](http://en.wikipedia.org/wiki/Binary_prefix), set this to 1024 instead of default 1000   |
+| `:space`     | `''`      | Space between number and prefix. Set to `' '` to get `9.88 T` instead of `9.88T`                            |
+| `:min_exp`   | -8        | Down to <strong>y</strong>octo                                                                              |
+| `:max_exp`   | 8         | Up to <strong>Y</strong>otta                                                                                |
 
 ```ruby
-9876543210000.si(:length => 5)  # '9.8765T'
+9876543210000.si(length: 5)  # '9.8765T'
 
 # For convenience, a single Fixnum is recognized as :length value
 9876543210000.si(5)             # '9.8765T'
 ```
 
-### `si_byte`
+### `si_bytes`
 
-`si_byte` is simply a shorcut for `number.si(:length => length, :base => 1024, :min_exp => 0) + 'B'`.
+Formats the number of bytes using SI prefixes (base 1000).
 
 ```ruby
-13255342817.si_byte(3)  # '12.3GB'
+13255342817.si_bytes  # '13.3GB'
+```
+
+### `bin_bytes`
+
+Formats the number of bytes using binary prefixes (base 1024).
+
+```ruby
+13255342817.bin_bytes  # '12.3GiB'
 ```
 
 ## SI module methods: convert / revert
 
 ```ruby
-SI.convert(9876543210000, :length => 5)  # '9.8765T'
-SI.revert('100k', :base => 1024)         # 102400.0
+SI.convert(9876543210000, length: 5)  # '9.8765T'
+SI.revert('100k', base: 1024)         # 102400.0
 ```
 
 ## Avoiding monkey-patching

data/lib/si/constants.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module SI
   PREFIXES = {
@@ -10,22 +10,22 @@ module SI
     -3 => 'n',
     -2 => 'μ',
     -1 => 'm',
-     0 => '',
-     1 => 'k',
-     2 => 'M',
-     3 => 'G',
-     4 => 'T',
-     5 => 'P',
-     6 => 'E',
-     7 => 'Z',
-     8 => 'Y'
-  }
+    0 => '',
+    1 => 'k',
+    2 => 'M',
+    3 => 'G',
+    4 => 'T',
+    5 => 'P',
+    6 => 'E',
+    7 => 'Z',
+    8 => 'Y'
+  }.freeze
 
   DEFAULT = {
-    :length  =>    3,
-    :base    => 1000,
-    :min_exp =>   -8,
-    :max_exp =>    8,
-  }
+    length: 3,
+    base: 1000,
+    space: '',
+    min_exp: -8,
+    max_exp: 8
+  }.freeze
 end
-

data/lib/si/minimal.rb

@@ -1,4 +1,5 @@
+# frozen_string_literal: true
+
 require 'si/version'
 require 'si/constants'
 require 'si/module'
-

data/lib/si/module.rb

@@ -1,63 +1,77 @@
+# frozen_string_literal: true
+
 module SI
   class << self
-    def convert num, options = {}
-      options = { :length => options } if options.is_a?(Numeric)
+    def convert(num, options = {})
+      options = { length: options } if options.is_a?(Numeric)
       options = DEFAULT.merge(options)
-      length,
-      min_exp,
-      max_exp = options.values_at(:length, :min_exp, :max_exp)
-      raise ArgumentError.new("Invalid length") if length < 2
-      return num.is_a?(Float) ? "0.#{'0' * (length - 1)}" : '0' if num == 0
-
-      base    = options[:base].to_f
-      minus   = num < 0 ? '-' : ''
-      nump    = num.abs
-
-      PREFIXES.keys.sort.reverse.select { |exp| (min_exp..max_exp).include? exp }.each do |exp|
-        denom = base ** exp
-        if nump >= denom || exp == min_exp
-          val = nump / denom
-          val = SI.round val, [length - val.to_i.to_s.length, 0].max
-          val = val.to_i if exp == 0 && !num.is_a?(Float)
-          val = val.to_s.ljust(length + 1, '0') if val.is_a?(Float)
-
-          return "#{minus}#{val}#{PREFIXES[exp]}"
-        end
+      space, length, min_exp, max_exp = options.values_at(:space, :length, :min_exp, :max_exp)
+      raise ArgumentError, 'Invalid length' if length < 2
+
+      return num.is_a?(Float) ? "0.#{'0' * (length - 1)}" : '0' if num.zero?
+
+      base = options[:base].to_f
+      minus = num.negative? ? '-' : ''
+      nump = num.abs
+
+      PREFIXES.keys.sort.reverse.select { |exp| (min_exp..max_exp).include?(exp) }.each do |exp|
+        denom = base**exp
+        next unless nump >= denom || exp == min_exp
+
+        val = nump / denom
+        val = SI.round val, [length - val.to_i.to_s.length, 0].max
+        val = val.to_i if exp.zero? && !num.is_a?(Float)
+        val = val.to_s.ljust(length + 1, '0') if val.is_a?(Float)
+
+        return "#{minus}#{val}#{space}#{PREFIXES[exp]}"
       end
 
       nil
     end
 
-    def revert str, options = {}
-      options = Hash[ DEFAULT.select { |k, v| k == :base } ].merge(options)
-      pair    = PREFIXES.to_a.find { |k, v| !v.empty? && str =~ /[0-9]#{v}$/ }
+    def revert(str, options = {})
+      options = Hash[DEFAULT.select { |k, _v| k == :base }].merge(options)
+      pair    = PREFIXES.to_a.find { |_k, v| !v.empty? && str =~ /[0-9]#{v}$/ }
 
       if pair
-        str[0...-1].to_f * (options[:base] ** pair.first)
+        str[0...-1].to_f * (options[:base]**pair.first)
       else
         str.to_f
       end
     end
 
     if (RUBY_VERSION.split('.')[0, 2].map(&:to_i) <=> [1, 8]) == 1
-      def round val, ndigits
+      def round(val, ndigits)
         val.round ndigits
       end
     else
-      def round val, ndigits
-        exp = (10 ** ndigits).to_f
+      def round(val, ndigits)
+        exp = (10**ndigits).to_f
         val = ((val * exp).round / exp)
-        ndigits == 0 ? val.to_i : val
+        ndigits.zero? ? val.to_i : val
       end
     end
   end
 
-  def si options = {}
+  def si(options = {})
     SI.convert(self, options)
   end
 
-  def si_byte length = 3
-    SI.convert(self, :length => length, :base => 1024, :min_exp => 0) + 'B'
+  # Deprecated. Only kept for backward compatibility.
+  def si_byte(length = 3)
+    "#{SI.convert(self, length: length, base: 1024, min_exp: 0)}B"
+  end
+
+  def si_bytes(options = {})
+    options = { length: options } if options.is_a?(Numeric)
+    options = { base: 1000, length: 3, min_exp: 0 }.merge(options)
+    "#{SI.convert(self, options)}B"
   end
-end
 
+  def bin_bytes(options = {})
+    options = { length: options } if options.is_a?(Numeric)
+    options = { base: 1024, length: 3, min_exp: 0 }.merge(options)
+    result = SI.convert(self, options)
+    result.match?(/[0-9]$/) ? "#{result}B" : "#{result}iB"
+  end
+end

data/lib/si/patch.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 original_verbosity = $VERBOSE
 
 $VERBOSE = nil
 
-['Float', 'Fixnum', 'Bignum', 'Rational', 'Integer'].each do |const|
+%i[Float Fixnum Bignum Rational Integer].each do |const|
   next unless Object.const_defined?(const)
 
   Object.const_get(const).class_eval do

data/lib/si/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SI
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'
 end

data/lib/si.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'si/minimal'
 require 'si/patch'
-

data/si.gemspec

@@ -1,17 +1,16 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/si/version', __FILE__)
+require File.expand_path('lib/si/version', __dir__)
 
 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.authors       = ['Junegunn Choi']
+  gem.email         = ['junegunn.c@gmail.com']
+  gem.description   = 'Formats a number with SI prefix'
+  gem.summary       = '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.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.name          = 'si'
+  gem.require_paths = ['lib']
   gem.version       = SI::VERSION
 end

data/test/test_si.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
+# frozen_string_literal: true
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'test/unit'
@@ -46,31 +46,31 @@ class TestSI < Test::Unit::TestCase
       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
@@ -91,14 +91,14 @@ class TestSI < Test::Unit::TestCase
       123456700Y
       1234567000Y
     ].each do |ret|
-      assert_equal ret, val.si(:length => 6)
-      assert_equal '-' + ret, (-val).si(:length => 6)
+      assert_equal ret, val.si(length: 6)
+      assert_equal '-' + ret, (-val).si(length: 6)
       val *= 10
     end
   end
 
   def test_si_base
-    val = 807936
+    val = 807_936
     %w[
       789k
       789M
@@ -107,86 +107,121 @@ class TestSI < Test::Unit::TestCase
       807936T
       827326464T
     ].each do |ret|
-      assert_equal ret, val.si(:base => 1024, :max_exp => 4)
+      assert_equal ret, val.si(base: 1024, max_exp: 4)
       val *= 1024
     end
   end
 
-  def test_si_byte
+  def test_bin_bytes
+    {
+      1_234_132 => '1.18MiB',
+      123_004_132 => '117MiB',
+      123_004_999_132 => '115GiB',
+      555_123_004_999_132 => '505TiB',
+      5_555_123_004_999_132 => '4.93PiB',
+      3_335_555_123_004_999_132 => '2.89EiB',
+      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.bin_bytes
+
+      if val.zero?
+        assert_equal ret, (-val).bin_bytes
+      else
+        assert_equal "-#{ret}", (-val).bin_bytes
+      end
+    end
+  end
+
+  def test_si_bytes
     {
-      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',
+      1_234_132 => '1.23MB',
+      123_004_132 => '123MB',
+      123_004_999_132 => '123GB',
+      555_123_004_999_132 => '555TB',
+      5_555_123_004_999_132 => '5.56PB',
+      3_335_555_123_004_999_132 => '3.34EB',
+      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
+      assert_equal ret, val.si_bytes
 
-      if val == 0
-        assert_equal ret, (-val).si_byte
+      if val.zero?
+        assert_equal ret, (-val).si_bytes
       else
-        assert_equal '-' + ret, (-val).si_byte unless val == 0
+        assert_equal "-#{ret}", (-val).si_bytes
       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',
+      0.009 => '9.00m',
+      0.09 => '90.0m',
+      0.9 => '900m',
+      9 => '9',
+      98 => '98',
+      987 => '987',
+      9876 => '9.88k',
+      98_765 => '98.8k',
+      987_654 => '988k',
+      9_876_543 => '9.88M',
+      98_765_432 => '98.8M',
+      987_654_321 => '988M',
+      9_876_543_210 => '9.88G',
+      98_765_432_100 => '98.8G',
+      987_654_321_000 => '988G',
+      9_876_543_210_000 => '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
+    assert_equal '9.8765T', 9_876_543_210_000.si(length: 5)
+    assert_equal '12.3GB', 13_255_342_817.si_byte
   end
 
   def test_edge_cases
-    assert_equal '9.0000T', 9000000000001.si(:length => 5)
+    assert_equal '9.0000 T', 9_000_000_000_001.si(length: 5, space: ' ')
   end
 
   def test_shortcut
-    assert_equal '123.5M', 123450000.si(4)
+    assert_equal '123.5M', 123_450_000.si(4)
   end
 
   def test_module_methods
-    assert_equal '9.8765T',          SI.convert(9876543210000, :length => 5)
-    assert_equal 9876500000000,      SI.revert('9.8765T')
-    assert_equal 9876500000,         SI.revert('9.8765G')
-    assert_equal 9876500,            SI.revert('9.8765M')
-    assert_equal 9.8765 * 1024 ** 2, SI.revert('9.8765M', :base => 1024)
+    assert_equal '9.8765T', SI.convert(9_876_543_210_000, length: 5)
+    assert_equal 9_876_500_000_000, SI.revert('9.8765T')
+    assert_equal 9_876_500_000, SI.revert('9.8765G')
+    assert_equal 9_876_500, SI.revert('9.8765M')
+    assert_equal 9.8765 * 1024**2, SI.revert('9.8765M', base: 1024)
     assert_equal 0.0000098765,       SI.revert('9.8765μ')
     assert_equal 0.0098765,          SI.revert('9.8765m')
     assert_equal 9.8765,             SI.revert('9.8765')
@@ -195,7 +230,7 @@ class TestSI < Test::Unit::TestCase
   end
 
   def test_rational
-    assert_equal '12.345n', (12345 * (10 ** -12)).si(5)
+    assert_equal '12.345n', (12_345 * (10**-12)).si(5)
   end
 
   def test_zero
@@ -212,4 +247,3 @@ class TestSI < Test::Unit::TestCase
     assert_raise(ArgumentError) { 123.si(1) }
   end
 end
-

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: si
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Junegunn Choi
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-26 00:00:00.000000000 Z
+date: 2025-06-27 00:00:00.000000000 Z
 dependencies: []
 description: Formats a number with SI prefix
 email:
@@ -20,7 +19,6 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -35,7 +33,6 @@ files:
 homepage: https://github.com/junegunn/si
 licenses: []
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,8 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Formats a number with SI prefix (metric prefix)
 test_files:

data/Gemfile.lock

@@ -1,23 +0,0 @@
-PATH
-  remote: .
-  specs:
-    si (0.1.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    power_assert (2.0.3)
-    rake (13.0.6)
-    test-unit (3.6.1)
-      power_assert
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake (~> 13.0, >= 13.0.6)
-  si!
-  test-unit (~> 3.6, >= 3.6.1)
-
-BUNDLED WITH
-   2.4.10