mr-sparkle 0.0.1 → 0.0.2

data/CHANGES.md

@@ -0,0 +1,7 @@
+### 0.0.2
+
+  * Messages from mr-sparkle now go on stderr, not stdout, just like unicorn's log messages
+
+### 0.0.1
+
+  * Initial release

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |t|
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => [:spec]

data/bin/mr-sparkle

@@ -16,4 +16,4 @@ OptionParser.new do |opts|
   end
 end.parse!
 
-Mr::Sparkle::Daemon.new(options, ARGV).run
+Mr::Sparkle::Daemon.new.run(options, ARGV)

data/lib/mr-sparkle.rb

@@ -10,27 +10,22 @@ module Mr
 
     class Daemon
 
-      def initialize(options, unicorn_args)
-        @reload_pattern = options[:pattern] || DEFAULT_RELOAD_PATTERN
-        @full_reload_pattern = options[:full] || DEFAULT_FULL_RELOAD_PATTERN
-        @unicorn_args = unicorn_args
-      end
-
       def start_unicorn
-        Kernel.spawn('unicorn', '-c',
+        @unicorn_pid = Kernel.spawn('unicorn', '-c',
           File.expand_path('mr-sparkle/unicorn.conf.rb',File.dirname(__FILE__)),
           *@unicorn_args)
       end
 
-      def run()
-        puts "Reload pattern: #{@reload_pattern}"
-        @unicorn_pid = start_unicorn
+      def run(options, unicorn_args)
+        reload_pattern = options[:pattern] || DEFAULT_RELOAD_PATTERN
+        full_reload_pattern = options[:full] || DEFAULT_FULL_RELOAD_PATTERN
+        @unicorn_args = unicorn_args
         listener = Listen.to('.', :relative_paths=>true)
-        listener.filter(@full_reload_pattern)
-        listener.filter(@reload_pattern)
+        listener.filter(full_reload_pattern)
+        listener.filter(reload_pattern)
         listener.change do |modified, added, removed|
-          puts "File change event detected: #{[modified, added, removed].inspect}"
-          if (modified + added + removed).index {|f| f =~ @full_reload_pattern}
+          $stderr.puts "File change event detected: #{{modified: modified, added: added, removed: removed}.inspect}"
+          if (modified + added + removed).index {|f| f =~ full_reload_pattern}
             # Reload everything.  Perhaps this could use the "procedure to
             # replace a running unicorn executable" described at:
             # http://unicorn.bogomips.org/SIGNALS.html
@@ -38,7 +33,7 @@ module Mr
             # and this is just way simpler for now.
             Process.kill(:QUIT, @unicorn_pid)
             Process.wait(@unicorn_pid)
-            @unicorn_pid = start_unicorn.call
+            start_unicorn
           else
             # Send a HUP to unicorn to tell it to gracefully shut down its
             # workers
@@ -61,6 +56,13 @@ module Mr
         # So we need to start it in the background, then keep this thread
         # alive just so it can wait to be interrupted.
         listener.start(false)
+        # Theoretically, we could have problems if a file changed RIGHT AT
+        # THIS POINT, between the time we started the listener and the time
+        # we started the unicorn process.  But this is just for development,
+        # so we're just not going to worry about that.
+        start_unicorn
+
+        # And now we just want to keep the thread alive--we're just waiting around to get interrupted at this point.
         sleep(99999) while true
       end
 

data/lib/mr-sparkle/version.rb

@@ -1,5 +1,5 @@
 module Mr
   module Sparkle
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/mr-sparkle.gemspec

@@ -25,4 +25,10 @@ Gem::Specification.new do |gem|
   # https://github.com/guard/guard#efficient-filesystem-handling
   gem.add_dependency('rb-inotify', '~>0.8.8')
   gem.add_dependency('rb-fsevent', '~>0.9.2')
+
+  gem.add_development_dependency('minitest', '~>4.3.3')
+  gem.add_development_dependency('minitest-reporters', '~>0.13.1')
+  gem.add_development_dependency('minitest-around', '~>0.0.1')
+  gem.add_development_dependency('rack', '~>1.4.1')
+  gem.add_development_dependency('rake', '~>10.0.3')
 end

data/spec/fixtures/full_reload/Gemfile

@@ -0,0 +1,5 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem 'rack', '~>1.4.1'
+gem 'full_reload_test_gem', :path=>'vendor/full_reload_test_gem'

data/spec/fixtures/full_reload/config.ru

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+require 'full_reload_test_gem'
+# This is loaded just once--subsequent changes to the file won't be reflected...
+string_from_file = IO.read(File.expand_path("file.notwatched",File.dirname(__FILE__)))
+run lambda {|env| [200, {'Content-Type' => 'text/plain'}, [string_from_file+FullReloadTestGem::THINGY]] }

data/spec/fixtures/full_reload/file.notwatched

@@ -0,0 +1 @@
+This file was not watched.

data/spec/fixtures/full_reload/vendor/full_reload_test_gem/full_reload_test_gem.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "full_reload_test_gem"
+  gem.version       = '0.0.1'
+  gem.authors       = ["Micah Chalmer"]
+  gem.email         = ["micah@micahchalmer.net"]
+  gem.description   = %q{This is only here as part of a test fixture}
+  gem.summary       = %q{This is only here as part of a test fixture}
+  gem.homepage      = ""
+
+  gem.files         = ['lib/full_reload_test_gem.rb']
+  gem.executables   = []
+  gem.test_files    = []
+  gem.require_paths = ["lib"]
+end

data/spec/fixtures/full_reload/vendor/full_reload_test_gem/lib/full_reload_test_gem.rb

@@ -0,0 +1,3 @@
+module FullReloadTestGem
+  THINGY = "This string is from a gem."
+end

data/spec/fixtures/hello/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem 'rack', '~>1.4.1'

data/spec/fixtures/hello/config.ru

@@ -0,0 +1 @@
+run lambda {|env| [200, {'Content-Type' => 'text/plain'}, ["Hello, world!"]] }

data/spec/full_reload_spec.rb

@@ -0,0 +1,41 @@
+require_relative 'spec_helper'
+
+VENDOR_GEM_CODE_PATH = 'vendor/full_reload_test_gem/lib/full_reload_test_gem.rb'
+INITIAL_STRING = "This file was not watched.\nThis string is from a gem."
+
+describe "App Runner: Full Reloading" do
+  before do
+    self.app_template_path = app_template_fixture("full_reload")
+  end
+
+  it "does not reload when a file that isn't watched is changed" do
+    start_app
+    app_request('/').body.must_equal(INITIAL_STRING)
+    change_file('file.notwatched', /not watched/, 'changed')
+    # The whole point of this is that a change is NOT fired off--so we
+    # can't wait for that.  Sleep to give it time to wrongly trigger,
+    # if it were going to.
+    sleep(3)
+    app_request('/').body.must_match(/^This file was not watched/)
+  end
+
+  it "reloads the app when config.ru changes, but not the gem" do
+    start_app
+    app_request('/').body.must_equal(INITIAL_STRING)
+    change_file('file.notwatched', /not watched/, 'changed')
+    change_file(VENDOR_GEM_CODE_PATH, /from a gem/, 'also changed but will not be reflected')
+    change_file('config.ru', /be reflected.../, 'comment changed just to trigger')
+    watch_until_change_detected
+    app_request('/').body.must_equal("This file was changed.\nThis string is from a gem.")
+  end
+
+  it "reloads the entire app, including gems, when Gemfile is changed" do
+    start_app
+    app_request('/').body.must_equal(INITIAL_STRING)
+    change_file('file.notwatched', /not watched/, 'changed')
+    change_file(VENDOR_GEM_CODE_PATH, /from a gem/, 'from a gem and this time it will show changes')
+    change_file('Gemfile', /sample Gemfile/, 'sample changed Gemfile')
+    watch_until_change_detected
+    app_request('/').body.must_equal("This file was changed.\nThis string is from a gem and this time it will show changes.")
+  end
+end

data/spec/normal_running_spec.rb

@@ -0,0 +1,20 @@
+require_relative 'spec_helper'
+
+describe "App Runner: Normal Operation" do
+  before do
+    self.app_template_path = app_template_fixture('hello')
+  end
+
+  it "runs the application" do
+    start_app
+    app_request('/').body.must_match(/^Hello, world!/)
+  end
+
+  it "reloads the application when a ruby file changes" do
+    start_app
+    app_request('/').body.must_match(/^Hello, world!/)
+    change_file('config.ru', /world/, "Dolly")
+    watch_until_change_detected
+    app_request('/').body.must_match(/^Hello, Dolly!/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,126 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest/around'
+require 'net/http'
+require 'tmpdir'
+require 'timeout'
+require 'bundler'
+
+MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+
+# Max # of seconds to wait before declaring the test failed
+WAIT_TIMEOUT=10
+
+class ServerAppTest < MiniTest::Spec
+
+  attr_accessor :app_template_path # Path to the test fixture application to run
+
+  # Use this to get paths for app_template_path
+  def app_template_fixture(name)
+    File.expand_path("fixtures/#{name}",File.dirname(__FILE__))
+  end
+
+  attr_reader :running_app_dir
+  attr_reader :app_pid
+  attr_reader :app_stdout
+  attr_reader :app_stderr
+
+  attr_writer :app_command
+  def app_command
+    @app_command ||= File.expand_path('../bin/mr-sparkle',File.dirname(__FILE__))
+  end
+
+  attr_writer :app_args
+  def app_args
+    # We want unicorn not to listen on non-local ports.  We also use a different port
+    # than the usual test server...
+    @app_args || []
+  end
+
+  def start_app
+    stop_app
+    @app_socket_path = File.expand_path("main_unicorn_socket", running_app_dir)
+    Dir.mkdir(File.expand_path('log', running_app_dir))
+    @app_stdout, app_stdout_w = IO.pipe
+    @app_stderr, app_stderr_w = IO.pipe
+    Bundler.with_clean_env do
+      @app_pid = Kernel.spawn(
+        app_command, *app_args, '--', '-l', @app_socket_path,
+        {pgroup: true, chdir: running_app_dir,
+          in: '/dev/null', out: app_stdout_w, err: app_stderr_w, pgroup: true})
+    end
+    
+    @old_handler = Signal.trap(:EXIT) do
+      stop_app
+      @old_handler.call if @old_handler
+    end
+    watch_until {|line| File.exists?(@app_socket_path)}
+  end
+
+  def watch_until(stream=@app_stderr, &block)
+    Timeout.timeout(WAIT_TIMEOUT) do
+      stream.each_line do |line|
+        return true if block.call(line)
+      end
+    end
+  end
+
+  def app_request(path)
+    # Hat tip to:
+    # http://code.google.com/p/semicomplete/source/browse/codesamples/ruby-supervisorctl.rb?spec=svn3046&r=3046
+    # for how this works
+    sock = Net::BufferedIO.new(UNIXSocket.new(@app_socket_path))
+    req = Net::HTTP::Get.new(path)
+    req.exec(sock, "1.1", path)
+    begin
+      response = Net::HTTPResponse.read_new(sock)
+    end while response.kind_of?(Net::HTTPContinue)
+    response.reading_body(sock, req.response_body_permitted?) { }
+
+    response
+  end
+
+  def stop_app
+    if @app_pid
+      Process.kill(:TERM, -@app_pid) # Negate the pid to kill the whole process group
+      Process.wait(@app_pid)
+      @app_pid = nil
+    end
+    
+    Signal.trap(:EXIT, @old_handler) if @old_handler
+    @old_handler = nil
+  end
+
+  def change_file(file_name, pattern, replacement)
+    full_file_name = File.expand_path(file_name,@running_app_dir)
+    contents = IO.read(full_file_name)
+    IO.write(full_file_name, contents.gsub(pattern,replacement))
+  end
+
+  def watch_until_change_detected(&block)
+    watch_until do |line| 
+      /^File change event detected/.match(line) && (block.nil? || block.call(line))
+    end
+    # It won't really serve the new version until it starts its new worker process
+    watch_until {|line| /worker=\d+ ready/.match(line)}
+  end
+
+  def around
+    raise "Must set @app_template_path" if @app_template_path.nil?
+    Dir.mktmpdir do |dir|
+      FileUtils.cp_r("#{app_template_path}/.", dir)
+      @running_app_dir = dir
+      begin
+        yield
+      rescue Exception=>e
+        puts e.inspect
+        raise
+      ensure
+        stop_app
+      end
+    end
+  end
+  
+end
+
+MiniTest::Spec.register_spec_type(/^App Runner:/, ServerAppTest)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mr-sparkle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000Z
+date: 2012-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicorn
-  requirement: &77182970 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 4.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *77182970
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.5.0
 - !ruby/object:Gem::Dependency
   name: listen
-  requirement: &77182700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *77182700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rb-inotify
-  requirement: &77182400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 0.8.8
   type: :runtime
   prerelease: false
-  version_requirements: *77182400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &77182140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +69,92 @@ dependencies:
         version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *77182140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.3
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: minitest-around
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
 description: This gem contains a script to start a Unicorn-based server for your Rack
   application that reloads your automatically when they are changed, but doesn't incur
   the penalty of reloading all the gem dependencies.  It's based on Jonathan D. Stott's
@@ -67,6 +167,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -76,6 +177,16 @@ files:
 - lib/mr-sparkle/unicorn.conf.rb
 - lib/mr-sparkle/version.rb
 - mr-sparkle.gemspec
+- spec/fixtures/full_reload/Gemfile
+- spec/fixtures/full_reload/config.ru
+- spec/fixtures/full_reload/file.notwatched
+- spec/fixtures/full_reload/vendor/full_reload_test_gem/full_reload_test_gem.gemspec
+- spec/fixtures/full_reload/vendor/full_reload_test_gem/lib/full_reload_test_gem.rb
+- spec/fixtures/hello/Gemfile
+- spec/fixtures/hello/config.ru
+- spec/full_reload_spec.rb
+- spec/normal_running_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/MicahChalmer/mr-sparkle
 licenses: []
 post_install_message: 
@@ -96,8 +207,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Runs Unicorn, automatically reloading the application, but not bundled gems.
-test_files: []
+test_files:
+- spec/fixtures/full_reload/Gemfile
+- spec/fixtures/full_reload/config.ru
+- spec/fixtures/full_reload/file.notwatched
+- spec/fixtures/full_reload/vendor/full_reload_test_gem/full_reload_test_gem.gemspec
+- spec/fixtures/full_reload/vendor/full_reload_test_gem/lib/full_reload_test_gem.rb
+- spec/fixtures/hello/Gemfile
+- spec/fixtures/hello/config.ru
+- spec/full_reload_spec.rb
+- spec/normal_running_spec.rb
+- spec/spec_helper.rb