stepdown 0.4.0 → 0.5.0

data/.gitignore

@@ -5,3 +5,4 @@
 *.rbc
 *.gem
 .rvmrc
+*.swp

data/Gemfile

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

data/Gemfile.lock

@@ -2,24 +2,27 @@ GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.2)
-    haml (2.0.10)
+    gherkin (2.3.8)
+      json (>= 1.4.6)
+    haml (3.1.1)
+    json (1.4.6)
     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)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.0)
+    rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
+    rspec-mocks (2.6.0)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
+  gherkin (~> 2.3)
   haml (> 2.0.0)
   rake
   rcov (~> 0.9.9)
-  rspec (~> 2.5.0)
+  rspec (~> 2.5)

data/History.txt

@@ -1,3 +1,9 @@
+== 0.50 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

data/bin/stepdown

@@ -2,8 +2,8 @@
 lib = File.expand_path('../lib/', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
-require 'stepdown'
 require 'stepdown/options'
+require 'stepdown'
 
 begin
 
@@ -11,6 +11,8 @@ begin
   options.parse(ARGV)
   options.validate
 
+  Stepdown.quiet = options.quiet
+
   Stepdown::Analyzer.new(options.steps_dir, options.features_dir, options.reporter).analyse
 
 rescue Interrupt => e

data/lib/stepdown.rb

@@ -2,5 +2,13 @@ require 'stepdown/feature_parser'
 require 'stepdown/step_instance'
 require 'stepdown/html_reporter'
 require 'stepdown/text_reporter'
-
 require 'stepdown/analyzer'
+
+require 'rubygems'
+require 'bundler/setup'
+
+module Stepdown
+  class << self
+    attr_accessor :quiet
+  end
+end

data/lib/stepdown/analyzer.rb

@@ -1,4 +1,4 @@
-
+require 'gherkin/parser/parser'
 
 module Stepdown
   class Analyzer
@@ -9,10 +9,10 @@ module Stepdown
     end
 
     def analyse
-      puts "Parsing feature files..."
+      puts "Parsing feature files..." unless Stepdown.quiet
       scenarios = process_feature_files(feature_files)
 
-      puts "Performing analysis..."
+      puts "Performing analysis..." unless Stepdown.quiet
 
       reporter = reporter(@reporter, scenarios, instance.step_collection)
       reporter.output_overview
@@ -20,13 +20,14 @@ module Stepdown
     end
 
     def process_feature_files(feature_files)
-      parser = Stepdown::FeatureParser.new
+      listener = Stepdown::FeatureParser.new(instance)
+
+      parser = Gherkin::Parser::Parser.new(listener, true, 'root')
 
-      scenarios = []
       feature_files.each do |feature_file|
-        scenarios << parser.process_feature(feature_file, instance)
+        parser.parse(File.read(feature_file), feature_file, 0)
       end
-      scenarios.flatten
+      listener.scenarios
     end
 
     def reporter(type, scenarios, step_collection)
@@ -35,6 +36,8 @@ module Stepdown
           Stepdown::HTMLReporter.new(scenarios, step_collection)
         when "text"
           Stepdown::TextReporter.new(scenarios, step_collection)
+        when "quiet"
+          Stepdown::Reporter.new(scenarios, step_collection)
       end
     end
 
@@ -64,4 +67,4 @@ module Stepdown
       @step_files = Dir.glob(@steps_dir + '/**/*.rb')
     end
   end
-end
+end

data/lib/stepdown/feature_parser.rb

@@ -3,28 +3,58 @@ 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
+    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
 
-      scenarios
+    def step(step)
+      matched_step = @instance.line_matches(step.name)
+      @current_scenario.add_step(matched_step) if matched_step
     end
 
-    protected
-    def read_feature_file(file_name)
-      File.read(file_name).split("\n")
+    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/html_reporter.rb

@@ -7,7 +7,7 @@ module Stepdown
   class HTMLReporter < Reporter
 
     def output_overview()
-      puts "Generating report..."
+      puts "Generating report..." unless Stepdown.quiet
       FileUtils.mkdir_p(Reporter::OUTPUT_DIR)
       copy_files
 
@@ -26,7 +26,7 @@ module Stepdown
 
       out.close
 
-      $stdout.puts "\nReport output to #{Reporter::OUTPUT_DIR}/analysis.html"
+      puts "\nReport output to #{Reporter::OUTPUT_DIR}/analysis.html" unless Stepdown.quiet
     end
 
     protected

data/lib/stepdown/options.rb

@@ -2,14 +2,15 @@ require 'optparse'
 
 module Stepdown
   class Options
-    attr_reader :steps_dir, :features_dir, :reporter
+    attr_reader :steps_dir, :features_dir, :reporter, :quiet
 
-    OUTPUT_FORMATS = ["html", "text"]
+    OUTPUT_FORMATS = ["html", "text", "quiet"]
 
     def parse(params)
       @steps_dir = "features/step_definitions"
       @features_dir = "features"
       @reporter = "html"
+      @quiet = false
       parser = OptionParser.new do |opts|
         opts.banner = "Usage: stepdown step_definition_dir feature_file_directory"
 
@@ -27,6 +28,10 @@ module Stepdown
           @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

data/lib/stepdown/reporter.rb

@@ -83,6 +83,10 @@ module Stepdown
       step_usages.select{|use| use.total_usage == 0}
     end
 
+    def unused_step_count
+      unused_steps.length
+    end
+
     def uniq_steps_per_scenario(scenarios)
       total_steps = 0.0
       uniq_steps = 0.0
@@ -101,6 +105,13 @@ module Stepdown
       end
       sprintf "%.2f", (step_count / scen_count)
     end
+
+    def empty_scenarios
+      @scenarios.select do |scen|
+        scen.steps.empty?
+      end
+    end
+
   end
 end
 

data/lib/stepdown/scenario.rb

@@ -2,10 +2,11 @@ require 'stepdown/step_collection'
 
 module Stepdown
   class Scenario
-    attr_reader :step_count
-    def initialize
+    attr_reader :step_count, :name
+    def initialize(name)
       @step_collection = Stepdown::StepCollection.new
       @step_count = 0
+      @name = name
     end
 
     def add_step(step)

data/lib/stepdown/step_instance.rb

@@ -39,10 +39,10 @@ module Stepdown
     end
 
     def line_matches(line)
-      stripped_line = line.strip.gsub(/^(And|Given|When|Then) (.*)$/,'\2')
+      #stripped_line = line.strip.gsub(/^(And|Given|When|Then) (.*)$/,'\2')
 
       @steps.each_with_index do |regex,i|
-        match = regex.match(stripped_line)
+        match = regex.match(line)
         if match
           return step_collection.detect{|step| i == step.id}
         end

data/lib/stepdown/text_reporter.rb

@@ -4,11 +4,12 @@ module Stepdown
   class TextReporter < Reporter
 
     def output_overview
-      puts "Generating report..."
+      puts "Generating report..." unless Stepdown.quiet
       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 "Unused steps: #{unused_step_count}"
       output.puts "Steps per scenario: #{steps_per_scenario}"
       output.puts "Unique steps per scenario: #{unique_steps}"
 
@@ -21,7 +22,7 @@ module Stepdown
 
       output.close
 
-      puts "Report output to #{Reporter::OUTPUT_DIR}/analysis.txt"
+      puts "Report output to #{Reporter::OUTPUT_DIR}/analysis.txt" unless Stepdown.quiet
 
     end
 

data/spec/lib/stepdown/analyzer_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'analyzer'
+require 'reporter'
+require 'html_reporter'
+require 'text_reporter'
+
+describe Stepdown::Analyzer do
+
+  describe "selecting a reporter" do
+
+    it "should return an HTML reporter" do
+      analyzer = Stepdown::Analyzer.new('', '', 'html')
+      reporter = analyzer.reporter('html',[],mock('step_collection'))
+      reporter.should be_instance_of(Stepdown::HTMLReporter)
+    end
+
+    it "should return a text reporter" do
+      analyzer = Stepdown::Analyzer.new('', '', 'text')
+      reporter = analyzer.reporter('text',[],mock('step_collection'))
+      reporter.should be_instance_of(Stepdown::TextReporter)
+    end
+
+    it "should return a quiet reporter" do
+      analyzer = Stepdown::Analyzer.new('', '', 'quiet')
+      reporter = analyzer.reporter('quiet',[],mock('step_collection'))
+      reporter.should be_instance_of(Stepdown::Reporter)
+    end
+
+  end
+
+end
+

data/spec/lib/stepdown/feature_parser_spec.rb

@@ -9,45 +9,49 @@ describe Stepdown::FeatureParser do
 
   describe "creating scenarios" do
     before :each do
+      instance = mock("instance")
+      @parser = Stepdown::FeatureParser.new(instance)
     end
-    it "should create a scenario for a scenario line" do
 
-      file = mock("file")
-      instance = mock("instance")
-      file_lines = ["Scenario: My testing scenario"]
+    it "should create a scenario for a scenario line" do
 
-      @parser = Stepdown::FeatureParser.new
-      @parser.should_receive(:read_feature_file).with(file).and_return(file_lines)
-      scenario = mock("scenario")
+      scenario = mock("scenario", :name => 'scenario')
       Stepdown::Scenario.should_receive(:new).and_return(scenario)
-      
-      @parser.process_feature(file, instance).should =~ [scenario]
+      @parser.scenario(scenario)
+
+      @parser.scenarios.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 = Stepdown::FeatureParser.new
-      @parser.should_receive(:read_feature_file).with(file).and_return(file_lines)
-      scenario = mock("scenario")
-      Stepdown::Scenario.should_receive(:new).and_return(scenario)
-      
-      @parser.process_feature(file, instance).should =~ [scenario]
+      background = mock("background", :name => '')
+      Stepdown::Scenario.should_receive(:new).and_return(background)
+      @parser.background(background)
+
+      @parser.scenarios.should =~ [background]
+    end
+
+    it "should create a scenario for a scenario outline" do
+
+      outline = mock("outline", :name => 'outline')
+      Stepdown::Scenario.should_receive(:new).and_return(outline)
+      @parser.scenario_outline(outline)
+
+      @parser.scenarios.should =~ [outline]
     end
   end
 
 
   describe "parsing step lines" do
     before :each do 
-      @parser = Stepdown::FeatureParser.new
       @step_instance = mock("step_instance")
+      @parser = Stepdown::FeatureParser.new(@step_instance)
+      @parser.scenario(mock('scenario', :name => 'scenario'))
 
     end
 
     it "should not add unmatched steps" do
-      lines = ["Scenario", "matched", "match 2"]
+      lines = ["matched", "match 2"]
       unmatched_lines = ["not matched", "not matched 2"]
       steps = []
       lines.each_with_index do |line, i|
@@ -61,23 +65,26 @@ describe Stepdown::FeatureParser do
       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)
+      all_lines.each do |line|
+        @parser.step(mock('step', :name => line))
+      end
+
+      scenarios = @parser.scenarios
       scenarios.first.steps.collect{|s| s.regex }.should =~ ["matched", "match 2"]
     end
 
     it "should add matched steps" do
-      lines = ["Scenario", "matched", "match 2"]
+      lines = ["matched", "match 2"]
       steps = []
       lines.each_with_index do |line, i|
         step = Stepdown::Step.new(i, line)
         stub_line_match_with(@step_instance, line, step)
+        @parser.step(mock('step', :name => line))
         steps << step
       end
-      @parser.should_receive(:read_feature_file).and_return(lines)
 
-      scenarios = @parser.process_feature(mock('file'), @step_instance)
+      scenarios = @parser.scenarios
       scenarios.first.steps.collect{|s| s.regex }.should =~ ["matched", "match 2"]
 
     end

data/spec/lib/stepdown/options_spec.rb

@@ -87,6 +87,11 @@ describe Stepdown::Options do
         @io.string.should == "Directory features_dir does not exist"
       end.should raise_error(SystemExit)
     end
+
+    it "should allow output to be supressed" do
+      @options.parse(["-q"])
+      @options.quiet.should == true
+    end
   end
 
 end

data/spec/lib/stepdown/reporter_spec.rb

@@ -41,8 +41,8 @@ describe Stepdown::Reporter do
   #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
+      @scen_1 = Stepdown::Scenario.new('scenario')
+      @scen_2 = Stepdown::Scenario.new('scenario')
       @scenarios = [@scen_1, @scen_2]
 
       @collection = Stepdown::StepCollection.new
@@ -100,8 +100,8 @@ describe Stepdown::Reporter do
   #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
+      @scen_1 = Stepdown::Scenario.new('scenario')
+      @scen_2 = Stepdown::Scenario.new('scenario')
       @scenarios = [@scen_1, @scen_2]
 
       @collection = Stepdown::StepCollection.new
@@ -172,13 +172,41 @@ describe Stepdown::Reporter do
       @reporter.stub!(:step_usages).and_return([@use_1, @use_2, @use_3])
     end
 
-    it "should return unused steps" do
+    it "should return used steps" do
       @reporter.usages.should =~ [@use_1, @use_2]
     end
 
-    it "should return used steps" do
+    it "should return unused steps" do
       @reporter.unused_steps.should =~ [@use_3]
     end
+
+    it "should return the number of unused steps" do
+      @reporter.unused_step_count.should == 1
+    end
+  end
+
+  describe "returning empty scenarios" do
+
+    it "should return scenarios with no steps" do
+      scen_1 = Stepdown::Scenario.new('scenario')
+      scen_2 = Stepdown::Scenario.new('scenario')
+
+      @reporter = Stepdown::Reporter.new([scen_1, scen_2], Stepdown::StepCollection.new)
+
+      @reporter.empty_scenarios().should == [scen_1,scen_2]
+    end
+
+    it "should not return scenarios with steps" do
+      scen_1 = Stepdown::Scenario.new('scenario')
+      scen_2 = Stepdown::Scenario.new('scenario')
+
+      scen_1.add_step(Stepdown::Step.new(1,/regex/))
+
+      @reporter = Stepdown::Reporter.new([scen_1, scen_2], Stepdown::StepCollection.new)
+
+      @reporter.empty_scenarios().should == [scen_2]
+    end
+
   end
 
 end

data/spec/lib/stepdown/scenario_spec.rb

@@ -5,7 +5,7 @@ require 'step'
 
 describe Stepdown::Scenario do
   before :each do
-    @scenario = Stepdown::Scenario.new
+    @scenario = Stepdown::Scenario.new('scenario')
     @s1 = Stepdown::Step.new(1, /step 1/)
     @s2 = Stepdown::Step.new(2, /Step 2/)
     @s2_dup = Stepdown::Step.new(2, /Step 2/)

data/stepdown.gemspec

@@ -1,7 +1,7 @@
 
 Gem::Specification.new do |s|
   s.name = "stepdown"
-  s.version = "0.4.0"
+  s.version = "0.5.0"
   s.platform = Gem::Platform::RUBY
   s.required_ruby_version = '>= 1.8.7'
   s.authors = "Sean Caffery"
@@ -13,8 +13,9 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project = "stepdown"
 
-  s.add_dependency('haml', '> 2.0.0')
-  s.add_development_dependency('rspec', "~> 2.5.0")
+  s.add_dependency('haml', '> 2.0')
+  s.add_dependency('gherkin', '~> 2.3')
+  s.add_development_dependency('rspec', "~> 2.5")
   s.add_development_dependency('rake')
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files spec/*`.split("\n")

data/templates/main.html.haml

@@ -18,6 +18,8 @@
             %a{:href => '#usage'} Step usage
           %li
             %a{:href => '#unused'} Unused steps
+          %li
+            %a{:href => '#empty'} Empty scenarios
           %li
             %a{:href => '#grouping'} Step grouping
       #content
@@ -34,6 +36,9 @@
             %tr
               %td Total number of steps
               %td= total_steps
+            %tr
+              %td Unused stepss
+              %td= unused_step_count
             %tr
               %td Steps per scenario
               %td= steps_per_scenario
@@ -90,6 +95,15 @@
           - unused_steps.each do |use|
             %tr
               %td= use.step.regex.inspect
+        %h2
+          %a{:name => 'empty'} Empty scenarios
+        %table
+          %tbody
+            %th Scenarios
+
+          - empty_scenarios.each do |scen|
+            %tr
+              %td= scen.name  
         %h2
           %a{:name => 'grouping'} Step grouping
         %table

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stepdown
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Sean Caffery
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-29 00:00:00 +11:00
+date: 2011-05-17 00:00:00 +10:00
 default_executable: stepdown
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,34 +26,47 @@ dependencies:
     requirements: 
     - - ">"
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 3
         segments: 
         - 2
         - 0
-        - 0
-        version: 2.0.0
+        version: "2.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: gherkin
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
         segments: 
         - 2
         - 5
-        - 0
-        version: 2.5.0
+        version: "2.5"
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -63,7 +76,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 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
@@ -97,6 +110,7 @@ files:
 - lib/stepdown/text_reporter.rb
 - public/jquery-1.4.3.min.js
 - public/step_down.js
+- spec/lib/stepdown/analyzer_spec.rb
 - spec/lib/stepdown/feature_parser_spec.rb
 - spec/lib/stepdown/options_spec.rb
 - spec/lib/stepdown/reporter_spec.rb
@@ -142,11 +156,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: stepdown
-rubygems_version: 1.5.3
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Static analysis tool for Cucumber features
 test_files: 
+- spec/lib/stepdown/analyzer_spec.rb
 - spec/lib/stepdown/feature_parser_spec.rb
 - spec/lib/stepdown/options_spec.rb
 - spec/lib/stepdown/reporter_spec.rb