vegas 0.1.2 → 0.1.3

data/.gitignore

@@ -1 +1,5 @@
-
+.DS_Store
+test/tmp
+pkg/*
+_layouts
+*.sw?

data/History.txt

@@ -1,3 +1,9 @@
+== 0.1.3 2010-01-08
+
+* Fixed: Runner escapes :app_name to make it a valid string for using in paths (thanks greatseth!)
+* Fixed: Runner respects a server setting on Sinatra apps to use that specific Rack handler. (thanks greatseth!)
+* New: Tested against Rack 1.1
+
 == 0.1.2 2009-12-28
 
 * New 

data/Rakefile

@@ -1,32 +1,35 @@
-%w[rubygems rake rake/clean rake/testtask fileutils].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/vegas'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = %q{vegas}
-    s.version = Vegas::VERSION
-    s.authors = ["Aaron Quint"]
-    s.date = %q{2009-08-30}
-    s.summary              = "Vegas aims to solve the simple problem of creating executable versions of Sinatra/Rack apps."
-    s.description          = %{Vegas aims to solve the simple problem of creating executable versions of Sinatra/Rack apps. It includes a class Vegas::Runner that wraps Rack/Sinatra applications and provides a simple command line interface and launching mechanism.}
-    s.email = ["aaron@quirkey.com"]
-    s.homepage = %q{http://code.quirkey.com/vegas}
-    s.rubyforge_project = %q{quirkey}
-    s.add_runtime_dependency(%q<rack>, [">= 1.0.0"])
-    s.add_development_dependency(%q<bacon>, [">= 1.1.0"])
-    s.add_development_dependency(%q<sinatra>, [">= 0.9.4"])
-    
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test*.rb']
-  t.verbose = true
-end
-
-Dir['tasks/**/*.rake'].each { |t| load t }
+%w[rubygems rake rake/clean rake/testtask fileutils].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/vegas'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = %q{vegas}
+    s.version = Vegas::VERSION
+    s.authors = ["Aaron Quint"]
+    s.date = %q{2009-08-30}
+    s.summary              = "Vegas aims to solve the simple problem of creating executable versions of Sinatra/Rack apps."
+    s.description          = %{Vegas aims to solve the simple problem of creating executable versions of Sinatra/Rack apps. It includes a class Vegas::Runner that wraps Rack/Sinatra applications and provides a simple command line interface and launching mechanism.}
+    s.email = ["aaron@quirkey.com"]
+    s.homepage = %q{http://code.quirkey.com/vegas}
+    s.rubyforge_project = %q{quirkey}
+    
+    s.add_runtime_dependency(%q<rack>, [">= 1.0.0"])
+    
+    s.add_development_dependency(%q<mocha>,   ["~> 0.9.8"])
+    s.add_development_dependency(%q<bacon>,   ["~> 1.1.0"])
+    s.add_development_dependency(%q<sinatra>, ["~> 0.9.4"])
+    
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/vegas.rb

@@ -8,7 +8,7 @@ end
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
 module Vegas
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
   WINDOWS = !!(RUBY_PLATFORM =~ /(mingw|bccwin|wince|mswin32)/i)
   
   autoload :Runner, 'vegas/runner'

data/lib/vegas/runner.rb

@@ -6,72 +6,81 @@ if Vegas::WINDOWS
   begin
     require 'win32/process'
   rescue 
-    puts "Sorry, in order to use Vegas on Windows you need the win32-process gem:\n gem install win32-process"
+    puts "Sorry, in order to use Vegas on Windows you need the win32-process gem:\n " +
+         "gem install win32-process"
   end
 end
 
 module Vegas
   class Runner
-    attr_reader :app, :app_name, :rack_handler, :port, :host, :options, :args
-
+    attr_reader :app, :app_name, :filesystem_friendly_app_name, :quoted_app_name,
+      :rack_handler, :port, :host, :options, :args
+    
     ROOT_DIR   = File.expand_path(File.join('~', '.vegas'))
     PORT       = 5678
     HOST       = WINDOWS ? 'localhost' : '0.0.0.0'
-
+    
     def initialize(app, app_name, set_options = {}, runtime_args = ARGV, &block)
-      # initialize
-      @app                    = app
-      @app_name               = app_name
-      @options                = set_options || {}
-      @runtime_args           = runtime_args
+      @options = set_options || {}
+      
       self.class.logger.level = options[:debug] ? Logger::DEBUG : Logger::INFO
-            
-      @rack_handler = @app.respond_to?(:detect_rack_handler) ? 
-        @app.send(:detect_rack_handler) : Rack::Handler.get('thin')
+      
+      @app          = app
+      @app_name     = app_name
+      
+      @filesystem_friendly_app_name = @app_name.gsub(/\W+/, "_")
+      @quoted_app_name = "'#{app_name}'"
+      
+      @runtime_args = runtime_args
+      @rack_handler = setup_rack_handler
       
       # load options from opt parser      
       @args = define_options do |opts|
         if block_given?
           opts.separator ''
-          opts.separator "#{app_name} options:"
+          opts.separator "#{quoted_app_name} options:"
           yield(self, opts, app)
         end
       end
       
-      # Call before run if before_run is a Proc
-      if before_run = options.delete(:before_run) and 
-          before_run.is_a?(Proc)
+      # Handle :before_run hook
+      if (before_run = options.delete(:before_run)).respond_to?(:call)
         before_run.call(self)
       end
 
-      # set app options
+      # Set app options
       @host = options[:host] || HOST
-      if @app.respond_to?(:set)
-        @app.set(options) 
-        @app.set(:vegas, self)
+      
+      if app.respond_to?(:set)
+        app.set(options) 
+        app.set(:vegas, self)
       end
-      # initialize app dir
+      
+      # Make sure app dir is setup
       FileUtils.mkdir_p(app_dir)
-      return if options[:start] === false
+      
+      return if options[:start] == false
+      
       # evaluate the launch_path
-      path = if options[:launch_path] && options[:launch_path].respond_to?(:call)
+      path = if options[:launch_path].respond_to?(:call)
         options[:launch_path].call(self)
       else
         options[:launch_path]
       end
+      
       start(path)
     end
 
     def app_dir
-      File.join(ROOT_DIR, app_name)
+      File.join(ROOT_DIR, filesystem_friendly_app_name)
     end
 
     def pid_file
-      File.join(app_dir, "#{app_name}.pid")
+      File.join(app_dir, "#{filesystem_friendly_app_name}.pid")
     end
 
     def url_file
-      File.join(app_dir, "#{app_name}.url")
+      File.join(app_dir, "#{filesystem_friendly_app_name}.url")
     end
 
     def url
@@ -79,39 +88,46 @@ module Vegas
     end
 
     def log_file
-      File.join(app_dir, "#{app_name}.log")
+      File.join(app_dir, "#{filesystem_friendly_app_name}.log")
     end
 
     def start(path = nil)
       logger.info "Running with Windows Settings" if WINDOWS
-      logger.info "Starting #{app_name}"
+      logger.info "Starting #{quoted_app_name}"
       begin
         check_for_running(path)
         find_port
         write_url
         launch!(url, path)
-        daemonize! unless options[:foreground]      
+        daemonize! unless options[:foreground]
         run!
       rescue RuntimeError => e
-        logger.warn "There was an error starting #{app_name}: #{e}"
+        logger.warn "There was an error starting #{quoted_app_name}: #{e}"
         exit
       end
     end
 
     def find_port
       if @port = options[:port]
-        if !port_open?
+        announce_port_attempted
+        
+        unless port_open?
           logger.warn "Port #{port} is already in use. Please try another or don't use -P, for auto-port"
         end
       else
         @port = PORT
-        logger.info "Trying to start #{app_name} on Port #{port}"
-        while !port_open?
+        announce_port_attempted
+        
+        until port_open?
           @port += 1
-          logger.info "Trying to start #{app_name} on Port #{port}"
+          announce_port_attempted
         end
       end
     end
+    
+    def announce_port_attempted
+      logger.info "Trying to start #{quoted_app_name} on port #{port}"
+    end
 
     def port_open?(check_url = nil)
       begin
@@ -130,7 +146,7 @@ module Vegas
       if File.exists?(pid_file) && File.exists?(url_file)
         running_url = File.read(url_file)
         if !port_open?(running_url)
-          logger.warn "#{app_name} is already running at #{running_url}"
+          logger.warn "#{quoted_app_name} is already running at #{running_url}"
           launch!(running_url, path)
           exit!
         end
@@ -138,11 +154,13 @@ module Vegas
     end
 
     def run!
+      logger.info "Running with Rack handler: #{@rack_handler.inspect}"
+      
       rack_handler.run app, :Host => host, :Port => port do |server|
         trap(kill_command) do
           ## Use thins' hard #stop! if available, otherwise just #stop
           server.respond_to?(:stop!) ? server.stop! : server.stop
-          logger.info "#{app_name} received INT ... stopping"
+          logger.info "#{quoted_app_name} received INT ... stopping"
           delete_pid!
         end
       end
@@ -185,11 +203,11 @@ module Vegas
 
     def status
       if File.exists?(pid_file)
-        logger.info "#{app_name} running"
+        logger.info "#{quoted_app_name} running"
         logger.info "PID #{File.read(pid_file)}"
         logger.info "URL #{File.read(url_file)}" if File.exists?(url_file)
       else
-        logger.info "#{app_name} not running!"
+        logger.info "#{quoted_app_name} not running!"
       end
     end
     
@@ -201,11 +219,11 @@ module Vegas
       config.sub!(/^__END__\n.*/, '')
       @app.module_eval(config)
     end
-
+    
     def self.logger=(logger)
       @logger = logger
     end
-
+    
     def self.logger
       @logger ||= LOGGER if defined?(LOGGER)
       if !@logger
@@ -219,11 +237,45 @@ module Vegas
     def logger
       self.class.logger
     end
-
-    private
+    
+  private
+    def setup_rack_handler
+      # First try to set Rack handler via a special hook we honor
+      @rack_handler = if @app.respond_to?(:detect_rack_handler)
+        @app.detect_rack_handler
+      
+      # If they aren't using our hook, try to use their @app.server settings
+      elsif @app.respond_to?(:server) and @app.server
+        # If :server isn't set, it returns an array of possibilities, 
+        # sorted from most to least preferable.
+        if @app.server.is_a?(Array)
+          handler = nil
+          @app.server.each do |server|
+            begin
+              handler = Rack::Handler.get(server)
+              break
+            rescue NameError => e
+              next
+            end
+          end
+          handler
+        
+        # :server might be set explicitly to a single option like "mongrel"
+        else
+          Rack::Handler.get(@app.server)
+        end
+      
+      # If all else fails, we'll use Thin
+      else
+        Rack::Handler::Thin
+      end
+    end
+    
     def define_options
       OptionParser.new("", 24, '  ') do |opts|
-        opts.banner = "Usage: #{app_name} [options]"
+        # TODO instead of app_name, we should determine the name of the script 
+        # used to invoke Vegas and use that here
+        opts.banner = "Usage: your_executable_name [options]"
 
         opts.separator ""
         opts.separator "Vegas options:"
@@ -278,7 +330,7 @@ module Vegas
 
         opts.on_tail("--version", "Show version") do
           if app.respond_to?(:version)
-            puts "#{app_name} #{app.version}"
+            puts "#{quoted_app_name} #{app.version}"
           end
           puts "rack #{Rack::VERSION.join('.')}"
           puts "sinatra #{Sinatra::VERSION}" if defined?(Sinatra)

data/test/test_helper.rb

@@ -48,4 +48,8 @@ module TestHelper
 
 end
 
-Bacon::Context.send(:include, TestHelper)
+module Bacon
+  summary_on_exit
+  # extend TestUnitOutput
+  class Context; include TestHelper; end
+end

data/test/test_vegas_runner.rb

@@ -1,6 +1,9 @@
 require File.join(File.dirname(__FILE__), 'test_helper.rb')
 
-Vegas::Runner::ROOT_DIR = File.join(File.dirname(__FILE__), 'tmp', '.vegas')
+Vegas::Runner.class_eval do
+  remove_const :ROOT_DIR
+  ROOT_DIR = File.join(File.dirname(__FILE__), 'tmp', '.vegas')
+end
 
 describe 'Vegas::Runner' do
   before do
@@ -9,9 +12,9 @@ describe 'Vegas::Runner' do
     Vegas::Runner.logger = Logger.new(@log)
   end
 
-  describe '.new' do
+  describe 'creating an instance' do
 
-    describe 'with basic usage' do
+    describe 'basic usage' do
       before do
         Vegas::Runner.any_instance.expects(:system).once
         vegas(TestApp1, 'vegas_test_app_1', {:sessions => true}, ["route","--debug"])
@@ -24,6 +27,14 @@ describe 'Vegas::Runner' do
       it "sets app name" do
         @vegas.app_name.should == 'vegas_test_app_1'
       end
+      
+      it "sets quoted app name" do
+        @vegas.quoted_app_name.should == "'vegas_test_app_1'"
+      end
+      
+      it "sets filesystem friendly app name" do
+        @vegas.filesystem_friendly_app_name.should == 'vegas_test_app_1'
+      end
 
       it "stores options" do
         @vegas.options[:sessions].should.be.true
@@ -44,24 +55,87 @@ describe 'Vegas::Runner' do
       it "writes a url with the port" do
         @vegas.url_file.should have_matching_file_content(/0.0.0.0\:#{@vegas.port}/)
       end
+      
+      it "knows where to find the pid file" do
+        @vegas.pid_file.should.equal \
+          File.join(@vegas.app_dir, @vegas.filesystem_friendly_app_name + ".pid")
+        # @vegas.pid_file.should exist_as_file
+      end
     end
+    
+    describe 'basic usage with a funky app name' do
+      before do
+        Vegas::Runner.any_instance.expects(:system).once
+        vegas(TestApp1, 'Funky YEAH!1!', {:sessions => true}, ["route","--debug"])
+      end
+
+      it "sets app" do
+        @vegas.app.should == TestApp1
+      end
+
+      it "sets app name" do
+        @vegas.app_name.should == 'Funky YEAH!1!'
+      end
+      
+      it "sets quoted app name" do
+        @vegas.quoted_app_name.should == "'Funky YEAH!1!'"
+      end
+      
+      it "sets filesystem friendly app name" do
+        @vegas.filesystem_friendly_app_name.should == 'Funky_YEAH_1_'
+      end
+      
+      it "stores options" do
+        @vegas.options[:sessions].should.be.true
+      end
 
-    describe 'with a sinatra app' do
+      it "puts unparsed args into args" do
+        @vegas.args.should == ["route"]
+      end
+
+      it "parses options into @options" do
+        @vegas.options[:debug].should.be.true
+      end
+
+      it "writes the app dir" do
+        @vegas.app_dir.should exist_as_file
+      end
+
+      it "writes a url with the port" do
+        @vegas.url_file.should have_matching_file_content(/0.0.0.0\:#{@vegas.port}/)
+      end
+      
+      it "knows where to find the pid file" do
+        @vegas.pid_file.should.equal \
+          File.join(@vegas.app_dir, @vegas.filesystem_friendly_app_name + ".pid")
+        # @vegas.pid_file.should exist_as_file
+      end
+    end
+    
+    describe 'with a sinatra app using mongrel for the server' do
       before do
-        TestApp1.expects(:detect_rack_handler).returns(Rack::Handler::Mongrel)
+        TestApp1.set :server, "mongrel"
         Vegas::Runner.any_instance.expects(:system).once
         Rack::Handler::Mongrel.stubs(:run)
         vegas(TestApp1, 'vegas_test_app_1', {:skip_launch => true, :sessions => true}, ["route","--debug"])
       end
-    
+      
       it 'sets the rack handler automaticaly' do
         @vegas.rack_handler.should == Rack::Handler::Mongrel
       end
+    end
     
-      it "sets options on the app" do
-        @vegas.app.sessions.should.be.true
+    describe 'with a sinatra app using webrick for the server' do
+      before do
+        TestApp1.set :server, "webrick"
+        Vegas::Runner.any_instance.expects(:system).once
+        Rack::Handler::WEBrick.stubs(:run)
+        vegas(TestApp1, 'vegas_test_app_1', {:skip_launch => true, :sessions => true}, ["route","--debug"])
+      end
+      
+      it 'sets the rack handler automaticaly' do
+        @vegas.rack_handler.should == Rack::Handler::WEBrick
       end
-
     end
 
     describe 'with a simple rack app' do

data/vegas.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{vegas}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Quint"]
-  s.date = %q{2009-12-28}
+  s.date = %q{2010-01-08}
   s.description = %q{Vegas aims to solve the simple problem of creating executable versions of Sinatra/Rack apps. It includes a class Vegas::Runner that wraps Rack/Sinatra applications and provides a simple command line interface and launching mechanism.}
   s.email = ["aaron@quirkey.com"]
   s.extra_rdoc_files = [
@@ -24,7 +24,6 @@ Gem::Specification.new do |s|
      "Rakefile",
      "lib/vegas.rb",
      "lib/vegas/runner.rb",
-     "pkg/vegas-0.1.1.gem",
      "test/apps.rb",
      "test/test_app/bin/test_app",
      "test/test_app/bin/test_rack_app",
@@ -52,17 +51,20 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rack>, [">= 1.0.0"])
-      s.add_development_dependency(%q<bacon>, [">= 1.1.0"])
-      s.add_development_dependency(%q<sinatra>, [">= 0.9.4"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.8"])
+      s.add_development_dependency(%q<bacon>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<sinatra>, ["~> 0.9.4"])
     else
       s.add_dependency(%q<rack>, [">= 1.0.0"])
-      s.add_dependency(%q<bacon>, [">= 1.1.0"])
-      s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.8"])
+      s.add_dependency(%q<bacon>, ["~> 1.1.0"])
+      s.add_dependency(%q<sinatra>, ["~> 0.9.4"])
     end
   else
     s.add_dependency(%q<rack>, [">= 1.0.0"])
-    s.add_dependency(%q<bacon>, [">= 1.1.0"])
-    s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.8"])
+    s.add_dependency(%q<bacon>, ["~> 1.1.0"])
+    s.add_dependency(%q<sinatra>, ["~> 0.9.4"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vegas
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Aaron Quint
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-28 00:00:00 -05:00
+date: 2010-01-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,13 +22,23 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
 - !ruby/object:Gem::Dependency 
   name: bacon
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         version: 1.1.0
     version: 
@@ -38,7 +48,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         version: 0.9.4
     version: 
@@ -60,7 +70,6 @@ files:
 - Rakefile
 - lib/vegas.rb
 - lib/vegas/runner.rb
-- pkg/vegas-0.1.1.gem
 - test/apps.rb
 - test/test_app/bin/test_app
 - test/test_app/bin/test_rack_app