blinkspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bdd4e2d26ff72dd8721bb07b871e7986d4a01bb
+  data.tar.gz: 4e54abe62716a9877234d481d12fc185c6159aa7
+SHA512:
+  metadata.gz: bc87914f380bda67bef4de81fe10fb3add153167fd90e3f4654baba37dd57303a9ce22b841525c2b244c6530cdb14673cba0e88c47d5efad7234a517959c3b5d
+  data.tar.gz: 43158c06f78f996c9939ec5d0fc4df4d8f0c624e35a15a592f04a013051ceba25cab30be40378be9110142666ca5c1168968ec1eefa4a5bf3a4996150c1c0430

data/.gitignore

@@ -0,0 +1,5 @@
+blinkspec-*.gem
+.DS_Store
+Gemfile.lock
+blinkspec.json
+.bundle/**

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+
+notifications:
+  email:
+    recipients:
+      - lukas.nagl@innovaptor.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lukas Nagl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,28 @@
+# blinkspec
+
+[![Build Status](https://travis-ci.org/j4zz/blinkspec.svg)](https://travis-ci.org/j4zz/blinkspec)
+
+`blinkspec` is a ruby gem that was created to utilize the [blink(1)](http://blink1.thingm.com/) USB RGB LED by ThingM when executing long-running [rspec](http://www.relishapp.com/rspec) tests.
+
+With blinkspec, you can run your specs just like you’re used to, and your blink(1) will indicate that:
+
+  * Your specs are still running.
+  * `blinkspec` detected an error in your specs while running.
+  * Your specs have finished running and are either all green, have pending specs left or have failing specs left.
+
+## Installation
+
+`gem install blinkspec`
+
+## Usage
+
+Just replace your use of `bundle exec rspec` with `blinkspec` and you’re good to go. All regular rspec arguments are supported except for format parameters.
+
+```
+blinkspec spec/
+blinkspec spec/ --tag debug
+```
+
+# Contributing
+
+Any pull request of any size is welcome! :)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rspec/core/rake_task'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task default: :spec

data/bin/blinkspec

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'blinkspec'
+require 'pry'
+
+# Allow String to be easily colorized
+class String
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+end
+
+blinkspec = BlinkSpec::BlinkSpecRunner.new
+success, pending, failed = blinkspec.run_specs(ARGV.join(' '))
+exit 1 if success.nil?
+
+puts "Success: #{success.to_s.green} Pending: #{pending.to_s.yellow} Failed: #{failed.to_s.red}"
+
+if failed > 0
+  system("blink1-tool --glimmer --rgb=#{BlinkSpec::BlinkColor.fail}")
+elsif pending > 0
+  system("blink1-tool --glimmer --rgb=#{BlinkSpec::BlinkColor.pending}")
+else
+  system("blink1-tool --glimmer --rgb=#{BlinkSpec::BlinkColor.success}")
+end

data/blinkspec.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = "blinkspec"
+  s.version     = "0.0.1"
+  s.date        = "2015-07-27"
+  s.summary     = "Run your specs with blink(1) feedback."
+  s.description = "Run your specs with beautiful output and blink(1) signals"
+  s.authors     = ["Lukas Nagl"]
+  s.email       = "lukas.nagl@innovaptor.com"
+  s.homepage    = "https://github.com/j4zz/blinkspec"
+  s.license     = "MIT"
+  # Done with descriptive fields.
+  s.rubyforge_project = "blinkspec"
+  s.files       = ["bin/blinkspec"]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables << "blinkspec"
+  s.require_paths = ["lib"]
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'pry', '~> 0.10'
+  s.add_development_dependency 'rake', '~> 10.3'
+  s.add_development_dependency 'bundler'
+end

data/fixtures/blinkspec_fixture.json

@@ -0,0 +1 @@
+{"messages":["Run options: include {:dbg=>true}"],"examples":[{"description":"failure","full_description":"BlinkSpec::BlinkSpecRunner blinkspec fixtures failure","status":"failed","file_path":"./spec/blinkspec_spec.rb","line_number":5,"run_time":0.001606,"exception":{"class":"RSpec::Expectations::ExpectationNotMetError","message":"\nexpected: false\n     got: true\n\n(compared using ==)\n","backtrace":["/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-expectations-3.2.1/lib/rspec/expectations/fail_with.rb:29:in `fail_with'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-expectations-3.2.1/lib/rspec/expectations/handler.rb:38:in `handle_failure'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-expectations-3.2.1/lib/rspec/expectations/handler.rb:50:in `block in handle_matcher'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-expectations-3.2.1/lib/rspec/expectations/handler.rb:27:in `with_matcher'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-expectations-3.2.1/lib/rspec/expectations/handler.rb:48:in `handle_matcher'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-expectations-3.2.1/lib/rspec/expectations/expectation_target.rb:54:in `to'","/Users/lukas/Innovaptor/workspaces/blinkspec/spec/blinkspec_spec.rb:6:in `block (3 levels) in <top (required)>'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example.rb:177:in `instance_exec'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example.rb:177:in `block in run'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example.rb:385:in `block in with_around_and_singleton_context_hooks'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example.rb:343:in `block in with_around_example_hooks'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/hooks.rb:474:in `block in run'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/hooks.rb:612:in `run_around_example_hooks_for'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/hooks.rb:474:in `run'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example.rb:343:in `with_around_example_hooks'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example.rb:385:in `with_around_and_singleton_context_hooks'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example.rb:174:in `run'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example_group.rb:549:in `block in run_examples'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example_group.rb:545:in `map'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example_group.rb:545:in `run_examples'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example_group.rb:512:in `run'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example_group.rb:513:in `block in run'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example_group.rb:513:in `map'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/example_group.rb:513:in `run'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb:110:in `block (3 levels) in run_specs'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb:110:in `map'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb:110:in `block (2 levels) in run_specs'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/configuration.rb:1526:in `with_suite_hooks'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb:109:in `block in run_specs'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/reporter.rb:62:in `report'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb:108:in `run_specs'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb:86:in `run'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb:70:in `run'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/lib/rspec/core/runner.rb:38:in `invoke'","/Users/lukas/.rvm/gems/ruby-2.1.5/gems/rspec-core-3.2.3/exe/rspec:4:in `<top (required)>'","/Users/lukas/.rvm/gems/ruby-2.1.5/bin/rspec:23:in `load'","/Users/lukas/.rvm/gems/ruby-2.1.5/bin/rspec:23:in `<main>'","/Users/lukas/.rvm/gems/ruby-2.1.5/bin/ruby_executable_hooks:15:in `eval'","/Users/lukas/.rvm/gems/ruby-2.1.5/bin/ruby_executable_hooks:15:in `<main>'"]}},{"description":"pending","full_description":"BlinkSpec::BlinkSpecRunner blinkspec fixtures pending","status":"pending","file_path":"./spec/blinkspec_spec.rb","line_number":9,"run_time":0.000147},{"description":"success","full_description":"BlinkSpec::BlinkSpecRunner blinkspec fixtures success","status":"passed","file_path":"./spec/blinkspec_spec.rb","line_number":14,"run_time":7.0e-05}],"summary":{"duration":0.003018,"example_count":3,"failure_count":1,"pending_count":1},"summary_line":"3 examples, 1 failure, 1 pending"}%

data/fixtures/blinkspec_fixture_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe "BlinkSpec fixtures", fixture: true do
+  context 'fixture', fixture_fail: true do
+    it 'should fail' do
+      fail
+    end
+  end
+end

data/lib/blinkcolor.rb

@@ -0,0 +1,24 @@
+module BlinkSpec
+  # Wrap color definitions
+  class BlinkColor
+    def self.fail
+      '255,0,0'
+    end
+
+    def self.success
+      '0,255,0'
+    end
+
+    def self.pending
+      '255,255,0'
+    end
+
+    def self.running
+      '255,255,255'
+    end
+
+    def self.error
+      '0,0,255'
+    end
+  end
+end

data/lib/blinkspec.rb

@@ -0,0 +1,98 @@
+require 'json'
+require 'fileutils'
+require 'pry'
+require_relative 'blinkcolor'
+
+# Run rspec with support of a blink(1)
+module BlinkSpec
+  class BlinkSpecRunner
+    attr_accessor :spec_output_file
+
+    def initialize
+      @spec_output_file = 'blinkspec.json'
+    end
+
+    # Run rspec and indicate progress with blink(1).
+    #
+    # * *Args*    :
+    #   - +args+ -> rspec specific arguments that should be used separated by whitespace
+    # * *Returns* :
+    #   - the number of successful, pending and failed results in that order
+    def run_specs(args)
+      begin
+        # indicate that the specs are running
+        blink("--glimmer --rgb=#{BlinkColor.running}")
+
+        run_rspec_subprocess(args)
+      rescue SystemExit, Interrupt
+        # catch keyboard interrupt to remove generated file and cleanly exit
+        blink("--blink 1 --rgb=#{BlinkColor.error}")
+        return nil,nil,nil
+      end
+
+      # handle rspec execution errors
+      exit_code = $?.exitstatus
+      unless [0, 1].include? exit_code
+        blink("--blink 1 --rgb=#{BlinkColor.error}")
+        puts "Rspec could not be executed correctly. Exit Code: #{exit_code}"
+        return nil,nil,nil
+      end
+
+      results
+    end
+
+    private
+
+    # Run rspec and listen for errors.
+    #
+    # * *Args*    :
+    #   - +args+ -> rspec specific arguments that should be used separated by whitespace
+    # * *Returns* :
+    #   - the number of successful, pending and failed results in that order
+    def run_rspec_subprocess(args)
+      IO.popen("bundle exec rspec #{args} --format documentation --format j --out #{@spec_output_file}").each do |f|
+        # listen to running specs and look for errors to report them early
+        line = f.chomp
+        if line.include? 'FAILED'
+          # show an error with blink(1)
+          blink("--blink 1 --rgb=#{BlinkColor.fail}")
+        end
+        puts line
+      end
+    end
+
+    # Run a blink1 command.
+    #
+    # * *Args*    :
+    #   - +args+ -> arguments passed to blink-1
+    #
+    # * *Returns* :
+    #   - true in case of 0 exit status
+    def blink(args)
+      system("blink1-tool #{args}")
+    end
+
+    # Get a summary of the results of the previous rspec run.
+    #
+    # * *Returns* :
+    #   - the number of successful, pending and failed results in that order
+    def results
+      # read execution resuls
+      file = File.open(@spec_output_file, 'r')
+      specresults = file.read
+      file.close
+
+      # fetch example results
+      # and cut eventual stdout output after json
+      specresults = specresults[0..(specresults.rindex("\}"))]
+      jsonresults = JSON.parse(specresults, symbolize_names: true)
+
+      # get summary
+      example_count = jsonresults[:summary][:example_count] || 0
+      pending_count = jsonresults[:summary][:pending_count] || 0
+      failure_count = jsonresults[:summary][:failure_count] || 0
+      success_count = example_count - pending_count - failure_count
+      return success_count, pending_count, failure_count
+    end
+  end
+end

data/spec/blinkspec_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe BlinkSpec::BlinkSpecRunner do
+  context 'when spec files are given' do
+    let(:runner) { BlinkSpec::BlinkSpecRunner.new }
+
+    it 'should call rspec with arguments' do
+      expect(runner).to receive(:blink).with(/--rgb=#{BlinkSpec::BlinkColor.running}/)
+      expect(runner).to receive(:run_rspec_subprocess).with('fixtures/blinkspec_fixture_spec.rb --color')
+      expect(runner).to receive(:results)
+      runner.run_specs('fixtures/blinkspec_fixture_spec.rb --color')
+    end
+
+    it 'should detect errors immediately during running' do
+      expect(runner).to receive(:blink).with(/--rgb=#{BlinkSpec::BlinkColor.fail}/)
+      runner.send(:run_rspec_subprocess, 'fixtures/blinkspec_fixture_spec.rb --tag fixture_fail')
+    end
+  end
+
+  context 'errors' do
+    let(:runner) { BlinkSpec::BlinkSpecRunner.new }
+
+    it 'should handle an error if exit code is not a success exit code' do
+      expect(runner).to receive(:blink).with(/--rgb=#{BlinkSpec::BlinkColor.running}/)
+      expect(runner).to receive(:blink).with(/--rgb=#{BlinkSpec::BlinkColor.error}/)
+      allow(runner).to receive(:run_rspec_subprocess) { system("exit 42") }
+      success, pending, failure = runner.run_specs('fixtures/blinkspec_fixture_spec.rb')
+      expect(success).to eq(nil)
+    end
+
+    it 'should handle keyboard interrupts' do
+      expect(runner).to receive(:blink).with(/--rgb=#{BlinkSpec::BlinkColor.running}/)
+      expect(runner).to receive(:blink).with(/--rgb=#{BlinkSpec::BlinkColor.error}/)
+      allow(runner).to receive(:run_rspec_subprocess).and_raise(Interrupt)
+      success, pending, failure = runner.run_specs('fixtures/blinkspec_fixture_spec.rb')
+      expect(success).to eq(nil)
+    end
+  end
+
+  context 'when spec results are given' do
+    let(:runner) do
+      runner = BlinkSpec::BlinkSpecRunner.new
+      runner.instance_variable_set(:@spec_output_file, 'fixtures/blinkspec_fixture.json')
+      runner
+    end
+    it 'should provide the success specs number' do
+      success, _pending, _error = runner.send(:results)
+      expect(success).to eq(1)
+    end
+    it 'should provide the pending specs number' do
+      _success, pending, _error = runner.send(:results)
+      expect(pending).to eq(1)
+    end
+    it 'should provide the failed specs number' do
+      _success, _pending, error = runner.send(:results)
+      expect(error).to eq(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'blinkspec'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: blinkspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lukas Nagl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: Run your specs with beautiful output and blink(1) signals
+email: lukas.nagl@innovaptor.com
+executables:
+- blinkspec
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/blinkspec
+- blinkspec.gemspec
+- fixtures/blinkspec_fixture.json
+- fixtures/blinkspec_fixture_spec.rb
+- lib/blinkcolor.rb
+- lib/blinkspec.rb
+- spec/.DS_Store
+- spec/blinkspec_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/j4zz/blinkspec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: blinkspec
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Run your specs with blink(1) feedback.
+test_files:
+- spec/blinkspec_spec.rb
+- spec/spec_helper.rb
+has_rdoc: