merb 0.4.2 → 0.5.0

data/README

@@ -42,14 +42,15 @@ provides a faster library but will not work with jRuby.
  
 Optionally, merb can take advantage of the following gems: 
  
-* mailfactory (if you wish to use merb's mailers) 
-* haml (if you wish to use HAML templates, i.e. .haml files) 
+* mailfactory (if you wish to use merb's mailers)
+* haml 1.8 or greater (if you wish to use HAML templates, i.e. .haml files)
 * markaby (if you wish to use Markaby template, i.e. .mab files) 
 * builder (if you wish to use Builder templates, i.e. .rxml, .rerb or .builder files) 
 * memcache-client (for use with Danga Interactive's memcached) 
 * swiftiply 
 * eventmachine 
 * rcov
+* ruby-debug (if you want to use debugging functionality)
 
 You will also probably need to install your ORM of choice as well as any gem plugins you want to use (see below).
 
@@ -75,6 +76,12 @@ To start a Merb IRB console where all your models and other classes are pre load
 use the -i flag
 
 	$ merb -i
+
+To enable ruby-debug support, start Merb with
+
+  $ merb -D
+
+Now you can use the +debugger+ method everywhere in your code to open an rdebug session.
 	
 To see all the available command line flags use:
 
@@ -96,11 +103,11 @@ 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
+Merb.root/config/dependencies.rb
 
 === Controllers
 
-(MERB_ROOT/app/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
@@ -110,10 +117,10 @@ 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.)
+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)
+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.
 
@@ -171,18 +178,18 @@ After filters accept a symbol, string or Proc and call that proc with the contro
 
 === Views
 
-(MERB_ROOT/app/views/*)
+(Merb.root/app/views/*)
 
 A view can be loosely defined as any data sent back to the client (a "view" of your data.)
 By default, Merb controllers send the return value of your controller action as the view.
 The Controller#render method simply renders the specified view and returns it as a string.
 By default, a call to +render+ without any options renders the view template associated
 with that controller action.  Using the default ERB templating system, this means that a
-call to +render+ in Posts#index would render the file MERB_ROOT/app/views/posts/index.html.erb
+call to +render+ in Posts#index would render the file Merb.root/app/views/posts/index.html.erb
 
 ==== Layouts
 
-(MERB_ROOT/app/views/layout/*)
+(Merb.root/app/views/layout/*)
 
 Layouts are generic templates in which your specific view templates are rendered.  A sample
 layout could look like:
@@ -198,8 +205,8 @@ layout could look like:
   </html>
 
 By default, +render+ will look for a corresponding layout for your controller in the form
-of MERB_ROOT/app/views/layout/<controller>.html.erb .  If no specific layout is present,
-+render+ will attempt to use MERB_ROOT/app/view/layout/application.html.erb
+of Merb.root/app/views/layout/<controller>.html.erb .  If no specific layout is present,
++render+ will attempt to use Merb.root/app/view/layout/application.html.erb
 
 <i>See #render for more details/options, as well as how to use different templating systems
 in your app.</i>
@@ -222,7 +229,7 @@ mongrel handles calling it in a thread safe manner.
 
 === Helpers
 
-(MERB_ROOT/app/helpers/*)
+(Merb.root/app/helpers/*)
 
 app/helpers/global_helper.rb will be available to all of your views.
  Helpers named after your controller plus _helper.rb will be included in the views
@@ -234,7 +241,7 @@ you just want to copy it to the right place on the filesystem.
 
 	def upload
 	  puts params[:file].inspect
-	  FileUtils.mv params[:file][:tempfile].path, MERB_ROOT+"/uploads/#{params[:file][:filename]}"
+	  FileUtils.mv params[:file][:tempfile].path, Merb.root+"/uploads/#{params[:file][:filename]}"
 	  render
 	end
 

data/Rakefile

@@ -1,188 +1,237 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/testtask'
-require 'spec/rake/spectask'
-require 'fileutils'
+require "rake"
+require "rake/clean"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+require "rake/testtask"
+require "spec/rake/spectask"
+require "fileutils"
+
 def __DIR__
   File.dirname(__FILE__)
 end
 
-require __DIR__+'/tools/rakehelp'
-require __DIR__+'/tools/annotation_extract'
+require __DIR__ + "/tools/rakehelp"
+require __DIR__ + "/tools/annotation_extract"
+
 include FileUtils
 
 NAME = "merb"
-require 'lib/merb/version'
-CLEAN.include ['**/.*.sw?', '*.gem', '.config']
 
+require "lib/merb/version"
+
+##############################################################################
+# Packaging & Installation
+##############################################################################
+CLEAN.include ["**/.*.sw?", "*.gem", ".config"]
 
 windows = (PLATFORM =~ /win32|cygwin/)
 
 SUDO = windows ? "" : "sudo"
 
-setup_clean [ "pkg", "lib/*.bundle", "*.gem", "doc/rdoc", ".config", 'coverage', "cache", "log"]
-
+setup_clean [ "pkg", "lib/*.bundle", "*.gem", "doc/rdoc", ".config", "coverage", "cache", "log"]
 
 desc "Packages up Merb."
-task :default => [:package]
-task :merb => [:clean, :rdoc, :package]
-
-task :doc => [:rdoc]
-
+task :default => :package
 
-Rake::RDocTask.new do |rdoc|
-      files = ['README', 'LICENSE', 'CHANGELOG',
-               'lib/**/*.rb']
-      rdoc.rdoc_files.add(files)
-      rdoc.main = 'README'
-      rdoc.title = 'Merb Docs'
-      rdoc.template = __DIR__ + '/tools/allison-2.0/lib/allison.rb'
-      rdoc.rdoc_dir = 'doc/rdoc'
-      rdoc.options << '--line-numbers' << '--inline-source'
-end
+task :merb => [:clean, :rdoc, :package]
 
 spec = Gem::Specification.new do |s|
-  s.name = NAME
-  s.version = Merb::VERSION
-  s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
-  #s.rdoc_options += RDOC_OPTS + 
-  #  ['--exclude', '^(app|uploads)']
-  s.summary = "Merb == Mongrel + Erb. Pocket rocket web framework."
-  s.description = s.summary
-  s.author = "Ezra Zygmuntowicz"
-  s.email = 'ez@engineyard.com'
-  s.homepage = 'http://merb.devjavu.com'
-  s.executables = ['merb']
-
-  s.add_dependency('mongrel')
-  s.add_dependency('erubis')
-  s.add_dependency('mime-types')
-  s.add_dependency('rubigen')
-  s.add_dependency('rake') 
-  s.add_dependency('ruby2ruby') 
-  s.add_dependency('json_pure') 
-  s.requirements << 'install the json gem to get faster json parsing'
-  s.required_ruby_version = '>= 1.8.4'
-
-  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{bin,spec,lib,examples,app_generators,merb_generators,merb_default_generators,rspec_generators,test_unit_generators,script}/**/*") 
-      
+  s.name         = NAME
+  s.version      = Merb::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.author       = "Ezra Zygmuntowicz"
+  s.email        = "ez@engineyard.com"
+  s.homepage     = "http://merb.devjavu.com"
+  s.summary      = "Merb == Mongrel + Erb. Pocket rocket web framework."
+  s.bindir       = "bin"
+  s.description  = s.summary
+  s.executables  = %w( merb )
   s.require_path = "lib"
-  s.bindir = "bin"
+  s.files        = %w( LICENSE README Rakefile TODO ) + [Merb.svn_revision_filename] + Dir["{bin,spec,lib,examples,app_generators,merb_generators,merb_default_generators,rspec_generators,test_unit_generators,script}/**/*"]
+
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w( README LICENSE TODO )
+  #s.rdoc_options     += RDOC_OPTS + ["--exclude", "^(app|uploads)"]
+
+  # Dependencies
+  s.add_dependency "mongrel"
+  s.add_dependency "erubis"
+  #s.add_dependency "haml", ">= 1.8"
+  s.add_dependency "mime-types"
+  s.add_dependency "rubigen"
+  s.add_dependency "rake"
+  s.add_dependency "ruby2ruby"
+  s.add_dependency "json_pure"
+  
+  # Requirements
+  s.requirements << "install the json gem to get faster json parsing"
+  s.required_ruby_version = ">= 1.8.4"
 end
 
-Rake::GemPackageTask.new(spec) do |p|
-  #p.need_tar = true
-  p.gem_spec = spec
+Rake::GemPackageTask.new(spec) do |package|
+  # package.need_tar = true
+  package.gem_spec = spec
 end
 
-task :install do
-  sh %{rake package}
-  sh %{#{SUDO} gem install pkg/#{NAME}-#{Merb::VERSION} --no-rdoc --no-ri}
+desc "Run :package and install the resulting .gem"
+task :install => :package do
+  sh %{#{SUDO} gem install pkg/#{NAME}-#{Merb::VERSION}.gem --no-rdoc --no-ri}
 end
 
-task :uninstall => [:clean] do
+desc "Run :clean and uninstall the .gem"
+task :uninstall => :clean do
   sh %{#{SUDO} gem uninstall #{NAME}}
 end
 
-desc "run webgen"
-task :doc_webgen do
-  sh %{cd doc/site ; webgen}
-end
+##############################################################################
+# Documentation
+##############################################################################
+task :doc => [:rdoc]
+namespace :doc do
+
+  Rake::RDocTask.new do |rdoc|
+    files = ["README", "LICENSE", "CHANGELOG", "lib/**/*.rb"]
+    rdoc.rdoc_files.add(files)
+    rdoc.main = "README"
+    rdoc.title = "Merb Docs"
+    rdoc.template = __DIR__ + "/tools/allison-2.0.2/lib/allison.rb"
+    rdoc.rdoc_dir = "doc/rdoc"
+    rdoc.options << "--line-numbers" << "--inline-source"
+  end
 
-desc "rdoc to rubyforge"
-task :doc_rforge do
-  sh %{rake doc}
-  sh %{#{SUDO} chmod -R 755 doc} unless windows
-  sh %{/usr/bin/scp -r -p doc/rdoc/* ezmobius@rubyforge.org:/var/www/gforge-projects/merb}
-end
+  desc "run webgen"
+  task :webgen do
+    sh %{cd doc/site; webgen}
+  end
+
+  desc "rdoc to rubyforge"
+  task :rubyforge do
+    # sh %{rake doc}
+    sh %{#{SUDO} chmod -R 755 doc} unless windows
+    sh %{/usr/bin/scp -r -p doc/rdoc/* ezmobius@rubyforge.org:/var/www/gforge-projects/merb}
+  end
 
-desc 'Run all specs and then rcov'
-task :aok do
-  sh %{rake specs;rake rcov}
 end
 
+##############################################################################
+# rSpec & rcov
+##############################################################################
+desc "Run :specs, :rcov"
+task :aok => [:specs, :rcov]
+
 desc "Run all specs"
-Spec::Rake::SpecTask.new('specs') do |t|
+Spec::Rake::SpecTask.new("specs") do |t|
   t.spec_opts = ["--format", "specdoc", "--colour"]
-  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+  t.spec_files = Dir["spec/**/*_spec.rb"].sort
 end
 
 desc "Run a specific spec with TASK=xxxx"
-Spec::Rake::SpecTask.new('spec') do |t|
+Spec::Rake::SpecTask.new("spec") do |t|
   t.spec_opts = ["--format", "specdoc", "--colour"]
-  t.libs = ['lib', 'server/lib' ]
-  t.spec_files = ["spec/merb/#{ENV['TASK']}_spec.rb"]
+  t.libs = ["lib", "server/lib" ]
+  t.spec_files = (ENV["TASK"] || '').split(',').map do |task|
+    "spec/merb/#{task}_spec.rb"
+  end
 end
 
 desc "Run all specs output html"
-Spec::Rake::SpecTask.new('specs_html') do |t|
+Spec::Rake::SpecTask.new("specs_html") do |t|
   t.spec_opts = ["--format", "html"]
-  t.libs = ['lib', 'server/lib' ]
-  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+  t.libs = ["lib", "server/lib" ]
+  t.spec_files = Dir["spec/**/*_spec.rb"].sort
 end
 
 desc "RCov"
-Spec::Rake::SpecTask.new('rcov') do |t|
+Spec::Rake::SpecTask.new("rcov") do |t|
+  t.rcov_opts = ["--exclude", "gems", "--exclude", "spec"]
   t.spec_opts = ["--format", "specdoc", "--colour"]
-  t.spec_files = Dir['spec/**/*_spec.rb'].sort
-  t.libs = ['lib', 'server/lib' ]
+  t.rcov_opts = ["--exclude","gems"]
+  t.spec_files = Dir["spec/**/*_spec.rb"].sort
+  t.libs = ["lib", "server/lib" ]
   t.rcov = true
 end
 
 STATS_DIRECTORIES = [
-  %w(Code               lib/),
-  %w(Unit\ tests        specs),
-].collect { |name, dir| [ name, "./#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+  ['Code', 'lib/'],
+  ['Unit tests', 'specs']
+].collect { |name, dir| [ name, "./#{dir}" ] }.
+  select  { |name, dir| File.directory?(dir) }
 
 desc "Report code statistics (KLOCs, etc) from the application"
 task :stats do
-  require __DIR__ + '/tools/code_statistics'
-  #require 'extra/stats'
+  require __DIR__ + "/tools/code_statistics"
+  # require "extra/stats"
   verbose = true
   CodeStatistics.new(*STATS_DIRECTORIES).to_s
 end
 
 task :release => :package do
-  if ENV['RELEASE']
-    sh %{rubyforge add_release merb merb "#{ENV['RELEASE']}" pkg/#{NAME}-#{Merb::VERSION}.gem}
+  if ENV["RELEASE"]
+    sh %{rubyforge add_release merb merb "#{ENV["RELEASE"]}" pkg/#{NAME}-#{Merb::VERSION}.gem}
   else
-    puts 'Usage: rake release RELEASE="Clever tag line goes here"'
+    puts "Usage: rake release RELEASE='Clever tag line goes here'"
   end
 end
 
 ##############################################################################
 # SVN
 ##############################################################################
+namespace :repo do
+
+  desc "Add new files to repository"
+  task :add do
+    if File.directory?(".git")
+      system "git add *"
+    elsif File.directory?(".svn")
+      system "svn status | grep '^\?' | sed -e 's/? *//' | sed -e 's/ /\ /g' | xargs svn add"
+    end
+  end
 
-desc "Add new files to subversion"
-task :svn_add do
-   system "svn status | grep '^\?' | sed -e 's/? *//' | sed -e 's/ /\ /g' | xargs svn add"
+  desc "Fetch changes from master repository"
+  task :rebase do
+    if File.directory?(".git")
+      system "git stash ; git svn rebase ; git stash apply"
+    elsif File.directory?(".svn")
+      system "svn update"
+    end
+  end
+  
+  desc "commit modified changes to the repository"
+  task :commit do
+    if File.directory?(".git")
+      system "git commit"
+    elsif File.directory?(".svn")
+      system "svn commit"
+    end
+  end
+  
 end
 
-
-# Run specific tests or test files
+# Run specific tests or test files. Searches nested spec directories as well.
 # 
 # Based on a technique popularized by Geoffrey Grosenbach
 rule "" do |t|
-  spec_cmd = (RUBY_PLATFORM =~ /java/) ? 'jruby -S spec' : 'spec'
+  spec_cmd = (RUBY_PLATFORM =~ /java/) ? "jruby -S spec" : "spec"
   # spec:spec_file:spec_name
   if /spec:(.*)$/.match(t.name)
-    arguments = t.name.split(":")
+    arguments = t.name.split(':')
+    
     file_name = arguments[1]
     spec_name = arguments[2..-1]
 
-    if File.exist?("spec/merb/#{file_name}_spec.rb")
-      run_file_name = "spec/merb/#{file_name}_spec.rb" 
-    end
+    spec_filename = "#{file_name}_spec.rb"
+    specs = Dir["spec/merb/**/#{spec_filename}"]
     
-    example = !spec_name.empty? ? " -e '#{spec_name}'" : ""
+    if path = specs.detect { |f| spec_filename == File.basename(f) }
+      run_file_name = path
+    else
+      puts "No specs found for #{t.name.inspect}"
+      exit
+    end
 
-    sh "#{spec_cmd} #{run_file_name} --format specdoc --colour #{example}" 
+    example = " -e '#{spec_name}'" unless spec_name.empty?
+    
+    sh "#{spec_cmd} #{run_file_name} --format specdoc --colour #{example}"
   end
 end
-
-