merb 0.0.7 → 0.0.8

data/README

@@ -7,8 +7,20 @@ for simple dynamic pages.
 
 **Sample APP included**
 
+** Dependencies **
+mongrel
+erubis
+json or fjson
+mime-types
+
+Install these gems first then you can build the merb gem from svn trunk like so:
+$ sudo gem install mongrel erubis json mime-types --include-dependencies
+$ svn co http://svn.devjavu.com/merb
+$ cd merb
+$ sudo rake install
+
 **Important**
-The new default filename extensions for templates are as follows:
+The new default filename extensions for templates are as follows
 html ->  .herb
 js   ->  .jerb
 xml  ->  .xerb
@@ -16,38 +28,54 @@ xml  ->  .xerb
 You can change the extensions to anything you want in your config file in
 yourapp/dist/conf/merb.yml. See the default settings in the sample app.
 
-Unpack the gem and grab the sample app
+First you need to install the dependencies. Merb requires the follwing gems
+
+erubis
+
+json
+
+fjson # will be used if present. requires C extension.
+
+# fastthread will be used if present and is reccommended.
+sudo gem install fastthread --source=http://mongrel.rubyforge.org/ 
+
+If you have checked out merb trunk from svn you will want to build and install
+the gem to use merb. Run this command from the root of the merb svn checkout
+to do that:
 
+$ sudo rake install
+
+
+If you installed merb from gems then unpack the gem and grab the sample app
 $ gem unpack merb
 
-cd merb*
-cd examples/sample_app
+now with either the svn or the unpacked gem you can try out the sample app.
 
-$ merb
+$ cd merb*
+$ cd examples/sample_app
 
-then the sample app will be running on port 4000 in the foreground. 
-you can go to a few urls:
+$ merb
 
 You will need the mongrel_upload_progress gem installed to go to /files
+so use the -f flag to load a config file for mongrel_upload_progress
+$ merb -f dist/conf/mup.conf
 
+then the sample app will be running on port 4000 in the foreground. 
+you can go to a few urls:
 http://localhost:4000/files/start
 
 http://localhost:4000/foo/123/baz/12234345
 
-If you have checked out merb trunk from svn you will want to build and install
-the gem to use merb. Run this command from the root of the merb svn checkout
-to do that:
-
-$ sudo rake install
+**FEATURES** 
 
-*note* you may have to run this comand twice if it fails the first time.
-
-**FEATURES** 1. Mongrel handler built in that parses incoming requests
+*Mongrel handler* 
+built in that parses incoming requests
 including multipart uploads and post as well as ?query=strings. Puts the
 params into params and the cookies into cookies when it instantiates your
 controller class.
 
-2. RouteMatcher and route compiler. Reads your route definition and compiles
+*RouteMatcher and route compiler* 
+Reads your route definition and compiles
 a method on the fly that will match the request path against each route and do the 
 right thing. So the following routes:
 
@@ -78,7 +106,8 @@ lambda{|path|
   end
 }
 
-3. Simple controller classes with built in render method and template handling
+*Simple Controllers*
+classes with built in render method and template handling
 with instance vars available in the views automatically. Merb also supports 
 layouts. It will look for a layout named after your controller class first and
 then fall back to application.herb if no layout exists named after your controller.
@@ -124,7 +153,7 @@ def ajax_action
 end
 
 # ajax_action.jerb
-$('comments').update('<%= escape_js(partial(:posts)) %>');
+$('comments').update('<%=js partial(:posts) %>');
 
 # _posts.herb
 <ul>
@@ -137,11 +166,12 @@ $('comments').update('<%= escape_js(partial(:posts)) %>');
 </ul>	
 
 
-Controllers also now have before filters. Use the before method in
-your controllers. before accepts either a symbol or a Proc/lambda object.
-If you give it a symbol it will call a method with the same name as the 
-symbol. If you give it a proc that takes one argument it will call the 
-proc with the current controller as that argument.
+*Controllers also now have before filters*
+
+Use the before method in your controllers. before accepts either a symbol 
+or a Proc/lambda object. If you give it a symbol it will call a method with
+the same name as the symbol. If you give it a proc that takes one argument 
+it will call the proc with the current controller as that argument.
 
 class Foo < Merb::Controller
  
@@ -162,8 +192,9 @@ Sessions are available when you start merb with the -s flag. See sample app for
 migration too add session table.
 
 
-4. the server. right now you add your routes in
-the appdir/conf/router.rb file. So by default it runs on port 4000
+*The merb server*
+right now you add your routes in
+the appdir/dist/conf/router.rb file. So by default it runs on port 4000
 
 $ cd /path/to/your/merb/app
 $ merb  
@@ -182,13 +213,15 @@ use the -i flag
 
 $merb -i
 
-5. File uploads. This is the thing that Merb was written for. Rails doesn't allow 
+*File uploads* 
+This is one of the things that Merb was written for. Rails doesn't allow 
 multiple concurrent file uploads at once without blocking an entire rails backend 
 for each file upload. Merb allows multiple file uploads at once. Start the server 
-and browse to http://localhost:4000/upload/start  and you will get a file upload 
-form. There is a very simple upload controller example that handles this upload.
-When a file is uploaded with Merb, it gets put in a Tempfile. So you just want to 
-copy it to the right place on the filesystem.
+and browse to http://localhost:4000/files/start  and you will get a file upload 
+form. This uses the mongrel_upload_progress gem so that must be installed first.
+There is a very simple upload controller example that handles this upload with a 
+progress bar. When a file is uploaded with Merb, it gets put in a Tempfile. So 
+you just want to copy it to the right place on the filesystem.
 
 def upload
   puts params[:file].inspect
@@ -199,7 +232,9 @@ def upload
 end
 
 
-6. Merb app layout. A Merb app contains everything it needs to run in production in the 
+*Merb app layout* 
+
+A Merb app contains everything it needs to run in production in the 
 MERB_ROOT/dist directory. So for deployment you only need to deploy the dist dir. This
 keeps your test code and development plugins separate from your main app and lets you
 not deploy them to the live server. You deal with two things with this setup, MERB_ROOT

data/Rakefile

@@ -10,7 +10,7 @@ require File.dirname(__FILE__)+'/tools/rakehelp'
 include FileUtils
 
 NAME = "merb"
-VERS = "0.0.7"
+VERS = "0.0.8"
 CLEAN.include ['**/.*.sw?', '*.gem', '.config']
 RDOC_OPTS = ['--quiet', '--title', "Merb Documentation",
   "--opname", "index.html",
@@ -59,6 +59,7 @@ spec = Gem::Specification.new do |s|
   s.add_dependency('mongrel')
   s.add_dependency('erubis')
   s.add_dependency('json')
+  s.add_dependency('mime-types')
   s.required_ruby_version = '>= 1.8.4'
 
   s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{app,bin,test,lib,examples}/**/*") 
@@ -85,6 +86,7 @@ end
 desc "rdoc to rubyforge"
 task :doc_rforge do
   sh %{rake doc}
+  sh %{sudo chmod -R 755 doc/rdoc}
   sh %{scp -r -p doc/rdoc/* ezmobius@rubyforge.org:/var/www/gforge-projects/merb}
 end
 

data/bin/merb

@@ -1,14 +1,35 @@
 #!/usr/local/bin/ruby
 require 'rubygems'
+
+begin
+  require 'fastthread'
+  require 'thread'
+  puts 'Using FastThread'
+rescue LoadError
+  puts "not using FastThread"
+end
+
+begin
+  require 'fjson'
+  puts "using fjson"
+rescue LoadError
+  require 'json'
+end
 require 'optparse'
 require 'ostruct'
 require 'fileutils'
 require 'yaml'
 require 'erubis'
 
-module Merb
+module Erubis
+  class MEruby < Erubis::Eruby
+    include PercentLineEnhancer
+    include StringBufferEnhancer
+  end
 end
 
+module Merb; end
+
 class Merb::Config
   def self.setup
     defaults = {
@@ -19,7 +40,7 @@ class Merb::Config
       :template_ext => {:html => :herb, :js => :jerb, :xml => :xerb}
     }
     begin
-      options = defaults.merge(YAML.load(Erubis::Eruby.new(IO.read("#{defaults[:merb_root]}/dist/conf/merb.yml")).result))
+      options = defaults.merge(YAML.load(Erubis::MEruby.new(IO.read("#{defaults[:merb_root]}/dist/conf/merb.yml")).result))
     rescue
       options = defaults
     end
@@ -34,42 +55,53 @@ class Merb::Server
     options = Merb::Config.setup
 
     opts = OptionParser.new do |opts|
-      opts.on("-f", "--config-file [String]") do |config|
+      opts.banner = "Usage: merb [fdcphmisl] [argument]"
+      opts.define_head "Merb Mongrel+ Erb. Lightweight replacement for ActionPack"
+      opts.separator '*'*80
+      opts.separator 'If no flags are given, Merb starts in the foreground on port 4000'
+      opts.separator '*'*80
+      
+      opts.on("-f", "--config-file FILENAME", "This flag is for adding extra config files for things like the upload progress module") do |config|
         options[:config] = config
       end
       
-      opts.on("-d", "--daemonize [String]") do |config|
+      opts.on("-d", "--daemonize", "This will run a single merb in the background") do |config|
         options[:daemonize] = true
       end
       
-      opts.on("-c", "--cluster-nodes [String]") do |nodes|
+      opts.on("-c", "--cluster-nodes NUM_MERBS", "Number of merb daemons to run") do |nodes|
         options[:cluster] = nodes
       end
 
-      opts.on("-p", "--port [Integer]") do |port|
+      opts.on("-p", "--port PORTNUM", "Port to run merb on, defaults to 4000") do |port|
         options[:port] = port
       end
 
-      opts.on("-h", "--host [String]") do |host|
+      opts.on("-h", "--host HOSTNAME", "Host to bind to(default is all IP's)") do |host|
         options[:host] = host
       end
 
-      opts.on("-m", "--merb-root [String]") do |merb_root|
+      opts.on("-m", "--merb-root MERB_ROOT", "the path to the MERB_ROOT for the app you want to run") do |merb_root|
         options[:merb_root] = File.expand_path(merb_root)
       end
       
-      opts.on("-i", "--irb-console [String]") do |console|
+      opts.on("-i", "--irb-console", "This flag will start merb in irb console mode. All your models and other classes will be available for you in an irb session.") do |console|
         options[:console] = true
       end
       
-      opts.on("-s", "--session-drb-port [Integer]") do |drb_port|
+      opts.on("-s", "--session-drb-port PORTNUM", "This is the port number to run the drb daemon on for sessions and uplod progress monitoring.") do |drb_port|
         options[:session] = drb_port
       end
       
-      opts.on("-l", "--log-level [String]") do |loglevel|
+      opts.on("-l", "--log-level LEVEL", "Log levels can be set to any of these options: DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN") do |loglevel|
         options[:log_level] = loglevel
       end
       
+      opts.on("-?", "--help", "Show this help message") do
+        puts opts  
+        exit
+      end
+      
     end
 
     opts.parse!(@@merb_raw_opts)
@@ -161,18 +193,20 @@ class Merb::Server
   end  
   
   def self.drbserver_start(port)
+    puts "Starting merb drb server on port: #{port}"
     require 'merb/session/merb_drb_server'
     DRb.start_service("druby://#{@@merb_opts[:host]}:#{port}", Merb::DRbSession.setup)
     DRb.thread.join
   end  
 
   def self.mongrel_start(port)
+    @@merb_opts[:port] = port
     initialize_merb
 
     config = Mongrel::Configurator.new :host => (@@merb_opts[:host]||"0.0.0.0"), :port => (port ||4000) do
-      load_plugins( :includes => ["mongrel"], :excludes => ["rails"] ) if @@merb_opts[:config]
+      config = YAML.load(Erubis::Eruby.new(IO.read(File.expand_path(@@merb_opts[:config]))).result) if @@merb_opts[:config]
       listener do
-        run_config(@@merb_opts[:config]) if @@merb_opts[:config]
+        uri( "/", :handler => MerbUploadHandler.new(config), :in_front => true) if @@merb_opts[:config]
         uri "/", :handler => MerbHandler.new(@@merb_opts[:dist_root]+'/public')
         uri "/favicon.ico", :handler => Mongrel::Error404Handler.new("")
       end

data/examples/app_skeleton/Rakefile

@@ -6,6 +6,7 @@ require 'fileutils'
 require 'rubygems'
 require 'merb'
 require MERB_FRAMEWORK_ROOT+'/merb_tasks'
+MERB_ROOT = File.dirname(__FILE__)
 include FileUtils
 
 
@@ -18,9 +19,9 @@ task :merb_init do
   require File.dirname(__FILE__)+'/dist/conf/merb_init.rb'
 end  
 
-desc "Run schema morphing"
-task :schema => [:merb_init] do
-  require File.dirname(__FILE__)+'/dist/schema/schema1.rb'
+desc "Load db schema"
+task :load_schema => [:merb_init] do
+  require File.dirname(__FILE__)+'/dist/schema/schema.rb'
 end
 
 task :uninstall => [:clean] do

data/examples/app_skeleton/dist/app/helpers/global_helper.rb

@@ -0,0 +1,6 @@
+module Merb
+  module GlobalHelper
+  end
+end    
+    
+    

data/examples/app_skeleton/dist/conf/merb.yml

@@ -0,0 +1,11 @@
+--- 
+:host: 0.0.0.0
+:port: "4000"
+:allow_reloading: true
+#:sql_session: true
+#:basic_auth: 
+#  :username: ezra
+#  :password: test
+#  :domain: localhost
+#:daemonize: true
+#:cluster: 3

data/examples/app_skeleton/dist/conf/mup.conf

@@ -0,0 +1,5 @@
+# upload progress conf
+--- 
+:drb: true
+:path_info: /files/upload
+:frequency: 2

data/examples/app_skeleton/dist/conf/router.rb

@@ -11,10 +11,8 @@
 
 puts "Compiling routes: \n"
 Merb::RouteMatcher.prepare do |r|
-  r.add '/foo/:bar/baz/:id', :controller => 'Test', :action => 'foo'
   r.add '/:controller/:action/:id'
-  r.add '/bar/:*rest', :controller => 'Test', :action => 'glob'
-  r.add '', :controller => 'posts', :action =>'index'
+  #r.add '', :controller => 'SomeController', :action =>'foo'
 end
 
 m = Merb::RouteMatcher.new

data/examples/app_skeleton/scripts/merb_stop

@@ -1,5 +1,13 @@
 #!/usr/bin/env ruby
+require 'fileutils'
 
-pid = File.open(File.dirname(__FILE__)+"/../log/merb.pid"){|f| f.read.chomp.to_i }
+pids=[]
 
-Process.kill(9, pid)
+port_or_star = ARGV[0] || '*'
+
+Dir[File.dirname(__FILE__)+"/../log/merb.#{port_or_star}.pid"].each do |f|
+  pid = IO.read(f).chomp.to_i
+  puts "killing PID: #{pid}"
+  Process.kill(9, pid)
+  FileUtils.rm f
+end

data/examples/sample_app/Rakefile

@@ -19,9 +19,9 @@ task :merb_init do
   require File.dirname(__FILE__)+'/dist/conf/merb_init.rb'
 end  
 
-desc "Run schema morphing"
-task :schema => [:merb_init] do
-  require File.dirname(__FILE__)+'/dist/schema/schema1.rb'
+desc "Load db schema"
+task :load_schema => [:merb_init] do
+  require File.dirname(__FILE__)+'/dist/schema/schema.rb'
 end
 
 task :uninstall => [:clean] do

data/examples/sample_app/dist/app/controllers/files.rb

@@ -1,12 +1,12 @@
 class Files < Merb::Controller
   
   def start
-    render_no_layout
+    render :layout => :none
   end
   
   def index
     @args = params
-    render 'start'
+    render :action => 'start'
   end  
   
   def upload
@@ -25,7 +25,7 @@ class Files < Merb::Controller
   end
   
   def file
-    send_file DIST_ROOT+'/public/files/'+params[:file]
+    send_file params[:file]
   end
 
 end

data/examples/sample_app/dist/app/controllers/posts.rb

@@ -1,9 +1,13 @@
 
 class Posts < Merb::Controller
   
+  def access_denied
+    render
+  end  
+    
   def new
-    session[:foo] = 'bar'
-    puts session.sess_id
+    #session[:foo] = 'foo'
+    #puts session.session_id
     render
   end  
   
@@ -13,29 +17,29 @@ class Posts < Merb::Controller
   end
     
   def show
-    puts session[:foo]
-    session[:foo] = 'changed'
+    #puts session[:foo]
+    #session[:foo] = 'changed'
     @post = Post.find params[:id]
     @comments = @post.comments
     render
   end
   
   def test
-    puts "protocol: #{protocol}"
-    puts "ssl?: #{ssl?}"
-    puts "uri: #{uri}"
-    puts "path: #{path}"
-    puts "path_info: #{path_info}"
-    puts "port: #{port}"
-    puts "host: #{host}"
-    puts "domain: #{domain}"
-    puts "get?: #{get?}"
-    puts "post?: #{post?}"
-    puts "put?: #{put?}"
-    puts "delete?: #{delete?}"
-    puts "head?: #{head?}"
-    puts "xhr?: #{xhr?}"
-    puts @env.inspect
+    puts "request.protocol: #{request.protocol}"
+    puts "request.ssl?: #{request.ssl?}"
+    puts "request.uri: #{request.uri}"
+    puts "request.path: #{request.path}"
+    puts "request.path_info: #{request.path_info}"
+    puts "request.port: #{request.port}"
+    puts "request.host: #{request.host}"
+    puts "request.domain: #{request.domain}"
+    puts "request.get?: #{request.get?}"
+    puts "request.post?: #{request.post?}"
+    puts "request.put?: #{request.put?}"
+    puts "request.delete?: #{request.delete?}"
+    puts "request.head?: #{request.head?}"
+    puts "request.xhr?: #{request.xhr?}"
+    puts request.inspect
   end
   
   def xml_test
@@ -43,6 +47,7 @@ class Posts < Merb::Controller
   end  
   
   def list
+    #session[:foo] = 'hi'
     @posts = Post.find :all, :limit => 4
     render
   end  
@@ -62,8 +67,5 @@ class Posts < Merb::Controller
     @comments = @post.comments.reload
     render_js 'comment'
   end  
-  
-  def index
-    list
-  end  
+
 end