guard-webrick 0.1.0

data/.gitignore

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

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 0.1.0 (Mar 19, 2011)
+
+Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in guard-webrick.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'bundler' do
+  watch(/^Gemfile/)
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :version => 2 do
+  watch(/^spec\/.*_spec\.rb/)
+  watch(/^lib\/(.*)\.rb/)         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(/^spec\/spec_helper\.rb/) { "spec" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Fletcher Nichol
+
+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.rdoc

@@ -0,0 +1,60 @@
+= Guard::WEBrick
+
+Guard::WEBrick automatically starts and restarts WEBrick when needed. Useful when you are working on a static site but want to benefit from {Guard::LiveReload}[http://github.com/guard/guard-livereload].
+
+- Tested on Ruby 1.8.7, 1.9.2, Ruby Enterprise Edition, and JRuby
+
+== Install
+
+Please be sure to have {Guard}[http://github.com/guard/guard] installed before continue.
+
+Install the gem:
+
+    gem install guard-webrick
+
+Add it to your Gemfile (inside test group):
+
+    gem 'guard-webrick'
+
+Add guard definition to your Guardfile by running this command:
+
+    guard init webrick
+
+== Usage
+
+Please read {Guard usage doc}[http://github.com/guard/guard#readme]
+
+== Guardfile
+
+You can adapt your 'view' files like you want.
+Please read {Guard doc}[http://github.com/guard/guard#readme] for more info about Guardfile DSL.
+
+    guard 'webrick' do
+    end
+
+== Options
+
+The WEBrick guard has 3 options that you can set like this:
+
+    guard 'webrick', :host => '127.0.0.1', :port => '35728', :docroot => 'public' do
+      ...
+    end
+
+Available options:
+
+    :host => '127.3.3.1'     # default '0.0.0.0'
+    :port => '12345'         # default '3000'
+    :docroot => 'public'     # default current working directory
+    :launchy => false        # default true
+
+== Development
+
+- Source hosted at {GitHub}[http://github.com/fnichol/guard-webrick]
+- Report issues/Questions/Feature requests on {GitHub Issues}[http://github.com/fnichol/guard-webrick/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
+
+{Fletcher Nichol}[http://github.com/fnichol]

data/Rakefile

@@ -0,0 +1,32 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+namespace(:spec) do
+  desc "Run all specs on multiple ruby versions (requires rvm)"
+  task(:portability) do
+    rubies = if ENV['RUBIES']
+               ENV['RUBIES'].split(' ')
+             else
+               %w[1.8.7 1.9.2 ree jruby]
+             end
+    rubies.each do |version|
+      rvm_ruby = if ENV['GEMSET']
+                   "#{version}@#{ENV['GEMSET']}"
+                 else
+                   version
+                 end
+      system <<-BASH
+        bash -c '
+          source ~/.rvm/scripts/rvm;
+          rvm #{rvm_ruby};
+          echo "--------- version #{rvm_ruby} ----------\n";
+          bundle install;
+          rake spec'
+      BASH
+    end
+  end
+end

data/guard-webrick.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "guard/webrick/version"
+
+Gem::Specification.new do |s|
+  s.name        = "guard-webrick"
+  s.version     = Guard::WEBrickVersion::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Fletcher Nichol']
+  s.email       = ['fnichol@nichol.ca']
+  s.homepage    = 'http://rubygems.org/gems/guard-webrick'
+  s.summary     = %q{Guard gem for WEBrick}
+  s.description = %q{Guard::WEBrick automatically starts and restarts WEBrick when needed.}
+
+  s.required_rubygems_version = '>= 1.3.6'
+  s.rubyforge_project = "guard-webrick"
+
+  s.add_dependency 'guard', '~> 0.3'
+  s.add_dependency 'ffi',   '~> 1.0.7'
+  s.add_dependency 'spoon', '~> 0.0.1'
+
+  s.add_development_dependency 'bundler',       '~> 1.0.10'
+  s.add_development_dependency 'rspec',         '~> 2.5.0'
+  s.add_development_dependency 'guard-rspec',   '~> 0.2.0'
+  s.add_development_dependency 'guard-bundler', '~> 0.1.1'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/guard/webrick.rb

@@ -0,0 +1,114 @@
+require 'guard'
+require 'guard/guard'
+require 'spoon'
+require 'launchy'
+require 'socket'
+require 'timeout'
+
+module Guard
+  class WEBrick < Guard
+
+    attr_accessor :pid
+
+    def initialize(watchers=[], options={})
+      super
+      @options = {
+        :host       => '0.0.0.0',
+        :port       => 3000,
+        :docroot    => Dir::pwd,
+        :launchy    => true
+      }.update(options)
+    end
+
+    # =================
+    # = Guard methods =
+    # =================
+
+    # Call once when guard starts
+    def start
+      UI.info "Starting up WEBrick..."
+      if running?
+        UI.error "Another instance of WEBrick::HTTPServer is running."
+        false
+      else
+        @pid = Spoon.spawnp('ruby',
+          File.expand_path(File.join(File.dirname(__FILE__), %w{webrick server.rb})),
+          @options[:host],
+          @options[:port].to_s,
+          @options[:docroot]
+        )
+        wait_for_port
+        if @options[:launchy]
+          Launchy.open("http://#{@options[:host]}:#{@options[:port]}")
+          @options[:launchy] = false  # only run once
+        end
+        @pid
+      end
+    end
+
+    # Call with Ctrl-C signal (when Guard quit)
+    def stop
+      UI.info "Shutting down WEBrick..."
+      Process.kill("TERM", @pid)
+      Process.wait(@pid)
+      @pid = nil
+      true
+    end
+
+    # Call with Ctrl-Z signal
+    def reload
+      restart
+    end
+
+    # Call on file(s) modifications
+    def run_on_change(paths = {})
+      restart
+    end
+
+    private
+
+    def restart
+      UI.info "Restarting WEBrick..."
+      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
+        port_open?(@options[:host], @options[:port]) and return
+      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/webrick/server.rb

@@ -0,0 +1,34 @@
+require 'webrick'
+
+module Guard
+  class WEBrick
+    class Server
+
+      attr_reader :server
+
+      def initialize(options = {})
+        @server = ::WEBrick::HTTPServer.new(
+          :BindAddress  => options[:host],
+          :Port         => options[:port],
+          :DocumentRoot => File.expand_path(options[:docroot])
+        )
+      end
+
+      def start
+        %w{TERM HUP}.each { |signal| trap(signal){ server.shutdown } }
+        # ignore signals for guard
+        %w{INT TSTP QUIT}.each { |signal| trap(signal) {} }
+        @server.start
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  host, port, docroot = ARGV
+  Guard::WEBrick::Server.new(
+    :host     => host,
+    :port     => port,
+    :docroot  => docroot
+  ).start
+end

data/lib/guard/webrick/templates/Guardfile

@@ -0,0 +1,2 @@
+guard 'webrick' do
+end

data/lib/guard/webrick/version.rb

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

data/spec/guard/webrick/server_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'guard/webrick/server'
+
+describe Guard::WEBrick::Server do
+
+  describe "initialize" do
+
+    it "should create a WEBrick::HTTPServer instance" do
+      ::WEBrick::HTTPServer.should_receive(:new).with(
+        :BindAddress  => '0.0.0.0',
+        :Port         => 3000,
+        :DocumentRoot => Dir::pwd
+      )
+      new_server
+    end
+
+    it "should expand the docroot path" do
+      ::WEBrick::HTTPServer.should_receive(:new).with(
+        :BindAddress  => '0.0.0.0',
+        :Port         => 3000,
+        :DocumentRoot => File.expand_path(File.join(Dir::pwd, 'public'))
+      )
+      new_server(:docroot => 'public')
+    end
+  end
+
+  describe "start" do
+
+    subject { new_server }
+
+    it "should start the WEBrick::HTTPServer instance" do
+      ::WEBrick::HTTPServer.stub(:new).and_return(mock_http_server)
+      subject.server.should_receive(:start)
+      subject.start
+    end
+  end
+end
+
+def new_server(options = {})
+  Guard::WEBrick::Server.new({
+    :host     => '0.0.0.0',
+    :port     => 3000,
+    :docroot  => Dir::pwd
+  }.update(options))
+end
+
+def mock_http_server
+  @mock_http_server ||= mock(::WEBrick::HTTPServer).as_null_object
+end

data/spec/guard/webrick_spec.rb

@@ -0,0 +1,183 @@
+require 'spec_helper'
+
+describe Guard::WEBrick do
+  subject { Guard::WEBrick.new }
+
+  before(:each) do
+    Launchy.stub(:open)
+  end
+
+  describe "options" do
+
+    describe "host" do
+
+      it "should be '0.0.0.0' by default" do
+        subject = Guard::WEBrick.new([])
+        subject.options[:host].should == '0.0.0.0'
+      end
+
+      it "should be set to '127.0.0.5'" do
+        subject = Guard::WEBrick.new([], { :host => '127.0.0.5' })
+        subject.options[:host].should == '127.0.0.5'
+      end
+    end
+
+    describe "port" do
+
+      it "should be 3000 by default" do
+        subject = Guard::WEBrick.new([])
+        subject.options[:port].should == 3000
+      end
+
+      it "should be set to 8080" do
+        subject = Guard::WEBrick.new([], { :port => 8080 })
+        subject.options[:port].should == 8080
+      end
+    end
+
+    describe "docroot" do
+
+      it "should be Dir::pwd by default" do
+        subject = Guard::WEBrick.new([])
+        subject.options[:docroot].should == Dir::pwd
+      end
+
+      it "should be set to #{File.join(Dir::pwd, 'public')}" do
+        subject = Guard::WEBrick.new([], { :docroot => File.join(Dir::pwd, 'public') })
+        subject.options[:docroot].should == File.join(Dir::pwd, 'public')
+      end
+    end
+
+    describe "launchy" do
+
+      it "should be true by default" do
+        subject = Guard::WEBrick.new([])
+        subject.options[:launchy].should == true
+      end
+
+      it "should be set to false" do
+        subject = Guard::WEBrick.new([], { :launchy => false })
+        subject.options[:launchy].should == false
+      end
+    end
+  end
+
+  describe "start" do
+
+    before(:each) do
+      Spoon.stub(:spawnp).and_return(123456)
+      subject.stub(:wait_for_port)
+    end
+
+    it "should spawn the server instance" do
+      subject = Guard::WEBrick.new([], { :host => '127.0.2.5', :port => 8080,
+        :docroot => '/tmp' })
+      subject.stub(:wait_for_port)
+      Spoon.should_receive(:spawnp).with( 'ruby',
+        File.expand_path(File.join(File.dirname(__FILE__),
+          %w{.. .. lib guard webrick server.rb})),
+        '127.0.2.5', '8080', '/tmp'
+      )
+      subject.start
+    end
+
+    it "should pass startup options to the server instance" do
+      Spoon.should_receive(:spawnp).with( 'ruby',
+        File.expand_path(File.join(File.dirname(__FILE__),
+          %w{.. .. lib guard webrick server.rb})),
+        '0.0.0.0', '3000', Dir::pwd
+      )
+      subject.start
+    end
+
+    it "should set the pid" do
+      subject.start
+      subject.pid.should == 123456
+    end
+
+    it "should return true" do
+      subject.start.should be_true
+    end
+
+    it "should warn when server instance is already running" do
+      subject.start
+      Process.stub(:getpgid).and_return(true)
+      Guard::UI.should_receive(:error).with(
+        "Another instance of WEBrick::HTTPServer is running.")
+      subject.start
+    end
+
+    it "should open a web browser page" do
+      Launchy.should_receive(:open).with("http://0.0.0.0:3000")
+      subject.start
+    end
+
+    it "should not open a web browser if disabled" do
+      subject = Guard::WEBrick.new([], { :launchy => false })
+      subject.stub(:wait_for_port)
+      Launchy.should_not_receive(:open)
+      subject.start
+    end
+  end
+
+  describe "stop" do
+
+    before(:each) do
+      Spoon.stub(:spawnp).and_return(123456)
+      Process.stub(:wait)
+      Process.stub(:kill)
+      subject.stub(:wait_for_port)
+      subject.start
+    end
+
+    it "should kill the server instance" do
+      Process.should_receive(:kill).with("TERM", 123456)
+      subject.stop
+    end
+
+    it "should wait for the child process to exit" do
+      Process.should_receive(:wait).with(123456)
+      subject.stop
+    end
+
+    it "should set pid to nil" do
+      subject.stop
+      subject.pid.should be_nil
+    end
+
+    it "should return true" do
+      subject.stop.should be_true
+    end
+  end
+
+  %w{reload run_on_change}.each do |method|
+    describe method do
+
+      before(:each) do
+        Spoon.stub(:spawnp).and_return(123456)
+        Process.stub(:wait)
+        Process.stub(:kill)
+        subject.stub(:wait_for_port)
+        subject.start
+      end
+
+      it "should restart the server" do
+        subject.should_receive(:stop).ordered
+        subject.should_receive(:start).ordered
+        subject.send(method)
+      end
+
+      it "should return true" do
+        subject.send(method).should be_true
+      end
+
+      it "should only open a web browser the first time" do
+        subject = Guard::WEBrick.new([], { :launchy => true })
+        subject.stub(:wait_for_port)
+        Launchy.should_receive(:open).once
+        subject.start
+        subject.send(method)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'guard/webrick'
+
+ENV["GUARD_ENV"] = 'test'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification 
+name: guard-webrick
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Fletcher Nichol
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-19 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 0
+        - 7
+        version: 1.0.7
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: spoon
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 0
+        - 10
+        version: 1.0.10
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 2
+        - 0
+        version: 0.2.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: guard-bundler
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :development
+  version_requirements: *id007
+description: Guard::WEBrick automatically starts and restarts WEBrick when needed.
+email: 
+- fnichol@nichol.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG.rdoc
+- Gemfile
+- Guardfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- guard-webrick.gemspec
+- lib/guard/webrick.rb
+- lib/guard/webrick/server.rb
+- lib/guard/webrick/templates/Guardfile
+- lib/guard/webrick/version.rb
+- spec/guard/webrick/server_spec.rb
+- spec/guard/webrick_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/guard-webrick
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: guard-webrick
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Guard gem for WEBrick
+test_files: 
+- spec/guard/webrick/server_spec.rb
+- spec/guard/webrick_spec.rb
+- spec/spec_helper.rb