picnic 0.7.1 → 0.8.0

data/lib/picnic/conf.rb

@@ -1,3 +1,5 @@
+require 'active_support'
+
 module Picnic
   # Provides an interface for accessing your Picnic app's configuration file.
   #
@@ -11,18 +13,21 @@ module Picnic
   #   puts Conf[:authentication][:username]
   #   # ... etc.
   class Conf
-    $CONF ||= HashWithIndifferentAccess.new
-    $CONF[:log] ||= HashWithIndifferentAccess.new
-    $CONF[:log][:file]  ||= STDOUT
-    $CONF[:log][:level] ||= 'DEBUG'
-    $CONF[:uri_path]    ||= "/"
+    def initialize(from_hash = {})
+      @conf = HashWithIndifferentAccess.new(from_hash)
+      
+      @conf[:log] ||= HashWithIndifferentAccess.new
+      @conf[:log].merge!(:file => STDOUT, :level => 'DEBUG')
+      
+      @conf[:uri_path] ||= "/"
+    end
     
     # Read a configuration option.
     #
     # For example:
     #   puts Conf[:server]
-    def self.[](key)
-      $CONF[key]
+    def [](key)
+      @conf[key]
     end
     
     # Another way of reading a configuration option.
@@ -30,10 +35,15 @@ module Picnic
     # The following statements are equivalent:
     #   puts Conf[:server]
     #   puts Conf.server
-    def self.method_missing(method, *args)
+    def method_missing(method, *args)
       self[method]
     end
     
+    # Needs to be defined when we have a custom method_missing().
+    def respond_to?(method)
+      (@conf.stringify_keys.keys).include?(method.to_s) || super
+    end
+    
     # Returns the path to your application's example config file.
     #
     # The example config file should be in the root directory of
@@ -41,32 +51,27 @@ module Picnic
     # <tt>config.example.yml</tt>. This file is used as a template
     # for your app's configuration, to be customized by the end
     # user. 
-    def self.example_config_file_path
-      if $APP_PATH
-        app_path = File.expand_path($APP_PATH)
-      else
-        caller.last =~ /^(.*?):\d+$/
-        app_path = File.dirname(File.expand_path($1))
-      end
-      app_path+'/config.example.yml'
+    def example_config_file_path(app_root)
+      "#{app_root}/config.example.yml"
     end
     
     # Copies the example config file into the appropriate
     # configuration directory.
     #
-    # +app+:: The name of your application. For example: <tt>foo</tt>
+    # +app_name+:: The name of your application. For example: <tt>foo</tt>
+    # +app_root+:: The path to your application's root directory. For example: <tt>/srv/www/camping/foo/</tt>
     # +dest_conf_file:: The path where the example conf file should be copied to.
     #                   For example: <tt>/etc/foo/config.yml</tt>
-    def self.copy_example_config_file(app, dest_conf_file)
+    def copy_example_config_file(app_name, app_root, dest_conf_file)
       require 'fileutils'
           
-      example_conf_file = example_config_file_path
+      example_conf_file = example_config_file_path(app_root)
       
-      puts "\n#{app.to_s.upcase} SERVER HAS NOT YET BEEN CONFIGURED!!!\n"
+      puts "\n#{app_name.to_s.upcase} SERVER HAS NOT YET BEEN CONFIGURED!!!\n"
       puts "\nAttempting to copy sample configuration from '#{example_conf_file}' to '#{dest_conf_file}'...\n"
       
       unless File.exists? example_conf_file 
-        puts "\nThe example conf file does not exist! The author of #{app} may have forgotten to include it. You'll have to create the config file manually.\n"
+        puts "\nThe example conf file does not exist! The author of #{app_name} may have forgotten to include it. You'll have to create the config file manually.\n"
         exit 2
       end
       
@@ -84,50 +89,47 @@ module Picnic
       end
       
       puts "\nA sample configuration has been created for you in '#{dest_conf_file}'. Please edit this file to" +
-        " suit your needs and then run #{app} again.\n"
+        " suit your needs and then run #{app_name} again.\n"
       exit 1
     end
     
-    # Loads the configuration from the yaml file for the given app.
+    # Loads the configuration from the YAML file for the given app.
     #
-    # <tt>app</tt> should be the name of your app; for example: <tt>foo</tt>.
+    # <tt>app_name</tt> should be the name of your app; for example: <tt>foo</tt>
+    # <tt>app_root</tt> should be the path to your application's root directory; for example:: <tt>/srv/www/camping/foo/</tt>
+    # [<tt>config_file</tt>] can be the path to an alternate location for the config file to load
     #
-    # By default, the configuration will be loaded from <tt>/etc/<app>/config.yml</tt>.
-    # You can override this by setting a global <tt>$CONFIG_FILE</tt> variable.
-    def self.load(app)
+    # By default, the configuration will be loaded from <tt>/etc/<app_name>/config.yml</tt>.
+    def load_from_file(app_name, app_root, config_file = nil)
+      conf_file = config_file || "/etc/#{app_name.to_s.downcase}/config.yml"
       
-      conf_file = $CONFIG_FILE || "/etc/#{app.to_s.downcase}/config.yml"
-      
-      puts "Loading configuration for #{app} from '#{conf_file}'..."
+      puts "Loading configuration for #{app_name.inspect} from #{conf_file.inspect}..."
       
       begin
         conf_file = etc_conf = conf_file
         unless File.exists? conf_file 
           # can use local config.yml file in case we're running non-gem installation
-          conf_file = File.dirname(File.expand_path(__FILE__))+"/../../config.yml"
+          conf_file = "#{app_root}/config.yml"
         end
       
         unless File.exists? conf_file  
-          copy_example_config_file(app, etc_conf)
+          copy_example_config_file(app_name, app_root, etc_conf)
         end
         
         loaded_conf = HashWithIndifferentAccess.new(YAML.load_file(conf_file))
         
-        if $CONF
-          $CONF = HashWithIndifferentAccess.new($CONF)
-          $CONF = $CONF.merge(loaded_conf)
-        else
-          $CONF = loaded_conf
-        end
-        
-        $CONF[:log][:file] = STDOUT unless $CONF[:log][:file]
+        @conf.merge!(loaded_conf)
         
-      rescue
-          raise "Your #{app} configuration may be invalid."+
+      rescue => e
+          raise "Your #{app_name} configuration may be invalid."+
             " Please double-check check your config.yml file."+
             " Make sure that you are using spaces instead of tabs for your indentation!!" +
-            "\n\nTHE UNDERLYING ERROR WAS:\n#{$!}"
+            "\n\nTHE UNDERLYING ERROR WAS:\n#{e.inspect}"
       end
     end
+    
+    def merge_defaults(defaults)
+      @conf = HashWithIndifferentAccess.new(HashWithIndifferentAccess.new(defaults).merge(@conf))
+    end
   end
 end

data/lib/picnic/logger.rb

@@ -0,0 +1,41 @@
+require 'logger'
+
+module Picnic
+  module Logger
+    
+    # Makes available a Logger instance under the global $LOG variable.
+    def init_global_logger!
+      logdev = ($CONF && $CONF.log[:file]) || STDOUT
+      $LOG = Picnic::Logger::Base.new(logdev)
+      $LOG.level = Picnic::Logger::Base.const_get(($CONF && $CONF.log[:level]) || 'DEBUG')
+      
+      puts "Initialized global logger to #{logdev.inspect}."
+    end
+    module_function :init_global_logger!
+    
+    class Base < ::Logger
+      def initialize(logdev, shift_age = 0, shift_size = 1048576)
+        begin
+          super
+        rescue Exception
+          puts "WARNING: Couldn't create Logger with output '#{logdev}'. Logger output will be redirected to STDOUT."
+          super(STDOUT, shift_age, shift_size)
+        end
+      end
+    
+      def format_message(severity, datetime, progrname, msg)
+        (@formatter || @default_formatter).call(severity, datetime, progname, msg)
+      end
+    end
+  
+    # Custom log formatter used by the Picnic Logger.
+    class Formatter < ::Logger::Formatter
+      Format = "[%s#%d] %5s -- %s: %s\n"
+      
+      def call(severity, time, progname, msg)
+        Format % [format_datetime(time), $$, severity, progname,
+          msg2str(msg)]
+      end
+    end
+  end
+end

data/lib/picnic/server.rb

@@ -0,0 +1,99 @@
+require 'camping/server'
+
+module Picnic::Server
+  class Base < Camping::Server::Base
+    def start
+      handler, conf = case @conf.server
+      when "console"
+        ARGV.clear
+        IRB.start
+        exit
+      when "mongrel"
+        prep_mongrel
+      when "webrick"
+        prep_webrick
+      end
+      
+      rapp =  apps.first
+
+      if @conf.uri_path
+        rapp = Rack::URLMap.new(@conf.uri_path => rapp)
+      end
+      
+      rapp = Rack::Static.new(rapp, @conf[:static]) if @conf[:static]
+      rapp = Rack::ContentLength.new(rapp)
+      rapp = FixContentLength.new(rapp)
+      rapp = Rack::Lint.new(rapp)
+      rapp = Camping::Server::XSendfile.new(rapp)
+      rapp = Rack::ShowExceptions.new(rapp)
+      
+      handler.run(rapp, conf) 
+    end
+    
+    
+    private
+    
+    def prep_webrick
+      handler = Rack::Handler::WEBrick
+      options = {
+        :BindAddress => @conf.bind_address || "0.0.0.0",
+        :Port => @conf.port
+      }
+      
+      cert_path = @conf.ssl_cert
+      key_path = @conf.ssl_key || @conf.ssl_cert
+        # look for the key in the ssl_cert if no ssl_key is specified
+        
+      unless cert_path.nil? && key_path.nil?
+        raise "The specified certificate file #{cert_path.inspect} does not exist or is not readable. " +
+          " Your 'ssl_cert' configuration setting must be a path to a valid " +
+          " ssl certificate." unless
+            File.exists? cert_path
+        
+        raise "The specified key file #{key_path.inspect} does not exist or is not readable. " +
+          " Your 'ssl_key' configuration setting must be a path to a valid " +
+          " ssl private key." unless
+            File.exists? key_path
+            
+        require 'openssl'
+        require 'webrick/https'
+        
+        cert = OpenSSL::X509::Certificate.new(File.read(cert_path))
+        key = OpenSSL::PKey::RSA.new(File.read(key_path))
+        
+        options[:SSLEnable] = true
+        options[:SSLVerifyClient] = ::OpenSSL::SSL::VERIFY_NONE
+        options[:SSLCertificate] = cert
+        options[:SSLPrivateKey] = key
+      end
+      
+      return handler, options
+    end
+    
+    
+    def prep_mongrel
+      handler = Rack::Handler::Mongrel
+      options = {
+        :Host => @conf.bind_address || "0.0.0.0", 
+        :Port => @conf.port
+      }
+      
+      return handler, options
+    end
+    
+  end
+  
+  class FixContentLength
+    def initialize(app)
+      @app = app
+    end
+  
+    def call(env)
+      status, headers, body = @app.call(env)
+      if headers.has_key?('Content-Length') && headers['Content-Length'].to_i == 0
+        headers['Content-Length'] = body.body.length.to_s
+      end
+      [status, headers, body]
+    end
+  end
+end

data/lib/picnic/version.rb

@@ -1,8 +1,8 @@
 module Picnic #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 7
-    TINY  = 1
+    MINOR = 8
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/picnic.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{picnic}
+  s.version = '0.8.0.' + Time.now.strftime('%Y%m%d')
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Zukowski"]
+  s.date = Time.now.strftime('%Y-%m-%d')
+  s.description = %q{Camping for sissies}
+  s.email = %q{matt@roughest.net}
+  s.extra_rdoc_files = ["CHANGELOG.txt", "History.txt", "LICENSE.txt", "Manifest.txt", "README.txt"]
+  s.files = ["CHANGELOG.txt", "History.txt", "LICENSE.txt", "Manifest.txt", "README.txt", "Rakefile", "lib/picnic.rb", "lib/picnic/authentication.rb", "lib/picnic/cli.rb", "lib/picnic/conf.rb", "lib/picnic/controllers.rb", "lib/picnic/logger.rb", "lib/picnic/server.rb", "lib/picnic/service_control.rb", "lib/picnic/version.rb", "setup.rb", "test/picnic_test.rb", "test/test_helper.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"]
+  s.has_rdoc = true
+  s.homepage = %q{http://picnic.rubyforge.org}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{picnic}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Camping for sissies}
+  s.test_files = ["test/picnic_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_runtime_dependency(%q<markaby>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
+    else
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<markaby>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.2"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<markaby>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.2"])
+  end
+end

data/vendor/{camping-1.5.180 → camping-2.0.20090212}/CHANGELOG

@@ -1,14 +1,21 @@
-= Patches
-=== 31st Mar, 2008
-
-* Can now set expiry time for cookies.
-    
-    @cookies[:foo] = {:value => "bar", :expires => Time.now + 1.hour}
-    
-  The simple method of setting cookies without expiry still works.
+= 1.6
+=== ???, 2007
+
+* Camping::Apps removed, it wasn't reliable.
+* bin/camping server kinds splitted in various files.
+* NotFound and ServerError controllers changed to methods :
+
+  r404 : called when a controller was not found
+  r500 : called on uncaught exception
+  r501 : called on undefined method
   
-    @cookies[:foo] = "bar"
-    
+  All of those can be overridden at your taste.
+
+* Markaby no longer required. Like AR, is it autoloaded on (Mab) usage.
+* Camping::H is now inheriting from Hash instead of HashWithIndifferentAccess.
+* Which made possible to remove the last strict dependency : active_support
+* #errors_for removed, it wasn't really used
+* Bug fixes !
 
 = 1.5
 === 3rd Oct, 2006

data/vendor/{camping-1.5.180 → camping-2.0.20090212}/README

@@ -78,7 +78,7 @@ Interested yet?  Okay, okay, one step at a time.
 
 Or for the bleeding edge:
 
-* <tt>gem install camping --source code.whytheluckystiff.net</tt>
+* <tt>gem install camping --source http://code.whytheluckystiff.net</tt>
 
 You are encourage to install Camping and SQLite3, since it is a small database
 which fits perfectly with our compact bylaws, works well with the examples.
@@ -93,7 +93,7 @@ If you run them from the commandline, you'll probably just see a pile of HTML.
 Camping comes with an tool for launching apps from the commandline:
 
 * Run: <tt>camping blog.rb</tt>
-* Visit http://localhost:3301/blog/ to use the app.
+* Visit http://localhost:3301/ to use the app.
 
 == How the Camping Tool Works
 

data/vendor/{camping-1.5.180 → camping-2.0.20090212}/Rakefile

@@ -7,9 +7,9 @@ require 'fileutils'
 include FileUtils
 
 NAME = "camping"
-REV = File.read(".svn/entries")[/committed-rev="(\d+)"/, 1] rescue nil
-VERS = ENV['VERSION'] || ("1.5" + (REV ? ".#{REV}" : ""))
-CLEAN.include ['**/.*.sw?', '*.gem', '.config', 'test/test.log']
+REV = (`#{ENV['GIT'] || "git"} rev-list HEAD`.split.length + 1).to_s rescue nil
+VERS = ENV['VERSION'] || ("1.9" + (REV ? ".#{REV}" : ""))
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', 'test/test.log', '.*.pt']
 RDOC_OPTS = ['--quiet', '--title', "Camping, the Documentation",
     "--opname", "index.html",
     "--line-numbers", 
@@ -17,7 +17,7 @@ RDOC_OPTS = ['--quiet', '--title', "Camping, the Documentation",
     "--inline-source"]
 
 desc "Packages up Camping."
-task :default => [:package]
+task :default => [:check]
 task :package => [:clean]
 
 task :doc => [:before_doc, :rdoc, :after_doc]
@@ -59,8 +59,8 @@ spec =
         s.homepage = 'http://code.whytheluckystiff.net/camping/'
         s.executables = ['camping']
 
-        s.add_dependency('activesupport', '>=1.3.1')
         s.add_dependency('markaby', '>=0.5')
+        s.add_dependency('rack', '>=0.3')
         s.add_dependency('metaid')
         s.required_ruby_version = '>= 1.8.2'
 
@@ -115,3 +115,60 @@ Rake::TestTask.new(:test) do |t|
 #  t.warning = true
 #  t.verbose = true
 end
+
+desc "Compare camping and camping-unabridged parse trees"
+task :diff do
+  if `which parse_tree_show`.strip.empty?
+    STDERR.puts "ERROR: parse_tree_show missing : `gem install ParseTree`"
+    exit 1
+  end
+
+  sh "parse_tree_show lib/camping.rb > .camping.pt"
+  sh "parse_tree_show lib/camping-unabridged.rb > .camping-unabridged.pt"
+  sh "diff -u .camping-unabridged.pt .camping.pt | less"
+end
+
+task :ruby_diff do
+  require 'ruby2ruby'
+  c = Ruby2Ruby.translate(File.read("lib/camping.rb"))
+  n = Ruby2Ruby.translate(File.read("lib/camping-unabridged.rb"))
+  
+  File.open(".camping-unabridged.rb.rb","w"){|f|f<<c}
+  File.open(".camping.rb.rb","w"){|f|f<<n}
+  
+  sh "diff -u .camping-unabridged.rb.rb .camping.rb.rb | less"
+end
+
+task :check => ["check:valid", "check:size", "check:lines"]
+namespace :check do
+
+  desc "Check source code validity"
+  task :valid do
+    ruby "-rubygems", "-w", "lib/camping-unabridged.rb"
+    ruby "-rubygems", "-w", "lib/camping.rb"
+  end
+
+  SIZE_LIMIT = 4096
+  desc "Compare camping sizes to unabridged"
+  task :size do
+    FileList["lib/camping*.rb"].each do |path|
+      s = File.size(path)
+      puts "%21s : % 6d % 4d%" % [File.basename(path), s, (100 * s / SIZE_LIMIT)]
+    end
+    if File.size("lib/camping.rb") > SIZE_LIMIT
+      STDERR.puts "lib/camping.rb: file is too big (> #{SIZE_LIMIT})"
+    end
+  end
+
+  desc "Verify that line lenght doesn't exceed 80 chars for camping.rb"
+  task :lines do
+    i = 1
+    File.open("lib/camping.rb").each_line do |line|
+      if line.size > 81 # 1 added for \n
+        STDERR.puts "lib/camping.rb:#{i}: line too long (#{line[-10..-1].inspect})"
+      end
+      i += 1
+    end
+  end
+
+end