base_convert 4.0.200111 → 5.0.210126

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c43a6429ac3a041f6f01f535b4159087a89e1373c95069617bd134b4f0e5e03
-  data.tar.gz: 7cbd6306d8ece168d0b5548f1b1e208911be94040d405753c4fb83e1c08af83a
+  metadata.gz: a70b9639fe64e9243968dfd0b74efe7656c529bccde17ceb2fead9c3165e1c68
+  data.tar.gz: 4b4e8bf5f5560b2c2c638db7f925f9cd69a5637311225c5a272e63bc6dd66a53
 SHA512:
-  metadata.gz: 1b1ce6da4bdeb6d589b2b486519b91894eef24502968dc2fa1034e3007704d8791031f89af1e42d92116067c52f50d0b5c2a73ae21ff743975b1b6718d388042
-  data.tar.gz: 11cd53a28e2c169186f2c911345c751990ff48843133add22153bb35ff857208b09252f6c117df737601817b4b41d1870ab32eec6678f2e846ee41887cf30d3c
+  metadata.gz: '00827b732310b9117da09b021619895b93b476e1b4818ce9d8a6acfe0b65647d83b3bd6512e4e2c6a22f75299bde139d4448aa3c467ce2e60b390c37124fbdb9'
+  data.tar.gz: 14de39dc7f6fb4df71ab111b2ea8266383ed69e7787d87881047ed93eb0ba0f9a930721cfa13b8b0e40b3c47091ec4d0f67779f30df58699c7739ad4eb6f7e9c

data/README.md

@@ -1,9 +1,15 @@
 # BaseConvert
 
-* [VERSION 4.0.200111](https://github.com/carlosjhr64/base_convert/releases)
+* [VERSION 5.0.210126](https://github.com/carlosjhr64/base_convert/releases)
 * [github](https://www.github.com/carlosjhr64/base_convert)
 * [rubygems](https://rubygems.org/gems/base_convert)
 
+## INSTALL:
+
+```shell
+$ gem install base_convert
+```
+
 ## DESCRIPTION:
 
 BaseConvert - Number base conversion.
@@ -17,33 +23,31 @@ See also rosettacode.org's [Non-decimal radices convert](http://rosettacode.org/
 
 ## SYNOPSIS:
 
-    require 'base_convert'
+```ruby
+require 'base_convert'
 
-    #toi string, base, digits #=> integer
-    BaseConvert.toi 'FF', 16, '0123456789ABCDEF' #=> 255
+#toi string, base, digits => integer
+BaseConvert.toi 'FF', 16, '0123456789ABCDEF' #=> 255
 
-    #tos integer, base, digits #=> string
-    BaseConvert.tos 255, 16, '0123456789ABCDEF' #=> "FF"
+#tos integer, base, digits => string
+BaseConvert.tos 255, 16, '0123456789ABCDEF' #=> "FF"
 
-    # FromTo
-    c = BaseConvert::FromTo.new base: 16, digits: '0123456789ABCDEF', to_base: 7, to_digits: 'abcdefg'
-    c['FFF'] #=> "begea"
-    c.inspect   #=> "16:P95,7:abfg"
-
-    # Number
-    n = BaseConvert::Number.new 'FF', base: 16, digits: '0123456789ABCDEF'
-    n.to_i #=> 255
-    n.to_s #=> "FF"
-    n.inspect #=> FF 16:P95
-    #
-    n = n.to_base 64, "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
-    n.to_s #=> "D/"
-    n.to_i #=> 255
-    n.inspect #=> D/ 64:B64
-
-## INSTALL:
+# FromTo
+c = BaseConvert::FromTo.new base: 16, digits: '0123456789ABCDEF', to_base: 7, to_digits: 'abcdefg'
+c['FFF'] #=> "begea"
+c.inspect   #=> "16:P95,7:abfg"
 
-    $ gem install base_convert
+# Number
+n = BaseConvert::Number.new 'FF', base: 16, digits: '0123456789ABCDEF'
+n.to_i #=> 255
+n.to_s #=> "FF"
+n.inspect #=> FF 16:P95
+#
+n = n.to_base 64, "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
+n.to_s #=> "D/"
+n.to_i #=> 255
+n.inspect #=> D/ 64:B64
+```
 
 ## BUT WAIT, THERE'S MORE:
 
@@ -55,24 +59,26 @@ See also rosettacode.org's [Non-decimal radices convert](http://rosettacode.org/
 
 Exemplar:
 
-    class MyClass
-      include BaseConvert
-      attr_accessor :to_s, :to_i, :base, :digits
-    end
+```ruby
+class MyClass
+  include BaseConvert
+  attr_accessor :to_s, :to_i, :base, :digits
+end
 
-    obj = MyClass.new
-    obj.digits = '!@#$%^&*()'
-    obj.base = 10
+obj = MyClass.new
+obj.digits = '!@#$%^&*()'
+obj.base = 10
 
-    obj.to_s = '@'
-    obj.toi #=> 1
+obj.to_s = '@'
+obj.toi #=> 1
 
-    obj.to_i = 3
-    obj.tos #=> "$"
+obj.to_i = 3
+obj.tos #=> "$"
 
-    obj.ascii_ordered? #=> false
-    obj.digits = 'ABCDEFGHIJKLMNOP'
-    obj.ascii_ordered? #=> true
+obj.ascii_ordered? #=> false
+obj.digits = 'ABCDEFGHIJKLMNOP'
+obj.ascii_ordered? #=> true
+```
 
 ### Hash DIGITS
 
@@ -87,23 +93,25 @@ Exemplar:
 
 Exemplar:
 
-    include BaseConvert
-    DIGITS.get(:P95) #=> :alnum_bangs_typers_operators_separators_scapes_groupers_quoters_spacers
-    DIGITS[:P95]
-    #=> "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!?$&@*+-/<=>^~,.:;|#\\()[]{}%\"'`_ "
-    DIGITS.registry #=> [:P95, :B64, :U47, :G94, :Q91, :W63]
-    DIGITS.registry('347') #=> :U47
-    DIGITS.registry('0') #=> :P95
-    DIGITS.registry('AB') #=> :B64
-    DIGITS.registry('Cukoe') #=> nil
-    DIGITS.label('Cukoe') #=> :Cuoe
-    DIGITS.label('AaBbCcXxYyZz') #=> :AaZz
-    DIGITS[:N] #=> "0123456789"
-    DIGITS.get(:N) #=> nil
-    DIGITS.memoize!(:N)
-    DIGITS.get(:N) #=> "0123456789"
-    DIGITS.forget!(:N)
-    DIGITS.get(:N) #=> nil
+```ruby
+include BaseConvert
+DIGITS.get(:P95) #=> :alnum_bangs_typers_operators_separators_scapes_groupers_quoters_spacers
+DIGITS[:P95]
+#=> "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!?$&@*+-/<=>^~,.:;|#\\()[]{}%\"'`_ "
+DIGITS.registry #=> [:P95, :B64, :U47, :G94, :Q91, :W63]
+DIGITS.registry('347') #=> :U47
+DIGITS.registry('0') #=> :P95
+DIGITS.registry('AB') #=> :B64
+DIGITS.registry('Cukoe') #=> nil
+DIGITS.label('Cukoe') #=> :Cuoe
+DIGITS.label('AaBbCcXxYyZz') #=> :AaZz
+DIGITS[:N] #=> "0123456789"
+DIGITS.get(:N) #=> nil
+DIGITS.memoize!(:N)
+DIGITS.get(:N) #=> "0123456789"
+DIGITS.forget!(:N)
+DIGITS.get(:N) #=> nil
+```
 
 
 #### DIGITS constructions
@@ -112,71 +120,73 @@ Exemplar:
 See [Ruby-Doc's Regexp](https://ruby-doc.org/core-2.7.0/Regexp.html) documentation
 for a full list of keys.  The following provides an exemplar survey:
 
-    # Character Classes
-    # Selected from ASCII 32..126
-    DIGITS[:w] #=> "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz"
-    DIGITS[:d] #=> "0123456789"
-    # Note: :h was overridden, see :xdigit.
-    DIGITS[:h] #=> "0123456789ABCDEF"
-    DIGITS[:alpha] #=> "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
-    DIGITS[:graph]
-    #=> "!\"\#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
-    DIGITS[:lower] #=> "abcdefghijklmnopqrstuvwxyz"
-    DIGITS[:punct] #=> "!\"\#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
-    DIGITS[:upper] #=> "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
-    DIGITS[:xdigit] #=> "0123456789ABCDEFabcdef"
-
-    # Character Properties
-    # Selected from ASCII 32..126
-    DIGITS[:Alnum] #=> "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
-    DIGITS[:Any]
-    #=> " !\"\#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
-
-    # General Category
-    # Selected from ASCII 32..126
-    DIGITS[:Ps] #=> "([{"
-    DIGITS[:Pe] #=> ")]}"
-    DIGITS[:S] #=> "$+<=>^`|~"
-
-    # Ranged Selections
-    # v<hex>w<hex>_<filter>
-    DIGITS[:v1d7d8w1d7e1_Any] #=> "𝟘𝟙𝟚𝟛𝟜𝟝𝟞𝟟𝟠𝟡"
-    # i<dec>j<dec>_<filter>
-    DIGITS[:i120488j120513_Any] #=> "𝚨𝚩𝚪𝚫𝚬𝚭𝚮𝚯𝚰𝚱𝚲𝚳𝚴𝚵𝚶𝚷𝚸𝚹𝚺𝚻𝚼𝚽𝚾𝚿𝛀𝛁"
-
-    # Specified Characters
-    # u<hex>
-    DIGITS[:u61u62] #=> "ab"
-    # k<dec>
-    DIGITS[:k97k98] #=> "ab"
-
-    # BaseConvert's Custom Sets
-    DIGITS[:bangs] #=> "!?"
-    DIGITS[:typers] #=> "$&@"
-    DIGITS[:operators] #=> "*+-/<=>^~"
-    DIGITS[:separators] #=> ",.:;|"
-    DIGITS[:scapes] #=> "#\\"
-    DIGITS[:groupers] #=> "()[]{}"
-    DIGITS[:quotes] #=> "\"'`"
-    DIGITS[:quoters] #=> "%\"'`"
-    DIGITS[:spacers] #=> "_ "
-    DIGITS[:ambiguous] #=> "012568BDGIOQSZl"
-
-    # Composition, add merge:
-    DIGITS[:d_ambiguous] #=> "0123456789BDGIOQSZl"
-    # Composition, add top:
-    DIGITS[:'d+ambiguous'] #=> "3479012568BDGIOQSZl"
-    # Composition, subtract:
-    DIGITS[:'d-ambiguous'] #=> "3479"
-
-    # Compositions used in BaseConvert
-    # :P95 is:
-    DIGITS[:alnum_bangs_typers_operators_separators_scapes_groupers_quoters_spacers]
-    #=> "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!?$&@*+-/<=>^~,.:;|#\\()[]{}%\"'`_ "
-    # :B64 is:
-    DIGITS[:LN_k43k47] #=> "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
-    # :U47 is:
-    DIGITS[:'alnum-ambiguous'] #=> "3479ACEFHJKLMNPRTUVWXYabcdefghijkmnopqrstuvwxyz"
+```ruby
+# Character Classes
+# Selected from ASCII 32..126
+DIGITS[:w] #=> "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz"
+DIGITS[:d] #=> "0123456789"
+# Note: :h was overridden, see :xdigit.
+DIGITS[:h] #=> "0123456789ABCDEF"
+DIGITS[:alpha] #=> "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+DIGITS[:graph]
+#=> "!\"\#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
+DIGITS[:lower] #=> "abcdefghijklmnopqrstuvwxyz"
+DIGITS[:punct] #=> "!\"\#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
+DIGITS[:upper] #=> "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+DIGITS[:xdigit] #=> "0123456789ABCDEFabcdef"
+
+# Character Properties
+# Selected from ASCII 32..126
+DIGITS[:Alnum] #=> "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+DIGITS[:Any]
+#=> " !\"\#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
+
+# General Category
+# Selected from ASCII 32..126
+DIGITS[:Ps] #=> "([{"
+DIGITS[:Pe] #=> ")]}"
+DIGITS[:S] #=> "$+<=>^`|~"
+
+# Ranged Selections
+# v<hex>w<hex>_<filter>
+DIGITS[:v1d7d8w1d7e1_Any] #=> "𝟘𝟙𝟚𝟛𝟜𝟝𝟞𝟟𝟠𝟡"
+# i<dec>j<dec>_<filter>
+DIGITS[:i120488j120513_Any] #=> "𝚨𝚩𝚪𝚫𝚬𝚭𝚮𝚯𝚰𝚱𝚲𝚳𝚴𝚵𝚶𝚷𝚸𝚹𝚺𝚻𝚼𝚽𝚾𝚿𝛀𝛁"
+
+# Specified Characters
+# u<hex>
+DIGITS[:u61u62] #=> "ab"
+# k<dec>
+DIGITS[:k97k98] #=> "ab"
+
+# BaseConvert's Custom Sets
+DIGITS[:bangs] #=> "!?"
+DIGITS[:typers] #=> "$&@"
+DIGITS[:operators] #=> "*+-/<=>^~"
+DIGITS[:separators] #=> ",.:;|"
+DIGITS[:scapes] #=> "#\\"
+DIGITS[:groupers] #=> "()[]{}"
+DIGITS[:quotes] #=> "\"'`"
+DIGITS[:quoters] #=> "%\"'`"
+DIGITS[:spacers] #=> "_ "
+DIGITS[:ambiguous] #=> "012568BDGIOQSZl"
+
+# Composition, add merge:
+DIGITS[:d_ambiguous] #=> "0123456789BDGIOQSZl"
+# Composition, add top:
+DIGITS[:'d+ambiguous'] #=> "3479012568BDGIOQSZl"
+# Composition, subtract:
+DIGITS[:'d-ambiguous'] #=> "3479"
+
+# Compositions used in BaseConvert
+# :P95 is:
+DIGITS[:alnum_bangs_typers_operators_separators_scapes_groupers_quoters_spacers]
+#=> "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!?$&@*+-/<=>^~,.:;|#\\()[]{}%\"'`_ "
+# :B64 is:
+DIGITS[:LN_k43k47] #=> "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
+# :U47 is:
+DIGITS[:'alnum-ambiguous'] #=> "3479ACEFHJKLMNPRTUVWXYabcdefghijkmnopqrstuvwxyz"
+```
 
 ### class FromTo
 
@@ -186,12 +196,14 @@ for a full list of keys.  The following provides an exemplar survey:
 
 Example:
 
-    h2b = BaseConvert::FromTo.new(base: 16, digits: :P95, to_base: 64, to_digits: :B64)
-    h2b #=> 16:P95,64:B64
-    h2b['FFF'] #=> "//"
-    b2h = BaseConvert::FromTo.new(base: 64, digits: :B64, to_base: 16, to_digits: :P95)
-    b2h #=> 64:B64,16:P95
-    b2h['//'] #=> "FFF"
+```ruby
+h2b = BaseConvert::FromTo.new(base: 16, digits: :P95, to_base: 64, to_digits: :B64)
+h2b #=> 16:P95,64:B64
+h2b['FFF'] #=> "//"
+b2h = BaseConvert::FromTo.new(base: 64, digits: :B64, to_base: 16, to_digits: :P95)
+b2h #=> 64:B64,16:P95
+b2h['//'] #=> "FFF"
+```
 
 ### class Number
 
@@ -206,21 +218,23 @@ Example:
 
 Example:
 
-    a = BaseConvert::Number.new('FFF', base: 16, digits: :P95)
-    a #=> FFF 16:P95
-    a.to_i #=> 4095
-    b = a.to_digits(:U47)
-    b #=> RRR 16:U47
-    b.to_i #=> 4095
-    c = b.to_base(64, :B64)
-    c #=> // 64:B64
-    c.to_i #=> 4095
+```ruby
+a = BaseConvert::Number.new('FFF', base: 16, digits: :P95)
+a #=> FFF 16:P95
+a.to_i #=> 4095
+b = a.to_digits(:U47)
+b #=> RRR 16:U47
+b.to_i #=> 4095
+c = b.to_base(64, :B64)
+c #=> // 64:B64
+c.to_i #=> 4095
+```
 
 ## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2020 CarlosJHR64
+Copyright (c) 2021 CarlosJHR64
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/base_convert.rb

@@ -1,5 +1,5 @@
 module BaseConvert
-  VERSION = '4.0.200111'
+  VERSION = '5.0.210126'
   require 'base_convert/base_convert'
   require 'base_convert/chars'
   require 'base_convert/digits'

data/lib/base_convert/base_convert.rb

@@ -16,7 +16,7 @@ module BaseConvert
     string = ''
     while integer > 0
       integer, index = integer.divmod(base)
-      string = string.insert(0, digits[index])
+      string = string.prepend digits[index]
     end
     string
   end

data/lib/base_convert/digits.rb

@@ -55,14 +55,14 @@ class Digits < Hash
       return digits
     when Integer
       raise 'need digits to cover base' if key > 95
-      return self[:P95] # Defined below
+      return self[:P95] # Defined in configuration.rb
     end
     raise 'digits must be String|Symbol|Integer'
   end
 
   def registry(d=nil)
     # BaseConvert::Number memoizes and uses specifically :P95, :B64, and :U47;
-    # giving these precedence above the rest.
+    # giving these precedence above the rest.  Defined in configuration.rb.
     @registry ||= [:P95, :B64, :U47, :G94, :Q91, :W63]
     d ? @registry.detect{|_|self[_].start_with? d}: @registry
   end

data/lib/base_convert/number.rb

@@ -56,7 +56,7 @@ class Number
 
     # validate
     if @validate
-      raise 'digits must cover base' if @base > @digits.length
+      raise 'digits must cover base'  if @base > @digits.length
       unless string.nil? or string.empty?
         indeces = string.chars.map{|_|@digits.index(_)}
         if missing = indeces.any?{|_|_.nil?} or exceeding = indeces.any?{|_|_>=@base}
@@ -66,15 +66,15 @@ class Number
             missing = indeces.any?{|_|_.nil?} or exceeding = indeces.any?{|_|_>=@base}
           end
           raise 'digits must cover string' if missing
-          raise 'digits in string must be under base' if exceeding
+          raise 'digits in string must be under base'  if exceeding
         end
       end
       unless @integer.nil?
-        raise 'integer can not be negative' if @integer < 0
+        raise 'integer can not be negative'  if @integer < 0
       end
     end
 
-    @integer = toi(string) if @integer.nil?
+    @integer = toi(string)  if @integer.nil?
   end
 
   def inspect

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base_convert
 version: !ruby/object:Gem::Version
-  version: 4.0.200111
+  version: 5.0.210126
 platform: ruby
 authors:
 - carlosjhr64
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies: []
 description: |
   BaseConvert - Number base conversion.
@@ -35,7 +35,7 @@ homepage: https://github.com/carlosjhr64/base_convert
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,9 +50,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 2.7.0p0 (2019-12-25 revision 647ee6f091) [x86_64-linux]'
-rubygems_version: 3.1.2
-signing_key: 
+- 'ruby: ruby 3.0.0p0 (2020-12-25 revision 95aff21468) [x86_64-linux]'
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: BaseConvert - Number base conversion.
 test_files: []