rudil 0.0.1 → 1.0.0

data/History.txt

@@ -1,3 +1,9 @@
+=== 1.0.0 2009-11-12
+
+* 1 enhancement:
+  * renamed public method roll to throw_once to avoid
+  confusion beetween the roll and throw methods
+
 === 0.0.1 2009-10-11
 
 * 1 major enhancement:

data/Manifest.txt

@@ -1,6 +1,6 @@
 History.txt
 Manifest.txt
-README.rdoc
+README.markdown
 Rakefile
 lib/rudil.rb
 lib/rudil/die.rb

data/README.markdown

@@ -0,0 +1,117 @@
+rudil
+=====
+
+[rudil's homepage on github](http://github.com/sMAshdot/rudil)
+
+DESCRIPTION
+-----------
+
+rudil is a dice library for the Ruby programming language.
+
+FEATURES
+--------
+
+Roll dice with any number of sides.   
+Methods provided for single and multiple rolls.  
+Retrieve useful information about the rolls easily.  
+
+INSTALL
+-------
+
+Assuming you installed [Gemcutter](http://gemcutter.org), all you need to do is:
+
+    gem install rudil
+
+SYNOPSIS
+--------
+
+### Creating a die
+
+    require 'rudil'
+    die = Rudil::Die.new
+
+or
+
+    require 'rudil'
+    include Rudil
+    die = Die.new
+
+The die will have 6 sides per default. If you want another number of sides,
+pass it as a parameter to the constructor:
+
+    die = Die.new(20)
+
+### Rolling the die
+
+If you only need the result of a single throw, use the throw_once method:
+
+    die.throw_once
+    => 3
+
+The throw method will return an array containing any number of throws:
+
+    die.throw(5)
+    => [6, 5, 3, 1, 3]
+
+The die will be thrown once per default.
+
+    die.throw
+    => [4]
+
+### Analysing the results
+
+A *Throw* is a subclass of array with a few convenience methods added.
+To use it, collect the rolls in an instance of it:
+
+    throws = Throw.new( Die.new(20).throw(5) )
+    => [3, 6, 16, 13, 18]
+
+You can get information about
+
+* the lowest and the highest roll
+* the mean (floating point)
+* the number of rolls above a certain value (or equal and above)
+* the number of rolls below a certain value (or equal and below)
+
+like this:
+  
+    throws.lowest
+    => 3    
+    throws.highest
+    => 18
+    throws.mean
+    => 11.2
+    throws.above(13)
+    => 2
+    throws.eq_or_above(13)
+    => 3
+    throws.below 3
+    => 0
+    throws.eq_or_below(3)
+    => 1
+
+LICENSE
+-------
+
+(The MIT License)
+
+Copyright (c) 2009 Marc-Antonio Bisotti
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -5,22 +5,16 @@ require 'fileutils'
 require './lib/rudil'
 
 Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
 
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
 $hoe = Hoe.spec 'rudil' do
   self.developer 'Marc-Antonio Bisotti', 'mail@marc-antonio.de'
-  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  self.rubyforge_name       = self.name # TODO this is default value
-  # self.extra_deps         = [['activesupport','>= 2.0.2']]
-
+  self.url = "http://github.com/sMAshdot/rudil"
+  self.summary = 'rudil is a dice library for the Ruby programming language.'
+  self.description = "Throw dice with any number of sides any number of times. Helps you to interpret the results." 
+  self.readme_file = 'README.markdown'
 end
 
 require 'newgem/tasks'
 Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]

data/lib/rudil/die.rb

@@ -19,10 +19,10 @@ module Rudil
       if times <= 0
         raise ArgumentError
       end
-      Array.new(times).fill { roll }
+      Array.new(times).fill { throw_once }
     end
 
-    def roll
+    def throw_once
       # the part where randomness happens has it's own method
       # to simplify unit-testing by permitting it to be stubbed.
       rand(@sides)+1

data/lib/rudil.rb

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(libdir) unless
   $LOAD_PATH.include?(libdir) || $LOAD_PATH.include?(File.expand_path(libdir))
 
 module Rudil
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end
 
 require 'rudil/die'

data/spec/die_spec.rb

@@ -19,24 +19,24 @@ describe Die do
 
   it "should roll an integer" do
     die = Die.new
-    die.roll.class.should == Fixnum
+    die.throw_once.class.should == Fixnum
   end
 
   it "should not roll a number smaller than one" do
     die = Die.new
-    collection = Array.new(NB_OF_ROLLS).fill { die.roll }
+    collection = Array.new(NB_OF_ROLLS).fill { die.throw_once }
     collection.sort[0].should == 1 
   end
 
   it "should not roll a number bigger than 6 per default" do
     die = Die.new
-    collection = Array.new(NB_OF_ROLLS).fill { die.roll }
+    collection = Array.new(NB_OF_ROLLS).fill { die.throw_once }
     collection.sort[NB_OF_ROLLS - 1].should == 6 
   end
 
   it "should not roll a number bigger than the number of sides" do
     die = Die.new(20)
-    collection = Array.new(NB_OF_ROLLS).fill { die.roll }
+    collection = Array.new(NB_OF_ROLLS).fill { die.throw_once }
     collection.sort[NB_OF_ROLLS - 1].should == 20 
   end
 
@@ -58,14 +58,14 @@ describe Die do
   
   it "should return the result after it has been thrown once" do
     die = Die.new()
-    die.stub!(:roll).and_return(6)
+    die.stub!(:throw_once).and_return(6)
     throw = die.throw(1)
     throw[0].should == 6
   end
 
   it "should return the result after it has been thrown any number of times" do
     die = Die.new()
-    die.stub!(:roll).and_return(1,2,3,4,5,6)
+    die.stub!(:throw_once).and_return(1,2,3,4,5,6)
     throw = die.throw(6)
     throw[0].should == 1
     throw[5].should == 6

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rudil
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Marc-Antonio Bisotti
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-11 00:00:00 +02:00
+date: 2009-11-12 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.3
     version: 
-description: rudil is a dice library for ruby.
+description: Throw dice with any number of sides any number of times. Helps you to interpret the results.
 email: 
 - mail@marc-antonio.de
 executables: []
@@ -35,7 +35,7 @@ extra_rdoc_files:
 files: 
 - History.txt
 - Manifest.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - lib/rudil.rb
 - lib/rudil/die.rb
@@ -52,10 +52,10 @@ has_rdoc: true
 homepage: http://github.com/sMAshdot/rudil
 licenses: []
 
-post_install_message: PostInstall.txt
+post_install_message: 
 rdoc_options: 
 - --main
-- README.rdoc
+- README.markdown
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -76,6 +76,6 @@ rubyforge_project: rudil
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: rudil is a dice library for ruby.
+summary: rudil is a dice library for the Ruby programming language.
 test_files: []
 

data/README.rdoc

@@ -1,80 +0,0 @@
-= rudil
-
-* http://github.com/sMAshdot/rudil
-
-== DESCRIPTION:
-
-rudil is a dice library for ruby.
-
-== FEATURES/PROBLEMS:
-
-Roll dice with any number of sides.
-Methods for single and multiple rolls.
-Retrieve useful about the rolls easily.
-
-== SYNOPSIS:
-
-=== simple rolling
-
-  require 'rudil'
-  die = Rudil::Die.new
-or
-  require 'rudil'
-  include Rudil
-  die = Die.new
-creates a 6-sided die per default
-but you could also use Die.new(n) to
-obtain a die with more sides.
-
-  die.roll
-  => 3
-returns the result of a single roll
-
-  die.throw(5)
-  => [6, 5, 3, 1, 3]
-returns results of any number of rolls as array
-
-=== analysing the results
-
-start with a die
-  die = Die.new(20)
-  
-collect the rolls in a throw
-  throw = Throw.new( die.throw(5) )
-
-Throw is a subclass of array with a few convenience methods added.
-You can get information about
-- the lowest roll
-- the highest roll
-- the mean
-- the number of rolls above a certain value (or equal and above)
-- the number of rolls below a certain value (or equal and below) FIX (code sample of usage)
-
-== INSTALL:
-
-soon
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2009 FIXME full name
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.