cucumber-helpers 0.0.6

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZGJmNTZhZGNlNGNjZDNlOThiYWI3MzQzZWFkYzkzYzUzNzFkMTE5NA==
+  data.tar.gz: !binary |-
+    MDVkOTJhZDgwM2FkZTBmNGM0ZDU2N2Q3YTdkMTRkOWIyMWFjN2IyYg==
+SHA512:
+  metadata.gz: !binary |-
+    NDU5YjM2OWVlNzkwNzE1MWZiMzJhMDY0ZDgzZWRjN2ZjZTkyMTM0NjIwNzk1
+    ZjQwZjAzOTNkZDg5YmYzYzMzNDkzNzdkYTY1ZWUyYzNiM2NkYjVmNzk0Zjlm
+    NjA1ZGVhMTZkY2UxMDg4OTI4ZGM0ZmU3ZTI4YjUzZTdhZWZhNmU=
+  data.tar.gz: !binary |-
+    YzViYjBkNmVlMWY0NzI3MTIyYjg3MTA2M2UzZjRmMTcwYmExOWE5NDEwMzA1
+    NDJiY2UzNjkzZTYyNTliNGFiZGU4MDc1MTk3MzVhNjc1NzBhMjkzYjc3OGIx
+    OWFiNjM3ZjAwODVjMmNlYWU3NGFhODNkMGFlYWRjZTkxZjQzN2Y=

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+## 0.0.6 ([#8](https://git.mobcastdev.com/TEST/cucumber-helpers/pull/8) 2014-08-05 13:59:05)
+
+Fix contantize
+
+### Bug fix
+
+- Fixes an issue with the constantization of types which are "List of <whatever>".
+
+## 0.0.5 ([#7](https://git.mobcastdev.com/TEST/cucumber-helpers/pull/7) 2014-06-30 17:17:06)
+
+Move to artifactory
+
+### Improvement
+
+- Move to artifactory.
+
+## 0.0.4 (2014-02-24 10:59)
+
+### New Features
+
+* `Cucumber::Ast::Table`'s `.attribute_hash` will now return a hash with values set to the class type specified if no value column is given in the table.
+
+## 0.0.3 (2014-01-20 17:09)
+
+### New Features
+
+* Added can now specify array types with `List of <type>s`, for example `List of Integers` or `List of Strings`.
+
+## 0.0.2 (2014-01-20 11:14)
+
+### Bug fixes
+
+* Ensure the build will run on systems without git (ie. the build box!)
+
+## 0.0.1
+
+Initial release

data/README.md

@@ -0,0 +1,71 @@
+# Cucumber::Helpers
+
+A collection of helpers for cucumber tests we use at blinkbox books.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cucumber-helpers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cucumber-helpers
+
+## Usage
+
+### Typed object initialisation with Tables
+
+Occasionally you'll want to create an object with specific attributes, or test that the attributes that are present are of a particular data type. In Gherkin there is no defined way to specify the type of a named object, because Gherkin is a business language.
+
+This helper provides a mechanism to define attributes in a business-friendly manner and step helpers to convert them to the key names your code uses.
+
+#### Examples
+
+Let's say you have the following gherkin:
+
+```gherkin
+Given that a user exists with the following attributes:
+  | attribute            | type   | value             | description                           |
+  | First Name           | String | Sherlock          | The user's first name                 |
+  | Last Name            | String | Holmes            | The user's last name                  |
+  | Date of Birth        | Date   | 1999-12-31        | The user's birth date                 |
+  | Address: First Line  | String | 221B Baker Street | The first line of the user's address  |
+  | Address: Second Line | String | London            | The second line of the user's address | 
+  | Address: Postcode    | String | NW1 6XE           | The user's postcode                   |
+  | Number of Pipes      | Number | 12                | The number of pipes the user owns     |
+```
+
+And the following step definition:
+
+```ruby
+# TBC
+```
+
+The default attribute mapper will generate a hash (`attribute_hash`) that looks like this:
+
+```ruby
+{
+  "first_name"      => "Sherlock",
+  "last_name"       => "Holmes",
+  "date_of_birth"   => #<Date: 1999-12-31 ((2451544j,0s,0n),+0s,2299161j)>,
+  "address"         => {
+    "first_line"  => "221B Baker Street",
+    "second_line" => "London",
+    "postcode"    => "NW1 6XE"
+  },
+  "number_of_pipes" => 12
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/VERSION

@@ -0,0 +1 @@
+0.0.6

data/lib/cucumber/helpers.rb

@@ -0,0 +1,7 @@
+require "cucumber/helpers/core_ext"
+
+module Cucumber
+  module Helpers
+    VERSION = ::File.read(File.join(File.dirname(__FILE__),"../../VERSION"))
+  end
+end

data/lib/cucumber/helpers/core_ext.rb

@@ -0,0 +1,128 @@
+class Hash
+  def deep_key(deep_key)
+    sub_obj = self
+    deep_key.split('.').each do |k|
+      if k.match(/^(.+)\[(\d+)\]$/)
+        sub_obj = sub_obj[$1][$2.to_i]
+      else
+        sub_obj = sub_obj[k]
+      end
+    end
+    sub_obj
+  rescue
+    nil
+  end
+
+  def deep_delete(deep_key)
+    path_keys = deep_key.split('.')
+    final_key = path_keys.pop
+
+    sub_obj = self
+    path_keys.each do |k|
+      if k.match(/^(.+)\[(\d+)\]$/)
+        sub_obj = sub_obj[$1][$2.to_i]
+      else
+        sub_obj = sub_obj[k]
+      end
+    end
+
+    sub_obj.delete(final_key)
+  end
+
+  def deep_set(deep_key, value)
+    path_keys = deep_key.split('.')
+    final_key = path_keys.pop
+
+    sub_obj = self
+    path_keys.each do |k|
+      if k.match(/^(.+)\[(\d+)\]$/)
+        sub_obj = sub_obj[$1][$2.to_i]
+      else
+        sub_obj[k] ||= {}
+        sub_obj = sub_obj[k]
+      end
+    end
+
+    if final_key.match(/^(.+)\[(\d+)\]$/)
+      sub_obj[$1][$2.to_i] = value
+    else 
+      sub_obj[final_key] = value
+    end
+  end
+
+  # Collapses any nested hashes, converting the keys to delimited strings.
+  #
+  # For example, the hash `{ "address" => { "line1" => ..., "line2" => ... } }` will be converted to
+  # `{ "address.line1" => ..., "address.line2" => ... }`. The keys produced are compatible with the
+  # `deep_*` functions on hash, so this can provide a convenient way to iterate through values of a
+  # hash.
+  #
+  # Note that this function is lossy - if two nested hashes would result in the same keys then only
+  # one will be preserved.
+  def flat_hash(separator = ".")
+    each_with_object({}) do |(k, v), result|
+      if v.is_a?(Hash)
+        v.flat_hash(separator).each do |k2, v2|
+          result["#{k}#{separator}#{k2}"] = v2
+        end
+      else
+        result[k] = v
+      end
+    end
+  end
+end
+
+class Integer
+  def digits
+    self.to_s.chars.map(&:to_i)
+  end
+end
+
+# This is a bit of a hack to allow you to say "type: Boolean" as a validation
+module Boolean; end
+class TrueClass; include Boolean; end
+class FalseClass; include Boolean; end
+
+# This is a bit of a hack to allow you to say "type: Enum" as a validation
+module Enum; end
+class String; include Enum; end
+
+class String
+  # Converts a string to camelCase.
+  def camel_case
+    s = self
+    s = s.snake_case unless /^[a-z0-9]+$/i =~ s
+    s = s.downcase if s == s.upcase # stop "CVV" -> "cVV" when it should be "cvv"
+    s.camelize(:lower)
+  end
+
+  # Converts a string to snake_case or SNAKE_CASE.
+  def snake_case(casing = :lower)
+    s = self.tr(" ", "_")
+    case casing
+    when :lower then s.downcase 
+    when :upper then s.upcase
+    else raise ArgumentError, "unsupported casing"
+    end
+  end
+
+  # Converts a string to the specified primitive type. Useful because all Gherkin values are treated as strings.
+  def to_type(type)
+    # note: cannot use 'case type' as that expands to === which checks for instances of rather than type equality
+    if type == Boolean
+      self == "true"
+    elsif type == Date
+      Date.parse(self)
+    elsif type == DateTime
+      DateTime.parse(self)
+    elsif type == Enum
+      self.snake_case(:upper)
+    elsif type == Float
+      self.to_f
+    elsif type == Integer
+      self.to_i
+    else
+      self
+    end
+  end
+end

data/lib/cucumber/helpers/table.rb

@@ -0,0 +1,56 @@
+require "active_support/inflector"
+
+class Cucumber::Ast::Table
+  # Converts a table of attributes to a hash.
+  #
+  # The table must have the following columns:
+  #  
+  # attribute::
+  #   The name of the attribute. You can use natural language here and the parameter name will be
+  #   inferred, for example "Cardholder Name" will be converted to "cardholderName". You can also
+  #   specify nested objects using a `:` separator, for example "Address: Line 1" will be converted 
+  #   to an attribute like `{ "address": { "line1": ... } }`.
+  #
+  # value::
+  #   If provided this defines value of the attribute, cast according to the `type` specified. If
+  #   not provided the value of the corresponding hash key will be the class constant of the `type`
+  #   specified, or an array containing the class constant in the case of a 'List of' type.
+  #
+  # type::
+  #   The type of the attribute. This is used both as documentation of the type of the attribute
+  #   which is useful in itself, but also to control how the parameter is formatted in the JSON.
+  #   As well as built-in types, you can use the special type "Enum" which will represent the value
+  #   as a string, but convert it to the appropriate case, e.g. a value of "Sales Rank" will be
+  #   formatted as "SALES_RANK" inkeeping with enumeration conventions.
+  #
+  #   If the `type` is given as "List of <Type>", the `value` is assumed to be a comma delimited
+  #   list of items of the "<Type>" specified and is emitted as an array of typecast objects.
+  #   White space either side of commas is stripped.
+  #
+  # Any other columns in the table will be ignored, so you can have other columns in the table for
+  # different purposes, e.g. "description" is a fairly useful column purely for documentation.
+  def attribute_hash(casing: :camel_case)
+    class_only = !raw.first.include?('value')
+    hashes.each_with_object({}) do |row, hash|
+      name = row["attribute"].gsub(/: /, ".").send(casing)
+      hash.deep_set(name, value_from_row(row, class_only))
+    end
+  end
+
+  private
+
+  def value_from_row(row, class_only)
+    list_of = row["type"].match(/^List of (?<type>.*)$/)
+    type = (list_of ? list_of[:type].singularize : row["type"]).constantize
+
+    return type if class_only
+
+    if list_of
+      row["value"].split(/\s*,\s*/).collect do |subvalue|
+        subvalue.to_type(type)
+      end
+    else
+      row["value"].to_type(type)
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: cucumber-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Greg Beech
+- JP Hastings-Spital
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helpers for step definitions in cucumber.
+email:
+- greg@blinkbox.com
+- jphastings@blinkbox.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+files:
+- CHANGELOG.md
+- README.md
+- VERSION
+- lib/cucumber/helpers.rb
+- lib/cucumber/helpers/core_ext.rb
+- lib/cucumber/helpers/table.rb
+homepage: https://blinkboxbooks.github.io/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Helpers for cucumber.
+test_files: []