spring 0.0.5 → 0.0.6

data/lib/spring/server.rb

@@ -3,7 +3,7 @@ require "socket"
 require "spring/env"
 require "spring/application_manager"
 
-class Spring
+module Spring
   class Server
     def self.boot
       new.boot
@@ -25,15 +25,20 @@ class Spring
       set_exit_hook
       write_pidfile
 
+      $0 = "spring server | #{env.app_name} | started #{Time.now}"
+
       server = UNIXServer.open(env.socket_name)
       loop { serve server.accept }
     end
 
     def serve(client)
+      client.puts env.version
       app_client = client.recv_io
       rails_env  = client.gets.chomp
 
       client.puts @applications[rails_env].run(app_client)
+    rescue SocketError => e
+      raise e unless client.eof?
     end
 
     def set_exit_hook
@@ -45,6 +50,8 @@ class Spring
           [env.socket_path, env.pidfile_path].each do |path|
             path.unlink if path.exist?
           end
+
+          @applications.values.each(&:stop)
         end
       end
     end
@@ -56,7 +63,7 @@ class Spring
         @pidfile.fsync
       else
         STDERR.puts "#{file.path} is locked; it looks like a server is already running"
-        exit(1)
+        exit 1
       end
     end
   end

data/lib/spring/sid.rb

@@ -1,6 +1,6 @@
 require 'fiddle'
 
-class Spring
+module Spring
   module SID
     FUNC = Fiddle::Function.new(
       DL::Handle::DEFAULT['getsid'],

data/lib/spring/version.rb

@@ -1,3 +1,3 @@
-class Spring
-  VERSION = "0.0.5"
+module Spring
+  VERSION = "0.0.6"
 end

data/test/acceptance/app_test.rb

@@ -1,20 +1,28 @@
 require 'helper'
 require 'io/wait'
 require "timeout"
+require "spring/sid"
+require "spring/env"
 
 class AppTest < ActiveSupport::TestCase
-  BINFILE = File.expand_path('../bin/spring', TEST_ROOT)
-
   def app_root
-    "#{TEST_ROOT}/apps/rails-3-2"
+    Pathname.new("#{TEST_ROOT}/apps/rails-3-2")
   end
 
   def server_pidfile
     "#{app_root}/tmp/spring/#{Spring::SID.sid}.pid"
   end
 
+  def spring_env
+    @spring_env ||= Spring::Env.new(app_root)
+  end
+
   def server_pid
-    File.exist?(server_pidfile) ? File.read(server_pidfile).to_i : nil
+    spring_env.pid
+  end
+
+  def server_running?
+    spring_env.server_running?
   end
 
   def stdout
@@ -30,10 +38,15 @@ class AppTest < ActiveSupport::TestCase
 
     Bundler.with_clean_env do
       Process.spawn(
+        {
+          "GEM_HOME" => "#{app_root}/vendor/gems",
+          "GEM_PATH" => "",
+          "PATH"     => "#{app_root}/vendor/gems/bin:#{ENV["PATH"]}"
+        },
         command,
         out:   stdout.last,
         err:   stderr.last,
-        chdir: app_root,
+        chdir: app_root.to_s,
       )
     end
 
@@ -41,7 +54,9 @@ class AppTest < ActiveSupport::TestCase
 
     out, err = read_streams
 
-    @times << (Time.now - start_time) if opts.fetch(:timer, true)
+    @times << (Time.now - start_time) if @times
+
+    print_streams(out, err) if ENV["SPRING_DEBUG"]
 
     [status, out, err]
   rescue Timeout::Error
@@ -62,17 +77,17 @@ class AppTest < ActiveSupport::TestCase
   end
 
   def await_reload
-    sleep 0.2
+    sleep 0.4
   end
 
   def assert_successful_run(*args)
     status, _, _ = app_run(*args)
-    assert status.success?, 'The run should be successful but it was '
+    assert status.success?, "The run should be successful but it wasn't"
   end
 
   def assert_unsuccessful_run(*args)
     status, _, _ = app_run(*args)
-    assert !status.success?, 'The run should not be successful but it was'
+    assert !status.success?, "The run should not be successful but it was"
   end
 
   def assert_stdout(command, expected)
@@ -80,6 +95,11 @@ class AppTest < ActiveSupport::TestCase
     assert stdout.include?(expected), "expected '#{expected}' to be printed to stdout. But it wasn't, the stdout is:\n#{stdout}"
   end
 
+  def assert_stderr(command, expected)
+    _, _, stderr = app_run(command)
+    assert stderr.include?(expected), "expected '#{expected}' to be printed to stderr. But it wasn't, the stderr is:\n#{stderr}"
+  end
+
   def assert_speedup(opts = {})
     ratio  = opts.fetch(:ratio, 0.5)
     from   = opts.fetch(:from, 0)
@@ -89,20 +109,40 @@ class AppTest < ActiveSupport::TestCase
     assert (second / first) < ratio, "#{second} was not less than #{ratio} of #{first}"
   end
 
+  def assert_server_running(*args)
+    assert server_running?, "The server should be running but it isn't"
+  end
+
+  def assert_server_not_running(*args)
+    assert !server_running?, "The server should not be running but it is"
+  end
+
   def test_command
-    "#{BINFILE} test #{@test}"
+    "spring test #{@test}"
   end
 
+  @@installed_spring = false
+
   setup do
     @test                = "#{app_root}/test/functional/posts_controller_test.rb"
     @test_contents       = File.read(@test)
     @controller          = "#{app_root}/app/controllers/posts_controller.rb"
     @controller_contents = File.read(@controller)
 
-    @times = []
+    @spring_env          = Spring::Env.new(app_root)
+
+    unless @@installed_spring
+      system "gem build spring.gemspec 2>/dev/null 1>/dev/null"
+      app_run "gem install ../../../spring-*.gem"
+      @@installed_spring = true
+    end
+
+    FileUtils.rm_rf "#{app_root}/bin"
+    app_run "(gem list bundler | grep bundler) || gem install bundler", timeout: nil
+    app_run "bundle check || bundle update", timeout: nil
+    app_run "bundle exec rake db:migrate"
 
-    app_run "bundle check || bundle update", timer: false, timeout: nil
-    app_run "bundle exec rake db:migrate",   timer: false
+    @times = []
   end
 
   teardown do
@@ -123,7 +163,7 @@ class AppTest < ActiveSupport::TestCase
   end
 
   test "help message when called without arguments" do
-    assert_stdout BINFILE, 'Usage: spring COMMAND [ARGS]'
+    assert_stdout "spring", 'Usage: spring COMMAND [ARGS]'
   end
 
   test "test changes are picked up" do
@@ -176,8 +216,7 @@ class AppTest < ActiveSupport::TestCase
       CODE
       File.write(@test, @test_contents.sub("get :index", "Foo.omg"))
 
-      # Wait twice to give plenty of time for the wait thread to kick in
-      2.times { await_reload }
+      await_reload
 
       assert_stdout test_command, "RuntimeError: omg"
       assert_stdout test_command, "RuntimeError: omg"
@@ -209,11 +248,34 @@ class AppTest < ActiveSupport::TestCase
     end
   end
 
+  test "stop command kills server" do
+    assert_successful_run test_command
+    assert_server_running
+
+    assert_successful_run 'spring stop'
+    assert_server_not_running
+  end
+
   test "custom commands" do
-    assert_stdout "#{BINFILE} custom", "omg"
+    assert_stdout "spring custom", "omg"
   end
 
   test "runner alias" do
-    assert_stdout "#{BINFILE} r 'puts 1'", "1"
+    assert_stdout "spring r 'puts 1'", "1"
+  end
+
+  test "binstubs" do
+    app_run "spring binstub rake"
+    assert_successful_run "bin/spring help"
+    assert_stdout "bin/rake -T", "rake db:migrate"
+  end
+
+  test "missing config/application.rb" do
+    begin
+      FileUtils.mv app_root.join("config/application.rb"), app_root.join("config/application.rb.bak")
+      assert_stderr "spring rake -T", "unable to find your config/application.rb"
+    ensure
+      FileUtils.mv app_root.join("config/application.rb.bak"), app_root.join("config/application.rb")
+    end
   end
 end

data/test/apps/rails-3-2/.gitignore

@@ -13,3 +13,6 @@
 # Ignore all logfiles and tempfiles.
 /log/*.log
 /tmp
+
+/bin
+/vendor/gems/*

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

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
 
-gem 'rails', '~> 3.2.8'
+gem 'rails', '~> 3.2.0'
 gem 'sqlite3'
-gem 'spring', path: '../../..'

data/test/helper.rb

@@ -1,7 +1,6 @@
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
 require "bundler/setup"
-require "spring"
 require "active_support/test_case"
 require "minitest/autorun"
 

data/test/unit/application_watcher_test.rb

@@ -3,7 +3,7 @@ require "fileutils"
 require "active_support/core_ext/numeric/time"
 require "spring/application_watcher"
 
-class ApplicationWatcherTest < Test::Unit::TestCase
+class ApplicationWatcherTest < ActiveSupport::TestCase
   def setup
     @dir = "/tmp/spring"
     FileUtils.mkdir(@dir)
@@ -19,7 +19,7 @@ class ApplicationWatcherTest < Test::Unit::TestCase
     FileUtils.touch(file, options)
   end
 
-  def test_file_mtime
+  test "file mtime" do
     file = "#{@dir}/omg"
     touch file, Time.now - 2.seconds
 
@@ -31,7 +31,19 @@ class ApplicationWatcherTest < Test::Unit::TestCase
     assert watcher.stale?
   end
 
-  def test_glob
+  test "tolerates enoent" do
+    file = "#{@dir}/omg"
+    touch file
+
+    watcher = Spring::ApplicationWatcher.new
+    watcher.add_files [file]
+
+    assert !watcher.stale?
+    FileUtils.rm(file)
+    assert watcher.stale?
+  end
+
+  test "accepts glob patterns" do
     FileUtils.mkdir("#{@dir}/1")
     FileUtils.mkdir("#{@dir}/2")
 

data/test/unit/commands_test.rb

@@ -0,0 +1,34 @@
+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::Test.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 "prints error message when preloaded file does not exist" do
+    begin
+      original_stderr = $stderr
+      $stderr = StringIO.new('')
+      my_command_class = Class.new(Spring::Commands::Command)
+      my_command_class.preloads = %w(i_do_not_exist)
+
+      my_command_class.new.setup
+      assert_match /The #<Class:0x[0-9a-f]+> command tried to preload i_do_not_exist but could not find it./, $stderr.string
+    ensure
+      $stderr = original_stderr
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spring
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-26 00:00:00.000000000 Z
+date: 2013-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,12 +58,19 @@ files:
 - README.md
 - Rakefile
 - bin/spring
-- lib/spring.rb
 - lib/spring/application.rb
 - lib/spring/application_manager.rb
 - lib/spring/application_watcher.rb
+- lib/spring/client.rb
+- lib/spring/client/binstub.rb
+- lib/spring/client/command.rb
+- lib/spring/client/help.rb
+- lib/spring/client/run.rb
+- lib/spring/client/stop.rb
 - lib/spring/commands.rb
+- lib/spring/configuration.rb
 - lib/spring/env.rb
+- lib/spring/errors.rb
 - lib/spring/server.rb
 - lib/spring/sid.rb
 - lib/spring/version.rb
@@ -134,9 +141,11 @@ files:
 - test/apps/rails-3-2/test/unit/post_test.rb
 - test/apps/rails-3-2/vendor/assets/javascripts/.gitkeep
 - test/apps/rails-3-2/vendor/assets/stylesheets/.gitkeep
+- test/apps/rails-3-2/vendor/gems/.gitkeep
 - test/apps/rails-3-2/vendor/plugins/.gitkeep
 - test/helper.rb
 - test/unit/application_watcher_test.rb
+- test/unit/commands_test.rb
 homepage: http://github.com/jonleighton/spring
 licenses: []
 post_install_message: 
@@ -228,6 +237,8 @@ test_files:
 - test/apps/rails-3-2/test/unit/post_test.rb
 - test/apps/rails-3-2/vendor/assets/javascripts/.gitkeep
 - test/apps/rails-3-2/vendor/assets/stylesheets/.gitkeep
+- test/apps/rails-3-2/vendor/gems/.gitkeep
 - test/apps/rails-3-2/vendor/plugins/.gitkeep
 - test/helper.rb
 - test/unit/application_watcher_test.rb
+- test/unit/commands_test.rb

data/lib/spring.rb

@@ -1,151 +0,0 @@
-require "rbconfig"
-require "socket"
-require "pty"
-
-require "spring/version"
-require "spring/sid"
-require "spring/env"
-require "spring/commands"
-
-class Spring
-  SERVER_COMMAND = [
-    File.join(*RbConfig::CONFIG.values_at('bindir', 'RUBY_INSTALL_NAME')),
-    "-I", File.expand_path("../", __FILE__),
-    "-r", "spring/server",
-    "-r", "bundler/setup",
-    "-e", "Spring::Server.boot"
-  ]
-
-  FORWARDED_SIGNALS = %w(INT QUIT USR1 USR2 INFO)
-
-  def self.run(args)
-    exit new.run(args)
-  end
-
-  attr_reader :env
-
-  def initialize
-    @env = Env.new
-  end
-
-  def server_running?
-    if env.pidfile_path.exist?
-      pidfile = env.pidfile_path.open('r')
-      !pidfile.flock(File::LOCK_EX | File::LOCK_NB)
-    else
-      false
-    end
-  ensure
-    if pidfile
-      pidfile.flock(File::LOCK_UN)
-      pidfile.close
-    end
-  end
-
-  # Boot the server into the process group of the current session.
-  # This will cause it to be automatically killed once the session
-  # ends (i.e. when the user closes their terminal).
-  def boot_server
-    env.socket_path.unlink if env.socket_path.exist?
-    Process.spawn(*SERVER_COMMAND, pgroup: SID.pgid)
-    sleep 0.1 until env.socket_path.exist?
-  end
-
-  def run(args)
-    if self.class.command_registered?(args.first)
-      run_command(args)
-    else
-      print_help
-    end
-  end
-
-  private
-
-  def print_help
-    puts <<-EOT
-Usage: spring COMMAND [ARGS]
-
-The most common spring commands are:
- rake        Run a rake task
- console     Start the Rails console
- runner      Execute a command with the Rails runner
- generate    Trigger a Rails generator
-
- test        Execute a Test::Unit test
- rspec       Execute an RSpec spec
-EOT
-    false
-  end
-
-  def run_command(args)
-    boot_server unless server_running?
-
-    application, client = UNIXSocket.pair
-
-    server = UNIXSocket.open(env.socket_name)
-    server.send_io client
-    server.puts rails_env_for(args.first)
-
-    application.send_io STDOUT
-    application.send_io STDERR
-    application.send_io stdin_slave
-
-    application.puts args.length
-
-    args.each do |arg|
-      application.puts  arg.length
-      application.write arg
-    end
-
-    pid = server.gets.chomp
-
-    # We must not close the client socket until we are sure that the application has
-    # received the FD. Otherwise the FD can end up getting closed while it's in the server
-    # socket buffer on OS X. This doesn't happen on Linux.
-    client.close
-
-    if pid.empty?
-      false
-    else
-      forward_signals(pid.to_i)
-      application.read # FIXME: receive exit status from server
-      true
-    end
-  rescue Errno::ECONNRESET
-    false
-  ensure
-    application.close if application
-    server.close if server
-  end
-
-  def rails_env_for(command_name)
-    command = Spring.command(command_name)
-
-    if command.respond_to?(:env)
-      command.env
-    else
-      ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
-    end
-  end
-
-  def stdin_slave
-    master, slave = PTY.open
-
-    # Sadly I cannot find a way to achieve this without shelling out to stty, or
-    # using a C extension library. [Ruby does not have direct support for calling
-    # tcsetattr().] We don't want to use a C extension library so
-    # that spring can be used by Rails in the future.
-    system "stty -icanon -echo"
-    at_exit { system "stty sane" }
-
-    Thread.new { master.write STDIN.read(1) until STDIN.closed? }
-
-    slave
-  end
-
-  def forward_signals(pid)
-    (FORWARDED_SIGNALS & Signal.list.keys).each do |sig|
-      trap(sig) { Process.kill(sig, pid) }
-    end
-  end
-end