stepdown 0.3.3 → 0.4.0

data/Gemfile

@@ -1,7 +1,9 @@
 source 'http://rubygems.org'
 
-gem 'haml'
+gem 'haml', '> 2.0.0'
 
 group :development,:test do
-  gem 'rspec'
+  gem 'rake'
+  gem 'rspec', '~> 2.5.0'
+  gem 'rcov', '~> 0.9.9'
 end

data/Gemfile.lock

@@ -2,20 +2,24 @@ GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.2)
-    haml (3.0.25)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
+    haml (2.0.10)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
+    rspec-mocks (2.5.0)
 
 PLATFORMS
   java
   ruby
 
 DEPENDENCIES
-  haml
-  rspec
+  haml (> 2.0.0)
+  rake
+  rcov (~> 0.9.9)
+  rspec (~> 2.5.0)

data/History.txt

@@ -0,0 +1,30 @@
+== 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

@@ -17,5 +17,5 @@ Stepdown is available as a ruby gem
    gem install stepdown
 
 == Usage
-  stepdown <step definition directory> <feature file directory>
-  e.g. stepdown features/step_definitions features
+  stepdown --steps <step definition directory> --features <feature file directory>
+  e.g. stepdown --steps features/step_definitions --features features

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rspec/core/rake_task'
+
+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

@@ -2,16 +2,16 @@
 lib = File.expand_path('../lib/', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
-require 'step_down'
-require 'options'
+require 'stepdown'
+require 'stepdown/options'
 
 begin
 
-  options = Options.new
+  options = Stepdown::Options.new
   options.parse(ARGV)
   options.validate
 
-  StepDown.new(options.steps_dir, options.features_dir, options.reporter).analyse
+  Stepdown::Analyzer.new(options.steps_dir, options.features_dir, options.reporter).analyse
 
 rescue Interrupt => e
   puts "Quiting..."

data/lib/stepdown.rb

@@ -0,0 +1,6 @@
+require 'stepdown/feature_parser'
+require 'stepdown/step_instance'
+require 'stepdown/html_reporter'
+require 'stepdown/text_reporter'
+
+require 'stepdown/analyzer'

data/lib/stepdown/analyzer.rb

@@ -0,0 +1,67 @@
+
+
+module Stepdown
+  class Analyzer
+    def initialize(steps_dir, feature_dir, reporter)
+      @feature_dir = feature_dir
+      @steps_dir = steps_dir
+      @reporter = reporter
+    end
+
+    def analyse
+      puts "Parsing feature files..."
+      scenarios = process_feature_files(feature_files)
+
+      puts "Performing analysis..."
+
+      reporter = reporter(@reporter, scenarios, instance.step_collection)
+      reporter.output_overview
+
+    end
+
+    def process_feature_files(feature_files)
+      parser = Stepdown::FeatureParser.new
+
+      scenarios = []
+      feature_files.each do |feature_file|
+        scenarios << parser.process_feature(feature_file, instance)
+      end
+      scenarios.flatten
+    end
+
+    def reporter(type, scenarios, step_collection)
+      case type
+        when "html"
+          Stepdown::HTMLReporter.new(scenarios, step_collection)
+        when "text"
+          Stepdown::TextReporter.new(scenarios, step_collection)
+      end
+    end
+
+    def step(id)
+      instance.steps.detect{|step| step.id == id}
+    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,30 @@
+require 'stepdown/step'
+require 'stepdown/scenario'
+module Stepdown
+  class FeatureParser
+
+    def process_feature(file, instance)
+      scenarios = []
+      file_lines = read_feature_file(file)
+
+      file_lines.each do |line|
+
+        if line =~ /Scenario|Background/
+          @scenario = Scenario.new
+          scenarios << @scenario
+        else
+          step = instance.line_matches(line)
+          @scenario.add_step(step) if step
+        end
+      end
+
+      scenarios
+    end
+
+    protected
+    def read_feature_file(file_name)
+      File.read(file_name).split("\n")
+    end
+  end
+end
+

data/lib/stepdown/html_reporter.rb

@@ -0,0 +1,41 @@
+require 'fileutils'
+require 'stepdown/reporter'
+require 'haml'
+require 'sass'
+
+module Stepdown
+  class HTMLReporter < Reporter
+
+    def output_overview()
+      puts "Generating report..."
+      FileUtils.mkdir_p(Reporter::OUTPUT_DIR)
+      copy_files
+
+      template = File.open(File.expand_path(File.dirname(__FILE__)) + '/../../templates/main.html.haml').read()
+      engine = Haml::Engine.new(template)
+
+      out = File.new(Reporter::OUTPUT_DIR + '/analysis.html','w+')
+      out.puts engine.render(self)
+      out.close
+
+      template = File.open(File.expand_path(File.dirname(__FILE__))  + '/../../templates/style.sass').read
+      sass_engine = Sass::Engine.new(template)
+
+      out = File.new(Reporter::OUTPUT_DIR + '/style.css', 'w+')
+      out.puts sass_engine.render
+
+      out.close
+
+      $stdout.puts "\nReport output to #{Reporter::OUTPUT_DIR}/analysis.html"
+    end
+
+    protected
+
+    def copy_files
+      ['step_down.js', 'jquery-1.4.3.min.js'].each do |file|
+        src = File.expand_path("#{File.dirname(__FILE__)}/../../public/#{file}")
+        FileUtils.cp(src, File.join(OUTPUT_DIR, "#{file}"))
+      end
+    end
+  end
+end

data/lib/stepdown/options.rb

@@ -0,0 +1,59 @@
+require 'optparse'
+
+module Stepdown
+  class Options
+    attr_reader :steps_dir, :features_dir, :reporter
+
+    OUTPUT_FORMATS = ["html", "text"]
+
+    def parse(params)
+      @steps_dir = "features/step_definitions"
+      @features_dir = "features"
+      @reporter = "html"
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: stepdown step_definition_dir feature_file_directory"
+
+        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_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

data/lib/stepdown/reporter.rb

@@ -0,0 +1,106 @@
+require 'stepdown/step_group'
+require 'stepdown/step_usage'
+
+module Stepdown
+  class Reporter
+    OUTPUT_DIR = "./stepdown"
+
+    attr_reader :scenarios, :usages, :step_collection, :grouping
+
+    def initialize(scenarios, step_collection)
+      @scenarios = scenarios
+      @step_collection = step_collection
+    end
+
+    def groupings
+      @groupings ||= grouping(@scenarios)
+    end
+
+    def total_scenarios
+      @scenarios.length
+    end
+
+    def total_steps
+      @step_collection.length
+    end
+
+    def steps_per_scenario
+      steps_scenario(@scenarios)
+    end
+
+    def unique_steps
+      uniq_steps_per_scenario(@scenarios)
+    end
+
+    def grouping(scenarios)
+      step_groups = @step_collection.collect{|step| Stepdown::StepGroup.new(step) }
+
+      step_groups.each do |step_group|
+        scenarios.each do |scenario|
+
+          if scenario.steps.any?{|step| step.id == step_group.id}
+            step_group.add_steps(scenario.steps)
+            step_group.update_use_count(scenario.step_count)
+          end
+        end
+
+      end
+      step_groups.sort{|a,b| b.use_count <=> a.use_count}
+    end
+
+    def step_usage(scenarios)
+      usages = @step_collection.collect{|step| Stepdown::StepUsage.new(step) }
+      scenarios.each do |scenario|
+
+        scenario.steps.each do |step|
+          usage = usages.detect{|use| use.step.id == step.id}
+          if usage
+            usage.total_usage += step.count
+            usage.number_scenarios += 1
+          end
+        end
+      end
+
+      usages.each do |usage|
+        if usage.number_scenarios > 0
+          use = sprintf "%.2f", (usage.total_usage / Float(usage.number_scenarios))
+          usage.use_scenario = use
+        end
+      end
+
+      usages.sort{|a,b| b.total_usage <=> a.total_usage}
+    end
+
+    def step_usages
+      @step_usages ||= step_usage(@scenarios)
+    end
+
+    def usages
+      step_usages.select{|use| use.total_usage > 0 }
+    end
+
+    def unused_steps
+      step_usages.select{|use| use.total_usage == 0}
+    end
+
+    def uniq_steps_per_scenario(scenarios)
+      total_steps = 0.0
+      uniq_steps = 0.0
+      scenarios.each do |scen|
+        total_steps += scen.step_count
+        uniq_steps += scen.unique_step_count
+      end
+      sprintf "%.2f", (total_steps / uniq_steps)
+    end
+
+    def steps_scenario(scenarios)
+      scen_count = scenarios.length
+      step_count = 0.0
+      scenarios.each do |scenario|
+        step_count += scenario.step_count
+      end
+      sprintf "%.2f", (step_count / scen_count)
+    end
+  end
+end
+

data/lib/stepdown/scenario.rb

@@ -0,0 +1,25 @@
+require 'stepdown/step_collection'
+
+module Stepdown
+  class Scenario
+    attr_reader :step_count
+    def initialize
+      @step_collection = Stepdown::StepCollection.new
+      @step_count = 0
+    end
+
+    def add_step(step)
+      @step_count += 1
+      @step_collection.add_step(step.id, step.regex)
+    end
+
+    def steps
+      @step_collection.steps
+    end
+
+    def unique_step_count
+      @step_collection.length
+    end
+
+  end
+end