base_convert 3.0.191224 → 3.1.191231

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20e33ba2c83ac2c66ed25c9047af914ce03450c41b104e5ea46e36dfa16bb155
-  data.tar.gz: a4303de9c930084f602a58330119e721d28a713d90f5b86fce75f9d33da8b1b4
+  metadata.gz: '09e96875804850531f1e4e890eeac10d8a53275be55d875f3ea262a03624218d'
+  data.tar.gz: c374bb673c441bb11c314accdcd1b2afef057cf1e23252225cbf08347c83c9ef
 SHA512:
-  metadata.gz: e960d364647497d8a4e3c24198097570ea05de2d669a39cf48abdf4c634297d40c49d42b190eb5615c33835daeeeffdc6fbc45aea54d18dafa96a8eee8372d05
-  data.tar.gz: ff6bb256ba739c191aca4fd969a04fb85aad4a4a193a2120f5256383e911718140963b4dfa227ab7742830400f6f4fcea98fc26e6ce208704f7f2573d7cb9333
+  metadata.gz: 05ddba6c9079bf3c8a737b8e176e52f560beb6d19ed8aadda1230bd2f09691c112ffbf52cf5b329853f5dd96ab31ade73553938fb83eb7c29783337105bbd31b
+  data.tar.gz: 2b246aeea822d1aa57b281bc6bc93eb118751c86f938dea9c2eb719741efb53c0ca4e5dc7c26f2d38eb81ee535adc9a8d8cc7226c40de931dd087561f5fa741f

data/README.md

@@ -69,21 +69,42 @@ You can work with arbitrary digits:
     toi('&&&&', base, digits) #=> 4095
     tob(4095, base, digits) #=> "&&&&"
 
-For convenience, `base_convert` provides under `module BaseConvert::Configuration` some predefined sets of digits.
+Note that one can always explicitly specify the ordered digits to be used.
+But for convenience, `base_convert` provides some predefined sets of digits:
 
-* `GRAPH` are the ASCII graph characters.
-* `QGRAPH` are the ASCII graph characters except quotes: double-quote, single-quote, and back-tick.
-* `BASE64` is the standard base 64 digits from people with no sense of order.
-* `WORD_` are the ASCII word characters including underscore(`_`).
-* `WORD` are the ASCII word characters except underscore(`_`).
-* `UNAMBIGUOUS` are the characters in `WORD` without the `AMBIGUOUS` characters(B8G6I1l0OQDS5Z2).
+* `GRAPH :graph :g`,  the ASCII graph characters:
+
+    !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
+
+* `QGRAPH :qgraph :q`,  the ASCII graph characters except `QUOTES`:
+
+    !#$%&()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_abcdefghijklmnopqrstuvwxyz{|}~
+
+* `BASE64 :base64 :b64`, the standard base 64 digits from people with no sense of order:
+
+    ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/
+
+* `WORD_ :word_ :w_`, the ASCII word characters including `UNDERSCORE`:
+
+    0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz
+
+* `WORD :word :w`, the ASCII word characters except `UNDERSCORE`:
+
+    0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz
+
+* `UNAMBIGUOUS :unambigous :u`, the characters in `WORD` without the `AMBIGUOUS` characters(B8G6I1l0OQDS5Z2):
+
+    3479ACEFHJKLMNPRTUVWXYabcdefghijkmnopqrstuvwxyz
+
+* `G94 :g94` is the library's default defined as `WORD+QGRAPH.delete(WORD_)+QUOTES+UNDERSCORE`
+
+    0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!#$%&()*+,-./:;<=>?@[\]^{|}~"'`_
 
 Some examples:
 
-    Configuration::UNAMBIGUOUS #=> "3479ACEFHJKLMNPRTUVWXYabcdefghijkmnopqrstuvwxyz"
+    UNAMBIGUOUS #=> "3479ACEFHJKLMNPRTUVWXYabcdefghijkmnopqrstuvwxyz"
     # etc...
-    tob 255, 16, Configuration::WORD #=> "FF"
-    include Configuration
+    tob 255, 16, WORD #=> "FF"
     tob 255, 64, BASE64 #=> "D/"
 
 The second way to convert is via a conversion object of `BaseConvert::FromTo`.
@@ -101,11 +122,7 @@ The third way to work with variant base and digits numbers is via the `BaseConve
     hexadecimal.to_i #=> 65535
 
     # Number will infer your most likely meaning:
-    Number.new('FF', 16).to_i #=> 255
-
-    # And given a string of at least length 8,
-    # it'll go ahead and guess at your meaning:
-    Number.new('FFFFFFFF').to_i #=> 4294967295
+    Number.new('FF').to_i #=> 255
 
     # But best practice is to fully specify,
     # which is easy to do with keys:
@@ -135,6 +152,7 @@ one can use a mnemonic key:
 
 | long key       | short key | DIGITS        | BASE NUMBER |
 | -------------- | --------- | ------------- | ----------- |
+| `:g94`         |           | `G94`         | 94          |
 | `:graph`       | `:g`      | `GRAPH`       | 94          |
 | `:qgraph`      | `:q`      | `QGRAPH`      | 91          |
 | `:base64`      | `:b64`    | `BASE64`      | 64          |
@@ -149,6 +167,13 @@ one can use a mnemonic key:
 | `:octal`       | `:oct, :o` |  8          |
 | `:binary`      | `:bin, :b` |  2          |
 
+Example:
+
+    # For some pseudo-random string of unambigous characters
+    # of very likely length 16:
+    p = BaseConvert::Number.new(rand(47**16), digits: :u)
+    p.to_s   #=> "CxesjJqHcvpnp7bp"
+
 ## LICENSE:
 
 (The MIT License)

data/lib/base_convert.rb

@@ -1,30 +1,8 @@
-# http://rosettacode.org/wiki/Non-decimal_radices/Convert#Ruby
 module BaseConvert
-  VERSION = '3.0.191224'
-
-  def toi(string=@string, base=@base, digits=@digits)
-    integer = 0
-    string.each_char do |c|
-      index = digits.index(c)
-      integer = integer * base + index
-    end
-    integer
-  end
-
-  def tob(integer=@integer, base=@base, digits=@digits)
-    return digits[0] if integer == 0
-    string = ''
-    while integer > 0
-      integer, index = integer.divmod(base)
-      string = string.insert(0, digits[index])
-    end
-    string
-  end
-
-  extend self
-
-  autoload :Configuration, 'base_convert/configuration'
-  autoload :FromTo,        'base_convert/from_to'
-  autoload :Number,        'base_convert/number'
+  VERSION = '3.1.191231'
+  require 'base_convert/base_convert'
+  require 'base_convert/configuration'
+  require 'base_convert/from_to'
+  require 'base_convert/number'
 end
 #`ruby`

data/lib/base_convert/base_convert.rb

@@ -0,0 +1,23 @@
+# http://rosettacode.org/wiki/Non-decimal_radices/Convert#Ruby
+module BaseConvert
+  def toi(string=@string, base=@base, digits=@digits)
+    integer = 0
+    string.each_char do |c|
+      index = digits.index(c)
+      integer = integer * base + index
+    end
+    integer
+  end
+
+  def tob(integer=@integer, base=@base, digits=@digits)
+    return digits[0] if integer == 0
+    string = ''
+    while integer > 0
+      integer, index = integer.divmod(base)
+      string = string.insert(0, digits[index])
+    end
+    string
+  end
+
+  extend self
+end

data/lib/base_convert/configuration.rb

@@ -1,24 +1,26 @@
 module BaseConvert
-module Configuration
-
-  GRAPH  = 0.upto(255).map{|i| i.chr}.select{|c| c=~/[[:graph:]]/}.join.freeze
-  QGRAPH = GRAPH.delete(%('"`)).freeze
-
-  WORD_  = 0.upto(255).map{|i| i.chr}.select{|c| c=~/\w/}.join.freeze
-  WORD   = WORD_.delete('_').freeze
-  INDEXa = WORD.index('a')
-
+  QUOTES      = %("'`).freeze
+  UNDERSCORE  = '_'.freeze
   AMBIGUOUS   = 'B8G6I1l0OQDS5Z2'.freeze
+
+  GRAPH       = 0.upto(255).map{|i| i.chr}.select{|c| c=~/[[:graph:]]/}.join.freeze
+  QGRAPH      = GRAPH.delete(QUOTES).freeze
+  WORD_       = QGRAPH.chars.select{|c| c=~/\w/}.join.freeze
+  WORD        = WORD_.delete(UNDERSCORE).freeze
   UNAMBIGUOUS = WORD.delete(AMBIGUOUS).freeze
+  G94         = (WORD + QGRAPH.delete(WORD_) + QUOTES + UNDERSCORE).freeze
 
-  BASE64 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'
+  BASE64      = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'.freeze
+
+  INDEXa = G94.index('a')
 
   BASE = {
-    :graph       => GRAPH.length,
-    :qgraph      => QGRAPH.length,
-    :word_       => WORD_.length,
-    :word        => WORD.length,
-    :unambiguous => UNAMBIGUOUS.length,
+    :g94         => G94.length,          # 94
+    :graph       => GRAPH.length,        # 94
+    :qgraph      => QGRAPH.length,       # 91
+    :word_       => WORD_.length,        # 63
+    :word        => WORD.length,         # 62
+    :unambiguous => UNAMBIGUOUS.length,  # 47
     :base64      => 64,
     :b64         => 64,
     :hexadecimal => 16,
@@ -35,13 +37,14 @@ module Configuration
     :b           => 2,
   }
 
-  BASE[:g]   = BASE[:graph]
-  BASE[:q]   = BASE[:qgraph]
-  BASE[:w_]  = BASE[:word_]
-  BASE[:w]   = BASE[:word]
-  BASE[:u]   = BASE[:unambiguous]
+  BASE[:g]  = BASE[:graph]
+  BASE[:q]  = BASE[:qgraph]
+  BASE[:w_] = BASE[:word_]
+  BASE[:w]  = BASE[:word]
+  BASE[:u]  = BASE[:unambiguous]
 
   DIGITS = {
+    :g94         => G94,
     :graph       => GRAPH,
     :g           => GRAPH,
     :qgraph      => QGRAPH,
@@ -55,6 +58,4 @@ module Configuration
     :base64      => BASE64,
     :b64         => BASE64,
   }
-
-end
 end

data/lib/base_convert/from_to.rb

@@ -1,9 +1,8 @@
 module BaseConvert
 class FromTo
-  include Configuration
   include BaseConvert
 
-  def initialize(base: 10, to_base: base, digits: WORD, to_digits: digits)
+  def initialize(base: 10, to_base: base, digits: G94, to_digits: digits)
     base      = BASE[base]         if base.is_a?      Symbol
     to_base   = BASE[to_base]      if to_base.is_a?   Symbol
     digits    = DIGITS[digits]     if digits.is_a?    Symbol

data/lib/base_convert/number.rb

@@ -1,129 +1,86 @@
 module BaseConvert
 class Number
-  include Configuration
   include BaseConvert
 
-  def _infer_digits_from_string
-    if @string.chars.all?{|_|WORD_.include?_}
-      @string.include?('_')? WORD_ : WORD
-    elsif @string.chars.all?{|_|GRAPH.include?_}
-      @string.match?(/['"`]/)? GRAPH : QGRAPH
-    else
-      raise "Need digits."
+  def self.infer(string)
+    return 2, G94 if string.empty?
+    chars = string.chars
+    raise 'Need digits.' unless chars.all?{|_|G94.include?_}
+    max = chars.map{|_|G94.index(_)}.max
+    return 2,  G94  if max < 2
+    return 4,  G94  if max < 4
+    return 8,  G94  if max < 8
+    return 10, G94  if max < 10
+    return 16, G94  if max < 16
+    return 32, G94  if max < 32
+    [UNAMBIGUOUS, BASE64].each do |digits|
+      return digits.length, digits  if chars.all?{|_|digits.include?_}
     end
+    return 64, G94  if max < 64
+    return G94.length, G94  if max < 64
   end
 
-  def _infer_base_from_string
-    min = 1 + @digits.index(@string.chars.max)
-    max = @digits.length
-    return max if max==min
-    case @digits
-    when WORD, WORD_
-      if min <= 32
-        raise "Need base for WORD or WORD_." if @string.length < 8
-        return  8 if min <= 8
-        return 16 if min <= 16
-        return 32
-      end
-    when UNAMBIGUOUS
-      if min <= 22
-        raise "Need base for UNAMBIGUOUS." if @string.length < 8
-        return 22
-      end
-    when QGRAPH, GRAPH
-      n = @digits.index 'a'
-      if min <= n
-        raise "Need base for QGRAPH or GRAPH." if @string.length < 8
-        return n
-      end
-    end
-    return max
-  end
-
-  def _digits!
-    if @digits.nil?
-      @digits = @integer.nil? ? _infer_digits_from_string : WORD
-      if @base and @base > @digits.length
-        if @base == 64
-          @digits = BASE64
-        elsif @base <= QGRAPH.length
-          @digits = QGRAPH
-        elsif @base <= GRAPH.length
-          @digits = GRAPH
-        else
-          raise "Need digits that can cover base #{@base}."
-        end
-      end
+  attr_reader :base, :digits
+  def initialize(counter=0, base: nil, digits: nil, validate: true)
+    # validate
+    case validate
+    when true, false
+      @validate = validate
     else
-      if @digits.is_a? Symbol
-        digits = DIGITS[@digits]
-        raise "Unrecognized digits #{@digits}." if digits.nil?
-        @digits = digits
-      else
-        raise "digits must be a String of at least length 2." unless @digits.is_a?(String) and @digits.length > 1
-      end
+      raise "validate must be either true of false."
     end
-  end
 
-  def _base!
-    if @base.nil?
-      _digits!
-      if @integer.nil?
-        @base = _infer_base_from_string
-      else
-        @base = @digits.length
-      end
+    # counter
+    case counter
+    when String
+      @string = counter
+      base, digits = Number.infer(counter)  if base.nil? and digits.nil?
+    when Integer
+      @integer = counter
+      base, digits = 10, G94  if base.nil? and digits.nil?
     else
-      if @base.is_a? Symbol
-        base = BASE[@base]
-        raise "Unrecognized base #{@base}." if base.nil?
-        @base = base
-      else
-        raise "base must be an Integer greater than 1." unless @base.is_a?(Integer) and @base > 1
-      end
-      _digits!
+      raise "Need counter String|Integer."
     end
-  end
 
-  def _validate
-    raise "digits must cover base." if @base > @digits.length
-    raise "digits must not have duplicates." if @digits.length > @digits.chars.uniq.length
-    unless @string.nil?
-      raise "digits must cover string." unless @string.chars.all?{|_|@digits.include?_}
-      raise "digits in string must be under base." unless @base > @digits.index(@string.chars.max)
+    # digits
+    if digits.is_a? Symbol
+      digits = DIGITS[digits]
+      raise "Unrecognized digits." if digits.nil?
     end
-    unless @integer.nil?
-      raise "integer can't be negative." if @integer < 0
+    digits = DIGITS[base] if digits.nil?
+    digits = G94 if digits.nil?
+    raise "digits must be a String of at least length 2." unless digits.is_a?(String) and digits.length > 1
+    @digits = digits
+
+    # base
+    if base.is_a? Symbol
+      base = BASE[base]
+      raise "Unrecognized base." if base.nil?
     end
-  end
+    base = @digits.length if base.nil?
+    raise "base must be an Integer greater than 1." unless base.is_a?(Integer) and base > 1
+    @base = base
 
-  def _integer!
-    _base!
-    @string.upcase! if @base <= INDEXa and @digits == WORD
-    _validate if @validate
-    @integer = toi
-  end
+    # validate
+    if @validate
+      raise "digits must cover base." if @base > @digits.length
+      raise "digits must not have duplicates." if @digits.length > @digits.chars.uniq.length
+      unless @string.nil? or @string.empty?
+        @string.upcase! if @base <= INDEXa and @digits.equal? G94
+        raise "digits must cover string." unless @string.chars.all?{|_|@digits.include?_}
+        raise "digits in string must be under base." unless @base > @string.chars.map{|_|@digits.index(_)}.max
+      end
+      unless @integer.nil?
+        raise "integer can't be negative." if @integer < 0
+      end
+    end
 
-  def _string!
-    _base!
-    _validate if @validate
-    @string = tob
+    @integer = toi if @integer.nil?
+    @string  = tob if @string.nil?
   end
 
-  attr_reader :base, :digits
-  def initialize(counter, base: nil, digits: nil, validate: true)
-    @base, @digits, @validate = base, digits, validate
-    @string, @integer = nil, nil
-    case counter
-    when String
-      @string = counter
-      _integer!
-    when Integer
-      @integer = counter
-      _string!
-    else
-      raise "Need counter String|Integer."
-    end
+  def validate?
+    @validate
   end
 
   def to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base_convert
 version: !ruby/object:Gem::Version
-  version: 3.0.191224
+  version: 3.1.191231
 platform: ruby
 authors:
 - carlosjhr64
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-24 00:00:00.000000000 Z
+date: 2019-12-31 00:00:00.000000000 Z
 dependencies: []
 description: |
   BaseConvert - Number base conversion.
@@ -24,6 +24,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/base_convert.rb
+- lib/base_convert/base_convert.rb
 - lib/base_convert/configuration.rb
 - lib/base_convert/from_to.rb
 - lib/base_convert/number.rb
@@ -46,8 +47,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 2.6.5p114 (2019-10-01 revision 67812) [x86_64-linux]'
-rubygems_version: 3.0.3
+- 'ruby: ruby 2.7.0p0 (2019-12-25 revision 647ee6f091) [x86_64-linux]'
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: BaseConvert - Number base conversion.