devserver 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/devserver

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# devserver - devserver.outfielding.net
+# Copyright 2010 Jason Adam Young
+# 
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+# 
+#       http://www.apache.org/licenses/LICENSE-2.0
+# 
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+source_root = File.expand_path(File.dirname(__FILE__) + "/..")
+$LOAD_PATH.unshift("#{source_root}/lib")
+
+require 'rubygems' rescue nil
+require 'devserver'
+require 'devserver/cli'
+Devserver::CLI.start
+

data/devserver.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "devserver/version"
+
+Gem::Specification.new do |s|
+  s.name        = "devserver"
+  s.version     = Devserver::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jason Adam Young"]
+  s.email       = ["jay@outfielding.net"]
+  s.homepage    = "http://devserver.outfielding.net"
+  s.summary     = %q{Provides a wrapper around thin, similar to passenger standalone, for local ruby on rails development.}
+  s.description = %q{Provides a wrapper around thin, similar to passenger standalone, for local ruby on rails development.}
+  s.license = 'Apache-v2'
+  s.rubyforge_project = "devserver"
+  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"]
+  s.add_dependency('thor', '>= 0.14.6')
+end

data/lib/devserver/cli.rb

@@ -0,0 +1,167 @@
+require 'thor'
+require 'yaml'
+
+module Devserver
+  class CLI < Thor
+    include Thor::Actions
+    
+    # defaults
+    @@default_settings = {}
+    @@default_settings_source = {}
+    @@is_rails_dir = true
+
+    # sets defaults for the class
+    def self.set_defaults
+      if(!(@@app_root = self.determine_app_root))
+        @@is_rails_dir = false
+        @@default_settings[:app_root] = '.'
+      end
+      @@default_settings[:port] = 3000
+      @@default_settings[:environment] = 'development'
+      @@default_settings[:log_file] = "#{@@default_settings[:app_root]}/log/devserver.log"
+      @@default_settings[:pid_file] = "#{@@default_settings[:app_root]}/tmp/pids/devserver.pid"
+      @@default_settings[:mode] = 'start'
+      @@default_settings[:server] = 'thin'
+      self.load_defaults_from_yaml
+    end
+
+    # Pretend that we are checking for rails by checking for config/boot.rb
+    # we'll even do something smart for ourselves by chdir .. if ../config/boot.rb
+    # exists.  "smart for ourselves" is the operative phrase
+    #
+    # @return [String] the current app root path if we think this is a rails dir, else nil
+    def self.determine_app_root
+      if(File.exist?('config/boot.rb'))
+        return Dir.pwd
+      elsif(File.exist?('../config/boot.rb'))
+        Dir.chdir('..')
+        return Dir.pwd
+      else
+        return nil
+      end
+    end
+
+    # Load defaults from a devserver.yaml file located in config/
+    def self.load_defaults_from_yaml
+      configfile ="#{@@default_settings[:app_root]}/config/devserver.yml"
+      if File.exists?(configfile) then
+        @@default_settings[:configfile] = configfile
+        temp = YAML.load_file(configfile)
+        if temp.class == Hash
+          temp.each do |key,value|
+            @@default_settings[key.to_sym] = value
+            @@default_settings_source[key.to_sym] = configfile
+          end
+        end
+      end   
+    end
+    
+    # set defaults on class load
+    self.set_defaults 
+
+    # these are not the tasks that you seek
+    no_tasks do
+      # prints out a warning message if current dir does not appear to be a rails dir
+      def rails_warning
+        if(!@@is_rails_dir)
+          puts "WARNING: #{Dir.pwd} does not appear to be a rails application directory"
+        end
+      end
+      
+      # exits with error if current dir does not appear to be a rails dir
+      def rails_error
+        if(!@@is_rails_dir)
+          puts "ERROR: #{Dir.pwd} does not appear to be a rails application directory"
+          exit(1)
+        end
+      end
+      
+      def print_defaults
+        puts "default_settings:\n"
+        config_keys = @@default_settings.keys.map{|k|k.to_s}
+        config_keys.sort.each do |key|
+          puts "  #{key} => #{@@default_settings[key.to_sym]} (#{@@default_settings_source[key.to_sym] || 'code'})\n"
+        end
+      end
+    end
+
+
+    desc "about", "about devserver"  
+    def about
+      rails_warning
+      puts "Devserver Version #{VERSION}: Provides a wrapper around passenger, thin or mongrel for local ruby on rails development."
+    end
+
+    desc "defaults", "devserver configuration defaults"  
+    def defaults
+      rails_warning
+      print_defaults
+    end
+        
+    desc "start", "start devserver"
+    method_option :environment,:default => @@default_settings[:environment], :aliases => "-e", :desc => "Rails environment to start"
+    method_option :pid_file,:default => @@default_settings[:pid_file], :aliases => "-P", :desc => "Web server pid file"
+    method_option :log_file,:default => @@default_settings[:log_file], :aliases => "-l", :desc => "Web server log file"
+    method_option :port,:default => @@default_settings[:port], :aliases => "-p", :desc => "Run the web server on this port"
+    method_option :server,:default => @@default_settings[:server], :aliases => "-s", :desc => "Web server to use (e.g. passenger, thin, mongrel)"
+    def start
+      rails_error
+      the_server = Devserver::CommandManager.new(options)
+      if(the_server.is_port_open?)
+        puts "Another process is running on Port: #{the_server.port}"
+        puts "Running stop command: #{the_server.command(stop)}"
+        the_server.stop_devserver
+      end
+      the_server.start_devserver
+    end
+    
+    desc "debug", "start devserver in debug mode"
+    method_option :environment,:default => @@default_settings[:environment], :aliases => "-e", :desc => "Rails environment to start"
+    method_option :pid_file,:default => @@default_settings[:pid_file], :aliases => "-P", :desc => "Web server pid file"
+    method_option :log_file,:default => @@default_settings[:log_file], :aliases => "-l", :desc => "Web server log file"
+    method_option :port,:default => @@default_settings[:port], :aliases => "-p", :desc => "Run the web server on this port"
+    method_option :server,:default => @@default_settings[:server], :aliases => "-s", :desc => "Web server to use (e.g. passenger, thin, mongrel)"
+    def debug
+      rails_error
+      the_server = Devserver::CommandManager.new(options)
+      if(the_server.is_port_open?)
+        puts "Another process is running on Port: #{the_server.port}"
+        puts "Running stop command: #{the_server.command(stop)}"
+        the_server.stop_devserver
+      end
+      the_server.start_devserver('debug')
+    end
+    
+    desc "stop", "stop devserver"
+    method_option :pid_file,:default => @@default_settings[:pid_file], :aliases => "-P", :desc => "Web server pid file"
+    def stop
+      rails_error
+      the_server = Devserver::CommandManager.new(options)
+      the_server.stop_devserver      
+    end
+    
+    desc "command", "show devserver command"
+    method_option :environment,:default => @@default_settings[:environment], :aliases => "-e", :desc => "Rails environment to start"
+    method_option :pid_file,:default => @@default_settings[:pid_file], :aliases => "-P", :desc => "Web server pid file"
+    method_option :log_file,:default => @@default_settings[:log_file], :aliases => "-l", :desc => "Web server log file"
+    method_option :port,:default => @@default_settings[:port], :aliases => "-p", :desc => "Run the web server on this port"
+    method_option :server,:default => @@default_settings[:server], :aliases => "-s", :desc => "Web server to use (e.g. passenger, thin, mongrel)"
+    method_option :start,:default => true, :desc => "Show command used for server start"
+    method_option :stop,:default => true, :desc => "Show command used for server stop"
+    method_option :debug,:default => true, :desc => "Show command used for server start with debugging"
+    def command
+      rails_warning
+      the_server = Devserver::CommandManager.new(options)
+      if(options[:start])
+        puts "start command: #{the_server.command('start')}"
+      end
+      if(options[:stop])
+        puts "stop command: #{the_server.command('stop')}"
+      end
+      if(options[:debug])
+        puts "debug command: #{the_server.command('debug')}"
+      end
+    end
+     
+  end
+end

data/lib/devserver/command_manager.rb

@@ -0,0 +1,130 @@
+require 'socket'
+require 'timeout'
+
+module Devserver
+  class CommandManager
+    attr_accessor :port, :environment, :log_file, :pid_file, :mode, :server
+  
+    # raises DevserverError if it doesn't appear we are in or one level down of a rails directory
+    #
+    def initialize(options = {})
+      options.keys.each do |key|
+        self.instance_variable_set("@#{key.to_s}",options[key])
+      end
+    end
+      
+    # Pretend that we are checking for rails by checking for config/boot.rb
+    # we'll even do something smart for ourselves by chdir .. if ../config/boot.rb
+    # exists.  "smart for ourselves" is the operative phrase
+    #
+    # @return [String] the current app root path if we think this is a rails dir, else nil
+    def determine_app_root
+      if(File.exist?('config/boot.rb'))
+        return Dir.pwd
+      elsif(File.exist?('../config/boot.rb'))
+        Dir.chdir('..')
+        return Dir.pwd
+      else
+        return nil
+      end
+    end
+
+    # builds the command options with regard to the specified server
+    #
+    # @param [Boolean] mode mode to start in, either debug or start
+    # @return [String] command options
+    def start_options(mode = self.mode)
+      common_options = "--port #{self.port} --environment #{self.environment}"
+      if(mode == 'debug')
+        common_options += " --debug"
+      end
+      case self.server
+      when 'passenger'
+        "#{common_options} --log-file #{self.log_file} --pid-file #{self.pid_file}"
+      when 'thin'
+        "#{common_options} --log #{self.log_file} --pid #{self.pid_file}"
+      when 'mongrel'
+        "#{common_options} --log #{self.log_file} --pid #{self.pid_file}"
+      else
+        nil
+      end
+    end
+  
+    # builds the start command for @server
+    #
+    # @param [Boolean] mode mode to start in, either debug or start
+    # @return [String] start command
+    def start_command(mode = self.mode)
+      case self.server
+      when 'passenger'
+        "passenger start #{self.start_options(mode)}"
+      when 'thin'
+        "thin #{self.start_options(mode)} start"
+      when 'mongrel'
+        "mongrel_rails start #{self.start_options(mode)}"
+      else
+        raise DevserverError, "Unrecognized web server: #{self.server}"
+      end
+    end
+  
+    # builds the stop command for @server
+    #
+    # @return [String] stop command
+    def stop_command
+      case self.server
+      when 'passenger'
+        "passenger stop --pid-file #{self.pid_file}"
+      when 'thin'
+        "thin --pid #{self.pid_file} stop"
+      when 'mongrel'
+        "mongrel_rails stop --pid #{self.pid_file}"
+      else
+        raise DevserverError, "Unrecognized web server: #{self.server}"
+      end
+    end
+  
+    # returns command for @server and @mode (start, stop, debug)
+    #
+    # @return [String] command for @server and @mode
+    def command(mode = self.mode)
+      case mode
+      when 'start'
+        self.start_command(mode)
+      when 'debug'
+        self.start_command(mode)
+      when 'stop'
+        self.stop_command
+      else
+        raise DevserverError, "Unrecognized mode: #{mode}"
+      end
+    end
+
+    # check to see if anything is still running on @port
+    #
+    # @return [Boolean] whether port responds or not
+    def is_port_open?
+      begin
+        Timeout::timeout(1) do
+          begin
+            s = TCPSocket.new('127.0.0.1', self.port)
+            s.close
+            return true
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+            return false
+          end
+        end
+      rescue Timeout::Error
+      end
+      return false
+    end
+  
+    def start_devserver(mode = self.mode)
+      system("#{self.start_command(mode)}")
+    end
+    
+    def stop_devserver
+      system("#{self.stop_command}")
+    end
+  
+  end
+end

data/lib/devserver/version.rb

@@ -0,0 +1,3 @@
+module Devserver
+  VERSION = "0.0.1"
+end

data/lib/devserver.rb

@@ -0,0 +1,9 @@
+require 'devserver/version'
+
+module Devserver
+  autoload :CommandManager,          'devserver/command_manager'
+  
+  class DevserverError < StandardError
+  end
+  
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: devserver
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jason Adam Young
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 14
+        - 6
+        version: 0.14.6
+  type: :runtime
+  version_requirements: *id001
+description: Provides a wrapper around thin, similar to passenger standalone, for local ruby on rails development.
+email: 
+- jay@outfielding.net
+executables: 
+- devserver
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- bin/devserver
+- devserver.gemspec
+- lib/devserver.rb
+- lib/devserver/cli.rb
+- lib/devserver/command_manager.rb
+- lib/devserver/version.rb
+has_rdoc: true
+homepage: http://devserver.outfielding.net
+licenses: 
+- Apache-v2
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: devserver
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides a wrapper around thin, similar to passenger standalone, for local ruby on rails development.
+test_files: []
+