cukesalad 0.5.0 → 0.6.0

data/Examples/Calculator/Gemfile

@@ -1,6 +1,6 @@
 source :rubygems
 gem "cucumber", "0.10.0"
-gem "cukesalad", ">=0.3.0"
+gem "cukesalad", "0.6"
 gem "rspec", "2.5.0", :require => 'spec'
 gem "capybara", "0.4.1.2"
 gem "sinatra", "1.2.0"

data/Examples/Calculator/Gemfile.lock

@@ -24,7 +24,7 @@ GEM
       gherkin (~> 2.3.2)
       json (~> 1.4.6)
       term-ansicolor (~> 1.0.5)
-    cukesalad (0.3.0)
+    cukesalad (0.6.0)
       aruba (= 0.3.5)
       cucumber (= 0.10.0)
       rspec (= 2.5.0)
@@ -70,6 +70,6 @@ PLATFORMS
 DEPENDENCIES
   capybara (= 0.4.1.2)
   cucumber (= 0.10.0)
-  cukesalad (>= 0.3.0)
+  cukesalad (= 0.6)
   rspec (= 2.5.0)
   sinatra (= 1.2.0)

data/Examples/Calculator/features/addition.feature

@@ -6,7 +6,7 @@ Feature: Addition
 Scenario Outline: Find the sum of two numbers
   Given I am a Calculating Individual
   And I was able to switch on the calculator
-  When I attempt to add: the number '<first_number>' to the number '<second_number>'
+  When I attempt to add: the number '<first_number>' and the number '<second_number>'
   Then I should see the answer '<result>'
 
 	

data/Examples/Calculator/features/complex_calculations.feature

@@ -6,7 +6,7 @@ Feature: Complex Calculations
 Scenario Outline: Get the result of a more complex calculation
   Given I am a calculating individual
   And I was able to switch on the calculator
-  When I attempt to calculate: with the following '<calculation>'
+  When I attempt to calculate, with the following '<calculation>'
   Then I should see the answer '<correct_result>'
 
 Examples:

data/Examples/Calculator/features/lib/default/tasks/add.rb

@@ -1,11 +1,4 @@
-# This demonstrates how to use an attribute mapping 
-#  to make the interactions within the task read more naturally
-# In the scenario it might say "add: the number '5', to the number '10'
-# The form illustrated below simply maps the elements the_number and to_the_number
-#  to alternative symbols that make the interactions read more like real instructions
-# See subtract.rb for a way of writing tasks that reuses the common interactions 
-# required to perform calculations.
-in_order_to 'add', the_number: :first_number, to_the_number: :second_number do
+in_order_to 'add', the_number: :first_number, and_the_number: :second_number do
     enter the :first_number 
     press :plus
     enter the :second_number 

data/Examples/Calculator/features/lib/default/tasks/switch_on_the_calculator.rb

@@ -2,7 +2,7 @@ in_order_to "switch on the calculator" do
   require 'rspec/expectations'
   extend RSpec::Matchers
   
-  @calc = switch_on_the_calculator
+  switch_on_the_calculator
   self.should respond_to :enter
   self.should respond_to :press
   self.should respond_to :look_at_the_display

data/Examples/Calculator/features/subtraction.feature

@@ -6,7 +6,7 @@ Feature: Subtraction
 Scenario Outline: Find the result of subtracting two numbers
   Given I am a Calculating Individual
   And I was able to switch on the calculator
-  When I attempt to subtract: the number '<subtractor>' from the number '<subtractee>'
+  When I attempt to subtract, the number '<subtractor>' from the number '<subtractee>'
   Then I should see the answer '<result>'
 
 	

data/README.md

@@ -75,7 +75,7 @@ Create a new file, `features/lib/tasks/switch_on_the_calculator.rb`
 Remember the step `When  I attempt to switch on the calculator`
 
     in_order_to "switch on the calculator" do
-      @calc = switch_on_the_calculator
+      switch_on_the_calculator
     end
 
 Remember the step `Then  I should see the answer '0'`
@@ -110,7 +110,7 @@ You'll need a class called Calculator on the load path of course, but that's it.
 
 From your project folder, run (_note: '%' is our command prompt_)
 
-  % cucumber
+    % cucumber
 
 We now have our first passing Feature, without creating a single step definition!
 
@@ -121,30 +121,34 @@ Let's try another scenario...
     Scenario Outline: Find the sum of two numbers
       Given I am a Calculating Individual
       And I was able to switch on the calculator
-      When I attempt to add: the number '10' to the number '10'
+      When I attempt to add: the number '10' and the number '10'
       Then I should see the answer '20'
 
 Notice that we've reused 'switch on the calculator'.
 
 The new _When_ step has a slightly different layout.
-Let's examine that for a second... Notice the ':' (colon) after <do something> and the name-value pairs:
+Let's examine that for a second... See below. Notice the ':' (colon) after `<do something>` followed by the name-value pairs:
 
     When I attempt to <do something>: <name> '<value>' <name> '<value>'
 
-You can have as many name-value pairs as you like.
+You can also use a ',' (comma) in situations where a colon wouldn't quite work:
+
+    When I attempt to <do something>, <name> '<value>' <name> '<value>'
 
-So, we need a task called `tasks/add.rb` that explains the individual actions required to complete the task:
+`<do something>` can be as many words as you like. You can have as many name-value pairs as you like.
+
+For this to work we need a task called `tasks/add.rb` that explains the individual actions required to complete the task:
 
     in_order_to "add" do
       enter @value_of(:the_number)
       press :plus
-      enter @value_of(:to_the_number)
+      enter @value_of(:and_the_number)
       press :equals
     end
 
 Notice how the `value_of` lines use symbols that correspond to the wording `'the number '10' to the number '10'` in the "When" step.
 
-There is some 'syntactic sugar' that we can use to dress this up a little and make it read nicer... a simple attribute mapping:
+There is some 'syntactic sugar' that we can use to dress this up a little and make it read nicer... a simple attribute mapping (using Ruby 1.9.x syntax):
 
     in_order_to "add", the_number: :first_number, to_the_number: :second_number do
         enter the :first_number
@@ -153,9 +157,9 @@ There is some 'syntactic sugar' that we can use to dress this up a little and ma
         press :equals
     end
 
-All we've done is mapped "the_number" to "first_number". There is a special method called "the" that allows you to reference the mapped values rather than the symbols derived from the scenario.
+All we've done is mapped `:the_number` to `:first_number` and `:to_the_number` to `:second_number`. There is a special method called "the" that allows you to reference the mapped values rather than the symbols derived from the scenario.
 
-Now all we need to do is modify our `calculating_individual.rb` to receive those calls...
+Now all we need to do is create the corresponding methods in `calculating_individual.rb`.
 
     module CalculatingIndividual
 
@@ -188,6 +192,8 @@ Now all we need to do is modify our `calculating_individual.rb` to receive those
       end
     end
 
+Of course you'll have to [implement the calculator too](https://github.com/RiverGlide/CukeSalad/blob/master/Examples/Calculator/lib/calculator.rb)
+
 Now, you can run cucumber again:
 
     % cucumber
@@ -196,14 +202,74 @@ There's no need to write `step_definitions`...
 Simply express the _roles_ and the _tasks_ in clear,
 concise, easy to read classes.
 
-After adding some more scenarios and tasks and an alternative "Calculating Individual" (see below for why), our finished Calculator directory structure looks like this...
+If we want to know what things we can say, instead of trawling through a step-def ruby file, we can look in our tasks folder:
+
+    features/lib/default/tasks/
+    ├── add.rb
+    ├── calculate.rb
+    ├── calculations.rb
+    ├── see_the_answer.rb
+    ├── subtract.rb
+    └── switch_on_the_calculator.rb
+
+You can structure your tasks as you see fit. For example, as the project grows, it might end up looking like this:
+
+    features/lib/default/tasks/
+    ├── all_purpose
+    |   └── calculate.rb
+    ├── arithmetic
+    |   ├── add.rb
+    |   ├── divide.rb
+    |   ├── multiply.rb
+    |   └── subtract.rb
+    ├── extras
+    |   ├── recall_from_memory.rb
+    |   ├── store_in_memory.rb
+    |   └── switch_on_the_calculator.rb
+    ├── questions
+    |   ├── see_the_answer.rb
+    |   ├── see_the_following_indicators.rb
+    |   └── switch_on_the_calculator.rb
+    ├── trigonometry
+    |   ├── sine.rb
+    |   ├── cosine.rb
+    |   └── tangent.rb
+    └── reference_material
+        └── calculations.rb
+
+## Alternative Roles
+
+As our features _describe the value of a calculator application and not its
+implementation_, we have the opportunity to reuse them.
+
+In the Calculator example, we create a new _role_ in
+`./features/lib/alternative/roles/calculating_web_user.rb`, which we can swap
+into our tests using a Cucumber profile defined in `features/cucumber.yml`:
+
+    default --exclude features/lib/alternative/
+    alternative -r features/lib/alternative/ -r features/support/env.rb -r features/lib/default/tasks/
+
+We can run our alternative configuration like so:
+
+  `%cucumber --profile alternative`
+
+The Calculating Web User masquerades as the Calculating Individual from our
+previous example, and provides the same API, allowing us to reuse all of our
+existing features and _tasks_.
+
+The alternative, `./lib/web_calculator.rb`, implementation is a simple [Sinatra](http://www.sinatrarb.com) application,
+which we drive with the [Capybara](http://github.com/jnicklas/capybara) web testing framework.
+
+By writing a single new _role_ class we're able to reuse all of our existing features,
+_tasks_ and even the `Calculator` itself, which the web calculator delegates to in order to do its calculations.
+
+After adding some more scenarios and tasks and an alternative "Calculating Individual" (see below for why), our Calculator directory structure currently looks like this...
 
     ├── cucumber.yml
     ├── features
     │   ├── A_PlaceToStart.feature
     │   ├── Addition.feature
     │   ├── Complex_calculations.feature
-    │   ├── LOOK_MA_NO_STEP_DEFS.txt
     │   ├── Subtraction.feature
     │   ├── Typical_workflow.feature
     │   ├── lib
@@ -230,29 +296,3 @@ After adding some more scenarios and tasks and an alternative "Calculating Indiv
         └── web_calculator_spec.rb
 
 Take a look around the examples and the code to see how it all works. We hope you enjoy reading as much as we enjoyed writing it.
-
-## Alternative Roles
-
-As our features _describe the value of a calculator application and not its
-implementation_, we have the opportunity to reuse them.
-
-In the Calculator example, we create a new _role_ in
-`./features/lib/alternative/roles/calculating_web_user.rb`, which we can swap
-into our tests using a Cucumber profile defined in `features/cucumber.yml`:
-
-    default --exclude features/lib/alternative/
-    alternative -r features/lib/alternative/ -r features/support/env.rb -r features/lib/default/tasks/
-
-We can run our alternative configuration like so:
-
-  `%cucumber --profile alternative`
-
-The Calculating Web User masquerades as the Calculating Individual from our
-previous example, and provides the same API, allowing us to reuse all of our
-existing features and _tasks_.
-
-The alternative, `./lib/web_calculator.rb`, implementation is a simple [Sinatra](http://www.sinatrarb.com) application,
-which we drive with the [Capybara](http://github.com/jnicklas/capybara) web testing framework.
-
-By writing a single new _role_ class we're able to reuse all of our existing features,
-_tasks_ and even the `Calculator` itself, which the web calculator delegates to in order to do its calculations.

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/examples/Calculator/features/lib/default/tasks/add.rb

@@ -1,11 +1,4 @@
-# This demonstrates how to use an attribute mapping 
-#  to make the interactions within the task read more naturally
-# In the scenario it might say "add: the number '5', to the number '10'
-# The form illustrated below simply maps the elements the_number and to_the_number
-#  to alternative symbols that make the interactions read more like real instructions
-# See subtract.rb for a way of writing tasks that reuses the common interactions 
-# required to perform calculations.
-in_order_to 'add', the_number: :first_number, to_the_number: :second_number do
+in_order_to 'add', the_number: :first_number, and_the_number: :second_number do
     enter the :first_number 
     press :plus
     enter the :second_number 

data/examples/Calculator/features/lib/default/tasks/switch_on_the_calculator.rb

@@ -2,7 +2,7 @@ in_order_to "switch on the calculator" do
   require 'rspec/expectations'
   extend RSpec::Matchers
   
-  @calc = switch_on_the_calculator
+  switch_on_the_calculator
   self.should respond_to :enter
   self.should respond_to :press
   self.should respond_to :look_at_the_display

data/features/lib/tasks/create_a_task.rb

@@ -1,4 +1,12 @@
-#TODO: Consider exposing this detail in the examples since it shows you what to do
-in_order_to 'create a task', called: :name_of_task do
-  write_file 'features/lib/tasks/some_task.rb', "in_order_to '#{the :name_of_task}' do\nend"
+in_order_to 'create a task', called: :name_of_task, containing: :code do
+    file_name = the( :name_of_task ).gsub(" ", "_")
+    
+    default_content = 
+      "in_order_to '#{the :name_of_task}' do
+        #nothing 
+      end" 
+    content = the :code
+    content = default_content if content.nil?
+
+    write_file "features/lib/tasks/#{file_name}.rb", content
 end

data/features/lib/tasks/not_previously_take_note_of_something.rb

@@ -0,0 +1,3 @@
+in_order_to 'not previously take note of something' do
+  # nothing 
+end 

data/features/lib/tasks/run_a_scenario.rb

@@ -1,7 +1,7 @@
-in_order_to "RunAScenario", containing: :step do
+in_order_to "RunAScenario", containing: :steps do
   write_file 'features/a.feature', "Feature: A Feature
 
   Scenario: A Scenario
-    #{the :step}"
+    #{the :steps}"
   run_simple unescape( 'cucumber features/a.feature' ), false
 end

data/features/remember_information_between_steps.feature

@@ -0,0 +1,50 @@
+Feature: Remember information between steps
+  As a Step Free Cuker
+  I want information captured in one step to be available in a later step
+  So that I can deal with situations where dynamic information is required in later steps
+
+  Background:
+    Given you are a Step Free Cuker
+    And   you were able to create a new Cuke Salad project
+    And   you were able to create a role: called 'NewCustomer'
+
+  Scenario: You can reuse information
+    Given you were able to create a task, called 'do something' containing
+      """
+      in_order_to 'do something', remembering: :value do
+        take_note_of :some_key, the( :value )
+      end
+      """
+    And you were able to create a task, called 'find that the thing remembered was' containing
+      """
+      in_order_to 'find that the thing remembered was' do
+        recall :some_key
+      end
+      """
+    When you attempt to run a scenario: containing
+      """
+      Given I am a New Customer
+      When I attempt to do something, remembering 'a value'
+      Then I should find that the thing remembered was 'a value'
+      """
+    Then you should see it has 'passed'
+
+  Scenario: You'll get feedback if you ask for something that wasn't noted
+    Given you did not previously take note of something
+    And you were able to create a task, called 'find that the thing remembered was' containing
+    """
+    in_order_to 'find that the thing remembered was' do
+      recall :some_key
+    end
+    """
+    When I attempt to run a scenario: containing
+      """
+      Given I am a New Customer
+      Then I should find that the thing remembered was 'a value'
+      """
+    Then I should see it has 'failed'
+    And I should see a reply that includes:
+      """
+            You tried to recall ':some_key' but no previous step appears to have taken note of that information
+      """
+

data/lib/actor.rb

@@ -1,10 +1,11 @@
 require 'director'
 
 class Actor
-
+   
   def initialize this_type_of_role, directed_by=Director.new
     @director = directed_by
     get_into_character_for this_type_of_role
+    @note_pad = {}
   end
   
   def perform described_task, details = {}
@@ -31,4 +32,16 @@ class Actor
   def value_of(symbol)
     @info[symbol]
   end
+
+  def take_note_of key, value
+   @note_pad.store key, value
+  end
+
+  def recall key
+    begin
+      @note_pad.fetch key
+    rescue KeyError
+      raise KeyError, "You tried to recall ':#{key}' but no previous step appears to have taken note of that information."
+    end
+  end
 end

data/lib/cukesalad.rb

@@ -16,8 +16,8 @@ Given /^(?:I am|you are) a ([a-zA-Z ]+)$/ do |role|
   @actor = Actor.new(role)
 end
 
-When /^(?:I|you) (?:attempt to|was able to|were able to|did)? ([A-Z a-z_-]*)(?:[:|,] (.*))?$/ do | this_task, with_these_details, *and_more |
-  info = understand_the with_these_details unless with_these_details.nil?
+When /^(?:I|you) (?:attempt to|was able to|were able to|did)? ([A-Z a-z_-]*)(?:[:|,] (.*))?:?$/ do | this_task, details, *and_more |
+  info = understand_the details unless details.nil?
   info[info.keys.last] = and_more[0] unless and_more.empty?
   @actor.perform this_task, info unless info.nil?
   @actor.perform this_task if info.nil?

data/spec/actor_spec.rb

@@ -33,8 +33,8 @@ end
 describe Actor do
 
   it "gets into character" do
-    director = double("director")
     role_description = "Butler"
+    director = double("director")
     director.should_receive( :explain_the_role ).with( role_description ).and_return( Butler )
     
     actor = Actor.new role_description, director
@@ -68,5 +68,29 @@ describe Actor do
 
     actor.perform( task_description, details ).should == 5
   end
+
+  it "can take note of information" do
+    role_description = "Butler"
+    
+    director = double("director")
+    director.should_receive( :explain_the_role ).with( role_description ).and_return( Butler )
+
+    actor = Actor.new role_description, director
+
+    actor.take_note_of :something, "of importance"
+    actor.recall( :something ).should == "of importance"
+  end
+
+  it "tells you when it can't find the information you're looking for" do
+    role_description = "Butler"
+    
+    director = double("director")
+    director.should_receive( :explain_the_role ).with( role_description ).and_return( Butler )
+
+    actor = Actor.new role_description, director
+
+    lambda {actor.recall( :something )}.should raise_error KeyError, 
+      "You tried to recall ':something' but no previous step appears to have taken note of that information."
+  end
 end
 

metadata

@@ -2,7 +2,7 @@
 name: cukesalad
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - RiverGlide
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-21 00:00:00 Z
+date: 2011-04-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cucumber
@@ -121,10 +121,12 @@ files:
 - features/lib/tasks/create_directories.rb
 - features/lib/tasks/not_create_a_role.rb
 - features/lib/tasks/not_create_a_task.rb
+- features/lib/tasks/not_previously_take_note_of_something.rb
 - features/lib/tasks/run.rb
 - features/lib/tasks/run_a_scenario.rb
 - features/lib/tasks/see_a_reply.rb
 - features/lib/tasks/see_the_step_has.rb
+- features/remember_information_between_steps.feature
 - features/support/env.rb
 - lib/actor.rb
 - lib/codify/const_name.rb
@@ -166,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2598108803398810333
+      hash: -826541078781353768
       segments: 
       - 0
       version: "0"