rox-client-rspec 0.3.1 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzNhOWE3OTM3ZGQxNTEzZWE4YmE2ODQ1NWFmZGE4ODE0NDM3MzZiZQ==
+    ZGQ4ZTQwZDMyM2M0NjI0M2VjMDU4MmZjYjMzOWZjY2FmZmYyMzhiZg==
   data.tar.gz: !binary |-
-    Y2Q5MGU2ZmMzM2NkM2VjMzZiYTNlOTJkYTYwMzFiNzM5YzIyOTFhNA==
+    YmIyYjVlOGMyZDg2ZmUwYzk0YzJmOTkzMGFjZWRiY2FhMTRmNTdkOA==
 SHA512:
   metadata.gz: !binary |-
-    YzRkN2E5OTcyNTE0MTczMTMyYjhkOGY1NDg1ODFjMzA2MzU4OTRkYjQ1NWY2
-    OGUxNWFhMWI0MzdkZjBmNzk1NmZjMDYzMzhkZDJiOWFlN2Q2MGFmMzgyOWY2
-    OGY3Mjk4Nzc1NzhhOWI4ZWJkNDMwMzJhN2YxZjU2Y2E1YjU2NzE=
+    MWZkOWQxMWMwMzFiNDhiNzE4MGRhNGRlNGQ5N2ZiYjQ4OTE1OTM5MmM5ZDg1
+    ZDYyNTg3NzkzZTkxYWZkODU5NjAyMGE3ZDQ0YmM4MDQzZGUzYTgxMzA0ZmM0
+    MDlhMmUxY2M0MTRiMGM3ZjNiN2JhZDhlNzc1Y2Y0MmZiYjM2ZWI=
   data.tar.gz: !binary |-
-    OGJjNTk5YzQ1YjExZTQ0ZmJhZDMyMjI2YmM2ZjlkOWI0ZTAzNmQwZDQ1NmRk
-    MTI3NzUzZWY3MzAyNzNkOWNkY2EzYmI1OTExOGZjYzU5ZDE1ZmFjM2ExMmJj
-    OTcxNmM3ZWFiOTZjZGZkZjgzN2E3MzU1NGZjMjZkYjM1NzA4Y2M=
+    NmUzMGI0YmYwODk0NWJjNDJkNDMyNTcxMGVlODg1MjFmY2UxZWMyZjQ1M2Iy
+    ZWJmMWFmMmEyMjFjZTM4ZjU5M2I1ZjJlZTU1ZjFlOGJmNDc4NDI4MDBlM2Fh
+    OWViMGVkM2E3YzA3ZTdkMjQ3MDE2MGIxNzljMmZmMDFlYTI5NmQ=

data/Gemfile

@@ -3,10 +3,10 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
-gem 'rspec', '~> 2.14'
+gem 'rspec', '~> 3.1'
 gem 'oj', '~> 2.1'
-gem 'httparty', '~> 0.11.0'
-gem 'paint', '~> 0.8.6'
+gem 'httparty', '~> 0.13'
+gem 'paint', '~> 0.8'
 gem 'rake', '~> 10.1'
 
 # Add dependencies to develop your gem here.
@@ -14,8 +14,9 @@ gem 'rake', '~> 10.1'
 group :development do
   gem 'bundler'
   gem 'jeweler'
-  gem 'geminabox'
   gem 'rake-version'
   gem 'simplecov'
   gem 'fakefs', require: 'fakefs/safe'
+  gem 'rspec-its'
+  gem 'rspec-collection_matchers'
 end

data/README.md

@@ -6,14 +6,15 @@
 
 ## Requirements
 
-* RSpec 2.14
+* RSpec 3.1 (0.4.0+)
+  * *RSpec 2.14 is supported up to version 0.3.1*
 
 ## Installation
 
 In your Gemfile:
 
 ```rb
-gem 'rox-client-rspec', '~> 0.3.0'
+gem 'rox-client-rspec', '~> 0.4.0'
 ```
 
 Manually:
@@ -32,7 +33,7 @@ Test keys are assigned to test using RSpec metadata:
 
 ```rb
 it "should work", rox: { key: 'abcdefghijkl' } do
-  expect(true).to be_true
+  expect(true).to be(true)
 end
 
 it(nil, rox: { key: 'bcdefghijklm' }){ should validate_presence_of(:name) }
@@ -41,67 +42,12 @@ it(nil, rox: { key: 'bcdefghijklm' }){ should validate_presence_of(:name) }
 <a name="setup"></a>
 ## Setup
 
-ROX clients use [YAML](http://yaml.org) files for configuration.
-To use the RSpec ROX Client, you need two configuration files and you must set up the client in your spec helper file.
+You must first set up the configuration file(s) for the project.
+This procedure is described in the [rox-client](https://github.com/lotaris/rox-client) repository:
 
-In your home folder, you must create the `~/.rox/config.yml` configuration file.
+* [ROX Center Client Configuration](https://github.com/lotaris/rox-client#setup-procedure)
 
-```yml
-# List of ROX Center servers you can submit test results to.
-servers:
-  rox.example.com:                        # A custom name for your ROX Center server.
-                                          # You will use this in the client configuration file.
-                                          # We recommend using the domain name where you deployed it.
-
-    apiUrl: https://rox.example.com/api   # The URL of your ROX Center server's API.
-                                          # This is the domain where you deployed it with /api.
-
-    apiKeyId: 39fuc7x85lsoy9c0ek2d        # Your user credentials on this server.
-    apiKeySecret: mwpqvvmagzoegxnqptxdaxkxonjmvrlctwcrfmowibqcpnsdqd
-
-# If true, test results will be uploaded to ROX Center.
-# Set to false to temporarily disable publishing.
-# You can change this at runtime from the command line by setting the
-# ROX_PUBLISH environment variable to 0 (false) or 1 (true).
-publish: true
-```
-
-In the project directory where you run RSpec, you must add the `rox.yml` client configuration file:
-
-```yml
-# Configuration specific to your project.
-project:
-  apiId: 154sic93pxs0   # The API key of your project in the ROX Center server.
-  version: 1.2.3
-
-# Where the client should store its temporary files.
-# The client will work without it but it is required for some advanced features.
-workspace: tmp/rox
-
-# Client advanced features.
-payload:
-  
-  # Saves a copy of the test payload sent to the ROX Center server for debugging.
-  # The file will be saved in rspec/servers/<SERVER_NAME>/payload.json.
-  save: false
-
-  # If you track a large number of tests (more than a thousand), enabling this
-  # will reduce the size of the test payloads sent to ROX Center server by caching
-  # test information that doesn't change often such as the name.
-  cache: false
-
-  # Prints a copy of the test payload sent to the ROX Center server for debugging.
-  # Temporarily enable at runtime by setting the ROX_PRINT_PAYLOAD environment variable to 1.
-  print: false
-
-# The name of the ROX Center server to upload test results to.
-# This name must be one of the server names in the ~/.rox/config.yml file.
-# You can change this at runtime from the command line by setting the
-# ROX_SERVER environment variable.
-server: rox.example.com
-```
-
-Finally, you must enable the client in your spec helper file (usually `spec/spec_helper.rb`).
+You must then enable the client in your spec helper file (e.g. `spec/spec_helper.rb`).
 
 ```yml
 RoxClient::RSpec.configure do |config|

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/rox-client-rspec.rb

@@ -4,7 +4,7 @@ require 'rspec'
 module RoxClient
 
   module RSpec
-    VERSION = '0.3.1'
+    VERSION = '0.4.0'
 
     class Error < StandardError; end
     class PayloadError < Error; end

data/lib/rox-client-rspec/cache.rb

@@ -34,11 +34,11 @@ module RoxClient::RSpec
     end
 
     def known? test_result
-      @tests[@project_api_id] && !!@tests[@project_api_id][test_result.key]
+      !!@tests[@project_api_id] && !!@tests[@project_api_id][test_result.key]
     end
 
     def stale? test_result
-      @tests[@project_api_id] && test_result_hash(test_result) != @tests[@project_api_id][test_result.key]
+      !!@tests[@project_api_id] && test_result_hash(test_result) != @tests[@project_api_id][test_result.key]
     end
 
     private

data/lib/rox-client-rspec/client.rb

@@ -18,7 +18,6 @@ module RoxClient::RSpec
 
     def process test_run
 
-      puts
       return fail "No server to publish results to" if !@server
 
       test_run.uid = @uid.load_uid
@@ -43,6 +42,8 @@ module RoxClient::RSpec
       save_payload payload if @save_payload
       print_payload payload if @print_payload
 
+      puts
+
       published
     end
 

data/lib/rox-client-rspec/formatter.rb

@@ -4,10 +4,12 @@ require 'rspec/core/formatters/base_formatter'
 
 module RoxClient::RSpec
 
-  class Formatter < RSpec::Core::Formatters::BaseFormatter
+  class Formatter
 
-    def initialize *args
-      super *args
+    RSpec::Core::Formatters.register self, :start, :stop, :close,
+      :example_group_started, :example_started, :example_passed, :example_failed, :example_group_finished
+
+    def initialize output
 
       config = RoxClient::RSpec.config
       @client = Client.new config.server, config.client_options
@@ -16,38 +18,38 @@ module RoxClient::RSpec
       @groups = []
     end
 
-    def start example_count
+    def start notification
       # TODO: measure milliseconds
       @start_time = Time.now
     end
 
-    def example_group_started group
-      @groups << group
+    def example_group_started group_notification
+      @groups << group_notification.group
     end
 
-    def example_group_finished group
+    def example_group_finished group_notification
       @groups.pop
     end
 
-    def example_started example
+    def example_started example_notification
       @current_time = Time.now
     end
 
-    def example_passed example
-      add_result example, true
+    def example_passed example_notification
+      add_result example_notification.example, true
     end
 
-    def example_failed example
-      add_result example, false
+    def example_failed example_notification
+      add_result example_notification.example, false
     end
 
-    def stop
+    def stop notification
       end_time = Time.now
       @test_run.end_time = end_time.to_i * 1000
       @test_run.duration = ((end_time - @start_time) * 1000).round
     end
 
-    def dump_summary duration, example_count, failure_count, pending_count
+    def close notification
       @client.process @test_run
     end
 

data/lib/rox-client-rspec/test_result.rb

@@ -2,7 +2,7 @@
 module RoxClient::RSpec
 
   class TestResult
-    attr_reader :key, :name, :category, :tags, :tickets, :duration, :message
+    attr_reader :key, :name, :category, :tags, :tickets, :data, :duration, :message
 
     def initialize project, example, groups = [], options = {}
 
@@ -12,7 +12,7 @@ module RoxClient::RSpec
 
       @grouped = extract_grouped example, groups
 
-      [ :key, :name, :category, :tags, :tickets ].each do |attr|
+      [ :key, :name, :category, :tags, :tickets, :data ].each do |attr|
         instance_variable_set "@#{attr}".to_sym, send("extract_#{attr}".to_sym, example, groups)
       end
 
@@ -51,6 +51,7 @@ module RoxClient::RSpec
         h['c'] = @category if stale or (first and @category)
         h['g'] = @tags if stale or (first and !@tags.empty?)
         h['t'] = @tickets if stale or (first and !@tickets.empty?)
+        h['a'] = @data if @data # FIXME: cache custom data
       end
     end
 
@@ -107,6 +108,10 @@ module RoxClient::RSpec
       (wrap(@tickets) + groups.collect{ |g| wrap meta(g)[:tickets] } + (wrap meta(example)[:tickets])).flatten.compact.uniq.collect(&:to_s)
     end
 
+    def extract_data example, groups = []
+      meta(example)[:data]
+    end
+
     def wrap a
       a.kind_of?(Array) ? a : [ a ]
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rox-client-rspec
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Simon Oulevay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-13 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: paint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.6
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: geminabox
+  name: rake-version
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake-version
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -151,7 +151,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakefs
+  name: rspec-its
+  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-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -208,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: RSpec extensions to send results to ROX Center.