stepdown 0.3.2 → 0.3.3

data/bin/stepdown

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

data/lib/feature_parser.rb

@@ -8,21 +8,25 @@ class FeatureParser
 
   def process_feature(file, instance)
     @scenarios = []
+    file_lines = read_feature_file(file)
 
-    File.read(file).split("\n").each_with_index do |line,line_no|
-      @line_no = line_no
+    file_lines.each do |line|
 
       if line =~ /Scenario|Background/
         @scenario = Scenario.new
         @scenarios << @scenario
       else
-        step_id = instance.line_matches(line,line_no,file)
-        @scenario.add_step(step_id) if step_id
+        step = instance.line_matches(line)
+        @scenario.add_step(step) if step
       end
     end
 
     return @scenarios
   end
 
+protected
+  def read_feature_file(file_name)
+    File.read(file_name).split("\n")
+  end
 end
 

data/lib/options.rb

@@ -4,7 +4,7 @@ class Options
 
   OUTPUT_FORMATS = ["html", "text"]
 
-  def self.parse(params)
+  def parse(params)
     @@steps_dir = "features/step_definitions"
     @@features_dir = "features"
     @@reporter = "html"
@@ -41,7 +41,7 @@ class Options
     end
   end
 
-  def self.validate
+  def validate
     @@steps_dir = File.join(Dir.pwd, @@steps_dir)
     @@features_dir = File.join(Dir.pwd, @@features_dir)
 
@@ -54,15 +54,15 @@ class Options
 
   end
 
-  def self.steps_dir
+  def steps_dir
     @@steps_dir
   end
 
-  def self.features_dir
+  def features_dir
     @@features_dir
   end
 
-  def self.reporter
+  def reporter
     @@reporter
   end
 

data/lib/reporter.rb

@@ -46,7 +46,7 @@ class Reporter
       total_steps += scen.steps.length
       uniq_steps += scen.uniq_steps.length
     end
-    total_steps / uniq_steps
+    sprintf "%.2f", (total_steps / uniq_steps)
   end
 
   def steps_scenario(scenarios)
@@ -55,7 +55,7 @@ class Reporter
     scenarios.each do |scenario|
       step_count += scenario.steps.length
     end
-    step_count / scen_count
+    sprintf "%.2f", (step_count / scen_count)
   end
 
 end

data/lib/step_down.rb

@@ -67,7 +67,8 @@ class StepDown
 
     usages.each do |usage|
       if usage.number_scenarios > 0
-        usage.use_scenario = usage.total_usage / Float(usage.number_scenarios)
+        use = sprintf "%.2f", (usage.total_usage / Float(usage.number_scenarios))
+        usage.use_scenario = use
       end
     end
 

data/lib/step_group.rb

@@ -25,7 +25,6 @@ class StepGroup
 
   def update_use_count
     @total_usage = 0
-    #puts step[:in_steps].inspect
     @in_steps.each do |key,val|
       @total_usage += val.count
     end
@@ -50,4 +49,4 @@ class StepGroup
     base
   end
 
-end
+end

data/lib/step_instance.rb

@@ -19,19 +19,23 @@ class StepInstance
     @steps << regex
   end
 
+  def self.method_missing(*args)
+    #nothing
+  end
+
   def method_missing(*args)
     #nothing
   end
   
   def self.const_missing(*args)
-    #nothing
+    self
   end
 
   def require(*args)
     # do nothing
   end
 
-  def line_matches(line,line_no,file)
+  def line_matches(line)
     stripped_line = line.strip.gsub(/^(And|Given|When|Then) (.*)$/,'\2')
 
     @steps.each_with_index do |regex,i|

data/public/step_down.js

@@ -9,6 +9,11 @@ $(document).ready(function(){
   $("#scenario_filter").change(function(){
     filter(this.options[this.selectedIndex].value, 2, $("#usages tr"));
   });
+
+  $("a[class*=g]").click(function() {
+    $('.' + this.getAttribute("class")).show();
+    return false;
+  });
 });
 
 

data/spec/lib/feature_parser_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/scenario')
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/feature_parser')
+
+describe FeatureParser do
+  def stub_line_match_with(instance, line, value)
+    instance.stub!(:line_matches).with(line).and_return(value)
+  end
+
+  describe "creating scenarios" do
+    before :each do
+    end
+    it "should create a scenario for a scenario line" do
+
+      file = mock("file")
+      instance = mock("instance")
+      file_lines = ["Scenario: My testing scenario"]
+
+      @parser = FeatureParser.new
+      @parser.should_receive(:read_feature_file).with(file).and_return(file_lines)
+      scenario = mock("scenario")
+      Scenario.should_receive(:new).and_return(scenario)
+      
+      @parser.process_feature(file, instance).should =~ [scenario]
+    end
+ 
+    it "should create a scenario for a background line" do
+      file = mock("file")
+      instance = mock("instance")
+      file_lines = ["Background: My testing scenario"]
+
+      @parser = FeatureParser.new
+      @parser.should_receive(:read_feature_file).with(file).and_return(file_lines)
+      scenario = mock("scenario")
+      Scenario.should_receive(:new).and_return(scenario)
+      
+      @parser.process_feature(file, instance).should =~ [scenario]
+    end
+  end
+
+
+  describe "parsing step lines" do
+    before :each do 
+      @parser = FeatureParser.new
+      @step_instance = mock("step_instance")
+
+    end
+
+    it "should not add unmatched steps" do
+      lines = ["Scenario", "matched", "match 2"]
+      unmatched_lines = ["not matched", "not matched 2"]
+      steps = []
+      lines.each_with_index do |line, i|
+        step = Step.new(i, line)
+        stub_line_match_with(@step_instance, line, step)
+        steps << step
+      end
+      
+      unmatched_lines.each do |line|
+        stub_line_match_with(@step_instance, line, nil)
+      end
+
+      all_lines = [lines, unmatched_lines].flatten
+      @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]
+    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)
+        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]
+
+    end
+
+  end
+end

data/spec/lib/options_spec.rb

@@ -1,66 +1,67 @@
 require 'rspec'
 require File.expand_path(File.dirname(__FILE__) + '/../../lib/options')
 
-describe Options do
+describe @options do
 
   before :each do
+    @options = Options.new
   end
 
   describe "setting input directories" do
     it "should allow setting only steps directory" do
-      Options.parse(["--steps=step_dir"])
+      @options.parse(["--steps=step_dir"])
 
-      Options.steps_dir.should == "step_dir"
-      Options.features_dir.should == "features"
+      @options.steps_dir.should == "step_dir"
+      @options.features_dir.should == "features"
 
     end
 
     it "should allow setting only features directory" do
-      Options.parse(["--features=features_dir"])
+      @options.parse(["--features=features_dir"])
 
-      Options.steps_dir.should == "features/step_definitions"
-      Options.features_dir.should == "features_dir"
+      @options.steps_dir.should == "features/step_definitions"
+      @options.features_dir.should == "features_dir"
     end
 
     it "should allow setting features and settings directory" do
-      Options.parse(["--features=features_dir", "--steps=steps_dir"])
+      @options.parse(["--features=features_dir", "--steps=steps_dir"])
 
-      Options.steps_dir.should == "steps_dir"
-      Options.features_dir.should == "features_dir"
+      @options.steps_dir.should == "steps_dir"
+      @options.features_dir.should == "features_dir"
     end
   end
 
   describe "selecting reporter" do
     it "should select html by default" do
-      Options.parse([])
+      @options.parse([])
 
-      Options.reporter.should == "html"
+      @options.reporter.should == "html"
     end
 
     it "should allow selecting html" do
-      Options.parse(["--output=html"])
+      @options.parse(["--output=html"])
 
-      Options.reporter.should == "html"
+      @options.reporter.should == "html"
     end
 
     it "should allow selecting text" do
-      Options.parse(["--output=text"])
+      @options.parse(["--output=text"])
 
-      Options.reporter.should == "text"
+      @options.reporter.should == "text"
     end
   end
 
   describe "using default directories" do
     it "should select relative step directory" do
-      Options.parse([])
+      @options.parse([])
 
-      Options.steps_dir == "features/step_definitions"
+      @options.steps_dir == "features/step_definitions"
     end
 
     it "should select relative feature directory" do
-      Options.parse([])
+      @options.parse([])
 
-      Options.features_dir.should == "features"
+      @options.features_dir.should == "features"
     end
   end
 

data/spec/lib/scenario_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/scenario')
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/step')
+
+
+describe Scenario do
+  before :each do
+    @scenario = Scenario.new
+    @s1 = Step.new(1, /step 1/)
+    @s2 = Step.new(2, /Step 2/)
+    @s2_dup = Step.new(2, /Step 2/)
+    @s3 = Step.new(3, /Step 3/)
+
+  end
+
+  describe "adding steps" do
+    it "should add steps to cache" do
+      @scenario.add_step(@s1)
+      @scenario.add_step(@s2)
+      @scenario.add_step(@s2_dup)
+      @scenario.add_step(@s3)
+
+      steps = [@s1, @s2, @s2_dup, @s3]
+      @scenario.steps.should =~ steps
+    end
+
+  end
+
+  describe "returning unique steps" do 
+    it "should only return one instance of each step" do
+      @scenario.add_step(@s1)
+      @scenario.add_step(@s2)
+      @scenario.add_step(@s2_dup)
+      @scenario.add_step(@s3)
+
+      steps = [@s1, @s2, @s3]
+      @scenario.uniq_steps.should =~ steps
+    end
+
+  end
+
+end
+

data/spec/lib/step_instance_spec.rb

@@ -1,5 +1,6 @@
 require 'rspec'
 require File.expand_path(File.dirname(__FILE__) + '/../../lib/step_instance')
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/step')
 
 
 describe StepInstance do
@@ -10,17 +11,74 @@ describe StepInstance do
 
   it "should deal with missing constants" do
     lambda{ @step_instance.instance_eval("MissingConst") }.should_not raise_error
+    lambda{ @step_instance.instance_eval("MissingConst::MissingClass") }.should_not raise_error
+    lambda{ @step_instance.instance_eval("MissingConst::MissingClass.missing_method") }.should_not raise_error
   end
+
   it "should deal with missing methods" do
      lambda{ @step_instance.doesnt_exist }.should_not raise_error
+     lambda{ StepInstance.doesnt_exist }.should_not raise_error
   end
 
-  describe "steps" do
+  describe "returning steps" do
+    it "should return parsed steps" do
+      @step_instance.Given(/given/)
+      @step_instance.When(/when/)
+      @step_instance.Then(/then/)
+
+      @step_instance.steps.length.should == 3
+    end
 
   end
 
-  describe "line matches" do
+  describe "returning matched steps" do
+    it "should return nil when no matching step found" do
+      @step_instance.Given(/some step/)
+      @step_instance.line_matches("Given some other step").should be_nil
+    end
+
+    it "should parse And steps" do
+      @step_instance.Given(/matched step/)
+      @step_instance.line_matches("And matched step").regex.should == /matched step/
+    end
+
+    it "should parse Given steps" do
+      @step_instance.Given(/matched step/)
+      @step_instance.line_matches("Given matched step").regex.should == /matched step/
+    end
+
+    it "should parse When steps" do
+      @step_instance.When(/matched step/)
+      @step_instance.line_matches("When matched step").regex.should == /matched step/
+    end
+
+    it "should parse Then steps" do
+      @step_instance.Then(/matched step/)
+      @step_instance.line_matches("Then matched step").regex.should == /matched step/
+    end
 
   end
+  
+  describe "parsing step definitions" do
+    before :each do
+      @regex = /reg/
+      @step = mock('step')
+      Step.should_receive(:new).with(0, @regex).and_return(@step)
+    end
+
+    it "should define given steps" do
+      @step_instance.Given(@regex)
+      @step_instance.steps.should =~ [@step]
+    end
 
+    it "should define when steps" do
+      @step_instance.When(@regex)
+      @step_instance.steps.should =~ [@step]
+    end
+
+    it "should define then steps" do
+      @step_instance.Then(@regex)
+      @step_instance.steps.should =~ [@step]
+    end
+  end
 end

data/stepdown.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |s|
   s.name = "stepdown"
-  s.version = "0.3.2"
+  s.version = "0.3.3"
   s.platform = Gem::Platform::RUBY
   s.authors = "Sean Caffery"
   s.email = "sean@lineonpoint.com"

data/templates/main.html.haml

@@ -96,14 +96,23 @@
           %tbody
             %th Step
             %th Total step associations
-            %th
 
-          - groupings.each do |grouping|
+          - groupings.each_with_index do |grouping, i|
+            - next if grouping.use_count == 0
             %tr
-              %td= grouping.regex.inspect
+              %td
+                = grouping.regex.inspect
+                %br
+                %a{:href => '#', :class => "g#{i}"}Show associated steps
               %td= grouping.use_count
-            %tr
+            %tr{:class => "g#{i}", :style => "display: none;"}
               %td{:colspan => 2}
-                - grouping.in_steps.each do |step|
-                  %br
-                    = CGI.escapeHTML step.inspect
+                %table
+                  %tr
+                    %th Association count
+                    %th Step
+                  %tbody
+                    - grouping.in_steps.each do |step|
+                      %tr
+                        %td= step[1].count
+                        %td= CGI.escapeHTML step[1].regex.inspect

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stepdown
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Sean Caffery
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-28 00:00:00 +11:00
+date: 2011-03-06 00:00:00 +11:00
 default_executable: stepdown
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,7 +79,9 @@ files:
 - lib/text_reporter.rb
 - public/jquery-1.4.3.min.js
 - public/step_down.js
+- spec/lib/feature_parser_spec.rb
 - spec/lib/options_spec.rb
+- spec/lib/scenario_spec.rb
 - spec/lib/step_group_spec.rb
 - spec/lib/step_instance_spec.rb
 - stepdown.gemspec