fools 0.0.4

data/Manifest.txt

@@ -0,0 +1,65 @@
+COPYING
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/carps_fools
+bin/register_carps_fools
+features/character_sheet.feature
+features/dice.feature
+features/dm_interface.feature
+features/launch_dm.feature
+features/launch_player.feature
+features/player_interface.feature
+features/rules.feature
+features/step_definitions/common_steps.rb
+features/steps/character_sheet.rb
+features/steps/dice.rb
+features/steps/dm_interface.rb
+features/steps/dm_mod.rb
+features/steps/dm_test_mailer.rb
+features/steps/general.rb
+features/steps/interface.rb
+features/steps/launch_dm.rb
+features/steps/launch_player.rb
+features/steps/player_interface.rb
+features/steps/player_mod.rb
+features/steps/player_test_mailer.rb
+features/steps/resource.rb
+features/steps/rules.rb
+features/support/common.rb
+features/support/env.rb
+features/support/matchers.rb
+lib/fools.rb
+lib/fools/dm.rb
+lib/fools/dm/interface.rb
+lib/fools/dm/launch.rb
+lib/fools/dm/mod.rb
+lib/fools/interface.rb
+lib/fools/mod.rb
+lib/fools/player.rb
+lib/fools/player/interface.rb
+lib/fools/player/launch.rb
+lib/fools/player/mod.rb
+lib/fools/rules.rb
+lib/fools/rules/combat/dice.rb
+lib/fools/rules/combat/rule.rb
+lib/fools/rules/drink/dice.rb
+lib/fools/rules/drink/rule.rb
+lib/fools/rules/romance/dice.rb
+lib/fools/rules/romance/rule.rb
+lib/fools/sheet.rb
+lib/fools/sheet/alter.rb
+lib/fools/sheet/schema.rb
+lib/fools/sheet/semantics.rb
+lib/fools/util.rb
+lib/fools/util/error.rb
+permission
+script/console
+script/destroy
+script/generate
+tasks/readme_site.rake
+test/test_fools.rb
+test/test_helper.rb
+website/index.html

data/PostInstall.txt

@@ -0,0 +1,31 @@
+The Fools.  Copyright John Morrice 2010. 
+
+The Fools is distributed for educational purposes: it is 
+intended to be used by programmers, as an aid in 
+learning how to write mods for CARPS.
+
+The Fools is loosely based on the rules of the Drones RPG:
+http://www.granta.demon.co.uk/drones/
+Copyright Ian Crowther, Sheila Thomas, Victoria Uren 1995-1996
+
+You should familiarise yourself with the rules before
+play, though note the following differences and quriks
+present in this CARPS mod:
+
+* Your character points are present on the character
+  sheet. These are your total character points, rather
+  than the points you have not yet spent available.  
+  Hence you should NOT reduce this value when you spend 
+  a point.  
+  As in the Fools rules, you should expect 
+  the Game Master to tell you how many points you have 
+  available before the game begins.
+
+* Two additional character attributes are added:
+  Intoxication and Discomfiture.
+  These attributes are to keep track of the transitory 
+  nature of drunkenness and being the subject of A Sound 
+  Drubbing, respectively.  
+  These values range from 0 to -10.  0 indicates 
+  sobreity or perfect health, while -10 represents a 
+  highly debilated state.

data/README.rdoc

@@ -0,0 +1,73 @@
+= The Fools, an example CARPS mod 
+
+== The Fools is hosted on github:
+
+* http://github.com/elginer/fools
+
+== Description:
+
+The Fools.  Copyright John Morrice 2010. 
+
+The fools is an example mod for CARPS.
+
+The Fools is distributed for educational purposes: it is 
+intended to be used by programmers, as an aid in 
+learning how to write mods for CARPS.
+
+The Fools is loosely based on the rules of the Drones RPG:
+http://www.granta.demon.co.uk/drones/
+
+The Drones is Copyright Ian Crowther, Sheila Thomas, Victoria Uren 1995-1996
+
+You should familiarise yourself with the rules before
+play, though note the following differences 
+present in Fools:
+
+* Your character points are present on the character
+  sheet. These are your total character points, rather
+  than the points you have not yet spent available.  
+  Hence you should NOT reduce this value when you spend 
+  a point.  
+  As in the Fools rules, you should expect 
+  the Game Master to tell you how many points you have 
+  available before the game begins.
+
+* Two additional character attributes are added:
+  Intoxication and Discomfiture.
+  These attributes are to keep track of the transitory 
+  nature of drunkenness and being the subject of A Sound 
+  Drubbing, respectively.  
+  These values range from 0 to -10.  0 indicates 
+  sobreity or perfect health, while -10 represents a 
+  highly debilated state.
+
+== Requirements:
+
+CARPS
+
+== To Install:
+
+<tt># This installs the gem</tt>
+
+<tt>sudo gem install fools</tt>
+
+<tt># This registers the mod with CARPS</tt>
+
+<tt>register_carps_fools</tt>
+
+== License:
+
+Copyright 2010 John Morrice
+ 
+Fools is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+Fools is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Fools.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/fools'
+
+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 'fools' do
+  self.developer 'John Morrice', 'spoon@killersmurf.com'
+  self.post_install_message = File.read "PostInstall.txt"
+  self.summary              = 'The Fools for CARPS'
+  self.description          = "The Fools, copyright Ian Crowther, Sheila Thomas, Victoria Uren 1995-1996.\nsee http://www.granta.demon.co.uk/fools/\nThis is an implementation of The Fools for CARPS."
+  self.rubyforge_name       = self.name 
+  self.extra_deps         = [['carps','>= 0.2.0']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/bin/carps_fools

@@ -0,0 +1,27 @@
+#!/usr/local/bin/ruby
+# Copyright 2010 John Morrice
+ 
+# This file is part of The Fools.
+
+# The Fools is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# The Fools is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with The Fools.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps"
+
+require "fools"
+
+include CARPS
+# A hack
+include CARPS::Dice
+
+CARPS::Launcher::launch Fools

data/bin/register_carps_fools

@@ -0,0 +1,35 @@
+#!/usr/local/bin/ruby
+# Copyright 2010 John Morrice
+
+# This file is part of The Fools.
+
+# The Fools is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# The Fools is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with The Fools.  If not, see <http://www.gnu.org/licenses/>.
+
+require "carps"
+
+require "yaml"
+
+# Update the CARPS mod file
+filename = CARPS::root_config + "mods.yaml"
+contents = ""
+contents = File.read filename
+mods = {}
+unless contents.empty?
+mods = YAML::load contents
+end
+mods["fools"] = "carps_fools"
+new_mods = mods.to_yaml
+mod_file = File.open filename, "w"
+mod_file.write new_mods
+mod_file.close

data/features/character_sheet.feature

@@ -0,0 +1,35 @@
+Feature: Character sheet schema
+   As Fools users,
+   in order to exploit the features of CARPS,
+   The Fools needs to have a character sheet schema.
+
+   Scenario: valid sheet
+      Given the Fools' verifier 
+      When a valid sheet is provided
+      Then accept the character sheet
+   
+   Scenario: syntactically invalid sheet
+      Given the Fools' verifier
+      When a syntactically invalid sheet is provided 
+      Then do not accept the character sheet
+
+   Scenario: out of bounds sheet
+      Given the Fools' verifier
+      When an out of bounds sheet is provided
+      Then do not accept the character sheet
+
+   Scenario: sheet on limit
+      Given the Fools' verifier
+      When a character sheet using exactly 8 character points is provided
+      Then accept the character sheet
+
+   Scenario: sheet out of limit
+      Given the Fools' verifier
+      When a character sheet using more than 8 character points is provided
+      Then do not accept the character sheet
+
+   Scenario: sheet under limit
+      Given the Fools' verifier
+      When a character sheet using less than 8 character points is provided
+      Then accept the character sheet
+      

data/features/dice.feature

@@ -0,0 +1,28 @@
+Feature: Non-determinism in the fools
+
+   As a Fools user,
+   I expect this mod to behave
+   as described by the game manual,
+   with respect to non-determinism.
+
+   # As yet I haven't done the maths to prove these work
+   # However, these tests will prevent the game from crashing.
+   Scenario: drink roll
+      Given a hash of the dice rolls
+      Given a roll is made for drunkenness 
+      Then show the odds
+
+   Scenario: combat roll
+      Given a hash of the dice rolls
+      Given a roll is made for combat
+      Then show the odds
+
+   Scenario: romantic resistance roll
+      Given a hash of the dice rolls
+      Given a roll is made for romance
+      Then show the odds
+
+   Scenario: talking sense roll
+      Given a hash of the dice rolls
+      Given a roll is made for sense
+      Then show the odds

data/features/dm_interface.feature

@@ -0,0 +1,19 @@
+Feature: DM Interface
+   As a Fools DM,
+   I need control!
+
+   Scenario: present user interface
+      Given carps is initialized with test/server
+      Given a DM test mailer
+      Given a resource manager
+      Given the DM mod for campaign detective 
+      Given the DM user interface
+      Then present the interface to the user
+     
+   Scenario: test DM inputs
+      Given carps is initialized with test/server
+      Given a DM test mailer
+      Given a resource manager
+      Given the DM mod for campaign detective
+      Given the DM user interface
+      Then test all the DM user inputs

data/features/launch_dm.feature

@@ -0,0 +1,10 @@
+Feature: launch player
+   As a seriously minded Dungeon Master 
+   I require launching
+   of this wonderful CARPS mod.
+
+   Scenario: launch DM
+      Given a DM test mailer
+      Given a campaign called snarkle
+      Given carps is initialized with test/client
+      Then launch the DM interface

data/features/launch_player.feature

@@ -0,0 +1,9 @@
+Feature: launch player
+   As a Drone-to-be,
+   I require launching
+   of this wonderful CARPS mod.
+
+   Scenario: launch player
+      Given a test player mailer
+      Given carps is initialized with test/client
+      Then launch the player interface

data/features/player_interface.feature

@@ -0,0 +1,19 @@
+Feature: Player Interface
+   As a Fools Player,
+   I need to speak to the DM,
+   And do other things too!
+
+   Scenario: present user interface
+      Given carps is initialized with test/client
+      Given a test player mailer
+      Given the Player mod 
+      Given the Player user interface
+      Then present the interface to the user
+
+   Scenario: test player inputs
+      Given carps is initialized with test/server
+      Given a test player mailer
+      Given the Player mod
+      Given the Player user interface
+      When a character sheet is provided for the player 
+      Then test all the Player user inputs

data/features/rules.feature

@@ -0,0 +1,66 @@
+Feature: Fools rules
+
+   As a Fools user,
+   I expect the mod to faithfully
+   implement the rules as described
+   in the Fools manual.
+
+   Scenario: drinking odds
+      Given a hash of the rules
+      When the rule is drunkenness
+      Given a character sheet for an ordinary drone
+      Then show the odds for the drunk rule
+      Given a character sheet for a drone with a high tolerance for alcohol
+      Then show the odds for the drunk rule
+
+   Scenario: drinking application
+      Given a hash of the rules
+      When the rule is drunkenness
+      Given a character sheet for an ordinary drone
+      Then apply the drunk rule
+      Then display the character sheet
+
+   Scenario: combat odds
+      Given a hash of the rules
+      When the rule is combat
+      Given a character sheet for an ordinary drone
+      Given also a character sheet for a fit drone
+      Then show the odds for the combat rule
+
+   Scenario: combat application
+      Given a hash of the rules
+      When the rule is combat
+      Given a character sheet for an ordinary drone
+      Given also a character sheet for a fit drone
+      Then apply the combat rule
+      Then display the character sheet
+
+   Scenario: romantic resistance application
+      Given a hash of the rules
+      When the rule is romance
+      Given a character sheet for an ordinary drone
+      Given a character sheet for teh hawt wimenz
+      Then apply the romance rule
+      
+   Scenario: romantic resistance odds
+      Given a hash of the rules
+      When the rule is romance
+      Given a character sheet for an ordinary drone
+      Given a character sheet for teh hawt wimenz
+      Then show the odds for the romance rule
+
+   Scenario: sense application
+      Given a hash of the rules
+      When the rule is sense
+      Given a character sheet for an ordinary drone
+      Given a character sheet for teh hawt wimenz
+      Given also a character sheet for a fit drone
+      Then apply the sense rule
+
+   Scenario: sense odds
+      Given a hash of the rules
+      When the rule is sense
+      Given a character sheet for an ordinary drone
+      Given a character sheet for teh hawt wimenz
+      Given also a character sheet for a fit drone
+      Then show the odds for the sense rule

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,168 @@
+Given /^this project is active project folder/ do
+  @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
+end
+
+Given /^env variable \$([\w_]+) set to "(.*)"/ do |env_var, value|
+  ENV[env_var] = value
+end
+
+Given /"(.*)" folder is deleted/ do |folder|
+  in_project_folder { FileUtils.rm_rf folder }
+end
+
+When /^I invoke "(.*)" generator with arguments "(.*)"$/ do |generator, arguments|
+  @stdout = StringIO.new
+  in_project_folder do
+    if Object.const_defined?("APP_ROOT")
+      APP_ROOT.replace(FileUtils.pwd)
+    else 
+      APP_ROOT = FileUtils.pwd
+    end
+    run_generator(generator, arguments.split(' '), SOURCES, :stdout => @stdout)
+  end
+  File.open(File.join(@tmp_root, "generator.out"), "w") do |f|
+    @stdout.rewind
+    f << @stdout.read
+  end
+end
+
+When /^I run executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "#{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I run project executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I run local executable "(.*)" with arguments "(.*)"/ do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin", executable))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When /^I invoke task "rake (.*)"/ do |task|
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  in_project_folder do
+    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+Then /^folder "(.*)" (is|is not) created/ do |folder, is|
+  in_project_folder do
+    File.exists?(folder).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then /^file "(.*)" (is|is not) created/ do |file, is|
+  in_project_folder do
+    File.exists?(file).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then /^file with name matching "(.*)" is created/ do |pattern|
+  in_project_folder do
+    Dir[pattern].should_not be_empty
+  end
+end
+
+Then /^file "(.*)" contents (does|does not) match \/(.*)\// do |file, does, regex|
+  in_project_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then /gem file "(.*)" and generated file "(.*)" should be the same/ do |gem_file, project_file|
+  File.exists?(gem_file).should be_true
+  File.exists?(project_file).should be_true
+  gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
+  project_file_contents = File.read(File.join(@active_project_folder, project_file))
+  project_file_contents.should == gem_file_contents
+end
+
+Then /^(does|does not) invoke generator "(.*)"$/ do |does_invoke, generator|
+  actual_output = File.read(@stdout)
+  does_invoke == "does" ?
+    actual_output.should(match(/dependency\s+#{generator}/)) :
+    actual_output.should_not(match(/dependency\s+#{generator}/))
+end
+
+Then /help options "(.*)" and "(.*)" are displayed/ do |opt1, opt2|
+  actual_output = File.read(@stdout)
+  actual_output.should match(/#{opt1}/)
+  actual_output.should match(/#{opt2}/)
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should contain(text)
+end
+
+Then /^I should see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should contain(text)
+end
+
+Then /^I should not see$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should_not contain(text)
+end
+
+Then /^I should see exactly$/ do |text|
+  actual_output = File.read(@stdout)
+  actual_output.should == text
+end
+
+Then /^I should see all (\d+) tests pass/ do |expected_test_count|
+  expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then /^I should see all (\d+) examples pass/ do |expected_test_count|
+  expected = %r{^#{expected_test_count} examples?, 0 failures}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then /^yaml file "(.*)" contains (\{.*\})/ do |file, yaml|
+  in_project_folder do
+    yaml = eval yaml
+    YAML.load(File.read(file)).should == yaml
+  end
+end
+
+Then /^Rakefile can display tasks successfully/ do
+  @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+  in_project_folder do
+    system "rake -T > #{@stdout} 2> #{@stdout}"
+  end
+  actual_output = File.read(@stdout)
+  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+end
+
+Then /^task "rake (.*)" is executed successfully/ do |task|
+  @stdout.should_not be_nil
+  actual_output = File.read(@stdout)
+  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+  actual_output.should_not match(/Error/i)
+end
+
+Then /^gem spec key "(.*)" contains \/(.*)\// do |key, regex|
+  in_project_folder do
+    gem_file = Dir["pkg/*.gem"].first
+    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+    spec_value = gem_spec.send(key.to_sym)
+    spec_value.to_s.should match(/#{regex}/)
+  end
+end