rspec-console 0.5.2 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f24189139498af2e2f3711517f59f961655da36
-  data.tar.gz: 235a18e64431545763550f4c245051189db128f6
+  metadata.gz: 0e63502234311fe86e7f6313f2330e06727d401e
+  data.tar.gz: b39390aed9d22566014802cd0e2a29b1d99bf0c6
 SHA512:
-  metadata.gz: beb4a616ecd2ff1775780a12e000949c800f06748f759c1f5dd19309e5e66c54324d77804307cb0f00c90af5b013e79c23505109c4175e9ba77f854ca1a003c2
-  data.tar.gz: 40cd7a7d61f6dd1e52b42aa31addbc465f853f28a9ce5b9b7f831c2a9efc55cc93748122d2ae1804938f6f8832040ff5ff000a5a11356ff4bbb5f4dfc010c922
+  metadata.gz: 6cc98cfed58de7e6d9b7e56bb90a5a3ff3908a6f0022367cbab1a1934041395320237f28be5b90d5b33b130987dd3d5d661bad9c6cf96bd69d26e3a3ee028c6b
+  data.tar.gz: 548488ee091260bf4cd09c8a16c31ba6b3796d945da8f2a66cf24382cdb4c3b84b8c34dc724ef89cf0a9f54c1ecaf02572b8799cacf5407c75adcb1d42d33438

data/README.md

@@ -1,9 +1,11 @@
-RSpec Console
+RSpec Console [![Build Status](https://travis-ci.org/nviennot/rspec-console.svg)](https://travis-ci.org/nviennot/rspec-console)
 =============
 
 RSpec Console allows you to run your RSpec tests in a Rails console.
 Best served chilled with [irb-config](https://github.com/nviennot/irb-config).
 
+It is especially helpful when working with [jRuby](http://jruby.org/), because it will keep an active JVM running for you. This drastically reduces the feedback loop of doing TDD in jRuby -- and all without messing with nail-gun!
+
 ### Watch the screencast
 
 [![Watch the screencast!](https://s3.amazonaws.com/velvetpulse/screencasts/irb-config-screencast.jpg)](http://velvetpulse.com/2012/11/19/improve-your-ruby-workflow-by-integrating-vim-tmux-pry/)
@@ -60,10 +62,12 @@ Finished in 0.12654 seconds
 ~/prj/crowdtap/sniper (test) >
 ```
 
-TODO
-----
+Authors
+-------
+
+* [Alex Moore-Niemi](https://github.com/mooreniemi)
+* Nicolas Viennot
 
-* Testing
 
 License
 -------

data/lib/rspec-console.rb

@@ -1,40 +1,48 @@
 module RSpecConsole
-  autoload :ConfigCache, 'rspec-console/config_cache'
-  autoload :Runner,      'rspec-console/runner'
-  autoload :Pry,         'rspec-console/pry'
+  autoload :ConfigCache,    'rspec-console/config_cache'
+  autoload :RSpecState,     'rspec-console/rspec_state'
+  autoload :Runner,         'rspec-console/runner'
+  autoload :Pry,            'rspec-console/pry'
 
-  class << self; attr_accessor :hooks; end
-  self.hooks = []
+  class << self; attr_accessor :before_run_callbacks; end
+  self.before_run_callbacks = []
 
   def self.run(*args)
     Runner.run(args)
   end
 
-  def self.register_hook(&hook)
-    self.hooks << hook
+  def self.before_run(&hook)
+    self.before_run_callbacks << hook
   end
 
   Pry.setup if defined?(::Pry)
 
   # We only want the test env
-  register_hook do
-    if defined?(Rails) && !Rails.env =~ /test/
-      raise "Rails env must be set as test (use `rails console test` to launch the console)."
+  before_run do
+    if defined?(Rails) && !(Rails.env =~ /test/)
+      raise 'Please run in test mode (run `rails console test`).'
     end
   end
 
   # Emit warning when reload cannot be called, or call reload!
-  register_hook do
+  before_run do
+    class String
+      def red
+        "\033[31m#{self}\033[0m"
+      end
+    end
     if defined?(Rails)
       if Rails.application.config.cache_classes
-        STDERR.puts <<-MSG
-[WARNING]
-Rails's cache_classes must be turned off.
-Turn off in config/environments/test.rb:
+        STDERR.puts <<-MSG.gsub(/^ {10}/, '')
+          #{"[ WARNING ]".red }
+          Rails's cache_classes must be turned off.
+          Turn it off in config/environments/test.rb:
 
-  Rails.application.configure do
-    conig.cache_classes = false
-  end
+            Rails.application.configure do
+              config.cache_classes = false
+            end
+
+          Otherwise, code relading does not work.
         MSG
       else
         ActionDispatch::Reloader.cleanup!
@@ -44,5 +52,5 @@ Turn off in config/environments/test.rb:
   end
 
   # Reloading FactoryGirl if necessary
-  register_hook { FactoryGirl.reload if defined?(FactoryGirl) }
+  before_run { FactoryGirl.reload if defined?(FactoryGirl) }
 end

data/lib/rspec-console/config_cache.rb

@@ -8,75 +8,104 @@ class RSpecConsole::ConfigCache
   # modules (FactoryGirl, Mocha,...) and we don't want to replace requires with
   # load all around the place.
   #
-  # Instead, we cache whatever is done to RSpec.configuration during the
-  # first invokration of require('spec_helper').
-  # This is done by interposing the Proxy class on top of RSpec.configuration.
-  #
-  attr_accessor :proxy, :recorded_config, :shared_examples_groups
+  # Instead, we proxy and record whatever is done to RSpec.configuration during
+  # the first invocation of require('spec_helper').  This is done by interposing
+  # the RecordingProxy class on of RSpec.configuration.
+  attr_accessor :config_proxy, :shared_examples_copy
 
-  def initialize
-    ::RSpec.instance_eval do
-      def self.configuration=(value)
-        @configuration = value
+  class RecordingProxy < Struct.new(:target, :recorded_messages)
+    [:include, :extend].each do |method|
+      define_method(method) do |*args|
+        method_missing(method, *args)
       end
     end
+
+    def method_missing(method, *args, &block)
+      self.recorded_messages << [method, args, block]
+      self.target.send(method, *args, &block)
+    end
   end
 
-  def cache
-    if self.proxy
-      # replay
-      ::RSpec.configure do |config|
-        self.recorded_config.each do |msg|
-          config.send(msg[:method], *msg[:args], &msg[:block])
-        end
-      end
-      ::RSpec.world.shared_example_groups.merge!(self.shared_examples_groups || {}) rescue nil
+  def record_configuration(&configuration_block)
+    ensure_configuration_setter!
 
-    else
-      # record
-      real_config = ::RSpec.configuration
-      self.recorded_config = []
-      self.proxy = Proxy.new(self.recorded_config, real_config)
-      ::RSpec.configuration = self.proxy
-      yield
-      ::RSpec.configuration = real_config
-      self.shared_examples_groups = ::RSpec.world.shared_example_groups.dup rescue nil
-
-      # rspec-rails/lib/rspec/rails/view_rendering.rb add methods on the
-      # configuration singleton. Need advice to copy them without going down
-      # the road with object2module.
-    end
+    original_config = ::RSpec.configuration
+    ::RSpec.configuration = RecordingProxy.new(original_config, [])
+
+    configuration_block.call # spec helper is called during this yield, see #reset
+
+    self.config_proxy = ::RSpec.configuration
+    ::RSpec.configuration = original_config
 
-    # Well, instead of copying them, we redirect them to the configuration
-    # proxy. Looks like it good enough.
-    proxy = self.proxy
-    ::RSpec.configuration.singleton_class.send(:define_method, :method_missing) do |method, *args, &block|
-      proxy.send(method, *args, &block)
+    stash_shared_examples
+
+    forward_rspec_config_singleton_to(self.config_proxy)
+  end
+
+  def replay_configuration
+    ::RSpec.configure do |config|
+      self.config_proxy.recorded_messages.each do |method, args, block|
+        # reporter caches config.output_stream which is not good as it
+        # prevents the runner to use a custom stdout.
+        next if method == :reporter
+        config.send(method, *args, &block)
+      end
     end
 
+    restore_shared_examples
+
+    forward_rspec_config_singleton_to(self.config_proxy)
   end
-end
 
-class Proxy < Struct.new(:output, :target)
-  [:include, :extend].each do |method|
-    define_method(method) do |*args|
-      method_missing(method, *args)
+  def has_recorded_config?
+    !!self.config_proxy
+  end
+
+  def forward_rspec_config_singleton_to(config_proxy)
+    # an old version of rspec-rails/lib/rspec/rails/view_rendering.rb adds
+    # methods on the configuration singleton. This takes care of that.
+    ::RSpec.configuration.singleton_class
+      .send(:define_method, :method_missing, &config_proxy.method(:send))
+  end
+
+  def stash_shared_examples
+    if rspec2?
+      self.shared_examples_copy = ::RSpec.world.shared_example_groups.dup
+    else
+      self.shared_examples_copy = ::RSpec.world.shared_example_group_registry
+                                    .send(:shared_example_groups).dup
     end
+  rescue Exception => e
+    STDERR.puts "[rspec-console] WARN: #{e.class} #{e}"
   end
 
-  def method_missing(method, *args, &block)
-    self.output << {:method => method, :args => args, :block => block}
-    self.target.send(method, *args, &block)
+  def restore_shared_examples
+    return if self.shared_examples_copy.nil?
+
+    if rspec2?
+      ::RSpec.world.shared_example_groups.merge!(self.shared_examples_copy)
+    else
+      self.shared_examples_copy.each do |context, name_blocks|
+        name_blocks.each do |name, block|
+          ::RSpec.world.shared_example_group_registry.add(context, name, &block)
+        end
+      end
+    end
+  rescue Exception => e
+    STDERR.puts "[rspec-console] WARN: #{e.class} #{e}"
   end
-end
 
-# For compatibility with Ruby 1.8.x outside of the Rails framework
-if RUBY_VERSION =~ /1.8/
-  unless defined?(Rails)
-    class Object
-      def singleton_class
-        class << self; self; end
+  def ensure_configuration_setter!
+    return if RSpec.respond_to?(:configuration=)
+
+    ::RSpec.instance_eval do
+      def self.configuration=(value)
+        @configuration = value
       end
     end
   end
+
+  def rspec2?
+    Gem.loaded_specs['rspec-core'].version < Gem::Version.new('3')
+  end
 end

data/lib/rspec-console/pry.rb

@@ -1,30 +1,32 @@
-module RSpecConsole::Pry
-  def self.setup
-    ::Pry::CommandSet.new(&method(:rspec_command))
+module RSpecConsole
+  module Pry
+    def self.setup
+      ::Pry::CommandSet.new(&method(:rspec_command))
       .tap { |cmd| ::Pry::Commands.import cmd }
-  end
+    end
 
-  def self.rspec_command(cmd)
-    cmd.create_command "rspec", "Runs specs; to silence ActiveRecord output use SILENCE_AR=true" do
-      group "Testing"
+    def self.rspec_command(cmd)
+      cmd.create_command "rspec", "Runs specs; to silence ActiveRecord output use SILENCE_AR=true" do
+        group "Testing"
 
-      def process(*args)
-        with_ar_silenced { RSpecConsole::Runner.run(args) }
-      end
+        def process(*args)
+          with_ar_silenced { RSpecConsole::Runner.run(args) }
+        end
 
-      def with_ar_silenced(&block)
-        return block.call unless defined?(ActiveRecord) && ENV['SILENCE_AR']
-        begin
-          old_logger, ActiveRecord::Base.logger = ActiveRecord::Base.logger, nil
-          block.call
-        ensure
-          ActiveRecord::Base.logger = old_logger
+        def with_ar_silenced(&block)
+          return block.call unless defined?(ActiveRecord) && ENV['SILENCE_AR']
+          begin
+            old_logger, ActiveRecord::Base.logger = ActiveRecord::Base.logger, nil
+            block.call
+          ensure
+            ActiveRecord::Base.logger = old_logger
+          end
         end
-      end
 
-      def complete(input)
-        require 'bond'
-        super + Bond::Rc.files(input.split(" ").last || '')
+        def complete(input)
+          require 'bond'
+          super + Bond::Rc.files(input.split(" ").last || '')
+        end
       end
     end
   end

data/lib/rspec-console/rspec_state.rb

@@ -0,0 +1,48 @@
+module RSpecConsole
+  class RSpecState
+    class << self
+      def reset
+        require 'rspec/core'
+        raise 'Please use RSpec 2.10.0 or later' if obsolete_rspec?
+
+        ::RSpec::Core::Configuration.class_eval { define_method(:command) { 'rspec' } }
+        ::RSpec::Core::Runner.disable_autorun!
+        ::RSpec.reset
+
+        if config_cache.has_recorded_config?
+          config_cache.replay_configuration
+        else
+          config_cache.record_configuration(&rspec_configuration)
+        end
+      end
+
+      def rspec_configuration
+        proc do
+          ::RSpec.configure do |config|
+            config.color_enabled = true if config.respond_to?(:color_enabled=)
+            config.color         = true if config.respond_to?(:color=)
+          end
+
+          $LOAD_PATH << './spec'
+          try_load('spec_helper')
+          try_load('rails_helper')
+        end
+      end
+
+      def try_load(file)
+        begin
+          require file
+        rescue LoadError
+        end
+      end
+
+      def config_cache
+        @config_cache ||= RSpecConsole::ConfigCache.new
+      end
+
+      def obsolete_rspec?
+        Gem.loaded_specs['rspec-core'].version < Gem::Version.new('2.10.0')
+      end
+    end
+  end
+end

data/lib/rspec-console/runner.rb

@@ -1,44 +1,16 @@
-class RSpecConsole::Runner
-  class << self
-    def reset(args)
-      require 'rspec/core'
+# This class wraps the core rspec runner and manages the environment around it.
+module RSpecConsole
+  class Runner
+    class << self
+      def run(args, options={})
+        RSpecConsole.before_run_callbacks.each(&:call)
+        RSpecConsole::RSpecState.reset
 
-      if Gem.loaded_specs['rspec-core'].version < Gem::Version.new('2.9.10')
-        raise 'Please use RSpec 2.9.10 or later'
-      end
-
-      ::RSpec::Core::Runner.disable_autorun!
-      ::RSpec::Core::Configuration.class_eval { define_method(:command) { 'rspec' } }
-      ::RSpec.reset
-
-      config_cache.cache do
-        ::RSpec.configure do |config|
-          config.output_stream = STDOUT
-          config.color_enabled = true if config.respond_to?(:color_enabled=)
-          config.color         = true if config.respond_to?(:color=)
-        end
-
-        $LOAD_PATH << './spec'
-        require "spec_helper"
-        begin
-          require "rails_helper"
-        rescue LoadError
-        end
-      end
-    end
+        stdout = options[:stdout] || $stdout
+        stderr = options[:stderr] || $stderr
 
-    def run(args)
-      RSpecConsole.hooks.each(&:call)
-      reset(args)
-      if defined?(::RSpec::Core::CommandLine)
-        ::RSpec::Core::CommandLine.new(args).run(STDERR, STDOUT)
-      else
-        ::RSpec::Core::Runner.run(args, STDERR, STDOUT)
+        ::RSpec::Core::Runner.run(args, stderr, stdout)
       end
     end
-
-    def config_cache
-      @config_cache ||= RSpecConsole::ConfigCache.new
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-console
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: '0.6'
 platform: ruby
 authors:
 - Nicolas Viennot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-02 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bond
@@ -25,7 +25,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
+  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: pry
+  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: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -49,8 +77,8 @@ files:
 - lib/rspec-console.rb
 - lib/rspec-console/config_cache.rb
 - lib/rspec-console/pry.rb
+- lib/rspec-console/rspec_state.rb
 - lib/rspec-console/runner.rb
-- lib/rspec-console/version.rb
 homepage: http://github.com/nviennot/rspec-console
 licenses:
 - MIT

data/lib/rspec-console/version.rb

@@ -1,3 +0,0 @@
-module RSpecConsole
-  VERSION = '0.5.2'
-end