camping 1.5.180 → 2.0.rc0

data/CHANGELOG

@@ -1,3 +1,38 @@
+= 2.0
+=== ???, 2009
+* Speed-up of Camping::Mab (thanks zimbatm!)
+* @state is now an alias of @env['rack.session']
+* Camping.use injects a Rack middleware.
+* Update Flipbook to RDoc 2.4
+* Removed old examples. 
+* Updated examples/blog.rb
+* Camping::Apps returns!
+* Session-cookies now timeout naturally (thanks jenna!)
+* You can now `throw :halt` to halt the response in a helper.
+* Camping::H#u is gone (was an alias to merge!)
+* Camping::Session now uses session-cookies. The AR-backend is gone for now.
+* camping/db.rb has been renamed to camping/ar.rb.
+* Camping now uses Rack internally. Every app responds to #call.
+
+= 1.6
+=== Never released
+
+* 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
+  
+  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/README

@@ -1,12 +1,13 @@
-== Camping, a Microframework
+= Camping, a Microframework
 
-Camping is a web framework which consistently stays at less than 4kb of code.
-You can probably view the complete source code on a single page.  But, you know,
-it's so small that, if you think about it, what can it really do?
+Camping is a web framework which consistently stays at less than 4kB of code.
+You can probably view the complete source code on a single page. But, you
+know, it's so small that, if you think about it, what can it really do?
 
-The idea here is to store a complete fledgling web application in a single file
-like many small CGIs.  But to organize it as a Model-View-Controller application
-like Rails does.  You can then easily move it to Rails once you've got it going.
+The idea here is to store a complete fledgling web application in a single
+file like many small CGIs. But to organize it as a Model-View-Controller
+application like Rails does. You can then easily move it to Rails once you've
+got it going.
 
 == A Camping Skeleton
 
@@ -23,7 +24,7 @@ A skeletal Camping blog could look like this:
   end
 
   module Blog::Controllers
-    class Index < R '/'
+    class Index
       def get
         @posts = Post.find :all
         render :index
@@ -34,86 +35,60 @@ A skeletal Camping blog could look like this:
   module Blog::Views
     def layout
       html do
+        head { title "My Blog" }
         body do
+          h1 "My Blog"
           self << yield
         end
       end
     end
 
     def index
-      for post in @posts
+      @posts.each do |post|
         h1 post.title
       end
     end
   end
-
-Some things you might have noticed:
-
-* Camping::Models uses ActiveRecord to do its work.  We love ActiveRecord!
-* Camping::Controllers can be assigned URLs in the class definition.  Neat?
-* Camping::Views describes HTML using pure Ruby.  Markup as Ruby, which we
-  call Markaby.
-* You use Camping::goes to make a copy of the Camping framework under your
-  own module name (in this case: <tt>Blog</tt>.)
-
-<b>NOTE:</b> Camping auto-prefixes table names.  If your class is named
-<tt>Blog::Models::Post</tt>, your table will be called <b>blog_posts</b>.
-Since many Camping apps can be attached to a database at once, this helps
-prevent name clash.
-
-(If you want to see the full blog example, check out <tt>examples/blog/blog.rb</tt>
-for the complete code.)
-
-If you want to write larger applications with Camping, you are encouraged to
-split the application into distinct parts which can be mounted at URLs on your
-web server.  You might have a blog at /blog and a wiki at /wiki.  Each
-self-contained.  But you can certainly share layouts and models by storing them
-in plain Ruby scripts.
-
-Interested yet?  Okay, okay, one step at a time.
-
+  
 == Installation
 
-* <tt>gem install camping</tt>
-
-Or for the bleeding edge:
-
-* <tt>gem install camping --source 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.
-
-* See http://code.whytheluckystiff.net/camping/wiki/BeAlertWhenOnSqlite3 for instructions.
+Interested yet?  Luckily it's quite easy to install Camping.  We'll be using
+a tool called RubyGems, so if you don't have that installed yet, go grab it!
+Once that's sorted out, open up a Terminal or Command Line and enter:
 
-== Running Camping Apps
+    gem install camping
 
-The blog example above and most Camping applications look a lot like CGI scripts.
-If you run them from the commandline, you'll probably just see a pile of HTML.
+Even better, install the Camping Omnibus, a full package of recommended libs:
 
-Camping comes with an tool for launching apps from the commandline:
+    gem install camping-omnibus --source http://gems.judofyr.net
 
-* Run: <tt>camping blog.rb</tt>
-* Visit http://localhost:3301/blog/ to use the app.
+If not, you should be aware of that Camping itself only depends on
+Rack[http://rack.rubyforge.org], and if you're going to use the views you also
+need to install +markaby+, and if you're going to use the database you need
++activerecord+ as well.
 
-== How the Camping Tool Works
+    gem install markaby
+    gem install activerecord
+ 
+== Learning
 
-If your application isn't working with the <tt>camping</tt> tool, keep in mind
-that the tool expects the following conventions to be used:
+First of all, you should read {the first chapters}[link:book/01_introduction.html]
+of The Camping Book. It should hopefully get you started pretty quick. While
+you're doing that, you should be aware of the _reference_ which contains
+documentation for all the different parts of Camping.
 
-1. You must have SQLite3 and SQLite3-ruby installed.  (Once again, please see
-   http://code.whytheluckystiff.net/camping/wiki/BeAlertWhenOnSqlite3 for instructions.)
-2. If your script is called <tt>test.rb</tt>, Camping expects your application to
-   be stored in a module called <tt>Test</tt>.  Case is not imporant, though.  The
-   module can be called <tt>TeSt</tt> or any other permutation.
-3. Your script's postamble (anything enclosed in <tt>if __FILE__ == $0</tt>) will be
-   ignored by the tool, since the tool will create an SQLite3 database at 
-   <tt>~/.camping.db</tt>.  Or, on Windows, <tt>$USER/Application Data/Camping.db</tt>.
-4. If your application's module has a <tt>create</tt> method, it will be executed before
-   the web server starts up.
+{The wiki}[http://wiki.github.com/camping/camping] is the place for all tiny,
+useful tricks that we've collected over the years.  Don't be afraid to share
+your own discoveries; the more, the better!
 
-== The Rules of Thumb
+And if there's anything you're wondering about, don't be shy, but rather 
+subscribe to {the mailing list}[http://rubyforge.org/mailman/listinfo/camping-list]
+and ask there.  We also have an IRC channel over at Freenode, so if you feel
+like chatting with us, you should join {#camping @ irc.freenode.net}[http://java.freenode.net/?channel=camping].
 
-Once you've started writing your own Camping app, I'd highly recommend that you become familiar
-with the Camping Rules of Thumb which are listed on the wiki: 
-http://code.whytheluckystiff.net/camping/wiki/CampingRulesOfThumb
+== Authors
 
+Camping was originally crafted by {why the lucky stiff}[http://en.wikipedia.org/wiki/Why_the_lucky_stiff],
+but is now maintained by the _community_.  This simply means that if we like your
+patch, it will be applied.  Everything is managed through {the mailing list}[http://rubyforge.org/mailman/listinfo/camping-list],
+so just subscribe and you can instantly take a part in shaping Camping.

data/Rakefile

@@ -1,108 +1,119 @@
+$:.unshift 'extras'
 require 'rake'
 require 'rake/clean'
 require 'rake/gempackagetask'
-require 'rake/rdoctask'
 require 'rake/testtask'
-require 'fileutils'
-include FileUtils
+require 'tempfile'
+require 'open3'
+
+task :default => :check
 
+## Constants
 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']
-RDOC_OPTS = ['--quiet', '--title', "Camping, the Documentation",
-    "--opname", "index.html",
-    "--line-numbers", 
-    "--main", "README",
-    "--inline-source"]
-
-desc "Packages up Camping."
-task :default => [:package]
-task :package => [:clean]
-
-task :doc => [:before_doc, :rdoc, :after_doc]
-
-task :before_doc do 
-    mv "lib/camping.rb", "lib/camping-mural.rb"
-    mv "lib/camping-unabridged.rb", "lib/camping.rb"
-end
+BRANCH = "2.0"
+GIT = ENV['GIT'] || "git"
+REV = `#{GIT} rev-list HEAD`.strip.split.length
+VERS = ENV['VERSION'] || (REV.zero? ? BRANCH : [BRANCH, REV] * '.')
+
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', 'test/test.log', '.*.pt']
+RDOC_OPTS = ["--line-numbers", "--quiet", "--main", "README"]
+    
+## Packaging
+spec =
+  Gem::Specification.new do |s|
+    s.name = NAME
+    s.version = VERS
+    s.platform = Gem::Platform::RUBY
+    s.has_rdoc = true
+    s.extra_rdoc_files = FileList["README", "CHANGELOG", "COPYING", "book/*"].to_a
+    s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|extras)\/', '--exclude', 'lib/camping.rb']
+    s.summary = "minature rails for stay-at-home moms"
+    s.author = "why the lucky stiff"
+    s.email = 'why@ruby-lang.org'
+    s.homepage = 'http://camping.rubyforge.org/'
+    s.rubyforge_project = 'camping'
+    s.executables = ['camping']
+
+    s.add_dependency('rack', '>=1.0')
+    s.required_ruby_version = '>= 1.8.2'
+
+    s.files = %w(COPYING README Rakefile) +
+    Dir.glob("{bin,doc,test,lib,extras,book}/**/*") + 
+    Dir.glob("ext/**/*.{h,c,rb}") +
+    Dir.glob("examples/**/*.rb") +
+    Dir.glob("tools/*.rb")
+
+    s.require_path = "lib"
+    s.bindir = "bin"
+  end                   
 
-Rake::RDocTask.new do |rdoc|
-    rdoc.rdoc_dir = 'doc/rdoc'
-    rdoc.options += RDOC_OPTS
-    rdoc.template = "extras/flipbook_rdoc.rb"
-    rdoc.main = "README"
-    rdoc.title = "Camping, the Documentation"
-    rdoc.rdoc_files.add ['README', 'CHANGELOG', 'COPYING', 'lib/camping.rb', 'lib/camping/*.rb']
+omni =
+  Gem::Specification.new do |s|
+    s.name = "camping-omnibus"
+    s.version = VERS
+    s.platform = Gem::Platform::RUBY
+    s.summary = "the camping meta-package for updating ActiveRecord, Mongrel and SQLite3 bindings"
+    %w[author email homepage rubyforge_project].each { |x| s.__send__("#{x}=", spec.__send__(x)) }
+
+    s.add_dependency('camping', "=#{VERS}")
+    s.add_dependency('activerecord')
+    s.add_dependency('sqlite3-ruby', '>=1.1.0.1')
+    s.add_dependency('mongrel')
+    s.add_dependency('RedCloth')
+  end
+  
+## RDoc
+
+begin
+  gem 'rdoc', '~> 2.4.0'
+rescue LoadError
+  # Don't complain yet.
 end
 
-task :after_doc do
-    mv "lib/camping.rb", "lib/camping-unabridged.rb"
-    mv "lib/camping-mural.rb", "lib/camping.rb"
-    cp "extras/Camping.gif", "doc/rdoc/"
-    cp "extras/permalink.gif", "doc/rdoc/"
-    sh %{scp -r doc/rdoc/* #{ENV['USER']}@rubyforge.org:/var/www/gforge-projects/camping/}
-end
+require 'rdoc/rdoc'
+require 'rake/rdoctask'
 
-spec =
-    Gem::Specification.new do |s|
-        s.name = NAME
-        s.version = VERS
-        s.platform = Gem::Platform::RUBY
-        s.has_rdoc = true
-        s.extra_rdoc_files = ["README", "CHANGELOG", "COPYING"]
-        s.rdoc_options += RDOC_OPTS + ['--exclude', '^(examples|extras)\/', '--exclude', 'lib/camping.rb']
-        s.summary = "minature rails for stay-at-home moms"
-        s.description = s.summary
-        s.author = "why the lucky stiff"
-        s.email = 'why@ruby-lang.org'
-        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('metaid')
-        s.required_ruby_version = '>= 1.8.2'
-
-        s.files = %w(COPYING README Rakefile) +
-          Dir.glob("{bin,doc,test,lib,extras}/**/*") + 
-          Dir.glob("ext/**/*.{h,c,rb}") +
-          Dir.glob("examples/**/*.rb") +
-          Dir.glob("tools/*.rb")
-        
-        s.require_path = "lib"
-        # s.extensions = FileList["ext/**/extconf.rb"].to_a
-        s.bindir = "bin"
+Rake::RDocTask.new(:docs) do |rdoc|
+  if defined?(RDoc::VERSION) && RDoc::VERSION[0,3] == "2.4"
+    # We have a recent version of RDoc, so let's use flipbook.
+    require 'rdoc/generator/singledarkfish'
+    rdoc.options += ['-f', 'singledarkfish', *RDOC_OPTS]
+    rdoc.template = "flipbook"
+  else
+    # Use whatever template is available, and give a little warning.
+    task :docs do
+      puts "** Camping needs RDoc 2.4 in order to use the Flipbook template."
     end
+  end
+  
+  rdoc.inline_source = false # --inline-source is deprecated
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title = "Camping, a Microframework"
+  rdoc.rdoc_files.add ['README', 'lib/camping-unabridged.rb', 'lib/camping/**/*.rb', 'book/*']
+end
+  
+task :rubygems_docs do
+  require 'rubygems/doc_manager'
+  
+  def spec.installation_path; '.' end
+  def spec.full_gem_path;     '.' end
+  manager = Gem::DocManager.new(spec)
+  manager.generate_rdoc
+end
 
-omni =
-    Gem::Specification.new do |s|
-        s.name = "camping-omnibus"
-        s.version = VERS
-        s.platform = Gem::Platform::RUBY
-        s.summary = "the camping meta-package for updating ActiveRecord, Mongrel and SQLite3 bindings"
-        s.description = s.summary
-        %w[author email homepage].each { |x| s.__send__("#{x}=", spec.__send__(x)) }
-
-        s.add_dependency('camping', "=#{VERS}")
-        s.add_dependency('activerecord')
-        s.add_dependency('sqlite3-ruby', '>=1.1.0.1')
-        s.add_dependency('mongrel')
-        s.add_dependency('acts_as_versioned')
-        s.add_dependency('RedCloth')
-    end
+desc "Packages Camping."
+task :package => :clean
 
 Rake::GemPackageTask.new(spec) do |p|
-    p.need_tar = true
-    p.gem_spec = spec
+  p.need_tar = true
+  p.gem_spec = spec
 end
 
 Rake::GemPackageTask.new(omni) do |p|
-    p.gem_spec = omni
+  p.gem_spec = omni
 end
 
-task :install do
-  sh %{rake package}
+task :install => :package do
   sh %{sudo gem install pkg/#{NAME}-#{VERS}}
 end
 
@@ -110,8 +121,66 @@ task :uninstall => [:clean] do
   sh %{sudo gem uninstall #{NAME}}
 end
 
+## Tests
 Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/test_*.rb']
 #  t.warning = true
 #  t.verbose = true
 end
+
+## Diff
+desc "Compare camping and camping-unabridged"
+task :diff do
+  require 'ruby2ruby'
+  require 'ruby_parser'
+  u = Tempfile.new('unabridged')
+  m = Tempfile.new('mural')
+  
+  u << Ruby2Ruby.new.process(RubyParser.new.parse(File.read("lib/camping.rb")))
+  m << Ruby2Ruby.new.process(RubyParser.new.parse(File.read("lib/camping-unabridged.rb")))
+  
+  sh "diff -u #{u.path} #{m.path} | less"
+  
+  u.delete
+  m.delete
+end
+
+## Check
+task :check => ["check:valid", "check:size", "check:lines"]
+namespace :check do
+
+  desc "Check source code validity"
+  task :valid do
+    require 'ruby_parser'
+    u = RubyParser.new.parse(File.read("lib/camping-unabridged.rb"))
+    m = RubyParser.new.parse(File.read("lib/camping.rb"))
+    
+    unless u == m
+      STDERR.puts "camping.rb and camping-unabridged.rb are not synchronized."
+    end
+  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