rufus-mnemo 1.2.1 → 1.2.2

data/CHANGELOG.txt

@@ -2,6 +2,11 @@
 = rufus-mnemo CHANGELOG.txt
 
 
+== rufus-mnemo - 1.2.2    not yet released
+
+- reworked aliases (aligned with README)
+
+
 == rufus-mnemo - 1.2.1    released 2011/08/27
 
 - Rufus::Mnemo.to_s(i) (alias for .from_i(i))

data/{README.txt → README.rdoc}

@@ -8,26 +8,22 @@ The module Rufus::Mnemo has all the explanation.
 
 == getting it
 
-  sudo gem install rufus-mnemo
-
-or at
-
-http://rubyforge.org/frs/?group_id=4812
+  gem install rufus-mnemo
 
 
 == usage
 
   require 'rubygems'
   require 'rufus/mnemo'
-  
-  s = Rufus::Mnemo::from_integer 125704
-  
-  puts s
-    # => 'karasu'
-  
-  i = Rufus::Mnemo::to_integer s
-  
-  puts i
+
+  p Rufus::Mnemo.from_integer(125704)
+  p Rufus::Mnemo.from_i(125704)
+  p Rufus::Mnemo.to_s(125704)
+    # => "karasu"
+
+  p Rufus::Mnemo.to_integer('karasu')
+  p Rufus::Mnemo.to_i('karasu')
+  p Rufus::Mnemo.from_s('karasu')
     # => 125704
 
 
@@ -35,7 +31,8 @@ http://rubyforge.org/frs/?group_id=4812
 
 They are prefixed with the "wi" syllable (Thanks Stephan Wehner).
 
-  p Rufus::Mnemo::from_integer -173866
+  p Rufus::Mnemo.from_integer(-173866)
+  p Rufus::Mnemo.to_s(-173866)
     # => 'winamote'
 
 
@@ -51,9 +48,14 @@ On the rufus-ruby list[http://groups.google.com/group/rufus-ruby] :
   http://groups.google.com/group/rufus-ruby
 
 
+== IRC
+
+On freenode.net, the #ruote channel
+
+
 == issue tracker
 
-http://rubyforge.org/tracker/?atid=18584&group_id=4812&func=browse
+https://github.com/jmettraux/rufus-mnemo/issues
 
 
 == source
@@ -65,7 +67,7 @@ http://github.com/jmettraux/rufus-mnemo
 
 == author
 
-John Mettraux, jmettraux@gmail.com 
+John Mettraux, jmettraux@gmail.com
 http://jmettraux.wordpress.com
 
 

data/Rakefile

@@ -58,10 +58,10 @@ end
 
 Rake::RDocTask.new do |rd|
 
-  rd.main = 'README.txt'
+  rd.main = 'README.rdoc'
   rd.rdoc_dir = "rdoc/#{GEMSPEC.name}"
 
-  rd.rdoc_files.include('README.mdown', 'CHANGELOG.txt', 'lib/**/*.rb')
+  rd.rdoc_files.include('README.rdoc', 'CHANGELOG.txt', 'lib/**/*.rb')
 
   rd.title = "#{GEMSPEC.name} #{GEMSPEC.version}"
 end

data/lib/rufus/mnemo.rb

@@ -68,7 +68,7 @@ module Rufus
   #
   module Mnemo
 
-    VERSION = '1.2.1'
+    VERSION = '1.2.2'
 
     SYL = %w[
       b d g h j k m n p r s t z
@@ -95,14 +95,14 @@ module Rufus
 
       return "#{NEG}#{from_integer(-integer)}" if integer < 0
 
-      to_special(from_i(integer))
+      to_special(_from_integer(integer))
     end
 
     # Turns the given Mnemo word to its equivalent integer.
     #
     def self.to_integer(string)
 
-      to_i(from_special(string))
+      _to_i(from_special(string))
     end
 
     # Turns a simple syllable into the equivalent number.
@@ -165,7 +165,7 @@ module Rufus
       SPECIAL.inject(s) { |ss, (a, b)| ss.gsub(b, a) }
     end
 
-    def self.from_i(integer)
+    def self._from_integer(integer) # :nodoc:
 
       return '' if integer == 0
 
@@ -179,21 +179,28 @@ module Rufus
       from_i(rest) + SYL[mod]
     end
 
-    def self.to_i(s)
+    def self._to_i(s) # :nodoc:
 
       if s.length == 0
         return 0
       end
 
       if m = s.match(NEGATIVE)
-        return -1 * to_i(m[1])
+        return -1 * _to_i(m[1])
       end
 
-      SYL.length * to_i(s[0..-3]) + to_number(s[-2, 2])
+      SYL.length * _to_i(s[0..-3]) + to_number(s[-2, 2])
     end
 
     class << self
-      alias to_s from_i
+
+      alias to_string from_integer
+      alias to_s from_integer
+      alias from_i from_integer
+
+      alias to_i to_integer
+      alias from_string to_integer
+      alias from_s to_integer
     end
   end
 end

data/test/test.rb

@@ -91,16 +91,37 @@ class MnemoTest < Test::Unit::TestCase
 
   def test_collision_with_mathn
 
-    assert_equal 'dobejotehozi',  Rufus::Mnemo.from_i(13477774722)
+    assert_equal 'dobejotehozi',  Rufus::Mnemo._from_integer(13477774722)
 
     require 'mathn'
 
-    assert_equal 'dobejotehozi',  Rufus::Mnemo.from_i(13477774722)
+    assert_equal 'dobejotehozi',  Rufus::Mnemo._from_integer(13477774722)
   end
 
-  def test_to_s
+  def test_aliases_i_to_s
 
-    assert_equal 'dobejotehozi',  Rufus::Mnemo.to_s(13477774722)
+    assert_equal 'wina', Rufus::Mnemo.from_integer(-35)
+    assert_equal 'wina', Rufus::Mnemo.from_i(-35)
+    assert_equal 'wina', Rufus::Mnemo.to_string(-35)
+    assert_equal 'wina', Rufus::Mnemo.to_s(-35)
+
+    assert_equal 'dobejotehotzu',  Rufus::Mnemo.from_integer(13477774722)
+    assert_equal 'dobejotehotzu',  Rufus::Mnemo.from_i(13477774722)
+    assert_equal 'dobejotehotzu',  Rufus::Mnemo.to_string(13477774722)
+    assert_equal 'dobejotehotzu',  Rufus::Mnemo.to_s(13477774722)
+  end
+
+  def test_aliases_s_to_i
+
+    assert_equal -35, Rufus::Mnemo.from_string('wina')
+    assert_equal -35, Rufus::Mnemo.from_s('wina')
+    assert_equal -35, Rufus::Mnemo.to_integer('wina')
+    assert_equal -35, Rufus::Mnemo.to_i('wina')
+
+    assert_equal 13477774722, Rufus::Mnemo.from_string('dobejotehotzu')
+    assert_equal 13477774722, Rufus::Mnemo.from_s('dobejotehotzu')
+    assert_equal 13477774722, Rufus::Mnemo.to_integer('dobejotehotzu')
+    assert_equal 13477774722, Rufus::Mnemo.to_i('dobejotehotzu')
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-mnemo
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 1
   - 2
-  - 1
-  version: 1.2.1
+  - 2
+  version: 1.2.2
 platform: ruby
 authors: 
 - John Mettraux
@@ -51,7 +51,7 @@ files:
 - CHANGELOG.txt
 - CREDITS.txt
 - LICENSE.txt
-- README.txt
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/jmettraux/rufus-mnemo/
 licenses: []