yard-cucumber 2.0.2 → 2.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/History.txt +4 -0
- data/README.md +12 -11
- data/lib/templates/default/featuretags/html/namespace.erb +1 -1
- data/lib/templates/default/layout/html/headers.erb +4 -4
- data/lib/templates/default/layout/html/search.erb +3 -5
- data/lib/templates/default/layout/html/setup.rb +13 -0
- data/lib/yard-cucumber.rb +1 -1
- metadata +4 -3
data/History.txt
CHANGED
data/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
Cucumber
|
|
1
|
+
YARD-Cucumber: A Requirements Documentation Tool
|
|
2
2
|
====================================
|
|
3
3
|
|
|
4
4
|
Synopsis
|
|
5
5
|
--------
|
|
6
6
|
|
|
7
|
-
Cucumber-In-The-Yard is a YARD extension that processes
|
|
8
|
-
scenarios, steps, tags, step definitions, and even transforms
|
|
9
|
-
documentation similar to what you expect to how YARD displays classes,
|
|
10
|
-
and constants.This tools bridges the gap of having feature files found in
|
|
7
|
+
YARD-Cucumber (formerly Cucumber-In-The-Yard) is a YARD extension that processes
|
|
8
|
+
Cucumber features, scenarios, steps, tags, step definitions, and even transforms
|
|
9
|
+
to provide documentation similar to what you expect to how YARD displays classes,
|
|
10
|
+
methods and constants.This tools bridges the gap of having feature files found in
|
|
11
11
|
your source code and true documentation that your team, product owners and
|
|
12
12
|
stakeholders can use.
|
|
13
13
|
|
|
@@ -22,23 +22,23 @@ developer; quality assurance engineer; or product owner/stakeholder.
|
|
|
22
22
|
|
|
23
23
|
The implemented example has been deployed at [http://recursivegames.com/cukes/](http://recursivegames.com/cukes/).
|
|
24
24
|
|
|
25
|
-
**1. View Features and Scenarios** [example](http://recursivegames.com/cukes/requirements
|
|
25
|
+
**1. View Features and Scenarios** [example](http://recursivegames.com/cukes/requirements.html)
|
|
26
26
|
|
|
27
27
|
**2. Search through [features, scenarios](http://recursivegames.com/cukes/feature_list.html), and [tags](http://recursivegames.com/cukes/tag_list.html)**
|
|
28
28
|
|
|
29
29
|
**3. Dynamic Tag Unions and Intersections** [example](http://recursivegames.com/cukes/requirements/tags.html)
|
|
30
30
|
|
|
31
|
-
**4. View all features and scenarios by tag** [example](http://recursivegames.com/cukes/requirements/tags/
|
|
31
|
+
**4. View all features and scenarios by tag** [example](http://recursivegames.com/cukes/requirements/tags/bvt.html)
|
|
32
32
|
|
|
33
33
|
**5. View Step Definitions and Transforms** [example](http://recursivegames.com/cukes/requirements/step_transformers.html)
|
|
34
34
|
|
|
35
35
|
**6. All steps [matched](http://recursivegames.com/cukes/requirements/step_transformers.html#definition_5-stepdefinition) to step definitions**
|
|
36
36
|
|
|
37
|
-
**7. [Steps](http://recursivegames.com/cukes/requirements/step_transformers.html#
|
|
37
|
+
**7. [Steps](http://recursivegames.com/cukes/requirements/step_transformers.html#step_transform7-steptransform) that have transforms applied to them**
|
|
38
38
|
|
|
39
39
|
**8. [Undefined steps](http://recursivegames.com/cukes/requirements/step_transformers.html#undefined_steps) and even [Rubular](http://rubular.com/) links of your step definitions.**
|
|
40
40
|
|
|
41
|
-
**9. Feature directories with a README.md will be parsed into the description** [example](http://recursivegames.com/cukes/requirements/
|
|
41
|
+
**9. Feature directories with a README.md will be parsed into the description** [example](http://recursivegames.com/cukes/requirements/example/child_feature.html)
|
|
42
42
|
|
|
43
43
|
Installation
|
|
44
44
|
------------
|
|
@@ -101,7 +101,8 @@ highlighting that was exceedingly helpful for quickly understanding the requirem
|
|
|
101
101
|
|
|
102
102
|
I also found it hard to share the test framework that I had put together with
|
|
103
103
|
another developer that joined the team. It was difficult to direct them around
|
|
104
|
-
the features, tags, step definitions, and transforms. It was when I started to
|
|
104
|
+
the features, tags, step definitions, and transforms. It was when I started to
|
|
105
|
+
convey to them the conventions that I had established that I wished I had a
|
|
105
106
|
tool that would allow me to provide documentation like one would find generated
|
|
106
107
|
by a great tool like YARD.
|
|
107
108
|
|
|
@@ -123,7 +124,7 @@ LICENSE
|
|
|
123
124
|
|
|
124
125
|
(The MIT License)
|
|
125
126
|
|
|
126
|
-
Copyright (c) 2011
|
|
127
|
+
Copyright (c) 2011 Franklin Webber
|
|
127
128
|
|
|
128
129
|
Permission is hereby granted, free of charge, to any person obtaining
|
|
129
130
|
a copy of this software and associated documentation files (the
|
|
@@ -61,7 +61,7 @@
|
|
|
61
61
|
</div>
|
|
62
62
|
|
|
63
63
|
<div id="tag_filtering" >
|
|
64
|
-
<span style="font-size: 18px;">Tag Filtering <a href="https://github.com/
|
|
64
|
+
<span style="font-size: 18px;">Tag Filtering <a href="https://github.com/cucumber/cucumber/wiki/Tags" target="_blank">?</a></span>
|
|
65
65
|
|
|
66
66
|
<div style="clear: both"></div>
|
|
67
67
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<meta
|
|
1
|
+
<meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
|
|
2
2
|
<title><%= @page_title %></title>
|
|
3
3
|
<link rel="stylesheet" href="<%= url_for("css/style.css") %>" type="text/css" media="screen" charset="utf-8" />
|
|
4
4
|
<link rel="stylesheet" href="<%= url_for("css/common.css") %>" type="text/css" media="screen" charset="utf-8" />
|
|
@@ -9,6 +9,6 @@
|
|
|
9
9
|
relpath = '<%= url_for('') %>';
|
|
10
10
|
if (relpath != '') relpath += '/';
|
|
11
11
|
</script>
|
|
12
|
-
|
|
13
|
-
<script type="text/javascript" charset="utf-8" src="<%= url_for(
|
|
14
|
-
|
|
12
|
+
<% javascript_files.each do |js_file| %>
|
|
13
|
+
<script type="text/javascript" charset="utf-8" src="<%= url_for(js_file) %>"></script>
|
|
14
|
+
<% end %>
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
<div id="search">
|
|
2
|
-
|
|
3
|
-
<a id="
|
|
4
|
-
|
|
5
|
-
<a id="method_list_link" href="#">Method List</a>
|
|
6
|
-
<a id ="file_list_link" href="#">File List</a>
|
|
2
|
+
<% search_fields.each do |id,name| %>
|
|
3
|
+
<a id="<%= id %>" href="#"><%= name %></a>
|
|
4
|
+
<% end %>
|
|
7
5
|
</div>
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
def init
|
|
2
|
+
super
|
|
3
|
+
end
|
|
4
|
+
|
|
5
|
+
def javascript_files
|
|
6
|
+
existing_js = super rescue [ 'js/jquery.js','js/app.js' ]
|
|
7
|
+
existing_js + [ 'js/cucumber.js' ]
|
|
8
|
+
end
|
|
9
|
+
|
|
10
|
+
def search_fields
|
|
11
|
+
existing_fields = super rescue [ [ 'class_list_link', 'Class List' ],[ 'method_list_link', 'Method List' ],[ 'file_list_link', 'File List' ] ]
|
|
12
|
+
existing_fields + [ [ 'features_list_link', 'Features' ],[ 'tags_list_link', 'Tags' ] ]
|
|
13
|
+
end
|
data/lib/yard-cucumber.rb
CHANGED
metadata
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
name: yard-cucumber
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
4
|
prerelease:
|
|
5
|
-
version: 2.0.
|
|
5
|
+
version: 2.0.3
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
8
8
|
- Franklin Webber
|
|
@@ -10,7 +10,7 @@ autorequire:
|
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
12
|
|
|
13
|
-
date: 2011-
|
|
13
|
+
date: 2011-05-22 00:00:00 -07:00
|
|
14
14
|
default_executable:
|
|
15
15
|
dependencies:
|
|
16
16
|
- !ruby/object:Gem::Dependency
|
|
@@ -104,6 +104,7 @@ files:
|
|
|
104
104
|
- lib/templates/default/fulldoc/html/setup.rb
|
|
105
105
|
- lib/templates/default/layout/html/headers.erb
|
|
106
106
|
- lib/templates/default/layout/html/search.erb
|
|
107
|
+
- lib/templates/default/layout/html/setup.rb
|
|
107
108
|
- lib/templates/default/requirements/html/alpha_table.erb
|
|
108
109
|
- lib/templates/default/requirements/html/requirements.erb
|
|
109
110
|
- lib/templates/default/requirements/html/setup.rb
|
|
@@ -143,7 +144,7 @@ homepage: http://github.com/burtlo/yard-cucumber
|
|
|
143
144
|
licenses: []
|
|
144
145
|
|
|
145
146
|
post_install_message: "\n\
|
|
146
|
-
(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n Thank you for installing yard-cucumber 2.0.
|
|
147
|
+
(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n Thank you for installing yard-cucumber 2.0.3 / 2011-05-22.\n \n Changes:\n \n * Updated Cucumber links to the new github organization\n \n\n\
|
|
147
148
|
(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n\n"
|
|
148
149
|
rdoc_options:
|
|
149
150
|
- --charset=UTF-8
|