radix 2.2.0 → 2.2.1

data/HISTORY.md

@@ -1,5 +1,22 @@
 # RELEASE HISTORY
 
+## 2.2.1 / 2014-03-02
+
+This release fixes a couple of issues. One unsettling issue in particular,
+somewhere around Ruby 2.0, `String#b` became an offical core method
+that force-encodes a string to ASCII 8-bit. This, of course, broke Radix :(
+That aside, it seems like a rather weak name for such a method. `String#ascii`
+seems a much better choice (IOHO). Thankfully, there's just enough wiggle-room
+to implement a work around, so the Radix API remains the same. In addition,
+there was a bug when trying to decode custom character sets, which has been
+fixed.
+
+Changes:
+
+* Work around Ruby's `String#b` method.
+* Fix custom base decoding.
+
+
 ## 2.2.0 / 2013-03-20
 
 Good documentation is so under-addressed by most developers that we really

data/README.md

@@ -1,23 +1,26 @@
 # Radix
 
-[Website](http://rubyworks.github.com/radix) ·
-[Report Issue](http://github.com/rubyworks/radix/issues) ·
-[Source Code](http://github.com/rubyworks/radix)     
-[![Build Status](https://secure.travis-ci.org/rubyworks/radix.png)](http://travis-ci.org/rubyworks/radix)
-[![Gem Version](https://badge.fury.io/rb/radix.png)](http://badge.fury.io/rb/radix)    
+[![Gem Version](http://img.shields.io/gem/v/radix.svg?style=flat)](http://rubygems.org/gem/radix)
+   
+[![Fork Me](http://img.shields.io/badge/scm-github-blue.svg?style=flat)](http://github.com/rubyworks/radix)
+[![Report Issue](http://img.shields.io/github/issues/rubyworks/radix.svg?style=flat)](http://github.com/rubyworks/radix/issues)
+[![Build Status](http://img.shields.io/travis/rubyworks/radix.svg?style=flat)](http://travis-ci.org/rubyworks/radix)
+   
+[![Gittip](http://img.shields.io/badge/gittip-$1/wk-green.svg?style=flat)](https://www.gittip.com/on/github/rubyworks/)
 [![Flattr Me](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/324911/Rubyworks-Ruby-Development-Fund)
 
 
-Radix is a very easy to use Ruby library for converting numbers to and from
-any base. It supports both Integer, Float and Rational numbers, as well as 
-representational string-notations that need not be in ASCII order.
+<b>[Radix]((http://rubyworks.github.com/radix)) is a very easy to use Ruby library
+for converting numbers to and from any base. It supports Integer, Float and
+Rational numbers, as well as representational string-notations that need not be
+in ASCII order.</b>
 
 
 ## Features
 
 * Convert to and from any base.
-* Convert Integers, Floats and Rational numbers.
-* Define custom encoding and character sets.
+* Convert Integer, Float and Rational numbers.
+* Define custom encodings and character sets.
 * Can be used to encode/decode bytecode strings.
 * Very intuitive API.
 
@@ -26,49 +29,66 @@ representational string-notations that need not be in ASCII order.
 
 Base conversions with ASCII ordered notations are easy in Ruby.
 
-    255.to_s(16)   #=> "FF"
+```ruby
+255.to_s(16)   #=> "FF"
 
-    "FF".to_i(16)  #=> 255
+"FF".to_i(16)  #=> 255
+```
 
 But Ruby reaches it's limit at base 36.
 
-    255.to_s(37)   #=> Error
+```ruby
+255.to_s(37)   #=> Error
+```
 
 Radix provides the means of converting to and from any base.
 
 For example, a number in base 256 can be represented by the array `[100, 10]`
 (`100**256 + 10**1`) and can be convert to base 10.
 
-    [100,10].b(256).to_a(10)  #=> [2,5,6,1,0]
+```ruby
+[100,10].b(256).to_a(10)  #=> [2,5,6,1,0]
+```
 
 Or, to get a string representation for any base up to 62.
 
-    [100,10].b(256).to_s(10)  #=> "25610"
+```ruby
+[100,10].b(256).to_s(10)  #=> "25610"
+```
 
 A string representation of a number can be converted too, again,
 up to base 62.
 
-    "10".b(62).to_s(10)  #=> "62"
+```ruby
+"10".b(62).to_s(10)  #=> "62"
+```
 
 To use a custom character set, use an array of characters as the base
 rather than an integer. For example we can convert a base 10 number
 to another base 10 number using a different encoding.
 
-    base = [:Q, :W, :E, :R, :T, :Y, :U, :I, :O, :U]
+```ruby
+base = [:Q, :W, :E, :R, :T, :Y, :U, :I, :O, :U]
 
-    "10".b(10).to_a(base)  #=> [:W, :Q]
+"10".b(10).to_a(base)  #=> [:W, :Q]
+```
 
 To learn more have a look at the [QED Demo](http://rubydoc.info/gems/radix/file/DEMO.md).
 
 
 ## Installing
 
+If using Bundler, then add the ususal gem entry to your project's Gemfile.
+
+    gem 'radix'
+
 To install with RubyGems simply open a console and type:
 
     $ gem install radix
 
 Radix follows [Ruby Setup](http://rubyworks.github.com/setup) package standard
-so it can also be installed in an FHS compliant manner using setup.rb.
+so it can also be installed in an FHS compliant manner using setup.rb (very
+old-school and no longer recommeded).
 
 
 ## Special Thanks
@@ -80,7 +100,7 @@ so your contribution is greatly appreciated. Thank you, Douglas!
 
 ## Copyrights
 
-Copyright (c) 2009 Rubyworks
+Copyright (c) 2009 [Rubyworks](https://rubyworks.github.io)
 
 This program is distributable in accordance with the *BSD-2-Clause* license.
 

data/demo/issues/012_array_base.md

@@ -0,0 +1,13 @@
+# Encoding/decoding with custom character sets (#12)
+
+There is not problem converting a numeric value into a custom base.
+
+    c62 = (0..9).map{ |x| x.to_s } + ('a'..'z').to_a + ('A'..'Z').to_a
+
+    809145531659995.b(c62).to_s  #=> "3HLszsQsP"
+
+But there was a problem with decoding custom number back.
+
+    "3HLszsQsP".b(c62).to_i   #=> 809145531659995
+
+

data/lib/radix.yml

@@ -2,7 +2,7 @@
 revision: 2013
 type: ruby
 sources:
-- var
+- index
 authors:
 - name: Thomas Sawyer
   email: transfire@gmail.com
@@ -29,9 +29,6 @@ resources:
 - type: code
   uri: http://github.com/rubyworks/radix
   label: Source Code
-- type: mail
-  uri: http://groups.google.com/groups/rubyworks-mailinglist
-  label: Mailing List
 - type: bugs
   uri: http://github.com/rubyworks/radix/issues
   label: Issue Tracker
@@ -48,12 +45,12 @@ customs: []
 paths:
   lib:
   - lib
-created: '2009-07-01'
-summary: Convert to and from any base.
-title: Radix
-version: 2.2.0
 name: radix
-description: ! "Radix is a very easy to use Ruby library for converting numbers to
-  and from\nany base. It supports both Integer, Float and Rational numbers, as well
-  as \nrepresentational string-notations that need not be in ASCII order."
-date: '2013-03-20'
+title: Radix
+summary: Convert to and from any base.
+created: '2009-07-01'
+description: "Radix is a very easy to use Ruby library for converting numbers to and
+  from\nany base. It supports both Integer, Float and Rational numbers, as well as
+  \nrepresentational string-notations that need not be in ASCII order."
+version: 2.2.1
+date: '2015-03-02'

data/lib/radix/float.rb

@@ -49,8 +49,8 @@ module Radix
     #
     # @return [void]    
     def initialize(value, base=10)
-      @value = parse_value(value, base)
       @base, @code = parse_base(base)
+      @value = parse_value(value, @base)
     end
 
     ##
@@ -77,10 +77,10 @@ module Radix
       end
     end
 
-    public
+  public
 
     ##
-    # Makes this Radix::Float a ruby Integer.
+    # Convert the Radix::Float a Ruby Integer.
     # 
     # @return [Integer] Base(10) value as Integer.
     def to_i
@@ -90,7 +90,7 @@ module Radix
     alias_method :to_int, :to_i
 
     ##
-    # Makes this Radix::Float a ruby float.
+    # Convert Radix::Float to a Ruby float.
     # 
     # @return [Float] Base(10) value as Float.
     def to_f

data/lib/radix/integer.rb

@@ -32,7 +32,7 @@ module Radix
     # @return [Array<String>, nil] Substitution chars or nil if default.
     attr :code
 
-    private
+  private
 
     ##
     # Starts a new instance of the Radix::Integer class
@@ -45,8 +45,8 @@ module Radix
     #
     # @return [void]
     def initialize(value, base=10)
-      @value = parse_value(value, base)
       @base, @code = parse_base(base)
+      @value = parse_value(value, @base)
     end
 
     ##
@@ -94,8 +94,7 @@ module Radix
 
     ## digits << #Radix.convert(d, base, 10).to_i
 
-    public
-
+  public
 
     ##
     # Makes this Radix::Integer a ruby integer.

data/lib/radix/numeric.rb

@@ -68,7 +68,7 @@ module Radix
       operation(:/, other)
     end
 
-    private
+  private
 
     ##
     # Parses the value of the base and character set to use.
@@ -85,7 +85,7 @@ module Radix
     #   1 - Nil, or Array of characters representing the base values.
     def parse_base(base)
       case base
-       when Array
+      when Array
         code = base
         base = base.size
       else
@@ -192,7 +192,7 @@ module Radix
     end
 
     ##
-    # Decode an encoded array. Defaults to BASE::B62 if self.code is not set.
+    # Decode an encoded array. Defaults to BASE::B62 if @code is not set.
     # 
     # @param [Array<String, Numeric>] digits The encoded characters. 
     #

data/lib/radix/operator.rb

@@ -40,6 +40,17 @@ end
 # instances.
 class ::String
 
+  # Ruby 2.x defines it's own `String#b` method for converting to ASCII 8-bit.
+  # That breaks Radix (of course), but it a terrbile name. `String#ascii` is 
+  # much better (duh!). So that's what we are doing.
+  if method_defined?(:b)
+    alias :ascii :b
+  else
+    def ascii
+      force_encoding('ASCII')
+    end
+  end
+
   ##
   # Takes a String and makes it into a Radix::Integer or Radix::Float as given
   # base. Float is determined by a "." character in string instance
@@ -48,7 +59,9 @@ class ::String
   #   The desired base.
   #
   # @return [Radix::Integer, Radix::Float]
-  def b(base)
+  def b(base=nil)
+    return ascii unless base
+
     if index('.')
       Radix::Float.new(self, base)
     else

data/lib/radix/rational.rb

@@ -40,7 +40,7 @@ module Radix
     # @return [Array<String>, nil] Substitution chars or nil if default.
     attr :code
 
-    private
+  private
 
     ##
     # Create a new Radix::Rational instance.

metadata

@@ -1,75 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: radix
 version: !ruby/object:Gem::Version
-  version: 2.2.0
-  prerelease: 
+  version: 2.2.1
 platform: ruby
 authors:
 - Thomas Sawyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2015-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ergo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: qed
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ae
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "Radix is a very easy to use Ruby library for converting numbers to
-  and from\nany base. It supports both Integer, Float and Rational numbers, as well
-  as \nrepresentational string-notations that need not be in ASCII order."
+description: "Radix is a very easy to use Ruby library for converting numbers to and
+  from\nany base. It supports both Integer, Float and Rational numbers, as well as
+  \nrepresentational string-notations that need not be in ASCII order."
 email:
 - transfire@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- HISTORY.md
 - README.md
+- HISTORY.md
 - DEMO.md
 files:
 - .index
@@ -83,6 +76,7 @@ files:
 - demo/applique/check.rb
 - demo/applique/radix.rb
 - demo/issues/004_zero_empty_string.md
+- demo/issues/012_array_base.md
 - lib/radix/base.rb
 - lib/radix/float.rb
 - lib/radix/integer.rb
@@ -91,34 +85,33 @@ files:
 - lib/radix/rational.rb
 - lib/radix.rb
 - lib/radix.yml
-- HISTORY.md
 - README.md
+- HISTORY.md
 - DEMO.md
 - LICENSE.txt
 homepage: http://rubyworks.github.com/radix
 licenses:
 - BSD-2-Clause
+metadata: {}
 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
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Convert to and from any base.
 test_files: []
 has_rdoc: