rudil 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-10-11
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/rudil.rb
+lib/rudil/die.rb
+lib/rudil/throw.rb
+script/console
+script/destroy
+script/generate
+spec/die_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/throw_spec.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,80 @@
+= 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.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+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']]
+
+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

@@ -0,0 +1,31 @@
+module Rudil
+  class Die
+    def initialize sides=6
+      unless sides >= 1 and sides <= 120
+        raise ArgumentError
+        # "120 sides should be enough for anybody."
+        #   - sMAshdot
+        # Such a die would be an Hexakis Icosahedron, and I challenge
+        # anyone to build it.
+        # The biggest manufactured die to date has 100 sides and is
+        # trademarked as Zocchihedron. It isn't a polyhedron anymore
+        # but rather a ball with flattened planes (think golfball).
+      else
+        @sides = sides
+      end
+    end
+
+    def throw times=1
+      if times <= 0
+        raise ArgumentError
+      end
+      Array.new(times).fill { roll }
+    end
+
+    def roll
+      # the part where randomness happens has it's own method
+      # to simplify unit-testing by permitting it to be stubbed.
+      rand(@sides)+1
+    end
+  end
+end

data/lib/rudil/throw.rb

@@ -0,0 +1,38 @@
+module Rudil
+  class Throw < Array
+    def to_s
+      inspect
+    end
+    
+    def lowest
+      sort.first 
+    end
+
+    def highest
+      sort.last
+    end
+
+    def mean
+      if size < 1
+        return nil
+      end
+      inject(0.0) { |sum, i| sum + i } / size 
+    end
+    
+    def above m
+      select { |n| n > m }.size
+    end
+
+    def eq_or_above m
+      select { |n| n >= m }.size
+    end
+
+    def below m
+      select { |n| n < m }.size
+    end
+
+    def eq_or_below m
+      select { |n| n <= m }.size
+    end
+  end
+end

data/lib/rudil.rb

@@ -0,0 +1,11 @@
+libdir = File.dirname(__FILE__)
+
+$LOAD_PATH.unshift(libdir) unless
+  $LOAD_PATH.include?(libdir) || $LOAD_PATH.include?(File.expand_path(libdir))
+
+module Rudil
+  VERSION = '0.0.1'
+end
+
+require 'rudil/die'
+require 'rudil/throw'

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rudil.rb'}"
+puts "Loading rudil gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/die_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+# classes dealing with random numbers are not easily unit-tested.
+# this number represents the number of dice-throwing to do until
+# the Die is considered "tested enough"
+NB_OF_ROLLS = 180
+# 180 throws correspond to a 1-(19/20)^180=0.99990 chance of
+# throwing a certain number at least once on a twenty sided die
+
+if NB_OF_ROLLS < 1
+  raise ScriptError
+end
+
+describe Die do
+  it "should not want to have less than 1 or more than 120 sides" do
+    lambda { Die.new(0) }.should raise_error(ArgumentError)
+    lambda { Die.new(121) }.should raise_error(ArgumentError)
+  end
+
+  it "should roll an integer" do
+    die = Die.new
+    die.roll.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.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.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.sort[NB_OF_ROLLS - 1].should == 20 
+  end
+
+  it "should be thrown once per default" do
+    die = Die.new
+    die.throw.length.should == 1
+  end
+
+  it "should be thrown as often as told" do
+    die = Die.new
+    die.throw(10).length.should == 10
+  end
+
+  it "should not want to be thrown less than once" do
+    die = Die.new
+    lambda { die.throw(-1) }.should raise_error(ArgumentError)
+    lambda { die.throw(0) }.should raise_error(ArgumentError)
+  end
+  
+  it "should return the result after it has been thrown once" do
+    die = Die.new()
+    die.stub!(:roll).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)
+    throw = die.throw(6)
+    throw[0].should == 1
+    throw[5].should == 6
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
+
+require 'rudil'
+include Rudil

data/spec/throw_spec.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Throw do
+  it "should be pretty when casted into string" do
+    throw = Throw.new [1,2,3,4,5,6]
+    throw.to_s.should == "[1, 2, 3, 4, 5, 6]"
+  end
+
+  it "should return its lowest roll" do
+    throw = Throw.new []
+    throw.lowest.should == nil
+    throw = Throw.new [3]
+    throw.lowest.should == 3
+    throw = Throw.new [2,5,1,6]
+    throw.lowest.should == 1
+  end
+
+  it "should return its highest roll" do
+    throw = Throw.new []
+    throw.highest.should == nil
+    throw = Throw.new [3]
+    throw.highest.should == 3
+    throw = Throw.new [2,5,1,6]
+    throw.highest.should == 6
+  end
+
+  it "should return its mean" do
+    throw = Throw.new []
+    throw.mean.should == nil
+    throw = Throw.new [1,2,3]
+    throw.mean.should == 2.0
+    throw = Throw.new [1,2,3,4]
+    throw.mean.should == 2.5
+  end
+
+  it "should return number of rolls above a certain value" do
+    throw = Throw.new [1,2,3,4,5,6]
+    throw.above(3).should == 3
+  end
+
+  it "should return number of rolls equal or below a value" do
+    throw = Throw.new [1,2,3,4,5,6]
+    throw.eq_or_above(3).should == 4
+  end
+
+  it "should return number of rolls below a certain value" do
+    throw = Throw.new [1,2,3,4,5,6]
+    throw.below(3).should == 2
+  end
+
+  it "should return number of rolls equal or above a value" do
+    throw = Throw.new [1,2,3,4,5,6]
+    throw.eq_or_below(3).should == 3
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: rudil
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Marc-Antonio Bisotti
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: rudil is a dice library for ruby.
+email: 
+- mail@marc-antonio.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/rudil.rb
+- lib/rudil/die.rb
+- lib/rudil/throw.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/die_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/throw_spec.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/sMAshdot/rudil
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rudil
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: rudil is a dice library for ruby.
+test_files: []
+