stepdown-patched 0.6.3.1patched

data/.bundle/config

@@ -0,0 +1 @@
+--- {}

data/.gitignore

@@ -0,0 +1,7 @@
+.idea/
+.sass-cache
+*.html
+*.rbc
+*.gem
+.rvmrc
+*.swp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gem 'gherkin', '> 2.3'
+gem 'bundler', '> 1.0'
+
+group :development,:test do
+  gem 'rake'
+  gem 'rspec', '~> 2.5.0'
+  gem 'rcov', '~> 0.9.9'
+  gem 'sass', '~> 3.1.0'
+  gem 'haml', '~> 3.1.3'
+end

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    gherkin (2.4.6)
+      json (>= 1.4.6)
+    haml (3.1.3)
+    json (1.5.3)
+    rake (0.9.2)
+    rcov (0.9.10)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.2)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    sass (3.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (> 1.0)
+  gherkin (> 2.3)
+  haml
+  rake
+  rcov (~> 0.9.9)
+  rspec (~> 2.5.0)
+  sass (~> 3.1.0)

data/History.txt

@@ -0,0 +1,50 @@
+== 0.6.3 2011-08-16
+* update dependant gems, be less restrictive on versions
+* adjust statistics interface to improve metric_fu integration
+
+== 0.6.2 2011-06-26
+* Only show top 10 items on page load
+
+== 0.6.1 2011-06-23
+* fix issue with Ruby 1.9.2
+* update jQuery
+
+== 0.6.0 2011-6-6
+* Graph for overall statistics
+
+== 0.5.0 2011-5-17
+* Use gherkin gem to parse features
+* Added empty step detection
+* Added unused step count to summary
+* Added quiet option
+
+== 0.4.0 2011-3-29
+* Better HTML output
+* Structured like other gems
+* Maintainability improvements
+* Better test coverage
+
+== 0.3.3 2011-03-05
+* Better HTML output
+
+== 0.3.2 - 2011-02-27
+* Bugfix in option parsing
+* Bugfix for missing constants
+
+== 0.3.1 - 2011-02-26
+* Fix broken include [Robert Postill]
+
+== 0.3.0 - 2011-02-26
+* Added text report
+* Bug fix for missing constants
+
+== 0.2.1 - 2011-02-19
+* Proper option parsing
+
+== 0.2 - 2011-02-14
+* Added some specs
+* Improved output
+* Updated usage message
+
+== 0.1 - 2011-01-16
+* Initial release

data/README.rdoc

@@ -0,0 +1,28 @@
+= Stepdown
+Stepdown allows you to see where your most used Cucumber steps are, your unused steps and how they are clustered
+
+== Statistics available
+* Total number of scenarios
+* Total number of steps
+* Number of empty scenarios (scenarios without any steps)
+* Number of steps per scenario
+* Number of unique steps per scenario
+* Per step
+  * Total usage
+  * Number of scenarios
+  * Usage per scenario
+  * Scenario grouping (number of times used with another step)
+
+== Installation
+Stepdown is available as a Ruby gem
+   gem install stepdown
+
+Or, add the following to your Gemfile
+   gem 'stepdown'
+
+== Usage
+From the root folder of your project. This assumes step definitions are in PROJECT_ROOT/features/step_definitions and feature files are in PROJECT_ROOT/features
+  stepdown
+Or, set the the directory parameters manually
+  stepdown --steps <step definition directory> --features <feature file directory>
+  e.g. stepdown --steps features/step_definitions --features features

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.fail_on_error = false
+end
+
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.fail_on_error = false
+  t.rcov_opts = %w{ --exclude gems\/,spec\/,features\/}
+  t.rcov = true
+end
+
+task :default => :spec

data/bin/stepdown

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'stepdown/options'
+require 'stepdown'
+
+begin
+
+  options = Stepdown::Options.new
+  options.parse(ARGV)
+  options.validate
+
+  Stepdown.quiet = options.quiet
+  Stepdown.output_directory = options.output_directory
+
+  Stepdown::Analyzer.new(options.steps_dir, options.features_dir, options.reporter).analyse
+
+rescue Interrupt => e
+  puts "Quiting..."
+  exit 1
+end
+

data/lib/stepdown/analyzer.rb

@@ -0,0 +1,74 @@
+require 'gherkin/parser/parser'
+
+module Stepdown
+  class Analyzer
+    def initialize(steps_dir, feature_dir, reporter)
+      @feature_dir = feature_dir
+      @steps_dir = steps_dir
+      @reporter = reporter
+    end
+
+    def analyse
+      scenarios = collect_scenarios
+
+      stats = Statistics.new(scenarios, instance.step_collection)
+      stats.generate
+
+      reporter = reporter(@reporter, stats)
+      reporter.output_overview
+
+      Stepdown::YamlWriter.write(stats)
+      Stepdown::Graph.create_graph
+    end
+
+    def collect_scenarios
+      puts "Parsing feature files..." unless Stepdown.quiet
+      process_feature_files(feature_files)
+    end
+
+    def process_feature_files(feature_files)
+      listener = Stepdown::FeatureParser.new(instance)
+
+      parser = Gherkin::Parser::Parser.new(listener, true, 'root')
+
+      feature_files.each do |feature_file|
+        parser.parse(File.read(feature_file), feature_file, 0)
+      end
+      listener.scenarios
+    end
+
+    def reporter(type, stats)
+      case type
+        when "html"
+          Stepdown::HTMLReporter.new(stats)
+        when "text"
+          Stepdown::TextReporter.new(stats)
+        when "quiet"
+          Stepdown::Reporter.new(stats)
+      end
+    end
+
+
+    def instance
+      @instance ||= begin
+        new_inst = Stepdown::StepInstance.new
+
+        Dir.glob(step_files).each do |file_name|
+          new_inst.instance_eval File.read(file_name)
+        end
+        new_inst
+      end
+    end
+
+    private
+    def feature_files
+      return @feature_files if @feature_files
+      @feature_files = Dir.glob(@feature_dir + '/**/*.feature')
+    end
+
+    def step_files
+      return @step_files if @step_files
+      @step_files = Dir.glob(@steps_dir + '/**/*.rb')
+    end
+  end
+end

data/lib/stepdown/feature_parser.rb

@@ -0,0 +1,60 @@
+require 'stepdown/step'
+require 'stepdown/scenario'
+module Stepdown
+  class FeatureParser
+
+    def initialize(instance)
+      @instance = instance
+      @scenarios = []
+    end
+
+    def scenarios
+      unless @scenarios.last == @current_scenario
+        @scenarios << @current_scenario
+      end
+      @scenarios.compact
+    end
+
+    def background(background)
+      @scenarios << @current_scenario
+      @current_scenario = Scenario.new(background.name)
+    end
+
+    def scenario(scenario)
+      @scenarios << @current_scenario
+      @current_scenario = Scenario.new(scenario.name)
+    end
+
+    def scenario_outline(scenario_outline)
+      @scenarios << @current_scenario      
+      @current_scenario = Scenario.new(scenario_outline.name)
+    end
+
+    def step(step)
+      matched_step = @instance.line_matches(step.name)
+      @current_scenario.add_step(matched_step) if matched_step
+    end
+
+    def uri(*args) end
+
+    def feature(*args) end
+
+    def examples(*args) end
+
+    def comment(*args) end
+
+    def tag(*args) end
+
+    def table(*args) end
+
+    def py_string(*args) end
+
+    def eof(*args) end
+
+    def syntax_error(*args)
+      # raise "SYNTAX ERROR"
+    end
+
+  end
+end
+

data/lib/stepdown/graph.rb

@@ -0,0 +1,75 @@
+require 'json'
+require 'date'
+module Stepdown
+  class Graph
+    BLUFF_GRAPH_SIZE = "890x400"
+    BLUFF_DEFAULT_OPTIONS = <<-EOS
+      var g = new Bluff.Line('graph', "#{BLUFF_GRAPH_SIZE}");
+      g.theme_37signals();
+      g.tooltips = true;
+      g.title_font_size = "24px"
+      g.legend_font_size = "12px"
+      g.marker_font_size = "10px"
+    EOS
+
+    def self.create_graph
+      stats, labels = collect_stats
+      label_set = {}
+      labels.each_with_index do |label, i|
+        label_set.update({i => label})
+      end
+
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Stepdown';
+        g.data('Total scenarios', [#{stats[:number_scenarios].join(',')}]);
+        g.data('Total steps', [#{stats[:total_steps].join(',')}]);
+        g.data('Total steps per scenario', [#{stats[:steps_per_scenario].join(',')}]);
+        g.data('Total unused steps', [#{stats[:unused_steps].join(',')}]);
+        g.labels = #{label_set.to_json};
+        g.draw();
+      EOS
+
+      File.open(File.join(Stepdown.output_directory, 'stepdown.js'), 'w') do 
+        |f| f << content 
+      end
+    end
+
+    def self.collect_stats
+      stats = Hash.new {|hsh, key| hsh[key] = [] }
+      labels = []
+
+      load_stats.each do |stat_set|
+        stat_set.each{|key, val| stats[key].push val }
+        labels.push(stat_set[:label])
+      end
+
+      [stats, labels]
+    end
+
+    def self.load_stats
+      stat_collection = []
+      Dir.glob("#{Stepdown.output_directory}/*.yml").sort.each do |file_name|
+        stats = Hash.new {|hsh, key| hsh[key] = [] }
+        file = File.open(file_name)
+        stat_set = YAML::load(file)
+
+        stat_set.each do |key, val|
+          stats[key].push(val)
+        end
+        stats[:label] = date_from_file_name(file_name)
+        stat_collection << stats
+
+        file.close
+      end
+
+      stat_collection
+    end
+
+    def self.date_from_file_name(file_name)
+      label_date = Date.strptime(file_name.match(/(\d+)/)[1], "%Y%m%d")
+      "#{label_date.day} / #{label_date.month}"
+    end
+
+  end
+end

data/lib/stepdown/html_reporter.rb

@@ -0,0 +1,37 @@
+require 'fileutils'
+require 'stepdown/reporter'
+require 'haml'
+
+module Stepdown
+  class HTMLReporter < Reporter
+
+    def output_overview()
+      puts "Generating report..." unless Stepdown.quiet
+      FileUtils.mkdir_p(Stepdown.output_directory)
+      copy_files()
+
+      ["index", "_empty", "_unused", "_grouping", "_usages"].each { |template| write_html_from_erb(template) }
+
+      puts "\nReport output to #{Stepdown.output_directory}/index.html" unless Stepdown.quiet
+    end
+
+    protected
+
+    def write_html_from_erb(template)
+      file = File.open(File.expand_path(File.dirname(__FILE__)) + "/../../templates/#{template}.html.erb")
+      erb = ERB.new(file.read())
+
+      file.close
+      out = File.new(Stepdown.output_directory + "/#{template}.html",'w+')
+      out.puts erb.result(binding())
+      out.close
+    end
+
+    def copy_files
+      ['step_down.js', 'jquery-1.6.1.min.js', 'bluff-min.js', 'excanvas.js', 'js-class.js', 'stepdown.css'].each do |file|
+        src = File.expand_path("#{File.dirname(__FILE__)}/../../public/#{file}")
+        FileUtils.cp(src, File.join(Stepdown.output_directory, "#{file}"))
+      end
+    end
+  end
+end

data/lib/stepdown/options.rb

@@ -0,0 +1,68 @@
+require 'optparse'
+
+module Stepdown
+  class Options
+    attr_reader :steps_dir, :features_dir, :reporter, :quiet, :output_directory
+
+    OUTPUT_FORMATS = ["html", "text", "quiet"]
+
+    def parse(params)
+      @steps_dir = "features/step_definitions"
+      @features_dir = "features"
+      @reporter = "html"
+      @quiet = false
+      @output_directory = "./stepdown"
+      parser = OptionParser.new do |opts|
+        opts.banner = <<-USE 
+        Usage: stepdown
+               stepdown --steps <STEP_DEFINITION_DIRECTORY> --features <FEATURE_FILE_DIRECTORY>
+        USE
+
+        opts.separator("")
+
+        opts.on("--output=TYPE", OUTPUT_FORMATS, "Select ouput format (#{OUTPUT_FORMATS.join(',')}). Default: html") do |o|
+          @reporter = o
+        end
+
+        opts.on("--steps=STEPS_DIR", "Step definition directory. Default: ./features/step_definitions") do |o|
+          @steps_dir = o
+        end
+
+        opts.on("--features=FEATURE_DIR", "Feature file directory. Default: ./features") do |o|
+          @features_dir = o
+        end
+
+        opts.on("--quiet", "-q", "Supress output") do |o|
+          @quiet = true
+        end
+
+        opts.on_tail("-h", "--help", "You're looking at it") do |o|
+          puts opts
+          exit
+        end
+
+      end
+
+      begin
+        parser.parse(params)
+
+      rescue OptionParser::ParseError => e
+        puts e
+        exit 1
+      end
+    end
+
+    def validate(io = STDOUT)
+      @steps_dir = File.join(Dir.pwd, @steps_dir)
+      @features_dir = File.join(Dir.pwd, @features_dir)
+
+      [@steps_dir, @features_dir].each do |dir|
+        unless File.exists?(dir)
+          io.puts "Directory #{dir} does not exist"
+          exit 1
+        end
+      end
+
+    end
+  end
+end