brine-dsl 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 690350fecddec6e5978bcb684189f2ac742a7918
-  data.tar.gz: 6a37f34f8424ac9422517f3cc0282cb8eb5b321d
+SHA256:
+  metadata.gz: 906c5a5791f773d74511eb23f0dd53a1ee25f29d3e7b4318f8b1b2f4299c5696
+  data.tar.gz: 06d1b4ffc9d6a745f06b2ebb7c6164b650d3c5fa6d6cd918dcb9c406a1b98656
 SHA512:
-  metadata.gz: 41b4ddf87394b647485b3ae8f77c517742661330583650eebf980e52050b2b8878f6d27c150613682e4da04b3ad0c109c62d97018a36effcb698e4f5bda3caae
-  data.tar.gz: 786aa5afef5cca973ac32c12b5fac728810da1d1eeface795254ac9d61f2b1f14b6fb4978c7f14463616f7342f45e30aabe02b566e32af09b64e9e2687a9e326
+  metadata.gz: d94513fc23ac9e9d5d21e45641821c1e90e9b06245947d68007277e033efff64fc6bc2054750e0d451c8455c8088614a52621cd63e45f3b925ef20171f8be7c0
+  data.tar.gz: 3395d12a8fd7c8ee1b3df7e86474807ec3c666e49a3d6c974f77dad51d5175b87ece0ecbc016cd823e1beb7feba8357ec2067a4a2167400405478e444cffab6a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brine-dsl (0.10.2.pre.SNAPSHOT)
+    brine-dsl (0.11.0)
       cucumber (~> 2.4)
       faraday (~> 0.12)
       faraday_middleware (~> 0.12)
@@ -52,15 +52,15 @@ GEM
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.1)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.2)
     to_regexp (0.2.1)
 
 PLATFORMS

data/Rakefile

@@ -1,12 +1,5 @@
 # encoding: utf-8
 require 'bundler'
-require 'cucumber/rake/task'
-
-Cucumber::Rake::Task.new(:check) do |t|
-  # Cucumber needs some help to deal with the features and support being split.
-  t.libs = "#{__dir__}"
-end
 
 Bundler::GemHelper.install_tasks
 
-task default: %w[check]

data/lib/brine.rb

@@ -30,7 +30,7 @@ def brine_mix
   require 'brine/step_definitions/perform'
   require 'brine/step_definitions/selection'
 
-  require 'brine/transforms'
+  require 'brine/transforming'
   require 'brine/hooks'
 
   Brine

data/lib/brine/coercing.rb

@@ -69,6 +69,7 @@ module Brine
       def coerce(first, second)
         @map[[first.class, second.class]].call(first, second)
       end
+
     end
 
     ##

data/lib/brine/mustache_expanding.rb

@@ -2,7 +2,6 @@
 # @file mustache_expanding.rb
 # Support for expanding Mustache templates with a defined binding.
 ##
-
 module Brine
 
   ##
@@ -33,15 +32,52 @@ module Brine
 
     ##
     # Expanded Mustache template using binding environment.
-    # Mustache in...no Mustache out.
+    #
+    # This exists to support latent expansion and template retrieval.
     #
     # @param [String] template Template content to expand with binding.
     # @return [String] The contents of `template` with any expansions done using `binding`.
     ##
-    def shave_value(template)
-      Mustache.render(template, binding)
+    class BrineTemplate < Mustache
+
+      ##
+      # Instantiate a Brine template.
+      #
+      # @param tmpl [String] The string content of the template.
+      # @param binding [Hash] A reference to the (mutable) binding.
+      ##
+      def initialize(tmpl, binding)
+        @template = tmpl
+        @binding = binding
+      end
+
+      ##
+      # Expand the template using the current bindings.
+      ##
+      def expand
+        begin
+          context.push(@binding)
+          render
+        ensure
+          context.pop
+        end
+      end
+
+      ##
+      # Stringify as template contents.
+      #
+      # This supports cases such as dynamic steps
+      # where a string is expected but the template should not yet
+      # be expanded.
+      ##
+      def to_s
+        @template
+      end
     end
 
+    def as_template(str)
+      BrineTemplate.new(str, binding)
+    end
   end
 
   ##

data/lib/brine/selecting.rb

@@ -3,6 +3,8 @@
 # Selection of one or more values to be used by Brine (normally for assertion).
 ##
 
+require 'brine/transforming.rb'
+
 module Brine
 
   ##
@@ -23,6 +25,7 @@ module Brine
     # which it applied against the targeted value.
     ##
     class Selector
+      include ParameterTransforming
       include RSpec::Matchers
 
       ##
@@ -69,7 +72,7 @@ module Brine
       def assert_that(value, negated=nil)
         # shim while moving negation to assertions.
         negated = @negated if negated.nil?
-        target, value = coercer.coerce(@target, value)
+        target, value = coercer.coerce(expand(@target), expand(value))
         message = negated ? :to_not : :to
         matcher = filter_matcher(yield(value))
         expect(target).send(message, matcher)
@@ -156,11 +159,12 @@ end
 RESPONSE_ATTRIBUTES='(status|headers|body)'
 Then(/^the value of `([^`]*)` is( not)? (.*)$/) do |value, negated, assertion|
   select(value, (!negated.nil?))
-  step "it is #{assertion}"
+  # Stringify in case the assertion clause is a template.
+  step "it is #{assertion.to_s}"
 end
 
 def dig_from_response(attribute, path=nil, plural=false)
   root = response.send(attribute.to_sym)
   return root if !path
-  JsonPath.new("$.#{path}").send(plural ? :on : :first, root)
+  JsonPath.new("$.#{path}").send(plural ? :on : :first, expand(root))
 end

data/lib/brine/transforming.rb

@@ -0,0 +1,170 @@
+##
+# @file  transforming.rb
+# Argument Parameter transforming for Brine.
+##
+module Brine
+
+  ##
+  #
+  # A module that converts 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.
+    #
+    # This implementation is designed around instances being
+    # defined with patterns which define whether they should handle
+    # provided input, and procs which should do the transformation
+    # (when the patterns match).
+    ##
+    class Transformer
+      attr_reader :type
+
+      ##
+      # Return a new Transformer instance configured as specified.
+      #
+      # @param [String] type 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
+      #                     the output type of this Transformer.
+      ##
+      def initialize(type, pattern, &xfunc)
+        @type = type
+        @pattern = pattern
+        @xfunc = xfunc
+      end
+
+      ##
+      # 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.
+      ##
+      def can_handle?(input)
+        input =~ @pattern
+      end
+
+      ##
+      # Transform the provided input.
+      #
+      # @param [String] input The String input as provided by Cucumber.
+      # @return [Object] The transformed input into the appropriate type.
+      ##
+      def transform(input)
+        STDERR.puts("Handling #{input} as #{@type}") if ENV['BRINE_LOG_TRANSFORMS']
+        @xfunc.call(input)
+      end
+    end
+
+    # Constants used for DateTime transformation.
+    DATE='\d{4}-\d{2}-\d{2}'
+    TIME='\d{2}:\d{2}:\d{2}'
+    MILLIS='(?:\.\d{3})?'
+    TZ='(?:Z|(?:[+-]\d{2}:\d{2}))'
+
+    ##
+    # 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.
+    # The order of the Transformers is therefore significant: higher priority
+    # or more specific Transfomers should be earlier in the list than those
+    # that are lower priority or can handle a superset of supported input
+    # relative to those previous.
+    #
+    # This exposed for direct list manipulation as an advanced customization point.
+    ##
+    def parameter_transformers
+      @parameter_transformers ||= [
+
+        # These will be deprecated in preference for explicit type specification.
+        Transformer.new('Double Quoted', /\A".*"\z/) {|input|
+          input[1..-2] },
+        Transformer.new('Single Quoted', /\A'.*'\z/) {|input|
+          input[1..-2] },
+
+        # Whitespace removal transforms
+        # Handle stripping leading and trailing whitespace.
+        # These are split out from the transforms to consolidate the behavior.
+        # They call transform on the stripped value so that subsequent transforms no longer
+        # have to deal with such whitespace.
+        #
+        # Note that these need to deal with multiline string arguments which require
+        # the multiline flag and \A/\z anchors to properly operate on the full string rather than
+        # being line oriented. The calls to +#strip+ are also not likely to properly clean up
+        # multiline strings but is just meant as a (potentially ineffective) optimization over
+        # recursive calls and capturing.
+        Transformer.new('Trailing Whitespace', /\A\s+.*\z/) {|input|
+          transformed_parameter(input.strip) },
+        Transformer.new('Leading Whitespace', /\A.*\s+\z/m) {|input|
+          transformed_parameter(input.strip) },
+
+        # Template Expansion
+        Transformer.new('Template', /.*{{.*}}.*/) {|input|
+          as_template(input) },
+
+        # Scalars
+        Transformer.new('Integer', /\A-?\d+\z/) {|input|
+          input.to_i },
+        Transformer.new('Boolean', /\Atrue|false\z/) {|input|
+          input.to_s == "true" },
+        # This presently does not support flags after the closing slash, support for these should be added as needed
+        Transformer.new('Regex', /\A\/.*\/\z/) {|input|
+          Regexp.new(input[1..-2]) },
+        Transformer.new('DateTime', /^#{DATE}T#{TIME}#{MILLIS}#{TZ}$/) {|input|
+          Time.parse(input) },
+
+        # Structures
+        Transformer.new('Array', /\A\[.*\]\z/m) {|input| JSON.parse(input) },
+        Transformer.new('Object', /\A{.*}\z$/m) {|input| JSON.parse(input) },
+
+        # String sentinel...this is last to act as a catch-all.
+        Transformer.new('String', /.*/) {|input| input },
+      ]
+    end
+
+    ##
+    # 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.
+    ##
+    def transformed_parameter(input)
+      parameter_transformers.find {|it| it.can_handle? input }
+        .transform(input)
+    end
+
+    ##
+    # Expand val if needed and transform the result.
+    #
+    # 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.
+    ##
+    def expand(val)
+      if val.respond_to? :expand
+        transformed_parameter(val.expand)
+      else
+        val
+      end
+    end
+
+  end
+
+  ##
+  # Mix the ParameterTransforming module functionality into the main Brine module.
+  ##
+  include ParameterTransforming
+end
+
+##
+# Configure Cucumber to use these transformers.
+##
+Transform /.*/ do |input|
+  transformed_parameter(input)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brine-dsl
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Matt Whipple
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-29 00:00:00.000000000 Z
+date: 2019-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -153,7 +153,7 @@ files:
 - lib/brine/step_definitions/request_construction.rb
 - lib/brine/step_definitions/selection.rb
 - lib/brine/test_steps.rb
-- lib/brine/transforms.rb
+- lib/brine/transforming.rb
 - lib/brine/type_checking.rb
 - lib/brine/util.rb
 homepage: http://github.com/brightcove/brine
@@ -176,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: Cucumber@REST in Brine

data/lib/brine/transforms.rb

@@ -1,89 +0,0 @@
-##
-# @file  transformers.rb
-# Argument Transforms for Brine.
-#
-# The Transforms that convert provided inputs to support richer
-# functionaliy than the simple strings which Cucumber provides.
-
-##
-# @defgroup Scalar transforms
-# Convert inputs into basic Ruby data types which represent a single value
-##
-
-# Integers
-Transform /\A(-?\d+)\z/ do |number|
-  number.to_i
-end
-
-# Booleans
-Transform /\A(?:true|false)\z/ do |boolean|
-  boolean.to_s == "true"
-end
-
-# Regexp
-# This presently does not support flags after the closing slash, support for these should be added as needed
-Transform /\A\/(.*)\/\z/ do |pattern|
-  Regexp.new(pattern)
-end
-
-# Temporal
-DATE='\d{4}-\d{2}-\d{2}'
-TIME='\d{2}:\d{2}:\d{2}'
-MILLIS='(?:\.\d{3})?'
-TZ='(?:Z|(?:[+-]\d{2}:\d{2}))'
-Transform /^#{DATE}T#{TIME}#{MILLIS}#{TZ}$/ do |date|
-          Time.parse(date)
-end
-
-##
-# @defgroup Structure transforms
-# Converts inputs to general data structures
-##
-
-# Lists
-Transform /\A\[.*\]\z/m do |input|
-  JSON.parse(input)
-end
-
-# Objects
-# Rely on templates being registered later and therefore given higher priority.
-# Lookarounds could avoid the ambiguity but are a nastier pattern.
-Transform /\A{.*}\z$/m do |input|
-    JSON.parse(input)
-end
-
-##
-# @defgroup Atypical transforms
-# Transforms for which data type is not the primary focus
-##
-
-# Whitespace removal transforms
-# Handle stripping leading and trailing whitespace.
-# These are split out from the transforms to consolidate the behavior.
-# They call transform on the stripped value so that subsequent transforms no longer
-# have to deal with such whitespace.
-#
-# Note that these need to deal with multiline string arguments which require
-# the multiline flag and \A/\z anchors to properly operate on the full string rather than
-# being line oriented. The calls to +#strip+ are also not likely to properly clean up
-# multiline strings but is just meant as a (potentially ineffective) optimization over
-# recursive calls and capturing.
-Transform /\A\s+(.*)\z/m do |input|
-  Transform(input.strip)
-end
-Transform /\A(.*)\s+\z/m do |input|
-  Transform(input.strip)
-end
-
-# Quotes
-Transform /\A".*"\z/ do |quoted|
-  quoted[1..-2]
-end
-Transform /\A'.*'\z/ do |quoted|
-  quoted[1..-2]
-end
-
-# Template Expansion
-Transform /.*{{.*}}.*/ do |template|
-  Transform(shave_value(template))
-end