cornichon 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0296d0b8d9c07b3e06e1997e38c229617931e72
+  data.tar.gz: 77d948f2f9ec78b1fa2f9cae5e899b02e59b2b21
+SHA512:
+  metadata.gz: 93ed8757dda8e3b4b626d5ac4af3c6dd77083fb1fdc4ec655a7c5404a4138721ba92135b5f5d9e3bfe413acc81994f240d365caccceb24dc3f52a2d80cfe4b84
+  data.tar.gz: df3c0444bb1601c2b2d043529e9b6ef23e1e58ed8678f1f1082b994c7d04660e2a774fe12606ae2c89235e261773176212ae4d2c31028e15e7effd3b60507a2d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rvmrc

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 2.0.0" > .rvmrc
+environment_id="ruby-2.3.1"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.29.1 (master)" # 1.10.1 seems like a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 1 )) # display automatically
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)\n" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME\n" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS="" \command \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS="" \command \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in cornichon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Thom Gray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,209 @@
+# Cornichon
+
+A cornichon is a fancy gherkin ([WIKI](https://en.wikipedia.org/wiki/Pickled_cucumber#Cornichon))
+
+Cornichon allows you to write pseudo-Gherkin features that will transpile to valid Gherkin. In the process, you can programatically insert content into those features before running your cucumber tests. Now, you can write your acceptance tests to be more configurable, flexible, reusable, dynamic and greatly increase your test coverage!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cornichon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cornichon
+
+## Quick Start
+
+Add the following files to your project
+```
+your_project/
+  features/
+    cornichon/
+      templates/
+        quick_start.cornichon
+      presenters/
+        quick_start.rb
+```
+
+```feature
+# features/cornichon/templates/quick_start.cornichon
+
+Feature: A very quick start
+
+Scenario: You're never gonna keep me down
+  Given I've been knocked down {{several}} times
+  Then I get up again
+```
+
+```rb
+# features/cornichon/presenters/quick_start.rb
+
+def several
+  # return a random number between 2 .. 100
+  2 + rand(99)
+end
+```
+
+Then simply run
+```sh
+bundle exec cornichon
+```
+
+And voilà! you should have a brand new feature file in `features/cornichon/features`.
+Now run your cucumber tests!
+
+## Usage
+
+### Simple values
+
+use `{{double braces}}` to insert a method value
+
+Template:
+```feature
+# features/cornichon/templates/joke.cornichon
+
+Scenario: A classic pub joke
+  Given A {{person}} walks into a bar
+  Then expect consequences
+```
+Presenter:
+```rb
+# features/cornichon/presenters/joke.rb
+
+def person
+  ['Englishman', 'Irishman', 'Scotsman', 'Welshman'].sample
+end
+```
+Sample Output:
+```feature
+# features/cornichon/features/joke.feature
+
+Scenario: A classic pub joke
+  Given A Scotsman walks into a bar
+  Then expect consequences
+```
+
+### Nested values
+
+use `{{dot.separated.keys}}` to specify values within a nested hash
+
+### Tables
+
+use `[[double square brackets]]` to insert a table from an array of hashes (or a single hash for a single row table)
+
+Template:
+```feature
+# features/cornichon/templates/nursery_rhyme.cornichon
+
+Scenario Outline: A classic nursery rhyme
+  Given I was born on a "<day>"
+  Then I should "<expectation>"
+  Examples:
+  [[mondays_child]]
+  
+```
+Presenter:
+```rb
+# features/cornichon/presenters/nursery_rhyme.rb
+
+def mondays_child
+  [
+    {
+      'day' => 'Monday'
+      'expectation' => 'be fair of face'
+    },
+    {
+      'day' => 'Tuesday'
+      'expectation' => 'be full of grace'
+    },
+    {
+      'day' => 'Wednesday'
+      'expectation' => 'be full of woe'
+    },
+    {
+      'day' => 'Thursday'
+      'expectation' => 'have far to go'
+    },
+    {
+      'day' => 'Friday'
+      'expectation' => 'be loving and giving'
+    },
+    {
+      'day' => 'Saturday'
+      'expectation' => 'work hard for a living'
+    },
+    {
+      'day' => 'Sunday'
+      'expectation' => 'be bonnie and blithe and good and gay'
+    }
+  ]
+end
+```
+Sample Output:
+```feature
+# features/cornichon/features/nursery_rhyme.feature
+
+Scenario Outline: A classic nursery rhyme
+  Given I was born on a "<day>"
+  Then I should "<expectation>"
+  Examples:
+  | day       | expectation                           |
+  | Monday    | be fair of face                       |
+  | Tuesday   | be full of grace                      |
+  | Wednesday | be full of woe                        |
+  | Thursday  | have far to go                        |
+  | Friday    | be loving and giving                  |
+  | Saturday  | work hard for a living                |
+  | Sunday    | be bonnie and blithe and good and gay |
+```
+
+### The + sign
+
+use `{{+a plus sign}}` to refer to the last instance of a key (rather than calling the method again)
+You may need to use this if your methods do not return the same value on every call
+
+Template:
+```feature
+# features/cornichon/templates/reply.cornichon
+
+Scenario: Being polite
+  Given my name is {{name}}
+  When someone asks me my name
+  Then I would say 'My name is {{+name}}'
+```
+Presenter:
+```rb
+# features/cornichon/presenters/reply.rb
+
+def name
+  ['Sarah', 'Thomas', 'Michael', 'Jane', 'Fred', 'Kirsty'].sample
+end
+```
+Sample Output:
+```feature
+# features/cornichon/features/joke.feature
+
+Scenario: Being polite
+  Given my name is Jane
+  When someone asks me my name
+  Then I would say 'My name is Jane'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :demo do
+  require_relative "lib/cornichon"
+  require_relative "lib/cornichon/writer"
+  Cornichon.configure(:features_path => 'features')
+  Cornichon::Writer.write!(:verbose => true)
+end

data/bin/cornichon

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'cornichon/writer'
+puts "writing cornichon features ..."
+Cornichon::Writer.write!

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cornichon.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cornichon/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cornichon"
+  spec.version       = Cornichon::VERSION
+  spec.authors       = ["thomgray"]
+  spec.email         = ["thomdikdave@hotmail.com"]
+  spec.executables   << 'cornichon'
+
+  spec.summary       = %q{A fancy gherkin}
+  spec.description   = %q{A gherkin transpiler that allows you to write cucumber (gherkin) features programatically, thereby greatly improving your test coverage!}
+  spec.homepage      = "https://github.com/thomgray/cornichon"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "cucumber"
+end

data/lib/cornichon.rb

@@ -0,0 +1,11 @@
+require "cornichon/version"
+require "cornichon/config"
+require "cornichon/writer"
+
+module Cornichon
+  class << self
+    def configure(opts = {})
+      Config.configure(opts)
+    end
+  end
+end

data/lib/cornichon/config.rb

@@ -0,0 +1,23 @@
+module Cornichon
+  class Config
+    class << self
+      def configure(opts)
+        @relative_feature_path = opts[:features_path] if opts[:features_path]
+        @relative_template_path = opts[:templates_path] if opts[:templates_path]
+        @relative_presenter_path = opts[:presenters_path] if opts[:presenters_path]
+      end
+
+      def relative_feature_path
+        @relative_feature_path ||= 'features/cornichon/features'
+      end
+
+      def relative_template_path
+        @relative_template_path ||= 'features/cornichon/templates'
+      end
+
+      def relative_presenter_path
+        @relative_presenter_path ||= 'features/cornichon/presenters'
+      end
+    end
+  end
+end

data/lib/cornichon/parser.rb

@@ -0,0 +1,103 @@
+module Cornichon
+  class Parser
+    class << self
+      def parse(template)
+        template.gsub(/{{(.*?)}}|^(.*)\[\[(.*?)\]\]/) { |match|
+          replacement = nil
+          if $1
+            replacement = handle_string $1.strip
+          elsif $3
+            replacement = get_array(call($3), $2.length)
+            replacement.prepend($2) if replacement
+          end
+
+          if replacement
+            replacement
+          else
+            match
+          end
+        }
+      end
+
+      private
+
+      def handle_string(raw)
+        retained = false
+        if raw.start_with? '+'
+          raw.slice!('+').lstrip!
+          retained = true
+        end
+
+        value = call(raw, retained)
+
+        get_string value
+      end
+
+      def inject_path(hash, path)
+        return hash if path.empty?
+        begin
+          path.inject(hash, :[])
+        rescue
+          nil
+        end
+      end
+
+      def retain_cache
+        @retain_cache ||= Hash.new
+      end
+
+      def call(method, retained = false)
+        value = nil
+
+        key_path = method.split('.')
+        first = key_path.first
+        remainder = key_path.drop 1
+
+        if retained
+          value = retain_cache[first]
+          return inject_path(value, remainder) if value
+        end
+
+        begin
+          value = send first
+        rescue
+          return nil
+        end
+
+        if value
+          retain_cache[first] = value
+          value = inject_path(value, remainder)
+        end
+        value
+      end
+
+      def get_string(str)
+        str.to_s if str
+      end
+
+      def get_array(array, lpad = 0)
+        return nil unless array
+        array = [array] if array.is_a?(Hash)
+        return nil unless array.is_a?(Array)
+
+        all_keys = array.reduce([]) { |acc, obj|
+          acc | obj.keys
+        }
+        columns = all_keys.map { |key|
+          max_width = key.length
+          rows = [key] + array.map { |example|
+            cell = example.fetch(key, "")
+            max_width = cell.length if cell.length > max_width
+            cell
+          }
+          rows.map! { |cell| cell.ljust(max_width) }
+        }
+        (0...columns.first.length).map { |i|
+          first = '| '
+          first.prepend(' ' * lpad) if i > 0
+          first << columns.map { |c| c[i] }.join(' | ') << ' |'
+        }.join("\n")
+      end
+    end
+  end
+end

data/lib/cornichon/version.rb

@@ -0,0 +1,3 @@
+module Cornichon
+  VERSION = "0.1.0"
+end

data/lib/cornichon/writer.rb

@@ -0,0 +1,56 @@
+require "cornichon/config"
+require "cornichon/parser"
+require "fileutils"
+
+module Cornichon
+  class Writer
+    class << self
+      def write!(opts = {})
+        $verbose = opts[:verbose]
+        if $verbose
+          puts "SETUP: templates at #{Config.relative_template_path}"
+          puts "SETUP: presenters at #{Config.relative_presenter_path}"
+          puts "SETUP: features written to #{Config.relative_feature_path}\n"
+        end
+
+        require_presenter_methods
+        create_feature_dir
+
+        templates.each { |template|
+          template_name = File.basename(template, ".cornichon")
+          feature_path = File.join(Dir.pwd, Config.relative_feature_path, "#{template_name}.feature")
+          raw_feature = parse_template(template)
+          IO.write(feature_path, raw_feature)
+          puts "written #{feature_path}" if $verbose
+        }
+      end
+
+      def templates
+        @templates ||= Proc.new {
+          full_path = File.join(Dir.pwd, Config.relative_template_path)
+          Dir.glob("#{full_path}/*.cornichon")
+        }.call
+      end
+
+      def parse_template(template_file)
+        raw_template = IO.read(template_file)
+        Parser.parse(raw_template)
+      end
+
+      private
+
+      def require_presenter_methods
+        full_path = File.join(Dir.pwd, Config.relative_presenter_path)
+        Dir.glob("#{full_path}/*.rb").each { |file|
+          puts "SETUP: requiring #{file}" if $verbose
+          require "#{file}"
+        }
+      end
+
+      def create_feature_dir
+        dir_path = File.join(Dir.pwd, Config.relative_feature_path)
+        FileUtils.mkdir_p dir_path unless Dir.exist? dir_path
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: cornichon
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- thomgray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: A gherkin transpiler that allows you to write cucumber (gherkin) features
+  programatically, thereby greatly improving your test coverage!
+email:
+- thomdikdave@hotmail.com
+executables:
+- cornichon
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/cornichon
+- bin/setup
+- cornichon.gemspec
+- lib/cornichon.rb
+- lib/cornichon/config.rb
+- lib/cornichon/parser.rb
+- lib/cornichon/version.rb
+- lib/cornichon/writer.rb
+homepage: https://github.com/thomgray/cornichon
+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.6.10
+signing_key: 
+specification_version: 4
+summary: A fancy gherkin
+test_files: []