spring 1.0.0 → 1.3.0

data/lib/spring/test/application.rb

@@ -0,0 +1,217 @@
+require "spring/env"
+
+module Spring
+  module Test
+    class Application
+      DEFAULT_TIMEOUT = ENV['CI'] ? 30 : 10
+
+      attr_reader :root, :spring_env
+
+      def initialize(root)
+        @root       = Pathname.new(root)
+        @spring_env = Spring::Env.new(root)
+      end
+
+      def exists?
+        root.exist?
+      end
+
+      def stdout
+        @stdout ||= IO.pipe
+      end
+
+      def stderr
+        @stderr ||= IO.pipe
+      end
+
+      def log_file
+        @log_file ||= path("tmp/spring.log").open("w+")
+      end
+
+      def env
+        @env ||= {
+          "GEM_HOME"   => gem_home.to_s,
+          "GEM_PATH"   => gem_home.to_s,
+          "HOME"       => user_home.to_s,
+          "RAILS_ENV"  => nil,
+          "RACK_ENV"   => nil,
+          "SPRING_LOG" => log_file.path
+        }
+      end
+
+      def path(addition)
+        root.join addition
+      end
+
+      def gemfile
+        path "Gemfile"
+      end
+
+      def gem_home
+        path "vendor/gems/#{RUBY_VERSION}"
+      end
+
+      def user_home
+        path "user_home"
+      end
+
+      def spring
+        gem_home.join "bin/spring"
+      end
+
+      def rails_version
+        @rails_version ||= RailsVersion.new(gemfile.read.match(/gem 'rails', '(.*)'/)[1])
+      end
+
+      def spring_test_command
+        "#{rails_version.test_command} #{test}"
+      end
+
+      def stop_spring
+        run "#{spring} stop"
+      rescue Errno::ENOENT
+      end
+
+      def test
+        path "test/#{rails_version.controller_tests_dir}/posts_controller_test.rb"
+      end
+
+      def controller
+        path "app/controllers/posts_controller.rb"
+      end
+
+      def application_config
+        path "config/application.rb"
+      end
+
+      def spring_config
+        path "config/spring.rb"
+      end
+
+      def run(command, opts = {})
+        start_time = Time.now
+
+        Bundler.with_clean_env do
+          Process.spawn(
+            env,
+            command.to_s,
+            out:   stdout.last,
+            err:   stderr.last,
+            in:    :close,
+            chdir: root.to_s,
+          )
+        end
+
+        _, status = Timeout.timeout(opts.fetch(:timeout, DEFAULT_TIMEOUT)) { Process.wait2 }
+
+        if pid = spring_env.pid
+          @server_pid = pid
+          lines = `ps -A -o ppid= -o pid= | egrep '^\\s*#{@server_pid}'`.lines
+          @application_pids = lines.map { |l| l.split.last.to_i }
+        end
+
+        output = read_streams
+        puts dump_streams(command, output) if ENV["SPRING_DEBUG"]
+
+        @times << (Time.now - start_time) if @times
+
+        output.merge(status: status, command: command)
+      rescue Timeout::Error => e
+        raise e, "Output:\n\n#{dump_streams(command, read_streams)}"
+      end
+
+      def with_timing
+        @times = []
+        yield
+      ensure
+        @times = nil
+      end
+
+      def last_time
+        @times.last
+      end
+
+      def first_time
+        @times.first
+      end
+
+      def timing_ratio
+        last_time / first_time
+      end
+
+      def read_streams
+        {
+          stdout: read_stream(stdout.first),
+          stderr: read_stream(stderr.first),
+          log:    read_stream(log_file)
+        }
+      end
+
+      def read_stream(stream)
+        output = ""
+        while IO.select([stream], [], [], 0.5) && !stream.eof?
+          output << stream.readpartial(10240)
+        end
+        output
+      end
+
+      def dump_streams(command, streams)
+        output = "$ #{command}\n"
+
+        streams.each do |name, stream|
+          unless stream.chomp.empty?
+            output << "--- #{name} ---\n"
+            output << "#{stream.chomp}\n"
+          end
+        end
+
+        output << "\n"
+        output
+      end
+
+      def debug(artifacts)
+        artifacts = artifacts.dup
+        artifacts.delete :status
+        dump_streams(artifacts.delete(:command), artifacts)
+      end
+
+      def await_reload
+        raise "no pid" if @application_pids.nil? || @application_pids.empty?
+
+        Timeout.timeout(DEFAULT_TIMEOUT) do
+          sleep 0.1 while @application_pids.any? { |p| process_alive?(p) }
+        end
+      end
+
+      def run!(command, options = {})
+        attempts  = (options.delete(:retry) || 0) + 1
+        artifacts = nil
+
+        until attempts == 0 || artifacts && artifacts[:status].success?
+          artifacts = run(command, options)
+          attempts -= 1
+        end
+
+        if artifacts[:status].success?
+          artifacts
+        else
+          raise "command failed\n\n#{debug(artifacts)}"
+        end
+      end
+
+      def bundle
+        run! "(gem list bundler | grep bundler) || gem install bundler", timeout: nil, retry: 2
+        run! "bundle check || bundle update --retry=2", timeout: nil
+      end
+
+      private
+
+      def process_alive?(pid)
+        Process.kill 0, pid
+        true
+      rescue Errno::ESRCH
+        false
+      end
+    end
+  end
+end

data/lib/spring/test/application_generator.rb

@@ -0,0 +1,121 @@
+module Spring
+  module Test
+    class ApplicationGenerator
+      attr_reader :version_constraint, :version, :application
+
+      def initialize(version_constraint)
+        @version_constraint = version_constraint
+        @version            = RailsVersion.new(version_constraint.split(' ').last)
+        @application        = Application.new(root)
+        @bundled            = false
+      end
+
+      def test_root
+        Pathname.new Spring::Test.root
+      end
+
+      def root
+        test_root.join("apps/rails-#{version.major}-#{version.minor}-spring-#{Spring::VERSION}")
+      end
+
+      def system(command)
+        if ENV["SPRING_DEBUG"]
+          puts "$ #{command}\n"
+        else
+          command = "(#{command}) > /dev/null"
+        end
+
+        Kernel.system(command) or raise "command failed: #{command}"
+        puts if ENV["SPRING_DEBUG"]
+      end
+
+      def generate
+        Bundler.with_clean_env { generate_files }
+        install_spring
+        generate_scaffold
+      end
+
+      # Sporadic SSL errors keep causing test failures so there are anti-SSL workarounds here
+      def generate_files
+        system("gem list '^rails$' --installed --version '#{version_constraint}' || " \
+                 "gem install rails --clear-sources --source http://rubygems.org --version '#{version_constraint}'")
+
+        @version = RailsVersion.new(`ruby -e 'puts Gem::Specification.find_by_name("rails", "#{version_constraint}").version'`.chomp)
+
+        skips = %w(--skip-bundle --skip-javascript --skip-sprockets)
+        skips << "--skip-spring" if version.bundles_spring?
+
+        system("rails _#{version}_ new #{application.root} #{skips.join(' ')}")
+        raise "application generation failed" unless application.exists?
+
+        FileUtils.mkdir_p(application.gem_home)
+        FileUtils.mkdir_p(application.user_home)
+        FileUtils.rm_rf(application.path("test/performance"))
+
+        File.write(application.gemfile, "#{application.gemfile.read}gem 'spring', '#{Spring::VERSION}'\n")
+
+        if version.needs_testunit?
+          File.write(application.gemfile, "#{application.gemfile.read}gem 'spring-commands-testunit'\n")
+        end
+
+        File.write(application.gemfile, application.gemfile.read.sub("https://rubygems.org", "http://rubygems.org"))
+
+        if application.path("bin").exist?
+          FileUtils.cp_r(application.path("bin"), application.path("bin_original"))
+        end
+      end
+
+      def generate_if_missing
+        generate unless application.exists?
+      end
+
+      def install_spring
+        return if @installed
+
+        build_and_install_gems
+
+        application.bundle
+
+        FileUtils.rm_rf application.path("bin")
+
+        if application.path("bin_original").exist?
+          FileUtils.cp_r application.path("bin_original"), application.path("bin")
+        end
+
+        application.run! "#{application.spring} binstub --all"
+        @installed = true
+      end
+
+      def manually_built_gems
+        %w(spring)
+      end
+
+      def build_and_install_gems
+        manually_built_gems.each do |name|
+          spec = Gem::Specification.find_by_name(name)
+
+          FileUtils.cd(spec.gem_dir) do
+            FileUtils.rm(Dir.glob("#{name}-*.gem"))
+            system("gem build #{name}.gemspec 2>&1")
+          end
+
+          application.run! "gem install #{spec.gem_dir}/#{name}-*.gem", timeout: nil
+        end
+      end
+
+      def copy_to(path)
+        system("rm -rf #{path}")
+        system("cp -r #{application.root} #{path}")
+      end
+
+      def generate_scaffold
+        application.run! "bundle exec rails g scaffold post title:string"
+        application.run! "bundle exec rake db:migrate db:test:clone"
+      end
+
+      def gemspec(name)
+        "#{Gem::Specification.find_by_name(name).gem_dir}/#{name}.gemspec"
+      end
+    end
+  end
+end

data/lib/spring/test/rails_version.rb

@@ -0,0 +1,40 @@
+module Spring
+  module Test
+    class RailsVersion
+      attr_reader :version
+
+      def initialize(string)
+        @version = Gem::Version.new(string)
+      end
+
+      def rails_3?
+        version < Gem::Version.new("4.0.0")
+      end
+      alias needs_testunit? rails_3?
+
+      def test_command
+        needs_testunit? ? 'bin/testunit' : 'bin/rake test'
+      end
+
+      def controller_tests_dir
+        rails_3? ? 'functional' : 'controllers'
+      end
+
+      def bundles_spring?
+        version.segments.take(2) == [4, 1] || version > Gem::Version.new("4.1")
+      end
+
+      def major
+        version.segments[0]
+      end
+
+      def minor
+        version.segments[1]
+      end
+
+      def to_s
+        version.to_s
+      end
+    end
+  end
+end

data/lib/spring/test/watcher_test.rb

@@ -0,0 +1,167 @@
+require "tmpdir"
+require "fileutils"
+require "timeout"
+require "active_support/core_ext/numeric/time"
+
+module Spring
+  module Test
+    class WatcherTest < ActiveSupport::TestCase
+      runnables.delete self # prevent Minitest running this class
+
+      LATENCY = 0.001
+      TIMEOUT = 1
+
+      attr_accessor :dir
+
+      def watcher_class
+        raise NotImplementedError
+      end
+
+      def watcher
+        @watcher ||= watcher_class.new(dir, LATENCY)
+      end
+
+      def setup
+        @dir = File.realpath(Dir.mktmpdir)
+      end
+
+      def teardown
+        FileUtils.remove_entry_secure @dir
+        watcher.stop
+      end
+
+      def touch(file, mtime = nil)
+        options = {}
+        options[:mtime] = mtime if mtime
+        FileUtils.touch(file, options)
+      end
+
+      def assert_stale
+        timeout = Time.now + TIMEOUT
+        sleep LATENCY until watcher.stale? || Time.now > timeout
+        assert watcher.stale?
+      end
+
+      def assert_not_stale
+        sleep LATENCY * 10
+        assert !watcher.stale?
+      end
+
+      test "starting with no file" do
+        file = "#{@dir}/omg"
+        touch file, Time.now - 2.seconds
+
+        watcher.start
+        watcher.add file
+
+        assert_not_stale
+        touch file, Time.now
+        assert_stale
+      end
+
+      test "is stale when a watched file is updated" do
+        file = "#{@dir}/omg"
+        touch file, Time.now - 2.seconds
+
+        watcher.add file
+        watcher.start
+
+        assert_not_stale
+        touch file, Time.now
+        assert_stale
+      end
+
+      test "is stale when removing files" do
+        file = "#{@dir}/omg"
+        touch file, Time.now
+
+        watcher.add file
+        watcher.start
+
+        assert_not_stale
+        FileUtils.rm(file)
+        assert_stale
+      end
+
+      test "is stale when files are added to a watched directory" do
+        subdir = "#{@dir}/subdir"
+        FileUtils.mkdir(subdir)
+
+        watcher.add subdir
+        watcher.start
+
+        assert_not_stale
+        touch "#{subdir}/foo", Time.now - 1.minute
+        assert_stale
+      end
+
+      test "is stale when a file is changed in a watched directory" do
+        subdir = "#{@dir}/subdir"
+        FileUtils.mkdir(subdir)
+        touch "#{subdir}/foo", Time.now - 1.minute
+
+        watcher.add subdir
+        watcher.start
+
+        assert_not_stale
+        touch "#{subdir}/foo", Time.now
+        assert_stale
+      end
+
+      test "adding doesn't wipe stale state" do
+        file = "#{@dir}/omg"
+        file2 = "#{@dir}/foo"
+        touch file, Time.now - 2.seconds
+        touch file2, Time.now - 2.seconds
+
+        watcher.add file
+        watcher.start
+
+        assert_not_stale
+
+        touch file, Time.now
+        watcher.add file2
+
+        assert_stale
+      end
+
+      test "on stale" do
+        file = "#{@dir}/omg"
+        touch file, Time.now - 2.seconds
+
+        stale = false
+        watcher.on_stale { stale = true }
+
+        watcher.add file
+        watcher.start
+
+        touch file, Time.now
+
+        Timeout.timeout(1) { sleep 0.01 until stale }
+        assert stale
+
+        # Check that we only get notified once
+        stale = false
+        sleep LATENCY * 3
+        assert !stale
+      end
+
+      test "add relative path" do
+        File.write("#{dir}/foo", "foo")
+        watcher.add "foo"
+        assert_equal ["#{dir}/foo"], watcher.files.to_a
+      end
+
+      test "add dot relative path" do
+        File.write("#{dir}/foo", "foo")
+        watcher.add "./foo"
+        assert_equal ["#{dir}/foo"], watcher.files.to_a
+      end
+
+      test "add non existent file" do
+        watcher.add './foobar'
+        assert watcher.files.empty?
+      end
+    end
+  end
+end

data/lib/spring/test.rb

@@ -0,0 +1,18 @@
+require "active_support"
+require "active_support/test_case"
+
+ActiveSupport.test_order = :random
+
+module Spring
+  module Test
+    class << self
+      attr_accessor :root
+    end
+
+    require "spring/test/application"
+    require "spring/test/application_generator"
+    require "spring/test/rails_version"
+    require "spring/test/watcher_test"
+    require "spring/test/acceptance_test"
+  end
+end

data/lib/spring/version.rb

@@ -1,3 +1,3 @@
 module Spring
-  VERSION = "1.0.0"
+  VERSION = "1.3.0"
 end

data/lib/spring/watcher/abstract.rb

@@ -22,7 +22,7 @@ module Spring
         @files       = Set.new
         @directories = Set.new
         @stale       = false
-        @io_listener = nil
+        @listeners   = []
       end
 
       def add(*items)
@@ -55,15 +55,14 @@ module Spring
         @stale
       end
 
-      def mark_stale
-        @stale = true
-        @io_listener.write "." if @io_listener
+      def on_stale(&block)
+        @listeners << block
       end
 
-      def to_io
-        read, write = IO.pipe
-        @io_listener = write
-        read
+      def mark_stale
+        return if stale?
+        @stale = true
+        @listeners.each(&:call)
       end
 
       def restart

data/lib/spring/watcher/polling.rb

@@ -1,3 +1,5 @@
+require "spring/watcher"
+
 module Spring
   module Watcher
     class Polling < Abstract

data/lib/spring/watcher.rb

@@ -9,15 +9,11 @@ module Spring
   end
 
   def self.watch_method=(method)
-    case method
-    when :polling
-      require_relative "watcher/polling"
-      @watch_method = Watcher::Polling
-    when :listen
-      require_relative "watcher/listen"
-      @watch_method = Watcher::Listen
-    else
+    if method.is_a?(Class)
       @watch_method = method
+    else
+      require "spring/watcher/#{method}"
+      @watch_method = Watcher.const_get(method.to_s.gsub(/(^.|_.)/) { $1[-1].upcase })
     end
   end
 

data/spring.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   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.homepage      = "http://github.com/rails/spring"
   gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($/)
@@ -18,6 +18,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency 'activesupport'
+  gem.add_development_dependency 'activesupport', '~> 4.2.0'
   gem.add_development_dependency 'rake'
 end

data/test/acceptance_test.rb

@@ -0,0 +1,4 @@
+require "helper"
+
+class AcceptanceTest < Spring::Test::AcceptanceTest
+end

data/test/helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
 require "bundler/setup"
-require "active_support/test_case"
 require "minitest/autorun"
 
-TEST_ROOT = File.expand_path('..', __FILE__)
+require "spring/test"
+Spring::Test.root = File.expand_path('..', __FILE__)

data/test/unit/client/version_test.rb

@@ -0,0 +1,14 @@
+require 'helper'
+require 'spring/client'
+
+class VersionTest < ActiveSupport::TestCase
+  test "outputs current version number" do
+    version = Spring::Client::Version.new 'version'
+
+    out, err = capture_io do
+      version.call
+    end
+
+    assert_equal "Spring version #{Spring::VERSION}", out.chomp
+  end
+end