spring 0.0.8 → 0.0.9

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.0.9
+
+* Added `Spring::Commands::Rake.environment_matchers` for matching
+  rake tasks to specific environments.
+* Kill the spring server when the `Gemfile` or `Gemfile.lock` is
+  changed. This forces a new server to boot up on the next run, which
+  ensures that you get the correct gems (or the correct error message from
+  bundler if you have forgotten to `bundle install`.)
+* Fixed error when `Spring.watch` is used in `config/spring.rb`
+
 ## 0.0.8
 
 * Renamed `spring test` to `spring testunit`.

data/README.md

@@ -78,9 +78,9 @@ Finished tests in 0.127245s, 55.0121 tests/s, 78.5887 assertions/s.
 
 7 tests, 10 assertions, 0 failures, 0 errors, 0 skips
 
-real	0m2.165s
-user	0m0.281s
-sys	0m0.066s
+real    0m2.165s
+user    0m0.281s
+sys     0m0.066s
 ```
 
 That booted our app in the background:
@@ -111,9 +111,9 @@ Finished tests in 0.176896s, 39.5714 tests/s, 56.5305 assertions/s.
 
 7 tests, 10 assertions, 0 failures, 0 errors, 0 skips
 
-real	0m0.610s
-user	0m0.276s
-sys	0m0.059s
+real    0m0.610s
+user    0m0.276s
+sys     0m0.059s
 ```
 
 Running `spring testunit`, `spring rake`, `spring rails`, etc gets a bit
@@ -145,15 +145,22 @@ Finished tests in 0.166585s, 42.0207 tests/s, 60.0296 assertions/s.
 
 7 tests, 10 assertions, 0 failures, 0 errors, 0 skips
 
-real	0m0.407s
-user	0m0.077s
-sys	0m0.059s
+real    0m0.407s
+user    0m0.077s
+sys     0m0.059s
 ```
 
 You can add "./bin" to your `PATH` when in your application's directory
 [with direnv](https://github.com/zimbatm/direnv), but you should
 recognise and understand the security implications of using that.
 
+Note: Don't use spring binstubs with `bundle install --binstubs`.  If
+you do this, spring and bundler will overwrite each other. If _you will_
+not be using a command with spring, use `bundle binstub [GEM]` to
+generate a bundler binstub for that specific gem.  If you _will_ be
+using a command with spring, generate a spring binstub _instaed of_ a
+bundler binstub; spring will run your command inside the bundle anyway.
+
 If we edit any of the application files, or test files, the change will
 be picked up on the next run, without the background process
 having to be restarted.
@@ -242,7 +249,17 @@ Runs a cucumber feature.
 
 ### `rake`
 
-Runs a rake task.
+Runs a rake task. Rake tasks run in the `development` environment by
+default. You can change this on the fly by using the `RAILS_ENV`
+environment variable. The environment is also configurable with the
+`Spring::Commands::Rake.environment_matchers` hash. This has sensible
+defaults, but if you need to match a specific task to a specific
+environment, you'd do it like this:
+
+``` ruby
+Spring::Commands::Rake.environment_matchers["perf_test"] = "test"
+Spring::Commands::Rake.environment_matchers[/^perf/]     = "test"
+```
 
 ### `rails console`, `rails generate`, `rails runner`
 
@@ -251,22 +268,22 @@ a different sub command (e.g. `rails server`) then spring will automatically
 pass it through to the underlying `rails` executable (without the
 speed-up).
 
-## Configuration
+## Configuration file
+
+Spring will read `config/spring.rb` for custom settings, described below.
 
-### application_root
+### Specifying application root
 
-Spring must know how to find your rails application. If you have a
+Spring must know how to find your Rails application. If you have a
 normal app everything works out of the box. If you are working on a
 project with a special setup (an engine for example), you must tell
 Spring where your app is located:
 
-**config/spring.rb**
-
 ```ruby
 Spring.application_root = './test/dummy'
 ```
 
-### preload files
+### Preloading files
 
 Every Spring command has the ability to preload a set of files. The
 `test` command for example preloads `test_helper` (it also adds the
@@ -276,16 +293,16 @@ preloads for every command:
 
 ```ruby
 # if your test helper is called "helper"
-Commands::Command::TestUnit.preloads = %w(helper)
+Spring::Commands::TestUnit.preloads = %w(helper)
 
 # if you don't want to preload spec_helper.rb
-Commands::Command::RSpec.preloads = []
+Spring::Commands::RSpec.preloads = []
 
 # if you want to preload additional files for the console
-Commands::Command::RailsConsole.preloads << 'extenstions/console_helper'
+Spring::Commands::RailsConsole.preloads << 'extensions/console_helper'
 ```
 
-### after fork callbacks
+### Callbacks after forking
 
 You might want to run code after Spring forked off the process but
 before the actual command is run. You might want to use an
@@ -301,22 +318,23 @@ end
 If you want to register multiple callbacks you can simply call
 `Spring.after_fork` multiple times with different blocks.
 
-### tmp directory
-
-Spring needs a tmp directory. This will default to `Rails.root.join('tmp', 'spring')`.
-You can set your own configuration directory by setting the `SPRING_TMP_PATH` environment variable.
-
 ### Watching files and directories
 
 As mentioned above, Spring will automatically detect file changes to any file loaded when the server
-boots. If you would like to watch additional files or directories, use
-`Spring.watch`:
+boots. If you would like to watch additional files or directories, use `watch`:
 
 ```ruby
-Spring.watch "#{Rails.root}/spec/factories"
+Spring.watch "spec/factories"
 ```
 
-### Filesystem polling
+## Other configuration
+
+### tmp directory
+
+Spring needs a tmp directory. This will default to `Rails.root.join('tmp', 'spring')`.
+You can set your own configuration directory by setting the `SPRING_TMP_PATH` environment variable.
+
+### Filesystem polling speed
 
 By default Spring will check the filesystem for changes once every 0.2 seconds. This
 method requires zero configuration, but if you find that it's using too
@@ -326,9 +344,6 @@ adding the following to to your `Gemfile`:
 ```ruby
 group :development, :test do
   gem 'listen'
-  gem 'rb-inotify', :require => false  # linux
-  gem 'rb-fsevent', :require => false  # mac os x
-  gem 'rb-kqueue',  :require => false  # bsd
 end
 ```
 

data/bin/spring

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
 
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 require 'spring/client'
 Spring::Client.run(ARGV)

data/lib/spring/application.rb

@@ -24,7 +24,7 @@ module Spring
       # The test environment has config.cache_classes = true set by default.
       # However, we don't want this to prevent us from performing class reloading,
       # so this gets around that.
-      Rails::Application.initializer :initialize_dependency_mechanism, group: :all do
+      ::Rails::Application.initializer :initialize_dependency_mechanism, group: :all do
         ActiveSupport::Dependencies.mechanism = :load
       end
 

data/lib/spring/application_manager.rb

@@ -4,11 +4,10 @@ require "spring/application"
 
 module Spring
   class ApplicationManager
-    attr_reader :pid, :child, :app_env, :spring_env
-
-    def initialize(app_env)
-      super()
+    attr_reader :pid, :child, :app_env, :spring_env, :server
 
+    def initialize(server, app_env)
+      @server     = server
       @app_env    = app_env
       @spring_env = Env.new
       @mutex      = Mutex.new
@@ -78,6 +77,8 @@ module Spring
     private
 
     def start_child(silence = false)
+      server.application_starting
+
       @child, child_socket = UNIXSocket.pair
       @pid = fork {
         [STDOUT, STDERR].each { |s| s.reopen('/dev/null', 'w') } if silence

data/lib/spring/client/run.rb

@@ -29,7 +29,7 @@ module Spring
 
       def boot_server
         env.socket_path.unlink if env.socket_path.exist?
-        Process.spawn("spring", "start")
+        Process.spawn(BINFILE, "start")
         sleep 0.1 until env.socket_path.exist?
       end
 
@@ -48,7 +48,7 @@ ERROR
 
       def connect_to_application(client)
         server.send_io client
-        send_json server, args: args, env: ENV
+        send_json server, args: args, env: ENV.to_hash
         server.gets or raise CommandNotFound
       end
 

data/lib/spring/commands.rb

@@ -1,3 +1,5 @@
+require "spring/watcher"
+
 # If the config/spring.rb contains requires for commands from other gems,
 # then we need to be under bundler.
 require "bundler/setup"
@@ -71,17 +73,18 @@ MESSAGE
       end
 
       def call(args)
-        if args.size > 0
-          ARGV.replace args
-          path = File.expand_path(args.first)
+        if args.empty?
+          args = ['test']
+        end
 
+        ARGV.replace args
+        args.each do |arg|
+          path = File.expand_path(arg)
           if File.directory?(path)
             Dir[File.join path, "**", "*_test.rb"].each { |f| require f }
           else
             require path
           end
-        else
-          $stderr.puts "you need to specify what test to run: spring test TEST_NAME"
         end
       end
 
@@ -107,7 +110,7 @@ MESSAGE
 
       def call(args)
         $0 = "rspec"
-        ::RSpec::Core::Runner.run(args)
+        Kernel.exit ::RSpec::Core::Runner.run(args)
       end
 
       def description
@@ -127,7 +130,9 @@ MESSAGE
       end
 
       def call(args)
-        ::Cucumber::Cli::Main.execute(args)
+        # Cucumber's execute funtion returns `true` if any of the steps failed or
+        # some other error occured.
+        Kernel.exit(1) if ::Cucumber::Cli::Main.execute(args)
       end
 
       def description
@@ -137,6 +142,21 @@ MESSAGE
     Spring.register_command "cucumber", Cucumber.new
 
     class Rake < Command
+      class << self
+        attr_accessor :environment_matchers
+      end
+
+      self.environment_matchers = {
+        /^(test|spec|cucumber)($|:)/ => "test"
+      }
+
+      def env(args)
+        self.class.environment_matchers.each do |matcher, environment|
+          return environment if matcher === args.first
+        end
+        nil
+      end
+
       def setup
         super
         require "rake"
@@ -154,8 +174,8 @@ MESSAGE
     Spring.register_command "rake", Rake.new
 
     class RailsConsole < Command
-      def env(tail)
-        tail.first if tail.first && !tail.first.index("-")
+      def env(args)
+        args.first if args.first && !args.first.index("-")
       end
 
       def setup

data/lib/spring/env.rb

@@ -6,6 +6,7 @@ require "spring/sid"
 
 module Spring
   IGNORE_SIGNALS = %w(INT QUIT)
+  BINFILE        = File.expand_path("../../../bin/spring", __FILE__)
 
   class Env
     attr_reader :root
@@ -48,12 +49,10 @@ module Spring
     end
 
     def server_running?
-      if pidfile_path.exist?
-        pidfile = pidfile_path.open('r')
-        !pidfile.flock(File::LOCK_EX | File::LOCK_NB)
-      else
-        false
-      end
+      pidfile = pidfile_path.open('r')
+      !pidfile.flock(File::LOCK_EX | File::LOCK_NB)
+    rescue Errno::ENOENT
+      false
     ensure
       if pidfile
         pidfile.flock(File::LOCK_UN)
@@ -61,6 +60,10 @@ module Spring
       end
     end
 
+    def bundle_mtime
+      [Bundler.default_lockfile, Bundler.default_gemfile].select(&:exist?).map(&:mtime).max
+    end
+
     private
 
     def default_tmp_path

data/lib/spring/server.rb

@@ -1,8 +1,11 @@
 require "socket"
+require "thread"
 
 require "spring/env"
 require "spring/application_manager"
 require "spring/process_title_updater"
+
+# Must be last, as it requires bundler/setup
 require "spring/commands"
 
 # readline must be required before we setpgid, otherwise the require may hang,
@@ -19,17 +22,19 @@ module Spring
 
     def initialize(env = Env.new)
       @env          = env
-      @applications = Hash.new { |h, k| h[k] = ApplicationManager.new(k) }
+      @applications = Hash.new { |h, k| h[k] = ApplicationManager.new(self, k) }
       @pidfile      = env.pidfile_path.open('a')
+      @mutex        = Mutex.new
     end
 
     def boot
+      write_pidfile
       set_pgid
       ignore_signals
       set_exit_hook
-      write_pidfile
       redirect_output
       set_process_title
+      watch_bundle
 
       server = UNIXServer.open(env.socket_name)
       loop { serve server.accept }
@@ -78,15 +83,15 @@ module Spring
     def set_exit_hook
       server_pid = Process.pid
 
-      at_exit do
-        # We don't want this hook to run in any forks of the current process
-        if Process.pid == server_pid
-          [env.socket_path, env.pidfile_path].each do |path|
-            path.unlink if path.exist?
-          end
+      # We don't want this hook to run in any forks of the current process
+      at_exit { shutdown if Process.pid == server_pid }
+    end
+
+    def shutdown
+      @applications.values.each(&:stop)
 
-          @applications.values.each(&:stop)
-        end
+      [env.socket_path, env.pidfile_path].each do |path|
+        path.unlink if path.exist?
       end
     end
 
@@ -96,7 +101,6 @@ module Spring
         @pidfile.write("#{Process.pid}\n")
         @pidfile.fsync
       else
-        $stderr.puts "#{@pidfile.path} is locked; it looks like a server is already running"
         exit 1
       end
     end
@@ -121,5 +125,13 @@ module Spring
         "spring server | #{env.app_name} | started #{distance} ago"
       }
     end
+
+    def watch_bundle
+      @bundle_mtime = env.bundle_mtime
+    end
+
+    def application_starting
+      @mutex.synchronize { exit if env.bundle_mtime != @bundle_mtime }
+    end
   end
 end

data/lib/spring/version.rb

@@ -1,3 +1,3 @@
 module Spring
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/spring/watcher/listen.rb

@@ -5,6 +5,7 @@ module Spring
 
       def self.available?
         require "listen"
+        require "listen/version"
         true
       rescue LoadError
         false
@@ -12,10 +13,15 @@ module Spring
 
       def start
         unless @listener
-          @listener = ::Listen::MultiListener.new(*base_directories)
+          @listener = ::Listen.to(*base_directories, relative_paths: false)
           @listener.latency(latency)
           @listener.change(&method(:changed))
-          @listener.start(false)
+
+          if ::Listen::VERSION >= "1.0.0"
+            @listener.start
+          else
+            @listener.start(false)
+          end
         end
       end
 
@@ -45,9 +51,10 @@ module Spring
       end
 
       def base_directories
-        [root] +
+        ([root] +
           files.reject       { |f| f.start_with? root }.map { |f| File.expand_path("#{f}/..") } +
           directories.reject { |d| d.start_with? root }
+        ).uniq
       end
     end
   end

data/test/acceptance/app_test.rb

@@ -6,6 +6,8 @@ require "spring/env"
 require "pty"
 
 class AppTest < ActiveSupport::TestCase
+  DEFAULT_TIMEOUT = ENV['CI'] ? 30 : 10
+
   def app_root
     Pathname.new("#{TEST_ROOT}/apps/rails-3-2")
   end
@@ -30,12 +32,16 @@ class AppTest < ActiveSupport::TestCase
     @stderr ||= IO.pipe
   end
 
+  def env
+    @env ||= {"GEM_HOME" => gem_home.to_s, "GEM_PATH" => ""}
+  end
+
   def app_run(command, opts = {})
     start_time = Time.now
 
     Bundler.with_clean_env do
       Process.spawn(
-        { "GEM_HOME" => gem_home.to_s, "GEM_PATH" => "" },
+        env,
         command.to_s,
         out:   stdout.last,
         err:   stderr.last,
@@ -44,7 +50,7 @@ class AppTest < ActiveSupport::TestCase
       )
     end
 
-    _, status = Timeout.timeout(opts.fetch(:timeout, 10)) { Process.wait2 }
+    _, status = Timeout.timeout(opts.fetch(:timeout, DEFAULT_TIMEOUT)) { Process.wait2 }
 
     stdout, stderr = read_streams
     puts dump_streams(command, stdout, stderr) if ENV["SPRING_DEBUG"]
@@ -63,7 +69,7 @@ class AppTest < ActiveSupport::TestCase
   def read_streams
     [stdout, stderr].map(&:first).map do |stream|
       output = ""
-      output << stream.readpartial(10240) while IO.select([stream], [], [], 0.1)
+      output << stream.readpartial(10240) while IO.select([stream], [], [], 0.5)
       output
     end
   end
@@ -98,13 +104,13 @@ class AppTest < ActiveSupport::TestCase
 
   def assert_success(command, expected_output = nil)
     artifacts = app_run(command)
-    assert artifacts[:status].success?, "expected successful exit status"
+    assert artifacts[:status].success?, "expected successful exit status\n\n#{dump_streams(command, *artifacts.values_at(:stdout, :stderr))}"
     assert_output artifacts, expected_output if expected_output
   end
 
   def assert_failure(command, expected_output = nil)
     artifacts = app_run(command)
-    assert !artifacts[:status].success?, "expected unsuccessful exit status"
+    assert !artifacts[:status].success?, "expected unsuccessful exit status\n\n#{dump_streams(command, *artifacts.values_at(:stdout, :stderr))}"
     assert_output artifacts, expected_output if expected_output
   end
 
@@ -124,6 +130,8 @@ class AppTest < ActiveSupport::TestCase
   setup do
     @test                = "#{app_root}/test/functional/posts_controller_test.rb"
     @test_contents       = File.read(@test)
+    @spec                = "#{app_root}/spec/dummy_spec.rb"
+    @spec_contents       = File.read(@spec)
     @controller          = "#{app_root}/app/controllers/posts_controller.rb"
     @controller_contents = File.read(@controller)
 
@@ -143,6 +151,7 @@ class AppTest < ActiveSupport::TestCase
   teardown do
     app_run "#{spring} stop"
     File.write(@test,       @test_contents)
+    File.write(@spec,       @spec_contents)
     File.write(@controller, @controller_contents)
   end
 
@@ -311,4 +320,33 @@ class AppTest < ActiveSupport::TestCase
     assert_success "#{spring} rails runner -e staging 'puts Rails.env'", stdout: "staging"
     assert_success "#{spring} rails runner --environment=staging 'puts Rails.env'", stdout: "staging"
   end
+
+  test "exit code for failing specs" do
+    assert_success "#{spring} rspec"
+    File.write(@spec, @spec_contents.sub("true.should be_true", "false.should be_true"))
+    assert_failure "#{spring} rspec"
+  end
+
+  test "selecting rails environment for rake" do
+    env['RAILS_ENV'] = 'staging'
+    assert_success "#{spring} rake -p 'ENV[\"RAILS_ENV\"]'", stdout: "staging"
+  end
+
+  test "changing the Gemfile restarts the server" do
+    begin
+      gemfile = app_root.join("Gemfile")
+      gemfile_contents = gemfile.read
+
+      assert_success %(#{spring} rails runner 'require "rspec"')
+
+      File.write(gemfile, gemfile_contents.sub(%{gem 'rspec'}, %{# gem 'rspec'}))
+      app_run "bundle check"
+
+      await_reload
+      assert_failure %(#{spring} rails runner 'require "rspec"'), stderr: "cannot load such file -- rspec"
+    ensure
+      File.write(gemfile, gemfile_contents)
+      assert_success "bundle check"
+    end
+  end
 end

data/test/apps/rails-3-2/Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gem 'rails', '~> 3.2.0'
 gem 'sqlite3'
+gem 'rspec'
 
 # gem 'listen'
 gem 'rb-inotify', :require => false  # linux

data/test/apps/rails-3-2/spec/dummy_spec.rb

@@ -0,0 +1,5 @@
+describe "behaviour" do
+  it "passes" do
+    true.should be_true
+  end
+end

data/test/unit/commands_test.rb

@@ -2,20 +2,6 @@ require "helper"
 require "spring/commands"
 
 class CommandsTest < ActiveSupport::TestCase
-  test "test command needs a test name" do
-    begin
-      real_stderr = $stderr
-      $stderr = StringIO.new('')
-
-      command = Spring::Commands::TestUnit.new
-      command.call([])
-
-      assert_equal "you need to specify what test to run: spring test TEST_NAME\n", $stderr.string
-    ensure
-      $stderr = real_stderr
-    end
-  end
-
   test 'children of Command have inheritable accessor named "preload"' do
     command1, command2 = 2.times.map { Class.new(Spring::Commands::Command) }
 
@@ -75,4 +61,13 @@ class CommandsTest < ActiveSupport::TestCase
     command = Spring::Commands::RailsRunner.new
     assert_nil command.env(['puts 1+1'])
   end
+
+  test "rake command has configurable environments" do
+    command = Spring::Commands::Rake.new
+    assert_nil command.env(["foo"])
+    assert_equal "test", command.env(["test"])
+    assert_equal "test", command.env(["test:models"])
+    assert_equal "test", command.env(["spec"])
+    assert_nil command.env(["test_foo"])
+  end
 end

data/test/unit/watcher_test.rb

@@ -3,7 +3,8 @@ require "tmpdir"
 require "fileutils"
 require "active_support/core_ext/numeric/time"
 require "spring/watcher"
-require "listen"
+
+raise "listen not loaded" unless Spring::Watcher::Listen.available?
 
 module WatcherTests
   LATENCY = 0.001

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spring
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-22 00:00:00.000000000 Z
+date: 2013-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -137,12 +137,12 @@ files:
 - test/apps/rails-3-2/public/index.html
 - test/apps/rails-3-2/public/robots.txt
 - test/apps/rails-3-2/script/rails
+- test/apps/rails-3-2/spec/dummy_spec.rb
 - test/apps/rails-3-2/test/fixtures/.gitkeep
 - test/apps/rails-3-2/test/fixtures/posts.yml
 - test/apps/rails-3-2/test/functional/.gitkeep
 - test/apps/rails-3-2/test/functional/posts_controller_test.rb
 - test/apps/rails-3-2/test/integration/.gitkeep
-- test/apps/rails-3-2/test/performance/browsing_test.rb
 - test/apps/rails-3-2/test/test_helper.rb
 - test/apps/rails-3-2/test/unit/.gitkeep
 - test/apps/rails-3-2/test/unit/helpers/posts_helper_test.rb
@@ -234,12 +234,12 @@ test_files:
 - test/apps/rails-3-2/public/index.html
 - test/apps/rails-3-2/public/robots.txt
 - test/apps/rails-3-2/script/rails
+- test/apps/rails-3-2/spec/dummy_spec.rb
 - test/apps/rails-3-2/test/fixtures/.gitkeep
 - test/apps/rails-3-2/test/fixtures/posts.yml
 - test/apps/rails-3-2/test/functional/.gitkeep
 - test/apps/rails-3-2/test/functional/posts_controller_test.rb
 - test/apps/rails-3-2/test/integration/.gitkeep
-- test/apps/rails-3-2/test/performance/browsing_test.rb
 - test/apps/rails-3-2/test/test_helper.rb
 - test/apps/rails-3-2/test/unit/.gitkeep
 - test/apps/rails-3-2/test/unit/helpers/posts_helper_test.rb

data/test/apps/rails-3-2/test/performance/browsing_test.rb

@@ -1,12 +0,0 @@
-require 'test_helper'
-require 'rails/performance_test_help'
-
-class BrowsingTest < ActionDispatch::PerformanceTest
-  # Refer to the documentation for all available options
-  # self.profile_options = { :runs => 5, :metrics => [:wall_time, :memory]
-  #                          :output => 'tmp/performance', :formats => [:flat] }
-
-  def test_homepage
-    get '/'
-  end
-end