rspec_profiling 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjZhODlmNmNlMDU5N2QxNTM3ZDEyMjUyMzViNWI5M2Q5ZjQ3OGU4MA==
-  data.tar.gz: !binary |-
-    ZjlhZjRiMDRiYmM0NDllNTcwMjA2M2M3M2U4MDJmZTJkNmU3NTAxNw==
+SHA1:
+  metadata.gz: 6bc728acea2819f10b80dabdb13491eaabe8a17c
+  data.tar.gz: a3777e5d205c41a13d5b2d7413d8ad897cbe84d9
 SHA512:
-  metadata.gz: !binary |-
-    MDNjMmFhYzIxNmNhODcwODkxODVmYzdjNmJkYTdkYTdhZWI4YjQzYzU1Nzk0
-    NzU3YTI4MTU0YjU0NGNkOGY0NjliY2JhMWQ3ZTZmYjE5ZWE1YTcyM2NjZWRi
-    YzJlMThmZWU1Y2NmNmVlNjg0NzEzM2UyMzllMWEzNThkMTg5MDA=
-  data.tar.gz: !binary |-
-    MjZlMjk0MTA2MjY3NzJhZTM2NmZmZmJlZTUwMjZmZjlmMzBiODFjNzRhNzAw
-    YTJjNTY1NjdiNGRiYmYwOWFiNjZhY2FkM2RhZTQyMjA1MDQ0MTU4Y2UxNTQ2
-    MDY1YTkwZmRhNTdiNTk3OWMxYTY4YmMyODBiNjEzN2MxMTQyYzg=
+  metadata.gz: fd7439d412650cdc9dc1be244d65b258f0397eed74e7ae43eaca1abd232b3d45d7a07e45668c0ff38355d4b03c204d33a31b10f6d9d0a88cecf118cbeb38eb21
+  data.tar.gz: ce31b48d6789a4695fd4befa270dbfc3d51dd539af4ded0822e1f34aef17d2f4851af71ce96ca6606742d075fe2c7f6f7726876fdf97f6a05fde654808875797

data/.ruby-gemset

@@ -0,0 +1 @@
+rspec_profiling

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/README.md

@@ -1,4 +1,4 @@
-# RSpecProfiling
+# RspecProfiling
 
 Collects profiles of RSpec test suites, enabling you to identify specs
 with interesting attributes. For example, find the slowest specs, or the
@@ -15,7 +15,7 @@ Collected attributes include:
 
 ## Compatibility
 
-RSpecProfiling should work with Rails >= 3.2 and RSpec >= 2.14.
+RspecProfiling should work with Rails >= 3.2 and RSpec >= 2.14.
 
 ## Installation
 
@@ -46,6 +46,34 @@ bundle exec rake rspec_profiling:install
 
 ## Usage
 
+### Choose a version control system
+
+Results are collected based on the version control system employed e.g. revision or commit SHA for `svn` and `git` respectively.
+
+#### Git
+
+By default, RspecProfiling expects Git as the version control system.
+
+#### Subversion
+
+RspecProfiling can be configured to use `svn` in `config/initializers/rspec_profiling.rb`:
+
+```Ruby
+RspecProfiling.configure do |config|
+  config.vcs = RspecProfiling::VCS::Svn
+end
+```
+
+#### Git / Subversion
+
+For those with a mixed project, with some developers using `git svn` and others regular `svn`, use this configuration to detect which is being used locally and behave accordingly.
+
+```Ruby
+RspecProfiling.configure do |config|
+  config.vcs = RspecProfiling::VCS::GitSvn
+end
+```
+
 ### Choose a results collector
 
 Results are collected just by running the specs.
@@ -55,7 +83,7 @@ Results are collected just by running the specs.
 By default, profiles are collected in an SQL database. Make sure you've
 run the installation rake task before attempting.
 
-You can review results by running the RSpecProfiling console.
+You can review results by running the RspecProfiling console.
 
 ```
 bundle exec rake rspec_profiling:console
@@ -76,15 +104,12 @@ results.count
 
 #### CSV
 
-You can configure `RSpecProfiling` to collect results in a CSV in your
-`spec_helper.rb` file.
+You can configure `RspecProfiling` to collect results in a CSV in `config/initializers/rspec_profiling.rb`:
 
 ```Ruby
-RSpecProfiling.configure do |config|
-  config.collector = RSpecProfiling::Collectors::CSV
+RspecProfiling.configure do |config|
+  config.collector = RspecProfiling::Collectors::CSV
 end
-
-require "rspec_profiling/rspec"
 ```
 
 By default, the CSV is output to `cat tmp/spec_benchmarks.csv`.
@@ -92,12 +117,22 @@ Rerunning spec will overwrite the file. You can customize the CSV path
 to, for example, include the sample time.
 
 ```Ruby
-RSpecProfiling.configure do |config|
-  config.collector = RSpecProfiling::Collectors::CSV
+RspecProfiling.configure do |config|
+  config.collector = RspecProfiling::Collectors::CSV
   config.csv_path = ->{ "tmp/spec_benchmark_#{Time.now.to_i}" }
 end
+```
 
-require "rspec_profiling/rspec"
+#### Postgresql
+
+You can configure `RspecProfiling` to collect results in a Postgres database
+in your `spec_helper.rb` file.
+
+```Ruby
+RspecProfiling.configure do |config|
+  config.collector = RspecProfiling::Collectors::PSQL
+  config.db_path   = 'profiling'
+end
 ```
 
 ## Configuration Options
@@ -105,7 +140,7 @@ require "rspec_profiling/rspec"
 Configuration is performed like this:
 
 ```Ruby
-RSpecProfiling.configure do |config|
+RspecProfiling.configure do |config|
   config.<option> = <something>
 end
 ```
@@ -115,11 +150,11 @@ end
 - `db_path` - the location of the SQLite database file
 - `table_name` - the database table name in which results are stored
 - `csv_path` - the directory in which CSV files are dumped
+- `collector` - collector to use
 
 ## Uninstalling
 
-To remove the results database, run `bundle exec rake
-rspec_profiling:uninstall`.
+To remove the results database, run `bundle exec rake rspec_profiling:uninstall`.
 
 ## Contributing
 

data/lib/rspec_profiling.rb

@@ -4,7 +4,11 @@ require "rspec_profiling/config"
 require "rspec_profiling/version"
 require "rspec_profiling/run"
 require "rspec_profiling/collectors/csv"
-require "rspec_profiling/collectors/database"
+require "rspec_profiling/collectors/sql"
+require "rspec_profiling/collectors/psql"
+require "rspec_profiling/vcs/git"
+require "rspec_profiling/vcs/svn"
+require "rspec_profiling/vcs/git_svn"
 
 module RspecProfiling
   class Railtie < Rails::Railtie

data/lib/rspec_profiling/collectors/csv.rb

@@ -30,6 +30,10 @@ module RspecProfiling
         # no op
       end
 
+      def initialize
+        RspecProfiling.config.csv_path ||= 'tmp/spec_benchmarks.csv'
+      end
+
       def insert(attributes)
         output << HEADERS.map do |field|
           attributes.fetch(field.to_sym)

data/lib/rspec_profiling/collectors/psql.rb

@@ -0,0 +1,106 @@
+require "pg"
+require "active_record"
+
+module RspecProfiling
+  module Collectors
+    class PSQL
+      def self.install
+        new.install
+      end
+
+      def self.uninstall
+        new.uninstall
+      end
+
+      def self.reset
+        new.results.destroy_all
+      end
+
+      def initialize
+        RspecProfiling.config.db_path ||= 'rspec_profiling'
+        establish_connection
+      end
+
+      def install
+        return if prepared?
+
+        connection.create_table(table) do |t|
+          t.string    :commit
+          t.datetime  :date
+          t.text      :file
+          t.integer   :line_number
+          t.text      :description
+          t.decimal   :time
+          t.string    :status
+          t.text      :exception
+          t.integer   :query_count
+          t.decimal   :query_time
+          t.integer   :request_count
+          t.decimal   :request_time
+          t.timestamps null: true
+        end
+      end
+
+      def uninstall
+        connection.drop_table(table)
+      end
+
+      def insert(attributes)
+        results.create!(attributes.except(:created_at))
+      end
+
+      def results
+        @results ||= begin
+          establish_connection
+
+          Result.table_name = table
+          Result.attr_protected if Result.respond_to?(:attr_protected)
+          Result
+        end
+      end
+
+      private
+
+      def prepared?
+        connection.table_exists?(table)
+      end
+
+      def connection
+        @connection ||= results.connection
+      end
+
+      def establish_connection
+        begin
+          PG.connect(dbname: 'postgres').exec("CREATE DATABASE #{database}")
+        rescue PG::DuplicateDatabase
+          # no op
+        end
+
+        Result.establish_connection(
+          :adapter  => 'postgresql',
+          :database => database
+        )
+      end
+
+      def table
+        RspecProfiling.config.table_name
+      end
+
+      def database
+        RspecProfiling.config.db_path
+      end
+
+      class Result < ActiveRecord::Base
+        def to_s
+          [description, location].join(" - ")
+        end
+
+        private
+
+        def location
+          [file, line_number].join(":")
+        end
+      end
+    end
+  end
+end

data/lib/rspec_profiling/collectors/{database.rb → sql.rb}

@@ -3,7 +3,7 @@ require "active_record"
 
 module RspecProfiling
   module Collectors
-    class Database
+    class SQL
       def self.install
         new.install
       end
@@ -17,6 +17,7 @@ module RspecProfiling
       end
 
       def initialize
+        RspecProfiling.config.db_path ||= 'tmp/rspec_profiling'
         establish_connection
       end
 
@@ -36,7 +37,7 @@ module RspecProfiling
           t.decimal   :query_time
           t.integer   :request_count
           t.decimal   :request_time
-          t.timestamps
+          t.timestamps null: true
         end
       end
 
@@ -70,7 +71,7 @@ module RspecProfiling
 
       def establish_connection
         Result.establish_connection(
-          :adapter  => "sqlite3",
+          :adapter  => 'sqlite3',
           :database => database
         )
       end

data/lib/rspec_profiling/config.rb

@@ -5,10 +5,9 @@ module RspecProfiling
 
   def self.config
     @config ||= OpenStruct.new({
-      collector:  RspecProfiling::Collectors::Database,
-      db_path:    'tmp/rspec_profiling',
-      table_name: 'spec_profiling_results',
-      csv_path:   Proc.new { 'tmp/spec_benchmarks.csv' }
+      collector:  RspecProfiling::Collectors::SQL,
+      vcs:        RspecProfiling::VCS::Git,
+      table_name: 'spec_profiling_results'
     })
   end
 end

data/lib/rspec_profiling/rspec.rb

@@ -1,9 +1,14 @@
 require "rspec_profiling"
 
 RSpec.configure do |config|
-  config.reporter.register_listener RspecProfiling::Run.new(RspecProfiling.config.collector.new),
+  runner = RspecProfiling::Run.new(RspecProfiling.config.collector.new, 
+                                   RspecProfiling.config.vcs.new)
+
+  config.reporter.register_listener(
+    runner,
     :start,
     :example_started,
     :example_passed,
     :example_failed
+  )
 end

data/lib/rspec_profiling/run.rb

@@ -1,10 +1,18 @@
 require "rspec_profiling/example"
-require "rspec_profiling/current_commit"
+require "rspec_profiling/vcs/git"
+require "rspec_profiling/vcs/svn"
+require "rspec_profiling/vcs/git_svn"
+require "rspec_profiling/collectors/sql"
+require "rspec_profiling/collectors/psql"
+require "rspec_profiling/collectors/csv"
 
 module RspecProfiling
   class Run
-    def initialize(collector)
+    def initialize(collector = RspecProfiling.config.collector.new,
+                   vcs = RspecProfiling.config.vcs.new)
+
       @collector = collector
+      @vcs       = vcs
     end
 
     def start(*args)
@@ -19,8 +27,8 @@ module RspecProfiling
 
     def example_finished(*args)
       collector.insert({
-        commit:        CurrentCommit.sha,
-        date:          CurrentCommit.time,
+        commit:        vcs.sha,
+        date:          vcs.time,
         file:          @current_example.file,
         line_number:   @current_example.line_number,
         description:   @current_example.description,
@@ -39,7 +47,7 @@ module RspecProfiling
 
     private
 
-    attr_reader :collector
+    attr_reader :collector, :vcs
 
     def start_counting_queries
       ActiveSupport::Notifications.subscribe("sql.active_record") do |name, start, finish, id, query|

data/lib/rspec_profiling/vcs/git.rb

@@ -0,0 +1,15 @@
+require 'time'
+
+module RspecProfiling
+  module VCS
+    class Git
+      def sha
+        `git rev-parse HEAD`
+      end
+
+      def time
+        Time.parse `git show -s --format=%ci #{sha}`
+      end
+    end
+  end
+end

data/lib/rspec_profiling/vcs/git_svn.rb

@@ -0,0 +1,29 @@
+require 'time'
+
+module RspecProfiling
+  module VCS
+    class GitSvn
+      # returns nil if using `git svn`
+      def version_control
+        `[ -d .git/svn  ] && [ x != x"$(ls -A .git/svn/)" ]`
+        RspecProfiling::VCS::Svn unless $CHILD_STATUS.success?
+      end
+
+      def sha
+        if version_control.nil?
+          `git svn info | grep "Revision" | cut -f2 -d' '`
+        else
+          `svn info -r 'HEAD' | grep "Revision" | cut -f2 -d' '`
+        end
+      end
+
+      def time
+        if version_control.nil?
+          Time.parse `git svn info | grep "Last Changed Date" | cut -f4,5,6 -d' '`
+        else
+          Time.parse `svn info -r 'HEAD' | grep "Last Changed Date" | cut -f4,5,6 -d' '`
+        end
+      end
+    end
+  end
+end

data/lib/rspec_profiling/vcs/svn.rb

@@ -0,0 +1,15 @@
+require 'time'
+
+module RspecProfiling
+  module VCS
+    class Svn
+      def sha
+        `svn info -r 'HEAD' | grep "Revision" | cut -f2 -d' '`
+      end
+
+      def time
+        Time.parse `svn info -r 'HEAD' | grep "Last Changed Date" | cut -f4,5,6 -d' '`
+      end
+    end
+  end
+end

data/lib/rspec_profiling/version.rb

@@ -1,3 +1,3 @@
 module RspecProfiling
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/tasks/rspec_profiling.rake

@@ -2,16 +2,16 @@ require 'rake'
 
 namespace :rspec_profiling do
   desc "Install the collector"
-  task :install do
+  task install: :environment do
     collector.install
   end
 
   desc "Uninstall the collector"
-  task :uninstall do
+  task uninstall: :environment do
     collector.uninstall
   end
 
-  task :console do
+  task console: :environment do
     require 'irb'
     require 'irb/completion'
     require 'rspec_profiling'

data/rspec_profiling.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "sqlite3"
   spec.add_dependency "activerecord"
+  spec.add_dependency "pg"
+  spec.add_dependency "rails"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/spec/collectors/{database_spec.rb → psql_spec.rb}

@@ -1,11 +1,11 @@
 require "rspec_profiling/config"
-require "rspec_profiling/collectors/database"
+require "rspec_profiling/collectors/psql"
 
 module RspecProfiling
   module Collectors
-    describe Database do
-      before(:all) { Database.install }
-      after(:all)  { Database.uninstall }
+    describe PSQL do
+      before(:all) { described_class.install }
+      after(:all)  { described_class.uninstall }
 
       describe "#insert" do
         let(:collector) { described_class.new }
@@ -37,7 +37,7 @@ module RspecProfiling
         end
 
         it "records the commit date" do
-          expect(result.commit_date).to eq Time.utc(2012, 12, 18, 12)
+          expect(result.date).to eq Time.utc(2012, 12, 18, 12)
         end
 
         it "records the file" do

data/spec/collectors/sql_spec.rb

@@ -0,0 +1,85 @@
+require "rspec_profiling/config"
+require "rspec_profiling/collectors/sql"
+
+module RspecProfiling
+  module Collectors
+    describe SQL do
+      before(:all) { described_class.install }
+      after(:all)  { described_class.uninstall }
+
+      describe "#insert" do
+        let(:collector) { described_class.new }
+        let(:result)    { collector.results.first }
+
+        before do
+          collector.insert({
+            commit: "ABC123",
+            date: "Thu Dec 18 12:00:00 2012",
+            file: "/some/file.rb",
+            line_number: 10,
+            description: "Some spec",
+            time: 100,
+            status: :passed,
+            exception: "some issue",
+            query_count: 10,
+            query_time: 50,
+            request_count: 1,
+            request_time: 400
+          })
+        end
+
+        it "records a single result" do
+          expect(collector.results.count).to eq 1
+        end
+
+        it "records the commit SHA" do
+          expect(result.commit).to eq "ABC123"
+        end
+
+        it "records the commit date" do
+          expect(result.date).to eq Time.utc(2012, 12, 18, 12)
+        end
+
+        it "records the file" do
+          expect(result.file).to eq "/some/file.rb"
+        end
+
+        it "records the line number" do
+          expect(result.line_number).to eq 10
+        end
+
+        it "records the description" do
+          expect(result.description).to eq "Some spec"
+        end
+
+        it "records the time" do
+          expect(result.time).to eq 100.0
+        end
+
+        it "records the passing status" do
+          expect(result.status).to eq 'passed'
+        end
+
+        it "records the exception" do
+          expect(result.exception). to eq 'some issue'
+        end
+
+        it "records the query count" do
+          expect(result.query_count).to eq 10
+        end
+
+        it "records the query time" do
+          expect(result.query_time).to eq 50
+        end
+
+        it "records the request count" do
+          expect(result.request_count).to eq 1
+        end
+
+        it "records the request time" do
+          expect(result.request_time).to eq 400
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,83 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: rspec_profiling
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Ben Eddy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Profile RSpec test suites
@@ -87,25 +115,31 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/rspec_profiling.rb
 - lib/rspec_profiling/collectors/csv.rb
-- lib/rspec_profiling/collectors/database.rb
+- lib/rspec_profiling/collectors/psql.rb
+- lib/rspec_profiling/collectors/sql.rb
 - lib/rspec_profiling/config.rb
 - lib/rspec_profiling/console.rb
-- lib/rspec_profiling/current_commit.rb
 - lib/rspec_profiling/example.rb
 - lib/rspec_profiling/rspec.rb
 - lib/rspec_profiling/run.rb
+- lib/rspec_profiling/vcs/git.rb
+- lib/rspec_profiling/vcs/git_svn.rb
+- lib/rspec_profiling/vcs/svn.rb
 - lib/rspec_profiling/version.rb
 - lib/tasks/rspec_profiling.rake
 - rspec_profiling
 - rspec_profiling.gemspec
-- spec/collectors/database_spec.rb
+- spec/collectors/psql_spec.rb
+- spec/collectors/sql_spec.rb
 - spec/run_spec.rb
 homepage: https://github.com/foraker/rspec_profiling
 licenses:
@@ -117,20 +151,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Profile RSpec test suites
 test_files:
-- spec/collectors/database_spec.rb
+- spec/collectors/psql_spec.rb
+- spec/collectors/sql_spec.rb
 - spec/run_spec.rb

data/lib/rspec_profiling/current_commit.rb

@@ -1,28 +0,0 @@
-require "time"
-
-module RspecProfiling
-  module CurrentCommit
-    extend self
-
-    def git?
-      `git rev-parse 2>&1`
-      $?.success?
-    end
-
-    def sha
-      if git?
-        `git rev-parse HEAD`
-      else
-        `svn info -r 'HEAD' | grep "Revision" | cut -f2 -d' '`
-      end
-    end
-
-    def time
-      if git?
-        Time.parse `git show -s --format=%ci #{sha}`
-      else
-        Time.parse `svn info -r 'HEAD' | grep "Last Changed Date" | cut -f4,5,6 -d' '`
-      end
-    end
-  end
-end