stepdown 0.3.3 → 0.4.0

data/lib/stepdown/step.rb

@@ -0,0 +1,22 @@
+module Stepdown
+  class Step
+
+    attr_accessor :count
+    attr_reader :id, :regex
+
+    def initialize(id, regex)
+      @id = id
+      @regex = regex
+      @count = 0
+    end
+
+    def <=>(other)
+      other.count <=> self.count
+    end
+
+    def ==(other)
+      self.id == other.id
+    end
+
+  end
+end

data/lib/stepdown/step_collection.rb

@@ -0,0 +1,36 @@
+require 'stepdown/step'
+
+module Stepdown
+  class StepCollection
+    include Enumerable
+
+    def initialize
+      @steps = {}
+    end
+
+    def add_step(id, regex)
+      if @steps[id]
+        @steps[id].count += 1
+      else
+        @steps[id] = Stepdown::Step.new(id, regex)
+        @steps[id].count = 1
+      end
+    end
+
+    def steps
+      @steps.collect{|id,step| step }
+    end
+
+    def each
+      @steps.each{|id, step| yield step }
+    end
+
+    def [](id)
+      @steps[id]
+    end
+
+    def length
+      @steps.length
+    end
+  end
+end

data/lib/stepdown/step_group.rb

@@ -0,0 +1,45 @@
+require 'cgi'
+require 'stepdown/step_collection'
+
+module Stepdown
+  class StepGroup
+    attr_reader :id, :regex, :use_count
+
+    def initialize(step)
+      @id = step.id
+      @regex = step.regex
+      @use_count = 0
+      @step_collection = Stepdown::StepCollection.new
+    end
+
+    def step_collection
+      @step_collection.sort
+    end
+
+    def add_step(step)
+      @step_collection.add_step(step.id, step.regex)
+    end
+
+    def add_steps(step_set)
+      step_set.each{|step| add_step(step)}
+    end
+
+    def update_use_count(num_steps)
+      @use_count += num_steps
+    end
+
+    def group_graph
+      base = "https://chart.googleapis.com/chart?cht=gv:dot&chl=graph{"
+      base += "a [label=\"#{CGI.escape(CGI.escapeHTML(@regex.inspect.to_s))}\"];"
+
+      step_collection[0..10].each do |step|
+
+        next if step.regex.nil?
+        base += "a--\"#{CGI.escape(CGI.escapeHTML(step.regex.inspect.to_s))}\" [weight=#{step.count}];"
+        #a [label=\"#{grouping.in_steps[0][:step].regex.inspect}\"]; a--b [penwidth=3,weight=2];b--d}"
+      end
+      base += "}"
+      base
+    end
+  end
+end

data/lib/stepdown/step_instance.rb

@@ -0,0 +1,63 @@
+require 'stepdown/step_collection'
+
+module Stepdown
+  class StepInstance
+    def initialize
+      @steps = []
+    end
+
+    def Given(regex,&block)
+      define_step(regex,&block)
+    end
+
+    def When(regex,&block)
+      define_step(regex,&block)
+    end
+
+    def Then(regex,&block)
+      define_step(regex,&block)
+    end
+
+    def define_step(regex,&block)
+      @steps << regex
+    end
+
+    def self.method_missing(*args)
+      #nothing
+    end
+
+    def method_missing(*args)
+      #nothing
+    end
+
+    def self.const_missing(*args)
+      self
+    end
+
+    def require(*args)
+      # do nothing
+    end
+
+    def line_matches(line)
+      stripped_line = line.strip.gsub(/^(And|Given|When|Then) (.*)$/,'\2')
+
+      @steps.each_with_index do |regex,i|
+        match = regex.match(stripped_line)
+        if match
+          return step_collection.detect{|step| i == step.id}
+        end
+      end
+
+      return nil
+    end
+
+    def step_collection
+      return @step_collection if @step_collection
+      @step_collection = StepCollection.new
+      @steps.each_with_index do |regex, i|
+        @step_collection.add_step(i, regex)
+      end
+      @step_collection
+    end
+  end
+end

data/lib/stepdown/step_usage.rb

@@ -0,0 +1,15 @@
+
+module Stepdown
+  class StepUsage
+
+    attr_accessor :total_usage, :number_scenarios, :use_scenario
+    attr_reader :step
+
+    def initialize(step)
+      @step = step
+      @total_usage = 0
+      @number_scenarios = 0
+      @use_scenario = 0.0
+    end
+  end
+end

data/lib/stepdown/text_reporter.rb

@@ -0,0 +1,38 @@
+require 'stepdown/reporter'
+
+module Stepdown
+  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"
+      output.puts "Step|Total usage|Scenarios|Use per scenario"
+      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.inspect
+    end
+
+  end
+end

data/spec/lib/{feature_parser_spec.rb → stepdown/feature_parser_spec.rb}

@@ -1,7 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/scenario')
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/feature_parser')
+require 'spec_helper'
+require 'scenario'
+require 'feature_parser'
 
-describe FeatureParser do
+describe Stepdown::FeatureParser do
   def stub_line_match_with(instance, line, value)
     instance.stub!(:line_matches).with(line).and_return(value)
   end
@@ -15,10 +16,10 @@ describe FeatureParser do
       instance = mock("instance")
       file_lines = ["Scenario: My testing scenario"]
 
-      @parser = FeatureParser.new
+      @parser = Stepdown::FeatureParser.new
       @parser.should_receive(:read_feature_file).with(file).and_return(file_lines)
       scenario = mock("scenario")
-      Scenario.should_receive(:new).and_return(scenario)
+      Stepdown::Scenario.should_receive(:new).and_return(scenario)
       
       @parser.process_feature(file, instance).should =~ [scenario]
     end
@@ -28,10 +29,10 @@ describe FeatureParser do
       instance = mock("instance")
       file_lines = ["Background: My testing scenario"]
 
-      @parser = FeatureParser.new
+      @parser = Stepdown::FeatureParser.new
       @parser.should_receive(:read_feature_file).with(file).and_return(file_lines)
       scenario = mock("scenario")
-      Scenario.should_receive(:new).and_return(scenario)
+      Stepdown::Scenario.should_receive(:new).and_return(scenario)
       
       @parser.process_feature(file, instance).should =~ [scenario]
     end
@@ -40,7 +41,7 @@ describe FeatureParser do
 
   describe "parsing step lines" do
     before :each do 
-      @parser = FeatureParser.new
+      @parser = Stepdown::FeatureParser.new
       @step_instance = mock("step_instance")
 
     end
@@ -50,7 +51,7 @@ describe FeatureParser do
       unmatched_lines = ["not matched", "not matched 2"]
       steps = []
       lines.each_with_index do |line, i|
-        step = Step.new(i, line)
+        step = Stepdown::Step.new(i, line)
         stub_line_match_with(@step_instance, line, step)
         steps << step
       end
@@ -63,21 +64,21 @@ describe FeatureParser do
       @parser.should_receive(:read_feature_file).and_return(all_lines)
 
       scenarios = @parser.process_feature(mock('file'), @step_instance)
-      scenarios.first.steps.should =~ steps[1..2]
+      scenarios.first.steps.collect{|s| s.regex }.should =~ ["matched", "match 2"]
     end
 
     it "should add matched steps" do
       lines = ["Scenario", "matched", "match 2"]
       steps = []
       lines.each_with_index do |line, i|
-        step = Step.new(i, line)
+        step = Stepdown::Step.new(i, line)
         stub_line_match_with(@step_instance, line, step)
         steps << step
       end
       @parser.should_receive(:read_feature_file).and_return(lines)
 
       scenarios = @parser.process_feature(mock('file'), @step_instance)
-      scenarios.first.steps.should =~ steps[1..2]
+      scenarios.first.steps.collect{|s| s.regex }.should =~ ["matched", "match 2"]
 
     end
 

data/spec/lib/{options_spec.rb → stepdown/options_spec.rb}

@@ -1,10 +1,10 @@
-require 'rspec'
-require File.expand_path(File.dirname(__FILE__) + '/../../lib/options')
+require 'spec_helper'
+require 'options'
 
-describe @options do
+describe Stepdown::Options do
 
   before :each do
-    @options = Options.new
+    @options = Stepdown::Options.new
   end
 
   describe "setting input directories" do
@@ -66,9 +66,27 @@ describe @options do
   end
 
   describe "validating options" do
-    it "should report an invalid steps directory"
-    it "should report an invalid features directory"
+    require 'stringio'
+    before :each do
+      Dir.stub!(:pwd).and_return("")
+      @io = StringIO.new
+    end
+
+    it "should report an invalid steps directory" do
+      @options.parse(["--steps=steps_dir"])
+      lambda do
+        @options.validate(@io)
+        @io.string.should == "Directory steps_dir does not exist"
+      end.should raise_error(SystemExit)
+    end
 
+    it "should report an invalid features directory" do
+      @options.parse(["--features=features_dir"])
+      lambda do
+        @options.validate(@io)
+        @io.string.should == "Directory features_dir does not exist"
+      end.should raise_error(SystemExit)
+    end
   end
 
 end

data/spec/lib/stepdown/reporter_spec.rb

@@ -0,0 +1,184 @@
+require 'stepdown/step_group'
+require 'stepdown/step_usage'
+require 'stepdown/reporter'
+require 'stepdown/scenario'
+
+describe Stepdown::Reporter do
+
+  describe "returning overall statistics" do
+    it "should return the total number of steps" do
+      steps = [mock('step_1'), mock('step_2')]
+      reporter = Stepdown::Reporter.new([], steps)
+      reporter.total_steps.should == 2
+    end
+
+    it "should return the total number of scenarios" do
+      scenarios = [mock('scenario_1'), mock('scenario_2')]
+      reporter = Stepdown::Reporter.new(scenarios, [])
+      reporter.total_scenarios.should == 2
+    end
+
+    it "should return the number of steps per scenario" do
+      steps = [mock('step_1'), mock('step_2'), mock('step_3')]
+      scenario1 = mock("scenario1", :steps => steps, :step_count => steps.length)
+      scenario2 = mock("scenario2", :steps => [], :step_count => 0)
+
+      reporter = Stepdown::Reporter.new([scenario1, scenario2], [])
+      reporter.steps_per_scenario.should == "1.50"
+    end
+
+    it "should return the number of unique steps per scenario" do
+      steps = [mock('step_1'), mock('step_2'), mock('step_3')]
+      scenario1 = mock("scenario1", :steps => steps, :unique_step_count => 2, :step_count => 3)
+      scenario2 = mock("scenario2", :steps => steps[0...1], :unique_step_count => 1, :step_count => 1)
+
+      reporter = Stepdown::Reporter.new([scenario1, scenario2], [])
+      reporter.unique_steps.should == "1.33"
+    end
+
+  end
+
+  #this whole grouping thing needs to be refactored. Nasty.
+  describe "creating step groupings" do
+    before :each do
+      @scen_1 = Stepdown::Scenario.new
+      @scen_2 = Stepdown::Scenario.new
+      @scenarios = [@scen_1, @scen_2]
+
+      @collection = Stepdown::StepCollection.new
+      @s1 = Stepdown::Step.new(1, /step 1/)
+      @s2 = Stepdown::Step.new(2, /step 2/)
+      @s3 = Stepdown::Step.new(3, /step 3/)
+      @s4 = Stepdown::Step.new(4, /step 4/)
+      @s5 = Stepdown::Step.new(5, /step 5/)
+
+      @collection.add_step(@s1.id, @s1.regex)
+      @collection.add_step(@s2.id, @s2.regex)
+      @collection.add_step(@s3.id, @s3.regex)
+      @collection.add_step(@s4.id, @s4.regex)
+      @collection.add_step(@s5.id, @s5.regex)
+
+      @scen_1.add_step(@s1)
+      @scen_1.add_step(@s2)
+      @scen_1.add_step(@s3)
+      @scen_1.add_step(@s4)
+
+      @scen_2.add_step(@s1)
+      @scen_2.add_step(@s2)
+      @scen_2.add_step(@s1)
+      @scen_2.add_step(@s5)
+
+    end
+
+    it "should return the correct step grouping" do
+      reporter = Stepdown::Reporter.new([@scen_1, @scen_2], @collection)
+
+      reporter.groupings[0].step_collection.should =~ [@s1,@s2,@s3,@s4,@s5]
+      reporter.groupings[1].step_collection.should =~ [@s1,@s2,@s3,@s4,@s5]
+      reporter.groupings[2].step_collection.should =~ [@s1,@s2,@s5]
+      reporter.groupings[3].step_collection.should =~ [@s1,@s2,@s3,@s4]
+      reporter.groupings[4].step_collection.should =~ [@s1,@s2,@s3,@s4]
+
+    end
+
+    it "should return usage for steps across scenarios" do
+      reporter = Stepdown::Reporter.new([@scen_1, @scen_2], @collection)
+
+      group_1 = reporter.groupings.detect{|g| g.id == 1}
+      group_1.use_count.should == 8
+    end
+
+    it "should return usage for steps in scenarios with duplicated steps" do
+      reporter = Stepdown::Reporter.new([@scen_1, @scen_2], @collection)
+
+      group_5 = reporter.groupings.detect{|g| g.id == 5}
+      group_5.use_count.should == 4
+    end
+
+  end
+
+  #this usage thing needs to be refactored as well
+  describe "creating step usages" do
+    before :each do
+      @scen_1 = Stepdown::Scenario.new
+      @scen_2 = Stepdown::Scenario.new
+      @scenarios = [@scen_1, @scen_2]
+
+      @collection = Stepdown::StepCollection.new
+      @s1 = Stepdown::Step.new(1, /step 1/)
+      @s2 = Stepdown::Step.new(2, /step 2/)
+      @s3 = Stepdown::Step.new(3, /step 3/)
+      @s4 = Stepdown::Step.new(4, /step 4/)
+      @s5 = Stepdown::Step.new(5, /step 5/)
+
+      @collection.add_step(@s1.id, @s1.regex)
+      @collection.add_step(@s2.id, @s2.regex)
+      @collection.add_step(@s3.id, @s3.regex)
+      @collection.add_step(@s4.id, @s4.regex)
+      @collection.add_step(@s5.id, @s5.regex)
+
+      @scen_1.add_step(@s1)
+      @scen_1.add_step(@s2)
+      @scen_1.add_step(@s3)
+      @scen_1.add_step(@s4)
+
+      @scen_2.add_step(@s1)
+      @scen_2.add_step(@s2)
+      @scen_2.add_step(@s1)
+      @scen_2.add_step(@s5)
+      @scen_2.add_step(@s5)
+    end
+
+    it "should return the usage of across scenarios" do
+      reporter = Stepdown::Reporter.new([@scen_2, @scen_1], @collection)
+
+      usage = reporter.usages.detect{|use| use.step.id == 1}
+      usage.total_usage.should == 3
+      usage.number_scenarios.should == 2
+      usage.use_scenario.should == "1.50"
+      end
+
+    it "should return duplicate usage of a step in a scenario" do
+      reporter = Stepdown::Reporter.new([@scen_2, @scen_1], @collection)
+
+      usage = reporter.usages.detect{|use| use.step.id == 5}
+      usage.total_usage.should == 2
+      usage.number_scenarios.should == 1
+      usage.use_scenario.should == "2.00"
+    end
+
+    it "should return usage of a step in a scenario" do
+      reporter = Stepdown::Reporter.new([@scen_2, @scen_1], @collection)
+
+      usage = reporter.usages.detect{|use| use.step.id == 3}
+      usage.total_usage.should == 1
+      usage.number_scenarios.should == 1
+      usage.use_scenario.should == "1.00"
+    end
+
+  end
+
+  describe "returing step usage" do
+    before :each do
+      @reporter = Stepdown::Reporter.new([], mock('step_colllection'))
+
+      @use_1 = Stepdown::StepUsage.new(Stepdown::Step.new(1,/regex/))
+      @use_2 = Stepdown::StepUsage.new(Stepdown::Step.new(2,/regex/))
+      @use_3 = Stepdown::StepUsage.new(Stepdown::Step.new(3,/regex/))
+
+      @use_1.total_usage += 1
+      @use_2.total_usage += 1
+
+      @reporter.stub!(:step_usages).and_return([@use_1, @use_2, @use_3])
+    end
+
+    it "should return unused steps" do
+      @reporter.usages.should =~ [@use_1, @use_2]
+    end
+
+    it "should return used steps" do
+      @reporter.unused_steps.should =~ [@use_3]
+    end
+  end
+
+end