features 0.1.4 → 0.2.0

data/Manifest

@@ -26,3 +26,62 @@ lib/scenario.rb
 lib/step.rb
 lib/string_extension.rb
 lib/suite.rb
+website/README
+website/Rakefile
+website/config.yaml
+website/deploy.rb
+website/deploy/1251795725/features/browserfix.css
+website/deploy/1251795725/features/default.css
+website/deploy/1251795725/features/images/bodybg.gif
+website/deploy/1251795725/features/images/header-bg.gif
+website/deploy/1251795725/features/images/logo.png
+website/deploy/1251795725/features/images/minus.png
+website/deploy/1251795725/features/images/plus.png
+website/deploy/1251795725/features/images/sidebarbg.gif
+website/deploy/1251795725/features/index.html
+website/deploy/1251796894/features/browserfix.css
+website/deploy/1251796894/features/default.css
+website/deploy/1251796894/features/images/bodybg.gif
+website/deploy/1251796894/features/images/header-bg.gif
+website/deploy/1251796894/features/images/logo.png
+website/deploy/1251796894/features/images/minus.png
+website/deploy/1251796894/features/images/output-screen-1.png
+website/deploy/1251796894/features/images/plus.png
+website/deploy/1251796894/features/images/sidebarbg.gif
+website/deploy/1251796894/features/index.html
+website/deploy/1251822430/features/browserfix.css
+website/deploy/1251822430/features/default.css
+website/deploy/1251822430/features/images/bodybg.gif
+website/deploy/1251822430/features/images/header-bg.gif
+website/deploy/1251822430/features/images/logo.png
+website/deploy/1251822430/features/images/minus.png
+website/deploy/1251822430/features/images/output-screen-1.png
+website/deploy/1251822430/features/images/plus.png
+website/deploy/1251822430/features/images/sidebarbg.gif
+website/deploy/1251822430/features/index.html
+website/ext/init.rb
+website/out/browserfix.css
+website/out/default.css
+website/out/images/bodybg.gif
+website/out/images/header-bg.gif
+website/out/images/logo.png
+website/out/images/minus.png
+website/out/images/output-screen-1.png
+website/out/images/plus.png
+website/out/images/sidebarbg.gif
+website/out/index.html
+website/src/browserfix.css
+website/src/default.css
+website/src/default.template
+website/src/images/bodybg.gif
+website/src/images/deploy.rb
+website/src/images/header-bg.gif
+website/src/images/logo.png
+website/src/images/minus.png
+website/src/images/output-screen-1.png
+website/src/images/plus.png
+website/src/images/sidebarbg.gif
+website/src/images/webgen.rb
+website/src/index.page
+website/webgen.cache
+website/webgen.rb

data/README.markdown

@@ -87,7 +87,7 @@ will look like in the different languages:
 		    }
 		  @end
 
-* Other Languages (Java, C#, C++, Python) will follow soon ...
+* Other Languages (Java, C#, C++, Python, PHP) will follow soon ...
 
 
 ### Provide Step Implementations
@@ -97,6 +97,36 @@ that inherits from the language specific TestCase class (eg 'ActionController::I
 and that itself is the parent of the generated TestCases. This way, all test method implementations (aka Scenarios)   
 will have access to the steps.
 
+The implementation follows the some patterns :
+
+* Only use characters that may appear in method and class definitions.
+* Spaces in the step definition map to underscores in the implementation:
+
+		(Rails) Given something => given_Something
+		(ObjC)  Given something => Given_Something
+	
+
+
+* Place Holders for variable strings (that can be passed to the step implementation) are 
+  identified by double underscores (plus underscores for spaces) in the step implementation and strings are single quoted 
+  in the step definition:
+
+		# Step definition
+		When i say 'Hello, World!'
+	
+		# Rails Step implementation
+		def when_i_say___(string)
+			# do something
+		end
+	
+		# ObjectiveC Step implementation
+		-(void) When_i_say___:(NSString *) string
+		{
+			// do something
+		} 
+		
+
+
 ## Installation
 
     gem install features

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('features', '0.1.4') do |p|
+Echoe.new('features', '0.2.0') do |p|
   p.description    = "Plaintext User Stories Parser supporting native programming languages."
   p.url            = "http://features.rubyforge.org"
   p.author         = "Matthias Hennemeyer"

data/features.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{features}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matthias Hennemeyer"]
-  s.date = %q{2009-09-04}
+  s.date = %q{2009-09-05}
   s.description = %q{Plaintext User Stories Parser supporting native programming languages.}
   s.email = %q{mhennemeyer@me.com}
   s.extra_rdoc_files = ["README.markdown", "lib/ObjC/objc_feature.rb", "lib/ObjC/objc_scenario.rb", "lib/ObjC/objc_step.rb", "lib/ObjC/objc_suite.rb", "lib/Rails/rails_feature.rb", "lib/Rails/rails_scenario.rb", "lib/Rails/rails_step.rb", "lib/Rails/rails_suite.rb", "lib/feature.rb", "lib/features.rb", "lib/objc.rb", "lib/parser.rb", "lib/rails.rb", "lib/scenario.rb", "lib/step.rb", "lib/string_extension.rb", "lib/suite.rb"]
-  s.files = ["Manifest", "README.markdown", "Rakefile", "generators/features/USAGE", "generators/features/features_generator.rb", "generators/features/templates/HelloWorld.feature", "generators/features/templates/custom_steps.rb", "generators/features/templates/features_helper.rb", "generators/features/templates/features_test_case_class.rb", "generators/features/templates/run_features.rb", "generators/features/templates/test_cases_file.rb", "lib/ObjC/objc_feature.rb", "lib/ObjC/objc_scenario.rb", "lib/ObjC/objc_step.rb", "lib/ObjC/objc_suite.rb", "lib/Rails/rails_feature.rb", "lib/Rails/rails_scenario.rb", "lib/Rails/rails_step.rb", "lib/Rails/rails_suite.rb", "lib/feature.rb", "lib/features.rb", "lib/objc.rb", "lib/parser.rb", "lib/rails.rb", "lib/scenario.rb", "lib/step.rb", "lib/string_extension.rb", "lib/suite.rb", "features.gemspec"]
+  s.files = ["Manifest", "README.markdown", "Rakefile", "generators/features/USAGE", "generators/features/features_generator.rb", "generators/features/templates/HelloWorld.feature", "generators/features/templates/custom_steps.rb", "generators/features/templates/features_helper.rb", "generators/features/templates/features_test_case_class.rb", "generators/features/templates/run_features.rb", "generators/features/templates/test_cases_file.rb", "lib/ObjC/objc_feature.rb", "lib/ObjC/objc_scenario.rb", "lib/ObjC/objc_step.rb", "lib/ObjC/objc_suite.rb", "lib/Rails/rails_feature.rb", "lib/Rails/rails_scenario.rb", "lib/Rails/rails_step.rb", "lib/Rails/rails_suite.rb", "lib/feature.rb", "lib/features.rb", "lib/objc.rb", "lib/parser.rb", "lib/rails.rb", "lib/scenario.rb", "lib/step.rb", "lib/string_extension.rb", "lib/suite.rb", "website/README", "website/Rakefile", "website/config.yaml", "website/deploy.rb", "website/deploy/1251795725/features/browserfix.css", "website/deploy/1251795725/features/default.css", "website/deploy/1251795725/features/images/bodybg.gif", "website/deploy/1251795725/features/images/header-bg.gif", "website/deploy/1251795725/features/images/logo.png", "website/deploy/1251795725/features/images/minus.png", "website/deploy/1251795725/features/images/plus.png", "website/deploy/1251795725/features/images/sidebarbg.gif", "website/deploy/1251795725/features/index.html", "website/deploy/1251796894/features/browserfix.css", "website/deploy/1251796894/features/default.css", "website/deploy/1251796894/features/images/bodybg.gif", "website/deploy/1251796894/features/images/header-bg.gif", "website/deploy/1251796894/features/images/logo.png", "website/deploy/1251796894/features/images/minus.png", "website/deploy/1251796894/features/images/output-screen-1.png", "website/deploy/1251796894/features/images/plus.png", "website/deploy/1251796894/features/images/sidebarbg.gif", "website/deploy/1251796894/features/index.html", "website/deploy/1251822430/features/browserfix.css", "website/deploy/1251822430/features/default.css", "website/deploy/1251822430/features/images/bodybg.gif", "website/deploy/1251822430/features/images/header-bg.gif", "website/deploy/1251822430/features/images/logo.png", "website/deploy/1251822430/features/images/minus.png", "website/deploy/1251822430/features/images/output-screen-1.png", "website/deploy/1251822430/features/images/plus.png", "website/deploy/1251822430/features/images/sidebarbg.gif", "website/deploy/1251822430/features/index.html", "website/ext/init.rb", "website/out/browserfix.css", "website/out/default.css", "website/out/images/bodybg.gif", "website/out/images/header-bg.gif", "website/out/images/logo.png", "website/out/images/minus.png", "website/out/images/output-screen-1.png", "website/out/images/plus.png", "website/out/images/sidebarbg.gif", "website/out/index.html", "website/src/browserfix.css", "website/src/default.css", "website/src/default.template", "website/src/images/bodybg.gif", "website/src/images/deploy.rb", "website/src/images/header-bg.gif", "website/src/images/logo.png", "website/src/images/minus.png", "website/src/images/output-screen-1.png", "website/src/images/plus.png", "website/src/images/sidebarbg.gif", "website/src/images/webgen.rb", "website/src/index.page", "website/webgen.cache", "website/webgen.rb", "features.gemspec"]
   s.homepage = %q{http://features.rubyforge.org}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Features", "--main", "README.markdown"]
   s.require_paths = ["lib"]

data/generators/features/templates/run_features.rb

@@ -2,6 +2,33 @@ require "rubygems"
 require "features"
 
 current_dir = File.dirname(File.expand_path(__FILE__))
+
+# pass in config options directly as a hash. What follows are the possible keys:
+# 
+# :feature_files_path 
+# The path to the directory containing your plaintext user stories files
+# 
+# :feature_file_suffix
+# A suffix to the plaintext user stories filenames. The default is .feature. Ommit the dot!
+# 
+# :test_cases_file
+# The path to the file that holds the tests generated by features.
+# 
+# :features_helper
+# The path to the file that will be required inside the test_cases_file. 
+# 
+# :feature_keyword
+# The keyword that is prepended to the User Stories title. Defaults to 'Feature:'. With colon.
+# 
+# :scenario_keyword
+# The keyword that is prepended to the Scenario or Acceptance tests titles. Defaults to 'Scenario:'. With colon.
+# 
+# :given_scenario_keyword
+# The keyword that identifies a Scenario to be reused inside another Scenario. Defaults to 'GivenScenario:'. With colon.
+# 
+# :project_name
+# The project name will be shown at the top of the html output. Defaults to 'Features'.
+
 suite = RailsSuite.new({
   :feature_files_path => current_dir,
   :test_cases_file    => current_dir + "/support/test_cases_file.rb",

data/lib/ObjC/objc_feature.rb

@@ -1,36 +1,13 @@
 class ObjcFeature < Feature
-  attr_reader :scenarios, :scenario_keyword,
-              :title, :body, :parent, :parser,
-              :given_scenario_keyword, :keyword
-  
-  def initialize(hash={})
-    @title                  = hash[:title]
-    @body                   = hash[:body]
-    @parent                 = hash[:parent]
-    @keyword                = hash[:keyword] || "Feature:"
-    @scenario_keyword       = hash[:scenario_keyword] || "Scenario:"
-    @given_scenario_keyword = hash[:given_scenario_keyword] || "GivenScenario:"
-    
-    raise "No title given" unless title
-    raise "No body given" unless body
-  end
-  
-  def story
-    body.split(/#{scenario_keyword}/)[0].split(/#{keyword}\s#{title}/).join(" ").strip
-  end
-  
-  def story_html
-    story.split("\n").join(" <br />")
-  end
-  
-  def parse_scenarios
+  def parse_scenarios(klass=ObjcScenario)
     title_body_arr = Parser.title_and_body_by_keyword_from_string({
       :string => body,
       :keyword => scenario_keyword
     })
-    @scenarios = title_body_arr.map {|hash| ObjcScenario.new(hash.update({
+    @scenarios = title_body_arr.map {|hash| klass.new(hash.update({
       :parent => self,
-      :given_scenario_keyword => given_scenario_keyword
+      :given_scenario_keyword => given_scenario_keyword,
+      :follow_up_keyword => follow_up_keyword
     }))}
     @scenarios.each {|scenario| scenario.collect_steps}
     self

data/lib/ObjC/objc_scenario.rb

@@ -1,34 +1,4 @@
 class ObjcScenario < Scenario
-  attr_reader :steps, :lines, :given_scenario_keyword,
-              :title, :body, :parent, :passed
-              
-  def initialize(hash)
-    @title  = hash[:title]
-    @body   = hash[:body]
-    @parent = hash[:parent]
-    @given_scenario_keyword = hash[:given_scenario_keyword] || "GivenScenario:"
-    
-    raise "No title given" unless title
-    raise "No body given" unless body
-  end
-  
-  def keyword
-    parent.scenario_keyword
-  end
-  
-  def to_html
-    <<-END
-    <div class="scenario #{passed? ? "passed" : "failed"}">
-      <h2 class="scenario_title">#{keyword} #{title}</h2>
-      #{steps.map {|s| s.to_html}.join(" \n")}
-    </div>
-    END
-  end
-  
-  def passed?
-    !!@passed
-  end
-  
   def verify_status(results="")
     test_case_name = parent.test_case_name
     #Test Case '-[SayHelloTest testWithABlankObject]' failed (0.001 seconds).
@@ -43,35 +13,8 @@ class ObjcScenario < Scenario
     end
   end
   
-  def collect_steps
-    
-    if has_given_scenarios?
-      @body = expand_given_scenarios_in_body.strip
-    end
-    
-    
-    @lines = body.split(/\n+/).map {|s| s.strip}
-    raise "No Steps found" if lines.empty?
-    
-    @steps = parse_lines
-    self
-  end
-  
-  def expand_given_scenarios_in_body
-    raise "No associated Feature" unless parent 
-    raise "Associated Feature has no Scenarios" unless parent.scenarios
-    body.gsub(/#{given_scenario_keyword}(.*)/) do |m|
-      existing_scenario = parent.scenarios.detect {|s| s.title == $1.strip }
-      existing_scenario ? existing_scenario.body.strip : ""
-    end
-  end
-  
   def parse_lines
-    lines.map {|l| ObjcStep.new({:title => l, :body => l}).aggregate!}
-  end
-  
-  def has_given_scenarios?
-    !!(body =~ /#{given_scenario_keyword}(.*)/)
+    lines.map {|l| ObjcStep.new({:body => l}).aggregate!}
   end
   
   def to_s

data/lib/ObjC/objc_step.rb

@@ -1,39 +1,8 @@
 class ObjcStep < Step
-  attr_reader :message
-  
-  attr_reader :title, :body, :parent
-  def initialize(hash)
-    @title  = hash[:title]
-    @body   = hash[:body]
-    @parent = hash[:parent]
-    raise "No title given" unless title
-    raise "No body given" unless body
-  end
-  
-  def to_html
-    s = <<-END
-    <h3 class="step">#{title}</h3>
-    END
-    s.strip
-  end
-  
-  def aggregate!
-    @message = first_part + args_string
-    self
-  end
-  
   def first_part
     body.gsub(/\s+/,"_").gsub(/'[^']*'/, "__").remove_invalid_chars
   end
   
-  def has_args?
-    !args.empty?
-  end
-  
-  def args
-    @args ||= body.scan(/'([^']*)'/).map {|a| a[0]}
-  end
-  
   def args_string
     if has_args?
       ([":@\"#{args[0]}\""] + 

data/lib/ObjC/objc_suite.rb

@@ -4,7 +4,8 @@ class ObjcSuite < Suite
               :features,                   :test_cases_file,  
               :feature_class_header_files, :given_scenario_keyword,
               :feature_keyword,            :scenario_keyword,
-              :project_name,               :passed
+              :project_name,               :passed,
+              :follow_up_keyword
   
   def initialize(hash)
     @feature_files_path          = hash[:feature_files_path]
@@ -15,96 +16,23 @@ class ObjcSuite < Suite
     @scenario_keyword            = hash[:scenario_keyword] || "Scenario:"
     @given_scenario_keyword      = hash[:given_scenario_keyword] || "GivenScenario:"
     @project_name                = hash[:project_name] || "Features"
+    @follow_up_keyword           = hash[:follow_up_keyword] || "And"
     @feature_files               = all_feature_files
     @feature_files_as_strings    = all_feature_files_as_strings
   end
   
-  def parse_output_file_and_open_in_browser(file)
-    results = ""
-    File.open(file) do |f|
-      f.readlines.each do |l|
-        results << l
-      end
-    end
-    
-    html = parse_results(results).html
-
-    %x(touch '/tmp/out.html' && echo '#{html}' > /tmp/out.html && open '/tmp/out.html' )
-    
-  end
-  
-  
-  def parse_results(results="")
-    parse
-    @passed = true
-    features.each do |f|
-      f.scenarios.each do |s|
-        s.verify_status(results)
-        @passed &&= s.passed?
-      end
+  def parse_features(klass=ObjcFeature)
+    title_body_arr = Parser.title_and_body_by_keyword_from_string({
+      :string => feature_files_as_strings.join(" "),
+      :keyword => feature_keyword
+    })
+    @features = title_body_arr.map do |hash| 
+      klass.new(hash.update({
+        :keyword => feature_keyword, 
+        :scenario_keyword => scenario_keyword,
+        :given_scenario_keyword => given_scenario_keyword,
+        :follow_up_keyword => follow_up_keyword}))
     end
-    self
-  end
-  
-  def passed?
-    @passed
-  end
-  
-  def html
-    <<-END
-    <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-    <html>
-      <head>
-        <style type="text/css">
-        body { 
-          font-family: Lucida Grande;
-          background-color: #FEFEFE;
-          padding: 5px;
-        }
-        * {-webkit-border-radius: 10px;}
-        body {background-color: #EEE; -webkit-border-radius: 0px;}
-        .feature { background-color: #CCC;padding: 20px; margin: 20px;}
-        .scenario { background-color: #EEE; padding: 20px; margin: 20px}
-        .failed {border: 1px solid #C88; background-color: #B77; }
-        .passed {border: 1px solid #8C8; background-color: #7B7; }
-        .feature_title {font-size: 24pt; }
-        .story { font-size: 18pt; padding-left: 40px;}
-        #indicator { width: 100%; height: 20px; }
-        #wrap { background-color: #EEE; padding: 20px }
-        </style></head>
-      </head>
-      <body>
-      <div id="wrap">
-        <div id="header">
-          <div id="indicator" class="#{passed? ? "passed" : "failed"}">&nbsp;</div>
-          <h1 class="project_name">#{project_name}</h1>
-          
-        </div>
-        #{features.map {|f| f.to_html }.join(" \n")}
-      </div>
-      </body>
-    </html>
-    END
-  end
-  
-  def valid?
-    unique_feature_test_case_names?
-  end
-  
-  def unique_feature_test_case_names?
-    feature_test_case_name =  features.map {|f| f.test_case_name }
-    feature_test_case_name == feature_test_case_name.uniq
-  end
-  
-  def run
-    parse
-    raise "Invalid: Duplicated Titles" unless valid?
-    File.open(test_cases_file, "w") { |f| f.puts self }
-  end
-  
-  def parse
-    parse_features
-    parse_feature_scenarios
   end
   
   def to_s
@@ -113,40 +41,4 @@ class ObjcSuite < Suite
     #{features.map {|f| f.to_s }.join(" ")}
     END
   end
-  
-  def parse_features
-    title_body_arr = Parser.title_and_body_by_keyword_from_string({
-      :string => feature_files_as_strings.join(" "),
-      :keyword => feature_keyword
-    })
-    @features = title_body_arr.map {|hash| ObjcFeature.new(hash.update({:keyword => feature_keyword, :scenario_keyword => scenario_keyword}))}
-  end
-  
-  def parse_feature_scenarios
-    features.each do |feature|
-      feature.parse_scenarios
-    end
-  end
-  
-  def all_feature_files
-    all_entries_in_feature_files_path = Dir.new(feature_files_path).entries
-    feature_entries =  all_entries_in_feature_files_path.select do |file|
-      !!(file =~ /\.#{feature_file_suffix}$/)
-    end
-    feature_entries.map do |file|
-      feature_files_path + "/" + file
-    end
-  end
-  
-  def all_feature_files_as_strings
-    feature_files.map do |file|
-      feature_string = ""
-      File.open(file) do |f|
-        f.readlines.each do |l|
-          feature_string << l
-        end
-      end
-      feature_string
-    end
-  end
 end