picnic 0.7.1 → 0.8.0

data/History.txt

@@ -1,3 +1,13 @@
+=== 0.8.0 :: 2009-03-18
+
+* Overhauled for Camping 2.0. Major changes throughout. Some things to
+  watch out for:
+  * Your app's bin script should now specify :app_file instead of :app_path,
+    and :app_file should point to your Camping app's main .rb file.
+  * Postamples for Mongrel and WEBrick are gone, since everything is now
+    handled by Rack. It is also now possible to run Picnic apps on Phusion
+    Passenger (mod_rails/mod_rack).
+
 === 0.7.1 :: 2008-11-10
 
 * Fixed config file loading problems rooted in $APP_PATH inconsistencies.

data/Manifest.txt

@@ -9,21 +9,38 @@ lib/picnic/authentication.rb
 lib/picnic/cli.rb
 lib/picnic/conf.rb
 lib/picnic/controllers.rb
-lib/picnic/postambles.rb
+lib/picnic/logger.rb
+lib/picnic/server.rb
 lib/picnic/service_control.rb
-lib/picnic/utils.rb
 lib/picnic/version.rb
+picnic.gemspec
 setup.rb
 test/picnic_test.rb
 test/test_helper.rb
-vendor/camping-1.5.180/CHANGELOG
-vendor/camping-1.5.180/COPYING
-vendor/camping-1.5.180/README
-vendor/camping-1.5.180/Rakefile
-vendor/camping-1.5.180/lib/camping-unabridged.rb
-vendor/camping-1.5.180/lib/camping.rb
-vendor/camping-1.5.180/lib/camping/db.rb
-vendor/camping-1.5.180/lib/camping/fastcgi.rb
-vendor/camping-1.5.180/lib/camping/reloader.rb
-vendor/camping-1.5.180/lib/camping/session.rb
-vendor/camping-1.5.180/lib/camping/webrick.rb
+vendor/camping-2.0.20090212/CHANGELOG
+vendor/camping-2.0.20090212/COPYING
+vendor/camping-2.0.20090212/README
+vendor/camping-2.0.20090212/Rakefile
+vendor/camping-2.0.20090212/bin/camping
+vendor/camping-2.0.20090212/doc/camping.1.gz
+vendor/camping-2.0.20090212/examples/README
+vendor/camping-2.0.20090212/examples/blog.rb
+vendor/camping-2.0.20090212/examples/campsh.rb
+vendor/camping-2.0.20090212/examples/tepee.rb
+vendor/camping-2.0.20090212/extras/Camping.gif
+vendor/camping-2.0.20090212/extras/flipbook_rdoc.rb
+vendor/camping-2.0.20090212/extras/permalink.gif
+vendor/camping-2.0.20090212/lib/camping-unabridged.rb
+vendor/camping-2.0.20090212/lib/camping.rb
+vendor/camping-2.0.20090212/lib/camping/ar.rb
+vendor/camping-2.0.20090212/lib/camping/ar/session.rb
+vendor/camping-2.0.20090212/lib/camping/mab.rb
+vendor/camping-2.0.20090212/lib/camping/reloader.rb
+vendor/camping-2.0.20090212/lib/camping/server.rb
+vendor/camping-2.0.20090212/lib/camping/session.rb
+vendor/camping-2.0.20090212/setup.rb
+vendor/camping-2.0.20090212/test/apps/env_debug.rb
+vendor/camping-2.0.20090212/test/apps/forms.rb
+vendor/camping-2.0.20090212/test/apps/misc.rb
+vendor/camping-2.0.20090212/test/apps/sessions.rb
+vendor/camping-2.0.20090212/test/test_camping.rb

data/Rakefile

@@ -22,6 +22,7 @@ ENV['NODOT'] = '1'
 
 NAME = "picnic"
 REV = nil
+#REV = Time.now.strftime('%Y%m%d%H%M')
 #REV = `svn info`[/Revision: (\d+)/, 1] rescue nil
 VERS = ENV['VERSION'] || (Picnic::VERSION::STRING + (REV ? ".#{REV}" : ""))
                           CLEAN.include ['**/.*.sw?', '*.gem', '.config']
@@ -56,6 +57,7 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   
   # note that camping-1.5.0.180 is now bundled with picnic in the vendor directory. 
   p.extra_deps = [
+    'rack',
     'markaby',
     'activesupport'
   ]

data/lib/picnic.rb

@@ -1,126 +1,11 @@
 require 'rubygems'
-#require 'active_support'
+require 'activesupport'
 
-$: << File.dirname(File.expand_path(__FILE__))+"/../vendor/camping-1.5.180/lib" 
-require "camping"
+$: << File.dirname(__FILE__)
+$: << File.dirname(__FILE__) + "/../vendor/camping-2.0.20090212/lib"
 
-$: << File.dirname(File.expand_path(__FILE__))
-require "picnic/utils.rb"
-require "picnic/conf.rb"
-require "picnic/postambles.rb"
+require "camping"
 
 
-class Module
-  
-  # Adds Picnic functionality to a Camping-enabled module.
-  #
-  # Example:
-  #
-  #   Camping.goes :Blog
-  #   Blog.picnic!
-  #
-  # Your <tt>Blog</tt> Camping app now has Picnic functionality.
-  def picnic!
-    include Picnic
-    
-    puts "Adding Picnic functionality to #{self} from #{File.dirname(File.expand_path(__FILE__))}..."
-    self.module_eval do
-      # Initialize your application's logger. 
-      # This is automatically done for you when you call #picnic!
-      # The logger is initialized based on your <tt>:log</tt> configuration.
-      # See <tt>config.example.yml</tt> for info on configuring the logger.
-      def init_logger
-        puts "Initializing #{self} logger..."
-        $LOG = Picnic::Utils::Logger.new(self::Conf.log[:file])
-        $LOG.level = Picnic::Utils::Logger.const_get(self::Conf.log[:level])
-      end
-      module_function :init_logger
-      
-      # Initialize your application's database logger. 
-      # If enabled, all SQL queries going through ActiveRecord will be logged here.
-      #
-      # THIS SEEMS TO BE BROKEN RIGHT NOW and I can't really understand why.
-      def init_db_logger
-        begin
-          if self::Conf.db_log
-            log_file = self::Conf.db_log[:file] || "#{self.to_s.downcase}_db.log"
-            self::Models::Base.logger = Picnic::Utils::Logger.new(log_file)
-            self::Models::Base.logger.level = Picnic::Utils::Logger.const_get(self::Conf.db_log[:level] || 'DEBUG')
-            $LOG.debug "Logging database queries to #{log_file.inspect}"
-          end
-        rescue Errno::EACCES => e
-          $LOG.warn "Can't write to database log file at '#{log_file}': #{e}"
-        end
-      end
-      module_function :init_db_logger
-      
-      # Enable authentication for your app.
-      #
-      # For example:
-      #
-      #   Camping.goes :Blog
-      #   Blog.picnic!
-      #
-      #   $CONF[:authentication] ||= {:username => 'admin', :password => 'picnic'}
-      #   Blog.authenticate_using :basic
-      #
-      #   module Blog
-      #     def self.authenticate(credentials)
-      #       credentials[:username] == Taskr::Conf[:authentication][:username] &&
-      #         credentials[:password] == Taskr::Conf[:authentication][:password]
-      #     end
-      #   end
-      #
-      # Note that in the above example we use the authentication configuration from
-      # your app's conf file.
-      #
-      def authenticate_using(mod)
-        load "picnic/authentication.rb"
-        mod = self::Authentication.const_get(mod.to_s.camelize) unless mod.kind_of? Module
-        
-        $LOG.info("Enabling authentication for all requests using #{mod.inspect}.")
-        
-        module_eval do
-          include mod
-        end
-      end
-      module_function :authenticate_using
-    
-      # Launches the web server to run your Picnic app.
-      # This method will continue to run as long as your server is running.
-      def start_picnic
-          require "#{File.dirname(File.expand_path(__FILE__))}/picnic/postambles.rb"
-          self.extend self::Postambles
-          
-          if $PID_FILE && !(self::Conf.server.to_s == 'mongrel' || self::Conf.server.to_s == 'webrick')
-            $LOG.warn("Unable to create a pid file. You must use mongrel or webrick for this feature.")
-          end
-          
-          puts "\nStarting with configuration: #{$CONF.to_yaml}"
-          puts
-        
-        #  begin
-            raise NoMethodError if self::Conf.server.nil?
-            send(self::Conf.server)
-        #  rescue NoMethodError => e
-        #    # FIXME: this rescue can sometime report the incorrect error messages due to other underlying problems
-        #    #         raising a NoMethodError
-        #    if Fluxr::Conf.server
-        #      raise e, "The server setting '#{Fluxr::Conf.server}' in your config.yml file is invalid."
-        #    else
-        #      raise e, "You must have a 'server' setting in your config.yml file. Please see the Fluxr documentation."
-        #    end
-        #  end
-      end
-      module_function :start_picnic
-      
-      c = File.dirname(File.expand_path(__FILE__))+'/picnic/controllers.rb'
-      p = IO.read(c).gsub("Picnic", self.to_s)
-      eval p, TOPLEVEL_BINDING
-      
-    end
-    
-    self::Conf.load(self)
-    init_logger
-  end
+module Picnic
 end

data/lib/picnic/authentication.rb

@@ -3,6 +3,42 @@ module Picnic #:nodoc:
   # for your Camping app. 
   #
   module Authentication
+    
+    def self.included(base)
+      base.module_eval do
+        # Enable authentication for your app.
+        #
+        # For example:
+        #
+        #   Camping.goes :Blog
+        #   Blog.picnic!
+        #
+        #   $CONF[:authentication] ||= {:username => 'admin', :password => 'picnic'}
+        #   Blog.authenticate_using :basic
+        #
+        #   module Blog
+        #     def self.authenticate(credentials)
+        #       credentials[:username] == Taskr::Conf[:authentication][:username] &&
+        #         credentials[:password] == Taskr::Conf[:authentication][:password]
+        #     end
+        #   end
+        #
+        # Note that in the above example we use the authentication configuration from
+        # your app's conf file.
+        #
+        def authenticate_using(mod)
+          mod = Picnic::Authentication.const_get(mod.to_s.camelize) unless mod.kind_of? Module
+          
+          $LOG.info("Enabling authentication for all requests using #{mod.inspect}.")
+          
+          module_eval do
+            include mod
+          end
+        end
+        module_function :authenticate_using
+      end
+    end
+    
     # Picnic::Authentication::Basic provides Basic HTTP Authentication for your Camping app. 
     # The module defines a <tt>service</tt> method that only continues the request chain when 
     # proper credentials are provided by the client (browser).
@@ -50,7 +86,7 @@ module Picnic #:nodoc:
       # Reads the username and password from the headers and returns them.
       def read_credentials
         if d = %w{REDIRECT_X_HTTP_AUTHORIZATION X-HTTP_AUTHORIZATION HTTP_AUTHORIZATION}.inject([]) \
-          { |d,h| env.has_key?(h) ? env[h].to_s.split : d }
+          { |d,h| @env.has_key?(h) ? @env[h].to_s.split : d }
           u,p = ::Base64.decode64(d[1]).split(':')[0..1] if d[0] == 'Basic'
           return {:username => u, :password => p}
         end
@@ -68,9 +104,9 @@ module Picnic #:nodoc:
           s = super(*a)
         else
           @status = 401
-          @headers['Content-type'] = @headers['Content-type'] || 'text/plain'
-          @headers['Status'] = 'Unauthorized'
-          @headers['WWW-Authenticate'] = "Basic realm=\"#{app}\""
+          headers['Content-type'] = @headers['Content-type'] || 'text/plain'
+          #headers['Status'] = 'Unauthorized'
+          headers['WWW-Authenticate'] = "Basic realm=\"#{app}\""
           @body = 'Unauthorized'
           s = self
         end

data/lib/picnic/cli.rb

@@ -1,5 +1,9 @@
 require 'optparse'
 
+require 'picnic'
+require 'picnic/conf'
+require 'picnic/server'
+
 module Picnic
   # Provides a command-line interface for your app. 
   # This is useful for creating a 'bin' file for launching your application.
@@ -15,7 +19,7 @@ module Picnic
   #
   #   cli = Picnic::Cli.new(
   #     'foo',
-  #     :app_path => "/path/to/foo.br"
+  #     :app_file => "/path/to/foo.br"
   #   )
   #
   #   cli.handle_cli_input   
@@ -36,85 +40,124 @@ module Picnic
     #             +pid_file+:: Where the app's PID file (containing the app's
     #                          process ID) should be placed. By default this is
     #                          <tt>/etc/<app>/<app>.pid</tt>
-    #             +verbose+::  True if the cli handler should report
-    #                          everything that it's doing to STDOUT. 
     def initialize(app, options = {})
       @app = app
       
       @options = options || {}
-      @options[:app_file]   ||= File.expand_path(File.dirname(File.expand_path($0))+"/../lib/#{app}.rb")
+      @options[:app_file]   ||= File.expand_path(File.dirname(File.expand_path(__FILE__))+"/../lib/#{app}.rb")
+      @options[:app_name]   ||= app
       @options[:app_module] ||= app.capitalize
       @options[:pid_file]   ||= "/etc/#{app}/#{app}.pid"
       @options[:conf_file]  ||= nil
-      @options[:verbose]    ||= false
     end
     
     # Parses command line options given to the script.
     def handle_cli_input
-      if File.exists? options[:app_file]
+#      if File.exists? options[:app_file]
         # try to use given app base path
-        $APP_PATH = File.dirname(options[:app_file]).gsub(/\/(lib|bin)\/?$/, '')
-      else
-        require 'rubygems'
-        
-        # fall back to using gem installation
-        matches = Gem::source_index.find_name(app)
-        raise LoadError, "#{app} gem doesn't appear to be installed!" if matches.empty?
-        
-        gem_spec = matches.last
-        $APP_PATH = gem_spec.full_gem_path
-        
-        gem(app)
+        $APP_ROOT = File.dirname(options[:app_file]).gsub(/\/(lib|bin)\/?$/, '')
+#      else
+#        require 'rubygems'
+#        
+#        # fall back to using gem installation
+#        matches = Gem::source_index.find_name(app)
+#        raise LoadError, "#{app} gem doesn't appear to be installed!" if matches.empty?
+#        
+#        gem_spec = matches.last
+#        $APP_ROOT = gem_spec.full_gem_path
+#        
+#        gem(app)
+#      end
+      
+      unless File.file?(options[:app_file])
+        raise ArgumentError, "options[:app_file] points to #{options[:app_file].inspect} but this does not appear to be a valid Camping application!}"
       end
       
-      $: <<  $APP_PATH+"/lib"
       
-      $PID_FILE = "/etc/#{app}/#{app}.pid" 
+      puts "Loading #{app.inspect} code from #{$APP_ROOT.inspect}..."
       
-      OptionParser.new do |opts|
-        opts.banner = "Usage: #{app} [options]"
+      $: <<  $APP_ROOT+"/lib"
       
-        opts.on("-c", "--config FILE", "Use config file (default is /etc/#{app}/config.yml)") do |c|
-          puts "Using config file #{c}"
-          $CONFIG_FILE = c
-        end
-        
-        opts.on("-d", "--daemonize", "Run as a daemon (only when using webrick or mongrel)") do |c|
+      $PID_FILE     = @options[:pid_file]
+      $CONFIG_FILE  = @options[:conf_file]
+      $VERBOSE      = @options[:verbose]
+      
+      opts = OptionParser.new do |opts|
+        #opts.banner = ""
+        #opts.define_head ""
+        #opts.separator ""
+        opts.on("-d", "--daemonize", "Run daemonized in the background") do
           $DAEMONIZE = true
         end
-      
-        opts.on("-P", "--pid_file FILE", "Use pid file (default is /etc/#{app}/#{app}.pid)") do |c|
-          if $DAEMONIZE && !File.exists?(c)
-            puts "Using pid file '#{c}'"
-            $PID_FILE = c
-          elsif File.exists?(c)
+        opts.on("-c", "--config FILE", "Use this config file (default is /etc/<app>/config.yml)") do |c| 
+          puts "Using config file #{c.inspect}"
+          $CONFIG_FILE = c
+        end
+        opts.on("-P", "--pid_file FILE", "Path to pid file (used only when running daemonized; default is /etc/<app>/<app>.pid)") do |p| 
+          if $DAEMONIZE && !File.exists?(p)
+            puts "Using pid file #{p.inspect}"
+            $PID_FILE = p
+          elsif File.exists?(p)
             puts "The pid file already exists.  Is #{app} running?\n" +
-              "You will have to first manually remove the pid file at '#{c}' to start the server as a daemon."
+              "You will have to first manually remove the pid file at '#{p}' to start the server as a daemon."
             exit 1
           else
             puts "Not running as daemon.  Ignoring pid option"
           end
         end
- 
-        # :extra_cli_options should be a block with additonal app-specific opts.on() calls
+        
+        # optoinal block with additonal opts.on() calls specific to your application
         if @options[:extra_cli_options]
           @options[:extra_cli_options].call(opts)
-        end     
-
+        end   
+      
+        # No argument, shows at tail.  This will print an options summary.
+        # Try it and see!
         opts.on_tail("-h", "--help", "Show this message") do
           puts opts
           exit
         end
         
-        opts.on_tail("-V", "--version", "Show version number") do
-          require "#{$APP_PATH}/lib/#{app}/version.rb"
+        opts.on_tail("-v", "--version", "Show the application's version number") do
+          require "#{$APP_ROOT}/lib/#{app}/version.rb"
           app_mod = Object.const_get(@options[:app_module])
           puts "#{app}-#{app_mod::VERSION::STRING}"
           exit
         end
-      end.parse!
+      end
+      
+      begin
+        opts.parse! ARGV
+      rescue OptionParser::ParseError => ex
+        STDERR.puts "!! #{ex.message}"
+        puts "** use `#{File.basename($0)} --help` for more details..."
+        exit 1
+      end
+      
+      
+      $CONF = Picnic::Conf.new
+      $CONF.load_from_file(app, $APP_ROOT, $CONF_FILE)
+      
+      if $DAEMONIZE
+        # TODO: use Process.daemon when RUBY_VERSION >= 1.9
+        
+        exit if fork
+        Process.setsid
+        exit if fork
+        
+        Dir.chdir $APP_ROOT
+        File.umask 0000
+        
+        STDIN.reopen  $CONF.log[:file], "a"
+        STDOUT.reopen $CONF.log[:file], "a"
+        STDERR.reopen $CONF.log[:file], "a"
+        
+        File.open($PID_FILE, 'w'){ |f| f.write("#{Process.pid}") }
+        at_exit { File.delete($PID_FILE) if File.exist?($PID_FILE) }
+      end
       
-      require "#{$APP_PATH}/lib/#{app}.rb"
+      server = Picnic::Server::Base.new($CONF, [options[:app_file]])
+      server.start
     end
   end
 end