vegas 0.0.4.1 → 0.1.0

data/History.txt

@@ -1,3 +1,13 @@
+== 0.1.0 2009-08-30
+
+* New:
+  * options[:start] = false will keep the app from actually starting (useful for defining your own start/stop commands)
+  * options[:launch_path] Takes a string or an object that responds to call (proc/lambda) that gets the runner as its only argument. This allows you to easily manipulate options or args to launch the app to a specific path. See latest gembox for example.
+* Changed:
+  * Sinatra is no longer a dependency! Vegas can now run pure Rack apps.
+  * All methods for starting an app are grouped into Runner#start
+  * launch! and start both take an optional path string to launch the app to.
+
 == 0.0.4 2009-08-09
 
 * new -L (--skip-launch) option doesn't launch the web browser (thanks bmabey!)

data/README.rdoc

@@ -8,7 +8,7 @@ Vegas aims to solve the simple problem of creating executable versions of Sinatr
 
 == FEATURES/PROBLEMS:
 
-Currently, Vegas just includes a single class Vegas::Runner which wraps your Sinatra app to give it command line options, daemonization, PID/URL tracking, and browser launching (using Launchy).
+Currently, Vegas just includes a single class Vegas::Runner which wraps your Sinatra app to give it command line options, daemon-ization, PID/URL tracking, and browser launching.
 
 Lets say you have a gem with a sinatra application. With Vegas you can create a bin that looks like
   

data/lib/vegas.rb

@@ -1,14 +1,14 @@
 begin
-  require 'sinatra'
+  require 'rack'
 rescue LoadError
   require 'rubygems'
-  require 'sinatra'
+  require 'rack'
 end
 
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
 module Vegas
-  VERSION = "0.0.4.1"
+  VERSION = "0.1.0"
   WINDOWS = !!(RUBY_PLATFORM =~ /(mingw|bccwin|wince|mswin32)/i)
   
   autoload :Runner, 'vegas/runner'

data/lib/vegas/runner.rb

@@ -12,73 +12,82 @@ end
 
 module Vegas
   class Runner
-    attr_reader :app, :app_name, :rack_handler, :port, :host, :options
-    
+    attr_reader :app, :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 = {}, &block)
+
+    def initialize(app, app_name, set_options = {}, runtime_args = ARGV, &block)
       # initialize
-      @app          = app
-      @app_name     = app_name
-      @options      = set_options || {}
-      @rack_handler = @app.send :detect_rack_handler
+      @app                    = app
+      @app_name               = app_name
+      @options                = set_options || {}
+      @runtime_args           = runtime_args
+      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')
       # load options from opt parser
-      define_options do |opts|
+      @args = define_options do |opts|
         if block_given?
           opts.separator ''
           opts.separator "#{app_name} options:"
-          yield(opts, app)
+          yield(self, opts, app)
         end
       end
+
       # set app options
       @host = options[:host] || HOST
-      @app.set options
+      @app.set(options) if @app.respond_to?(:set)
       # initialize app dir
       FileUtils.mkdir_p(app_dir)
-      
-      logger.info "Running with Windows Settings" if WINDOWS
-      logger.info "Starting #{app_name}"
-      
-      check_for_running
-      find_port
-      write_url
-      
-      begin
-        launch!    
-        daemonize! unless options[:foreground]      
-        run!
-      rescue RuntimeError => e
-        logger.warn "There was an error starting #{app_name}: #{e}"
-        exit
+      return if options[:start] === false
+      # evaluate the launch_path
+      path = if options[:launch_path] && 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)
     end
-    
+
     def pid_file
       File.join(app_dir, "#{app_name}.pid")
     end
-    
+
     def url_file
       File.join(app_dir, "#{app_name}.url")
     end
-    
+
     def url
       "http://#{host}:#{port}"
     end
-    
+
     def log_file
       File.join(app_dir, "#{app_name}.log")
     end
-    
-    def handler_name
-      rack_handler.name.gsub(/.*::/, '')
+
+    def start(path = nil)
+      logger.info "Running with Windows Settings" if WINDOWS
+      logger.info "Starting #{app_name}"
+      begin
+        check_for_running(path)
+        find_port
+        write_url
+        launch!(url, path)
+        daemonize! unless options[:foreground]      
+        run!
+      rescue RuntimeError => e
+        logger.warn "There was an error starting #{app_name}: #{e}"
+        exit
+      end
     end
-        
+
     def find_port
       if @port = options[:port]
         if !port_open?
@@ -93,7 +102,7 @@ module Vegas
         end
       end
     end
-    
+
     def port_open?(check_url = nil)
       begin
         open(check_url || url)
@@ -102,22 +111,22 @@ module Vegas
         true
       end
     end
-    
+
     def write_url
       File.open(url_file, 'w') {|f| f << url }
     end
-    
-    def check_for_running
+
+    def check_for_running(path = nil)
       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}"
-          launch!(running_url)
+          launch!(running_url, path)
           exit!
         end
       end
     end
-    
+
     def run!
       rack_handler.run app, :Host => host, :Port => port do |server|
         trap(kill_command) do
@@ -128,7 +137,7 @@ module Vegas
         end
       end
     end
-    
+
     # Adapted from Rackup
     def daemonize!
       if RUBY_VERSION < "1.9"
@@ -149,13 +158,13 @@ module Vegas
       File.open(pid_file, 'w') {|f| f.write("#{Process.pid}") }
       at_exit { delete_pid! }
     end
-    
-    def launch!(specific_url = nil)
+
+    def launch!(specific_url = nil, path = nil)
       return if options[:skip_launch]
-      cmd = WINDOWS ? "start" : "sleep 2 && open"
-      system "#{cmd} #{specific_url || url}"
+      cmd = WINDOWS ? "start" : "open"
+      system "#{cmd} #{specific_url || url}#{path}"
     end
-    
+
     def kill!
       pid = File.read(pid_file)
       logger.warn "Sending INT to #{pid.to_i}"
@@ -163,7 +172,7 @@ module Vegas
     rescue => e
       logger.warn "pid not found at #{pid_file} : #{e}"
     end
-    
+
     def status
       if File.exists?(pid_file)
         logger.info "#{app_name} running"
@@ -174,26 +183,36 @@ module Vegas
       end
     end
 
-    def logger
-      return @logger if @logger
-      @logger = Logger.new(STDOUT)
-      @logger.level     = options[:debug] ? Logger::DEBUG : Logger::INFO
-      @logger.formatter = Proc.new {|s, t, n, msg| "[#{t}] #{msg}\n"}
+    def self.logger=(logger)
+      @logger = logger
+    end
+
+    def self.logger
+      @logger ||= LOGGER if defined?(LOGGER)
+      if !@logger
+        @logger           = Logger.new(STDOUT)
+        @logger.formatter = Proc.new {|s, t, n, msg| "[#{t}] #{msg}\n"}
+        @logger
+      end
       @logger
     end
-    
+
+    def logger
+      self.class.logger
+    end
+
     private
     def define_options
-      OptionParser.new("", 24, '  ') { |opts|
+      OptionParser.new("", 24, '  ') do |opts|
         opts.banner = "Usage: #{app_name} [options]"
 
         opts.separator ""
         opts.separator "Vegas options:"
-                
-        opts.on("-s", "--server SERVER", "serve using SERVER (webrick/mongrel)") { |s|
+
+        opts.on("-s", "--server SERVER", "serve using SERVER (thin/mongrel/webrick)") { |s|
           @rack_handler = Rack::Handler.get(s)
         }
-        
+
         opts.on("-o", "--host HOST", "listen on HOST (default: #{HOST})") { |host|
           @options[:host] = host
         }
@@ -218,18 +237,18 @@ module Vegas
           kill!
           exit
         }
-        
+
         opts.on('-S', "--status", "display the current running PID and URL then quit") {|s| 
           status
           exit!
         }
-        
+
         opts.on('-d', "--debug", "raise the log level to :debug (default: :info)") {|s| 
           @options[:debug] = true
         }
-                
+
         yield opts if block_given?
-        
+
         opts.separator ""
         opts.separator "Common options:"
 
@@ -242,24 +261,25 @@ module Vegas
           if app.respond_to?(:version)
             puts "#{app_name} #{app.version}"
           end
-          puts "sinatra #{Sinatra::VERSION}"
+          puts "rack #{Rack::VERSION.join('.')}"
+          puts "sinatra #{Sinatra::VERSION}" if defined?(Sinatra)
           puts "vegas #{Vegas::VERSION}"
           exit
         end
 
-        opts.parse! ARGV
-      }
+      end.parse! @runtime_args
     rescue OptionParser::MissingArgument => e
       logger.warn "#{e}, run -h for options"
       exit
     end
-    
+
     def kill_command
       WINDOWS ? 1 : :INT
     end
-    
+
     def delete_pid!
       File.delete(pid_file) if File.exist?(pid_file)
     end
   end
+  
 end

data/test/test_app/test_app.rb

@@ -4,7 +4,7 @@ require 'sinatra'
 class TestApp < Sinatra::Base
   
   get '/' do
-    'This is a TEST'
+    'This is a TEST: params: ' + params.inspect
   end
   
 end

data/test/test_apps.rb

@@ -1,4 +1,4 @@
-class TestApp1 < Sinatra::Default
+class TestApp1 < Sinatra::Base
   
   get '/' do
     'TestApp1 Index'
@@ -10,7 +10,7 @@ class TestApp1 < Sinatra::Default
 end
 
 
-class TestApp2 < Sinatra::Default
+class TestApp2 < Sinatra::Base
   
   get '/' do
     'TestApp2 Index'
@@ -19,4 +19,8 @@ class TestApp2 < Sinatra::Default
   get '/route' do
     'TestApp2 route'
   end
-end
+end
+
+RackApp1 = Proc.new {|env| 
+  [200, {'Content-Type' => 'text/plain'}, ["This is an app. #{env.inspect}"]]
+}

data/test/test_helper.rb

@@ -1,8 +1,8 @@
 dependencies = %w{
   bacon
+  mocha/standalone
+  mocha/object
   sinatra
-  rack/test
-  nokogiri
 }
 
 begin
@@ -13,10 +13,15 @@ rescue LoadError
 end
 
 require File.join(File.dirname(__FILE__), '..', 'lib', 'vegas.rb')
+require File.join(File.dirname(__FILE__), 'test_apps.rb')
+
 
 module TestHelper
-  def rackup(app)
-    Rack::Test::Session.new(app)
+  
+  def vegas(*args, &block)
+    Vegas::Runner.any_instance.stubs(:daemonize!).once
+    Rack::Handler::Thin.stubs(:run).once
+    @vegas = Vegas::Runner.new(*args, &block)
   end
   
   def body
@@ -26,6 +31,16 @@ module TestHelper
   def instance_of(klass)
     lambda {|obj| obj.is_a?(klass) }
   end
+  
+  def exist_as_file
+    lambda {|obj| File.exist?(obj) }
+  end
+  
+  def have_matching_file_content(content_regex)
+    lambda {|obj| 
+      File.exist?(obj) && File.read(obj).match(content_regex) 
+    }
+  end
 
   def html_body
     body =~ /^\<html/ ? body : "<html><body>#{body}</body></html>"
@@ -33,27 +48,4 @@ module TestHelper
 
 end
 
-Bacon::Context.send(:include, TestHelper)
-
-class Should
-
-  def have_element(search, content = nil)
-    satisfy "have element matching #{search}" do
-      doc = Nokogiri.parse(@object.to_s)
-      node_set = doc.search(search)
-      if node_set.empty?
-        false
-      else
-        collected_content = node_set.collect {|t| t.content }.join(' ')
-        case content
-        when Regexp
-          collected_content =~ content
-        when String
-          collected_content.include?(content)
-        when nil
-          true
-        end
-      end
-    end
-  end
-end
+Bacon::Context.send(:include, TestHelper)

data/test/test_vegas_runner.rb

@@ -1,8 +1,103 @@
 require File.join(File.dirname(__FILE__), 'test_helper.rb')
 
+Vegas::Runner::ROOT_DIR = File.join(File.dirname(__FILE__), 'tmp', '.vegas')
+
 describe 'Vegas::Runner' do
-  
-  
+  before do
+    FileUtils.rm_rf(File.join(File.dirname(__FILE__), 'tmp'))
+    @log = StringIO.new
+    Vegas::Runner.logger = Logger.new(@log)
+  end
+
+  describe '.new' do
+
+    describe 'with basic usage' do
+      before do
+        Vegas::Runner.any_instance.expects(:system).once
+        vegas(TestApp1, 'vegas_test_app_1', {:sessions => true}, ["route","--debug"])
+      end
+
+      it "sets app" do
+        @vegas.app.should == TestApp1
+      end
+
+      it "sets app name" do
+        @vegas.app_name.should == 'vegas_test_app_1'
+      end
+
+      it "stores options" do
+        @vegas.options[:sessions].should.be.true
+      end
+
+      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
+    end
+
+    describe 'with a sinatra app' do
+      before do
+        TestApp1.expects(:detect_rack_handler).returns(Rack::Handler::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
+    
+      it "sets options on the app" do
+        @vegas.app.sessions.should.be.true
+      end
+
+    end
+
+    describe 'with a simple rack app' do
+      before do
+        vegas(RackApp1, 'rack_app_1', {:skip_launch => true, :sessions => true})
+      end
+      
+      it "sets default rack handler to thin" do
+        @vegas.rack_handler.should == Rack::Handler::Thin
+      end      
+    end
+    
+    describe 'with a launch path specified as a proc' do      
+      it 'evaluates the proc in the context of the runner' do
+        Vegas::Runner.any_instance.expects(:system).once.with {|s| s =~ /\?search\=blah$/ }
+        vegas(TestApp2, 
+              'vegas_test_app_2', 
+              {:launch_path => Proc.new {|r| "?search=#{r.args.first}" }}, 
+              ["--debug", "blah"])
+        @vegas.options[:launch_path].should.be instance_of(Proc)
+      end      
+    end
+    
+    describe 'with a launch path specified as string' do
+      it 'launches to the specific path' do
+        Vegas::Runner.any_instance.expects(:system).once.with {|s| s =~ /\?search\=blah$/ }
+        vegas(TestApp2, 
+              'vegas_test_app_2', 
+              {:launch_path => "?search=blah"}, 
+              ["--debug", "blah"])
+        @vegas.options[:launch_path].should == "?search=blah"
+      end
+    end
+    
+
+  end
 
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vegas
 version: !ruby/object:Gem::Version 
-  version: 0.0.4.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Aaron Quint
@@ -9,48 +9,38 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-09 00:00:00 -04:00
+date: 2009-08-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: sinatra
+  name: rack
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 0.9.1
+        version: "1.0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: newgem
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.5.1
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
+  name: bacon
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.6
+        version: 1.1.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: bacon
+  name: mocha
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.0
+        version: 0.9.7
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe