rspectacles 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92fd52dccf56cd933bfa9361092dd7590e767cd8
-  data.tar.gz: d58bfa299fdfb27798a1de5d8e4e578318dea9d7
+  metadata.gz: 55a26564ce13d66c487172e032524359c5440e6d
+  data.tar.gz: cb85f1910af0e08b2cc4ad8bead4cdc671057b89
 SHA512:
-  metadata.gz: aa73df7297d3b0daaf259c41ae0068c52ef1a84f3ba6909f33356d459ccf8c8803a5dbefce4b74a09c8ad8c8189df12889990615d946fa429ed42937a0efb354
-  data.tar.gz: 5c05f8a496b3f28f99f06a1a9e07add764f64cfebd0bd4a5789bec0e3c7612c183247587f4430fe503bc4ad07096931e532f2c05bdc21120c86de6e300dcf1aa
+  metadata.gz: bf43b503e80ca48f4babc6e9830ffcfe305bb96b9f8e7273c4b04e97a33c0d28218fc2a4f6ed01cfce6a9e843940915ce166a5f09a73c26dea0bd11cd8c18a70
+  data.tar.gz: 1e43d2e4f4307a0d61daeaf2ad1412563abf543aa87f8e906677fb248a5e7698b874346f2d55c24396b9d7c3de4dab579243ee5e1ba94d927b647fbac09ef7fe

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspectacles (0.0.6)
+    rspectacles (0.0.7)
       em-hiredis (~> 0.2.1)
       rake
       redis

data/README.md

@@ -0,0 +1,92 @@
+# RSpectacles
+
+RSpectacles is an in-browser visualizer and profiler for RSpec. It uses
+Server-Sent Events, Redis, and d3.js to render a
+[partition](http://bl.ocks.org/mbostock/4063423) of your specs in real time, so
+that you can tell at a glance where the time is spent in your test suite.
+
+As a Sinatra app it can be run standalone, or else mounted on another Rack app.
+
+## Installation
+
+    gem install rspectacles
+
+Or in your Gemfile:
+
+    group :test, :development do
+      gem 'rspectacles'
+    end
+
+Then add the formatter to your .rspec file:
+
+    --require 'rspectacles/redis_formatter'
+    --format RSpectacles::RedisFormatter
+
+    --format progress # or whatever other formatters you want to use
+
+RSpectacles depends on [Redis](http://redis.io) for pubsub and persistence. You
+can quickly get an instance up and running by using your favorite package
+manager:
+
+    brew install redis
+    redis-server
+
+Start the server and connect to it in your browser:
+
+    rspectacles
+
+Then run your specs and watch the magic happen!
+
+## The Server
+
+The server can be run in standalone mode:
+
+    rspectacles
+
+Or mounted directly on your app:
+
+    # routes.rb
+    mount RSpectacles::App => '/rspectacles'
+
+## Configuration
+If you need to change any settings, the best method is to create a yaml file
+with your settings, and set the ```RSPECTACLES_CONFIG``` environment variable so
+that both the server and formatter can locate the file.
+
+For instance:
+
+```sh
+export RSPECTACLES_CONFIG='/path/to/config/rspectacles.yml'
+```
+
+And in ```rspectacles.yml```:
+```yaml
+sinatra_port: 4567
+redis_uri: 'redis://127.0.0.1:6379/'
+pubsub_channel_name: 'redis-rspec-examples'
+last_run_primary_key: 'redis-rspec-last-run'
+```
+
+## Realtime Results
+
+RSpectacles will attempt to stream spec results into the browser in realtime.
+This optional feature depends on EventMachine, and so will only work on servers
+with EM support. So if you mount RSpectacles on an app that uses
+[thin](http://code.macournoyer.com/thin/) or
+[rainbows](http://rainbows.rubyforge.org/) then
+you should be able to see the realtime results.
+
+If you use a server that doesn't support EventMachine - no sweat. You'll still
+be able to see the visualization. You'll just need to refresh your browser
+from time to time.
+
+Or you could always spin up an instance in standalone mode, which uses thin by
+default.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bin/rspectacles

@@ -9,4 +9,4 @@ rescue LoadError => e
   require 'rspectacles/app.rb'
 end
 
-Thin::Server.start RSpectacles::App, '0.0.0.0', 4567
+Thin::Server.start RSpectacles::App, '0.0.0.0', RSpectacles.config.sinatra_port

data/lib/rspectacles/app/public/js/exampleStream.js

@@ -8,7 +8,6 @@ define(['riffle'], function (riffle) {
       , serverEvents
       , ajaxEvents
       , matching
-      , toArray
       , toJson
       , each
       , stringEvents

data/lib/rspectacles/app.rb

@@ -5,11 +5,14 @@ require 'em-hiredis'
 require 'redis'
 require 'uri'
 require 'thin'
+require 'rspectacles/config.rb'
 
 module RSpectacles
   class App < Sinatra::Base
     require 'rspectacles/app/helpers'
+
     connections = []
+    config = RSpectacles.config
     dir = File.dirname(File.expand_path(__FILE__))
     set :app_file, __FILE__
     set :root, dir
@@ -22,7 +25,7 @@ module RSpectacles
       set :public, "#{dir}/app/public"
     end
 
-    uri = URI.parse 'redis://127.0.0.1:6379/'
+    uri = URI.parse config.redis_uri
     redis = Redis.new host: uri.host, port: uri.port
 
     # Routes
@@ -38,14 +41,14 @@ module RSpectacles
     end
 
     get '/last' do
-      redis.lrange('redis-rspec-last-run', 0, -1).to_json
+      redis.lrange(config.last_run_primary_key, 0, -1).to_json
     end
 
     # pubsub and streaming - EventMachine support only
     EM.next_tick do
       emredis = EM::Hiredis.connect(uri)
 
-      emredis.pubsub.subscribe 'redis-rspec-examples' do |message|
+      emredis.pubsub.subscribe config.pubsub_channel_name do |message|
         connections.each { |out| out << "data: #{message}\n\n" }
       end
     end

data/lib/rspectacles/config.rb

@@ -0,0 +1,41 @@
+require 'ostruct'
+require 'yaml'
+
+module RSpectacles
+  class Config
+    def initialize
+      user_options = load_user_opts
+      @opts = OpenStruct.new defaults.merge(user_options)
+    end
+
+    def defaults
+      {
+        sinatra_port: 4567,
+        pubsub_channel_name: 'redis-rspec-examples',
+        last_run_primary_key: 'redis-rspec-last-run',
+        redis_uri: 'redis://127.0.0.1:6379/'
+      }
+    end
+
+    def load_user_opts
+      if ENV['RSPECTACLES_CONFIG'] && ::File.exists?(::File.expand_path(ENV['RSPECTACLES_CONFIG']))
+        YAML.load_file(::File.expand_path(ENV['RSPECTACLES_CONFIG']))
+      else
+        {}
+      end
+    end
+
+    def method_missing(method, *args)
+      @opts.send method, *args
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Config.new
+  end
+
+  def self.config
+    yield configuration if block_given?
+    configuration
+  end
+end

data/lib/rspectacles/redis_formatter.rb

@@ -1,4 +1,5 @@
 require 'rspec/core/formatters/base_formatter'
+require 'rspectacles/config'
 require 'ostruct'
 require 'redis'
 
@@ -8,18 +9,13 @@ module RSpectacles
 
     class << self
       def config
-        OpenStruct.new({
-          channel_name: 'redis-rspec-examples',
-          last_run_key: 'redis-rspec-last-run',
-          port: 6379,
-          host: '127.0.0.1',
-          password: ''
-        })
+        RSpectacles.config
       end
     end
 
     def initialize(output)
-      self.redis = Redis.new host: config.host, port: config.port
+      uri = config.redis_uri
+      self.redis = Redis.new host: uri.host, port: uri.port, password: uri.password
     end
 
     def message(message)
@@ -28,7 +24,7 @@ module RSpectacles
 
     def start(example_count)
       log 'status:start'
-      redis.del config.last_run_key
+      redis.del config.last_run_primary_key
     end
 
     def stop
@@ -60,14 +56,14 @@ module RSpectacles
     end
 
     def log(message)
-      redis.publish config.channel_name, message
-      redis.lpush config.last_run_key, message
+      redis.publish config.pubsub_channel_name, message
+      redis.lpush config.last_run_primary_key, message
     end
 
     def log_formatted(example)
       message = format_example(example)
-      redis.publish config.channel_name, message
-      redis.lpush config.last_run_key, message
+      redis.publish config.pubsub_channel_name, message
+      redis.lpush config.last_run_primary_key, message
     end
 
     def format_example(example)

data/lib/rspectacles/version.rb

@@ -1,3 +1,3 @@
 module RSpectacles
-  VERSION='0.0.6'
+  VERSION='0.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspectacles
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Michael Wheeler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2013-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -106,6 +106,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- README.md
 - Rakefile
 - bin/rspectacles
 - config.ru
@@ -124,6 +125,7 @@ files:
 - lib/rspectacles/app/public/js/riffle.js
 - lib/rspectacles/app/public/js/script.js
 - lib/rspectacles/app/views/index.erb
+- lib/rspectacles/config.rb
 - lib/rspectacles/redis_formatter.rb
 - lib/rspectacles/version.rb
 - rspectacles.gemspec