yard-gherkin-turnip 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67de9dce9f9670a5fb850a1a4a169da5d9db6248bf701e1cb0d07176209e44e4
+  data.tar.gz: '09332973d65527f530801f524955aad6182918913c34922116f3e958f75c3c84'
+SHA512:
+  metadata.gz: 4850efe6c5b56cc7f207a6f05d4f6cb3f443b8016f7005da652ea21836d224f6e528b507a880f83f2832cdffc28665424622f210c3988b9e1cb08be00dbc2856
+  data.tar.gz: 4e5d7038c782c9282ab891638b97b8187b610e90a71270de3bb103894ba4e3f0bd6cc943ac3b4a7ff371e9c71d61dc3113de487fa01878b29a6aee67b2b48f2c

data/.gitignore

@@ -0,0 +1,6 @@
+# Ignore any built gems that are laying around
+*.gem
+
+# Documents folder
+doc
+.yardoc

data/.rspec

@@ -0,0 +1,3 @@
+# /.rspec
+--format d
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+yard-gherkin-turnip

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.yardopts

@@ -0,0 +1 @@
+--plugin yard-gherkin-turnip

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem 'redcarpet'
+gem 'gherkin', '>= 4.0', '< 6.0'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    yard-gherkin-turnip (1.0.0)
+      cucumber (>= 2.0, < 4.0)
+      gherkin (>= 4.0, < 6.0)
+      yard (~> 0.8, >= 0.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    backports (3.18.1)
+    builder (3.2.4)
+    cucumber (3.2.0)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.2.0)
+      cucumber-expressions (~> 6.0.1)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.2.1)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (~> 5.0)
+    cucumber-expressions (6.0.1)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.4.2)
+    gherkin (5.1.0)
+    multi_json (1.14.1)
+    multi_test (0.1.2)
+    rake (10.5.0)
+    redcarpet (3.5.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gherkin (>= 4.0, < 6.0)
+  rake (~> 10)
+  redcarpet
+  yard-gherkin-turnip!
+
+BUNDLED WITH
+   2.1.4

data/History.txt

@@ -0,0 +1,293 @@
+=== 1.0.0 / 2020-06-28
+
+* Forked from yard-cucumber and renamed yard-gherkin-turnip
+* Support added for Turnip `step` and `placeholder` definitions
+
+=== 4.0.0 / 2018-02-25
+
+* @wellavelino: Adjusts the indentation of several project classes
+  (https://github.com/burtlo/yard-cucumber/pull/89)
+* @elhuang: Adding example tags and scenarios counts
+  (https://github.com/burtlo/yard-cucumber/pull/87)
+* @weh: Update README.md
+  (https://github.com/burtlo/yard-cucumber/pull/84)
+* @weh: Fix Gem Load Error
+  (https://github.com/burtlo/yard-cucumber/pull/83)
+* @Stephen-Kaye: Transforms with CONSTANTS
+  (https://github.com/burtlo/yard-cucumber/pull/79)
+
+=== 3.1.0/ 2016-12-06
+
+* Updates to Gherkin 4.0 and Cucumber 2.4.0
+* Fixes issues with the formatting that comes from these changes
+
+=== 2.3.2/ 2013-11-08
+
+* De-duping uses of step definitions when the line number is the same (ipwnstuff)
+
+=== 2.3.1/ 2013-07-12
+
+* Fixes for Cucumber ~> 1.3 and gherkin ~> 2.12 by loading
+  a required platform file.
+* Added appropriate MIT license
+
+=== 2.3.0/ 2013-07-12
+
+* Fixes for Cucumber ~> 1.3 and gherkin ~> 2.12 by loading
+  a required platform file.
+
+=== 2.2.3/ 2013-02-15
+
+* Step Definitions that are marked as 'pending' will now appear as pending
+  on the step definition and transforms page.
+
+=== 2.2.2/ 2012-10-07
+
+* Steps and Definitions have links to step transformer page
+* Step definitions in the search menu no longer expand constants
+
+=== 2.2.1/ 2012-09-29
+
+* Fixes and compatibility with JRuby (Thanks @singram)
+
+=== 2.2.0/ 2012-05-29
+
+* Fixes and changes to become compatible with YARD 0.8.1
+
+=== 2.1.7/ 2011-11-24
+
+* Better parsing support for doc_strings (thanks @nikosd)
+
+=== 2.1.6 / 2011-11-24
+
+* FIX for yard-server (Thanks @msolovyov, @maxigit, @nikosd)
+
+=== 2.1.5 / 2011-10-19
+
+* FIX for multiple scenario outlines (Thanks @ardavis)
+
+=== 2.1.4 / 2011-10-10
+
+* Support for multiple scenario outlines (Thanks @jmerrifield)
+
+=== 2.1.3 / 2011-09-24
+
+* Support for Gherkin ~ 2.5 (Thanks @turboladen)
+
+=== 2.1.2 / 2011-09-16
+
+* JRuby Bug Fix (Thanks @aledalgrande)
+
+=== 2.1.1 / 2011-06-17
+
+* Gherkin 2.4.0 Compatibility (Thanks @bowsersenior)
+
+=== 2.1.0 / 2011-05-22
+
+* YARD 0.7.0 compatibility (removed some monkey-patching)
+* Add more menus (Steps and Step Definitions)
+* Define step definitions in your language Internalization (Ruby 1.9.2)
+
+=== 2.0.3 / 2011-05-22
+
+* Updated Cucumber links to the new github organization
+
+=== 2.0.2 / 2011-04-06
+
+- No Features/Tags will still generate landing pages instead of no pages
+- Changed link to current gem 'yard-cucumber'
+
+=== 2.0.1 / 2011-03-14
+
+- YARD 0.6.5 compatibility
+
+=== 2.0.0 / 2011-02-08
+
+* Cucumber In The YARD becomes `yard-cucumber` and with that gains the
+  benefits of being a YARD plugin
+
+=== 1.7.9 / 2011-02-05
+
+- FIX links to Scenarios and Transforms in various places
+- FIX Comments on Step Definitions that may blow up
+
+=== 1.7.8 / 2011-01-30
+
+* 'All Features' lands you on the root features directory; 'Requirements'
+  is still accessible through the breadcrumbs.
+* Feature directory pages will display all the features in all subdirectories
+* Better sorting for features, tags, and step transformers.
+
+- FIX Feature-Scenario links and Cursors
+
+=== 1.7.7 / 2011-01-06
+
+* Feature Directories now support a README.md file that can be used to provide
+  information (with markdown support) about the directory of features.
+
+=== 1.7.6 / 2011-01-06
+
+* Feature descriptions, multi-line strings, and comments will preserve spacing.
+
+=== 1.7.5 / 2010-12-14
+
+* FIX Step Transforms were colliding with Step Definitions in Ruby 1.9.2
+
+=== 1.7.4 / 2010-12-11
+
+* Ruby 1.9.2 Support
+* Change to YARD Server support:
+   yard server -e /path/to/gem/lib/server.b
+
+=== 1.7.3 / 2010-12-06
+
+* Shortcut Keys (t) for tags and (r) for features (f was taken)
+* Step definitions/transforms consolidate steps for easier viewing
+  and when they have no steps they are colored differently
+* Tag filtering supports inverse (~) of tags
+
+* FIX Scenario Outlines without examples will not crash the parser
+* FIX Features, Scenarios, and Directories should display in alphabetic order
+* FIX Comments and multiline strings will display correctly
+* FIX Feature comments will show
+
+=== 1.7.2 / 2010-11-30
+
+* Step Definition and Transform page enhancements
+* Step Regex links to Rubular
+* FIX Steps with HTML encoded characters will display correctly
+
+=== 1.7.1 / 2010-11-28
+
+* Feature file with layout enhancements
+* Scenarios are now linked/linkable
+* FIX Scenario Outline error on CentOS, Ruby 1.8.7
+* FIX Requiring Cucumber before Gherkin so that correct gherkin is loaded
+
+=== 1.7.0 / 2010-11-18
+
+* Dynamic Tag Union / Intersection
+
+=== 1.6.4 / 2010-11-16
+
+* `yard server` can now serve up requirements with YARD 0.6.2
+* 'All Tags' page now has a cucumber tag AND filtering tool (beta)
+* Step Defs and Transforms will show comments
+
+* FIX removed warnings by no longer requiring YARD
+
+=== 1.6.2 / 2010-11-07
+
+* Undefined Steps are displayed on the Step Transformer page
+* Defined and Undefined steps are better linked to the Transformer page
+
+* FIX Requirements tags were conflicting with YARD tags and being displayed
+  in multiple locations
+* FIX Scenario Outlines Examples failed to show their tables or text
+
+=== 1.6.1 / 2010-11-04
+
+* FIX - Feature Directries with sub-directories aborted serialization
+
+=== 1.6.0 / 2010-11-02
+
+* Feature directories, subdirectories, and Tags breadcrumb pages are present
+* Scenario Outlines now display each example inline when the example is clicked
+* 'All Features' and 'All Tags' links in the search fields
+
+=== 1.5.4 / 2010-10-28
+
+* Optimization - Found that for a large test suite that the processing time was
+  approaching 2 hours (oh boy!).  Reduced that time to a few minutes by optimizing
+  the feature handler to cache all step definitions and step transforms.
+
+* Step Transforms will now attempt to unpack any constants found within them.
+* FIX - Step Transforms were not being parsed because the regex incorrectly included
+  the block.
+* FIX - Features and Scenarios with multiple tags were not being displayed
+
+=== 1.5.3 / 2010-10-26
+
+* FIX - Step Definition YARD handler regex was poorly formed and raised exceptions
+  when it contained a forward-slash (even if escaped).
+* FIX - Step highlighting was causing 'Out Of Memory' issues because
+  gsub could not handle nil values.
+* FIX - Step highlighting failed to replace matches properly causing for corrupted
+  HTML span values to appear in the highlighted step definitions
+
+=== 1.5.2 / 2010-10-26
+
+* FIX - Step Transform YARD handler regex was poorly formed and raised exceptions
+  when a transform contained a forward-slash (even if escaped).
+
+=== 1.5.1 / 2010-10-26
+
+* Unified Feature/Scenario search field that resembles the Namespace-Class field
+* Tag search also displays immediate features/scenarios
+* Removed Scenario searching field
+* Added filename and line number to a number of locations
+* Minor Tag template enhancements
+* FIX - Scenario Outline Reference was being replaced with the first example
+* FIX - Scenario Outlines were not getting counted for tags
+
+=== 1.5 / 2010-10-25
+
+* Steps that have found their step definitions will also attempt to find their
+  step transforms (However step transforms are not unpacked yet like step
+  definitions).
+* Scenario Outlines will expand, behind the scenes, and match like traditional
+  scenarios.
+* FIX - duplication of owners that the tag reports has been removed.
+* INFO level messaging while processing features and scenarios to help assist
+  with feedback during the long processing.
+
+=== 1.4 / 2010-10-17
+
+* Tagusage has been retired
+* Tags are found during parsing by name or created and all uses are appended to the exising or newly created object
+* Tagusage template renamed and fixed up for just a tag and all the references
+* Tags are named tag_TAG (removed the @ as it was encoded during file serialization and I couldn't find an encoder helper)
+* Cleaned up all references in the fulldoc, full list to references tags
+
+* Moved Cucumber CodeObjects, Handlers, and Parsers to a Cucumber sub-directory
+* Moved StepDefinition and StepTransforms form extensions.rb to individual StepObject and Handlers files
+
+* (lsegal advice) Created Cucumber Namespace and sub namespaces for features, tags, and step transformers.
+* (lsegal advice) Started to break apart the feature.erb into smaller digestable erb sections
+
+* Feature namespace now parallels the directory structure of the feature directory (from where it is parsed)
+* Feature files have simpler names; i.e. featurefile.html instead of featurefile.feature.html
+* Feature page title now states Feature: The Feature ( KEYWORD: FEATURE_TITLE )
+* Moved the templates to lib/templates so I could use yard/templates to override the YARD helpers
+
+* Changed document parsing to mirror the order imposed by Cucumber, this is to stop features being loaded before step definitions.
+  This should hopefully address the issue where steps were not being mapped correctly to step definitions.  This fixed the issue
+  in the small and large test suite I ran it against.
+
+
+=== 1.3 / 2010-10-13
+
+* (7rans requested) Step definitions to show their source code; required a better source definition to be stored during creation of the CodeObject
+* Fixes to the Feature template which had some unclosed table header elements
+* Scenario Outline helper methods added to Scenarios
+* Scenario Outlines, Tables, and Multiline Strings had other minor CSS changes
+* Step tables and Scenario Example tables are no longer locked to 150px; instead that is the minimum width
+* Tables and Multiline Strings (PyStrings) are no longer displayed in the steps frame which was causing ugliness with the striping of the rows
+* (lsegal strongly recommended) Removed the pervasive use of filename in the CodeObjects
+* Cleaned up the fulldoc setup to remove the redundancy
+* Updated all the templates to support the lack of filename
+
+=== 1.2 / 2010-10-10
+
+* FIX: Empty Step Definitions caused failure during serialization
+* FIX: Empty Step Definitions caused failure during rendering HTML
+
+=== 1.1 / 2010-10-10
+
+* FIX: Feature template had references to old methods for description (when it was an array)
+* FIX: Empty feature files caused the documentation to fail; ignoring emptying feature files
+* FIX: Tags, Step definitions, and other CodeObjects that were not present caused rendering to fail; Checking for nil
+
+=== 1.0 / 2010-10-10
+
+* Initial Release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Franklin Webber
+
+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,182 @@
+# YARD-Gherkin-Turnip: A Requirements Documentation Tool
+
+## Synopsis
+
+YARD-Gherkin-Turnip (forked from YARD-Cucumber) is a YARD extension that processes
+Gherkin features, scenarios, steps and tags with step definitions and placeholders written using Turnip
+to provide documentation similar to what you expect to how YARD displays
+classes, methods and constants.This tools bridges the gap of having feature
+files found in your source code and true documentation that your team, product
+owners and stakeholders can use.
+
+## Examples
+
+I have created a trivial, example project to help provide a quick
+visualization of the resulting documentation. I encourage you to look at it as
+an example and see if it would assist your project from a multitude of
+perspectives: as the project's core developer; another developer or a new
+developer; quality assurance engineer; or product owner/stakeholder.
+
+The implemented example has been deployed at [http://burtlo.github.io/yard-cucumber/](http://burtlo.github.io/yard-cucumber/).
+
+**1. View Features and Scenarios** [example](http://burtlo.github.io/yard-cucumber/requirements.html)
+
+**2. Search through [features, scenarios](http://burtlo.github.io/yard-cucumber/feature_list.html), and [tags](http://burtlo.github.io/yard-cucumber/tag_list.html)**
+
+**3. Dynamic Tag Unions and Intersections** [example](http://burtlo.github.io/yard-cucumber/requirements/tags.html)
+
+**4. View all features and scenarios by tag** [example](http://burtlo.github.io/yard-cucumber/requirements/tags/bvt.html)
+
+**5. View Step Definitions and Transforms** [example](http://burtlo.github.io/yard-cucumber/requirements/step_transformers.html)
+
+**6. All steps [matched](http://burtlo.github.io/yard-cucumber/requirements/step_transformers.html#definition_5-stepdefinition) to step definitions**
+
+**7. [Steps](http://burtlo.github.io/yard-cucumber/requirements/step_transformers.html#step_transform7-steptransform) that have transforms applied to them**
+
+**8. [Undefined steps](http://burtlo.github.io/yard-cucumber/requirements/step_transformers.html#undefined_steps) and even [Rubular](http://rubular.com/) links of your step definitions.**
+
+**9. Feature directories with a README.md will be parsed into the description** [example](http://burtlo.github.io/yard-cucumber/requirements/example/child_feature.html)
+
+**10. Configurable Menus - want a searchable steps menu and remove the tags menu**
+
+**11. Step definitions in your language (Ruby 1.9.2 - Internationalization)**
+
+## Installation
+
+YARD-Gherkin-Turnip requires the following gems installed:
+
+Gherkin - http://cukes.info
+YARD - http://yardoc.org
+Turnip - https://github.com/jnicklas/turnip
+
+To install `yard-gherkin-turnip` use the following command:
+
+```bash
+$ gem install yard-gherkin-turnip
+```
+
+(Add `sudo` if you're installing under a POSIX system as root)
+
+## Usage
+
+YARD supports for automatically including gems with the prefix `yard-`
+as a plugin. To enable automatic loading yard-gherkin-turnip.
+
+```bash
+$ mkdir ~/.yard
+$ yard config load_plugins true
+$ yardoc 'example/**/*.rb' 'example/**/*.feature'
+```
+
+Now you can run YARD as you [normally](https://github.com/lsegal/yard) would and
+have your features, step definitions and transforms captured.
+
+An example with the rake task:
+
+```ruby
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+t.files   = ['features/**/*.feature', 'features/**/*.rb']
+t.options = ['--any', '--extra', '--opts'] # optional
+end
+```
+
+
+## Configuration
+
+* Adding or Removing search fields (yardoc)
+
+Be default the yardoc output will generate a search field for features and tags.
+This can be configured through the yard configuration file `~/.yard/config` to
+add or remove these search fields.
+
+```yaml
+--- !ruby/hash-with-ivars:SymbolHash
+elements:
+  :load_plugins: true
+  :ignored_plugins: []
+  :autoload_plugins: []
+  :safe_mode: false
+  :"yard-gherkin-turnip":
+    menus: [ 'features', 'directories', 'tags', 'steps', 'step definitions' ]
+ivars:
+  :@symbolize_value: false
+```
+
+By default the configuration, yaml format, that is generate by the `yard config`
+command will save a `SymbolHash`. You can still edit this file add the entry for
+`:"yard-gherkin-turnipr":` and the sub-entry `menus:` which can contain all of the above
+mentioned menus or simply an empty array `[]` if you want no additional menus.
+
+* Exclude features or scenarios from yardoc
+
+You can exclude any feature or scenario from the yardoc by adding a predefined tags to them.
+To define tags that will be excluded, again in yard configuration file:
+
+```yaml
+:"yard-gherkin-turnip":
+  exclude_tags: [ 'exclude-yardoc', 'also-exclude-yardoc' ]
+```
+
+## Details
+
+There are two things that I enjoy: a test framework written in my own Domain
+Specific Language (DSL) that is easily understood by all those on a project
+and the ability for all participants to easily read, search, and view the tests.
+
+Cucumber is an amazing tool that allowed me to define exercisable requirements.
+My biggest obstacle was bringing these requirements to my team, the product
+owner, and other stakeholders.
+
+Initially I tried to expose more of the functionality by providing freshly
+authored requirements through email, attachments to JIRA tickets, or linked in
+wiki documents. None of these methods were very sustainable or successful.
+First, I was continually pushing out the documents to those interested.
+Second, the documents were displayed to the user in text without the syntax
+highlighting that was exceedingly helpful for quickly understanding the requirements.
+
+I also found it hard to share the test framework that I had put together with
+another developer that joined the team. It was difficult to direct them around
+the features, tags, step definitions, and transforms. It was when I started to
+convey to them the conventions that I had established that I wished I had a
+tool that would allow me to provide documentation like one would find generated
+by a great tool like YARD.
+
+So I set out to integrate Cucumber objects like features, backgrounds,
+scenarios, tags, steps, step definitions, and transforms into a YARD template.
+From my quick survey of the landscape I can see that the my needs are
+different than a lot of others that use Cucumber.  The entire project that
+spawned this effort was solely to exercise the functionality of a different,
+large project and so there is a huge dependence on having the requirements
+documented.  This is in contrast to other projects that are using this on a
+small scale to test the functionality of small software component.  Though,
+ultimately, I realized that the functionality may provide a valuable tool for
+many as I feel it helps more solidly bridge the reporting of the documentation
+by putting a coat of paint on it.
+
+
+## LICENSE
+
+(The MIT License)
+
+Copyright (c) 2011 Franklin Webber
+
+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.