spec_run_queue 0.0.5 → 0.1.0

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
+.rvmrc
 .bundle
 Gemfile.lock
 pkg/*
+SpecRunQueueFile

data/README.markdown

@@ -20,26 +20,37 @@ and then runs the command, via backticks, in the shell.  Summary results from th
 NOTIFIERS
 =========
 
-Notifiers must provide at least one instane method, <tt>notify</tt>, which processes the output from the spec run.  Currently, there are two runners, Stdout, and Growl.  Stdout prints the results from the run to the terminal window, while growl sends a brief pass/fail summary to growl.
+Notifiers must provide at least one instance method, <tt>notify</tt>, which processes the output from the spec run.  Currently, there are two runners, Stdout, and Growl.  Stdout prints the results from the run to the terminal window, while growl sends a brief pass/fail summary to growl.
 
 
+CONFIGURATION
+=============
+
+You can configure per project behavior by creating a SpecRunQueueFile in the root of
+your project.  An example of such a file might look like:
+
+```ruby
+SpecRunQueue.configure do |c|
+  c.rspec_bin = "bundle exec rspec"
+  c.add_notifier :growl, :password => "fizzbuzz"
+end
+```
+
+If you do not provide a configuration, the runner will assume a binary of `rspec` and
+use the stdout notifier.
+
 USAGE
 =====
 
 In your project root, run
 
-    redis_runner [1|2]
-
-where 1 or 2 indicates the major version of rspec you are using for the project.
-
+    redis_runner
 
 In order to trigger a queue run, you need your editor to insert a YAML dump of the instructions described above to the queue.
 
-
 TODO
 ====
 
-* Check for Gemfile to bundle exec the spec bin
-* Genericify and configure the runner
 * Include code or a plugin for the vim script I'm using to inject instructions into the queue
 * Investigate a custom rspec runner in place of the current shell execution method
+* Swap YAML for JSON

data/bin/redis_runner

@@ -1,22 +1,18 @@
 #!/usr/bin/env ruby
 
-#TODO make this more generic and configurable
-
 require 'spec_run_queue'
 require 'spec_run_queue/queue/redis'
-require 'spec_run_queue/notifier/growl'
 require 'spec_run_queue/notifier/stdout'
 
-rspec_major_version = ARGV.shift
-unless rspec_major_version
-  $stderr.puts "please specify 1 or 2 for rspec version"
-  exit -1
-end
+SPEC_RUN_QUEUE_FILE = "SpecRunQueueFile"
 
-runner = SpecRunQueue::SystemRunner.new(rspec_major_version)
-runner.add_notifier SpecRunQueue::Notifier::Growl.new(:password => "gr0wl")
-# runner.add_notifier SpecRunQueue::Notifier::Stdout.new()
+if File.readable?(SPEC_RUN_QUEUE_FILE)
+  load "./#{SPEC_RUN_QUEUE_FILE}"
+else
+  SpecRunQueue.configure do |c|
+    c.add_notifier :stdout
+  end
+end
 
-queue = SpecRunQueue::Queue::Redis.new(runner)
+queue = SpecRunQueue::Queue::Redis.new(SpecRunQueue.runner)
 queue.run
-

data/lib/spec_run_queue/queue/base.rb

@@ -12,6 +12,7 @@ module SpecRunQueue
       def run
         with_reconnect do
           while (raw_instruction = queue_fetch)
+            raise "Dangerous yaml!" if raw_instruction[1] =~ /!ruby/
             instruction = YAML.load(raw_instruction[1])
             runner.run_spec(instruction)
           end

data/lib/spec_run_queue/system_runner.rb

@@ -1,20 +1,13 @@
 module SpecRunQueue
   class SystemRunner
-    attr_reader :version, :options, :notifiers
+    attr_reader :options, :notifiers
 
-    def initialize(version, options = {})
-      @version = version.to_i
+    def initialize(options = {})
       @options = options
     end
 
     def rspec_bin
-      if version == 1
-        options[:spec_bin] || "spec"
-      elsif version == 2
-        options[:rspec_bin] || "rspec"
-      else
-        raise "Couldn't determine rspec bin'"
-      end
+      options.fetch(:rspec_bin, "rspec")
     end
 
     def add_notifier(notifier)

data/lib/spec_run_queue/version.rb

@@ -1,3 +1,3 @@
 module SpecRunQueue
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/lib/spec_run_queue.rb

@@ -2,8 +2,47 @@ require 'rubygems'
 require 'yaml'
 
 module SpecRunQueue
+  class Configuration
+    attr_accessor :rspec_bin
+
+    def add_notifier(runner_symbol, options = {})
+      klass = SpecRunQueue::Notifier.send(:const_get, runner_symbol.to_s.capitalize)
+      SpecRunQueue.runner.add_notifier klass.new(options)
+    end
+
+    def to_h
+      h = {}
+      h[:rspec_bin] = rspec_bin if rspec_bin
+      h
+    end
+  end
+
+  def self.configuration
+    @configuration || configure
+  end
+
+  def self.configure
+    @configuration = Configuration.new
+
+    if block_given?
+      yield configuration
+    end
+
+    @configuration
+  end
+
+  def self.runner
+    @runner ||= SystemRunner.new(configuration.to_h)
+  end
 end
 
 require 'spec_run_queue/queue/base'
 require 'spec_run_queue/notifier/base'
 require 'spec_run_queue/system_runner'
+
+module SpecRunQueue
+  module Notifier
+    autoload :Growl, 'spec_run_queue/notifier/growl'
+    autoload :Stdout, 'spec_run_queue/notifier/stdout'
+  end
+end

data/spec/spec_run_queue_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe SpecRunQueue, "default runner" do
+  it "is a SystemRunner" do
+    runner = stub(:runner)
+    SpecRunQueue::SystemRunner.stub(:new).and_return(runner)
+    SpecRunQueue.runner.should == runner
+  end
+end
+
+describe SpecRunQueue, "Configuration" do
+  before do
+    SpecRunQueue.configure do |c|
+      c.rspec_bin      = "/usr/local/bin/spec"
+    end
+  end
+
+  it "provides a block style config" do
+    SpecRunQueue.configuration.rspec_bin.should == "/usr/local/bin/spec"
+  end
+
+  it "can be converted to a hash of options" do
+    SpecRunQueue.configuration.to_h.should == { :rspec_bin => "/usr/local/bin/spec" }
+  end
+
+  it "can add a notifier" do
+    notifier = stub(:notifier)
+    SpecRunQueue::Notifier::Growl.should_receive(:new).with(:password => "gpass").and_return(notifier)
+    SpecRunQueue.runner.should_receive(:add_notifier).with(notifier)
+
+    SpecRunQueue.configure do |c|
+      c.add_notifier :growl, :password => "gpass"
+    end
+  end
+end

data/spec/system_runner_spec.rb

@@ -3,42 +3,37 @@ require 'spec_helper'
 describe SpecRunQueue::SystemRunner do
   let(:foo_notifier) { @foo_notifier ||= mock("FooNotifier", :notify => true) }
   let(:bar_notifier) { @bar_notifier ||= mock("BarNotifier", :notify => true) }
-  let(:runner) { @runner ||= 
+  let(:runner) { @runner ||=
     begin
-      runner = SpecRunQueue::SystemRunner.new(1)
+      runner = SpecRunQueue::SystemRunner.new(:rspec_bin => "spec")
       runner.add_notifier(foo_notifier)
       runner.add_notifier(bar_notifier)
-      runner 
+      runner
     end
   }
 
   describe "initializing" do
-    it "should set the version" do
-      runner = SpecRunQueue::SystemRunner.new(1, { :password => "foo" })
-      runner.version.should == 1
-    end
-
     it "should set the options" do
-      runner = SpecRunQueue::SystemRunner.new(1, { :password => "foo" })
+      runner = SpecRunQueue::SystemRunner.new({ :password => "foo" })
       runner.options.should == { :password => "foo" }
     end
   end
-  
+
   describe "getting the rspec binary" do
-    it "for version 1 is spec by default" do
-      runner = SpecRunQueue::SystemRunner.new(1)
-      runner.rspec_bin.should == "spec"
+    it "is 'rspec' by default" do
+      runner = SpecRunQueue::SystemRunner.new
+      runner.rspec_bin.should == "rspec"
     end
 
-    it "for varsion 2 is rspec by default" do
-      runner = SpecRunQueue::SystemRunner.new(2)
-      runner.rspec_bin.should == "rspec"
+    it "will use the rspec_bin option if present" do
+      runner = SpecRunQueue::SystemRunner.new(:rspec_bin => "bundle exec rspec")
+      runner.rspec_bin.should == "bundle exec rspec"
     end
   end
 
   describe "adding a notifier" do
     it "should append the notifier onto the notifiers list" do
-      runner = SpecRunQueue::SystemRunner.new(1)
+      runner = SpecRunQueue::SystemRunner.new
       foo_notifier = mock("FooNotifier")
       runner.add_notifier(foo_notifier)
       bar_notifier = mock("BarNotifier")

data/spec_run_queue.gemspec

@@ -18,4 +18,8 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = ["redis_runner"]
   s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "redis"
+  s.add_development_dependency "ruby-growl", '~> 3.0'
 end

metadata

@@ -1,34 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: spec_run_queue
-version: !ruby/object:Gem::Version 
-  hash: 21
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Brendon Murphy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-05 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
+date: 2013-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152806200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152806200
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &2152805700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152805700
+- !ruby/object:Gem::Dependency
+  name: ruby-growl
+  requirement: &2152804800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152804800
 description: Use a queue to run specs outside your editor
-email: 
+email:
 - xternal1+github@gmail.com
-executables: 
+executables:
 - redis_runner
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.markdown
@@ -48,47 +71,39 @@ files:
 - spec/queue/base_spec.rb
 - spec/queue/redis_spec.rb
 - spec/spec_helper.rb
+- spec/spec_run_queue_spec.rb
 - spec/system_runner_spec.rb
 - spec_run_queue.gemspec
-has_rdoc: true
 homepage: https://github.com/bemurphy/spec_run_queue
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: spec_run_queue
-rubygems_version: 1.3.7
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Use a queue to run specs outside your editor
-test_files: 
+test_files:
 - spec/notifier/base_spec.rb
 - spec/notifier/growl_spec.rb
 - spec/notifier/stdout_spec.rb
 - spec/queue/base_spec.rb
 - spec/queue/redis_spec.rb
 - spec/spec_helper.rb
+- spec/spec_run_queue_spec.rb
 - spec/system_runner_spec.rb