are_we_there_yet 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+gem "sqlite3", "~>1.3.0"
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+group :development do
+  gem "rspec", "~> 2.7.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    sqlite3 (1.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.7.0)
+  sqlite3 (~> 1.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Rory McKinley
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# README
+
+## About
+
+AreWeThereYet is a gem that provides alternative profiling for RSpec 1.3.x for those who are not blessed enough to be using all the
+crunchy goodness that is RSpec 2.x.  Metrics are tracked per file and per example in a SQLite3 database. The location of the 
+database is passed through as a parameter when running the specs
+
+AWTY only logs data, so you are currently required to handroll any reporting functionality. There is also, currently no data output
+to STDOUT when spec runs with this formatter.
+
+## Usage
+
+Usage is fairly simple:
+
+1. Add `require 'are_we_there_yet'` to your `spec_helper.rb` file.
+2. When running the specs pass the name of the class together with the location of your SQLite3 database, e.g:
+  `spec -fAreWeThereYet:/path/to/db.sqlite3 spec`
+
+## License
+
+Copyright (c) 2012 Rory McKinley
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "are_we_there_yet"
+  gem.homepage = "http://github.com/rorymckinley/are_we_there_yet"
+  gem.license = "MIT"
+  gem.summary = %Q{Profiler for RSpec 1.3.x}
+  gem.description = %Q{Provides detailed profiling data for RSpec runs in a SQLite3 DB}
+  gem.email = "rorymckinley@gmail.com"
+  gem.authors = ["Rory McKinley"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "are_we_there_yet #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/are_we_there_yet.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{are_we_there_yet}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rory McKinley"]
+  s.date = %q{2012-01-09}
+  s.description = %q{Provides detailed profiling data for RSpec runs in a SQLite3 DB}
+  s.email = %q{rorymckinley@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "are_we_there_yet.gemspec",
+    "lib/are_we_there_yet.rb",
+    "spec/are_we_there_yet_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/rorymckinley/are_we_there_yet}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Profiler for RSpec 1.3.x}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<sqlite3>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.7.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<sqlite3>, ["~> 1.3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.7.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sqlite3>, ["~> 1.3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.7.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/are_we_there_yet.rb

@@ -0,0 +1,74 @@
+require "spec/runner/formatter/base_formatter" unless defined? AWTY_SPEC_RUN
+require 'sqlite3'
+
+class AreWeThereYet < Spec::Runner::Formatter::BaseFormatter
+  def initialize(options,where)
+    @db = SQLite3::Database.new(where)
+
+    create_tables
+  end
+
+  def example_started(example)
+    @start = Time.now
+  end
+
+  def example_passed(example)
+    @db.transaction do |db|
+      location_id = persist_file(db, example)
+
+      example_id = persist_example(db, example, location_id)
+
+      db.execute(
+        "INSERT INTO metrics(example_id, execution_time) VALUES(:example_id, :execution_time)",
+        :example_id => db.last_insert_row_id,
+        :execution_time => Time.now - @start
+      )
+    end
+  end
+
+  private
+
+  def persist_file(db, example)
+    path = example.location.split(':').first
+
+    locations = db.execute("SELECT id FROM files WHERE path = :path", :path => path)
+    if locations.empty?
+      db.execute("INSERT INTO files(path) VALUES(:path)", :path => path)
+      db.last_insert_row_id
+    else
+      locations.first[0]
+    end
+  end
+
+  def persist_example(db, example, file_id)
+    examples = db.execute(
+      "SELECT id FROM examples WHERE file_id = :file_id AND description = :description",
+      :file_id => file_id,
+      :description => example.description
+    )
+    if examples.empty?
+      db.execute(
+        "INSERT INTO examples(file_id, description) VALUES(:file_id, :description)",
+        :file_id => file_id,
+        :description => example.description
+      )
+      db.last_insert_row_id
+    else
+      examples.first[0]
+    end
+  end
+
+  def create_tables
+    existing_tables = @db.execute("SELECT name FROM sqlite_master")
+
+    if existing_tables.empty?
+      @db.transaction do |db|
+        db.execute("CREATE TABLE files(id INTEGER PRIMARY KEY, path VARCHAR(255))")
+        db.execute("CREATE INDEX path ON files (path)")
+        db.execute("CREATE TABLE examples(id INTEGER PRIMARY KEY, file_id INTEGER, description TEXT)")
+        db.execute("CREATE INDEX file_description ON examples (file_id, description)")
+        db.execute("CREATE TABLE metrics(id INTEGER PRIMARY KEY, example_id INTEGER, execution_time FLOAT, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP)")
+      end
+    end
+  end
+end

data/spec/are_we_there_yet_spec.rb

@@ -0,0 +1,173 @@
+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
+    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
+  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)
+      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 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
+    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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+$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}
+
+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

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification 
+name: are_we_there_yet
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  segments_generated: true
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rory McKinley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        segments_generated: true
+        version: 1.3.0
+  requirement: *id001
+  prerelease: false
+  type: :runtime
+  name: sqlite3
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
+        segments_generated: true
+        version: 2.7.0
+  requirement: *id002
+  prerelease: false
+  type: :development
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        segments_generated: true
+        version: 1.0.0
+  requirement: *id003
+  prerelease: false
+  type: :development
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        segments_generated: true
+        version: 1.6.4
+  requirement: *id004
+  prerelease: false
+  type: :development
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        segments_generated: true
+        version: "0"
+  requirement: *id005
+  prerelease: false
+  type: :development
+  name: rcov
+description: Provides detailed profiling data for RSpec runs in a SQLite3 DB
+email: rorymckinley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- are_we_there_yet.gemspec
+- lib/are_we_there_yet.rb
+- spec/are_we_there_yet_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rorymckinley/are_we_there_yet
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      segments_generated: true
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      segments_generated: true
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Profiler for RSpec 1.3.x
+test_files: []
+