cucover 0.1.2

data/features/lazy_run_per_scenario_outline_example.feature

@@ -0,0 +1,29 @@
+Feature: Lazy Run per Scenario Outline Example
+  In order save time
+  As a developer working on a feature with Scenario Outlines
+  I want to run only the examples that could fail
+
+  Background:
+    Given I am using the simple example app
+    And I have run cucover -- features/call_foo_then_bar_from_scenario_outline_examples.feature
+
+  Scenario: Edit a source file that should trigger just one of the examples to be run
+    When I edit the source file lib/bar.rb
+    And I run cucover -- -q features/call_foo_then_bar_from_scenario_outline_examples.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo then Bar from Scenario Outline Examples
+
+        Scenario Outline: Call Something
+          When I call <Code>
+
+          Examples:
+            | Code |
+            | Foo  |  [ Cucover - Skipping clean scenario ]
+            | Bar  |
+
+      2 scenarios (1 skipped, 1 passed)
+      2 steps (1 skipped, 1 passed)
+
+      """
+

data/features/lazy_run_triggered_by_rails_view_change.feature

@@ -0,0 +1,43 @@
+@slow
+Feature: Lazy Run Triggered By Rails View Change
+  In order to feel the cucover love
+  As a front-end developer
+  I want the changes I make to rails views to trigger cucover runs, the same as Ruby code does
+  
+  Background:
+    And I am using the rails example app
+    And I have run cucover -- features/see_widgets.feature
+
+  Scenario: Change nothing and run cucover again
+    When I run cucover -- -q --format pretty features/see_widgets.feature
+    Then it should pass with:
+      """
+      Using the default profile...
+      Feature: See widgets
+
+        Scenario: See widgets
+          When I go to the widgets
+            [ Cucover - Skipping clean scenario ]
+          Then I should see "Look at all these lovely widgets"
+
+      1 scenario (1 skipped)
+      2 steps (2 skipped)
+      
+      """
+      
+  Scenario: Edit a view and run cucover again
+    When I edit the source file app/views/widgets/index.html.erb
+    When I run cucover -- -q --format pretty features/see_widgets.feature
+    Then it should pass with:
+      """
+      Using the default profile...
+      Feature: See widgets
+
+        Scenario: See widgets
+          When I go to the widgets
+          Then I should see "Look at all these lovely widgets"
+
+      1 scenario (1 passed)
+      2 steps (2 passed)
+      
+      """

data/features/run.feature

@@ -0,0 +1,25 @@
+Feature: Run
+  In order to trust cucover and not have to switch between testing tools
+  As a developer
+  I want to be able to run features and get useful feedback through cucover
+
+  Scenario: Run features, minimal output
+    Given I am using the simple example app
+    When I run cucover -- features/call_foo.feature features/call_foo_and_bar_together.feature
+    Then it should pass with:
+      """
+      Feature: Call Foo
+
+        Scenario: Call Foo # features/call_foo.feature:3
+          When I call Foo  # features/step_definitions/main_steps.rb:9
+
+      Feature: Call Foo and Bar Together
+
+        Scenario: Call Foo and Bar # features/call_foo_and_bar_together.feature:3
+          When I call Foo          # features/step_definitions/main_steps.rb:9
+          And I call Bar           # features/step_definitions/main_steps.rb:9
+
+      2 scenarios (2 passed)
+      3 steps (3 passed)
+
+      """

data/features/show_recordings.feature

@@ -0,0 +1,28 @@
+Feature: Show Recordings
+  In order to see what's going on inside Cucover
+  As a developer of Cucover
+  I want to be able to see a human-readable summary of the recordings
+
+  Background:
+    Given I am using the simple example app
+
+  Scenario: Run a couple of features, see the recordings
+    Given I have run cucover -- features/call_foo.feature
+    And I have run cucover -- features/call_foo_and_bar_together.feature
+    When I run cucover --show-recordings
+    Then it should pass with:
+    """
+
+    features/call_foo.feature:3
+      features/step_definitions/main_steps.rb:6:10
+      lib/foo.rb:2:3
+      features/call_foo.feature:<unknown lines>
+
+    features/call_foo_and_bar_together.feature:3
+      features/step_definitions/main_steps.rb:6:10
+      lib/bar.rb:2:3
+      lib/foo.rb:2:3
+      features/call_foo_and_bar_together.feature:<unknown lines>
+
+
+    """

data/features/step_definitions/main_steps.rb

@@ -0,0 +1,41 @@
+Given /^I have (tried to |)run cucover (.*)$/ do |tried, args|
+  When %{I run cucover #{args}}
+  if tried.blank?
+    assert(@status == 0, @out)
+  end
+end
+
+Given /^I am using the (.*) example app$/ do |app_name|
+  @example_app = app_name
+  clear_cache!
+end
+
+When /^I run cucover (.*)$/ do |args|
+  cucover_binary = File.expand_path(File.dirname(__FILE__) + '../../../bin/cucover')
+  within_examples_dir do
+    full_cmd = "#{Cucumber::RUBY_BINARY} #{cucover_binary} #{args}"
+    @out = `#{full_cmd}`
+    @status = $?.exitstatus
+  end
+end
+
+When /^I edit the source file (.*)$/ do |source_file|
+  within_examples_dir do
+    edit source_file
+  end
+end
+
+Then /^it should (pass|fail) with:$/ do |expected_status, expected_text|
+  expected_status_code = expected_status == "pass" ? 0 : 1
+  
+  unless @status == expected_status_code
+    raise "Expected #{expected_status} but return code was #{@status}: #{@out}"
+  end
+  
+  strip_trailing_spaces(strip_duration(@out)).should == expected_text
+end
+
+Then /^I should see "([^\"]*)"$/ do |expected_text|
+  @out.should =~ /#{Regexp.escape(expected_text)}/
+end
+

data/features/support/env.rb

@@ -0,0 +1,52 @@
+# require File.dirname(__FILE__) + '/../../lib/cucover'
+require 'spec'
+require 'test/unit/assertions'
+
+module CucoverHelper
+  def edit(file)
+    original_mtime = File.mtime(file)
+    FileUtils.touch(file)
+    @edited_files ||= {}
+    @edited_files[file] = original_mtime
+  end
+
+  def restore_file_mtimes
+    return unless @edited_files
+    @edited_files.each do |file, original_mtime|
+      `touch -t #{original_mtime.strftime('%Y%m%d%H%M.%S')} #{examples_dir}/#{file}`
+    end
+  end
+
+  def strip_duration(s)
+    s.gsub(/^\d+m\d+\.\d+s\n/m, "")
+  end
+
+  def strip_trailing_spaces(s)
+    s.gsub(/ +$/, '')
+  end
+
+  def clear_cache!
+    `find examples -name cucover.data | xargs rm -rf`
+  end
+
+  def example_app
+    @example_app || raise("Please call the step 'Given I am using the .... example app' so I know which example app to run these features in.")
+  end
+
+  def within_examples_dir
+    Dir.chdir(examples_dir) do
+      yield
+    end
+  end
+
+  def examples_dir
+    File.expand_path(File.dirname(__FILE__) + "/../../examples/self_test/#{example_app}")
+  end
+end
+
+World CucoverHelper, Test::Unit::Assertions
+
+After do
+  clear_cache!
+  restore_file_mtimes
+end

data/lib/at_exit_hook.rb

@@ -0,0 +1,3 @@
+at_exit do
+  exit(Cucover::CliCommands::Cucumber.exit_status || 0)
+end

data/lib/cucover.rb

@@ -0,0 +1,65 @@
+$:.unshift(File.dirname(__FILE__))
+require 'dependencies'
+require 'cucover/logging_config'
+require 'cucover/cli_commands/coverage_of'
+require 'cucover/cli_commands/cucumber'
+require 'cucover/cli_commands/show_recordings'
+require 'cucover/cli_commands/version'
+require 'cucover/controller'
+require 'cucover/cli'
+require 'cucover/monkey'
+require 'cucover/rails'
+require 'cucover/recording'
+require 'cucover/recorder'
+require 'cucover/store'
+require 'cucover/line_numbers'
+
+
+require 'at_exit_hook'
+
+module Cucover
+  class << self
+    def logger
+      Logging::Logger['Cucover']
+    end
+
+    def should_execute?(scenario_or_table_row)
+      controller(scenario_or_table_row).should_execute?
+    end
+
+    def start_recording!(scenario_or_table_row)
+      raise("Already recording. Please call stop first.") if recording?
+
+      @current_recorder = Recorder.new(scenario_or_table_row)
+      @current_recorder.start!
+      record_file(scenario_or_table_row.file_colon_line.split(':').first) # TODO: clean this by extending the feature element
+    end
+
+    def stop_recording!
+      return unless recording?
+
+      @current_recorder.stop!
+      store.keep!(@current_recorder.recording)
+      @current_recorder = nil
+    end
+
+    def record_file(source_file)
+      Cucover.logger.debug("Recording extra source file #{source_file}")
+      @current_recorder.record_file!(source_file)
+    end
+
+    private
+
+    def controller(scenario_or_table_row)
+      Controller.new(scenario_or_table_row.file_colon_line, store)
+    end
+
+    def recording?
+      !!@current_recorder
+    end
+
+    def store
+      @store ||= Store.new
+    end
+  end
+end

data/lib/cucover/cli.rb

@@ -0,0 +1,50 @@
+module Cucover
+  class Cli
+    def initialize(args)
+      @args = args
+    end
+
+    def start
+      command_type.new(@args).execute
+    end
+    
+    private
+    
+    def command_type
+      case @args.first
+      when '--'
+        CliCommands::Cucumber
+      when '--version', '-v'
+        CliCommands::Version
+      when '--coverage-of', '-c'
+        CliCommands::CoverageOf
+      when '--show-recordings', '-s'
+        CliCommands::ShowRecordings
+      else
+        puts help
+        Kernel.exit(0)
+      end
+    end
+    
+      def help
+        <<-EOH
+Usage: cucover -- [options] [ [FILE|DIR|URL][:LINE[:LINE]*] ]+
+
+Examples:
+cucover -- --format pretty features
+cucover --coverage-of lib/monkeys.rb
+cucover --show-recordings
+
+    -- [ARGS]                               Run cucumber while recording coverage. This will skip scenarios 
+                                            if they have already been run and the covering code has not
+                                            been changed.
+    -c [FILE], --coverage-of [FILE]         Show file with feature coverage information
+    -s,        --show-recordings            Show all coverage information currently recorded
+    -v,        --version                    Show version
+    -h,        --help                       You're looking at it.
+
+EOH
+      end
+    
+  end
+end

data/lib/cucover/cli_commands/coverage_of.rb

@@ -0,0 +1,44 @@
+module Cucover
+  module CliCommands
+    class CoverageOf
+      CODE_COLUMN_WIDTH = 15
+
+      def initialize(cli_args)
+        @filespec = cli_args[1]
+        @store = Store.new
+      end
+
+      def execute
+        load_cucumber_enviroment
+        return unless recordings.any?
+
+        File.open(@filespec).each_with_index do |line_content, index|
+          line_number = index + 1
+          coverage_text = coverage(line_number).join(', ')
+          line_content.rstrip!
+          if line_content.length > CODE_COLUMN_WIDTH
+            truncated_line_content = "#{line_content[0..(CODE_COLUMN_WIDTH - 1)]}.."
+          else
+            truncated_line_content = "#{line_content}  "
+          end
+          puts "#{line_number} #{truncated_line_content.ljust(CODE_COLUMN_WIDTH + 2)} #{coverage_text}"
+        end
+      end
+
+      def coverage(line_number)
+        recordings.select{ |r| r.covers_line?(@filespec, line_number) }.map{ |r| r.file_colon_line }
+      end
+
+      def recordings
+        @recordings ||= @store.recordings_covering(@filespec)
+      end
+
+      private
+      def load_cucumber_enviroment
+        support_files = Dir['features/**/*'].select {|file| file =~ /support\/env\..*/ }
+        support_files.each{ |env_file| puts env_file; require env_file }
+      end
+
+    end
+  end
+end

data/lib/cucover/cli_commands/cucumber.rb

@@ -0,0 +1,46 @@
+module Cucover
+  module CliCommands
+    class Cucumber
+
+      LANGUAGE = 'rb'
+
+      class << self
+        attr_accessor :exit_status
+      end
+
+      def initialize(cli_args)
+        Cucumber.exit_status = 0
+        @cli_args = cli_args
+      end
+
+      def execute
+        require 'rubygems'
+        require 'cucumber'
+
+        step_mother = ::Cucumber::StepMother.new
+        step_mother.load_programming_language(LANGUAGE)
+        require 'cucover/cucumber_hooks'
+
+        execute_cuke do
+          ::Cucumber::Cli::Main.new(ARGV).execute!(step_mother)
+        end
+      end
+
+      private
+
+      def execute_cuke
+        ARGV.replace cucumber_args
+        Cucumber.exit_status = yield
+        Cucumber.exit_status = Cucumber.exit_status ? 1 : 0
+        ARGV.replace @cli_args
+      end
+
+      def cucumber_args
+        return nil unless @cli_args.index('--')
+        first = @cli_args.index('--') + 1
+        last = @cli_args.length - 1
+        @cli_args[first..last]
+      end
+    end
+  end
+end

data/lib/cucover/cli_commands/show_recordings.rb

@@ -0,0 +1,29 @@
+module Cucover
+  module CliCommands
+    class ShowRecordings
+      def initialize(cli_args)
+        @store = Store.new
+      end
+      
+      def execute
+        unless recordings.any?
+          puts "No recordings to show. Run some tests with cucover first."
+          return
+        end
+        
+        recordings.each do |recording|
+          puts
+          puts "#{recording.file_colon_line}" # (#{recording.start_time.strftime('%Y-%m-%d %H:%M:%S')})
+          recording.covered_files.each do |covered_file|
+            puts "  #{covered_file.to_s}"
+          end
+        end
+        puts
+      end
+      
+      def recordings
+        @recordings ||= @store.latest_recordings.sort{ |x, y| x.file_colon_line <=> y.file_colon_line }
+      end
+    end
+  end
+end