Changeset 1038

Timestamp:

11/23/07 13:08:05 (1 year ago)

Author:

e.@brainspl.at

Message:

update readme docs. closes #328

Files:

• trunk/README (modified) (5 diffs)
• trunk/Rakefile (modified) (1 diff)
• trunk/lib/merb/mongrel_handler.rb (modified) (1 diff)

trunk/README

@@ -1 +1 @@
-= Merb
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-* mongrel
@@ -19 +40 @@
-* Ruby2Ruby
-
-
-
-
-
-
-
-
-
-
-
+
-
-=== The +merb+ server
@@ -54 +66 @@
-        
-To see all the available command line flags use:
+
+        $ merb -h
+                
+        
+== Using Merb
+
+Merb uses the Model-View-Controller (MVC) pattern.  Incoming requests are matched in the Router and
+directed to an appropriate controller action.
+
+=== Model
+
+Merb does not come with its own model layer.  While you are free to use whatever data system you like,
+the merb core team does maintain plugins for the following Object Relational Mappers (ORM's):
+
+ActiveRecord:: The same ORM that Rails uses. (<tt>sudo gem install merb_activerecord</tt>)
+DataMapper:: Fairly new ORM. (<tt>sudo gem install merb_datamapper</tt>)
+Sequel:: Fairly new ORM. (<tt>sudo gem install merb_sequel</tt>)
+
+To use your choice ORM, install the appropriate gem and uncomment the appropriate +use_orm+ line in
+MERB_ROOT/config/dependencies.rb
+
+=== Controllers
+
+(MERB_ROOT/app/controllers/*)
+
+Merb controllers inherit from Merb::Controller and contain built in view/template rendering.
+Incoming requests are usually mapped to a specific method in a controller.  For example, using
+the default routes, a request to http://www.yourapp.com/posts/show/1 would call the the #show
+method of your PostsController (and params[:id] would = 1.)
+
+The return value of your action function gets sent back to the client as the view.  In most cases,
+you are going to want to end your functions with a call to +render+.  By default, +render+ will
+render the view template associated with your action (in default merb that would be 
+MERB_ROOT/app/views/<controller>/<action>.html.erb - see the View section for more info.)
+
+Controllers can be generated by calling MERB_ROOT/script/generate controller ControllerName.
+By default, generated controllers inherit from the Application class (MERB_ROOT/app/controllers/application.rb)
+which itself inherits from Merb:Controller.  Application is a good place to put code pertinent to all controllers.
+An example would be setting a filter to check if a user is logged in or to preload user data for each controller.
+
+==== +before+ and +after+ filters
+
+Use the +before+ method in your controllers. +before+ accepts either a symbol, string 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. You can use :only and :exclude as options to your filters to exclude or include actions from certain filters. :only and :exclude take :symbols or [:sym, :sam] array of symbols.
+
+        class Foo < Merb::Controller
- 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-That last point has some cool connotations if you think about it. Merb does 
@@ -90 +209 @@
-mongrel handles calling it in a thread safe manner.
-
-
-==== Before and after filters
-
-Use the before method in your controllers. before accepts either a symbol, string 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. You can use :only and :exclude as options to your filters to exclude or include actionsfrom certain filters. :only and :exclude take :symbols or [:sym, :sam] array of symbols.
-
-        class Foo < Merb::Controller
- 
-          before :setup_user, :only => :foo
-          before lambda {|c| c.headers['X-Foo] = 'bar' }, :exclude => [:foo, :baz]
-
-          def setup_user
-            # blah blah
-          end
-
-          def foo
-            # blah
-          end
-
-          def regular_action
-            # blah
-          end
-
-        end
-
-To stop the before filter chain you use throw :halt with a few options:
-
-        # halts the filter chain and calls filters_halted which you can override 
-        # in your controller to specialize it.
-
-        throw :halt
-
-        # halts the filters and calls the method named after the symbol:
-
-        throw :halt, :other_action
-
-        # halts the filter chain and returns the result of the Proc being called
-
-        throw :halt, Proc.new{ |c| c.redirect "/foo" }
-
-        # halts the chain and returns whatever is in the string
-
-        throw :halt, "<h1>You don't have permissions dude!</h1>"
-
-        or even render templates:
-
-        throw :halt, render 'foo'
-        throw :halt, partial 'foo'
-
-After filters accept a symbol, string or Proc and call that proc with the controller:
-
-        after Proc.new {|c| Tidy.new(c.body) }, :only => :index
-
-=== Helpers
+
+(MERB_ROOT/app/helpers/*)
-
-app/helpers/global_helper.rb will be available to all of your views.
@@ -173 +242 @@
-          app
-            controllers
+            helpers
+            mailers         
-            models
+            parts
-            views
-            parts
-            mailers
-          config
+          gems
-          lib
+          log
-          public
-          schema
-          Rakefile
-
+
+
-          test
-            spec
-            unit
-          plugins

trunk/Rakefile

@@ -21 +21 @@
-@windows = (PLATFORM =~ /win32/)
-
-||
+&&
-
-setup_clean [ "pkg", "lib/*.bundle", "*.gem", "doc/rdoc", ".config", 'coverage', "cache"]

trunk/lib/merb/mongrel_handler.rb

@@ -43 +43 @@
-  # then mongrel will serve the file directly and your controller can go on
-  # processing other requests.
-
+
+
+
-    start      = Time.now
-    benchmarks = {}
-    
-    return if response.socket.closed?
-    
-    MERB_LOGGER.info("\nRequest: REQUEST_URI: #{