probedock-rspec 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7eab1d34fa9237020aa501d102b8102f920aebec
-  data.tar.gz: 5251ca28e3eb843799327036d3a2adef17a2146a
+  metadata.gz: ba8bce3bce5176d6961dfd78fdae77bce895230b
+  data.tar.gz: 0d41a6542f22ea33dafd6a568aedf1813d117008
 SHA512:
-  metadata.gz: c118ffb9d5203145f5d84c5eb4302edd541a6ce5403a1abb115627203ca3344fedc8b639295df605127c0c10eea1153c9064c6b2132a13678b46be37b43999b0
-  data.tar.gz: 4cd6d2395d92343cdf8faa6e3f820dfb4d95c88b69ceb0aa701b1115bd51d3482211e1eb5bc8d89ef11c4dd2c34c5a007643fc55cbd412eb975ce6949c1bc666
+  metadata.gz: 6d9b15f140d29ba19baf020a257e9af6a5b2887b1df12ab514acb773586d26f8af9b3850420b21cac9a80c987246bc0375a8bf8a3e187361c802ba4d9f4184bf
+  data.tar.gz: 16160c7393aff207214bb62b7209533f872cd3b3e658651fc7c2cfee9084a3f54ecc46be9a028b953dc4eeb2b5589ab6519dc0f4986752fbf265d99930051cb8

data/Gemfile

@@ -4,13 +4,13 @@ source "http://rubygems.org"
 #   gem "activesupport", ">= 2.3.5"
 
 gem 'rspec', '~> 3.1'
-gem 'probedock-ruby', '~> 0.1'
+gem 'probedock-ruby', '~> 0.2.1'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem 'jeweler', '~> 2.0'
-  gem 'rake-version', '~> 0.4'
+  gem 'rake-version', '~> 1.0'
   gem 'simplecov', '~> 0.10', require: false
   gem 'fakefs', '~> 0.6', require: 'fakefs/safe'
   gem 'rspec-its', '~> 1.2'

data/README.md

@@ -1,6 +1,6 @@
-# Probe Dock RSpec
+# RSpec Probe for Probe Dock
 
-**RSpec probe for [Probe Dock](https://github.com/probedock/probedock).**
+**RSpec formatter to publish test results to [Probe Dock](https://github.com/probedock/probedock).**
 
 [![Gem Version](https://badge.fury.io/rb/probedock-rspec.svg)](http://badge.fury.io/rb/probedock-rspec)
 [![Dependency Status](https://gemnasium.com/probedock/probedock-rspec.svg)](https://gemnasium.com/probedock/probedock-rspec)
@@ -8,43 +8,36 @@
 [![Coverage Status](https://coveralls.io/repos/probedock/probedock-rspec/badge.svg)](https://coveralls.io/r/probedock/probedock-rspec?branch=master)
 [![License](https://img.shields.io/github/license/probedock/probedock-rspec.svg)](LICENSE.txt)
 
-## Requirements
+* [Requirements](#requirements)
+* [Installation](#installation)
+* [Usage](#usage)
+* [Contributing](#contributing)
 
-* RSpec 3+
 
-## Installation
 
-In your Gemfile:
-
-```rb
-gem 'probedock-rspec', '~> 0.6.0'
-```
+<a name="requirements"></a>
+## Requirements
 
-Manually:
+* Ruby 2+
+* RSpec 3+
 
-    gem install probedock-rspec
 
-## Usage
 
-If you haven't done it already, follow the [setup procedure](#setup) below.
+<a name="installation"></a>
+## Installation
 
-To track a test with a Probe Dock test key, use RSpec metadata:
+Add it to your Gemfile:
 
 ```rb
-it "should work", probedock: { key: 'abcdefghijkl' } do
-  expect(true).to be(true)
-end
-
-it(nil, probedock: { key: 'bcdefghijklm' }){ should validate_presence_of(:name) }
+gem 'probedock-rspec', '~> 0.7.0'
 ```
 
-<a name="setup"></a>
-## Setup
+Then run `bundle install`.
 
-You must first set up the configuration file(s) for the project.
+If you haven't done so already, set up your Probe Dock configuration file(s).
 This procedure is described here:
 
-* [Probe Setup Procedure](https://github.com/probedock/probedock-clients#setup-procedure)
+* [Probe Setup Procedure](https://github.com/probedock/probedock-probes#setup)
 
 You must then enable the client in your spec helper file (e.g. `spec/spec_helper.rb`).
 
@@ -60,6 +53,31 @@ end
 
 The next time you run your test suite, the RSpec probe will send the results to your Probe Dock server.
 
+
+
+<a name="usage"></a>
+## Usage
+
+To track a test with a Probe Dock test key, use RSpec metadata:
+
+```rb
+it "should work", probedock: { key: 'abcd' } do
+  expect(true).to be(true)
+end
+
+it(nil, probedock: { key: 'bcde' }){ should validate_presence_of(:name) }
+```
+
+You may also define a category, tags and tickets for a test like this:
+
+```rb
+it "should work", probedock: { key: 'cdef', category: 'Integration', tags: %w(user-registration validation), tickets: %w(JIRA-1000 JIRA-1012) } do
+  expect(2).to be < 3
+end
+```
+
+
+
 ## Contributing
 
 * [Fork](https://help.github.com/articles/fork-a-repo)
@@ -69,7 +87,8 @@ The next time you run your test suite, the RSpec probe will send the results to
 
 Please add a [changelog](CHANGELOG.md) entry with your name for new features and bug fixes.
 
+
+
 ## License
 
-Probe Dock RSpec is licensed under the [MIT License](http://opensource.org/licenses/MIT).
-See [LICENSE.txt](LICENSE.txt) for the full license.
+**probedock-rspec** is licensed under the [MIT License](http://opensource.org/licenses/MIT).

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/probe_dock_rspec/config.rb

@@ -1,9 +1,17 @@
 module ProbeDockRSpec
+  def self.config
+    @config ||= ProbeDockProbe::Config.new
+  end
+
+  def self.config= config
+    @config = config
+  end
 
   def self.configure options = {}, &block
-    ProbeDockProbe.config.load! &block
     setup! if options.fetch :setup, true
-    ProbeDockProbe.config
+    config.load! &block
+    config.project.category ||= 'RSpec'
+    config
   end
 
   private

data/lib/probe_dock_rspec/formatter.rb

@@ -11,7 +11,7 @@ module ProbeDockRSpec
 
     def initialize output
 
-      config = ProbeDockProbe.config
+      config = ProbeDockRSpec.config
       @client = ProbeDockProbe::Client.new config.server, config.client_options
       @test_run = ProbeDockProbe::TestRun.new config.project
 

data/lib/probe_dock_rspec/meta_parser.rb

@@ -7,28 +7,33 @@ module ProbeDockRSpec
 
       options = {}
 
-      %i(key category tags tickets data).each do |attr|
-        options[attr] = send "extract_#{attr}", example, groups
+      %i(key category tags tickets data active).each do |attr|
+        options[attr] = send("extract_#{attr}", example, groups)
       end
 
-      name_parts = extract_name_parts example, groups
-      options[:name] = name_parts.join ' '
-      options[:fingerprint] = Digest::SHA1.hexdigest name_parts.join('|||')
+      name_parts = extract_name_parts(example, groups)
+      options[:name] = name_parts.join(' ')
+      options[:fingerprint] = Digest::SHA1.hexdigest(name_parts.join('|||'))
+
+      data = options[:data]
+      metadata = example.metadata
 
       # TODO: remove once Probe Dock has been migrated to use fingerprints
-      options[:data]['fingerprint'] = options[:fingerprint]
+      data['fingerprint'] = options[:fingerprint]
+
+      data['file.path'] = metadata[:file_path].to_s.sub(/^\.\//, '') if metadata[:file_path]
+      data['file.line'] = metadata[:line_number] if metadata[:line_number]
 
       options
     end
 
     private
 
-    def self.extract_key example, groups = []
-      (groups.collect{ |g| meta(g)[:key] } << meta(example)[:key]).compact.reject{ |k| k.strip.empty? }.last
+    def self.extract_key(example, groups = [])
+      (groups.collect{ |g| probedock_meta(g)[:key] } << probedock_meta(example)[:key]).compact.reject{ |k| k.strip.empty? }.last
     end
 
-    def self.meta holder
-
+    def self.probedock_meta(holder)
       meta = holder.metadata[:probedock] || {}
 
       if meta.kind_of? String
@@ -40,25 +45,29 @@ module ProbeDockRSpec
       end
     end
 
-    def self.extract_name_parts example, groups = []
+    def self.extract_name_parts(example, groups = [])
       (groups.collect(&:description) << example.description).compact.collect(&:strip).reject{ |p| p.empty? }
     end
 
-    def self.extract_category example, groups = []
-      cat = (groups.collect{ |g| meta(g)[:category] } << meta(example)[:category]).compact.last
+    def self.extract_category(example, groups = [])
+      cat = (groups.collect{ |g| probedock_meta(g)[:category] } << probedock_meta(example)[:category]).compact.last
       cat ? cat.to_s : nil
     end
 
-    def self.extract_tags example, groups = []
-      (groups.collect{ |g| wrap meta(g)[:tags] } + (wrap meta(example)[:tags])).flatten.compact.uniq.collect(&:to_s)
+    def self.extract_active(example, groups = [])
+      (groups.collect{ |g| probedock_meta(g)[:active] } << probedock_meta(example)[:active]).compact.last
+    end
+
+    def self.extract_tags(example, groups = [])
+      (groups.collect{ |g| wrap probedock_meta(g)[:tags] } + (wrap probedock_meta(example)[:tags])).flatten.compact.uniq.collect(&:to_s)
     end
 
-    def self.extract_tickets example, groups = []
-      (groups.collect{ |g| wrap meta(g)[:tickets] } + (wrap meta(example)[:tickets])).flatten.compact.uniq.collect(&:to_s)
+    def self.extract_tickets(example, groups = [])
+      (groups.collect{ |g| wrap probedock_meta(g)[:tickets] } + (wrap probedock_meta(example)[:tickets])).flatten.compact.uniq.collect(&:to_s)
     end
 
-    def self.extract_data example, groups = []
-      meta(example)[:data] || {}
+    def self.extract_data(example, groups = [])
+      probedock_meta(example)[:data] || {}
     end
 
     def self.wrap a

data/lib/probe_dock_rspec.rb

@@ -3,7 +3,7 @@ require 'rspec'
 require 'probedock-ruby'
 
 module ProbeDockRSpec
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 
   class Error < StandardError; end
   class PayloadError < Error; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: probedock-rspec
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Simon Oulevay (Alpha Hydrae)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: RSpec client to publish test results to Probe Dock.