are_we_there_yet 0.2.1 → 1.0.0

data/spec/lib/recorder_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe AreWeThereYet::Recorder do
+  before(:each) do
+    @db_name = "/tmp/arewethereyet.sqlite"
+    @db = "sqlite://#{@db_name}"
+
+    File.unlink(@db_name) if File.exists? @db_name
+
+    @connection = Sequel.connect(@db)
+  end
+
+  it "extends the RSpec formatter" do
+    AreWeThereYet::Recorder.should < Spec::Runner::Formatter::BaseFormatter
+  end
+
+  describe "#initialize" do
+    it "creates the necessary tables in the database" do
+      AreWeThereYet::Recorder.new({},@db)
+
+      @connection.tables.should_not be_empty
+    end
+
+    it "logs the start of a spec run" do
+      AreWeThereYet::Recorder.new({},@db)
+
+      @connection[:runs].first[:started_at].should_not be_nil
+    end
+  end
+
+  describe "logging a metric" do
+    before(:each) do
+      @awty = AreWeThereYet::Recorder.new({}, @db)
+      @mock_example = mock(Spec::Example::ExampleProxy, :location => "/path/to/spec:42", :description => "blaah")
+    end
+
+    # This test duplicates a test done for the Metric class - still undecided whether the cost of duplication
+    # outweighs the benefit of confirming integration
+    it "creates an entry for the metric in the database" do
+      start_time = Time.now - 10
+      end_time = Time.now
+
+      Time.stub!(:now).and_return(start_time)
+      @awty.example_started(@mock_example)
+
+      Time.stub!(:now).and_return(end_time)
+      @awty.example_passed(@mock_example)
+
+      run_id = @connection[:runs].first[:id]
+
+      @connection[:metrics].count.should ==1
+      metric = @connection[:metrics].first
+      metric[:execution_time].should == end_time - start_time
+      metric[:run_id].should == run_id
+      metric[:path].should == @mock_example.location.split(':').first
+      metric[:description].should == @mock_example.description
+    end
+  end
+
+  describe "closing" do
+    before(:each) do
+      @awty = AreWeThereYet::Recorder.new({}, @db)
+      @mock_example = mock(Spec::Example::ExampleProxy, :location => "/path/to/spec", :description => "blaah")
+      @awty.example_started(@mock_example)
+    end
+
+    it "closes the connection to the database" do
+      Sequel::SQLite::Database.any_instance.should_receive(:disconnect)
+      @awty.close
+    end
+
+    it "updates the end time value for the relevant run" do
+      @awty.close
+
+      run = @connection[:runs].first[:ended_at].should_not be_nil
+    end
+  end
+end

data/spec/lib/run_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe AreWeThereYet::Run do
+  before(:each) do
+    @db_name = "/tmp/are_we_there_yet_#{Time.now.to_i}_#{rand(100000000)}_spec.sqlite"
+    @db = "sqlite://#{@db_name}"
+
+    @connection = AreWeThereYet::Persistence::Connection.create(@db)
+    AreWeThereYet::Persistence::Schema.create(@connection)
+  end
+
+  describe "start" do
+    it "adds a record to the database" do
+      @connection[:runs].all.should be_empty
+
+      AreWeThereYet::Run.new.start(@connection)
+
+      @connection[:runs].all.should have(1).records
+    end
+
+    it "sets the start time as an UTC timestamp" do
+      fake_time = Time.at(0)
+      Time.stub_chain(:now, :utc).and_return(fake_time)
+
+      AreWeThereYet::Run.new.start(@connection)
+
+      @connection[:runs].first[:started_at].should == fake_time
+    end
+
+    it "records the id of the run created" do
+      run = AreWeThereYet::Run.new
+      run.start(@connection)
+      run.id.should == @connection[:runs].first[:id]
+    end
+  end
+
+  describe "finish" do
+    it "sets the end time as an UTC timestamp" do
+      fake_time = Time.at(0)
+      Time.stub_chain(:now, :utc).and_return(fake_time)
+
+      run = AreWeThereYet::Run.new
+      run.start(@connection)
+      run.finish(@connection)
+
+      @connection[:runs].first[:ended_at].should == fake_time
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,43 +2,14 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 
-#Create an empty class that we will need to inherit from
-
-module Spec
-  module Runner
-    module Formatter
-      class BaseFormatter
-      end
-    end
-  end
-end
-
 AWTY_SPEC_RUN = true
-require 'are_we_there_yet'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
+require 'are_we_there_yet'
+
 RSpec.configure do |config|
   
 end
-
-def table_exists?(database_location,table_name)
-  SQLite3::Database.new(database_location).execute(
-    "SELECT name FROM sqlite_master WHERE type = 'table' AND name = '#{table_name}'"
-  ).any?
-end
-
-def index_exists?(database_location,table_name,index_name)
-  SQLite3::Database.new(database_location).execute(
-    "SELECT name FROM sqlite_master WHERE type = 'index' AND name = '#{index_name}' AND tbl_name = '#{table_name}'"
-  ).any?
-end
-
-module Spec
-  module Example
-    class ExampleProxy
-    end
-  end
-end

data/spec/support/spec_classes.rb

@@ -0,0 +1,22 @@
+# Fake classes so that we do not need RSpec1.x present for the tests to pass
+module Spec
+  module Runner
+    module Formatter
+      class BaseFormatter
+      end
+    end
+  end
+end
+
+module Spec
+  module Example
+    class ExampleProxy
+      attr_reader :description, :location
+      def initialize(description, location)
+        @description = description
+        @location = location
+      end
+    end
+  end
+end
+

data/spec/support/symbol.rb

@@ -0,0 +1,6 @@
+class Symbol
+  def <=>(other_symbol)
+    self.to_s <=> other_symbol.to_s
+  end
+end
+

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: are_we_there_yet
 version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
+  hash: 23
+  prerelease: 
   segments: 
-  - 0
-  - 2
   - 1
-  segments_generated: true
-  version: 0.2.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Rory McKinley
@@ -16,28 +15,61 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-10 00:00:00 +02:00
-default_executable: 
+date: 2012-05-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  name: trollop
+  prerelease: false
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 83
         segments: 
         - 1
+        - 16
+        - 2
+        version: 1.16.2
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  prerelease: false
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 123
+        segments: 
         - 3
+        - 31
         - 0
-        segments_generated: true
-        version: 1.3.0
-  requirement: *id001
+        version: 3.31.0
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
   prerelease: false
   type: :runtime
-  name: sqlite3
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  name: rspec
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -47,31 +79,29 @@ dependencies:
         - 2
         - 7
         - 0
-        segments_generated: true
         version: 2.7.0
-  requirement: *id002
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
   prerelease: false
   type: :development
-  name: rspec
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 19
         segments: 
         - 1
+        - 1
         - 0
-        - 0
-        segments_generated: true
-        version: 1.0.0
-  requirement: *id003
+        version: 1.1.0
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
   prerelease: false
   type: :development
-  name: bundler
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -81,14 +111,13 @@ dependencies:
         - 1
         - 6
         - 4
-        segments_generated: true
         version: 1.6.4
-  requirement: *id004
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
   prerelease: false
   type: :development
-  name: jeweler
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -96,16 +125,12 @@ dependencies:
         hash: 3
         segments: 
         - 0
-        segments_generated: true
         version: "0"
-  requirement: *id005
-  prerelease: false
-  type: :development
-  name: rcov
+  version_requirements: *id007
 description: Provides detailed profiling data for RSpec runs in a SQLite3 DB
 email: rorymckinley@gmail.com
-executables: []
-
+executables: 
+- are_we_there_yet
 extensions: []
 
 extra_rdoc_files: 
@@ -121,10 +146,28 @@ files:
 - Rakefile
 - VERSION
 - are_we_there_yet.gemspec
+- bin/are_we_there_yet
 - lib/are_we_there_yet.rb
-- spec/are_we_there_yet_spec.rb
+- lib/are_we_there_yet/exceptions.rb
+- lib/are_we_there_yet/formatter.rb
+- lib/are_we_there_yet/metric.rb
+- lib/are_we_there_yet/persistence/connection.rb
+- lib/are_we_there_yet/persistence/schema.rb
+- lib/are_we_there_yet/profiler.rb
+- lib/are_we_there_yet/profiler_ui.rb
+- lib/are_we_there_yet/recorder.rb
+- lib/are_we_there_yet/run.rb
+- spec/lib/formatter_spec.rb
+- spec/lib/metric_spec.rb
+- spec/lib/persistence/connection_spec.rb
+- spec/lib/persistence/schema_spec.rb
+- spec/lib/profiler_spec.rb
+- spec/lib/profiler_ui_spec.rb
+- spec/lib/recorder_spec.rb
+- spec/lib/run_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
+- spec/support/spec_classes.rb
+- spec/support/symbol.rb
 homepage: http://github.com/rorymckinley/are_we_there_yet
 licenses: 
 - MIT
@@ -141,7 +184,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
       hash: 3
       segments: 
       - 0
-      segments_generated: true
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
@@ -151,12 +193,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       hash: 3
       segments: 
       - 0
-      segments_generated: true
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Profiler for RSpec 1.3.x

data/spec/are_we_there_yet_spec.rb

@@ -1,252 +0,0 @@
-require 'spec_helper'
-
-describe AreWeThereYet do
-  before(:each) do
-    @db_name = "/tmp/arewethereyet.sqlite"
-    File.unlink(@db_name) if File.exists? @db_name
-  end
-
-  it "extends the RSpec formatter" do
-    AreWeThereYet.should < Spec::Runner::Formatter::BaseFormatter
-  end
-
-  describe "#initialize" do
-    it "opens a connection to the specified database" do
-      SQLite3::Database.should_receive(:new).with('/path/to/db.sqlite').and_return(mock(SQLite3::Database).as_null_object)
-      AreWeThereYet.new({},'/path/to/db.sqlite')
-    end
-
-    it "creates the necessary tables in the database" do
-      AreWeThereYet.new({},@db_name)
-      table_exists?(@db_name, 'files').should be_true
-      table_exists?(@db_name, 'examples').should be_true
-      table_exists?(@db_name, 'metrics').should be_true
-      table_exists?(@db_name, 'runs').should be_true
-    end
-
-    it "creates the necessary indexes" do
-      AreWeThereYet.new({},@db_name)
-      index_exists?(@db_name, 'files', 'path').should be_true
-      index_exists?(@db_name, 'examples', 'file_description').should be_true
-    end
-
-    it "does not create the tables if they already exist" do
-      AreWeThereYet.new({},@db_name)
-      SQLite3::Database.any_instance.should_not_receive(:execute)
-
-      AreWeThereYet.new({}, @db_name)
-    end
-
-    it "rolls back table creation on error" do
-      connection = SQLite3::Database.new(@db_name)
-      connection.stub(:execute) do |arg|
-        if arg =~ /metrics/
-          raise RuntimeError
-        else
-          connection.execute2(arg)
-          []
-        end
-      end
-      SQLite3::Database.should_receive(:new).and_return(connection)
-
-      expect { AreWeThereYet.new({},@db_name) }.should raise_error
-
-      connection.execute2("SELECT name FROM sqlite_master").size.should == 1 # Execute2 lists fields - size 1 means empty response
-    end
-
-    it "logs the start of a spec run" do
-      AreWeThereYet.new({},@db_name)
-      connection = SQLite3::Database.new(@db_name)
-
-      run = connection.get_first_row("SELECT id, started_at FROM runs")
-      run.should_not be_nil
-      run[1].should_not be_nil
-    end
-
-    it "does not log the start of a spec run if there is no table in the database" do
-      # This to maintain backwards-compatibility with DBs created by v0.1.0
-      connection = SQLite3::Database.new(@db_name)
-      connection.stub(:execute) do |arg|
-        if arg =~ /CREATE TABLE runs/
-          # Do nothing
-        else
-          connection.execute2(arg)
-          []
-        end
-      end
-      SQLite3::Database.should_receive(:new).and_return(connection)
-
-      expect { AreWeThereYet.new({},@db_name) }.should_not raise_error
-    end
-  end
-
-  describe "logging a metric for a new file" do
-    before(:each) do
-      @awty = AreWeThereYet.new({}, @db_name)
-      @mock_example = mock(Spec::Example::ExampleProxy, :location => "/path/to/spec:42", :description => "blaah")
-    end
-
-    it "creates an entry for the example's file" do
-      @awty.example_started(@mock_example)
-      @awty.example_passed(@mock_example)
-
-      files = SQLite3::Database.new(@db_name).execute("SELECT id, path FROM files")
-      files.size.should == 1
-      files.first[1].should == @mock_example.location.split(':').first
-    end
-
-    it "creates an entry for the example itself" do
-      @awty.example_started(@mock_example)
-      @awty.example_passed(@mock_example)
-
-      connection = SQLite3::Database.new(@db_name)
-      file = connection.get_first_row("SELECT id FROM files")
-      file_id = file.first
-      examples = connection.execute("SELECT id, file_id, description FROM examples")
-
-      examples.size.should == 1
-      examples.first[1].should == file_id
-      examples.first[2].should == @mock_example.description
-    end
-
-    it "creates an entry for the total execution time" do
-      start_time = Time.now - 10
-      end_time = Time.now
-
-      Time.should_receive(:now).and_return(start_time)
-      @awty.example_started(@mock_example)
-
-      Time.should_receive(:now).and_return(end_time)
-      @awty.example_passed(@mock_example)
-
-      connection = SQLite3::Database.new(@db_name)
-      run = connection.get_first_row("SELECT id FROM runs")
-      run_id = run.first
-
-      example = connection.get_first_row("SELECT id FROM examples")
-      example_id = example.first
-
-      Time.stub!(:now)
-      metrics = connection.execute("SELECT id, example_id, execution_time, created_at, run_id FROM metrics")
-      metrics.size.should == 1
-      metrics.first[1].should == example_id
-      metrics.first[2].should == end_time - start_time
-      metrics.first[3].should_not be_nil
-      metrics.first[4].should == run_id
-    end
-
-    it "does not link the metric to a run if the run table does not exist" do
-      # To maintain compatibility with version 0.1.0
-      AreWeThereYet.any_instance.should_receive(:tracking_runs?).and_return(false)
-
-      connection = SQLite3::Database.new(@db_name)
-      connection.execute("DROP TABLE metrics")
-      connection.execute("CREATE TABLE metrics(id INTEGER PRIMARY KEY, example_id INTEGER, execution_time FLOAT, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP)")
-
-      @awty.example_started(@mock_example)
-      expect { @awty.example_passed(@mock_example) }.should_not raise_error
-    end
-  end
-
-  describe "logging a metric for an existing file" do
-    before(:each) do
-      @awty = AreWeThereYet.new({}, @db_name)
-      @mock_example = mock(Spec::Example::ExampleProxy, :location => "/path/to/spec", :description => "blaah")
-      @another_example = mock(Spec::Example::ExampleProxy, :location => "/path/to/spec", :description => "yippee!")
-    end
-
-    it "creates an example linked to the existing location" do
-      @awty.example_started(@mock_example)
-      @awty.example_passed(@mock_example)
-
-      @awty.example_started(@another_example)
-      @awty.example_passed(@another_example)
-
-      connection = SQLite3::Database.new(@db_name)
-
-      examples = connection.execute("SELECT description FROM examples")
-      examples.size.should == 2
-
-      files = connection.execute("SELECT id FROM files")
-      files.size.should == 1
-    end
-  end
-
-  describe "logging a metric for an existing example" do
-    before(:each) do
-      @awty = AreWeThereYet.new({}, @db_name)
-      @mock_example = mock(Spec::Example::ExampleProxy, :location => "/path/to/spec", :description => "blaah")
-    end
-
-    it "creates a metric linked to the example" do
-      @awty.example_started(@mock_example)
-      @awty.example_passed(@mock_example)
-
-      @awty.example_started(@mock_example)
-      @awty.example_passed(@mock_example)
-
-      connection = SQLite3::Database.new(@db_name)
-
-      metrics = connection.execute("SELECT id FROM metrics")
-      metrics.size.should == 2
-
-      examples = connection.execute("SELECT description FROM examples")
-      examples.size.should == 1
-    end
-  end
-
-  describe "handling errors when logging" do
-    before(:each) do
-      @awty = AreWeThereYet.new({}, @db_name)
-      @mock_example = mock(Spec::Example::ExampleProxy, :location => "/path/to/spec", :description => "blaah")
-      @awty.example_started(@mock_example)
-    end
-
-    it "allows the error through and any changes are undone" do
-      connection = SQLite3::Database.new(@db_name)
-      connection.execute("DROP TABLE metrics")
-
-      expect { @awty.example_passed(@mock_example) }.should raise_error
-
-      connection.execute("SELECT * FROM files").should be_empty
-      connection.execute("SELECT * FROM examples").should be_empty
-    end
-  end
-
-  describe "closing" do
-    before(:each) do
-      @awty = AreWeThereYet.new({}, @db_name)
-      @mock_example = mock(Spec::Example::ExampleProxy, :location => "/path/to/spec", :description => "blaah")
-      @awty.example_started(@mock_example)
-    end
-
-    it "closes the connection to the database" do
-      SQLite3::Database.any_instance.should_receive(:close)
-      @awty.close
-    end
-
-    it "updates the end time value for the relevant run" do
-      @awty.close
-
-      connection = SQLite3::Database.new(@db_name)
-      run = connection.get_first_row('SELECT ended_at FROM runs')
-      run.first.should_not be_nil
-    end
-
-    it "stores the UTC time value for the relevant run" do
-      mock_time = mock(Time, :strftime => '1970-01-01 00:00:00')
-      mock_time.should_receive(:utc).and_return(mock_time)
-      Time.stub(:now).and_return(mock_time)
-
-      @awty.close
-    end
-
-    it "does not update the run if runs are not being tracked" do
-      connection = SQLite3::Database.new(@db_name)
-      connection.execute("DROP TABLE runs")
-      AreWeThereYet.any_instance.should_receive(:tracking_runs?).and_return(false)
-
-      expect { @awty.close }.should_not raise_error
-    end
-  end
-end