cukesalad 0.2.0

data/examples/Calculator/lib/calculator.rb

@@ -0,0 +1,53 @@
+
+class Calculator
+ 
+  attr_reader :display
+
+  def initialize
+    show 0
+    @operands = []
+  end
+  
+  def enter value
+    show value
+    @operands.push value
+  end
+
+  def get_ready_to op
+    calculate_if_necessary
+    start_next_calculation
+    @operator = op
+  end
+
+  def equals
+    we_need_two_operands
+    deal_with_repeated_equals
+    unless @operator.nil?
+      show @operands.inject (@operator)
+      @last_operator = @operator
+      @operator = nil
+      @operands[0] = @display
+    end
+  end
+
+  private
+  def show value
+    @display = value
+  end
+
+  def calculate_if_necessary
+    equals if @operands.size == 2
+  end
+  
+  def start_next_calculation
+    @operands = [@display] if @operator.nil?
+  end
+
+  def we_need_two_operands
+    @operands.concat @operands if @operands.size == 1
+  end
+  
+  def deal_with_repeated_equals
+    @operator = @last_operator if @operands.size == 2 && @operator.nil? && @last_operator
+  end
+end

data/examples/Calculator/lib/web_calculator.rb

@@ -0,0 +1,82 @@
+require 'sinatra/base'
+require 'erb'
+$:.unshift(File.dirname(__FILE__), '.')
+require 'calculator'
+
+Sinatra::Base.enable :inline_templates
+Sinatra::Base.enable :sessions
+
+class WebCalculator < Sinatra::Base
+
+  helpers do
+    def operate_with
+      { 'plus' => :+, 'minus' => :-}
+    end
+
+    def persist calc
+      session[:calc] = calc
+    end
+
+    def display_result_from calc
+      @display = calc.display
+      erb :index
+    end
+
+    def user_input
+      params[:number].to_i
+    end
+
+    def selected_operator
+      params[:operator]
+    end
+
+    def display_result_from_session
+      @display = session[:calc].display ||= 0
+      erb :index
+    end
+
+    def input_entered?
+      not params[:number].empty?
+    end
+
+    def equals_pressed?
+      selected_operator == "equals"
+    end
+
+    def load_calculator
+      session[:calc] ||= Calculator.new
+    end
+  
+  end
+
+  get '/' do
+    load_calculator
+    display_result_from_session
+  end
+
+  post '/' do
+    calculator = load_calculator 
+    calculator.enter user_input if input_entered?
+    if equals_pressed?
+      calculator.equals
+    else
+      calculator.get_ready_to operate_with[selected_operator]
+    end
+    persist calculator
+    display_result_from calculator
+  end
+end
+
+__END__
+@@ layout
+<h1>Calculator is Ready!</h1>
+<%= yield %>
+
+@@ index
+<form method="POST" action="/">
+  <input type="text" disabled name="display" id="display" value="<%=@display %>" />
+  <input type="text" name="number" id="number" />
+  <input type="submit" name="operator" id="minus" text="-" value="minus" />
+  <input type="submit" name="operator" id="plus" text="+" value="plus" />
+  <input type="submit" name="operator" id="equals" text="=" value="equals" />
+</form>

data/examples/Calculator/spec/calculator_spec.rb

@@ -0,0 +1,73 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'calculator'
+
+describe Calculator do
+
+  it "starts with zero" do
+    calc = Calculator.new
+
+    calc.display.should == 0
+  end
+
+  it "shows the current number" do
+    calc = Calculator.new
+    calc.enter 1
+
+    calc.display.should == 1
+  end
+
+  it "displays the same when equals alone is pressed" do
+    calc = Calculator.new
+    calc.enter 1
+
+    calc.equals
+
+    calc.display.should == 1
+  end
+
+  it "treats 1 + = like 1 + 1 =" do
+    calc = Calculator.new
+
+    calc.enter 1
+    calc.get_ready_to :+
+    calc.equals
+
+    calc.display.should == 2
+  end
+
+  it "repeats the last operation" do
+    calc = Calculator.new
+    calc.enter 1
+    calc.get_ready_to :+
+    calc.equals
+    calc.equals
+    calc.display.should == 3
+  end
+
+  it "starts again when you enter a number after equals" do
+    calc = Calculator.new
+    calc.enter 1
+    calc.get_ready_to :+
+    calc.enter 1
+    calc.equals
+    calc.enter 5
+    calc.get_ready_to :+
+    calc.equals
+    
+    calc.display.should == 10
+  end
+
+  it "calculate what it has so far" do
+    calc = Calculator.new
+    calc.enter 1
+    calc.get_ready_to :+
+    calc.enter 1
+    calc.get_ready_to :+ 
+
+    calc.display.should == 2
+  end
+
+end

data/examples/Calculator/spec/web_calculator_spec.rb

@@ -0,0 +1,99 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib/')
+require 'web_calculator'
+require 'capybara'
+require 'capybara/dsl'
+
+Capybara.app = WebCalculator
+Capybara.default_driver = :rack_test
+
+describe "WebCalculator", :type => :request do
+
+  include Capybara
+
+  before(:each) do
+    Capybara.reset_sessions! 
+  end
+
+  context "homepage" do
+    it "is successful" do
+      visit '/'
+      page.should have_content 'Calculator is Ready!'
+    end
+  end
+
+  def calculator_display
+    find_field('display').value.to_i
+  end
+
+  context "storing calculator display state" do
+    it "starts with nothing" do
+      visit '/'
+      calculator_display.should == 0
+    end
+
+    it "udpates the display when an operator is pressed" do
+      visit '/'
+      fill_in 'number', :with => '10'
+      click_button 'minus'
+      calculator_display.should == 10
+    end
+
+    it "updates the display when a different different operator is pressed" do
+      visit '/'
+      fill_in 'number', :with => '15'
+      click_button 'plus'
+      calculator_display.should == 15
+    end
+
+    it "updates the display when a sequence of operators are entered" do
+      visit '/'
+      fill_in 'number', :with => '1'
+      click_button 'plus'
+      fill_in 'number', :with => '1'
+      click_button 'plus'
+      calculator_display.should == 2 
+    end
+
+    it "persists the display between requests" do
+      visit '/'
+      fill_in 'number', :with => '15'
+      click_button 'plus'
+      calculator_display.should == 15
+      visit '/'
+      calculator_display.should == 15
+    end
+  end
+
+  context "doing simple arithmetic" do
+    it "adds two numbers" do
+      visit '/'
+      fill_in 'number', :with => '1'
+      click_button 'plus'
+      fill_in 'number', :with => '0'
+      click_button 'equals'
+      calculator_display.should == 1
+    end
+    
+    it "adds two of the same number" do
+      visit '/'
+      fill_in 'number', :with => '1'
+      click_button 'plus'
+      fill_in 'number', :with => '1'
+      click_button 'equals'
+      calculator_display.should == 2
+    end
+  end
+
+  context "doing meta calculations" do
+    it "allows double equals calculator functionality" do
+      visit '/'
+      fill_in 'number', :with => '1'
+      click_button 'plus'
+      click_button 'equals'
+      calculator_display.should == 2
+      click_button 'equals'
+      calculator_display.should == 3
+    end
+  end
+
+end

data/features/a_new_cukesalad_project.feature

@@ -0,0 +1,34 @@
+Feature: Cuke Salad
+  As a Step Free Cuker
+  You want to set up your project to use use Cuke Salad 
+  So that you can start writing scenarios without step definitions 
+
+  Scenario: Set up your project and verify that you can use CukeSalad
+    Given you are a Step Free Cuker
+    And   you were able to create directories: as follows
+    """
+    features
+    features/lib
+    features/lib/roles
+    features/lib/tasks
+    features/support
+    """
+    And you were able to create a file: at 'features/support/env.rb' containing
+      """
+      $:.unshift(File.dirname(__FILE__) + "/../../../../lib") #where to find CukeSalad
+             
+      require "cukesalad"
+      """
+    And you were able to create a file: at 'features/hello_cukesalad.feature' containing
+      """
+      Feature: Hello CukeSalad
+  
+        Scenario: Greetings
+          When I say hello CukeSalad
+      """ 
+    When you attempt to run: the command 'cucumber'  
+    Then  you should see a reply that includes:
+    """
+    CukeSalad says: Hello!!
+    """
+   And  you should see it has 'passed'

data/features/define_a_role.feature

@@ -0,0 +1,31 @@
+Feature: Define the Role
+  As a Step Free Cuker
+  You want to define a role
+  So that you are ready to explain the tasks 
+
+  Background:
+    Given you are a Step Free Cuker
+    And   you were able to create a new Cuke Salad project
+
+  Scenario: We'll tell you what you need to do to establish the role
+    Given you did not create a role: called 'NewCustomer'
+    When  you attempt to run a scenario: containing
+      """
+      Given I am a New Customer
+      """
+    Then you should see it has 'failed'
+    And  you should see a reply that includes:
+      """
+            I can't find a role called 'NewCustomer'. Have you created it?
+            e.g.
+              module NewCustomer
+              end
+      """
+
+  Scenario: Once you've created the role, you see the step pass
+    Given you did create a role: called 'NewCustomer'
+    When  you attempt to run a scenario: containing
+    """
+    Given I am a New Customer
+    """
+    Then you should see it has 'passed'

data/features/define_a_task.feature

@@ -0,0 +1,55 @@
+Feature: Define the Task
+  As a Step Free Cuker
+  You want to describe a task
+  So that your steps that use that role are executed 
+
+
+  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: We'll tell you what you need to do to describe the task
+    Given you did not create a task: called 'do something'
+    When  you attempt to run a scenario: containing
+      """
+      Given I am a New Customer
+      And I was able to do something
+      """
+    Then you should see it has 'failed'
+    And  you should see a reply that includes:
+      """
+            I can't find a task called 'do something'. Have you created it?
+            e.g.
+              in_order_to 'do something' do
+                # the actions
+              end
+      """
+
+  Scenario Outline: Once you've created the task, you see the step pass
+    Given you did create a task: called 'do something'
+    When  you attempt to run a scenario: containing
+    """
+    Given I am a New Customer
+    <step using the task>
+    """
+    Then you should see it has 'passed'
+
+    Examples:
+      | step using the task                 |
+      | Given I was able to do something    |
+      | And   I was able to do something    |
+      | But   I did do something            |
+      | Given you were able to do something |
+      | And   you were able to do something |
+      | But   you did do something          |
+      | When  I attempt to do something     |
+      | And   I attempt to do something     |
+      | And   I did do something            |
+      | When  you attempt to do something   |
+      | And   you attempt to do something   |
+      | And   you did do something          |
+      | Then  I should do something         |
+      | And   I should do something         |
+      | Then  you should do something       |
+      | And   you should do something       |

data/features/lib/roles/step_free_cuker.rb

@@ -0,0 +1,5 @@
+require 'aruba/api'
+#TODO: Consider wrapping Aruba 
+module StepFreeCuker
+  include Aruba::Api
+end

data/features/lib/tasks/create_a_file.rb

@@ -0,0 +1,3 @@
+in_order_to "CreateAFile", at: :path, containing: :content do
+  write_file( the(:path), the(:content ))
+end

data/features/lib/tasks/create_a_new_cukesalad_project.rb

@@ -0,0 +1,11 @@
+#TOOO: consider doing this as a feature since it's part of how you set up the project.
+in_order_to "CreateANewCukeSaladProject" do
+  create_dir 'features'
+  create_dir 'features/support'
+  write_file 'features/support/env.rb', "$:.unshift(File.dirname(__FILE__) + '/../../../../lib') #where to find CukeSalad
+             
+             require 'cukesalad'"
+  create_dir 'features/lib'
+  create_dir 'features/lib/roles'
+  create_dir 'features/lib/tasks'
+end

data/features/lib/tasks/create_a_role.rb

@@ -0,0 +1,4 @@
+#TODO: Consider exposing this detail in the examples since it shows you what to do
+in_order_to 'create a role', called: :name_of_role do
+  write_file 'features/lib/roles/my_role.rb', "module #{the :name_of_role}\nend"
+end

data/features/lib/tasks/create_a_task.rb

@@ -0,0 +1,4 @@
+#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"
+end

data/features/lib/tasks/create_directories.rb

@@ -0,0 +1,5 @@
+in_order_to "CreateDirectories", as_follows: :several_directories do
+  the( :several_directories ).split( " " ).each do | path |
+    create_dir path
+  end
+end

data/features/lib/tasks/not_create_a_role.rb

@@ -0,0 +1,2 @@
+in_order_to "NotCreateARole" do # Nothing!
+end

data/features/lib/tasks/not_create_a_task.rb

@@ -0,0 +1,3 @@
+in_order_to 'not create a task' do
+  # Nothing
+end

data/features/lib/tasks/run.rb

@@ -0,0 +1,4 @@
+in_order_to "Run", the_command: :command do
+  run_simple unescape( the :command )
+end
+

data/features/lib/tasks/run_a_scenario.rb

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

data/features/lib/tasks/see_a_reply.rb

@@ -0,0 +1,3 @@
+in_order_to "SeeAReply" do
+  all_output 
+end

data/features/lib/tasks/see_the_step_has.rb

@@ -0,0 +1,4 @@
+in_order_to "SeeItHas" do
+  outcome = {1 => "failed", 0 => "passed"}
+  outcome[@last_exit_status]
+end

data/features/support/env.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__) + '/../../lib') #where to find CukeSalad
+
+require 'cukesalad'
+
+After do
+  FileUtils.rm_rf 'tmp'
+end

data/lib/actor.rb

@@ -0,0 +1,32 @@
+require 'specifics'
+require 'director'
+
+class Actor
+  include Specifics
+
+  def initialize this_type_of_role, directed_by=Director.new
+    @director = directed_by
+    get_into_character_for this_type_of_role
+  end
+  
+  def perform described_task, *details
+    get_ready_to_perform described_task
+    understand_the *details unless details.empty?
+    perform_task 
+  end
+  alias :answer :perform
+
+  def get_into_character_for described_role
+    the_role = @director.explain_the_role described_role
+    see_how_to_do the_role
+  end
+  
+  def get_ready_to_perform something
+    the_thing = @director.how_do_i_perform something
+    see_how_to_do the_thing 
+  end
+
+  def see_how_to_do something
+    extend something
+  end
+end

data/lib/codify/const_name.rb

@@ -0,0 +1,21 @@
+module Codify
+  module ConstName
+    def ConstName.from sentence
+      joined_together capitalised( words_from sentence )
+    end
+    
+    private
+    def ConstName.joined_together words
+      words.join
+    end
+    
+    def ConstName.words_from this_sentence
+      on_word_boundary = /\s|([A-Z][a-z]+)/
+      this_sentence.split( on_word_boundary )
+    end
+
+    def ConstName.capitalised words
+      words.collect{ | word | word.capitalize }
+    end
+  end
+end

data/lib/cukesalad.rb

@@ -0,0 +1,33 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'rubygems'
+require 'bundler'
+require 'actor'
+require 'task_author'
+Bundler.setup
+
+When /^I say hello CukeSalad$/ do 
+  puts "CukeSalad says: Hello!!"
+end
+
+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 |
+  with_these_details ||= ""
+  with_these_details << " '#{and_more[0]}'" unless and_more.empty?
+  @actor.perform this_task, with_these_details unless with_these_details.nil?
+  @actor.perform this_task if with_these_details.nil?
+end
+
+Then /^(?:I|you) should ([^':]*)(?: '([^']*)')$/ do | this_question, expect_value |
+  @actor.answer( this_question ).to_s.should == expect_value
+end
+
+Then /^(?:I|you) should ([^':]+)$/ do | this_question |
+  @actor.answer( this_question )
+end
+
+Then /^(?:I|you) should ([^']*) that includes:$/ do | this_question, expected_content |
+  @actor.answer( this_question ).should include( expected_content )
+end

data/lib/director.rb

@@ -0,0 +1,28 @@
+require 'codify/const_name'
+class Director
+
+  include Codify
+ 
+  #TODO: Needs refactoring 
+  def explain_the_role description
+    name = ConstName.from description
+    begin
+      find_directives_for name
+    rescue NameError
+      raise "I can't find a role called '#{ name }'. Have you created it?\ne.g.\n  module #{ name }\n  end"
+    end
+  end
+
+  def how_do_i_perform something
+    name = ConstName.from something
+    begin
+      find_directives_for name
+    rescue NameError
+      raise "I can't find a task called '#{ something }'. Have you created it?\ne.g.\n  in_order_to '#{ something }' do\n    # the actions\n  end" 
+    end
+  end
+
+  def find_directives_for something
+    Kernel.const_get( something )
+  end
+end

data/lib/specifics.rb

@@ -0,0 +1,30 @@
+module Specifics
+  def understand_the details
+    @info = with_specifics_from( details )
+  end
+  
+  def value_of(symbol)
+    @info[symbol]
+  end
+
+  def with_specifics_from details
+    result = {}
+    names_and_values_in(details).each_slice(2) do |name_value| 
+      result[symbolized name_value[0]] = the_value_from_the name_value[1]
+    end
+    result
+  end
+
+  def names_and_values_in details
+    specifics_pattern = /('[^']+')/
+    details.split(specifics_pattern)
+  end
+
+  def symbolized name
+    name.strip.gsub(' ', '_').to_sym
+  end
+
+  def the_value_from_the item 
+    item.gsub(/(^'|'$)/, '')
+  end
+end

data/lib/task_author.rb

@@ -0,0 +1,12 @@
+require 'codify/const_name'
+def in_order_to do_something, *with_attributes, &actions
+  attr_map = with_attributes[0]
+  name = Codify::ConstName.from do_something
+  m = Module.new do
+    define_method :perform_task, &actions
+    define_method :the do | value |
+      value_of( attr_map.key value )
+    end
+  end
+  Kernel.const_set name, m
+end