rspec_profiling 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bc728acea2819f10b80dabdb13491eaabe8a17c
-  data.tar.gz: a3777e5d205c41a13d5b2d7413d8ad897cbe84d9
+  metadata.gz: fc2c3039e171c0935a2c938945e538e5ca46f1c2
+  data.tar.gz: bf4e57b9289fe5a396084b0e80a836586259ad2c
 SHA512:
-  metadata.gz: fd7439d412650cdc9dc1be244d65b258f0397eed74e7ae43eaca1abd232b3d45d7a07e45668c0ff38355d4b03c204d33a31b10f6d9d0a88cecf118cbeb38eb21
-  data.tar.gz: ce31b48d6789a4695fd4befa270dbfc3d51dd539af4ded0822e1f34aef17d2f4851af71ce96ca6606742d075fe2c7f6f7726876fdf97f6a05fde654808875797
+  metadata.gz: 526049fc2f4db27873427c16cde7da2ab1a1abc87f513fac462fdef5c96aad5f214cb2a59658a4d04ee9fe0faf1c9ecaf577b76829cbefab2f914d54fd3ecea1
+  data.tar.gz: ba80e7353e2b5f1b2187a08172a2b4bc280b16aaee9a79de1c99ac1db7f3f306e2b8de10a09b0c2ba9910e5e0f5f2d1b0380df16bbb66725f994e964a9884d1b

data/README.md

@@ -84,24 +84,32 @@ 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.
+The console has a preloaded `results` variable.
 
 ```
 bundle exec rake rspec_profiling:console
 
 > results.count
 => 1970
+```
 
+You can find the spec that runs the most queries:
+
+```
 > results.order(:query_count).last.to_s
 => "Updating my account - ./spec/features/account_spec.rb:15"
 ```
 
-The console has a preloaded `results` variable.
+Or find the spec that takes the most time:
 
 ```
-results.count
-> 180
+> results.order(:time).last.to_s
+=> "Updating my account - ./spec/features/account_spec.rb:15"
 ```
 
+There are additional attributes available on the `Result` instances to enable
+debugging, such as `exception` and `status`.
+
 #### CSV
 
 You can configure `RspecProfiling` to collect results in a CSV in `config/initializers/rspec_profiling.rb`:
@@ -152,6 +160,17 @@ end
 - `csv_path` - the directory in which CSV files are dumped
 - `collector` - collector to use
 
+### Usage in a script
+
+If you want to access the results from a Ruby script instead of the `rake rspec_profiling:console` shell command:
+
+```ruby
+require 'rspec_profiling'
+require 'rspec_profiling/console'
+```
+
+Then `results` will be available as a variable to the script. 
+
 ## Uninstalling
 
 To remove the results database, run `bundle exec rake rspec_profiling:uninstall`.
@@ -166,8 +185,8 @@ To remove the results database, run `bundle exec rake rspec_profiling:uninstall`
 
 ## About Foraker Labs
 
-<img src="http://assets.foraker.com/foraker_logo.png" width="400" height="62">
+![Foraker Logo](http://assets.foraker.com/attribution_logo.png)
 
-This project is maintained by Foraker Labs. The names and logos of Foraker Labs are fully owned and copyright Foraker Design, LLC.
+Foraker Labs builds exciting web and mobile apps in Boulder, CO. Our work powers a wide variety of businesses with many different needs. We love open source software, and we're proud to contribute where we can. Interested to learn more? [Contact us today](https://www.foraker.com/contact-us).
 
-Foraker Labs is a Boulder-based Ruby on Rails and iOS development shop. Please reach out if we can [help build your product](http://www.foraker.com).
+This project is maintained by Foraker Labs. The names and logos of Foraker Labs are fully owned and copyright Foraker Design, LLC.

data/lib/rspec_profiling/collectors/csv.rb

@@ -4,6 +4,7 @@ module RspecProfiling
   module Collectors
     class CSV
       HEADERS = %w{
+        branch
         commit
         date
         file

data/lib/rspec_profiling/collectors/psql.rb

@@ -25,6 +25,7 @@ module RspecProfiling
         return if prepared?
 
         connection.create_table(table) do |t|
+          t.string    :branch
           t.string    :commit
           t.datetime  :date
           t.text      :file

data/lib/rspec_profiling/collectors/sql.rb

@@ -25,6 +25,7 @@ module RspecProfiling
         return if prepared?
 
         connection.create_table(table) do |t|
+          t.string    :branch
           t.string    :commit
           t.datetime  :date
           t.text      :file

data/lib/rspec_profiling/run.rb

@@ -27,6 +27,7 @@ module RspecProfiling
 
     def example_finished(*args)
       collector.insert({
+        branch:        vcs.branch,
         commit:        vcs.sha,
         date:          vcs.time,
         file:          @current_example.file,

data/lib/rspec_profiling/vcs/git.rb

@@ -3,6 +3,10 @@ require 'time'
 module RspecProfiling
   module VCS
     class Git
+      def branch
+        `git rev-parse --abbrev-ref HEAD`
+      end
+
       def sha
         `git rev-parse HEAD`
       end

data/lib/rspec_profiling/vcs/git_svn.rb

@@ -9,6 +9,10 @@ module RspecProfiling
         RspecProfiling::VCS::Svn unless $CHILD_STATUS.success?
       end
 
+      def branch
+        nil
+      end
+
       def sha
         if version_control.nil?
           `git svn info | grep "Revision" | cut -f2 -d' '`

data/lib/rspec_profiling/vcs/svn.rb

@@ -3,6 +3,10 @@ require 'time'
 module RspecProfiling
   module VCS
     class Svn
+      def branch
+        nil
+      end
+
       def sha
         `svn info -r 'HEAD' | grep "Revision" | cut -f2 -d' '`
       end

data/lib/rspec_profiling/version.rb

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

data/spec/collectors/psql_spec.rb

@@ -13,6 +13,7 @@ module RspecProfiling
 
         before do
           collector.insert({
+            branch: "master",
             commit: "ABC123",
             date: "Thu Dec 18 12:00:00 2012",
             file: "/some/file.rb",
@@ -32,6 +33,10 @@ module RspecProfiling
           expect(collector.results.count).to eq 1
         end
 
+        it "records the branch name" do
+          expect(result.branch).to eq "master"
+        end
+
         it "records the commit SHA" do
           expect(result.commit).to eq "ABC123"
         end

data/spec/collectors/sql_spec.rb

@@ -13,6 +13,7 @@ module RspecProfiling
 
         before do
           collector.insert({
+            branch: "master",
             commit: "ABC123",
             date: "Thu Dec 18 12:00:00 2012",
             file: "/some/file.rb",
@@ -32,6 +33,10 @@ module RspecProfiling
           expect(collector.results.count).to eq 1
         end
 
+        it "records the branch name" do
+          expect(result.branch).to eq "master"
+        end
+
         it "records the commit SHA" do
           expect(result.commit).to eq "ABC123"
         end

data/spec/run_spec.rb

@@ -19,14 +19,9 @@ module RspecProfiling
 
     describe "#run_example" do
       let(:collector) { CollectorDouble.new }
-      let(:run)       { described_class.new(collector) }
+      let(:vcs) { VcsDouble.new }
+      let(:run)       { described_class.new(collector, vcs) }
       let(:result)    { collector.results.first }
-      let(:commit) do
-        double({
-          commit: "abc123",
-          time: Time.new(2012, 12, 12)
-        })
-      end
       let(:example) do
         ExampleDouble.new({
           file_path: "/something_spec.rb",
@@ -45,7 +40,6 @@ module RspecProfiling
       end
 
       before do
-        stub_const("RspecProfiling::CurrentCommit", commit)
         stub_const("ActiveSupport::Notifications", Notifications.new)
         simulate_test_suite_run
       end
@@ -54,6 +48,14 @@ module RspecProfiling
         expect(collector.count).to eq 1
       end
 
+      it "records the branch name" do
+        expect(result.branch).to eq "master"
+      end
+
+      it "records the commit SHA" do
+        expect(result.commit).to eq "abc123"
+      end
+
       it "counts two queries" do
         expect(result.query_count).to eq 2
       end
@@ -103,6 +105,20 @@ module RspecProfiling
       end
     end
 
+    class VcsDouble
+      def branch
+        "master"
+      end
+
+      def sha
+        "abc123"
+      end
+
+      def time
+        0.1
+      end
+    end
+
     class ExampleDouble
       attr_reader :metadata
 

data/spec/vcs/git_spec.rb

@@ -0,0 +1,27 @@
+require "rspec_profiling/vcs/git"
+
+module RspecProfiling
+  describe VCS::Git do
+    describe "#branch" do
+      it "calls Git to get the current branch" do
+        expect(subject).to receive(:`).with("git rev-parse --abbrev-ref HEAD").and_return("master")
+        expect(subject.branch).to eq "master"
+      end
+    end
+
+    describe "#sha" do
+      it "calls Git to get the current commit's SHA" do
+        expect(subject).to receive(:`).with("git rev-parse HEAD").and_return("abc123")
+        expect(subject.sha).to eq "abc123"
+      end
+    end
+
+    describe "#time" do
+      it "calls Git to get the current commit's datetime" do
+        expect(subject).to receive(:`).with("git rev-parse HEAD").and_return("abc123")
+        expect(subject).to receive(:`).with("git show -s --format=%ci abc123").and_return("2017-01-31")
+        expect(subject.time).to eq Time.parse("2017-01-31")
+      end
+    end
+  end
+end

data/spec/vcs/svn_spec.rb

@@ -0,0 +1,25 @@
+require "rspec_profiling/vcs/svn"
+
+module RspecProfiling
+  describe VCS::Svn do
+    describe "#branch" do
+      it "calls Git to get the current branch" do
+        expect(subject.branch).to be_nil
+      end
+    end
+
+    describe "#sha" do
+      it "calls Git to get the current commit's SHA" do
+        expect(subject).to receive(:`).with("svn info -r 'HEAD' | grep \"Revision\" | cut -f2 -d' '").and_return("abc123")
+        expect(subject.sha).to eq "abc123"
+      end
+    end
+
+    describe "#time" do
+      it "calls Git to get the current commit's datetime" do
+        expect(subject).to receive(:`).with("svn info -r 'HEAD' | grep \"Last Changed Date\" | cut -f4,5,6 -d' '").and_return("2017-01-31")
+        expect(subject.time).to eq Time.parse("2017-01-31")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_profiling
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ben Eddy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -141,6 +141,8 @@ files:
 - spec/collectors/psql_spec.rb
 - spec/collectors/sql_spec.rb
 - spec/run_spec.rb
+- spec/vcs/git_spec.rb
+- spec/vcs/svn_spec.rb
 homepage: https://github.com/foraker/rspec_profiling
 licenses:
 - MIT
@@ -161,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Profile RSpec test suites
@@ -169,3 +171,5 @@ test_files:
 - spec/collectors/psql_spec.rb
 - spec/collectors/sql_spec.rb
 - spec/run_spec.rb
+- spec/vcs/git_spec.rb
+- spec/vcs/svn_spec.rb