brine-dsl 0.8.1 → 0.9.0

data/docs/src/index.adoc

@@ -1,28 +0,0 @@
-= Brine
-Matt Whipple <http://github.com/mwhipple[@mwhipple]>
-:description: A Cucumber-based DSL for testing REST APIs
-:keywords: Brine, Cucumber, REST, DSL
-
-Cucumber DSL for testing REST APIs
-
-== Overview
-
-The documentation should provide the background information to
-get started using Brine and a framework for figuring out specific details.
-The focus of guides will be on concepts and high level information while
-more comprehensive and finer grained information will be provided by
-specifications and source. Recipes will be provided for problems which
-are common, interesting, or anything anyone wants to contribute :).
-
-== Documents
-
-link:guide.html[icon:book[] User Guide]::
-  A guide to writing specifications using the Brine provided DSL.
-
-link:specs.html[icon:cogs[] Specification]::
-  The Gherkin specification for all of Brine's features.
-
-link:cookbook.html[icon:cutlery[] Cookbook]::
-  Solutions to some problems which Brine does not solve directly.
-
-_TODO: The current Cookbook name should be qualified to match its scope_

data/docs/src/spec.erb

@@ -1,121 +0,0 @@
-<%# TODO: Indentation can't be used because of significance to adoc...comment liberally or abuse tags %>
-<%# TODO: Add a lot of CSS classes so the output can be matched back to this template %>
-
-=== [feature name]#<%= feature['name'] %>#
-
-<%if feature.key?('description') %>
-<%# FIXME: Styling doesn't work here and description seems to contain background %>
-<%= feature['description'] %>
-<% end %>
-
-<%if feature.key?('background') %>
-==== [background name]#<%= feature['background']['name'] %>#
-
-<%if feature['background'].key?('description') %>
-[background description]#<%= feature['background']['description'] %>#
-<% end %>
-
-<%if feature['background'].key?('steps') %>
-[.step-list]
-<% feature['background']['steps'].each do |step| %>
-* *<%= step['keyword'].strip %>* <%= step['name'] %>
-
-<%if step.key?('doc_string') %>
-[source,gherkin]
-----
-<%= step['doc_string']['value'] %>
-----
-<% end %>
-
-<%if step.key?('rows') %>
-+<% if step['rows'].first && step['rows'].first.key?('cols') %>
-[<%= step['rows'].first['cols'] %>]
-<% end %>
-
-|====
-<% step['rows'].each_with_index do |row, index| %>
-<% row['cells'].each_with_index do |cell, i| %>
-<% if row.key?('cell-styles') && row['cell-styles'].length > i %>
-<%= row['cell-styles'][i] %>
-<% end %>
-| <%= cell %>
-<% end %>
-<% end %>|====
-<% end %>
-<% end %>
-<% end %>
-
-<%if feature['background'].key?('examples')
-  example = feature['background']['examples'] %>
-
-==== EX: <%= example['keyword'].strip %> <%= example['name'] %>
-
-<% if example['rows'].first && example['rows'].first.key?('cols') %>
-[<%= example['rows'].first['cols'] %>]
-<% end %>
-
-|====
-<% example['rows'].each_with_index do |row, index| %>
-<% row['cells'].each_with_index do |cell, i| %>
-<% if row.key?('cell-styles') && row['cell-styles'].length > i %>
-<%= row['cell-styles'][i] %>
-<% end %>
-| <%= cell %>
-<% end %>
-<% if index == 0 %>
-<% end %>
-<% end %>
-|====
-<% end %>
-<% end %>
-
-<%if feature.key?('scenarios') %>
-<% feature['scenarios'].each do |scenario| %>
-==== [scenario name]#<%= scenario['name'] %>#
-<%if scenario.key?('description') %>
-<%= scenario['description'] %>
-<% end %>
-<%if scenario.key?('steps') %>[.step-list]<% scenario['steps'].each do |step| %>
-* *<%= step['keyword'].strip %>* <%= step['name'] %>
-<%if step.key?('doc_string') %>
-[source,gherkin]
-----
-<%= step['doc_string']['value'] %>
-----
-<% end %>
-<%if step.key?('rows') %>
-+<% if step['rows'].first && step['rows'].first.key?('cols') %>
-[<%= step['rows'].first['cols'] %>]
-<% end %>
-|====
-<% step['rows'].each_with_index do |row, index| %>
-<% row['cells'].each_with_index do |cell, i| %>
-<% if row.key?('cell-styles') && row['cell-styles'].length > i %>
-<%= row['cell-styles'][i] %>
-<% end %>
-| <%= cell %>
-<% end %>
-<% end %>|====
-<% end %>
-<% end %>
-<% end %>
-
-<%if scenario.key?('examples')
-  example = scenario['examples'] %>
-===== [example name]#<%= example['keyword'].strip %> <%= example['name'] %>#
-
-<% if example['rows'].first && example['rows'].first.key?('cols') %>
-[<%= example['rows'].first['cols'] %>]
-<% end %>
-|====
-<% example['rows'].each_with_index do |row, index| %>
-<% row['cells'].each_with_index do |cell, i| %>
-<% if row.key?('cell-styles') && row['cell-styles'].length > i %><%= row['cell-styles'][i] %><% end %>
-| <%= cell %>
-<% end %> <%# cell %>
-<% if index == 0 %>
-<% end %>
-<% end %>|====
-<% end %>
-<% end %>
-<% end %>

data/docs/src/specs.adoc

@@ -1,37 +0,0 @@
-= icon:cogs[] Brine Specifications
-Matt Whipple <http://github.com/mwhipple[@mwhipple]>
-:description: Specifications for Brine
-:keywords: Brine, Cucumber, RESt, DSL
-
-== Request Construction
-
-gherkin::../../features/request_construction/basic.feature[spec.erb]
-gherkin::../../features/request_construction/body.feature[spec.erb]
-gherkin::../../features/request_construction/params.feature[spec.erb]
-gherkin::../../features/request_construction/headers.feature[spec.erb]
-gherkin::../../features/request_construction/clearing.feature[spec.erb]
-
-== Resource Cleanup
-
-gherkin::../../features/resource_cleanup/cleanup.feature[spec.erb]
-
-== Assignment
-
-gherkin::../../features/assignment/parameter.feature[spec.erb]
-gherkin::../../features/assignment/random.feature[spec.erb]
-gherkin::../../features/assignment/timestamp.feature[spec.erb]
-gherkin::../../features/assignment/response_attribute.feature[spec.erb]
-
-== Selection
-
-gherkin::../../features/selectors/any.feature[spec.erb]
-gherkin::../../features/selectors/all.feature[spec.erb]
-
-== Assertion
-
-gherkin::../../features/assertions/is_equal_to.feature[spec.erb]
-gherkin::../../features/assertions/is_matching.feature[spec.erb]
-gherkin::../../features/assertions/is_including.feature[spec.erb]
-gherkin::../../features/assertions/is_empty.feature[spec.erb]
-gherkin::../../features/assertions/is_of_length.feature[spec.erb]
-gherkin::../../features/assertions/is_a_valid.feature[spec.erb]

data/features/argument_transforms/boolean.feature

@@ -1,37 +0,0 @@
-Feature: An argument that could represent a boolean value will be
-    transformed into a boolean type.
-
-  Scenario Outline: Assorted basic inputs are provided.
-    Given a file named "features/transform_boolean.feature" with:
-      """
-
-Feature: Transform boolean arguments.
-  Scenario: Docstring simple value.
-    When the response body is assigned:
-      \"\"\"
-      <input>
-      \"\"\"
-    Then the response body as JSON is:
-      \"\"\"
-      '<expected>'
-      \"\"\"
-
-  Scenario: Inline simple value.
-    When the response body is assigned `<input>`
-    Then the response body as JSON is:
-      \"\"\"
-      '<expected>'
-      \"\"\"
-
-      """
-    When I run `cucumber --strict features/transform_boolean.feature`
-    Then the output should contain:
-      """
-      2 passed
-      """
-    And it should pass
-
-    Examples:
-      | input     | expected |
-      | true      | true     |
-      | false     | false    |

data/features/argument_transforms/datetime.feature

@@ -1,45 +0,0 @@
-Feature: An argument that could represent a date/time value will be
-    transformed into a time type.
-
-  Scenario: Assorted basic inputs are provided.
-    Given a file named "features/transform_datetime.feature" with:
-      """
-
-Feature: Transform date/time arguments.
-  Scenario: Docstring datetime is serialized properly.
-    When the response body is assigned:
-      \"\"\"
-      2017-01-01T09:00:00Z
-      \"\"\"
-    Then the response body as JSON is:
-      \"\"\"
-      '"2017-01-01 09:00:00 UTC"'
-      \"\"\"
-
-  Scenario: Inline datetime is serialized properly.
-    When the response body is assigned `2017-01-01T09:00:00Z`
-    Then the response body as JSON is:
-      \"\"\"
-      '"2017-01-01 09:00:00 UTC"'
-      \"\"\"
-
-  Scenario: Value Comparison
-    When `now` is assigned a timestamp
-    And `then` is assigned `2017-01-01T12:00:00Z`
-    Then the value of `{{then}}` is less than `{{now}}`
-
-  Scenario: Child Comparison
-    When `now` is assigned a timestamp
-    And the response body is assigned:
-      \"\"\"
-      {"my_timestamp": "{{now}}"}
-      \"\"\"
-    Then the value of the response body child `my_timestamp` is greater than `2017-01-01T12:00:00Z`
-
-      """
-    When I run `cucumber --strict features/transform_datetime.feature`
-    Then the output should contain:
-      """
-      4 passed
-      """
-    And it should pass

data/features/argument_transforms/integer.feature

@@ -1,41 +0,0 @@
-Feature: An argument that could represent an integer will be
-    transformed into an integer type.
-
-  Scenario Outline: Assorted basic inputs are provided.
-    Given a file named "features/transform_integer.feature" with:
-      """
-
-Feature: Transform integer arguments.
-  Scenario: Docstring simple value.
-    When the response body is assigned:
-      \"\"\"
-      <input>
-      \"\"\"
-    Then the response body as JSON is:
-      \"\"\"
-      '<expected>'
-      \"\"\"
-
-  Scenario: Inline simple value.
-    When the response body is assigned `<input>`
-    Then the response body as JSON is:
-      \"\"\"
-      '<expected>'
-      \"\"\"
-
-      """
-    When I run `cucumber --strict features/transform_integer.feature`
-    Then the output should contain:
-      """ar
-      2 passed
-      """
-    And it should pass
-
-    Examples:
-      |               input |            expected |
-      |                   0 |                   0 |
-      |                  -0 |                   0 |
-      |                  10 |                  10 |
-      |                 -10 |                 -10 |
-      |  123456789123456789 |  123456789123456789 |
-      | -123456789123456789 | -123456789123456789 |

data/features/argument_transforms/list.feature

@@ -1,46 +0,0 @@
-Feature: An argument that could represent a JSON list will be
-    transformed into a list whose elements will be also be transformed.
-
-  Scenario Outline: Assorted basic inputs are provided.
-    Given a file named "features/transform_list.feature" with:
-      """
-
-Feature: Transform list arguments.
-  Scenario: Docstring simple list.
-    When the response body is assigned:
-      \"\"\"
-      <input>
-      \"\"\"
-    Then the response body as JSON is:
-      \"\"\"
-      '<expected>'
-      \"\"\"
-
-  Scenario: Inline simple list.
-    When the response body is assigned `<input>`
-    Then the response body as JSON is:
-      \"\"\"
-      '<expected>'
-      \"\"\"
-
-      """
-    When I run `cucumber --strict features/transform_list.feature`
-    Then the output should contain:
-      """
-      2 passed
-      """
-    And it should pass
-
-    Examples:
-      | input                   | expected                |
-      | []                      | []                      |
-      | ["a", "b"]              | ["a","b"]               |
-      | ["a"  ,  "b" ]          | ["a","b"]               |
-      | ["  a", " b "]          | ["  a"," b "]           |
-      | [true, "false"]         | [true,"false"]          |
-      | [1,-3,"-5"]             | [1,-3,"-5"]             |
-      | ["foo,bar","baz"]       | ["foo,bar","baz"]       |
-      | ["foo,bar,baz"]         | ["foo,bar,baz"]         |
-      | ["foo\\"","bar"]        | ["foo\\"","bar"]        |
-      | ["fo\\"o\\",bar","baz"] | ["fo\\"o\\",bar","baz"] |
-      | [{"i":1},{"i":2}, "h"]  | [{"i":1},{"i":2},"h"]   |

data/features/argument_transforms/object.feature

@@ -1,66 +0,0 @@
-Feature: An argument that could represent a JSON object will be
-    transformed into an object whose elements will also be transformed.
-
-  Scenario Outline: Assorted basic inputs are provided.
-    Given a file named "features/transform_object.feature" with:
-      """
-
-Feature: Transform object arguments.
-  Scenario: Docstring simple object.
-    When the response body is assigned:
-      \"\"\"
-      <input>
-      \"\"\"
-    Then the response body as JSON is:
-      \"\"\"
-      '<expected>'
-      \"\"\"
-
-  Scenario: Inline simple object.
-    When the response body is assigned `<input>`
-    Then the response body as JSON is:
-      \"\"\"
-      '<expected>'
-      \"\"\"
-
-      """
-    When I run `cucumber features/transform_object.feature`
-    Then the output should contain:
-      """
-      2 passed
-      """
-    And it should pass
-
-    Examples:
-      | input                                               | expected                                      |
-      | {}                                                  | {}                                            |
-      | {"a":1}                                             | {"a":1}                                       |
-      | {"foo":"bar", "num":1, "list": ["1", 2, true]}      | {"foo":"bar","num":1,"list":["1",2,true]}     |
-      | {"foo": {"bar":{ "num":1, "list": ["1", 2, true]}}} | {"foo":{"bar":{"num":1,"list":["1",2,true]}}} |
-      | {"foo": "\"list\": [\"1\", 2, true]"}               | {"foo":"\\"list\\": [\\"1\\", 2, true]"}      |
-            
-  Scenario: Passed an Object split over multiple lines
-    Given a file named "features/transform_object_splitline.feature" with:
-      """
-
-Feature: Using an object argument split over multiple lines
-  Scenario: Object split over lines
-    When the response body is assigned:
-      \"\"\"
-      {
-        "foo":"bar"
-      }
-      \"\"\"
-    Then the value of the response body is equal to:
-      \"\"\"
-      {"foo":"bar"}
-      \"\"\"
-
-      """
-    When I run `cucumber --strict features/transform_object_splitline.feature`
-    Then the output should contain:
-      """
-      1 passed
-      """
-    And it should pass
-            

data/features/argument_transforms/quoted.feature

@@ -1,41 +0,0 @@
-Feature: An argument that is quoted will be (not) transformed into
-    into a string, regardless of any more specific data type the
-    quoted value may resemble.
-
-  Scenario Outline: Assorted basic inputs are provided.
-    Given a file named "features/transform_quoted.feature" with:
-      """
-
-Feature: Transform quoted arguments.
-  Scenario: Docstring simple value.
-    When the response body is assigned:
-      \"\"\"
-      <input>
-      \"\"\"
-    Then the response body as JSON is:
-      \"\"\"
-      '<expected>'
-      \"\"\"
-
-    Scenario: Inline simple value.
-      When the response body is assigned `<input>`
-      Then the response body as JSON is:
-        \"\"\"
-        '<expected>'
-        \"\"\"
-
-      """
-    When I run `cucumber --strict features/transform_quoted.feature`
-    Then the output should contain:
-      """
-      2 passed
-      """
-    And it should pass
-
-    Examples:
-      | input               | expected            |
-      | "true"              | "true"              |
-      | "123"               | "123"               |
-      | " -123 "            | " -123 "            |
-      | "["foo","bar"]"     | "[\"foo\",\"bar\"]" |
-      | "{"foo":"bar"}"     | "{\"foo\":\"bar\"}" |