cuke_steps 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ad2be95b4f540466be1b163cc1410a669620800
+  data.tar.gz: 17f1228b2c8137686bc1aaf5694ce80a60e5748a
+SHA512:
+  metadata.gz: def5b79e7dcc8d0eb50fd0f2c3327f2098c763a36567d75b50286d3e78c9653a67d59d974a646faeca28befc561af9a3bcc87d158587785b7f80d3a43d808090
+  data.tar.gz: 79ed1e349de756db9c832d7c41f06a42470791cccb3b33a3cc5233c8287960f68c8fb78f3e11d74216708d1e53a75221207110552c0c866107133daab2697f24

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/.buildpath
+/.project
+/.settings
+*.gem

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,74 @@
+[![Build Status](https://travis-ci.org/raels/cuke-steps.svg?branch=master)](https://travis-ci.org/raels/cuke-steps)
+
+cuke-steps
+==========
+
+Cucumber step documentation.
+
+This is a small script that reads Cucumber/Gherkin step definition files and outputs pretty-printed documentation of those steps.  It is meant as a tool for developers to easily see what step definitions already exist.
+
+Currently supported output formats include HTML and Confluence wiki markup.  The documentation can be pushed into a wiki using the [Confluence Publisher Plugin] [cpp] for Jenkins.  Adding outputters for other formats is straightforward.
+
+  [cpp]: https://wiki.jenkins-ci.org/display/JENKINS/Confluence+Publisher+Plugin
+
+
+Usage
+-----
+
+You might install with either the gem command or using bundler.
+
+Assuming you installed with Bundler:
+
+> bundle exec cuke-steps \[options\] <directories...>
+
+In its simplest form:
+
+> bundle exec cuke-steps features/
+
+Supported options:
+
+*  -f FORMAT, --format FORMAT  
+   Select output format, either "html" or "cf"
+
+*  -o FILE, --output FILE  
+   Output to FILE, default "steps.html" or "steps.cf"
+
+*  -h, --help  
+   Usage instructions
+
+This will scan the provided directories for step definition files (*.rb) and output the documentation in the specified file.
+
+The tool supports having step definitions in multiple directories.  It will generate a separate section for each directory specified on the command line, and (if multiple directories are provided) a section containing all step definitions.
+
+
+TODO
+----
+
+*  Add options for defining a base URL prefix and postfix, and make the file names in the output link to a source repo or Jenkins workspace
+
+
+BSD License
+-----------
+
+Copyright (c) 2012, Sampo Niskanen
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cuke_steps_gem"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/cuke-steps

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+#-*- encoding: utf-8 -*-
+
+require 'optparse'
+
+require 'step_parser'
+require 'confluence_step_outputter'
+require 'html_step_outputter'
+
+
+# Parse command line
+options = {}
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: cuke-steps.rb [options] <directories...>"
+
+  opts.on("-o", "--output FILE", "Output to FILE") do |file|
+    options[:file] = file
+  end
+  opts.on("-f", "--format FMT", "Select output format: cf, html") do |format|
+    options[:format] = format
+  end
+end
+opts.parse!(ARGV)
+
+# Default output options
+if options[:file] && !options[:format]
+  options[:format] = options[:file].sub(/^.*\./, "")
+end
+if !options[:format]
+  options[:format] = "html"
+end
+if options[:format] && !options[:file]
+  options[:file] = "steps.#{options[:format]}"
+end
+
+
+# All other arguments are treated as input directories
+dirs = ARGV
+if dirs.size == 0
+  puts "No source directories provided, use -h for help"
+  exit 1
+end
+
+# Setup output
+case options[:format]
+when 'cf'
+  output = ConfluenceStepOutputter.new(options[:file])
+when 'html'
+  output = HtmlStepOutputter.new(options[:file])
+else
+  puts "Unknown output format: #{options[:format]}"
+  exit 1
+end
+puts "Writing output to file '#{options[:file]}'"
+
+
+# Sort primarily by step type, secondarily by step definition
+sorter = lambda do |a,b|
+  if a[:type] == b[:type]
+    a[:name].downcase <=> b[:name].downcase
+  else
+    weight = { "Given" => 1, "When" => 2, "Then" => 3, "Transform" => 4, "Before" => 5, "After" => 6, "AfterStep" => 7 }
+    wa = weight[a[:type]]
+    wb = weight[b[:type]]
+    wa <=> wb
+  end
+end
+
+
+# Read files and output
+all_steps = []
+output.header
+dirs.each do |dir|
+  dir = dir.sub(/\/+$/, "")
+  s = StepParser.new
+  Dir.glob("#{dir}/**/*.rb") do |file|
+    s.read(file)
+  end
+  steps = s.steps
+  all_steps += steps
+
+  output.start_directory(dir)
+  steps.sort!(&sorter)
+  steps.each { |s| output.step(s) }
+  output.end_directory
+end
+
+if dirs.size > 1
+  output.start_all
+  all_steps.sort!(&sorter)
+  all_steps.each { |s| output.step(s) }
+  output.end_all
+end
+
+output.footer
+output.close

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/cuke_steps_gem.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cuke_steps_gem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cuke_steps"
+  spec.version       = CukeStepsGem::VERSION
+  spec.authors       = ["plaa, packager:raels"]
+  spec.email         = [""]
+
+
+  spec.summary       = %q{Generates Gherkin step reference page}
+  spec.description   = %q{This gem offers a program to generate a reference index for your Gherkin step definitions.
+                          It was written by plaa, and packaged by raels.}
+  spec.homepage      = "https://raels.github.io/cuke-steps/"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "http://rubygems.org"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/confluence_step_outputter.rb

@@ -0,0 +1,64 @@
+# Outputter that generates Confluence markup
+
+require 'cgi'
+require 'fileutils'
+
+class ConfluenceStepOutputter
+  def initialize(file)
+    @file = File.open(file, 'w')
+    @previous_type = ""
+  end
+
+  def header
+    # No-op
+  end
+  def footer
+    @file.puts %(<p>&nbsp;</p>)
+    @file.puts %(<p><em>Documentation generated #{Time.now}</em></p>)
+  end
+
+  def close
+    @file.close
+  end
+
+  def start_directory(dir)
+    @file.puts %(<p>&nbsp;</p>)
+    @file.puts "<h2>#{dir}</h2>"
+    @previous_type = ""
+  end
+
+  def end_directory
+    # No-op
+  end
+
+  def start_all
+    @file.puts %(<p>&nbsp;</p>)
+    @file.puts "<h2>All definitions alphabetically</h2>"
+    @previous_type = ""
+  end
+
+  def end_all
+    # No-op
+  end
+
+  def step(step)
+    if @previous_type != step[:type]
+      @file.puts %(<h3>#{step[:type]} definitions</h3>)
+      @previous_type = step[:type]
+    end
+    @file.puts %(<ac:macro ac:name="expand">)
+    @file.puts %( <ac:parameter ac:name="title">#{CGI.escapeHTML(step[:name])}</ac:parameter>)
+    @file.puts %( <ac:rich-text-body>)
+    # TODO: Add link to source repo or Jenkins workspace
+    # <p><a href=".../#{CGI.escapeHTML(step[:filename])}" style="color: #888;">#{CGI.escapeHTML(step[:filename])}:#{step[:line_number]}</a></p>
+    @file.puts %(  <p style="color: #888;">#{CGI.escapeHTML(step[:filename])}:#{step[:line_number]}</p>)
+    @file.puts %(  <pre style="background-color: #ddd; padding-top: 1.2em;">)
+    step[:code].each do |line|
+      @file.puts %(   #{CGI.escapeHTML(line)})
+    end
+    @file.puts %(  </pre>)
+    @file.puts %( </ac:rich-text-body>)
+    @file.puts %(</ac:macro>)
+  end
+
+end

data/lib/cuke_steps_gem.rb

@@ -0,0 +1,8 @@
+require "cuke_steps_gem/version"
+require 'step_parser'
+require 'html_step_outputter'
+require 'confluence_step_outputter'
+
+module CukeStepsGem
+  # Your code goes here...
+end

data/lib/cuke_steps_gem/version.rb

@@ -0,0 +1,3 @@
+module CukeStepsGem
+  VERSION = "0.2.2"
+end

data/lib/html_step_outputter.rb

@@ -0,0 +1,119 @@
+# Outputter that generates HTML markup
+# Feel free to customize the below code for your needs
+
+require 'cgi'
+require 'fileutils'
+
+class HtmlStepOutputter
+  
+  def initialize(file)
+    @file = File.open(file, 'w')
+    @previous_type = ""
+    @id_number = 0
+  end
+  
+  # HTML file header - customize as needed
+  def header
+    @file.puts <<-eos
+      <!DOCTYPE html>
+      <html>
+      <head>
+      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+      <title>Cucumber step documentation</title>
+      <style>
+      .stepdefs {
+        font-size: smaller;
+      }
+      .stepdefs li {
+        margin-bottom: 0.25em;
+        list-style-type: none;
+      }
+      .stepdefs li:before {
+        content: "\u00BB ";
+        font-size: larger;
+        padding-right: 0.3em;
+      }
+      .stepdef {
+        color: #111;
+        text-decoration: none;
+      }
+      .extrainfo {
+        display: none;
+        overflow: hidden; /* Fixes jumping issue in jQuery slideToggle() */
+      }
+      </style>
+      <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.8.3/jquery.min.js"></script>
+      </head>
+      <body>
+    eos
+  end
+  
+  def footer
+    @file.puts <<-eos
+      </ul>
+      <p>&nbsp;</p>
+      <p><em>Documentation generated #{Time.now}</em></p>
+      </body>
+      </html>
+    eos
+  end
+
+  
+  def close
+    @file.close
+  end
+
+  def start_directory(dir)
+    @file.puts %(</ul>) if @previous_type != ""
+    @file.puts %(<p>&nbsp;</p>)
+    @file.puts %(<h2>Step definitions in #{dir}/</h2>)
+    @previous_type = ""
+  end
+
+  def end_directory
+    # No-op
+  end
+
+  def start_all
+    @file.puts %(</ul>)
+    @file.puts %(<p>&nbsp;</p>)
+    @file.puts %(<h2>All definitions alphabetically</h2>)
+    @previous_type = ""
+  end
+
+  def end_all
+    # No-op
+  end
+
+  def step(step)
+    if @previous_type != step[:type]
+      @file.puts %(</ul>) if @previous_type != ""
+      @file.puts %(<h3>#{step[:type]} definitions</h3>)
+      @file.puts %(<ul class="stepdefs">)
+      @previous_type = step[:type]
+    end
+
+    id = new_id
+    @file.puts %(<li>)
+    @file.puts %(  <a href="#" onclick="$('##{id}').slideToggle(); return false;" class="stepdef">#{CGI.escapeHTML(step[:name])}</a>)
+    @file.puts %(  <div id="#{id}" class="extrainfo">)
+    # TODO: Add link to source repo or Jenkins workspace
+    # <p><a href=".../#{CGI.escapeHTML(step[:filename])}" style="color: #888;">#{CGI.escapeHTML(step[:filename])}:#{step[:line_number]}</a></p>
+    @file.puts %(    <p style="color: #888;">#{CGI.escapeHTML(step[:filename])}:#{step[:line_number]}</p>)
+    @file.puts %(      <pre style="background-color: #ddd; padding-top: 1.2em;">)
+    step[:code].each do |line|
+      @file.puts %(   #{CGI.escapeHTML(line)})
+    end
+    @file.puts %(      </pre>)
+    @file.puts %(  </div>)
+    @file.puts %(</li>)
+  end
+  
+  private
+  
+  def new_id
+    @id_number += 1
+    "id#{@id_number}"
+  end
+
+end

data/lib/step_parser.rb

@@ -0,0 +1,75 @@
+# Class that parses step definitions from Ruby files
+
+class StepParser
+
+  attr_reader :steps
+  def initialize
+    @steps = []
+  end
+
+  def read(file)
+    @current_file = file
+    @line_number = 0
+    @lines = IO.read(file).split(/\r?\n/)
+    parse_lines
+  end
+
+
+  private
+
+  def next_line
+    @line_number += 1
+    @lines.shift
+  end
+
+  def unread(line)
+    @line_number -= 1
+    @lines.unshift(line)
+  end
+
+  def parse_lines
+    @comments = []
+    while not @lines.empty?
+
+      line = next_line
+      case line
+      when /^ *#/
+        @comments << line
+      when /^(Given|When|Then|Before|After|AfterStep|Transform)[ (]/
+        unread(line)
+        parse_step
+        @comments = []
+      when /^\s+(Given|When|Then|Before|After|AfterStep|Transform)[ (]/
+        puts "WARNING:  Indented step definition in file #{@current_file}:  #{line}"
+        @comments = []
+      else
+        @comments = []
+      end
+
+    end
+  end
+
+  def parse_step
+    type = parse_step_type(@lines.first)
+    name = parse_step_name(@lines.first)
+    line_number = @line_number + 1
+    code = @comments
+    line = ""
+    while !@lines.empty? && !(line =~ /^end\s*$/)
+      line = next_line
+      code << line
+    end
+    @steps << { :type => type, :name => name, :filename => @current_file, :code => code, :line_number => line_number }
+  end
+
+  def parse_step_type(line)
+    line.sub(/^([A-Za-z]+).*/, '\1')
+  end
+
+  def parse_step_name(line)
+    line = line.sub(/^(Given|When|Then|Transform) *\(?\/\^?(.*?)\$?\/.*/, '\1 \2')
+    line = line.gsub('\ ', ' ')
+    line
+  end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: cuke_steps
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- plaa, packager:raels
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: |-
+  This gem offers a program to generate a reference index for your Gherkin step definitions.
+                            It was written by plaa, and packaged by raels.
+email:
+- ''
+executables:
+- console
+- cuke-steps
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/cuke-steps
+- bin/setup
+- cuke_steps_gem.gemspec
+- lib/confluence_step_outputter.rb
+- lib/cuke_steps_gem.rb
+- lib/cuke_steps_gem/version.rb
+- lib/html_step_outputter.rb
+- lib/step_parser.rb
+homepage: https://raels.github.io/cuke-steps/
+licenses: []
+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.1
+signing_key: 
+specification_version: 4
+summary: Generates Gherkin step reference page
+test_files: []