guard-shotgun 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+vendor/bundle*

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Fletcher Nichol
+Copyright (c) 2012 Romain Champourlier
+
+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,89 @@
+# Guard::Shotgun
+
+Guard::Shotgun automatically starts and restarts Sinatra (through `rackup`) when needed. As useful as Shotgun when developing a Sinatra app.
+
+* Tested on Ruby 1.9.2-p290 only.
+
+## Why?
+
+* You are **developing with Sinatra** and you have to **restart your development server each time you change your source code**?
+* You are **using Shotgun** to do this, but well, the **latest version is not showing the logs anymore** in your console, which makes developing a little harder?
+
+If you have answered 'yes' to any of these questions, you may find some use to this plugin.
+
+## Install
+
+Please be sure to have [Guard](http://github.com/guard/guard) installed before continue.
+
+Install the gem:
+
+    gem install guard-shotgun
+
+Or add it to your Gemfile (inside development group):
+
+    gem 'guard-shotgun', :git => https://github.com/rchampourlier/guard-shotgun.git
+
+Add guard definition to your Guardfile by running this command:
+
+    guard init shotgun
+
+## Usage
+
+This guard plugin is intended to be used when **developing a Sinatra application**, loaded through `rackup`.
+
+**It allows automatic reloading of your Sinatra server when a file is changed.**
+
+> It provides the same service as the **Shotgun** gem, relying on **Guard** to watch for your files.
+
+Please read [Guard usage doc](http://github.com/guard/guard#readme)
+
+## Guardfile
+
+For example, to look at the `main.rb` file in your application directory, just set this guard:
+
+    guard 'shotgun' do
+      watch('main.rb')
+    end
+    
+Please read [Guard doc](http://github.com/guard/guard#readme) for more info about Guardfile DSL.
+
+
+## Options
+
+Currently there is no option.
+
+## History
+
+#### v0.0.4
+
+Killing Sinatra when reloading on change without waiting for requests to be completed.
+
+#### v0.0.3
+
+Initial release
+
+## TODOs
+
+* Add some options: host, port...
+* Allow starting Sinatra applications without using rackup.
+* Tests.
+
+Help is welcome!
+
+
+## Development
+
+* Source hosted at [GitHub](http://github.com/rchampourlier/guard-shotgun)
+* Report issues/Questions/Feature requests on [GitHub Issues](http://github.com/rchampourlier/guard-shotgun/issues)
+
+Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change
+you make.
+
+## Authors
+
+[Romain Champourlier](http://github.com/rchampourlier)
+
+
+## Credits
+
+This gem has been built from [guard-webrick](https://github.com/guard/guard-webrick) of [Fletcher Nichol](http://github.com/fnichol).

data/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "guard-shotgun"
+    gemspec.summary = "Guard gem for Sinatra (shotgun-like)"
+    gemspec.description = "Guard gem for Sinatra (shotgun-like)"
+    gemspec.email = "romain@softr.li"
+    gemspec.homepage = "http://github.com/rchampourlier/guard-shotgun"
+    gemspec.authors = ["romain@softr.li"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/guard-shotgun.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/guard/shotgun/version', __FILE__)
+require 'date'
+
+Gem::Specification.new do |gem|
+  gem.name          = "guard-shotgun"
+  gem.version       = Guard::ShotgunVersion::VERSION
+  gem.authors       = ["romain@softr.li", "Colin Rymer"]
+  gem.email         = ["romain@softr.li", "colin.rymer@gmail.com"]
+  gem.description   = 'This gem provides a Guard that restarts Rack apps when watched files are modified similar. Similar to the wonderful Shotgun by rtomayko'
+  gem.summary       = 'Shotgun-like Guard for Rack apps'
+  gem.date          = Date.today.to_s
+  gem.homepage      = "http://github.com/crymer11/guard-shotgun"
+  gem.license       = 'MIT'
+  gem.executables   = []
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- spec/*`.split("\n")
+  gem.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  gem.require_paths = ["lib"]
+  gem.required_ruby_version = '>= 1.9'
+
+  gem.add_dependency 'guard'
+  gem.add_dependency 'ffi'
+  gem.add_dependency 'spoon'
+end
+

data/lib/guard/shotgun.rb

@@ -0,0 +1,136 @@
+require 'guard'
+require 'guard/guard'
+require 'spoon'
+require 'socket'
+require 'timeout'
+
+module Guard
+  class Shotgun < Guard
+    VALID_ARGS = %w{server host port env daemonize pid option}
+
+    autoload :Notifier, 'guard/shotgun/notifier'
+    attr_accessor :pid
+
+    def initialize(watchers=[], options={})
+      super
+      @options = {
+        host: 'localhost',
+        port: 9292,
+        server: "WEBrick"
+      }.update(options) { |key, oldval, newval| (newval.nil? || newval.empty?) ? oldval : newval }
+      @reloaded = false
+    end
+
+    # =================
+    # = Guard methods =
+    # =================
+
+    # Call once when guard starts
+    def start
+      UI.info "Starting up Rack..."
+      if running?
+        UI.error "Another instance of Rack is running."
+        false
+      else
+        @pid = Spoon.spawnp 'rackup', *options_array, (config_file if config_file)
+      end
+      wait_for_port
+      Notifier.notify(@reloaded ? 'reloaded' : 'up')
+      @reloaded = false
+    end
+
+    # Call with Ctrl-C signal (when Guard quit)
+    def stop
+      UI.info "Shutting down Rack..."
+      Process.kill("TERM", @pid)
+      Process.wait(@pid)
+      @pid = nil
+      true
+    end
+
+    def stop_without_waiting
+      UI.info "Shutting down Rack without waiting..."
+      Process.kill("KILL", @pid)
+      Process.wait(@pid)
+      @pid = nil
+      true
+    end
+
+    # Call with Ctrl-Z signal
+    def reload
+      @reloaded = true
+      restart
+    end
+
+    # Call on file(s) modifications
+    def run_on_change(paths = {})
+      @reloaded = true
+      restart_without_waiting
+    end
+
+    private
+
+    def config_file
+      @options.fetch :config, nil
+    end
+
+    def options_array
+      @options.each_with_object([]) do |(key, val), array|
+        key = key.to_s.downcase
+        if VALID_ARGS.include? key
+          array << "--#{key}" << val.to_s
+        end
+      end
+    end
+
+    def restart_without_waiting
+      UI.info "Restarting Rack without waiting..."
+      stop_without_waiting
+      start
+    end
+
+    def restart
+      UI.info "Restarting Rack..."
+      stop
+      start
+    end
+
+    def running?
+      begin
+        if @pid
+          Process.getpgid @pid
+          true
+        else
+          false
+        end
+      rescue Errno::ESRCH
+        false
+      end
+    end
+
+    def wait_for_port
+      while true do
+        sleep 0.2
+        break if port_open?(@options[:host], @options[:port])
+      end
+    end
+
+    # thanks to: http://bit.ly/bVN5AQ
+    def port_open?(addr, port)
+      begin
+        Timeout::timeout(1) do
+          begin
+            s = TCPSocket.new(addr, port)
+            s.close
+            return true
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+            return false
+          end
+        end
+      rescue Timeout::Error
+      end
+
+      return false
+    end
+  end
+end

data/lib/guard/shotgun/notifier.rb

@@ -0,0 +1,32 @@
+module Guard
+  class Shotgun
+    class Notifier
+
+      def self.guard_message(result)
+        case result
+        when 'up'
+          "Sinatra up and running"
+        when 'reloaded'
+          "Sinatra reloaded"
+        end
+      end
+
+      # failed | success
+      def self.guard_image(result)
+        icon = if result == 'ready'
+          :success
+        else
+          :failed
+        end
+      end
+
+      def self.notify(result)
+        message = guard_message(result)
+        image   = guard_image(result)
+
+        ::Guard::Notifier.notify(message, :title => 'guard-shotgun', :image => image)
+      end
+
+    end
+  end
+end

data/lib/guard/shotgun/templates/Guardfile

@@ -0,0 +1,2 @@
+guard :shotgun do
+end

data/lib/guard/shotgun/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module ShotgunVersion
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: guard-shotgun
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- romain@softr.li
+- Colin Rymer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: guard
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: ffi
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: spoon
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: This gem provides a Guard that restarts Rack apps when watched files
+  are modified similar. Similar to the wonderful Shotgun by rtomayko
+email:
+- romain@softr.li
+- colin.rymer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- guard-shotgun.gemspec
+- lib/guard/shotgun.rb
+- lib/guard/shotgun/notifier.rb
+- lib/guard/shotgun/templates/Guardfile
+- lib/guard/shotgun/version.rb
+- spec/spec_helper.rb
+homepage: http://github.com/crymer11/guard-shotgun
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Shotgun-like Guard for Rack apps
+test_files:
+- spec/spec_helper.rb