docs/classes/Scenario.html docs/classes/Scenario.src/M000005.html docs/classes/Scenario/Base.html docs/classes/Scenario/Base.src/M000013.html docs/classes/Scenario/Base.src/M000014.html docs/classes/Scenario/Base.src/M000015.html docs/classes/Scenario/Base.src/M000016.html docs/classes/Scenario/Base.src/M000017.html docs/classes/Scenario/Base.src/M000018.html docs/classes/Scenario/Base.src/M000019.html docs/classes/Scenario/Base.src/M000020.html docs/classes/Scenario/Config.html docs/classes/Scenario/Config.src/M000012.html docs/classes/Scenario/InvalidScenario.html docs/classes/Scenario/Loaders.html docs/classes/Scenario/Loaders.src/M000006.html docs/classes/Scenario/TableMethods.html docs/classes/Scenario/TableMethods.src/M000007.html docs/classes/Scenario/TableMethods.src/M000008.html docs/classes/Scenario/TableMethods.src/M000009.html docs/classes/Scenario/TableMethods.src/M000010.html docs/classes/Scenario/TableMethods.src/M000011.html docs/classes/Scenarios.html docs/classes/Scenarios/DSL.html docs/classes/Scenarios/DSL/ClassMethods.html docs/classes/Scenarios/DSL/ClassMethods.src/M000004.html docs/classes/Scenarios/DSL/ExampleExtensions.html docs/classes/String.html docs/classes/String.src/M000003.html docs/classes/Symbol.html docs/classes/Symbol.src/M000002.html docs/created.rid docs/files/LICENSE.html docs/files/README.html docs/files/lib/scenarios/dsl/extensions/behaviour_rb.html docs/files/lib/scenarios/dsl/extensions/example_rb.html docs/files/lib/scenarios/dsl/extensions_rb.html docs/files/lib/scenarios/dsl/extensions_rb.src/M000001.html docs/files/lib/scenarios/extensions/string_rb.html docs/files/lib/scenarios/extensions/symbol_rb.html docs/files/lib/scenarios/extensions_rb.html docs/files/lib/scenarios_rb.html docs/fr_class_index.html docs/fr_file_index.html docs/fr_method_index.html docs/index.html docs/rdoc-style.css @@ -1,5 +1,3 @@ -== MIT License - Copyright (c) 2007, Adam Williams and John W. Long. Permission is hereby granted, free of charge, to any person obtaining a copy LICENSE @@ -127,8 +127,8 @@ use a specific scenario. For more information, I'd recommend that you study the source. The specs and example scenarios are probably good places to start: -http://faithfulcode.rubyforge.org/svn/plugins/trunk/scenarios/spec/scenarios_spec.rb -http://faithfulcode.rubyforge.org/svn/plugins/trunk/scenarios/spec/scenarios/ +* http://faithfulcode.rubyforge.org/svn/plugins/trunk/scenarios/spec/scenarios_spec.rb +* http://faithfulcode.rubyforge.org/svn/plugins/trunk/scenarios/spec/scenarios == License README @@ -1,6 +1,7 @@ require 'rubygems' gem 'rake' require 'rake' +require 'rake/rdoctask' require 'yaml' require "#{File.dirname(__FILE__)}/spec/environment" @@ -73,5 +74,13 @@ namespace :spec do end end end + +Rake::RDocTask.new(:docs) do |r| + r.title = "Rails Scenarios Plugin" + r.main = "README" + r.options << "--line-numbers" + r.rdoc_files.include("README", "LICENSE", "lib/**/*.rb") + r.rdoc_dir = "docs" +end task :default => :spec \ No newline at end of file Rakefile @@ -30,18 +30,20 @@ module Scenario blasted_tables << name end - # Inserts a record into the database. + # Inserts a record into the database. And adds the appropriate table + # reader helpers into the scenario and spec. # # create_record :event, :one, :name => "Showdown" # create_record :event, :name => "Showdown" # - # The first form will assign the returned record id to the provided _symbolic_name_, - # so that in your tests you may invoke something like this: + # The first form will assign the returned record id to the provided + # _symbolic_name_, so that in your tests you may invoke something like + # this: # # events(:one) # - # The second form will not remember the record id, so the events method will not - # be able to answer that record. + # The second form will not remember the record id, so the events method + # will not be able to answer that record. def create_record(class_name, *args) symbolic_name, attributes = extract_creation_arguments(args) table_name = class_name.to_s.pluralize lib/scenarios.rb f94ddada7982317f329f2d44b2388e7c5e7248a8 John Long me@johnwlong.com http://github.com/aiwilliams/scenarios/commit/a52b41f668a6b8a3a64aa4f7535f3a59ed4dae46 a52b41f668a6b8a3a64aa4f7535f3a59ed4dae46 2007-10-18T06:44:00-07:00 2007-10-18T06:44:00-07:00 scenarios: first pass at RDocs e9d2957a303b84c6bcfecbb5b86e69f90d6fc6cf John Long me@johnwlong.com