go-rank 0.0.4 → 0.0.5

data/History.txt

@@ -1,3 +1,8 @@
+== 0.0.5 2009-01-10
+
+* 1 enhancement:
+  * added methods for comparing Ranks (<,>,==,!=)
+
 == 0.0.4 2008-12-31
 
 * 1 minor  enhancement:

data/Rakefile

@@ -39,13 +39,13 @@ RUBYFORGE_PROJECT = 'go-rank' # The unix name for your project
 HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 
-NAME = "gorank"
+NAME = "go-rank"
 REV = nil 
 # UNCOMMENT IF REQUIRED: 
 # REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
 VERS = Gorank::VERSION::STRING + (REV ? ".#{REV}" : "")
 CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
-RDOC_OPTS = ['--quiet', '--title', 'gorank documentation',
+RDOC_OPTS = ['--quiet', '--title', 'go-rank documentation',
     "--opname", "index.html",
     "--line-numbers", 
     "--main", "README",

data/lib/gorank/gorank.rb

@@ -2,44 +2,44 @@
 class GoRank
 
   @@rank_array = [ 
-                   '7 dan',
-                   '6 dan',
-                   '5 dan',
-                   '4 dan',
-                   '3 dan',
-                   '2 dan',
-                   '1 dan',
-                   '1 kyu',
-                   '2 kyu',
-                   '3 kyu',
-                   '4 kyu',
-                   '5 kyu',
-                   '6 kyu',
-                   '7 kyu',
-                   '8 kyu',
-                   '9 kyu',
-                   '10 kyu',
-                   '11 kyu',
-                   '12 kyu',
-                   '13 kyu',
-                   '14 kyu',
-                   '15 kyu',
-                   '16 kyu',
-                   '17 kyu',
-                   '18 kyu',
-                   '19 kyu',
-                   '20 kyu',
-                   '21 kyu',
-                   '22 kyu',
-                   '23 kyu',
-                   '24 kyu',
-                   '25 kyu',
-                   '26 kyu',
-                   '27 kyu',
-                   '28 kyu',
-                   '29 kyu',
-                   '30 kyu',
-    ]
+    '7 dan',
+    '6 dan',
+    '5 dan',
+    '4 dan',
+    '3 dan',
+    '2 dan',
+    '1 dan',
+    '1 kyu',
+    '2 kyu',
+    '3 kyu',
+    '4 kyu',
+    '5 kyu',
+    '6 kyu',
+    '7 kyu',
+    '8 kyu',
+    '9 kyu',
+    '10 kyu',
+    '11 kyu',
+    '12 kyu',
+    '13 kyu',
+    '14 kyu',
+    '15 kyu',
+    '16 kyu',
+    '17 kyu',
+    '18 kyu',
+    '19 kyu',
+    '20 kyu',
+    '21 kyu',
+    '22 kyu',
+    '23 kyu',
+    '24 kyu',
+    '25 kyu',
+    '26 kyu',
+    '27 kyu',
+    '28 kyu',
+    '29 kyu',
+    '30 kyu',
+  ]
 
   # valid values for kd: :kyu, :dan
   def initialize(num, kd)
@@ -47,7 +47,7 @@ class GoRank
     @num = num
     @kd  = kd
     raise ArgumentError if @kd == :kyu and (@num < 1 or @num > 30) or
-                           @kd == :dan and (@num < 1 or @num > 7)
+      @kd == :dan and (@num < 1 or @num > 7)
   end
 
   # human representation of a rank.
@@ -100,4 +100,17 @@ class GoRank
     }
     result
   end
+  
+  def <(other)
+    other-self > 0
+  end
+  
+  def >(other)
+    other-self < 0
+  end
+  
+  def ==(other)
+    other-self == 0
+  end
+  
 end # class GoRank

data/lib/gorank/version.rb

@@ -2,7 +2,7 @@ module Gorank #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 4
+    TINY  = 5
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/test_gorank.rb

@@ -145,4 +145,20 @@ p myrank
     rank = GoRank.new 31, :kyu
     }
   end
+  
+  def test_order_of_ranks
+    assert GoRank.new(5,:kyu) < GoRank.new(4,:kyu)
+    assert GoRank.new(4,:kyu) > GoRank.new(5,:kyu)
+    
+    assert GoRank.new(1,:dan) > GoRank.new(1,:kyu)
+    assert GoRank.new(1,:kyu) < GoRank.new(1,:dan)
+    
+    assert GoRank.new(2,:dan) > GoRank.new(30,:kyu)
+    assert GoRank.new(30,:kyu) < GoRank.new(1,:dan)
+    
+    assert GoRank.new(5,:dan) == GoRank.new(5,:dan)
+    assert GoRank.new(5,:kyu) == GoRank.new(5,:kyu)
+    
+    assert GoRank.new(1,:kyu) != GoRank.new(2,:kyu)
+  end
 end

data/website/index.html

@@ -5,7 +5,7 @@
   <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>
-      gorank
+      go-rank
   </title>
   <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
 <style>
@@ -30,18 +30,68 @@
 <body>
 <div id="main">
 
-    <h1>gorank</h1>
+    <h1>go-rank</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/gorank"; return false'>
       <p>Get Version</p>
       <a href="http://rubyforge.org/projects/gorank" class="numbers">0.0.4</a>
     </div>
     <h2>What</h2>
-<p>Go-Rank is a class for handling ranks in the game of <a href="http://en.wikipedia.org/wiki/Go_(game">Go</a>)</p>
+<p>Go-Rank is a class for handling ranks in the game of <a href="http://en.wikipedia.org/wiki/Go_(game)">Go</a>.</p>
 <h2>Installing</h2>
-<pre syntax="ruby">sudo gem install gorank</pre>
+<pre syntax="ruby">sudo gem install go-rank</pre>
 <h2>The basics</h2>
 <h2>Demonstration of usage</h2>
-<p>See the rdoc documentation of this gem.</p>
+<pre syntax="ruby">
+require 'rubygems'
+require 'gorank'
+
+# create a go-rank object
+rank = GoRank.new 30, :kyu  # 30 kyu is the lowest
+                            #  7 dan is the highest rank
+
+puts rank.to_s # =&gt; '30 kyu'
+
+# one level higher:
+
+rank += 1
+puts rank.to_s # =&gt; '29 kyu'
+
+
+# one level lower:
+
+rank -= 1
+puts rank.to_s # =&gt; '30 kyu'
+
+# cannot go lower:
+begin
+  rank -= 1      # =&gt; raises IndexError
+  puts rank.to_s 
+rescue
+  #
+end
+
+# change from kyu to dan rank
+
+rank = GoRank.new 1, :kyu
+puts rank.to_s   # =&gt; '1 kyu'
+rank += 1
+puts rank.to_s   # =&gt; '1 dan'
+rank += 1
+puts rank.to_s   # =&gt; '2 dan'
+
+# difference between two ranks
+
+rank1 = GoRank.new 1, :dan
+rank2 = GoRank.new 5, :kyu
+
+puts "difference between #{rank1} and #{rank2} is #{rank1-rank2} stones"
+         # =&gt; "difference between 1 dan and 5 kyu is 5 stones"
+
+# invalid ranks
+
+rank = GoRank.new 35, :kyu # =&gt; raises ArgumentError
+</pre>
+
 <h2>Forum</h2>
 <p><a href="http://groups.google.com/group/gorank">http://groups.google.com/group/gorank</a></p>
 <h2>How to submit patches</h2>

data/website/index.txt

@@ -1,20 +1,76 @@
-h1. gorank
+h1. go-rank
 
 h2. What
 
-Go-Rank is a class for handling ranks in the game of "Go":http://en.wikipedia.org/wiki/Go_(game) 
+Go-Rank is a class for handling ranks in the game of ["Go":http://en.wikipedia.org/wiki/Go_(game)].
 
 h2. Installing
 
-<pre syntax="ruby">sudo gem install gorank</pre>
+<pre syntax="ruby">sudo gem install go-rank</pre>
 
 h2. The basics
 
 
 h2. Demonstration of usage
 
-See the rdoc documentation of this gem.
+<pre syntax="ruby">
+require 'rubygems'
+require 'gorank'
 
+# create a go-rank object
+rank = GoRank.new 30, :kyu  # 30 kyu is the lowest
+                            #  7 dan is the highest rank
+
+puts rank.to_s # => '30 kyu'
+
+# one level higher:
+
+rank += 1
+puts rank.to_s # => '29 kyu'
+
+
+# one level lower:
+
+rank -= 1
+puts rank.to_s # => '30 kyu'
+
+# cannot go lower:
+begin
+  rank -= 1      # => raises IndexError
+  puts rank.to_s 
+rescue
+  #
+end
+
+# change from kyu to dan rank
+
+rank = GoRank.new 1, :kyu
+puts rank.to_s   # => '1 kyu'
+rank += 1
+puts rank.to_s   # => '1 dan'
+rank += 1
+puts rank.to_s   # => '2 dan'
+
+# difference between two ranks
+
+rank1 = GoRank.new 1, :dan
+rank2 = GoRank.new 5, :kyu
+
+puts "difference between #{rank1} and #{rank2} is #{rank1-rank2} stones"
+         # => "difference between 1 dan and 5 kyu is 5 stones"
+
+# comparing ranks
+# a better rank is greater than a lower rank
+
+puts GoRank.new(1,:dan) > GoRank(5,:kyu) # => true
+puts GoRank.new(1,:dan) == GoRank(1,:dan) # => true
+puts GoRank.new(1,:dan) < GoRank(5,:kyu) # => false
+
+# invalid ranks
+
+rank = GoRank.new 35, :kyu # => raises ArgumentError
+</pre>
+ 
 h2. Forum
 
 "http://groups.google.com/group/gorank":http://groups.google.com/group/gorank

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: go-rank
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Thomas Preymesser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-31 00:00:00 +01:00
+date: 2009-01-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency