RubyGems - spreewald - Versions diffs - 1.6.0 → 1.7.0 - Mend

spreewald 1.6.0 → 1.7.0

Files changed (13) hide show

checksums.yaml +4 -4
data/README.md +122 -174
data/Rakefile +5 -1
data/lib/spreewald/development_steps.rb +7 -0
data/lib/spreewald/email_steps.rb +14 -14
data/lib/spreewald/file_attachment_steps.rb +0 -1
data/lib/spreewald/timecop_steps.rb +5 -5
data/lib/spreewald/web_steps.rb +20 -26
data/lib/spreewald_support/version.rb +1 -1
data/support/parser.rb +3 -1
data/support/step_definition.rb +4 -4
data/support/step_definition_file.rb +4 -4
metadata +2 -2

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df25090140652d3fa03a3cda6b6c6884b323d8a0
-  data.tar.gz: 7e7b89cbb1c43e35fcf8bfaaa2f688214c7e7d8d
+  metadata.gz: fa355b8ab659c4c92bf9bbb82d330c78d3dae334
+  data.tar.gz: 6bdae7b5482fa1db3ff3c1180cd4e21afa976fdf
 SHA512:
-  metadata.gz: 327ee94883e1f5aa4e52aac9241ea39f2a778361d4097d82ff4b975524df3849006c276734fba0f8a74d5be195616a027024eae7c08d67e50aba90ef278fbd99
-  data.tar.gz: 269ca468065eaeac5d49cad1ff49b72891956783a55b6684886251218de111947477967803d485558acc4cea4e9dc0a562c2b9eea690ce60241e48dffe5ac18f
+  metadata.gz: 8b5b1e7ce0e2c433af02ff362df920076bbfa5e11ea7ff6b28d7bc43a0cc5e5df159638d09fc66daed6506af64cda3665e2aad124e81ec7479dc8b27877a2f8d
+  data.tar.gz: b39e03bad642047b2afd5adb30f805b383675b076306bc99f50233ac0c3944dfda14208094540ac51df04f00dca3918df18b4fa2199d967a7d2527b7f204c721

data/README.md CHANGED

@@ -18,28 +18,36 @@ Or install it yourself as:
     $ gem install spreewald
 ## Usage
-Steps are grouped into a number of categories. You can pick and choose single categories by putting something like
+Require all Spreewald steps by putting
-    require 'spreewald/email_steps'
+    require 'spreewald/all_steps'
 into either your `support/env.rb` or `step_definitions/spreewald_steps.rb`.
-Alternatively, you can require everything by doing
+Steps are grouped into a number of categories. If you only want to use a subset
+of Spreewald's steps, you can pick and choose single categories by requiring
+single files like this:
-    require 'spreewald/all_steps'
+    require 'spreewald/email_steps'
+    require 'spreewald/web_steps'
 ## Spreewald binary
-Spreewald comes with a binary that prints a list of all Spreewald steps. It will filter the list by any string you pass it. Example usage:
+Spreewald comes with a binary that prints a list of all Cucumber steps from
+Spreewald _and your project_. It will filter the list by any string you
+pass it. Example usage:
 ```bash
 spreewald # lists all steps
 spreewald mail # lists all steps that contain "mail"
 ```
+The binary also prints paths and selectors; run `spreewald --help` to learn more.
 ## Waiting for page load
@@ -92,59 +100,59 @@ If you would like to contribute:
 ## This README
-The "Steps" section is autogenerated by `rake update_readme` from comments in the step definitions.
+The "Steps" section is autogenerated by `rake update_readme` from comments in
+the step definitions.
 ## Steps
-### development_steps.rb
+### development_steps.rb
 * **Then it should work**
-    Marks scenario as pending
+  Marks scenario as pending
 * **Then debugger**
-    Starts debugger, or Pry if installed
+  Starts debugger, or Pry if installed
-* **AfterStep @slow**
+* **Then pause**
-    Waits 2 seconds after each step
+  Pauses Cucumber, but not the application (unlike "Then debugger"). From the
+  test browser, you can interact with your application as you like.
-* **AfterStep @single**
+* **AfterStep @slow**
-    Waits for keypress after each step
+  Waits 2 seconds after each step
+* **AfterStep @single**
-### email_steps.rb
+  Waits for keypress after each step
+### email_steps.rb
 * **When I clear my e?mails**
 * **Then (an|no) e?mail should have been sent with:**
-    Example:
+  Example:
-        Then an email should have been sent with:
-          """
-          From: max.mustermann@example.com
-          Reply-To: mmuster@gmail.com
-          To: john.doe@example.com
-          Subject: The subject may contain "quotes"
-          Attachments: ...
+      Then an email should have been sent with:
+        """
+        From: max.mustermann@example.com
+        Reply-To: mmuster@gmail.com
+        To: john.doe@example.com
+        Subject: The subject may contain "quotes"
+        Attachments: ...
-          Message body goes here.
-          """
+        Message body goes here.
+        """
   You can skip lines, of course. Note that the mail body is only checked for
   _inclusion_.
@@ -152,51 +160,46 @@ The "Steps" section is autogenerated by `rake update_readme` from comments in th
 * **When I follow the (first|second|third)? link in the e?mail**
-    Only works after you have retrieved the mail using "Then an email should have been sent with:"
+  Only works after you have retrieved the mail using "Then an email should have been sent with:"
 * **Then no e?mail should have been sent**
 * **Then I should see "..." in the e?mail**
-    Checks that the last sent email includes some text
+  Checks that the last sent email includes some text
 * **Then show me the e?mails**
-    Print all sent emails to STDOUT.
+  Print all sent emails to STDOUT.
 * **Then that e?mail should( not)? have the following lines in the body:**
-    Only works after you've retrieved the email using "Then an email should have been sent with:"
+  Only works after you've retrieved the email using "Then an email should have been sent with:"
   Example:
-        And that mail should have the following lines in the body:
-          """
-          All of these lines
-          need to be present
-          """
+      And that mail should have the following lines in the body:
+        """
+        All of these lines
+        need to be present
+        """
 * **Then that e?mail should have the following body:**
-    Only works after you've retrieved the email using "Then an email should have been sent with:"
+  Only works after you've retrieved the email using "Then an email should have been sent with:"
   Checks that the text should be included in the retrieved email
-### file_attachment_steps.rb
+### file_attachment_steps.rb
 * **Given the file "..." was attached( as (.../)?...)? to the ... above( at "...")?**
-    Attach a file to the given model's last record.
+  Attach a file to the given model's last record.
   Example (Company has a `file` attribute):
@@ -219,21 +222,16 @@ The "Steps" section is autogenerated by `rake update_readme` from comments in th
       Given the file "some_file" was attached to the profile above at "2011-11-11 11:11"
-### table_steps.rb
+### table_steps.rb
 * **Then I should( not)? see a table with (exactly )?the following rows( in any order)?:?**
-    Check the content of tables in your HTML.
+  Check the content of tables in your HTML.
   See [this article](https://makandracards.com/makandra/763-cucumber-step-to-match-table-rows-with-capybara) for details.
-### timecop_steps.rb
+### timecop_steps.rb
 Steps to travel through time using [Timecop](https://github.com/jtrupiano/timecop).
@@ -242,29 +240,28 @@ See [this article](https://makandracards.com/makandra/1222-useful-cucumber-steps
 * **When the (date|time) is "?(\d{4}-\d{2}-\d{2}( \d{1,2}:\d{2})?)"?**
-    Example:
+  Example:
-        Given the date is 2012-02-10
-        Given the time is 2012-02-10 13:40
+      Given the date is 2012-02-10
+      Given the time is 2012-02-10 13:40
 * **When the time is "?(\d{1,2}:\d{2})"?**
-    Example:
+  Example:
-        Given the time is 13:40
+      Given the time is 13:40
 * **When it is (\d+|a|some|a few) (seconds?|minutes?|hours?|days?|weeks?|months?|years?) (later|earlier)**
-    Example:
+  Example:
-        When it is 10 minutes later
-        When it is a few hours earlier
+      When it is 10 minutes later
+      When it is a few hours earlier
-### web_steps.rb
+### web_steps.rb
 Most of cucumber-rails' original web steps plus a few of our own.
@@ -292,183 +289,160 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **When ... within ...**
-    You can append `within [selector]` to any other web step
+  You can append `within [selector]` to any other web step.
   Example:
-        Then I should see "some text" within ".page_body"
+      Then I should see "some text" within ".page_body"
 * **Given I am on ...**
 * **When I go to ...**
 * **Then I should be on ...**
 * **When I press "..."**
 * **When I follow "..."**
 * **When I fill in "..." (with|for) "..."**
-    Fill in text field
+  Fill in text field
 * **When I fill in "..." (with|for):**
-    Fill in text field with multi-line block
+  Fill in text field with multi-line block
   You can use a doc string to supply multi-line text
   Example:
-        When I fill in "some field" with:
-        """
-        Apple
-        Banana
-        Pear
-        """
+      When I fill in "some field" with:
+      """
+      Apple
+      Banana
+      Pear
+      """
 * **When I fill in "..." (with|for) '...'**
-    Fill in text field
+  Fill in text field
 * **When I select "..." from "..."**
-    Select from select box
+  Select from select box
 * **When I check "..."**
-    Check a checkbox
+  Check a checkbox
 * **When I uncheck "..."**
-    Uncheck a checkbox
+  Uncheck a checkbox
 * **When I choose "..."**
-    Select a radio button
+  Select a radio button
 * **When I attach the file "..." to "..."**
-    Attach a file to a file upload form field
+  Attach a file to a file upload form field
 * **Then I should see "..."**
-    Checks that some text appears on the page
+  Checks that some text appears on the page
   Note that this does not detect if the text might be hidden via CSS
 * **Then I should see /.../**
-    Checks that a regexp appears on the page
+  Checks that a regexp appears on the page
   Note that this does not detect if the text might be hidden via CSS
 * **Then I should not see "..."**
 * **Then I should not see /.../**
 * **Then the "..." field should (not )?contain "..."**
-    Checks that an input field contains some value (allowing * as wildcard character)
+  Checks that an input field contains some value (allowing * as wildcard character)
 * **Then the "..." field should (not )?contain:**
-    Checks that a multiline textarea contains some value (allowing * as wildcard character)
+  Checks that a multiline textarea contains some value (allowing * as wildcard character)
 * **Then I should see a form with the following values:**
-    Checks that a list of label/value pairs are visible as control inputs.
+  Checks that a list of label/value pairs are visible as control inputs.
   Example:
-        Then I should see a form with the following values:
-          | E-mail | foo@bar.com   |
-          | Role   | Administrator |
+      Then I should see a form with the following values:
+        | E-mail | foo@bar.com   |
+        | Role   | Administrator |
 * **Then the "..." field should have the error "..."**
-    Checks that an input field was wrapped with a validation error
+  Checks that an input field was wrapped with a validation error
 * **Then the "..." field should( not)? have an error**
 * **Then the "..." field should have no error**
 * **Then the "..." checkbox should( not)? be checked**
 * **Then the radio button "..." should( not)? be (checked|selected)**
 * **Then I should have the following query string:**
-    Example:
+  Example:
-        I should have the following query string:
-          | locale        | de  |
-          | currency_code | EUR |
+      I should have the following query string:
+        | locale        | de  |
+        | currency_code | EUR |
   Succeeds when the URL contains the given `locale` and `currency_code` params
 * **Then show me the page**
-    Open the current Capybara page using the `launchy` gem
+  Open the current Capybara page using the `launchy` gem
 * **Then I should( not)? see a field "..."**
-    Checks for the existance of an input field (given its id or label)
+  Checks for the existance of an input field (given its id or label)
 * **Then I should( not)? see the (number|amount) ([\-\d,\.]+)( ...)?**
-    Use this step to test for a number or money amount instead of a simple `Then I should see`
+  Use this step to test for a number or money amount instead of a simple `Then I should see`
   Checks for an unexpected minus sign, correct decimal places etc.
@@ -477,65 +451,57 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **Then I should get a response with content-type "..."**
-    Checks `Content-Type` HTTP header
+  Checks `Content-Type` HTTP header
 * **Then I should get a download with filename "..."**
-    Checks `Content-Disposition` HTTP header
+  Checks `Content-Disposition` HTTP header
   Attention: Doesn't work with Selenium, see https://github.com/jnicklas/capybara#gotchas
 * **Then "..." should be selected for "..."**
-    Checks that a certain option is selected for a text field
+  Checks that a certain option is selected for a text field
 * **Then nothing should be selected for "..."**
 * **Then "..." should( not)? be an option for "..."**
-    Checks for the presence of an option in a select
+  Checks for the presence of an option in a select
 * **Then I should see '...'**
-    Like `Then I should see`, but with single instead of double quotes. In case
+  Like `Then I should see`, but with single instead of double quotes. In case
   the expected string contains quotes as well.
 * **Then I should see "..." in the HTML**
-    Check that the raw HTML contains a string
+  Check that the raw HTML contains a string
 * **Then I should not see "..." in the HTML**
 * **Then I should see an error**
-    Checks that status code is 400..599
+  Checks that status code is 400..599
 * **Then the window should be titled "..."**
 * **When I reload the page**
 * **Then (the tag )?"..." should( not)? be visible**
-    Checks that an element is actually present and visible, also considering styles.
+  Checks that an element is actually present and visible, also considering styles.
   Within a selenium test, the browser is asked whether the element is really visible
   In a non-selenium test, we only check for `.hidden`, `.invisible` or `style: display:none`
@@ -546,14 +512,14 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **Then (the tag )?"..." should be hidden**
-    Checks that an element is actually present and hidden, also considering styles.
+  Checks that an element is actually present and hidden, also considering styles.
   Within a selenium test, the browser is asked whether the element is really hidden.
   In a non-selenium test, we only check for `.hidden`, `.invisible` or `style: display:none`
 * **When I click on "..."**
-    Click on some text that might not be a link.
+  Click on some text that might not be a link.
   Example:
@@ -563,7 +529,7 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **When I click on the element "..."**
-    Click on an element with the given selector.
+  Click on an element with the given selector.
   Example:
@@ -573,7 +539,7 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **When I click on the element for ...**
-    Click on the element with the given [selector alias](https://github.com/makandra/spreewald/blob/master/examples/selectors.rb).
+  Click on the element with the given [selector alias](https://github.com/makandra/spreewald/blob/master/examples/selectors.rb).
   Example:
@@ -582,7 +548,7 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **Then "..." should link to "..."**
-    Use this step to check external links.
+  Use this step to check external links.
   Example:
@@ -593,10 +559,9 @@ deprecation notice. Decide for yourself whether you want to use them:
          got: "http://makandra.com/" (using =~)
 * **Then I should (not )?see (an|the) element "..."**
-    Check that an element with the given selector is present on the page.
+  Check that an element with the given selector is present on the page.
   Example:
@@ -606,10 +571,9 @@ deprecation notice. Decide for yourself whether you want to use them:
       Then I should not see the element ".sidebar"
 * **Then I should (not )?see (an|the) element for ...**
-    Check that an element with the given [selector alias](https://github.com/makandra/spreewald/blob/master/examples/selectors.rb) is present on the page.
+  Check that an element with the given [selector alias](https://github.com/makandra/spreewald/blob/master/examples/selectors.rb) is present on the page.
   Example:
@@ -619,98 +583,82 @@ deprecation notice. Decide for yourself whether you want to use them:
       Then I should not see the element for the sidebar
 * **Then I should get a text response**
-    Checks that the result has content type `text/plain`
+  Checks that the result has content type `text/plain`
 * **When I follow "..." inside any "..."**
-    Click a link within an element matching the given selector. Will try to be clever
+  Click a link within an element matching the given selector. Will try to be clever
   and disregard elements that don't contain a matching link.
   Example:
-        When I follow "Read more" inside any ".text_snippet"
+      When I follow "Read more" inside any ".text_snippet"
 * **Then I should( not)? see "..." inside any "..."**
 * **When I fill in "..." with "..." inside any "..."**
 * **When I confirm the browser dialog**
 * **When I cancel the browser dialog**
 * **When I enter "..." into the browser dialog**
 * **When I switch to the new tab**
 * **Then I should see in this order:?**
-    Checks that these strings are rendered in the given order in a single line or in multiple lines
+  Checks that these strings are rendered in the given order in a single line or in multiple lines
   Example:
-        Then I should see in this order:
-          | Alpha Group |
-          | Augsburg    |
-          | Berlin      |
-          | Beta Group  |
+      Then I should see in this order:
+        | Alpha Group |
+        | Augsburg    |
+        | Berlin      |
+        | Beta Group  |
 * **Then the "..." (field|button) should( not)? be disabled**
-    Tests that an input or button with the given label is disabled.
+  Tests that an input or button with the given label is disabled.
 * **Then the "..." field should( not)? be visible**
-    Tests that a field with the given label is visible.
+  Tests that a field with the given label is visible.
 * **When I wait for the page to load**
-    Waits for the page to finish loading and AJAX requests to finish.
+  Waits for the page to finish loading and AJAX requests to finish.
   More details [here](https://makandracards.com/makandra/12139-waiting-for-page-loads-and-ajax-requests-to-finish-with-capybara).
 * **When I perform basic authentication as ".../..." and go to ...**
-    Performs HTTP basic authentication with the given credentials and visits the given path.
+  Performs HTTP basic authentication with the given credentials and visits the given path.
   More details [here](https://makandracards.com/makandra/971-perform-http-basic-authentication-in-cucumber).
 * **When I go back**
-    Goes to the previously viewed page.
+  Goes to the previously viewed page.
 * **Then the "..." select should( not)? be sorted**
-    Tests whether a select field is sorted. Uses Array#natural_sort, if defined;
+  Tests whether a select field is sorted. Uses Array#natural_sort, if defined;
   Array#sort else.

data/Rakefile CHANGED

@@ -6,6 +6,7 @@ task :default => 'all:rubies'
 desc 'Update the "Steps" section of the README'
 task :update_readme do
+  readme_path = 'README.md'
   if Kernel.respond_to? :require_relative
     require_relative './support/step_manager'
   else
@@ -16,7 +17,10 @@ task :update_readme do
   start_of_steps_section = readme =~ /^## Steps/
   length_of_steps_section = (readme[(start_of_steps_section+1)..-1] =~ /^##[^#]/) || readme.size - start_of_steps_section
   readme[start_of_steps_section, length_of_steps_section] = "## Steps\n\n" + StepManager.new('lib/spreewald').to_markdown
-  File.open('README.md', 'w') { |f| f.write(readme) }
+  File.open(readme_path, 'w') { |f| f.write(readme) }
+  system "git diff #{readme_path}"
+  puts '', '> Done (see diff above).'
 end
 namespace :all do

data/lib/spreewald/development_steps.rb CHANGED

@@ -16,6 +16,13 @@ Then /^debugger$/ do
   true # Ruby will halt in this line
 end.overridable
+# Pauses Cucumber, but not the application (unlike "Then debugger"). From the
+# test browser, you can interact with your application as you like.
+Then /^pause$/ do
+  print 'Paused. Continue?'
+  STDIN.getc
+end.overridable
 # Waits 2 seconds after each step
 AfterStep('@slow-motion') do
   sleep 2

data/lib/spreewald/email_steps.rb CHANGED

@@ -12,16 +12,16 @@ end.overridable
 # Example:
 #
-#       Then an email should have been sent with:
-#         """
-#         From: max.mustermann@example.com
-#         Reply-To: mmuster@gmail.com
-#         To: john.doe@example.com
-#         Subject: The subject may contain "quotes"
-#         Attachments: ...
+#     Then an email should have been sent with:
+#       """
+#       From: max.mustermann@example.com
+#       Reply-To: mmuster@gmail.com
+#       To: john.doe@example.com
+#       Subject: The subject may contain "quotes"
+#       Attachments: ...
 #
-#         Message body goes here.
-#         """
+#       Message body goes here.
+#       """
 #
 # You can skip lines, of course. Note that the mail body is only checked for
 # _inclusion_.
@@ -97,11 +97,11 @@ end.overridable
 #
 # Example:
 #
-#       And that mail should have the following lines in the body:
-#         """
-#         All of these lines
-#         need to be present
-#         """
+#     And that mail should have the following lines in the body:
+#       """
+#       All of these lines
+#       need to be present
+#       """
 Then /^that e?mail should( not)? have the following lines in the body:$/ do |negate, body|
   expectation = negate ? 'should_not' : 'should'
   email_text_body = MailFinder.email_text_body(@mail)

data/lib/spreewald/file_attachment_steps.rb CHANGED

@@ -19,7 +19,6 @@
 # To simultaneously set the `updated_at` timestamp:
 #
 #     Given the file "some_file" was attached to the profile above at "2011-11-11 11:11"
-#
 Given /^the file "([^"]*)" was attached(?: as (?:([^"]*)\/)?([^"]*))? to the ([^"]*) above(?: at "([^"]*)")?$/ do
   |path_to_file, container_name, relation_name, model_name, time_string|

data/lib/spreewald/timecop_steps.rb CHANGED

@@ -42,23 +42,23 @@ if defined?(Timecop)
   # Example:
   #
-  #       Given the date is 2012-02-10
-  #       Given the time is 2012-02-10 13:40
+  #     Given the date is 2012-02-10
+  #     Given the time is 2012-02-10 13:40
   When /^the (?:date|time) is "?(\d{4}-\d{2}-\d{2}(?: \d{1,2}:\d{2})?)"?$/ do |time|
     Timecop.travel(parse_time(time))
   end.overridable
   # Example:
   #
-  #       Given the time is 13:40
+  #     Given the time is 13:40
   When /^the time is "?(\d{1,2}:\d{2})"?$/ do |time_without_date|
     Timecop.travel(parse_time(time_without_date)) # date will be today
   end.overridable
   # Example:
   #
-  #       When it is 10 minutes later
-  #       When it is a few hours earlier
+  #     When it is 10 minutes later
+  #     When it is a few hours earlier
   When /^it is (\d+|a|some|a few) (seconds?|minutes?|hours?|days?|weeks?|months?|years?) (later|earlier)$/ do |amount, unit, direction|
     amount = case amount
       when 'a'

data/lib/spreewald/web_steps.rb CHANGED

@@ -33,11 +33,11 @@ require 'uri'
 require 'cgi'
-# You can append `within [selector]` to any other web step
+# You can append `within [selector]` to any other web step.
 #
 # Example:
 #
-#       Then I should see "some text" within ".page_body"
+#     Then I should see "some text" within ".page_body"
 When /^(.*) within (.*[^:])$/ do |nested_step, parent|
   patiently do
     with_scope(parent) { step(nested_step) }
@@ -99,12 +99,12 @@ end.overridable
 #
 # Example:
 #
-#       When I fill in "some field" with:
-#       """
-#       Apple
-#       Banana
-#       Pear
-#       """
+#     When I fill in "some field" with:
+#     """
+#     Apple
+#     Banana
+#     Pear
+#     """
 When /^(?:|I )fill in "([^"]*)" (?:with|for):$/ do |field, value|
   patiently do
     fill_in(field, :with => value)
@@ -218,10 +218,9 @@ end.overridable
 #
 # Example:
 #
-#       Then I should see a form with the following values:
-#         | E-mail | foo@bar.com   |
-#         | Role   | Administrator |
-#
+#     Then I should see a form with the following values:
+#       | E-mail | foo@bar.com   |
+#       | Role   | Administrator |
 Then /^I should see a form with the following values:$/ do |table|
   expectations = table.raw
   expectations.each do |label, expected_value|
@@ -285,9 +284,9 @@ end.overridable
 # Example:
 #
-#       I should have the following query string:
-#         | locale        | de  |
-#         | currency_code | EUR |
+#     I should have the following query string:
+#       | locale        | de  |
+#       | currency_code | EUR |
 #
 # Succeeds when the URL contains the given `locale` and `currency_code` params
 Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
@@ -496,7 +495,6 @@ end.overridable
 # Don't forget the trailing slash. Otherwise you'll get the error
 #   expected: /http:\/\/makandra.com(\?[^\/]*)?$/
 #        got: "http://makandra.com/" (using =~)
-#
 Then /^"([^"]*)" should link to "([^"]*)"$/ do |link_label, target|
   patiently do
     link = find_link(link_label)
@@ -512,7 +510,6 @@ end.overridable
 #     Then I should see the element ".panel"
 #     Then I should not see an element ".sidebar"
 #     Then I should not see the element ".sidebar"
-#
 Then /^I should (not )?see (?:an|the) element "([^"]+)"$/ do |negate, selector|
   expectation = negate ? :should_not : :should
   patiently do
@@ -528,7 +525,6 @@ end.overridable
 #     Then I should see the element for the panel
 #     Then I should not see an element for the sidebar
 #     Then I should not see the element for the sidebar
-#
 Then /^I should (not )?see (?:an|the) element for (.*?)$/ do |negate, locator|
   expectation = negate ? :should_not : :should
   selector = _selector_for(locator)
@@ -548,8 +544,7 @@ end.overridable
 #
 # Example:
 #
-#       When I follow "Read more" inside any ".text_snippet"
-#
+#     When I follow "Read more" inside any ".text_snippet"
 When /^I follow "([^"]*)" inside any "([^"]*)"$/ do |label, selector|
   node = find("#{selector} a", :text => label)
   node.click
@@ -602,12 +597,11 @@ end.overridable
 #
 # Example:
 #
-#       Then I should see in this order:
-#         | Alpha Group |
-#         | Augsburg    |
-#         | Berlin      |
-#         | Beta Group  |
-#
+#     Then I should see in this order:
+#       | Alpha Group |
+#       | Augsburg    |
+#       | Berlin      |
+#       | Beta Group  |
 Then /^I should see in this order:?$/ do |text|
   if text.is_a?(String)
     lines = text.split(/\n/)

data/lib/spreewald_support/version.rb CHANGED

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '1.6.0'
+  VERSION = '1.7.0'
 end

data/support/parser.rb CHANGED

@@ -19,7 +19,9 @@ class Parser
     comment.gsub! /.*coding:.*UTF-8.*/, ''
     comment.strip!
     comment_lines = comment.split("\n").take_while { |line| line =~ /^\s*#/ }
-    comment_lines && comment_lines.join("\n").gsub(/^\s*# ?/, '')
+    formatted = comment_lines && comment_lines.join("\n").gsub(/^\s*# ?/, '')
+    formatted if formatted and not formatted.empty?
   end
 end

data/support/step_definition.rb CHANGED

@@ -22,11 +22,11 @@ class StepDefinition
   end
   def to_markdown
-    <<-TEXT
-* **#{kind} #{pretty_step}**
+    spaced_comment = if comment
+      "\n\n" + comment.gsub(/^/, '  ')
+    end
-  #{ comment.gsub /^/, '  ' }
-    TEXT
+    %(* **#{kind} #{pretty_step}**#{spaced_comment})
   end
   def to_s

data/support/step_definition_file.rb CHANGED

@@ -16,12 +16,12 @@ class StepDefinitionFile
   end
   def to_markdown
-    <<-TEXT
-### #{ @filename.split('/').last }
+    spaced_comment = "\n\n" + @comment if @comment
-#{@comment}
+    <<-TEXT
+### #{ @filename.split('/').last } #{spaced_comment}
-#{ steps.collect(&:to_markdown).join("\n\n") }
+#{ steps.collect(&:to_markdown).join("\n\n\n") }
     TEXT
   end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spreewald
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Tobias Kraze
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2016-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber