stepdown 0.2.1 → 0.3.0

data/.gitignore

@@ -4,3 +4,4 @@
 *.css
 *.rbc
 *.gem
+.rvmrc

data/bin/stepdown

@@ -10,7 +10,7 @@ begin
   Options.parse(ARGV)
   Options.validate
 
-  StepDown.new(Options.steps_dir, Options.features_dir).analyse
+  StepDown.new(Options.steps_dir, Options.features_dir, Options.reporter).analyse
 
 rescue Interrupt => e
   puts "Quiting..."

data/lib/html_reporter.rb

@@ -1,61 +1,28 @@
 require 'fileutils'
-class HTMLReporter
-  OUTPUT_DIR = "./stepdown"
-  attr_reader :scenarios, :usages, :steps, :grouping
-
-  def initialize(scenarios, usages, grouping, steps)
-    @scenarios = scenarios
-    @usages = usages
-    @steps = steps
-    @grouping = grouping
-  end
-
-  def groupings
-    @grouping
-  end
-
-  def total_scenarios
-    @scenarios.length
-  end
-
-  def total_steps
-    @steps.length
-  end
-
-  def steps_per_scenario
-    steps_scenario(@scenarios)
-  end
-
-  def unique_steps
-    uniq_steps_per_scenario(@scenarios)
-  end
-
-  def usages
-    @usages.select{|use| use.total_usage > 0 }
-  end
-
-  def unused_steps
-    @usages.select{|use| use.total_usage == 0}
-  end
+require 'reporter'
+class HTMLReporter < Reporter
 
   def output_overview()
-    FileUtils.mkdir_p(OUTPUT_DIR)
+    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(OUTPUT_DIR + '/analysis.html','w+')
+    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(OUTPUT_DIR + '/style.css', 'w+')
+    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
@@ -67,23 +34,4 @@ class HTMLReporter
     end
   end
 
-  def steps_scenario(scenarios)
-    scen_count = scenarios.length
-    step_count = 0.0
-    scenarios.each do |scenario|
-      step_count += scenario.steps.length
-    end
-    step_count / scen_count
-  end
-
-  def uniq_steps_per_scenario(scenarios)
-    total_steps = 0.0
-    uniq_steps = 0.0
-    scenarios.each do |scen|
-      total_steps += scen.steps.length
-      uniq_steps += scen.uniq_steps.length
-    end
-    total_steps / uniq_steps
-  end
-
-end
+end

data/lib/options.rb

@@ -2,15 +2,23 @@ require 'optparse'
 
 class Options
 
+  OUTPUT_FORMATS = ["html", "text"]
+
   def self.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(',')})") do |o|
+        @@reporter = o
+      end
+
       opts.on("--steps=directory", "Step definition directory") do |o|
         @@steps_dir = o
       end
@@ -61,4 +69,8 @@ class Options
     @@features_dir
   end
 
-end
+  def self.reporter
+    @@reporter
+  end
+
+end

data/lib/reporter.rb

@@ -0,0 +1,62 @@
+
+class Reporter
+  OUTPUT_DIR = "./stepdown"
+
+  attr_reader :scenarios, :usages, :steps, :grouping
+  
+  def initialize(scenarios, usages, grouping, steps)
+    @scenarios = scenarios
+    @usages = usages
+    @steps = steps
+    @grouping = grouping
+  end
+
+  def groupings
+    @grouping
+  end
+
+  def total_scenarios
+    @scenarios.length
+  end
+
+  def total_steps
+    @steps.length
+  end
+
+  def steps_per_scenario
+    steps_scenario(@scenarios)
+  end
+
+  def unique_steps
+    uniq_steps_per_scenario(@scenarios)
+  end
+
+  def usages
+    @usages.select{|use| use.total_usage > 0 }
+  end
+
+  def unused_steps
+    @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.steps.length
+      uniq_steps += scen.uniq_steps.length
+    end
+    total_steps / uniq_steps
+  end
+
+  def steps_scenario(scenarios)
+    scen_count = scenarios.length
+    step_count = 0.0
+    scenarios.each do |scenario|
+      step_count += scenario.steps.length
+    end
+    step_count / scen_count
+  end
+
+end
+

data/lib/step_down.rb

@@ -7,14 +7,18 @@ require 'step_instance'
 require 'step_group'
 require 'step_usage'
 require 'html_reporter'
+require 'yaml_reporter'
+require 'text_reporter'
 class StepDown
 
-  def initialize(steps_dir, feature_dir)
+  def initialize(steps_dir, feature_dir, reporter)
     @feature_files = Dir.glob(feature_dir + '/**/*.feature')
     @step_files = Dir.glob(steps_dir + '/**/*.rb')
+    @reporter = reporter
   end
 
   def analyse
+    puts "Parsing feature files..."
     parser = FeatureParser.new
 
     scenarios = []
@@ -23,17 +27,28 @@ class StepDown
     end
     scenarios.flatten!
 
+    puts "Performing analysis..."
     usages = step_usage(scenarios)
     usages = usages.sort{|a,b| b.total_usage <=> a.total_usage }
     grouping = grouping(scenarios).sort{|a,b| b.use_count <=> a.use_count}
 
-    reporter = HTMLReporter.new(scenarios, usages, grouping, instance.steps)
+    reporter = reporter(@reporter, scenarios, usages, grouping, instance.steps)
     reporter.output_overview
 
 #    #pp grouping(@scenarios)
 #       puts YAML::dump(scenario) if scenario.use_count > 100  &&  scenario.use_count < 500
 #    end
   end
+ 
+  # don't want a factory just yet 
+  def reporter(type, scenarios, usages, grouping, steps)
+    case type
+    when "html"
+      HTMLReporter.new(scenarios, usages, grouping, steps)
+    when "text"
+      TextReporter.new(scenarios, usages, grouping, steps)
+    end
+  end
 
   def step_usage(scenarios)
     usages = instance.steps.collect{|step| StepUsage.new(step) }

data/lib/step_instance.rb

@@ -22,6 +22,10 @@ class StepInstance
   def method_missing(*args)
     #nothing
   end
+  
+  def self.const_missing(*args)
+    #nothing
+  end
 
   def require(*args)
     # do nothing
@@ -49,4 +53,4 @@ class StepInstance
     @step_definitions
   end
 
-end
+end

data/lib/text_reporter.rb

@@ -0,0 +1,36 @@
+require 'reporter'
+
+class TextReporter < Reporter
+  
+  def output_overview
+    puts "Generating report..."
+    output = File.new(Reporter::OUTPUT_DIR + '/analysis.txt', "w+")
+
+    output.puts "Total number of scenarios: #{total_scenarios}"
+    output.puts "Total numer of steps: #{total_steps}"
+    output.puts "Steps per scenario: #{steps_per_scenario}"
+    output.puts "Unique steps per scenario: #{unique_steps}"
+
+    output.puts "Step usages"
+    usages.each{|use| output.puts used_step_line(use) }
+
+    output.puts "Unused steps"
+    unused_steps.each{|use| output.puts unused_step_line(use) }
+
+    output.close
+
+    puts "Report output to #{Reporter::OUTPUT_DIR}/analysis.txt"
+
+  end
+
+  def used_step_line(use)
+    line = [use.step.regex.inspect, use.total_usage, use.number_scenarios, use.use_scenario]
+    line.join("|")
+  end
+
+  def unused_step_line(use)
+    use.step.regex
+  end
+
+
+end

data/spec/lib/step_instance_spec.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/step_instance')
+
+
+describe StepInstance do
+
+  before :each do 
+    @step_instance = StepInstance.new
+  end
+
+  it "should deal with missing constants" do
+    lambda{ @step_instance.instance_eval("MissingConst") }.should_not raise_error
+  end
+  it "should deal with missing methods" do
+     lambda{ @step_instance.doesnt_exist }.should_not raise_error
+  end
+
+  describe "steps" do
+
+  end
+
+  describe "line matches" do
+
+  end
+
+end

data/stepdown.gemspec

@@ -1,13 +1,13 @@
 
 Gem::Specification.new do |s|
   s.name = "stepdown"
-  s.version = "0.2.1"
+  s.version = "0.3.0"
   s.platform = Gem::Platform::RUBY
   s.authors = "Sean Caffery"
   s.email = "sean@lineonpoint.com"
-  s.summary = "Analysis tool for Cucumber features"
-  s.homepage = "https://github.com/seancaffery/step-down"
-  s.description = "Step down allows you to see where your most used Cucumber steps are, and will help in refactoring"
+  s.summary = "Static analysis tool for Cucumber features"
+  s.homepage = "http://stepdown.lineonpoint.com"
+  s.description = "Stepdown allows you to see where your most used Cucumber steps are, your unused steps and how they are clustered"
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project = "stepdown"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stepdown
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sean Caffery
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-20 00:00:00 +11:00
+date: 2011-02-27 00:00:00 +11:00
 default_executable: stepdown
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,7 +50,7 @@ dependencies:
         version: 2.0.0
   type: :development
   version_requirements: *id002
-description: Step down allows you to see where your most used Cucumber steps are, and will help in refactoring
+description: Stepdown allows you to see where your most used Cucumber steps are, your unused steps and how they are clustered
 email: sean@lineonpoint.com
 executables: 
 - stepdown
@@ -69,20 +69,23 @@ files:
 - lib/feature_parser.rb
 - lib/html_reporter.rb
 - lib/options.rb
+- lib/reporter.rb
 - lib/scenario.rb
 - lib/step.rb
 - lib/step_down.rb
 - lib/step_group.rb
 - lib/step_instance.rb
 - lib/step_usage.rb
+- lib/text_reporter.rb
 - public/jquery-1.4.3.min.js
 - public/step_down.js
 - spec/lib/step_group_spec.rb
+- spec/lib/step_instance_spec.rb
 - stepdown.gemspec
 - templates/main.html.haml
 - templates/style.sass
 has_rdoc: true
-homepage: https://github.com/seancaffery/step-down
+homepage: http://stepdown.lineonpoint.com
 licenses: []
 
 post_install_message: 
@@ -116,6 +119,6 @@ rubyforge_project: stepdown
 rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: Analysis tool for Cucumber features
+summary: Static analysis tool for Cucumber features
 test_files: []