cuke-steps 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daf09884012622405d6940dc98da89ee1de820aa
+  data.tar.gz: 2bbbf2c368ee08721e5ade74bfccb53851f60b9f
+SHA512:
+  metadata.gz: 398a85ade3e4d2cc46a5253fbd41af919987b4dd34500c9055ca7a7e2839f9cf5af4556ea0578f3664379e8581e6172b0ca8121745a005d356eea54bf620a021
+  data.tar.gz: 1be067cd1c81a005dff578017b7f9728af8f1c0b30ec5672d70424a0926c6153955e12ae389382c353f05f0207205a0a5a1000072e4d205c6fa1d1fb3881d60c

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.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+#-*- encoding: utf-8 -*-
+
+require 'optparse'
+
+require_relative 'step_parser'
+require_relative 'confluence_step_outputter'
+require_relative '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/lib/cuke-tags.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+#-*- encoding: utf-8 -*-
+require 'json'
+require 'optparse'
+
+require_relative 'step_parser'
+require_relative 'tag_parser'
+require_relative 'confluence_step_outputter'
+require_relative 'html_step_outputter'
+
+# Parse command line
+options = {}
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: cuke-tags.rb [options] <directories...>"
+
+  opts.on("-o", "--output FILE", "Output to FILE") do |file|
+    options[:file] = file
+  end
+  
+end
+opts.parse!(ARGV)
+
+# Default output options
+if  !options[:file]
+  options[:file] = "tags.json"
+end
+
+# All other arguments are treated as input directories
+dirs = ARGV
+if dirs.size == 0
+  puts "No source directory provided, use -h for help"
+  exit 1
+end
+
+
+puts "Writing output to file '#{options[:file]}'"
+
+
+
+# Read files and output
+all_tags = []
+dir = Dir.new(dirs[0]).to_path
+t = TagParser.new
+Dir.glob("#{dir}/*.feature") do |file|
+  t.read(file)
+  tags = t.tags
+  all_tags += tags
+end
+File.open(options[:file], 'w') {|f| f.write(all_tags.to_json) }

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

data/lib/tag_parser.rb

@@ -0,0 +1,80 @@
+# Class that parses step definitions from Ruby files
+
+class TagParser
+
+  attr_reader :tags
+  def initialize
+    @tags = []
+  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 /^\s+@.*/
+        unread(line)
+        parse_tag
+        @comments = []
+      when /^@.*/
+        unread(line)
+        parse_tag
+      else
+        @comments = []
+      end
+
+    end
+  end
+
+  def parse_tag
+    line = next_line
+    tag_names = parse_tag_names(line)
+    line_number =@line_number
+    code = ""
+    line = ""
+    scenario = ""
+    while !@lines.empty? && !(line =~ /^\s+@.*/)
+      line = next_line
+      case line
+
+      when /^\s+Scenario:.*/
+        scenario = line
+      else
+        code << line
+      end
+
+    end
+    @tags << {  :names => tag_names, :filename => @current_file, :comments => @comments,:code => code, :scenario=>scenario, :line_number => line_number }
+  end
+
+  def parse_step_type(line)
+    line.sub(/^([A-Za-z]+).*/, '\1')
+  end
+
+  def parse_tag_names(line)
+    tags = line.split(' ')
+    tags
+  end
+
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: cuke-steps
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ali Khan
+- plaa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-02 00:00:00.000000000 Z
+dependencies: []
+description: Cucumber Steps and Tags documentation generator.
+email: alikhan@himindz.ie
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/confluence_step_outputter.rb
+- lib/cuke-steps.rb
+- lib/cuke-tags.rb
+- lib/html_step_outputter.rb
+- lib/step_parser.rb
+- lib/tag_parser.rb
+homepage: https://github.com/himindz/cuke-steps
+licenses:
+- BSD
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Cucumber Steps and Tags documentation generator
+test_files: []