merb-core 0.9.3 → 0.9.4

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Ezra Zygmuntowicz
+Copyright (c) 2008 Engine Yard Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README

@@ -15,7 +15,7 @@ Goals of this release:
   
 To familiarize yourself with how a merb-core application might look,
 use merb-gen (from merb-more) to generate a few apps:
-$ merb-gen myapp                   # a "normal" merb app
-$ merb-gen myapp --flat            # a flattened app
-$ merb-gen myapp --very-flat       # a single-file app
+$ merb-gen app myapp                   # a "normal" merb app
+$ merb-gen app myapp --flat            # a flattened app
+$ merb-gen app myapp --very-flat       # a single-file app
 

data/Rakefile

@@ -5,6 +5,7 @@ require "rake/rdoctask"
 require "rake/testtask"
 require "spec/rake/spectask"
 require "fileutils"
+require "extlib"
 
 def __DIR__
   File.dirname(__FILE__)
@@ -15,35 +16,39 @@ require __DIR__ + "/tools/annotation_extract"
 
 include FileUtils
 
-NAME = "merb-core"
-
 require "lib/merb-core/version"
 require "lib/merb-core/test/run_specs"
+require 'lib/merb-core/tasks/merb_rake_helper'
 
 ##############################################################################
-# Packaging & Installation
+# Package && release
 ##############################################################################
-CLEAN.include ["**/.*.sw?", "pkg", "lib/*.bundle", "*.gem", "doc/rdoc", ".config", "coverage", "cache"]
+RUBY_FORGE_PROJECT  = "merb"
+PROJECT_URL         = "http://merbivore.com"
+PROJECT_SUMMARY     = "Merb. Pocket rocket web framework."
+PROJECT_DESCRIPTION = PROJECT_SUMMARY
 
-windows = (PLATFORM =~ /win32|cygwin/) rescue nil
+AUTHOR = "Ezra Zygmuntowicz"
+EMAIL  = "ez@engineyard.com"
 
-SUDO = windows ? "" : "sudo"
+GEM_NAME    = "merb-core"
+PKG_BUILD   = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+GEM_VERSION = Merb::VERSION + PKG_BUILD
 
-desc "Packages up Merb."
-task :default => :package
+RELEASE_NAME    = "REL #{GEM_VERSION}"
 
-task :merb => [:clean, :rdoc, :package]
+require "extlib/tasks/release"
 
 spec = Gem::Specification.new do |s|
-  s.name         = NAME
-  s.version      = Merb::VERSION
+  s.name         = GEM_NAME
+  s.version      = GEM_VERSION
   s.platform     = Gem::Platform::RUBY
-  s.author       = "Ezra Zygmuntowicz"
-  s.email        = "ez@engineyard.com"
-  s.homepage     = "http://merbivore.com"
-  s.summary      = "Merb. Pocket rocket web framework."
+  s.author       = AUTHOR
+  s.email        = EMAIL
+  s.homepage     = PROJECT_URL
+  s.summary      = PROJECT_SUMMARY
   s.bindir       = "bin"
-  s.description  = s.summary
+  s.description  = PROJECT_DESCRIPTION
   s.executables  = %w( merb )
   s.require_path = "lib"
   s.files        = %w( LICENSE README Rakefile TODO ) + Dir["{docs,bin,spec,lib,examples,app_generators,merb_generators,merb_default_generators,rspec_generators,test_unit_generators,script}/**/*"]
@@ -54,16 +59,16 @@ spec = Gem::Specification.new do |s|
   #s.rdoc_options     += RDOC_OPTS + ["--exclude", "^(app|uploads)"]
 
   # Dependencies
+  s.add_dependency "extlib", ">=0.9.3"
   s.add_dependency "erubis"
   s.add_dependency "rake"
   s.add_dependency "json_pure"
   s.add_dependency "rspec"
   s.add_dependency "rack"
-  s.add_dependency "hpricot"
   s.add_dependency "mime-types"
   # Requirements
   s.requirements << "install the json gem to get faster json parsing"
-  s.required_ruby_version = ">= 1.8.4"
+  s.required_ruby_version = ">= 1.8.6"
 end
 
 Rake::GemPackageTask.new(spec) do |package|
@@ -72,32 +77,42 @@ end
 
 desc "Run :package and install the resulting .gem"
 task :install => :package do
-  sh %{#{SUDO} gem install --local pkg/#{NAME}-#{Merb::VERSION}.gem --no-rdoc --no-ri}
+  sh %{#{sudo} gem install #{install_home} --local pkg/#{GEM_NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
 end
 
 desc "Run :package and install the resulting .gem with jruby"
 task :jinstall => :package do
-  sh %{#{SUDO} jruby -S gem install pkg/#{NAME}-#{Merb::VERSION}.gem --no-rdoc --no-ri}
+  sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{NAME}-#{Merb::VERSION}.gem --no-rdoc --no-ri}
 end
 
 desc "Run :clean and uninstall the .gem"
 task :uninstall => :clean do
-  sh %{#{SUDO} gem uninstall #{NAME}}
+  sh %{#{sudo} gem uninstall #{NAME}}
 end
 
+CLEAN.include ["**/.*.sw?", "pkg", "lib/*.bundle", "*.gem", "doc/rdoc", ".config", "coverage", "cache"]
+
+desc "Run the specs."
+task :default => :specs
+
+task :merb => [:clean, :rdoc, :package]
+
+##############################################################################
+# Github
+##############################################################################
 namespace :github do
   desc "Update Github Gemspec"
   task :update_gemspec do
     skip_fields = %w(new_platform original_platform)
     integer_fields = %w(specification_version)
-    
+
     result = "Gem::Specification.new do |s|\n"
-    spec.instance_variables.each do |ivar| 
+    spec.instance_variables.each do |ivar|
       value = spec.instance_variable_get(ivar)
       name  = ivar.split("@").last
       next if skip_fields.include?(name) || value.nil? || value == "" || (value.respond_to?(:empty?) && value.empty?)
       if name == "dependencies"
-        value.each do |d| 
+        value.each do |d|
           dep, *ver = d.to_s.split(" ")
           result <<  "  s.add_dependency #{dep.inspect}, #{ver.join(" ").inspect.gsub(/[()]/, "")}\n"
         end
@@ -143,7 +158,7 @@ namespace :doc do
   desc "rdoc to rubyforge"
   task :rubyforge do
     # sh %{rake doc}
-    sh %{#{SUDO} chmod -R 755 doc} unless windows
+    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
 
@@ -255,14 +270,6 @@ task :stats do
   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}
-  else
-    puts "Usage: rake release RELEASE='Clever tag line goes here'"
-  end
-end
-
 ##############################################################################
 # SYNTAX CHECKING
 ##############################################################################
@@ -306,6 +313,68 @@ namespace :repo do
 
 end
 
+def git_log(since_release = nil, log_format = "format:%an")
+  git_log_query = "git log --pretty='format:#{log_format}' --no-merges"
+  git_log_query << " --since='#{since_release}'" if since_release
+  puts
+  puts "Running #{git_log_query}"
+  puts
+  `#{git_log_query}`
+end
+
+def contributors(since_release = nil)
+  @merb_contributors ||= git_log(since_release).split("\n").uniq.sort
+end
+
+PREVIOUS_RELEASE = '0.9.3'
+namespace :history do
+  namespace :update do
+    desc "updates contributors list"
+    task :contributors do
+      list = contributors.join "\n"
+
+      path = File.join(File.dirname(__FILE__), 'CONTRIBUTORS')
+
+      rm path if File.exists?(path)
+
+      puts "Writing contributors (#{contributors.size} entries)."
+      # windows needs wb
+      File.open(path, "wb") do |io|
+        io << "Use #{RUBY_FORGE_PROJECT}? Say thanks the following people:\n\n"
+        io << list
+      end
+    end
+  end
+
+  
+  namespace :alltime do
+    desc 'shows all-time committers'
+    task :contributors do
+      puts 'All-time contributors (#{contributors.size} total): '
+      puts '=============================='
+      puts
+      puts contributors.join("\n")
+    end
+  end
+  
+  namespace :current_release do
+    desc "show changes since previous release"
+    task :changes do
+      puts git_log(PREVIOUS_RELEASE, "format:* %s")
+    end
+
+
+    desc 'shows current release committers'
+    task :contributors do
+      puts "Current release contributors (#{contributors.size} total): "
+      puts '=============================='
+      puts
+      puts contributors(PREVIOUS_RELEASE).join("\n")
+    end
+  end
+end
+
+
 # Run specific tests or test files. Searches nested spec directories as well.
 #
 # Based on a technique popularized by Geoffrey Grosenbach
@@ -333,3 +402,45 @@ rule "" do |t|
     sh "#{spec_cmd} #{run_file_name} --format specdoc --colour #{example}"
   end
 end
+
+##############################################################################
+# Flog
+##############################################################################
+
+namespace :flog do
+  task :worst_methods do
+    require "flog"
+    flogger = Flog.new
+    flogger.flog_files Dir["lib/**/*.rb"]
+    totals = flogger.totals.sort_by {|k,v| v}.reverse[0..10]
+    totals.each do |meth, total|
+      puts "%50s: %s" % [meth, total]
+    end
+  end
+  
+  task :total do
+    require "flog"
+    flogger = Flog.new
+    flogger.flog_files Dir["lib/**/*.rb"]
+    puts "Total: #{flogger.total}"
+  end
+  
+  task :per_method do
+    require "flog"
+    flogger = Flog.new
+    flogger.flog_files Dir["lib/**/*.rb"]
+    methods = flogger.totals.reject { |k,v| k =~ /\#none$/ }.sort_by { |k,v| v }
+    puts "Total Flog:    #{flogger.total}"
+    puts "Total Methods: #{flogger.totals.size}"
+    puts "Flog / Method: #{flogger.total / methods.size}"
+  end
+end
+
+namespace :tools do
+  namespace :tags do
+    desc "Generates Emacs tags using Exuberant Ctags."
+    task :emacs do
+      sh "ctags -e --Ruby-kinds=-f -o TAGS -R lib"
+    end
+  end
+end

data/docs/bootloading.dox

@@ -55,3 +55,4 @@ deflist: MimeTypes.
 \:xml: to_xml, application/xml or text/xml or application/x-xml, adds "Encoding: UTF-8" response header
 \:js: to_json, text/javascript ot application/javascript or application/x-javascript
 \:json: to_json, application/json or text/x-json
+

data/lib/merb-core.rb

@@ -4,15 +4,70 @@ require 'rubygems'
 require 'set'
 require 'fileutils'
 require 'socket'
+require 'pathname'
+require "extlib"
 
-$LOAD_PATH.unshift File.dirname(__FILE__) unless
-  $LOAD_PATH.include?(File.dirname(__FILE__)) ||
-  $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+__DIR__ = File.dirname(__FILE__)
+
+$LOAD_PATH.unshift __DIR__ unless
+  $LOAD_PATH.include?(__DIR__) ||
+  $LOAD_PATH.include?(File.expand_path(__DIR__))
+
+require 'merb-core' / 'vendor' / 'facets'
 
 module Merb
   module GlobalHelpers; end
   class << self
 
+    # Merge environment settings
+    # Can allow you to have a "localdev" that runs like your "development"
+    #   OR
+    # A "staging" environment that runs like your "production"
+    #
+    # ==== Examples
+    # From any environment config file (ie, development.rb, custom.rb, localdev.rb, etc)
+    #   staging.rb:
+    #     Merb.merge_env "production"         #We want to use all the settings production uses
+    #     Merb::Config.use { |c|
+    #       c[:log_level]         = "debug"   #except we want debug log level
+    #       c[:exception_details] = true      #and we want to see exception details
+    #     }
+    #
+    # ==== Parameters
+    # env<~String>:: Environment to run like
+    # use_db<~Boolean>:: Should Merb use the merged environments DB connection
+    #     Defaults to +false+
+    def merge_env(env,use_db=false)
+      if Merb.environment_info.nil?
+        Merb.environment_info = {
+          :real_env => Merb.environment,
+          :merged_envs => [],
+          :db_env => Merb.environment
+        }
+      end
+      
+      #Only load if it hasn't been loaded
+      unless Merb.environment_info[:merged_envs].member? env
+        Merb.environment_info[:merged_envs] << env
+        
+        env_file = Merb.dir_for(:config) / "environments" / ("#{env}.rb")
+        if File.exists?(env_file)
+          load(env_file)
+        else
+          Merb.logger.warn! "Environment file does not exist! #{env_file}"
+        end
+        
+      end
+      
+      # Mark specific environment to load when ORM loads,
+      # if multiple environments are loaded, the last one
+      # with use_db as TRUE will be loaded
+      if use_db
+        Merb.environment_info[:db_env] = env
+      end
+    end
+
+
     # Startup Merb by setting up the Config and starting the server.
     # This is where Merb application environment and root path are set.
     #
@@ -59,11 +114,12 @@ module Merb
       start_environment(Merb::Config.to_hash.merge(argv))
     end
 
-    attr_accessor :environment, :load_paths, :adapter
+    attr_accessor :environment, :load_paths, :adapter, :environment_info, :started
 
     alias :env :environment
+    alias :started? :started
 
-    Merb.load_paths = Hash.new { [Merb.root] } unless Merb.load_paths.is_a?(Hash)
+    Merb.load_paths = Dictionary.new { [Merb.root] } unless Merb.load_paths.is_a?(Dictionary)
 
     # This is the core mechanism for setting up your application layout.
     # There are three application layouts in Merb:
@@ -103,10 +159,10 @@ module Merb
     # uses to simplify transition of legacy application, you can
     # set it up like this:
     #
-    # Merb.push_path(:models,      Merb.root / "app" / "models",      "**/*.rb")
-    # Merb.push_path(:mailers,     Merb.root / "app" / "models",      "**/*.rb")
-    # Merb.push_path(:controllers, Merb.root / "app" / "controllers", "**/*.rb")
-    # Merb.push_path(:views,       Merb.root / "app" / "views",       "**/*.rb")
+    # Merb.push_path(:model,      Merb.root / "app" / "models",      "**/*.rb")
+    # Merb.push_path(:mailer,     Merb.root / "app" / "models",      "**/*.rb")
+    # Merb.push_path(:controller, Merb.root / "app" / "controllers", "**/*.rb")
+    # Merb.push_path(:view,       Merb.root / "app" / "views",       "**/*.rb")
     #
     # ==== Parameters
     # type<Symbol>:: The type of path being registered (i.e. :view)
@@ -116,7 +172,7 @@ module Merb
     #   "**/*.rb".
     def push_path(type, path, file_glob = "**/*.rb")
       enforce!(type => Symbol)
-      load_paths[type] = [path, file_glob]
+      load_paths[type] = [Pathname.new(path), file_glob]
     end
 
     # Removes given types of application components
@@ -132,8 +188,8 @@ module Merb
     # application components.
     #
     # Merb.root = "path/to/legacy/app/root"
-    # Merb.remove_paths(:mailers)
-    # Merb.push_path(:mailers,     Merb.root / "app" / "models",      "**/*.rb")
+    # Merb.remove_paths(:mailer)
+    # Merb.push_path(:mailer,     Merb.root / "app" / "models",      "**/*.rb")
     #
     # Will make Merb use app/models for mailers just like Ruby on Rails does.
     def remove_paths(*args)
@@ -145,22 +201,32 @@ module Merb
     #
     # ==== Returns
     # String:: The directory for the requested type.
-    def dir_for(type)  Merb.load_paths[type].first end
+    def dir_for(type)
+      Merb.load_paths[type].first
+    end
 
     # ==== Parameters
     # type<Symbol>:: The type of path to retrieve glob for, e.g. :view.
     #
     # ===== Returns
     # String:: The pattern with which to match files within the type directory.
-    def glob_for(type) Merb.load_paths[type][1]    end
+    def glob_for(type)
+      Merb.load_paths[type][1]
+    end
 
     # ==== Returns
     # String:: The Merb root path.
-    def root()          @root || Merb::Config[:merb_root] || Dir.pwd  end
+    def root
+      app_root = @root || Merb::Config[:merb_root] || Dir.pwd
+
+      Pathname.new(app_root)
+    end
 
     # ==== Parameters
     # value<String>:: Path to the root directory.
-    def root=(value)    @root = value                                 end
+    def root=(value)
+      @root = Pathname.new(value)
+    end
 
     # ==== Parameters
     # *path::
@@ -176,7 +242,9 @@ module Merb
     #   Merb.path("views", "admin") # => "/home/merb/app/views/admin"
     #---
     # @public
-    def root_path(*path) File.join(root, *path)                       end
+    def root_path(*path)
+      Pathname.new(File.join(root, *path))
+    end
 
     # Logger settings
     attr_accessor :logger
@@ -200,15 +268,19 @@ module Merb
     # ==== Returns
     # String:: Path to directory that contains the log file.
     def log_path
-      case Merb::Config[:log_file]
+      path = case Merb::Config[:log_file]
       when String then File.dirname(Merb::Config[:log_file])
       else Merb.root_path("log")
       end
+
+      Pathname.new(path)
     end
 
     # ==== Returns
     # String:: The path of root directory of the Merb framework.
-    def framework_root()  @framework_root ||= File.dirname(__FILE__)  end
+    def framework_root
+      @framework_root ||= Pathname(File.dirname(__FILE__))
+    end
 
     # ==== Returns
     # RegExp::
@@ -245,8 +317,35 @@ module Merb
     end
 
     # Set up default variables under Merb
-    attr_accessor :generator_scope, :klass_hashes
-    Merb.generator_scope = [:merb_default, :merb, :rspec]
+    attr_accessor :generator_scope, :klass_hashes, :orm_generator_scope, :test_framework_generator_scope
+
+    # Returns registered ORM generators as symbols,
+    # for instance, :datamapper.
+    #
+    # ==== Returns
+    # <Array(Symbol>:: registered ORM generators.
+    def orm_generator_scope
+      @orm_generator_scope ||= :merb_default
+    end
+
+    # Returns registered test framework generators.
+    #
+    # ==== Returns
+    # <Array(Symbol>:: registred test framework generators.
+    def test_framework_generator_scope
+      @test_framework_generator_scope ||= :rspec
+    end
+
+    # Returns all registered generators plus Merb generator.
+    #
+    # ==== Returns
+    # <Array(Symbol>::
+    #   all registered generators, inc. needed by Merb itself.
+    def generator_scope
+      [:merb, orm_generator_scope, test_framework_generator_scope]
+    end
+
+
     Merb.klass_hashes = []
 
     attr_reader :registered_session_types
@@ -270,7 +369,7 @@ module Merb
     attr_accessor :frozen
 
     # ==== Returns
-    # Boolean:: True if Merb is running via script/frozen-merb or other freezer.
+    # Boolean:: True if Merb is running via merb-freezer or other freezer.
     #
     # ==== Notes
     # Freezing means bundling framework libraries with your application
@@ -282,7 +381,7 @@ module Merb
       @frozen
     end
 
-    # Used by script/frozen-merb and other freezers to mark Merb as frozen.
+    # Used by merb-freezer and other freezers to mark Merb as frozen.
     # See Merb::GlobalHelpers.frozen? for more details on framework freezing.
     def frozen!
       @frozen = true
@@ -322,6 +421,9 @@ module Merb
     # :session_id_key<String>::   session identifier,
     #                             default is _session_id
     #
+    # :session_store<String>::    session store to use (one of cookies,
+    #                             memcache or memory)
+    #
     # :log_delimiter<String>::    what Merb logger uses as delimiter
     #                             between message sections, default is " ~ "
     #
@@ -352,6 +454,10 @@ module Merb
     end
 
     # Load all basic dependencies (selected BootLoaders only).
+    # This sets up Merb framework component paths
+    # (directories for models, controllers, etc) using
+    # framework.rb or default layout, loads init file
+    # and dependencies specified in it and runs before_app_loads hooks.
     #
     # ==== Parameters
     # options<Hash>:: Options to pass on to the Merb config.
@@ -359,7 +465,7 @@ module Merb
       load_config(options)
       Merb::BootLoader::BuildFramework.run
       Merb::BootLoader::Dependencies.run
-      Merb::BootLoader::BeforeAppRuns.run
+      Merb::BootLoader::BeforeAppLoads.run
     end
 
     # Reload application and framework classes.
@@ -422,7 +528,7 @@ module Merb
     # ==== Parameters
     # *args:: One or more symbols of Merb internal components.
     def disable(*components)
-      disabled_components.push *components
+      disabled_components.push(*components)
     end
 
     # ==== Parameters
@@ -450,7 +556,17 @@ module Merb
     # Recommended way to find out what paths Rakefiles
     # are loaded from.
     def rakefiles
-      @rakefiles ||= ['merb-core/test/tasks/spectasks']
+      @rakefiles ||= ['merb-core' / 'test' / 'tasks' / 'spectasks']
+    end
+    
+    # === Returns
+    # Array(String):: Paths generators are loaded from
+    #
+    # === Notes
+    # Recommended way to find out what paths generators
+    # are loaded from.
+    def generators
+      @generators ||= []
     end
 
     # ==== Parameters
@@ -459,23 +575,29 @@ module Merb
     # ==== Notes
     # Recommended way to add Rakefiles load path for plugins authors.
     def add_rakefiles(*rakefiles)
-      @rakefiles ||= ['merb-core/test/tasks/spectasks']
+      @rakefiles ||= ['merb-core' / 'test' / 'tasks' / 'spectasks']
       @rakefiles += rakefiles
     end
-
-
-
+    
+    # ==== Parameters
+    # *generators:: Generator paths to add to the list of generators.
+    #
+    # ==== Notes
+    # Recommended way to add Generator load paths for plugin authors.
+    def add_generators(*generators)
+      @generators ||= []
+      @generators += generators
+    end
 
   end
 end
 
-require 'merb-core/autoload'
-require 'merb-core/server'
-require 'merb-core/gem_ext/erubis'
-require 'merb-core/logger'
-require 'merb-core/version'
-require 'merb-core/controller/mime'
-require 'merb-core/vendor/facets'
+require 'merb-core' / 'autoload'
+require 'merb-core' / 'server'
+require 'merb-core' / 'gem_ext/erubis'
+require 'merb-core' / 'logger'
+require 'merb-core' / 'version'
+require 'merb-core' / 'controller/mime'
 
 # Set the environment if it hasn't already been set.
 Merb.environment ||= ENV['MERB_ENV'] || Merb::Config[:environment] || (Merb.testing? ? 'test' : 'development')