trick_bag 0.57.0 → 0.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 012936fb2a08c5a0cf646ecf9e8895f8cb122aab
-  data.tar.gz: 11402a3ba146571b4648829b922db87aca0b62bd
+  metadata.gz: 10d4086b2610d6e23ce59201321b731e05a74df3
+  data.tar.gz: f64bd3abeeb2ee2c948173d39fb2cb1e464d5111
 SHA512:
-  metadata.gz: 416fdc0e04db515bcec0a0462308165a49e4b5c8a6c250c8624ec2bcd00811da27fd784cabecb72830e1cd90d5492aad495f22ab4e54439544097511f9519735
-  data.tar.gz: ef625fb8bee7da8734ba483071f64c24d5b3c7abb3ca6a2a05c767b1d32f733e59ce7d5d3e07cc87a48d74843c5cdb8e6857b22bc2220f30c6ff4e7b8c80f11a
+  metadata.gz: f36e566103aee54e599824f739a23b02c2a9957cfd857d4cc2c91d5aa086d3371638d61628766439569c4562f09e9fa182a95b20128b3c1e23b8624ea54429d1
+  data.tar.gz: 43ba1d249627e9205dc853d9fbde3e0bed51b1931cc5a28819bb6da64dbafb48cda72ee063578969926265deff5ea7384a9014ab40e8984429dac56d8bcf3750

data/RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+## v0.58.0
+
+* Added KmbtNumericString, Formatters.thousands_separated.
+
+
 ## v0.57.0
 
 * Removed most class methods from Bitmap and put them in new BitMapping module.

data/lib/trick_bag/formatters/formatters.rb

@@ -133,6 +133,59 @@ module Formatters
     Diffy::Diff.new(string1, string2).to_s(format)
   end
 
+
+  # Outputs bytes verbosely one on a line for examination.
+  # The characters printed are 1 byte in length, so multibyte
+  # characters will not be output correctly.  Output will look like:
+  #
+  # Index     Decimal        Hex              Binary    Character
+  # -----     -------        ---              ------    ---------
+  #     0          97         61 x          110 0001 b       a
+  #     1          49         31 x           11 0001 b       1
+  #     2          46         2e x           10 1110 b       .
+  #
+  def string_to_verbose_char_list(a_string)
+
+    header = [
+        'Index     Decimal        Hex              Binary    Character',
+        '-----     -------        ---              ------    ---------',
+        ''  # 3rd string is just to force a 3rd \n when joined
+    ].join("\n")
+
+    sio = StringIO.new
+    sio << header
+
+    if a_string.empty?
+      sio << '(String is empty)'
+    else
+      format = '%5d         %3d       %+6s    %+16s       %c'
+      a_string.bytes.each_with_index do |byte, index|
+        hex_str = "#{byte.to_s(16)} x"
+
+        base2_str = "#{byte.to_s(2)} b"
+        if base2_str.size > 6
+          base2_str.insert(base2_str.size - 6, ' ')
+        end
+
+        sio << format % [index, byte, hex_str, base2_str,  byte.chr] << "\n"
+      end
+    end
+    sio.string
+  end
+
+
+  # Returns a string representation of the Integer corresponding to the
+  # input parameter, with a customizable thousands separator.
+  # Does not (yet) support fractional values or decimal places.
+  def thousands_separated(number, separator = ',')
+    number = Integer(number)
+    triplets = []
+    source_chars = number.to_s.reverse.chars
+    source_chars.each_slice(3) do |slice|
+      triplets << slice.join
+    end
+    triplets.join(separator).reverse
+  end
 end
 end
 

data/lib/trick_bag/numeric/bit_mapping.rb

@@ -56,14 +56,17 @@ module BitMapping
 
 
   # Converts a number to an array of bit values, e.g. 9 => [1, 0, 0, 1]
-  def number_to_bit_array(number)
+  def number_to_bit_array(number, minimum_binary_places = 0)
     assert_non_negative(number)
     array = []
     while number > 0
       array << (number & 1)
       number >>= 1
     end
-    array.reverse
+    array.reverse!
+    zero_pad_count = minimum_binary_places - array.size
+    zero_pad_count.times { array.unshift(0) }
+    array
   end
 
 
@@ -105,9 +108,9 @@ module BitMapping
 
 
   # Converts a binary string to an array of bit values, e.g. "\x0C" => [1, 1, 0, 0]
-  def binary_string_to_bit_array(string)
+  def binary_string_to_bit_array(string, minimum_binary_places = 0)
     number = binary_string_to_number(string)
-    number_to_bit_array(number)
+    number_to_bit_array(number, minimum_binary_places)
   end
 
 
@@ -119,6 +122,16 @@ module BitMapping
           "but is #{number.inspect} (a #{number.class})")
     end
   end
+
+  # Reverses a binary string.  Note that it is not enough to reverse
+  # the string itself because although the bytes would be reversed,
+  # the bits within each byte would not.
+  def reverse_binary_string_bits(binary_string)
+    binary_place_count = binary_string.size * 8
+    reversed_bit_array = binary_string_to_bit_array(binary_string, binary_place_count).reverse
+    number = bit_array_to_number(reversed_bit_array)
+    number_to_binary_string(number)
+  end
 end
 end
 end

data/lib/trick_bag/numeric/kmgt_numeric_string.rb

@@ -0,0 +1,101 @@
+module TrickBag
+module Numeric
+
+
+# Converts number strings with optional suffixes of [kKmMgGtT] to integers.
+# Upper case letters represent powers of 1024, and lower case letters represent powers of 1000
+# (see MULTIPLIERS below).
+#
+# Also supports ranges, e.g. '1k..5k' will be converted by to_range to (1000..5000).
+#
+# Methods are to_number, to_range, and to_number_or_range.  See tests for usage examples.
+module KmgtNumericString
+
+  MULTIPLIERS = {
+      'k' => 1_000,
+      'K' => 1_024,
+      'm' => 1_000 ** 2,
+      'M' => 1_024 ** 2,
+      'g' => 1_000 ** 3,
+      'G' => 1_024 ** 3,
+      't' => 1_000 ** 4,
+      'T' => 1_024 ** 4,
+  }
+
+  VALID_STRING_SUFFIXES = MULTIPLIERS.keys
+
+  VALID_STRING_REGEX = /^-?\d+/  # only digits with optional minus sign prefix
+
+  module_function
+
+  # Converts a numeric string (e.g. '3', '2k') to a number.
+  # If the passed parameter is not a string, it is returned unchanged.
+  # This eliminates the need for the caller to do their own type test.
+  def to_number(object)
+    object.is_a?(String) ? ToNumberConverter.new(object).to_number : object
+  end
+
+  # Returns whether or not this is a number range.  Specifically, tests that
+  # the string contains only 2 numeric strings separated by '..'.
+  def range_string?(string)
+    number_strings = string.split('..')
+    number_strings.size == 2 && number_strings.all? { |str| VALID_STRING_REGEX.match(str) }
+  end
+
+  # Converts the passed string to a range (see range_string? above for the string's format).
+  # If the passed parameter is a Range already, returns it unchanged.
+  # This eliminates the need for the caller to do their own type test.
+  def to_range(object)
+    return object if object.is_a?(Range)
+    unless range_string?(object)
+        raise ArgumentError.new("Invalid argument (#{object}); Range must be 2 numbers separated by '..', e.g. 10..20 or 900K..1M")
+    end
+    numbers = object.split('..').map { |s| to_number(s) }
+    (numbers.first..numbers.last)
+  end
+
+  # Converts a string such as '3' or '1k..2k' into a number or range.
+  # If an Integer or Range is passed, it is returned unchanged.
+  # This eliminates the need for the caller to do their own type test.
+  def to_number_or_range(object)
+    case object
+      when Integer, Range
+        object
+      when String
+        range_string?(object) ? to_range(object) : to_number(object)
+      else
+        raise ArgumentError.new("Invalid argument, class is #{object.class}, object is (#{object}).")
+      end
+  end
+
+
+# This class is here to simplify implementation and is not intended
+# to be instantiated by users of this module.
+  class ToNumberConverter
+
+    def initialize(string)
+      @string = string.dup.gsub('_', '')
+      assert_valid_input(@string)
+    end
+
+    def assert_valid_input(string)
+      unless VALID_STRING_REGEX.match(string)
+        raise ArgumentError.new(
+            "Bad arg (#{string}); must be an integer, optionally followed by one of [" +
+            MULTIPLIERS.keys.join + '], optionally with underscores.')
+      end
+    end
+
+    def to_number
+      last_char = @string[-1]
+      if VALID_STRING_SUFFIXES.include?(last_char)
+        multiplier = MULTIPLIERS[last_char]
+        Integer(@string.chop) * multiplier
+      else
+        Integer(@string)
+      end
+    end
+  end
+end
+end
+end

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = "0.57.0"
+  VERSION = "0.58.0"
 end

data/spec/trick_bag/formatters/formatters_spec.rb

@@ -133,6 +133,53 @@ describe Formatters do
         expect(actual_text).to eq(expected_text)
       end
     end
+
+
+    context 'string_to_verbose_char_list' do
+
+      let(:result) { Formatters.string_to_verbose_char_list("a1.").split("\n") }
+
+      specify 'first line should have header text' do
+        required_words = %w(Index  Decimal  Hex  Binary  Character)
+        expect(required_words.all? { |word| result[0].include?(word) }).to eq(true)
+      end
+
+      specify 'second line should have only lines' do
+        non_blank_or_hyphens = result[1].chars.reject { |char| [' ', '-'].include?(char) }
+        expect(non_blank_or_hyphens).to be_empty
+      end
+
+      specify 'third line should include some required text' do
+        #   0          97         61 x          110 0001 b       a
+        expect(result[2]).to match(/^\s*\d*\s* 97 \s* 61 x \s* 110 0001 b\s*a\s*$/)
+      end
+
+      specify 'empty string returns header with 3rd line saying (string is empty)' do
+        output = Formatters.string_to_verbose_char_list('')
+        expect(output).to include('(String is empty)')
+      end
+    end
+
+
+    context '.thousands_separated' do
+
+      specify 'no separators for <= 3 digit numbers' do
+        expect(Formatters.thousands_separated(123)).to eq('123')
+        expect(Formatters.thousands_separated(12)).to eq('12')
+        expect(Formatters.thousands_separated(1)).to eq('1')
+      end
+
+      specify 'separators are in the right places' do
+        expect(Formatters.thousands_separated(1_234)).to eq('1,234')
+        expect(Formatters.thousands_separated(12_345)).to eq('12,345')
+        expect(Formatters.thousands_separated(123_456)).to eq('123,456')
+        expect(Formatters.thousands_separated(1_234_567)).to eq('1,234,567')
+      end
+
+      specify 'custom separators work properly' do
+        expect(Formatters.thousands_separated(1_234_567, '.')).to eq('1.234.567')
+      end
+    end
   end
 
 end

data/spec/trick_bag/numeric/bit_mapping_spec.rb

@@ -95,6 +95,10 @@ context '.number_to_bit_array' do
   specify 'a negative number should result in an error' do
     expect { BitMapping.number_to_bit_array(-1) }.to raise_error(ArgumentError)
   end
+
+  specify 'a minimum bit array size is respected' do
+    expect(BitMapping.number_to_bit_array(0, 3)).to eq([0, 0, 0])
+  end
 end
 
 
@@ -138,5 +142,23 @@ context '.set_bit_position_array_to_number' do
     expect(BitMapping.set_bit_position_array_to_number([])).to eq(nil)
   end
 end
+
+
+context '.reverse_binary_string_bits' do
+  specify 'a single byte string should reverse correctly' do
+    hex_01 = "\x01".force_encoding(Encoding::ASCII_8BIT)
+    hex_80 = "\x80".force_encoding(Encoding::ASCII_8BIT)
+    expect(BitMapping.reverse_binary_string_bits("\x01").size).to eq(1)
+    expect(BitMapping.reverse_binary_string_bits(hex_01)).to eq(hex_80)
+  end
+
+  specify 'a multiple byte string should reverse correctly' do
+    hex_01 = "\x00\x01".force_encoding(Encoding::ASCII_8BIT)
+    hex_80 = "\x80\x00".force_encoding(Encoding::ASCII_8BIT)
+    expect(BitMapping.reverse_binary_string_bits("\x01").size).to eq(1)
+    expect(BitMapping.reverse_binary_string_bits(hex_01)).to eq(hex_80)
+  end
 end
 end
+end
+

data/spec/trick_bag/numeric/kmgt_numeric_string_spec.rb

@@ -0,0 +1,84 @@
+require_relative '../../spec_helper'
+
+require 'trick_bag/numeric/kmgt_numeric_string'
+
+module TrickBag
+module Numeric
+module KmgtNumericString
+
+end
+  describe KmgtNumericString do
+
+    include KmgtNumericString
+
+    context '.to_number' do
+
+      specify 'ArgumentError should be raised on invalid inputs' do
+        expect { to_number('') }.to raise_error(ArgumentError)
+        expect { to_number('_') }.to raise_error(ArgumentError)
+        expect { to_number('-') }.to raise_error(ArgumentError)
+        expect { to_number('a') }.to raise_error(ArgumentError)
+        expect { to_number('A') }.to raise_error(ArgumentError)
+        expect { to_number('1a') }.to raise_error(ArgumentError)
+        expect { to_number('1A') }.to raise_error(ArgumentError)
+        expect { to_number('1.2') }.to raise_error(ArgumentError)
+      end
+
+      specify 'suffixes work correctly' do
+        expect(to_number('10k')).to eq(10 * 1000)
+        expect(to_number('10K')).to eq(10 * 1024)
+        expect(to_number('10m')).to eq(10 * (1000 ** 2))
+        expect(to_number('10M')).to eq(10 * (1024 ** 2))
+        expect(to_number('10g')).to eq(10 * (1000 ** 3))
+        expect(to_number('10G')).to eq(10 * (1024 ** 3))
+        expect(to_number('10t')).to eq(10 * (1000 ** 4))
+        expect(to_number('10T')).to eq(10 * (1024 ** 4))
+      end
+
+      specify 'negative numbers work too' do
+        expect(to_number('-10k')).to eq(-10 * 1000)
+        expect(to_number('-10')).to eq(-10)
+      end
+    end
+
+
+    context '.is_range_string' do
+
+      specify 'invalid range strings should return false' do
+        expect(range_string?('')).to eq(false)
+        expect(range_string?('10')).to eq(false)
+        expect(range_string?('10K')).to eq(false)
+        expect(range_string?('..')).to eq(false)
+        expect(range_string?('2..')).to eq(false)
+        expect(range_string?('..3')).to eq(false)
+      end
+
+      specify 'valid range strings should return true' do
+        expect(range_string?('1..-1')).to eq(true)
+        expect(range_string?('-1..1')).to eq(true)
+        expect(range_string?('10K..10M')).to eq(true)
+      end
+    end
+
+
+    context '.to_range' do
+
+      specify 'descending ranges are supported' do
+        expect(to_range('9..3')).to eq((9..3))
+      end
+
+      specify 'ascending ranges are supported' do
+        expect(to_range('3k..4k')).to eq((3000..4000))
+      end
+    end
+
+    context '.to_number_or_range' do
+
+      specify 'correct determination of number vs. range' do
+        expect(to_number_or_range('12k')).to eq(12_000)
+        expect(to_number_or_range('12k..24k')).to eq(12_000..24_000)
+      end
+    end
+    end
+end
+end

data/trick_bag.gemspec

@@ -24,4 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", '~> 10.1'
   spec.add_development_dependency "rspec", '~> 3.0'
+
+  unless /java/ === RUBY_PLATFORM
+    spec.add_development_dependency 'pry', '~> 0.10'
+    spec.add_development_dependency 'pry-byebug', '~> 2.0' if RUBY_VERSION >= '2'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.57.0
+  version: 0.58.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-16 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Miscellaneous general useful tools for general purpose programming.
 email:
 - keithrbennett@gmail.com
@@ -112,6 +140,7 @@ files:
 - lib/trick_bag/meta/classes.rb
 - lib/trick_bag/numeric/bit_mapping.rb
 - lib/trick_bag/numeric/bitmap.rb
+- lib/trick_bag/numeric/kmgt_numeric_string.rb
 - lib/trick_bag/numeric/multi_counter.rb
 - lib/trick_bag/numeric/start_and_max.rb
 - lib/trick_bag/numeric/totals.rb
@@ -141,6 +170,7 @@ files:
 - spec/trick_bag/meta/classes_spec.rb
 - spec/trick_bag/numeric/bit_mapping_spec.rb
 - spec/trick_bag/numeric/bitmap_spec.rb
+- spec/trick_bag/numeric/kmgt_numeric_string_spec.rb
 - spec/trick_bag/numeric/multi_counter_spec.rb
 - spec/trick_bag/numeric/start_and_max_spec.rb
 - spec/trick_bag/numeric/totals_spec.rb
@@ -194,6 +224,7 @@ test_files:
 - spec/trick_bag/meta/classes_spec.rb
 - spec/trick_bag/numeric/bit_mapping_spec.rb
 - spec/trick_bag/numeric/bitmap_spec.rb
+- spec/trick_bag/numeric/kmgt_numeric_string_spec.rb
 - spec/trick_bag/numeric/multi_counter_spec.rb
 - spec/trick_bag/numeric/start_and_max_spec.rb
 - spec/trick_bag/numeric/totals_spec.rb