brine-dsl 0.11.0 → 0.12.0

data/lib/brine/transforming.rb

@@ -1,19 +1,19 @@
 ##
-# @file  transforming.rb
-# Argument Parameter transforming for Brine.
+# @file transforming.rb
+# Transform parameter values for use in Brine.
 ##
 module Brine
 
   ##
   #
-  # A module that converts provided paramters to richer types.
+  # Convert provided paramters to richer types.
   #
   # This eases use of types beyond the Cucumber-provided simple strings.
   ##
   module ParameterTransforming
 
     ##
-    # A class which will transform supported input.
+    # Transform supported input.
     #
     # This implementation is designed around instances being
     # defined with patterns which define whether they should handle
@@ -21,15 +21,19 @@ module Brine
     # (when the patterns match).
     ##
     class Transformer
+
+      ##
+      # Provide an identifier for this Transformer.
+      ##
       attr_reader :type
 
       ##
-      # Return a new Transformer instance configured as specified.
+      # Construct a new Transformer instance configured as specified.
       #
-      # @param [String] type The name of the type produced by this transformer.
+      # @param type [String] Define the name of the type produced by this transformer.
       #                      This will be used for upcoming explicit type conversion.
-      # @param [Regexp] pattern A pattern which input should match for this Transformer to function.
-      # @param [Proc] xfunk The function which will be passed string input and will return
+      # @param pattern [Regexp] Specify a pattern for which this Transformer will handle matching input.
+      # @param xfunk [Proc] Provide the function which will be passed string input and will return
       #                     the output type of this Transformer.
       ##
       def initialize(type, pattern, &xfunc)
@@ -39,10 +43,10 @@ module Brine
       end
 
       ##
-      # Whether this instance should attempt to transform the input.
+      # Indicate whether this instance should attempt to transform the input.
       #
-      # @param [String] input The String input as provided by Cucumber.
-      # @return [Boolean] Whether this#transform should be called for input.
+      # @param input [String] Pass the String input as provided by Cucumber.
+      # @return [Boolean] Indicate whether this#transform should be called for input.
       ##
       def can_handle?(input)
         input =~ @pattern
@@ -51,8 +55,8 @@ module Brine
       ##
       # Transform the provided input.
       #
-      # @param [String] input The String input as provided by Cucumber.
-      # @return [Object] The transformed input into the appropriate type.
+      # @param input [String] Pass the String input as provided by Cucumber.
+      # @return [Object] Return input transformed into the appropriate type.
       ##
       def transform(input)
         STDERR.puts("Handling #{input} as #{@type}") if ENV['BRINE_LOG_TRANSFORMS']
@@ -67,7 +71,7 @@ module Brine
     TZ='(?:Z|(?:[+-]\d{2}:\d{2}))'
 
     ##
-    # The chain of Transformers which will be used to convert parameters.
+    # Expose the chain of Transformers which will be used to convert parameters.
     #
     # In the default implicit mode the list will be iterated over in sequence
     # and the first Transformer which can handle the input will be used.
@@ -130,8 +134,8 @@ module Brine
     ##
     # Transform the provided input using #parameter_transformers.
     #
-    # @param [String] input The String input as provided by Cucumber.
-    # @return [Object] The input converted by the handling Transformer.
+    # @param input [String] Pass the String input as provided by Cucumber.
+    # @return [Object] Return input as converted by the handling Transformer.
     ##
     def transformed_parameter(input)
       parameter_transformers.find {|it| it.can_handle? input }
@@ -143,12 +147,12 @@ module Brine
     #
     # If val is not `expand`able it will be returned as is.
     #
-    # @param [Object] val The value to potentially expand.
-    # @return The expanded value of val.
+    # @param val [Object] Provide the value to potentially expand.
+    # @return [Object] Return the value of val, expanding as appropriate.
     ##
-    def expand(val)
+    def expand(val, binding)
       if val.respond_to? :expand
-        transformed_parameter(val.expand)
+        transformed_parameter(val.expand(binding))
       else
         val
       end
@@ -163,8 +167,10 @@ module Brine
 end
 
 ##
-# Configure Cucumber to use these transformers.
+# Transform grave accent delimited parameters, performing implicit type transformation.
 ##
-Transform /.*/ do |input|
-  transformed_parameter(input)
-end
+ParameterType(
+  name: 'grave_param',
+  regexp: /`([^`]*)`/,
+  transformer: -> (input) { transformed_parameter(input) }
+)

data/lib/brine/type_checking.rb

@@ -1,21 +1,20 @@
 ##
 # @file type_checking.rb
-# Checks whether provided values are instances of a specified type.
+# Check whether provided values are instances of a specified type.
 #
-# Provides validation for an extended set of types supported byJSON.
+# Provide validation for an extended set of types beyond those supported by JSON.
 ##
-
 module Brine
 
   ##
-  # Module which adds functionality to check the type of values.
+  # Support asserting the type of values.
   ##
   module TypeChecking
 
     require 'rspec/expectations'
  
     ##
-    # A registry of checks for types which can return a Matcher for provided types.
+    # Define a registry of checks for types which can return a Matcher for registered types.
     ##
     class TypeChecks
       include RSpec::Matchers
@@ -23,7 +22,7 @@ module Brine
       ##
       # Initialize an instance with default checks or those provided.
       #
-      # @param [Hash<String, Matcher>] A hash of Matchers by type, where the Matcher value will be
+      # @param [Hash<String, Matcher>] Provide a hash of Matchers by type, where the Matcher value will be
       #                                used as the Matcher for the specified type.
       #                                It is expected that no map will be provided and the default
       #                                mapping will therefore be used.
@@ -41,9 +40,9 @@ module Brine
       ##
       # Return the Matcher for the specified type or die if not present.
       #
-      # @param [Class] type The type whose Matcher should be returned.
-      # @return [RSpec::Matcher] The Matcher configured for `type`.
-      # @throw Exception if no Matcher exists for `type`.
+      # @param type [Class] Specify the type whose Matcher should be returned.
+      # @return [RSpec::Matcher] Return the Matcher registered for `type`.
+      # @throw Exception Raise an exception if no Matcher exists for `type`.
       ##
       def for_type(type)
         @map[type.to_sym] || raise("Unsupported type #{type}")
@@ -52,8 +51,8 @@ module Brine
       ##
       # Register the provided matcher for the specified type.
       #
-      # @param[Class] type The type for which the Matcher will be registered.
-      # @param[RSpec::Matcher] matcher A matcher to verify that input is an instance of type.
+      # @param type [Class] Specify the type for which the Matcher will be registered.
+      # @param[RSpec::Matcher] matcher Provide a matcher to verify that input is an instance of type.
       ##
       def register_matcher(type, matcher)
         @map[type.to_sym] = matcher
@@ -61,7 +60,7 @@ module Brine
     end
 
     ##
-    # The currently active TypeCheck instance as a property, instantiating as needed.
+    # Expose the currently active TypeCheck instance as a property, instantiating as needed.
     ##
     def type_checks
       @type_check ||= TypeChecks.new
@@ -73,8 +72,9 @@ module Brine
     # This is the primary interface for type_checking to the rest of the system,
     # and is the only one expected to be used during test execution.
     #
-    # @param [Class] type The type for which a Matcher should be returned.
-    # @return [RSpec::Matcher] The Matcher currently registered for the type.
+    # @param type [Class] Specify the type for which a Matcher should be returned.
+    # @return [RSpec::Matcher] Return the Matcher currently registered for the type.
+    # @throw Exception Raise an exception if no Matcher exists for `type`.
     ##
     def type_check_for(type)
       type_checks.for_type(type)
@@ -86,3 +86,14 @@ module Brine
   ##
   include TypeChecking
 end
+
+require 'brine/transforming'
+
+##
+# Assert that the selected value satisfies the specified type check.
+#
+# @param type [Object] Specify the key for the type checker to evaluate the selection.
+##
+Then('it is a valid {grave_param}') do |type|
+  perform { selector.assert_that(type, binding) {|t| type_check_for(t) } }
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: brine-dsl
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Matt Whipple
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 2019-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: 4.0.0.rc.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: 4.0.0.rc.1
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +137,7 @@ files:
 - brine-dsl.gemspec
 - feature_setup.rb
 - lib/brine.rb
+- lib/brine/assertions.rb
 - lib/brine/cleaning_up.rb
 - lib/brine/client_building.rb
 - lib/brine/coercing.rb
@@ -144,18 +145,10 @@ files:
 - lib/brine/mustache_expanding.rb
 - lib/brine/performing.rb
 - lib/brine/requesting.rb
-- lib/brine/rest_steps.rb
 - lib/brine/selecting.rb
-- lib/brine/step_definitions/assertions.rb
-- lib/brine/step_definitions/assignment.rb
-- lib/brine/step_definitions/cleanup.rb
-- lib/brine/step_definitions/perform.rb
-- lib/brine/step_definitions/request_construction.rb
-- lib/brine/step_definitions/selection.rb
 - lib/brine/test_steps.rb
 - lib/brine/transforming.rb
 - lib/brine/type_checking.rb
-- lib/brine/util.rb
 homepage: http://github.com/brightcove/brine
 licenses:
 - MIT

data/lib/brine/rest_steps.rb

@@ -1,119 +0,0 @@
-require 'rspec'
-require 'brine/util'
-require 'brine/selecting'
-require 'jsonpath'
-
-# Chopping Block
-Then(/^the response #{RESPONSE_ATTRIBUTES} has `([^`]*)` with a value that is not empty$/) do
-  |attribute, member|
-  replaced_with('Then', "the value of the response #{attribute} child `#{member}` is not empty", '0.9')
-end
-
-Then(/^the response #{RESPONSE_ATTRIBUTES} includes? the entries:$/) do |attribute, table|
-  replaced_with('Then', "the value of the response #{attribute} is including:", '0.9', kv_table(table).to_json)
-end
-
-Then(/^the response body is a list of length (\d+)$/) do |length|
-  replaced_with('Then', "the value of the response body is of length `#{length}`", '0.9')
-end
-
-Then(/^the response body is a list (with|without) an entry containing:$/) do |with, data|
-  neg = (with == 'without') ? 'not ' : ''
-  replaced_with('Then', "the value of the response body does #{neg}have any element that is including:", '0.9', table.hashes.to_json)
-end
-
-Then(/^the response body has `([^`]*)` which (in|ex)cludes? the entries:$/) do
-  |child, in_or_ex, table|
-  neg = (in_or_ex=='ex') ? 'not ' : ''
-  replaced_with('Then', "the value of the response body child `#{child}` is #{neg}including:", '0.9', kv_table(table).to_json)
-end
-
-# This file is legacy or unsorted steps which will be deprecated or moved into
-# more appropriate homes
-
-def not_if(val) val ? :not_to : :to end
-
-# Return a table that that is a key value pair in a format ready for consumption
-def kv_table(table)
-  transform_table!(table).rows_hash
-end
-
-# TODO: Requires extensible is_a_valid for deprecation
-Then(/^the response body is a list which all are (\w+)$/) do |matcher|
-  pass_it = method(matcher.to_sym).call
-  expect(response_body_child.first).to all(pass_it)
-end
-
-# FIXME: In the process of being deprecated
-When(/^`([^`]*)` is bound to `([^`]*)` from the response body$/) do |name, path|
-  binding[name] = response_body_child(path).first
-end
-
-#
-# Response attribute (non-body) assertions
-#
-Then(/^the response #{RESPONSE_ATTRIBUTES} contains? null fields:$/) do |attribute, table|
-  expect(response)
-    .to have_attributes(attribute.to_sym =>
-                        include(table.raw.flatten.collect{|v| [v, be_nil]}.to_h))
-end
-
-Then(/^the response #{RESPONSE_ATTRIBUTES} contains? non null fields:$/) do |attribute, table|
-  expect(response)
-    .to have_attributes(attribute.to_sym =>
-                        include(table.raw.flatten.collect{|v| [v, be_not_nil]}.to_h))
-end
-
-#
-# Response body assertions
-#
-# TODO: Write specifications around this
-Then(/^the response body does not contain fields:$/) do |table|
-  expect(response_body_child.first.keys).to_not include(*table.raw.flatten)
-end
-
-#TODO: Maybe worth optimizing these 2 to O(n) after tests are in place
-Then(/^the response body is a list sorted by `([^`]*)` ascending$/) do |path|
-  values = response_body_child(path)
-  expect(values).to eq values.sort{|a,b| a.to_s.downcase <=> b.to_s.downcase}
-end
-
-Then(/^the response body is a list sorted by `([^`]*)` descending$/) do |path|
-  values = response_body_child(path)
-  expect(values).to eq values.sort{|a,b| b.to_s.downcase <=> a.to_s.downcase}
-end
-
-
-Then(/^the response body is (\w+)$/) do |matcher|
-  pass_it = method(matcher.to_sym).call
-  expect(response_body_child.first).to pass_it
-end
-
-#
-# Polling assertions
-#
-Then(/^a non\-empty list is eventually returned at `([^`]*)`$/) do |path|
-  retry_for(120, 3) do
-    send_request(parse_method('GET'), path)
-    expect(response_body_child.first).to_not be_empty
-  end
-end
-
-Then(/^the resource is eventually available at `([^`]*)`$/) do |path|
-  retry_for(120, 3) do
-    send_request(parse_method('GET'), path)
-    expect(response).to have_attributes(:status => 200)
-  end
-end
-
-# TODO: Parameterize polling length
-Then(/^the property `([^`]*)` is eventually `([^`]*)` at `([^`]*)`$/) do |field, value, path|
-  retry_for(180) do
-    send_request(parse_method('GET'), path)
-    expect(response_body_child.first).to include(field => value)
-  end
-end
-
-def response_body_child(path="")
-  JsonPath.new("$.#{path}").on(response.body.to_json)
-end

data/lib/brine/step_definitions/assertions.rb

@@ -1,50 +0,0 @@
-# assertions.rb - General assertions to be used with a Selector
-
-Then(/^it is equal to `([^`]*)`$/) do |value|
-  perform { selector.assert_that(value) {|v| eq v} }
-end
-Then(/^it is equal to:$/) do |value|
-  perform { selector.assert_that(value) {|v| eq v} }
-end
-Then(/^it is matching `([^`]*)`$/) do |value|
-  perform { selector.assert_that(value) {|v| match v} }
-end
-Then (/^it is matching:$/) do |value|
-  perform { selector.assert_that(value) {|v| match v} }
-end
-Then(/^it is greater than `([^`]*)`$/) do |value|
-  perform { selector.assert_that(value) {|v| be > v} }
-end
-Then(/^it is greater than or equal to `([^`]*)`$/) do |value|
-  perform { selector.assert_that(value) {|v| be >= v} }
-end
-Then(/^it is less than `([^`]*)`$/) do |value|
-  perform { selector.assert_that(value) {|v| be < v} }
-end
-Then(/^it is less than or equal to `([^`]*)`$/) do |value|
-  perform { selector.assert_that(value) {|v| be <= v} }
-end
-
-# Be a little smarter than default.
-Then(/^it is empty$/) do
-  perform { selector.assert_that(nil) do
-    satisfy{|i| i.nil? || (i.respond_to?(:empty?) && i.empty?) }
-  end }
-end
-
-Then(/^it is including `([^`]*)`$/) do |value|
-  perform { selector.assert_that(value) {|v| include v } }
-end
-Then(/^it is including:$/) do |value|
-  perform { selector.assert_that(value) {|v| include v } }
-end
-
-Then(/^it is a valid `([^`]*)`$/) do |type|
-  perform { selector.assert_that(type) {|t| type_check_for(t) } }
-end
-
-Then(/^it is of length `([^`]*)`$/) do |length|
-  perform { selector.assert_that(length) do |l|
-    satisfy{|i| i.respond_to?(:length) && i.length == l}
-  end }
-end

data/lib/brine/step_definitions/assignment.rb

@@ -1,42 +0,0 @@
-##
-# @file assignment.rb
-# Assignment related steps.
-##
-
-##
-# Assign the provided parameter.
-#
-# @param name - The identifier to which the value will be bound.
-# @param value - The value to bind to the identifier.
-When(/^`([^`]*)` is assigned `([^`]*)`$/) do |name, value|
-  perform { bind(name, value) }
-end
-
-##
-# Assign a random string (UUID).
-#
-# @param name - The identifier to which a random string will be bound.
-When(/^`([^`]*)` is assigned a random string$/) do |name|
-  perform { bind(name, SecureRandom.uuid) }
-end
-
-##
-# Assign a current timestamp.
-#
-# @param name - The identifier to which the current timestamp will be bound.
-When(/^`([^`]*)` is assigned a timestamp$/) do |name|
-  perform { bind(name, DateTime.now) }
-end
-
-##
-# Assign a value extracted from a response attribute.
-#
-# @param name - The identifier to which the extracted value will be bound.
-# @param attribute - The response member from which the value will be extracted.
-# @param plural - When the path is provided,
-# @param path - The path within the member to extract.
-# whether to extract a single match or a collection of all matching.
-When(/^`([^`]*)` is assigned the response #{RESPONSE_ATTRIBUTES}(?: child(ren)? `([^`]*)`)?$/) do
-  |name, attribute, plural, path|
-  perform { bind(name, dig_from_response(attribute, path, !plural.nil?)) }
-end