camping 1.1 → 1.2

data/examples/tepee/start

@@ -0,0 +1,6 @@
+#!/usr/bin/ruby
+require 'webrick/httpserver'
+s = WEBrick::HTTPServer.new(:BindAddress => '0.0.0.0', :Port => 3000)
+s.mount("/", WEBrick::HTTPServlet::CGIHandler, "tepee.rb")
+trap( :INT ) { s.shutdown }
+s.start

data/examples/tepee/tepee.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/ruby
+$:.unshift File.dirname(__FILE__) + "/../../lib"
+%w(rubygems redcloth camping acts_as_versioned).each { |lib| require lib }
+
+Camping.goes :Tepee
+
+module Tepee::Models
+  def self.schema(&block)
+    @@schema = block if block_given?
+    @@schema
+  end
+  
+  class Page < Base
+    PAGE_LINK = /\[\[([^\]|]*)[|]?([^\]]*)\]\]/
+    validates_uniqueness_of :title
+    before_save { |r| r.title = r.title.underscore }
+    acts_as_versioned
+  end
+end
+
+Tepee::Models.schema do
+  create_table :pages, :force => true do |t|
+    t.column :title, :string, :limit => 255
+    t.column :body, :text
+  end
+  Tepee::Models::Page.create_versioned_table
+end
+
+module Tepee::Controllers
+  class Index < R '/'
+    def get
+      redirect Show, 'home_page'
+    end
+  end
+
+  class List < R '/list'
+    def get
+      @pages = Page.find :all, :order => 'title'
+      render :list
+    end
+  end
+
+  class Show < R '/s/(\w+)', '/s/(\w+)/(\d+)'
+    def get page_name, version = nil
+      redirect(Edit, page_name, 1) and return unless @page = Page.find_by_title(page_name)
+      @version = (version.nil? or version == @page.version.to_s) ? @page : @page.versions.find_by_version(version)
+      render :show
+    end
+  end
+
+  class Edit < R '/e/(\w+)/(\d+)', '/e/(\w+)'
+    def get page_name, version = nil
+      @page = Page.find_or_create_by_title(page_name)
+      @page = @page.versions.find_by_version(version) unless version.nil? or version == @page.version.to_s
+      render :edit
+    end
+    
+    def post page_name
+      Page.find_or_create_by_title(page_name).update_attributes :body => input.post_body and redirect Show, page_name
+    end
+  end
+end
+
+module Tepee::Views
+  def layout
+    html do
+      head do
+        title 'test'
+      end
+      body do
+        p do
+          small do
+            span "welcome to " ; a 'tepee', :href => "http://code.whytheluckystiff.net/svn/camping/trunk/examples/tepee/"
+            span '. go ' ;       a 'home',  :href => R(Show, 'home_page')
+            span '. list all ' ; a 'pages', :href => R(List)
+          end
+        end
+        div.content do
+          self << yield
+        end
+      end
+    end
+  end
+
+  def show
+    h1 @page.title
+    div { _markup @version.body }
+    p do 
+      a 'edit',    :href => R(Edit, @version.title, @version.version)
+      a 'back',    :href => R(Show, @version.title, @version.version-1) unless @version.version == 1
+      a 'next',    :href => R(Show, @version.title, @version.version+1) unless @version.version == @page.version
+      a 'current', :href => R(Show, @version.title)                     unless @version.version == @page.version
+    end
+  end
+
+  def edit
+    form :method => 'post', :action => R(Edit, @page.title) do
+      p do
+        label 'Body' ; br
+        textarea @page.body, :name => 'post_body', :rows => 50, :cols => 100
+      end
+      
+      p do
+        input :type => 'submit'
+        a 'cancel', :href => R(Show, @page.title, @page.version)
+      end
+    end
+  end
+
+  def list
+    h1 'all pages'
+    ul { @pages.each { |p| li { a p.title, :href => R(Show, p.title) } } }
+  end
+
+  def _markup body
+    return '' if body.blank?
+    body.gsub!(Tepee::Models::Page::PAGE_LINK) do
+      page = title = $1.underscore
+      title = $2 unless $2.empty?
+      if Tepee::Models::Page.find(:all, :select => 'title').collect { |p| p.title }.include?(page)
+        %Q{<a href="#{R Show, page}">#{title}</a>}
+      else
+        %Q{<span>#{title}<a href="#{R Edit, page, 1}">?</a></span>}
+      end
+    end
+    RedCloth.new(body, [ :hard_breaks ]).to_html
+  end
+end
+
+db_exists = File.exists?('tepee.db')
+Tepee::Models::Base.establish_connection :adapter => 'sqlite3', :database => 'tepee.db'
+Tepee::Models::Base.logger = Logger.new('camping.log')
+ActiveRecord::Schema.define(&Tepee::Models.schema) unless db_exists
+
+if __FILE__ == $0
+  Tepee.run
+end

data/lib/camping-unabridged.rb

@@ -0,0 +1,468 @@
+%w[rubygems active_record markaby metaid ostruct tempfile].each { |lib| require lib }
+
+# == Camping 
+#
+# The camping module contains three modules for separating your application:
+#
+# * Camping::Models for storing classes derived from ActiveRecord::Base.
+# * Camping::Controllers for storing controller classes, which map URLs to code.
+# * Camping::Views for storing methods which generate HTML.
+#
+# Of use to you is also one module for storing helpful additional methods:
+#
+# * Camping::Helpers which can be used in controllers and views.
+#
+# == The postamble
+#
+# Most Camping applications contain the entire application in a single script.
+# The script begins by requiring Camping, then fills each of the three modules
+# described above with classes and methods.  Finally, a postamble puts the wheels
+# in motion.
+#
+#   if __FILE__ == $0
+#     Camping::Models::Base.establish_connection :adapter => 'sqlite3', :database => 'blog3.db'
+#     Camping::Models::Base.logger = Logger.new('camping.log')
+#     Camping.run
+#   end
+#
+# In the postamble, your job is to setup Camping::Models::Base (see: ActiveRecord::Base) 
+# and call Camping::run in a request loop.  The above postamble is for a standard
+# CGI setup, where the web server manages the request loop and calls the script once
+# for every request.
+#
+# For other configurations, see 
+# http://code.whytheluckystiff.net/camping/wiki/PostAmbles
+module Camping
+  C = self
+  S = File.read(__FILE__).gsub(/_{2}FILE_{2}/,__FILE__.dump)
+
+  # Helpers contains methods available in your controllers and views.
+  module Helpers
+    # From inside your controllers and views, you will often need to figure out
+    # the route used to get to a certain controller +c+.  Pass the controller class
+    # and any arguments into the R method, a string containing the route will be
+    # returned to you.
+    #
+    # Assuming you have a specific route in an edit controller:
+    #
+    #   class Edit < R '/edit/(\d+)'
+    #
+    # A specific route to the Edit controller can be built with:
+    #
+    #   R(Edit, 1)
+    #
+    # Which outputs: <tt>/edit/1</tt>.
+    #
+    # You may also pass in a model object and the ID of the object will be used.
+    #
+    # If a controller has many routes, the route will be selected if it is the
+    # first in the routing list to have the right number of arguments.
+    #
+    # Keep in mind that this route doesn't include the root path.  Occassionally
+    # you will need to use <tt>/</tt> (the slash method above).
+    def R(c,*args)
+      p = /\(.+?\)/
+      args.inject(c.urls.detect{|x|x.scan(p).size==args.size}.dup){|str,a|
+        str.sub(p,(a.method(a.class.primary_key)[] rescue a).to_s)
+      }
+    end
+    # Shows AR validation errors for the object passed. 
+    # There is no output if there are no errors.
+    #
+    # An example might look like:
+    #
+    #   errors_for @post
+    #
+    # Might (depending on actual data) render something like this in Markaby:
+    #
+    #   ul.errors do
+    #     li "Body can't be empty"
+    #     li "Title must be unique"
+    #   end
+    #
+    # Add a simple ul.errors {color:red; font-weight:bold;} CSS rule and you
+    # have built-in, usable error checking in only one line of code. :-)
+    #
+    # See AR validation documentation for details on validations.
+    def errors_for(o); ul.errors { o.errors.each_full { |er| li er } } unless o.errors.empty?; end
+    # Simply builds the complete URL from a relative or absolute path +p+.  If your
+    # application is running from <tt>/blog</tt>:
+    #
+    #   self / "/view/1"    #=> "/blog/view/1"
+    #   self / "styles.css" #=> "styles.css"
+    #   self / R(Edit, 1)   #=> "/blog/edit/1"
+    #
+    def /(p); p[/^\//]?@root+p:p end
+  end
+
+  # Controllers is a module for placing classes which handle URLs.  This is done
+  # by defining a route to each class using the Controllers::R method.
+  #
+  #   module Camping::Controllers
+  #     class Edit < R '/edit/(\d+)'
+  #       def get; end
+  #       def post; end
+  #     end
+  #   end
+  #
+  # If no route is set, Camping will guess the route from the class name.
+  # The rule is very simple: the route becomes a slash followed by the lowercased
+  # class name.  See Controllers::D for the complete rules of dispatch.
+  #
+  # == Special classes
+  #
+  # There are two special classes used for handling 404 and 500 errors.  The
+  # NotFound class handles URLs not found.  The ServerError class handles exceptions
+  # uncaught by your application.
+  module Controllers
+    # Controllers::Base is built into each controller by way of the generic routing
+    # class Controllers::R.  In some ways, this class is trying to do too much, but
+    # it saves code for all the glue to stay in one place.
+    #
+    # Forgivable, considering that it's only really a handful of methods and accessors.
+    #
+    # == Treating controller methods like Response objects
+    #
+    # Camping originally came with a barebones Response object, but it's often much more readable
+    # to just use your controller as the response.
+    #
+    # Go ahead and alter the status, cookies, headers and body instance variables as you
+    # see fit in order to customize the response.
+    #
+    #   module Camping::Controllers
+    #     class SoftLink
+    #       def get
+    #         redirect "/"
+    #       end
+    #     end
+    #   end
+    #
+    # Is equivalent to:
+    #
+    #   module Camping::Controllers
+    #     class SoftLink
+    #       def get
+    #         @status = 302
+    #         @headers['Location'] = "/"
+    #       end
+    #     end
+    #   end
+    #
+    module Base
+      include Helpers
+      attr_accessor :input, :cookies, :headers, :body, :status, :root
+      # Display a view, calling it by its method name +m+.  If a <tt>layout</tt>
+      # method is found in Camping::Views, it will be used to wrap the HTML.
+      #
+      #   module Camping::Controllers
+      #     class Show
+      #       def get
+      #         @posts = Post.find :all
+      #         render :index
+      #       end
+      #     end
+      #   end
+      #
+      def render(m); end; undef_method :render
+
+      # Any stray method calls will be passed to Markaby.  This means you can reply
+      # with HTML directly from your controller for quick debugging.
+      #
+      #   module Camping::Controllers
+      #     class Info
+      #       def get; code ENV.inspect end
+      #     end
+      #   end
+      #
+      # If you have a <tt>layout</tt> method in Camping::Views, it will be used to
+      # wrap the HTML.
+      def method_missing(m, *args, &blk)
+        str = m==:render ? markaview(*args, &blk):eval("markaby.#{m}(*args, &blk)")
+        str = markaview(:layout) { str } rescue nil
+        r(200, str.to_s)
+      end
+
+      # Formulate a redirect response: a 302 status with <tt>Location</tt> header
+      # and a blank body.  If +c+ is a string, the root path will be added.  If
+      # +c+ is a controller class, Helpers::R will be used to route the redirect
+      # and the root path will be added.
+      #
+      # So, given a root of <tt>/articles</tt>:
+      #
+      #   redirect "view/12"    # redirects to "/articles/view/12"
+      #   redirect View, 12     # redirects to "/articles/view/12"
+      #
+      def redirect(c, *args)
+        c = R(c,*args) if c.respond_to? :urls
+        r(302, '', 'Location' => self/c)
+      end
+
+      # A quick means of setting this controller's status, body and headers.
+      # Used internally by Camping, but... by all means...
+      #
+      #   r(302, '', 'Location' => self / "/view/12")
+      #
+      # Is equivalent to:
+      #
+      #   redirect "/view/12"
+      #
+      def r(s, b, h = {}); @status = s; @headers.merge!(h); @body = b; end
+
+      def service(r, e, m, a) #:nodoc:
+        @status, @headers, @root = 200, {}, e['SCRIPT_NAME']
+        cook = C.cookie_parse(e['HTTP_COOKIE'] || e['COOKIE'])
+        qs = C.qs_parse(e['QUERY_STRING'])
+        if "POST" == m
+          inp = r.read(e['CONTENT_LENGTH'].to_i)
+          if %r|\Amultipart/form-data.*boundary=\"?([^\";,]+)|n.match(e['CONTENT_TYPE'])
+            b = "--#$1"
+            inp.split(/(?:\r?\n|\A)#{ Regexp::quote( b ) }(?:--)?\r\n/m).each { |pt|
+              h,v=pt.split("\r\n\r\n",2);fh={}
+              [:name, :filename].each { |x|
+                fh[x] = $1 if h =~ /^Content-Disposition: form-data;.*(?:\s#{x}="([^"]+)")/m
+              }
+              fn = fh[:name]
+              if fh[:filename]
+                fh[:type]=$1 if h =~ /^Content-Type: (.+?)(\r\n|\Z)/m
+                fh[:tempfile]=Tempfile.new("#{C}").instance_eval {binmode;write v;rewind;self}
+              else
+                fh=v
+              end
+              qs[fn]=fh if fn
+            }
+          else
+            qs.merge!(C.qs_parse(inp))
+          end
+        end
+        @cookies, @input = [cook, qs].map{|_|OpenStruct.new(_)}
+
+        @body = method( m.downcase ).call(*a)
+        @headers['Set-Cookie'] = @cookies.marshal_dump.map { |k,v| "#{k}=#{C.escape(v)}; path=/" if v != cook[k] }.compact
+        self
+      end
+      def to_s #:nodoc:
+        "Status: #{@status}\n#{{'Content-Type'=>'text/html'}.merge(@headers).map{|k,v|v.to_a.map{|v2|"#{k}: #{v2}"}}.flatten.join("\n")}\n\n#{@body}"
+      end
+      private
+      def markaby
+          Mab.new( instance_variables.map { |iv| 
+            [iv[1..-1], instance_variable_get(iv)] }, {} )
+      end
+      def markaview(m, *args, &blk)
+        b=markaby
+        b.method(m).call(*args, &blk)
+        b.to_s
+      end
+    end
+
+    # The R class is the parent class for all controllers and ensures they all get the Base mixin.
+    class R; include Base end
+
+    # The NotFound class is a special controller class for handling 404 errors, in case you'd
+    # like to alter the appearance of the 404.  The path is passed in as +p+.
+    #
+    #   module Camping::Controllers
+    #     class NotFound
+    #       def get(p)
+    #         @status = 404
+    #         div do
+    #           h1 'Camping Problem!'
+    #           h2 "#{p} not found"
+    #         end
+    #       end
+    #     end
+    #   end
+    #
+    class NotFound; def get(p); r(404, div{h1("#{C} Problem!")+h2("#{p} not found")}); end end
+
+    # The ServerError class is a special controller class for handling many (but not all) 500 errors.
+    # If there is a parse error in Camping or in your application's source code, it will not be caught
+    # by Camping.  The controller class +k+ and request method +m+ (GET, POST, etc.) where the error
+    # took place are passed in, along with the Exception +e+ which can be mined for useful info.
+    #
+    #   module Camping::Controllers
+    #     class ServerError
+    #       def get(k,m,e)
+    #         @status = 500
+    #         div do
+    #           h1 'Camping Problem!'
+    #           h2 "in #{k}.#{m}"
+    #           h3 "#{e.class} #{e.message}:"
+    #           ul do
+    #             e.backtrace.each do |bt|
+    #               li bt
+    #             end
+    #           end
+    #         end
+    #       end
+    #     end
+    #   end
+    #
+    class ServerError; include Base; def get(k,m,e); r(500, markaby.div{ h1 "#{C} Problem!"; h2 "#{k}.#{m}"; h3 "#{e.class} #{e.message}:"; ul { e.backtrace.each { |bt| li bt } } }) end end
+
+    class << self
+      # Add routes to a controller class by piling them into the R method.
+      #
+      #   module Camping::Controllers
+      #     class Edit < R '/edit/(\d+)', '/new'
+      #       def get(id)
+      #         if id   # edit
+      #         else    # new
+      #         end
+      #       end
+      #     end
+      #   end
+      #
+      # You will need to use routes in either of these cases:
+      #
+      # * You want to assign multiple routes to a controller.
+      # * You want your controller to receive arguments.
+      #
+      # Most of the time the rules inferred by dispatch method Controllers::D will get you
+      # by just fine.
+      def R(*urls); Class.new(R) { meta_def(:inherited) { |c| c.meta_def(:urls) { urls } } }; end
+
+      # Dispatch routes to controller classes.  Classes are searched in no particular order.
+      # For each class, routes are checked for a match based on their order in the routing list
+      # given to Controllers::R.  If no routes were given, the dispatcher uses a slash followed
+      # by the name of the controller lowercased.
+      def D(path)
+        constants.inject(nil) do |d,c| 
+            k = const_get(c)
+            k.meta_def(:urls){["/#{c.downcase}"]}if !(k<R)
+            d||([k, $~[1..-1]] if k.urls.find { |x| path =~ /^#{x}\/?$/ })
+        end||[NotFound, [path]]
+      end
+    end
+  end
+
+  class << self
+    # When you are running many applications, you may want to create independent
+    # modules for each Camping application.  Namespaces for each.  Camping::goes
+    # defines a toplevel constant with the whole MVC rack inside.
+    #
+    #   require 'camping'
+    #   Camping.goes :Blog
+    #
+    #   module Blog::Controllers; ... end
+    #   module Blog::Models;      ... end
+    #   module Blog::Views;       ... end
+    #
+    def goes(m)
+        eval(S.gsub(/Camping/,m.to_s),TOPLEVEL_BINDING)
+    end
+
+    # URL escapes a string.
+    #
+    #   Camping.escape("I'd go to the museum straightway!")  
+    #     #=> "I%27d+go+to+the+museum+straightway%21"
+    #
+
+    def escape(s); s.to_s.gsub(/([^ a-zA-Z0-9_.-]+)/n){'%'+$1.unpack('H2'*$1.size).join('%').upcase}.tr(' ', '+') end
+    # Unescapes a URL-encoded string.
+    #
+    #   Camping.unescape("I%27d+go+to+the+museum+straightway%21") 
+    #     #=> "I'd go to the museum straightway!"
+    #
+    def unescape(s); s.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n){[$1.delete('%')].pack('H*')} end
+
+    # Parses a query string into an OpenStruct object.
+    #
+    #   input = Camping.qs_parse("name=Philarp+Tremain&hair=sandy+blonde")
+    #   input.name
+    #     #=> "Philarp Tremaine"
+    #
+    def qs_parse(qs, d = '&;'); (qs||'').split(/[#{d}] */n).
+        inject({}){|hsh, p|k, v = p.split('=',2).map {|v| unescape(v)}; hsh[k] = v unless v.blank?; hsh} end
+
+    # Parses a string of cookies from the <tt>Cookie</tt> header.
+    def cookie_parse(s); c = qs_parse(s, ';,'); end
+
+    # Fields a request through Camping.  For traditional CGI applications, the method can be
+    # executed without arguments.
+    #
+    #   if __FILE__ == $0
+    #     Camping::Models::Base.establish_connection :adapter => 'sqlite3', :database => 'blog3.db'
+    #     Camping::Models::Base.logger = Logger.new('camping.log')
+    #     Camping.run
+    #   end
+    #
+    # For FastCGI and Webrick-loaded applications, you will need to use a request loop, with <tt>run</tt>
+    # at the center, passing in the read +r+ and write +w+ streams.  You will also need to mimick or
+    # replace <tt>ENV</tt> as part of your wrapper.
+    #
+    #   if __FILE__ == $0
+    #     require 'fcgi'
+    #       Camping::Models::Base.establish_connection :adapter => 'sqlite3', :database => 'blog3.db'
+    #       Camping::Models::Base.logger = Logger.new('camping.log')
+    #       FCGI.each do |req|
+    #         ENV.replace req.env
+    #         Camping.run req.in, req.out
+    #         req.finish
+    #       end
+    #     end
+    #   end
+    #
+    def run(r=$stdin,w=$stdout)
+      w <<
+        begin
+          k, a = Controllers.D "/#{ENV['PATH_INFO']}".gsub(%r!/+!,'/')
+          m = ENV['REQUEST_METHOD']||"GET"
+          k.class_eval { include C; include Controllers::Base; include Models }
+          o = k.new
+          o.service(r, ENV, m, a)
+        rescue => e
+          Controllers::ServerError.new.service(r, ENV, "GET", [k,m,e])
+        end
+    end
+  end
+
+  # Models is an empty Ruby module for housing model classes derived
+  # from ActiveRecord::Base.  As a shortcut, you may derive from Base
+  # which is an alias for ActiveRecord::Base.
+  #
+  #   module Camping::Models
+  #     class Post < Base; belongs_to :user end
+  #     class User < Base; has_many :posts end
+  #   end
+  #
+  # == Where Models are Used
+  #
+  # Models are used in your controller classes.  However, if your model class
+  # name conflicts with a controller class name, you will need to refer to it
+  # using the Models module.
+  #
+  #   module Camping::Controllers
+  #     class Post < R '/post/(\d+)'
+  #       def get(post_id)
+  #         @post = Models::Post.find post_id
+  #         render :index
+  #       end
+  #     end
+  #   end
+  #
+  # Models cannot be referred to in Views at this time.
+  module Models; end
+
+  # Views is an empty module for storing methods which create HTML.  The HTML is described
+  # using the Markaby language.
+  #
+  # == Using the layout method
+  #
+  # If your Views module has a <tt>layout</tt> method defined, it will be called with a block
+  # which will insert content from your view.
+  module Views; include Controllers; include Helpers end
+  Models::Base = ActiveRecord::Base
+  
+  # The Mab class wraps Markaby, allowing it to run methods from Camping::Views
+  # and also to replace :href and :action attributes in tags by prefixing the root
+  # path.
+  class Mab < Markaby::Builder
+      include Views
+      def tag!(*g,&b)
+          h=g[-1]
+          [:href,:action].each{|a|(h[a]=self/h[a])rescue 0}
+          super 
+      end
+  end
+end