cukesalad 0.6.0 → 0.6.1

data/lib/cukesalad/codify/const_name.rb

@@ -0,0 +1,23 @@
+module CukeSalad
+  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
+end

data/lib/cukesalad/cucumber.rb

@@ -0,0 +1,35 @@
+require 'cukesalad'
+
+def in_order_to(do_something, *with_attributes, &actions)
+ CukeSalad::TaskAuthor.in_order_to(do_something, *with_attributes, &actions)
+end
+
+World(CukeSalad::TaskAuthor)
+World(CukeSalad::Specifics)
+
+When /^I say hello CukeSalad$/ do
+  puts "CukeSalad says: Hello!!"
+end
+
+Given /^(?:I am|you are) a ([a-zA-Z ]+)$/ do |role|
+  @actor = CukeSalad::Actor.new(role)
+end
+
+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?
+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/cukesalad/director.rb

@@ -0,0 +1,30 @@
+require 'cukesalad/codify/const_name'
+module CukeSalad
+  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
+end

data/lib/cukesalad/salad.rb

@@ -0,0 +1,3 @@
+require 'cukesalad/actor'
+require 'cukesalad/task_author'
+require 'cukesalad/specifics'

data/lib/cukesalad/specifics.rb

@@ -0,0 +1,36 @@
+module CukeSalad
+  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 set_last value
+      @info[@info.keys.last] = value
+    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(/(^'|'$)/, '') unless item.nil?
+    end
+  end
+end

data/lib/cukesalad/task_author.rb

@@ -0,0 +1,21 @@
+require 'cukesalad/codify/const_name'
+module CukeSalad
+  module TaskAuthor
+
+    def in_order_to do_something, *with_attributes, &actions
+      TaskAuthor.in_order_to do_something, *with_attributes, &actions
+    end
+
+    def TaskAuthor.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
+  end
+end

data/lib/cukesalad/version.rb

@@ -0,0 +1,3 @@
+module CukeSalad
+  VERSION = "0.6.1"
+end

data/spec/cukesalad/actor_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+module SetThePlaceAtTheTable
+
+  def perform_task
+    place = []
+    place_the_fork_on_the_left_of place
+    place_the_knife_on_the_right_of place
+    place
+  end
+end
+
+module LayTheTable
+ 
+  def perform_task
+    value_of( :with_places_for ).to_i
+  end
+end
+
+module Butler
+
+  def place_the_fork_on_the_left_of place
+    place.unshift "fork"
+  end
+
+  def place_the_knife_on_the_right_of place
+    place.push "knife"
+  end
+
+end
+
+module CukeSalad
+  describe Actor do
+
+    it "gets into character" 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
+    end  
+
+    it "performs a simple task as that character" do
+      role_description = "Butler"
+     
+      task_description = "set the place at the table"
+      
+      director = double("director")
+      director.should_receive( :explain_the_role ).with( role_description ).and_return( Butler )
+      director.should_receive( :how_do_i_perform ).with( task_description ).and_return( SetThePlaceAtTheTable )
+     
+      actor = Actor.new role_description, director
+      
+      actor.perform(task_description).should == ["fork","knife"]
+    end
+
+    it "can perform a task that requires certain details" do
+      role_description = "Butler"
+      
+      task_description = "Lay The Table"
+      details = { with_places_for: '5' }
+
+      director = double("director")
+      director.should_receive( :explain_the_role ).with( role_description ).and_return( Butler )
+      director.should_receive( :how_do_i_perform ).with( task_description ).and_return( LayTheTable )
+
+      actor = Actor.new role_description, director
+
+      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
+end

data/spec/cukesalad/codify/as_const_name_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'cukesalad/codify/const_name'
+
+module CukeSalad
+  module Codify
+    describe ConstName do
+    
+      it "gives you ClassName from when it's already a class name" do
+        ConstName.from( "ClassName" ).should == "ClassName"
+      end
+
+      it "gives you ClassName when separated by spaces" do
+        ConstName.from( "Class Name" ).should == "ClassName"
+      end
+
+      it "gives you ClassName from lowercase class name" do
+        ConstName.from( "class name" ).should == "ClassName"
+      end
+
+      it "gives you ClassName from lower case class name with leading/trailing spaces" do
+        ConstName.from( " class name " ).should == "ClassName"
+      end
+      
+      it "formats as a ClassName from a mix of class format and lower case" do
+        ConstName.from( "AnotherClass name " ).should == "AnotherClassName"
+      end
+    end
+
+  end
+end

data/spec/cukesalad/director_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+class Something
+end
+class Another
+end
+class MoreThanOneWord
+end
+
+
+module CukeSalad
+  describe Director do
+
+    before :each do
+      @director = Director.new
+    end
+
+    it "gives you directives (i.e. a class) for Something" do
+      the_thing_we_found = @director.how_do_i_perform "something"
+      the_thing_we_found.should == Something  
+    end
+
+    it "finds directives (i.e. a class) for something described with more than one word" do
+      the_thing_we_found = @director.how_do_i_perform "more than one word"
+      the_thing_we_found.should == MoreThanOneWord
+    end
+
+    it "apologises when it can't find the role" do
+      lambda { @director.explain_the_role "non existent role" }.should raise_error RuntimeError
+    end
+
+    it "apologises when it can't find the task" do
+      lambda { @director.how_do_i_perform "non existent task" }.should raise_error RuntimeError
+    end
+  end
+end

data/spec/cukesalad/specifics_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+class NeedingSpecifics
+  include CukeSalad::Specifics
+end
+
+module CukeSalad
+  describe Specifics do
+
+    it "has an item of specific information" do
+      something = NeedingSpecifics.new
+      something.understand_the "specific 'information'"
+      something.value_of(:specific).should == "information"
+    end
+
+    it "has items of specific information" do
+      something = NeedingSpecifics.new
+      something.understand_the "first 'item' second 'another'"
+      something.value_of(:first).should == "item"
+      something.value_of(:second).should == "another"
+    end
+
+    it "copes with names having more than one word" do
+      something = NeedingSpecifics.new 
+      something.understand_the "first thing 'item' second thing 'another'"
+      something.value_of(:first_thing).should == "item"
+      something.value_of(:second_thing).should == "another"
+    end
+    
+    it "should cope with values having more than one word" do
+      something = NeedingSpecifics.new
+      something.understand_the "first thing 'item' second thing 'another thing'"
+      something.value_of(:first_thing).should == "item"
+      something.value_of(:second_thing).should == "another thing"
+    end
+
+    context 'the last item' do
+      it "can be empty" do
+        something = NeedingSpecifics.new
+        something.understand_the "containing"
+        something.value_of(:containing).should be_nil
+      end
+
+      it "can be the only item and have a value assigned" do
+        something = NeedingSpecifics.new
+        something.understand_the "containing"
+        something.set_last('some value')
+        something.value_of(:containing).should == 'some value'
+      end
+
+      it "can be the only item and be empty" do
+        something = NeedingSpecifics.new
+        something.understand_the "called 'something' containing"
+        something.value_of(:called).should == 'something'
+        something.value_of(:containing).should be_nil
+      end
+
+      it "can have a value assigned" do
+        something = NeedingSpecifics.new
+        something.understand_the "called 'something' containing"
+        something.value_of(:called).should == 'something'
+        something.set_last('some value')
+        something.value_of(:containing).should == 'some value'
+      end
+
+    end
+  end
+end

data/spec/cukesalad/task_author_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'cukesalad/task_author'
+
+class SomeActor
+  def see_how_to_do something
+    extend something
+  end
+  def do_your_thing
+    perform_task
+  end
+  def value_of thing
+    "this is the info"
+  end
+end
+
+module CukeSalad
+  describe 'TaskAuthor' do
+    include TaskAuthor
+
+    it "creates a module by the same name" do
+      in_order_to "SomeTask" do;end
+
+      SomeActor.new.see_how_to_do SomeTask
+    end
+
+    it "creates a module by a similar name" do
+      in_order_to "some different task" do;end
+
+      SomeActor.new SomeDifferentTask
+    end
+
+    it "enables the actor to do something" do
+      in_order_to "SomeOtherTask" do
+        "done"
+      end
+
+      actor = SomeActor.new
+      actor.see_how_to_do SomeOtherTask
+      actor.do_your_thing.should == "done"
+    end
+
+    it "maps some attributes" do
+      in_order_to "YetAnotherTask", with_info: :info do
+        the :info
+      end
+
+      actor = SomeActor.new
+      actor.see_how_to_do YetAnotherTask
+      actor.do_your_thing.should == "this is the info"
+    end
+  end
+end