yard-lucid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08c7f6d439f619b3b01a3d229184f5b8db4cc8bc
+  data.tar.gz: 467656c8cdc9fd50cbd6634e3fd5d59728ef8d20
+SHA512:
+  metadata.gz: fd30a4ebd5c804ecb919757c2e51a55b60fa0dcd794eb11ec3cde282d8b0c61ecb57667682e89b59869d9ff528b29d69117baa2630782dd2d72dbc9c96704bb6
+  data.tar.gz: a72c6c29ba127364f97349e9f1300c7ed6821de1375ce9b1a2af7118717cf8f7b0f0aaa92f5abc74c469ee5f5130b7e00bdcf435de56b6c0ef8f8d557906b3ab

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/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jeff.nyman@sproutsocial.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yard-lucid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jeff Nyman
+
+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,87 @@
+# Lucid Yard
+
+The Lucid Yard gem acts as a YARD extension to process Gherkin-style feature files.
+
+The gem itself is called `yard-lucid` (rather than `lucid-yard`) because the YARD tool provides built-in support for gems being used as plugins. In order for that to work, the gems in question must have the prefix `yard-`.
+
+Gherkin objects like features, backgrounds, scenarios, tags, steps, step definitions, and transforms are integrated into a YARD template.
+
+Lucid Yard provides a parser component, which is the first component in YARD's processing pipeline. This parser runs before any handling is done on the source itself. Lucid Yard provides a hook into the Gherkin parser rather than attempting to recreate the parser.
+
+The parser translates the source into a set of statements that can be understood by the handlers that run immediately afterward. Handling is done after parsing to abstract away the implementation details of lexical and semantic analysis on the source and to only deal with the logic regarding recognizing source statements as particular types of code objects. Lucid Yard provides handlers that recognize the base level constructs of a Gherkin-style document. In other words, Gherkin feature files are being treated as a form of source code.
+
+The handler is taking parsed statements, processing them, and in that action, creating what are called code objects. Code objects are Ruby objects that describe the code being documented. Lucid Yard provides a specific set of code objects that match any constructs that can be found in a Gherkin feature file. These code objects in turn create tags (essentially, metadata) that are attached to the objects.
+
+These code objects are then added to an internal registry, which is a data store component.
+
+The final act of this is the processing of objects from the registry via a templating engine, which is what allows output to be generated.
+
+## Installation
+
+To get the latest stable release, add this line to your application's Gemfile:
+
+```ruby
+gem 'yard-lucid'
+```
+
+To get the latest code:
+
+```ruby
+gem 'yard-lucid', git: 'https://github.com/jeffnyman/yard-lucid'
+```
+
+After doing one of the above, execute the following command:
+
+    $ bundle
+
+You can also install Lucid Yard just as you would any other gem:
+
+    $ gem install yard-lucid
+
+## Usage
+
+Since `yard-lucid` is acting as an extension to YARD, you have to enable the automatic loading of such extensions by YARD. The easiest way to do this is:
+
+```bash
+$ mkdir ~/.yard
+$ yard config load_plugins true
+```
+
+Once that is done, you can run YARD as you normally would and have your Gherkin repository captured as a YARD documentation artifact.
+
+```bash
+$ yardoc 'features/**/*.feature' 'steps/**/*.rb'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Given the nature of Lucid Yard, it's difficult to provide unit tests for it, so you won't find a great deal of them. In fact, you'll find basically none.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/jeffnyman/yard-lucid](https://github.com/jeffnyman/yard-lucid). The testing ecosystem of Ruby is very large and this project is intended to be a welcoming arena for collaboration on yet another test-supporting tool. As such, contributors are very much welcome but are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+The Lucid Yard gems follows [semantic versioning](http://semver.org).
+
+To contribute to Lucid Yard:
+
+1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+2. Create your feature branch. (`git checkout -b my-new-feature`)
+3. Commit your changes. (`git commit -am 'new feature'`)
+4. Push the branch. (`git push origin my-new-feature`)
+5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
+
+## Author
+
+* [Jeff Nyman](http://testerstories.com)
+
+## Credits
+
+This code is based upon the [Yard-Cucumber](https://github.com/burtlo/yard-cucumber) gem. The reason for this approach rather than a fork is that I wanted to clean up a lot of the code decisions made by the original author. I also wanted to move away from a strict Cucumber terminology. Finally, the original author hasn't necessarily been as responsive to pull requests which I felt would limit my options.
+
+## License
+
+Lucid Yard is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.
+See the [LICENSE](https://github.com/jeffnyman/yard-lucid/blob/master/LICENSE.md) file for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yard/lucid"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

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/lib/docserver/default/fulldoc/html/js/lucid.js

@@ -0,0 +1,69 @@
+function lucidSearchFrameLinks() {
+	$('#feature_list_link').click(function() {
+		toggleSearchFrame(this, '/' + library + '/features');
+	});
+	$('#tag_list_link').click(function() {
+		toggleSearchFrame(this, '/' + library + '/tags');
+	});
+}
+
+$(lucidSearchFrameLinks);
+
+function toggleScenarioExample(id,example) {
+	var element = $("#" + id + "Example" + example + "Steps")[0];
+
+	$('#' + id + ' tr').each(function(index) {
+		this.style.backgroundColor = (index % 2 == 0 ? '#FFFFFF' : '#F0F6F9' );
+	});
+
+	if (element.style.display != 'none') {
+		element = $("#" + id + "Steps")[0];
+	} else {
+		$('#' + id + ' .outline * tr')[example].style.backgroundColor = '#FFCC80';
+	}
+
+	$('#' + id + ' .steps').each(function(index) {
+		this.style.display = 'none';
+	});
+
+	element.style.display = 'block';
+}
+
+function determine_tags_used_in_formula(tag_string)  {
+	tag_string = tag_string.replace(/^(\s+)|(\s+)$/,'').replace(/\s{2,}/,' ');
+
+	var tags = tag_string.match(/@\w+/g);
+	var return_tags = [];
+
+	if (tags != null) {
+		tags.forEach(function(tag, index, array) {
+			//$("#tag_debug")[0].innerHTML += tag + " ";
+			if (tag_list.indexOf(tag) != -1) { return_tags.push(tag); }
+		});
+	}
+	return return_tags;
+}
+
+function display_example_command_line(tags) {
+	$("#command_example")[0].innerHTML = "cucumber ";
+
+	if (tags.length > 0)  {
+		$("#command_example")[0].innerHTML += "--tags " + tags.join(" --tags ");
+	}
+}
+
+function display_qualifying_features_and_scenarios(tags) {
+	if (tags.length > 0) {
+		$(".feature,.scenario").each(function(feature){
+			this.style.display = "none";
+		});
+
+		$(".feature.\\" + tags.join(".\\") + ",.scenario.\\" + tags.join(".\\")).each(function(feature) {
+			this.style.display = "block";
+		});
+	}  else {
+		$(".feature,.scenario").each(function(feature){
+			this.style.display = "block";
+		});
+	}
+}

data/lib/docserver/default/layout/html/headers.erb

@@ -0,0 +1,13 @@
+<meta name="Content-Type" content="text/html; charset=UTF-8" />
+<title><%= @page_title %></title>
+<link rel="stylesheet" href="/css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="/css/custom.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="/css/common.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="/css/lucid.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/autocomplete.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/app.js"></script>
+<script type="text/javascript" charset="utf-8" src="/js/lucid.js"></script>
+<script type="text/javascript" charset="utf-8">
+  library = '<%= base_path(router.list_prefix) %>';
+</script>

data/lib/docserver/doc_server/full_list/html/full_list.erb

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="Content-Type" content="text/html; charset=<%= charset %>" />
+    <link rel="stylesheet" href="/css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+    <link rel="stylesheet" href="/css/common.css" type="text/css" media="screen" charset="utf-8" />
+    <link rel="stylesheet" href="/css/lucid.css" type="text/css" media="screen" charset="utf-8" />
+    <script type="text/javascript" charset="utf-8" src="/js/jquery.js"></script>
+    <script type="text/javascript" charset="utf-8" src="/js/full_list.js"></script>
+    <script type="text/javascript" charset="utf-8" src="/js/lucid.js"></script>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <script>
+      if (window.top.frames.main) {
+        document.getElementById('base_target').target = 'main';
+        document.body.className = 'frames';
+      }
+    </script>
+    <div id="content">
+      <h1 id="full_list_header"><%= @list_title %></h1>
+      <div id="nav">
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/features">Features</a> |
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/tags">Tags</a> |
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/class">Classes</a> |
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/methods">Methods</a> |
+        <a target="_self" href="/<%= base_path(router.list_prefix) %>/files">Files</a>
+      </div>
+
+      <div id="search">Search: <input type="text" /></div>
+
+      <ul id="full_list" class="<%= @list_class || @list_type %>">
+        <%= erb "full_list_#{@list_type}" %>
+      </ul>
+    </div>
+  </body>
+</html>

data/lib/docserver/doc_server/full_list/html/setup.rb

@@ -0,0 +1,19 @@
+include T('default/fulldoc/html')
+
+def init
+  # This is the css class type; defaulting to class.
+  @list_class = "class"
+
+  case @list_type.to_sym
+  when :features; @list_title = "Features"
+  when :tags; @list_title = "Tags"
+  when :class; @list_title = "Class List"
+  when :methods; @list_title = "Method List"
+  when :files; @list_title = "File List"
+  end
+  sections :full_list
+end
+
+def all_features_link
+  linkify YARD::CodeObjects::Lucid::LUCID_NAMESPACE, "All Features"
+end