are_we_there_yet 0.2.1 → 1.0.0

data/Gemfile

@@ -1,11 +1,13 @@
 source "http://rubygems.org"
-gem "sqlite3", "~>1.3.0"
+gem "trollop", "~> 1.16.2"
+gem "sequel", "~> 3.31.0"
+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 "bundler", "~> 1.1.0"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
 end

data/Gemfile.lock

@@ -8,7 +8,7 @@ GEM
       git (>= 1.2.5)
       rake
     rake (0.9.2.2)
-    rcov (0.9.11)
+    rcov (1.0.0)
     rspec (2.7.0)
       rspec-core (~> 2.7.0)
       rspec-expectations (~> 2.7.0)
@@ -17,14 +17,18 @@ GEM
     rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.7.0)
+    sequel (3.31.0)
     sqlite3 (1.3.5)
+    trollop (1.16.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  bundler (~> 1.1.0)
   jeweler (~> 1.6.4)
   rcov
   rspec (~> 2.7.0)
+  sequel (~> 3.31.0)
   sqlite3 (~> 1.3.0)
+  trollop (~> 1.16.2)

data/README.md

@@ -3,32 +3,68 @@
 ## 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 
+crunchy goodness that is RSpec 2.x.  Metrics are tracked per file and per example in a SQLite3 database. The URI 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.
+AreWeThereYet does not produce any output to STDOUT during the spec run. Howeevr, it does provide some rudimentary reporting that can
+be run against the data in the selected database.
+
+V1.0 provides no backwards compatibility for data recorded by earlier versions.
 
 ## Usage
 
-Usage is fairly simple:
+### Logging of spec execution time
 
 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`
+2. When running the specs pass the name of the class together with a database uri, e.g:
+  `spec -fAreWeThereYet::Recorder:sqlite:///path/to/db.sqlite3 spec`
 
 Only passing tests are profiled.
 
-## Data Structure
+### Displaying results
+
+AWTY currently offers two methods of listing execution times:
+
+- By file, ordered by descending average execution time.
+- By example, listing all the examples for a given file, ordered by descending average execution time. When listing by example, the 
+file path in question must also be supplied.
+
+The results can either be displayed by using the executable provided by the AWTY gem or by including the gem in code of your choice, 
+and making use of the `AreWeThereYet::Profiler#list_files` or `AreWeThereYet::Profiler#list_examples` methods.
+
+An example of using the executable:
+
+`bundle exec are_we_there_yet --database_uri sqlite:///path/to/results.sqlite3 --list examples --file_path /path/to/spec`
+
+`are_we_there_yet -h` will provide a list of available options.
+
+Currently, the only output supported is csv. The generator of this is very rudimentary. If there are sufficient use cases where 
+example descriptions contain characters that will break the output (e.g. examples that contain double quotes within their
+description) then it would make sense to use something like FasterCSV.
+
+An example of including AreWeThereYet::Profiler in other Ruby code:
+
+    require 'rubygems'
+    require 'are_we_there_yet'
+
+    # Instantiate the Profiler class with a string containing the path to the location of the database
+    profiler = AreWeThereYet::Profiler.new(@db_name)
+
+    examples_for_file = profiler.list_examples("/path/to/spec")
+
+Details of the output format as well as usage of `AreWeThereYet::Profiler#list_files` method can be found in
+`spec/lib/profiler_spec.rb`.
+    
+## Database
+
+AWTY should support any database that Sequel (the current underlying ORM library) supports - simply specify the URI accordingly.
+
+## Acknowledgements
 
-The following data is stored in the database:
+My employer, Hetzner (Pty) Ltd, generously allows me to work on Open Source projects during work hours - which accounted for most 
+of the time spent on this gem.
 
-- runs (from v0.2.0 onwards) - this is to allow conclusive tracking of metrics against a specific run. Multiple runs close to one 
-may result in guesswork when determining which metrics belong to which run. v0.1.0 does not track this data, but v0.2.0 is backwards 
-compatible and can handle the reduced fidelity when dealing with a database created by v0.1.0.
-- files - this represents the individual files containing the examples that are being run.
-- examples - the individual examples themselves (one file has many examples)
-- metrics - the run time per example (per run from v0.2.0 onwards) - one example has many metrics, one run has many metrics
+Thanks also to Sheldon Hearn for guidance/code review.
 
 ## License
 

data/Rakefile

@@ -21,6 +21,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{Provides detailed profiling data for RSpec runs in a SQLite3 DB}
   gem.email = "rorymckinley@gmail.com"
   gem.authors = ["Rory McKinley"]
+  gem.bindir = 'bin'
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.1
+1.0.0

data/are_we_there_yet.gemspec

@@ -4,14 +4,15 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{are_we_there_yet}
-  s.version = "0.2.1"
+  s.name = "are_we_there_yet"
+  s.version = "1.0.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-10}
-  s.description = %q{Provides detailed profiling data for RSpec runs in a SQLite3 DB}
-  s.email = %q{rorymckinley@gmail.com}
+  s.date = "2012-05-09"
+  s.description = "Provides detailed profiling data for RSpec runs in a SQLite3 DB"
+  s.email = "rorymckinley@gmail.com"
+  s.executables = ["are_we_there_yet"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -26,37 +27,61 @@ Gem::Specification.new do |s|
     "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",
-    "spec/spec_helper.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",
+    "spec/support/spec_classes.rb",
+    "spec/support/symbol.rb"
   ]
-  s.homepage = %q{http://github.com/rorymckinley/are_we_there_yet}
+  s.homepage = "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}
+  s.rubygems_version = "1.8.17"
+  s.summary = "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<trollop>, ["~> 1.16.2"])
+      s.add_runtime_dependency(%q<sequel>, ["~> 3.31.0"])
       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<bundler>, ["~> 1.1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
+      s.add_dependency(%q<trollop>, ["~> 1.16.2"])
+      s.add_dependency(%q<sequel>, ["~> 3.31.0"])
       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<bundler>, ["~> 1.1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
+    s.add_dependency(%q<trollop>, ["~> 1.16.2"])
+    s.add_dependency(%q<sequel>, ["~> 3.31.0"])
     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<bundler>, ["~> 1.1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
   end

data/bin/are_we_there_yet

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+
+require 'are_we_there_yet'
+require 'trollop'
+
+opts = Trollop::options do
+  opt :database_uri, "Database URI for the db that contains the execution times", :type => String
+  opt :list, "The type of list required - currently the options are 'files' or 'examples'", :type => String
+  opt :file_path, "The path for the spec file - used when listing examples for a given file", :type => String
+end
+
+AreWeThereYet::ProfilerUI.get_profiler_output(opts.delete(:database_uri), STDOUT, :list => opts[:list],
+                                              :file_path => opts[:file_path]) 

data/lib/are_we_there_yet.rb

@@ -1,108 +1,4 @@
 require "spec/runner/formatter/base_formatter" unless defined? AWTY_SPEC_RUN
-require 'sqlite3'
+require 'sequel'
 
-class AreWeThereYet < Spec::Runner::Formatter::BaseFormatter
-  def initialize(options,where)
-    @db = SQLite3::Database.new(where)
-
-    create_tables
-
-    log_run
-  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)
-
-      persist_metric(db, example_id)
-    end
-  end
-
-  def close
-    @db.execute(
-      "UPDATE runs SET ended_at = :end_time WHERE id = :run_id",
-      :end_time => Time.now.utc.strftime("%Y-%m-%d %H:%M:%S"), 
-      :run_id => @run_id
-    ) if tracking_runs?
-    @db.close
-  end
-
-  private
-
-  def log_run
-    @db.execute("INSERT INTO runs(id) VALUES(NULL)") if tracking_runs?
-    @run_id = @db.last_insert_row_id
-  end
-
-  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 persist_metric(db, example_id)
-    if tracking_runs?
-      db.execute(
-        "INSERT INTO metrics(example_id, execution_time, run_id) VALUES(:example_id, :execution_time, :run_id)",
-        :example_id => db.last_insert_row_id,
-        :execution_time => Time.now - @start,
-        :run_id => @run_id
-      )
-    else
-      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
-  
-  def create_tables
-    existing_tables = @db.execute("SELECT name FROM sqlite_master")
-
-    if existing_tables.empty?
-      @db.transaction do |db|
-        db.execute("CREATE TABLE runs(id INTEGER PRIMARY KEY, started_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP, ended_at TIMESTAMP)")
-        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, run_id INTEGER )")
-      end
-    end
-  end
-
-  def tracking_runs?
-    @tracking_runs ||= @db.execute("SELECT name FROM sqlite_master WHERE type = 'table' AND name = 'runs'").any?
-  end
-end
+Dir["#{File.dirname(__FILE__)}/are_we_there_yet/**/*.rb"].each {|f| require f}

data/lib/are_we_there_yet/exceptions.rb

@@ -0,0 +1,3 @@
+module AreWeThereYet
+  class InvalidDBLocation < StandardError; end
+end

data/lib/are_we_there_yet/formatter.rb

@@ -0,0 +1,17 @@
+module AreWeThereYet
+  class Formatter
+    def self.format_for_output(data)
+      if data.first.has_key? :file
+        headers = %Q{"File Path","Average Execution Time"\n\n}
+        data.inject(headers) do |output_string, metric_record|
+          output_string += %Q{"#{metric_record[:file]}",#{metric_record[:average_execution_time]}\n}
+        end
+      else
+        headers = %Q{"Example","Average Execution Time"\n\n}
+        data.inject(headers) do |output_string, metric_record|
+          output_string += %Q{"#{metric_record[:example]}",#{metric_record[:average_execution_time]}\n}
+        end
+      end
+    end
+  end
+end

data/lib/are_we_there_yet/metric.rb

@@ -0,0 +1,27 @@
+module AreWeThereYet
+  class Metric
+    attr_reader :id, :execution_time, :path, :run_id, :description
+    def initialize(options={})
+      @id = options[:id]
+      @execution_time = options[:execution_time]
+      @path = options[:path]
+      @run_id = options[:run_id]
+      @description = options[:description]
+    end
+
+    # Only works for creates not for updates - will need to be cleverer if we ever need to provide for updates
+    def save(datastore)
+      @id = datastore[:metrics].insert(to_h.merge(:created_at => Time.now.utc))
+    end
+
+    def self.all(datastore)
+      datastore[:metrics].all.map { |record| new record }
+    end
+
+    private
+
+    def to_h
+      { :execution_time => execution_time, :path => path, :description => description, :run_id => run_id }
+    end
+  end
+end

data/lib/are_we_there_yet/persistence/connection.rb

@@ -0,0 +1,13 @@
+module AreWeThereYet
+  module Persistence
+    module Connection
+      class InvalidDBLocation < StandardError; end
+      def self.create(uri)
+        Sequel.connect(uri)
+      rescue
+        raise AreWeThereYet::Persistence::Connection::InvalidDBLocation,
+          "Could not connect to the database specified by the URI - please check that the location is valid"
+      end
+    end
+  end
+end

data/lib/are_we_there_yet/persistence/schema.rb

@@ -0,0 +1,32 @@
+module AreWeThereYet
+  module Persistence
+    module Schema
+      @@tables = {
+        :runs => Proc.new {
+          primary_key :id
+          DateTime :started_at
+          DateTime :ended_at
+        },
+        :metrics => Proc.new {
+          primary_key :id
+          String :path
+          column :description, :text
+          Float :execution_time
+          DateTime :created_at
+          Integer :run_id
+          index :path
+          index :description
+        }
+      }
+      def self.create(connection)
+        if connection.tables.empty?
+          connection.transaction do
+            @@tables.each do |name,attributes|
+              connection.create_table(name, &attributes)
+            end
+          end
+        end
+      end
+    end
+  end
+end