guard-shotgun 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86d8bdbb8c06897e94cd051a246f966acad6a34d
+  data.tar.gz: 95f189ab7cd2ec78329c512cd0e9be3f8585549e
+SHA512:
+  metadata.gz: 6cd8119159f0c77415562f8152dd311b82b54e3452b45e73d426a605369d362d246e27fda4bb52fa061c3452d23eceb908e15962f0e4ba55260aa1d368fd93bd
+  data.tar.gz: 78d16d3146bea63b589bc79d9a26194e5edaad84ba9d305d954e3be41a1d6d0bd8223e59ba5ef88ff324a3dbe7c8296265cd86b65878da0c0f72e5d38bd40172

data/.gitignore

@@ -1,5 +1,6 @@
 *.gem
 .bundle
-Gemfile.lock
 pkg/*
 vendor/bundle*
+/*.ruby-version
+*.ruby-gemset

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    guard-shotgun (0.3.0)
+      ffi
+      guard (~> 1.0)
+      spoon
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    formatador (0.2.5)
+    guard (1.8.3)
+      formatador (>= 0.2.4)
+      listen (~> 1.3)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.3)
+      ffi (>= 0.5.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    slop (3.6.0)
+    spoon (0.0.4)
+      ffi
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-shotgun!
+  rake
+  rspec

data/LICENSE

@@ -1,6 +1,6 @@
 Copyright (c) 2011 Fletcher Nichol
-Copyright (c) 2012 Romain Champourlier
 Copyright (c) 2012 Colin Rymer
+Copyright (c) 2014 Romain Champourlier
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,19 +1,23 @@
 # Guard::Shotgun
 
-Guard::Shotgun automatically starts and restarts Sinatra (through `rackup`) when needed. As useful as Shotgun when developing a Sinatra app.
+Guard::Shotgun automatically starts and restarts Rack applications (through `rackup`) when needed. As useful as Shotgun when developing a Rack app.
 
-* Tested on Ruby 1.9.2-p290 only.
+Tested on:
+
+* Ruby 1.9.2-p290
+* Ruby 2.0.0-p247
 
 ## Why?
 
-* You are **developing with Sinatra** and you have to **restart your development server each time you change your source code**?
+* You are **developing with Rack** 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?
+* Reloading your whole Rack app with each request seems a bit overkill? Seems better to only reload it on a file change?
 
 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.
+Please be sure to have [Guard](http://github.com/guard/guard) installed before continuing.
 
 Install the gem:
 
@@ -21,7 +25,7 @@ Install the gem:
 
 Or add it to your Gemfile (inside development group):
 
-    gem 'guard-shotgun', :git => https://github.com/rchampourlier/guard-shotgun.git
+    gem 'guard-shotgun', :git => 'https://github.com/rchampourlier/guard-shotgun.git'
 
 Add guard definition to your Guardfile by running this command:
 
@@ -29,9 +33,9 @@ Add guard definition to your Guardfile by running this command:
 
 ## Usage
 
-This guard plugin is intended to be used when **developing a Sinatra application**, loaded through `rackup`.
+This guard plugin is intended to be used when **developing a Rack application**, loaded through `rackup`.
 
-**It allows automatic reloading of your Sinatra server when a file is changed.**
+**It allows automatic reloading of your Rack server when a file is changed.**
 
 > It provides the same service as the **Shotgun** gem, relying on **Guard** to watch for your files.
 
@@ -44,28 +48,75 @@ For example, to look at the `main.rb` file in your application directory, just s
     guard 'shotgun' do
       watch('main.rb')
     end
-    
+
+**Common config**
+
+Here we watch Ruby files within the `app` and `lib` directories, as well as the `config.ru` file. We also use Thin as a server instead of the default WEBRick.
+
+    guard 'shotgun', :server => 'thin' do
+      watch %r{^(app|lib)/.*\.rb}
+      watch 'config.ru'
+    end
+
 Please read [Guard doc](http://github.com/guard/guard#readme) for more info about Guardfile DSL.
 
 
 ## Options
 
-Currently there is no option.
+* `server`: the name of the server to use. The option is passed to the `rackup` command. You may use for example `WEBrick` (default), `thin`...
+* `port`: the port on which to run the server, the option is also passed to the `rackup` command.
+
+
+## Testing
+
+There is currently no spec :S. I intend to write some (won't need much). You may however go to the `spec/dummy_app`  directory and run:
+
+```
+bundle install
+bundle exec guard
+```
+
+This way, you can check it's working correctly. You can play with the `spec/dummy_app/app/base_app.rb` file and introduce some bug so that you may see a failing start is correctly handled too.
+
+
+## Compatibility with Guard
+
+* 0.2.0 is compatible (and dependent on) Guard ~> 1.0
 
 ## History
 
-#### v0.0.4
+#### 0.3.0
+
+* Adding dependency on Guard ~> 1.0
+* Fixed an issue when autoloading the Notifier class
+* Minor changes to README, repo and dummy_app
+
+#### 0.2.0
+
+* Merged an update by Colin Rymer
+
+#### 0.1.0
+
+* Essentially repository cleanup and README update.
+
+#### 0.0.6
+
+* Improved start/stop management:
+  * Exiting Guard will trigger INT signal instead of TERM, stopping WEBRick gently.
+  * Failure to start will be detected too after a 10 seconds timeout, and the app will just get reloaded when you change a file.
+
+#### 0.0.4
 
-Killing Sinatra when reloading on change without waiting for requests to be completed.
+Killing Rack when reloading on change without waiting for requests to be completed.
 
-#### v0.0.3
+#### 0.0.3
 
 Initial release
 
 ## TODOs
 
 * Add some options: host, port...
-* Allow starting Sinatra applications without using rackup.
+* Allow starting Rack applications without using rackup.
 * Tests.
 
 Help is welcome!

data/Rakefile

@@ -1,13 +1 @@
-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
+require "bundler/gem_tasks"

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.3.0

data/guard-shotgun.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   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.homepage      = "http://github.com/rchampourlier/guard-shotgun"
   gem.license       = 'MIT'
   gem.executables   = []
   gem.files         = `git ls-files`.split("\n")
@@ -22,9 +22,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.required_ruby_version = '>= 1.9'
 
-  gem.add_dependency 'guard', '~> 1.5.4'
-  gem.add_dependency 'ffi', '~> 1.2.0'
-  gem.add_dependency 'spoon', '~> 0.0.1'
+  gem.add_dependency 'guard', "~> 1.0"
+  gem.add_dependency 'ffi'
+  gem.add_dependency 'spoon'
 
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
 end
 

data/lib/guard/shotgun.rb

@@ -8,9 +8,11 @@ module Guard
   class Shotgun < Guard
     VALID_ARGS = %w{server host port env daemonize pid option}
 
-    autoload :Notifier, 'guard/shotgun/notifier'
+    require File.expand_path('../shotgun/notifier', __FILE__)
     attr_accessor :pid
 
+    STARTUP_TIMEOUT = 10 # seconds
+
     def initialize(watchers=[], options={})
       super
       @options = {
@@ -35,8 +37,13 @@ module Guard
         @pid = Spoon.spawnp 'rackup', *options_array, config_file
       end
       wait_for_port
-      Notifier.notify(@reloaded ? 'reloaded' : 'up')
-      @reloaded = false
+      if running?
+        Notifier.notify(@reloaded ? 'reloaded' : 'up')
+        @reloaded = false
+      else
+        UI.info "Rack failed to start."
+        Notifier.notify('failed')
+      end
     end
 
     # Call with Ctrl-C signal (when Guard quit)
@@ -109,7 +116,8 @@ module Guard
     end
 
     def wait_for_port
-      while true do
+      timeout_time = Time.now + STARTUP_TIMEOUT
+      while Time.now < timeout_time do
         sleep 0.2
         break if port_open?(@options[:host], @options[:port])
       end

data/lib/guard/shotgun/notifier.rb

@@ -8,14 +8,17 @@ module Guard
           "Sinatra up and running"
         when 'reloaded'
           "Sinatra reloaded"
+        when 'failed'
+          'Sinatra failed to start'
         end
       end
 
       # failed | success
       def self.guard_image(result)
-        icon = if result == 'ready'
+        case result
+        when 'reloaded', 'up'
           :success
-        else
+        when 'failed'
           :failed
         end
       end
@@ -26,7 +29,6 @@ module Guard
 
         ::Guard::Notifier.notify(message, :title => 'guard-shotgun', :image => image)
       end
-
     end
   end
-end
+end

data/lib/guard/shotgun/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module ShotgunVersion
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/spec/dummy_app/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1

data/spec/dummy_app/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'sinatra', :require => "sinatra/base"
+
+group :development, :test do
+  gem 'guard', '~> 1'
+
+  # Requirements for the manually inserted guard-shotgun
+  gem 'spoon'
+  gem 'ffi'
+end

data/spec/dummy_app/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    ffi (1.9.3)
+    formatador (0.2.5)
+    guard (1.8.3)
+      formatador (>= 0.2.4)
+      listen (~> 1.3)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.3)
+      ffi (>= 0.5.0)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slop (3.6.0)
+    spoon (0.0.4)
+      ffi
+    thor (0.19.1)
+    tilt (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ffi
+  guard (~> 1)
+  sinatra
+  spoon

data/spec/dummy_app/Guardfile

@@ -0,0 +1,5 @@
+require File.expand_path('../../../lib/guard/shotgun', __FILE__)
+
+guard 'shotgun' do
+  watch(%r{^(app|assets|lib|config)/(.)*.(rb|css|js|haml)})
+end

data/spec/dummy_app/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)

data/spec/dummy_app/app/base_app.rb

@@ -0,0 +1,7 @@
+class BaseApp < Sinatra::Base
+  #raise "Failing app"
+
+  get '/' do
+    "Hello world, naturally!"
+  end
+end

data/spec/dummy_app/config.ru

@@ -0,0 +1,6 @@
+ENV["RACK_ENV"] ||= "development"
+
+require File.join(File.dirname(__FILE__), 'config/boot')
+require File.join(File.dirname(__FILE__), 'app/base_app')
+
+run BaseApp

data/spec/dummy_app/config/boot.rb

@@ -0,0 +1,6 @@
+# boot.rb
+
+# Load dependencies
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-shotgun
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - romain@softr.li
@@ -10,56 +9,78 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.4
-    none: false
-  name: guard
+        version: '1.0'
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.4
-    none: false
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
-    none: false
-  name: ffi
+        version: '0'
   type: :runtime
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
-    none: false
+        version: '0'
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: spoon
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.1
-    none: false
-  name: spoon
+        version: '0'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.1
-    none: false
+        version: '0'
 description: This gem provides a Guard that restarts Rack apps when watched files
   are modified similar. Similar to the wonderful Shotgun by rtomayko
 email:
@@ -71,8 +92,11 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- .gitignore
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -82,31 +106,48 @@ files:
 - lib/guard/shotgun/notifier.rb
 - lib/guard/shotgun/templates/Guardfile
 - lib/guard/shotgun/version.rb
+- spec/dummy_app/.DS_Store
+- spec/dummy_app/.ruby-version
+- spec/dummy_app/Gemfile
+- spec/dummy_app/Gemfile.lock
+- spec/dummy_app/Guardfile
+- spec/dummy_app/Rakefile
+- spec/dummy_app/app/base_app.rb
+- spec/dummy_app/config.ru
+- spec/dummy_app/config/boot.rb
 - spec/spec_helper.rb
-homepage: http://github.com/crymer11/guard-shotgun
+homepage: http://github.com/rchampourlier/guard-shotgun
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Shotgun-like Guard for Rack apps
 test_files:
+- spec/dummy_app/.DS_Store
+- spec/dummy_app/.ruby-version
+- spec/dummy_app/Gemfile
+- spec/dummy_app/Gemfile.lock
+- spec/dummy_app/Guardfile
+- spec/dummy_app/Rakefile
+- spec/dummy_app/app/base_app.rb
+- spec/dummy_app/config.ru
+- spec/dummy_app/config/boot.rb
 - spec/spec_helper.rb