spring 0.0.1

data/lib/spring/env.rb

@@ -0,0 +1,30 @@
+require "pathname"
+require "spring/sid"
+
+class Spring
+  class Env
+    attr_reader :root
+
+    def initialize
+      @root = Pathname.new(File.expand_path('.'))
+    end
+
+    def tmp_path
+      path = root.join('tmp/spring')
+      path.mkdir unless path.exist?
+      path
+    end
+
+    def socket_path
+      tmp_path.join(SID.sid.to_s)
+    end
+
+    def socket_name
+      socket_path.to_s
+    end
+
+    def pidfile_path
+      tmp_path.join("#{SID.sid}.pid")
+    end
+  end
+end

data/lib/spring/server.rb

@@ -0,0 +1,59 @@
+require "socket"
+
+require "spring/env"
+require "spring/application_manager"
+
+class Spring
+  class Server
+    def self.boot
+      new.boot
+    end
+
+    attr_reader :env
+
+    def initialize(env = Env.new)
+      @env          = env
+      @applications = Hash.new { |h, k| h[k] = ApplicationManager.new(k) }
+    end
+
+    def boot
+      # Ignore SIGINT, otherwise the user typing ^C on the command line
+      # will kill the background server.
+      trap("INT", "IGNORE")
+
+      set_exit_hook
+      write_pidfile
+
+      server = UNIXServer.open(env.socket_name)
+      loop { @applications[server.accept.read].run server.accept }
+    end
+
+    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
+        end
+      end
+    end
+
+    def write_pidfile
+      file = env.pidfile_path.open('a')
+
+      if file.flock(File::LOCK_EX | File::LOCK_NB)
+        file.truncate(0)
+        file.write("#{Process.pid}\n")
+        file.fsync
+      else
+        STDERR.puts "#{file.path} is locked; it looks like a server is already running"
+        exit(1)
+      end
+    end
+  end
+end
+
+Spring::Server.boot if __FILE__ == $0

data/lib/spring/sid.rb

@@ -0,0 +1,19 @@
+require 'fiddle'
+
+class Spring
+  module SID
+    FUNC = Fiddle::Function.new(
+      DL::Handle::DEFAULT['getsid'],
+      [Fiddle::TYPE_INT],
+      Fiddle::TYPE_INT
+    )
+
+    def self.sid(pid = 0)
+      FUNC.call(pid)
+    end
+
+    def self.pgid
+      Process.getpgid(sid)
+    end
+  end
+end

data/lib/spring/version.rb

@@ -0,0 +1,3 @@
+class Spring
+  VERSION = "0.0.1"
+end

data/spring.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spring/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "spring"
+  gem.version       = Spring::VERSION
+  gem.authors       = ["Jon Leighton"]
+  gem.email         = ["j@jonathanleighton.com"]
+  gem.description   = %q{Rails application preloader}
+  gem.summary       = %q{Rails application preloader}
+  gem.homepage      = "http://github.com/jonleighton/spring"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activesupport'
+end

data/test/acceptance/app_test.rb

@@ -0,0 +1,198 @@
+require 'helper'
+require 'io/wait'
+
+class AppTest < ActiveSupport::TestCase
+  BINFILE = File.expand_path('../bin/spring', TEST_ROOT)
+
+  def app_root
+    "#{TEST_ROOT}/apps/rails-3-2"
+  end
+
+  def server_pidfile
+    "#{app_root}/tmp/spring/#{Spring::SID.sid}.pid"
+  end
+
+  def server_pid
+    File.exist?(server_pidfile) ? File.read(server_pidfile).to_i : nil
+  end
+
+  def stdout
+    @stdout ||= IO.pipe
+  end
+
+  def stderr
+    @stderr ||= IO.pipe
+  end
+
+  def app_run(command, opts = {})
+    start_time = Time.now
+
+    Bundler.with_clean_env do
+      Process.spawn(
+        command,
+        out:   stdout.last,
+        err:   stderr.last,
+        chdir: app_root,
+      )
+    end
+
+    _, status = Process.wait2
+
+    out, err = [stdout, stderr].map(&:first).map { |s| s.ready? ? s.readpartial(10240) : "" }
+
+    @times << (Time.now - start_time) if opts.fetch(:timer, true)
+
+    # p status
+    # puts "---"
+    # puts out
+    # puts "***"
+    # puts err
+    # puts "---"
+
+    [status, out, err]
+  end
+
+  def await_reload
+    sleep 0.2
+  end
+
+  def assert_successful_run(*args)
+    status, _, _ = app_run(*args)
+    assert status.success?
+  end
+
+  def assert_unsuccessful_run(*args)
+    status, _, _ = app_run(*args)
+    assert !status.success?
+  end
+
+  def assert_stdout(command, expected)
+    _, stdout, _ = app_run(command)
+    assert stdout.include?(expected)
+  end
+
+  def assert_speedup(opts = {})
+    ratio  = opts.fetch(:ratio, 0.5)
+    from   = opts.fetch(:from, 0)
+    first  = @times[from]
+    second = @times[from + 1]
+
+    assert (second / first) < ratio, "#{second} was not less than #{ratio} of #{first}"
+  end
+
+  def test_command
+    "#{BINFILE} test #{@test}"
+  end
+
+  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 = []
+
+    app_run "bundle check || bundle update", timer: false
+    app_run "bundle exec rake db:migrate",   timer: false
+  end
+
+  teardown do
+    if pid = server_pid
+      Process.kill('TERM', pid)
+    end
+
+    File.write(@test,       @test_contents)
+    File.write(@controller, @controller_contents)
+  end
+
+  test "basic" do
+    assert_successful_run test_command
+    assert File.exist?(server_pidfile)
+
+    assert_successful_run test_command
+    assert_speedup
+  end
+
+  test "test changes are picked up" do
+    assert_successful_run test_command
+
+    File.write(@test, @test_contents.sub("get :index", "raise 'omg'"))
+    assert_stdout test_command, "RuntimeError: omg"
+
+    assert_speedup
+  end
+
+  test "code changes are picked up" do
+    assert_successful_run test_command
+
+    File.write(@controller, @controller_contents.sub("@posts = Post.all", "raise 'omg'"))
+    assert_stdout test_command, "RuntimeError: omg"
+
+    assert_speedup
+  end
+
+  test "code changes in pre-referenced app files are picked up" do
+    begin
+      initializer = "#{app_root}/config/initializers/load_posts_controller.rb"
+      File.write(initializer, "PostsController\n")
+
+      assert_successful_run test_command
+
+      File.write(@controller, @controller_contents.sub("@posts = Post.all", "raise 'omg'"))
+      assert_stdout test_command, "RuntimeError: omg"
+
+      assert_speedup
+    ensure
+      FileUtils.rm_f(initializer)
+    end
+  end
+
+  test "app gets reloaded when preloaded files change" do
+    begin
+      application = "#{app_root}/config/application.rb"
+      application_contents = File.read(application)
+
+      assert_successful_run test_command
+
+      File.write(application, application_contents + <<-CODE)
+        class Foo
+          def self.omg
+            raise "omg"
+          end
+        end
+      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 }
+
+      assert_stdout test_command, "RuntimeError: omg"
+      assert_stdout test_command, "RuntimeError: omg"
+
+      assert_speedup from: 1
+    ensure
+      File.write(application, application_contents)
+    end
+  end
+
+  test "app recovers when a boot-level error is introduced" do
+    begin
+      application = "#{app_root}/config/application.rb"
+      application_contents = File.read(application)
+
+      assert_successful_run test_command
+
+      File.write(application, application_contents + "\nomg")
+      await_reload
+
+      assert_unsuccessful_run test_command
+
+      File.write(application, application_contents)
+      await_reload
+
+      assert_successful_run test_command
+    ensure
+      File.write(application, application_contents)
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

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

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

data/test/apps/rails-3-2/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.