mr-sparkle 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mr-sparkle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Micah Chalmer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Mr. Sparkle - The Magical Reloading Unicorn
+
+This gem contains a script to start a [Unicorn](http://unicorn.bogomips.org/)-based server for your [Rack](http://rack.github.com/) 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 blog post ["Magical Reloading Sparkles"](http://namelessjon.posterous.com/magical-reloading-sparkles)--hence the name.  (The name is also a Simpsons reference.  [CAN YOU SEE THAT I AM SERIOUS?](http://www.youtube.com/watch?v=dnaLRbbc-54))
+
+The main purpose of this gem is to take Jonathan's idea and package it into something can "just work" without having to be customized inside each project's code.  Besides the gem packaging, this code differs from the original watcher script in the following ways:
+
+1. It uses [listen](https://github.com/guard/listen) instead of [directory_watcher](https://github.com/TwP/directory_watcher/), which provides native event-driven file change detection, instead of polling.
+1. It assumes you're using [Bundler](http://gembundler.com/) for dependencies, which means that instead of needing a hardcoded list of gems in the `before_fork` hook, like the blog post had, this plugin just does `Bundler.require(:default)` to get all the modules mentioned in the Gemfile loaded before forking.
+1. If you change your Gemfile, the preloads are no longer valid, so this script treats that change as a special case: when the Gemfile changes, we kill the whole server and restart it, thus reloading absolutely everything.
+
+The script comes with a default set of file extensions it will watch for changes.  I've tried to be liberal about it--no harm reloading a few extra times when developing.  You can run `mr-sparkle --help` to see the default set as a regexp, and you can change that regexp with the `--pattern` option.
+
+## Installation
+
+    $ gem install mr-sparkle
+
+## Usage
+
+If you've got a Rack app that uses Bundler for its dependencies, then ordinarily all you have to do is execute
+
+    $ mr-sparkle
+    
+in your project's root directory.  You'll get a server listening on port 8080 (bound to all addresses, so external machines WILL be able to connect to it by default) and your code will be reloaded if any relevant files change.
+
+You can use command-line options to change the behavior a bit as follows:
+
+    $ mr-sparkle [--pattern regex] [--full-reload-pattern regex] [-- [unicorn options]]
+
+Use `--pattern` to replace the default regex that files must match to trigger a reload.  I've tried to make the default fairly liberal--it includes all extensions registered with [tilt](https://github.com/rtomayko/tilt/), for instance--so for most apps it will probably work fine.
+
+Use `--full-reload-pattern` to trigger a full reload for a different set of files.  By default it only does this for `Gemfile.`
+
+Any arguments after the `--` will be passed on to unicorn.  This is how you would change the default port, make it not bind to external ip addresses, use a rackup file with a name other than `config.ru`, etc.  See [the unicorn documentation](http://unicorn.bogomips.org/unicorn_1.html) for exactly what you can pass here.  Do not pass the `-c` option to unicorn--`mr-sparkle` comes with its own unicorn config file that it will use automatically.
+
+## Requirements
+
+This script requires Ruby 1.9.1 or greater (because it depends on `Kernel.spawn`.)  Since it's a wrapper around Unicorn, it will only work on "unix or unix-like" systems where unicorn is supported.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/mr-sparkle

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+require_relative '../lib/mr-sparkle'
+require 'optparse'
+
+options = {}
+OptionParser.new do |opts|
+  opts.on("--pattern [REGEXP]", Regexp,
+    "Regular expression to specify which files trigger a partial reload.  " +
+    "By default:\n #{Mr::Sparkle::DEFAULT_RELOAD_PATTERN.to_s}") do |rx|
+    options[:pattern] = rx
+  end
+  opts.on("--full-reload-pattern [REGEXP]", Regexp,
+    "Regular expression to specify which files trigger a full reload.  " +
+    "By default:\n #{Mr::Sparkle::DEFAULT_FULL_RELOAD_PATTERN.to_s}") do |rx|
+    options[:full] = rx
+  end
+end.parse!
+
+Mr::Sparkle::Daemon.new(options, ARGV).run

data/lib/mr-sparkle.rb

@@ -0,0 +1,70 @@
+require_relative "mr-sparkle/version"
+require 'listen'
+
+module Mr
+  module Sparkle
+
+    DEFAULT_RELOAD_PATTERN = /\.(?:builder|coffee|creole|css|erb|erubis|haml|html|js|less|liquid|mab|markdown|md|mdown|mediawiki|mkd|mw|nokogiri|radius|rb|rdoc|rhtml|ru|sass|scss|str|textile|txt|wiki|yajl|yml)$/
+
+    DEFAULT_FULL_RELOAD_PATTERN = /^Gemfile$/
+
+    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',
+          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
+        listener = Listen.to('.', :relative_paths=>true)
+        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}
+            # Reload everything.  Perhaps this could use the "procedure to
+            # replace a running unicorn executable" described at:
+            # http://unicorn.bogomips.org/SIGNALS.html
+            # but one wouldn't expect this to be triggered all that much,
+            # and this is just way simpler for now.
+            Process.kill(:QUIT, @unicorn_pid)
+            Process.wait(@unicorn_pid)
+            @unicorn_pid = start_unicorn.call
+          else
+            # Send a HUP to unicorn to tell it to gracefully shut down its
+            # workers
+            Process.kill(:HUP, @unicorn_pid)
+          end
+        end
+
+        shutdown = lambda do |signal|
+          listener.stop
+          Process.kill(:TERM, @unicorn_pid)
+          Process.wait(@unicorn_pid)
+          exit
+        end
+        Signal.trap(:INT, &shutdown)
+        Signal.trap(:EXIT, &shutdown)
+        
+        # Ideally we would start the listener in a blocking mode and have it
+        # just work.  But unfortunately listener.stop will not work from a
+        # signal on the same thread the listener is running.
+        # 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)
+        sleep(99999) while true
+      end
+
+    end
+
+  end
+end

data/lib/mr-sparkle/unicorn.conf.rb

@@ -0,0 +1,8 @@
+worker_processes 1
+
+GC.respond_to?(:copy_on_write_friendly=) and GC.copy_on_write_friendly = true
+
+before_fork do |server, worker|
+  require 'bundler'
+  Bundler.require(:default)
+end

data/lib/mr-sparkle/version.rb

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

data/mr-sparkle.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mr-sparkle/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mr-sparkle"
+  gem.version       = Mr::Sparkle::VERSION
+  gem.authors       = ["Micah Chalmer"]
+  gem.email         = ["micah@micahchalmer.net"]
+  gem.description   = %q{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 blog post "Magical Reloading Sparkles"--hence the name.}
+  gem.summary       = %q{Runs Unicorn, automatically reloading the application, but not bundled gems.}
+  gem.homepage      = "http://github.com/MicahChalmer/mr-sparkle"
+  gem.required_ruby_version = '>= 1.9.1'
+
+  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("unicorn", '~>4.5.0')
+  gem.add_dependency("listen", '~>0.6.0')
+
+  # Only one of these can actually be used on a given platform, but they
+  # can both be installed OK--see the note about this at:
+  # https://github.com/guard/guard#efficient-filesystem-handling
+  gem.add_dependency('rb-inotify', '~>0.8.8')
+  gem.add_dependency('rb-fsevent', '~>0.9.2')
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: mr-sparkle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Micah Chalmer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unicorn
+  requirement: &77182970 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *77182970
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: &77182700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *77182700
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: &77182400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *77182400
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &77182140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *77182140
+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
+  blog post "Magical Reloading Sparkles"--hence the name.
+email:
+- micah@micahchalmer.net
+executables:
+- mr-sparkle
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mr-sparkle
+- lib/mr-sparkle.rb
+- lib/mr-sparkle/unicorn.conf.rb
+- lib/mr-sparkle/version.rb
+- mr-sparkle.gemspec
+homepage: http://github.com/MicahChalmer/mr-sparkle
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Runs Unicorn, automatically reloading the application, but not bundled gems.
+test_files: []