stepdown 0.3.3 → 0.4.0

data/lib/counting_step.rb

@@ -1,14 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/step')
-class CountingStep < Step
-  attr_accessor :count
-
-  def initialize(id, regex)
-    @count = 0
-    super(id, regex)
-  end
-
-  def <=>(step)
-    self.count <=> step.count
-  end
-
-end

data/lib/feature_parser.rb

@@ -1,32 +0,0 @@
-#!/usr/bin/ruby
-require 'rubygems'
-
-require File.expand_path(File.dirname(__FILE__) + '/step')
-require File.expand_path(File.dirname(__FILE__) + '/scenario')
-
-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
-
-    return @scenarios
-  end
-
-protected
-  def read_feature_file(file_name)
-    File.read(file_name).split("\n")
-  end
-end
-

data/lib/html_reporter.rb

@@ -1,37 +0,0 @@
-require 'fileutils'
-require 'reporter'
-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

data/lib/options.rb

@@ -1,69 +0,0 @@
-require 'optparse'
-
-class Options
-
-  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
-    @@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)
-        puts "Directory #{dir} does not exist"
-        exit 1
-      end
-    end
-
-  end
-
-  def steps_dir
-    @@steps_dir
-  end
-
-  def features_dir
-    @@features_dir
-  end
-
-  def reporter
-    @@reporter
-  end
-
-end

data/lib/reporter.rb

@@ -1,62 +0,0 @@
-
-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
-    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.steps.length
-    end
-    sprintf "%.2f", (step_count / scen_count)
-  end
-
-end
-

data/lib/scenario.rb

@@ -1,19 +0,0 @@
-class Scenario
-
-  def add_step(step)
-    steps << step
-  end
-
-  def steps
-    @steps ||= []
-  end
-
-  def uniq_steps
-    uniq_steps = []
-    steps.each do |step|
-      uniq_steps << step unless uniq_steps.any?{|uniq| uniq.id == step.id}
-    end
-    uniq_steps
-  end
-
-end

data/lib/step.rb

@@ -1,10 +0,0 @@
-class Step
-
-  attr_reader :id, :regex
-
-  def initialize(id, regex)
-    @id = id
-    @regex = regex
-  end
-
-end

data/lib/step_down.rb

@@ -1,112 +0,0 @@
-require 'feature_parser'
-require 'pp'
-require 'haml'
-require 'sass'
-
-require 'step_instance'
-require 'step_group'
-require 'step_usage'
-require 'html_reporter'
-require 'text_reporter'
-class StepDown
-
-  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 = []
-    @feature_files.each do |feature|
-      scenarios << parser.process_feature(feature, instance)
-    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 = 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) }
-    scenarios.each do |scenario|
-
-      scenario.steps.each do |step|
-        usage = usages.detect{|use| use.step.id == step.id}
-        usage.total_usage += 1 if usage
-      end
-
-      scenario.uniq_steps.each do |step|
-        usage = usages.detect{|use| use.step.id == step.id}
-        usage.number_scenarios += 1 if usage
-      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
-  end
-
-  def grouping(scenarios)
-    step_groups = instance.steps.collect{|step| StepGroup.new(step) }
-
-    step_groups.each do |step_group|
-      scenarios.each do |scenario|
-         used = scenario.steps.any?{|s| s.id == step_group.id}
-
-         if used
-           scenario.steps.each do |scen_step|
-             step_group.add_step(scen_step)
-           end
-           step_group.update_use_count
-         end
-
-      end
-
-    end
-    step_groups
-  end
-
-  def step(id)
-    instance.steps.detect{|step| step.id == id}
-  end
-
-  def instance
-    @instance ||= begin
-      new_inst = StepInstance.new
-
-      Dir.glob(@step_files).each do |file_name|
-        new_inst.instance_eval File.read(file_name)
-      end
-      new_inst
-    end
-  end
-end

data/lib/step_group.rb

@@ -1,52 +0,0 @@
-require 'cgi'
-require 'counting_step'
-class StepGroup
-  attr_reader :id, :regex, :total_usage
-
-  def initialize(step)
-    @id = step.id
-    @regex = step.regex
-    @total_usage = 0
-    @in_steps = {}
-  end
-
-  def in_steps
-    @in_steps.sort{|a,b| b[1] <=> a[1]}
-  end
-
-  def add_step(step)
-    if @in_steps[step.id]
-      @in_steps[step.id].count += 1
-    else
-      @in_steps[step.id] = CountingStep.new(step.id, step.regex)
-      @in_steps[step.id].count = 1
-    end
-  end
-
-  def update_use_count
-    @total_usage = 0
-    @in_steps.each do |key,val|
-      @total_usage += val.count
-    end
-    @total_usage
-  end
-
-  def use_count
-    @total_usage || 0
-  end
-
-  def group_graph
-    base = "https://chart.googleapis.com/chart?cht=gv:circo&chl=graph{"
-    base += "a [label=\"#{CGI.escape(CGI.escapeHTML(@regex.inspect.to_s))}\"];"
-
-    @in_steps.each do |id,in_step|
-
-      next if in_step[:step].regex.nil?
-      base += "a--\"#{CGI.escape(CGI.escapeHTML(in_step[:step].regex.inspect.to_s))}\" [weight=#{in_step[:count]}];"
-      #a [label=\"#{grouping.in_steps[0][:step].regex.inspect}\"]; a--b [penwidth=3,weight=2];b--d}"
-    end
-    base += "}"
-    base
-  end
-
-end

data/lib/step_instance.rb

@@ -1,60 +0,0 @@
-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 steps[i]
-      end
-    end
-
-    return nil
-  end
-
-  def steps
-    return @step_definitions if @step_definitions
-    @step_definitions = []
-    @steps.each_with_index do |regex, i|
-      @step_definitions << Step.new(i, regex)
-    end
-    @step_definitions
-  end
-
-end