merb-gen 0.9.3 → 0.9.4

data/{app_generators/merb/templates → lib/generators/templates/application/merb}/autotest/merb.rb

@@ -9,7 +9,7 @@ class Autotest::Merb < Autotest
   # +fixtures_dir+::         the directory to find fixtures in
   attr_accessor :model_tests_dir, :controller_tests_dir, :view_tests_dir, :fixtures_dir
   
-  def initialize # :nodoc:
+  def initialize
     super
     
     initialize_test_layout
@@ -127,7 +127,7 @@ private
   #   => "login_controller_test.rb"
   #   > test_for("form", :view)
   #   => "form_view_spec.rb" # If you're running a RSpec-like suite
-  def test_for(filename, kind_of_test) # :nodoc:
+  def test_for(filename, kind_of_test)
     name  = [filename]
     name << kind_of_test.to_s if kind_of_test == :view
     name << "test"

data/lib/generators/templates/application/merb/autotest/merb_rspec.rb

@@ -0,0 +1,166 @@
+# Adapted from Autotest::Rails, RSpec's autotest class, as well as merb-core's.
+require 'autotest'
+
+class RspecCommandError < StandardError; end
+
+# This class maps your application's structure so Autotest can understand what 
+# specs to run when files change.
+#
+# Fixtures are _not_ covered by this class. If you change a fixture file, you 
+# will have to run your spec suite manually, or, better yet, provide your own 
+# Autotest map explaining how your fixtures are set up.
+class Autotest::MerbRspec < Autotest
+  def initialize
+    super
+
+    # Ignore any happenings in these directories
+    add_exception %r%^\./(?:doc|log|public|tmp)%
+
+    # Ignore SCM directories and custom Autotest mappings
+    %w[.svn .hg .git .autotest].each { |exception| add_exception(exception) }
+
+    # Ignore any mappings that Autotest may have already set up
+    clear_mappings
+
+    # Anything in /lib could have a spec anywhere, if at all. So, look for
+    # files with roughly the same name as the file in /lib
+    add_mapping %r%^lib\/(.*)\.rb% do |_, m|
+      files_matching %r%^spec\/#{m[1]}%
+    end
+
+    add_mapping %r%^spec/(spec_helper|shared/.*)\.rb$% do
+      all_specs
+    end
+
+    # Changing a spec will cause it to run itself
+    add_mapping %r%^spec/.*\.rb$% do |filename, _|
+      filename
+    end
+
+    # Any change to a model will cause it's corresponding test to be run
+    add_mapping %r%^app/models/(.*)\.rb$% do |_, m|
+      spec_for(m[1], 'model')
+    end
+
+    # Any change to global_helpers will result in all view and controller
+    # tests being run
+    add_mapping %r%^app/helpers/global_helpers\.rb% do
+      files_matching %r%^spec/(views|controllers|helpers)/.*_spec\.rb$%
+    end
+
+    # Any change to a helper will cause its spec to be run
+    add_mapping %r%^app/helpers/((.*)_helper(s)?)\.rb% do |_, m|
+      spec_for(m[1], 'helper')
+    end
+
+    # Changes to a view cause its spec to be run
+    add_mapping %r%^app/views/(.*)/% do |_, m|
+      spec_for(m[1], 'view')
+    end
+
+    # Changes to a controller result in its corresponding spec being run. If
+    # the controller is the exception or application controller, all
+    # controller specs are run.
+    add_mapping %r%^app/controllers/(.*)\.rb$% do |_, m|
+      if ["application", "exception"].include?(m[1])
+        files_matching %r%^spec/controllers/.*_spec\.rb$%
+      else
+        spec_for(m[1], 'controller')
+      end
+    end
+
+    # If a change is made to the router, run controller, view and helper specs
+    add_mapping %r%^config/router.rb$% do
+      files_matching %r%^spec/(controllers|views|helpers)/.*_spec\.rb$%
+    end
+
+    # If any of the major files governing the environment are altered, run
+    # everything
+    add_mapping %r%^config/(init|rack|environments/test).*\.rb|database\.yml% do 
+      all_specs
+    end
+  end
+
+  def failed_results(results)
+    results.scan(/^\d+\)\n(?:\e\[\d*m)?(?:.*?Error in )?'([^\n]*)'(?: FAILED)?(?:\e\[\d*m)?\n(.*?)\n\n/m)
+  end
+
+  def handle_results(results)
+    @failures      = failed_results(results)
+    @files_to_test = consolidate_failures(@failures)
+    @files_to_test.empty? && !$TESTING ? hook(:green) : hook(:red)
+    @tainted = !@files_to_test.empty?
+  end
+
+  def consolidate_failures(failed)
+    filters = Hash.new { |h,k| h[k] = [] }
+    failed.each do |spec, failed_trace|
+      if f = test_files_for(failed).find { |f| f =~ /spec\// }
+        filters[f] << spec
+        break
+      end
+    end
+    filters
+  end
+
+  def make_test_cmd(specs_to_runs)
+    [
+      ruby,
+      "-S",
+      spec_command,
+      add_options_if_present,
+      files_to_test.keys.flatten.join(' ')
+    ].join(' ')
+  end
+
+  def add_options_if_present
+    File.exist?("spec/spec.opts") ? "-O spec/spec.opts " : ""
+  end
+
+  # Finds the proper spec command to use. Precendence is set in the
+  # lazily-evaluated method spec_commands.  Alias + Override that in
+  # ~/.autotest to provide a different spec command then the default
+  # paths provided.
+  def spec_command(separator=File::ALT_SEPARATOR)
+    unless defined?(@spec_command)
+      @spec_command = spec_commands.find { |cmd| File.exists?(cmd) }
+
+      raise RspecCommandError, "No spec command could be found" unless @spec_command
+
+      @spec_command.gsub!(File::SEPARATOR, separator) if separator
+    end
+    @spec_command
+  end
+
+  # Autotest will look for spec commands in the following
+  # locations, in this order:
+  #
+  #   * default spec bin/loader installed in Rubygems
+  #   * any spec command found in PATH
+  def spec_commands
+    [File.join(Config::CONFIG['bindir'], 'spec'), 'spec']
+  end
+
+private
+
+  # Runs +files_matching+ for all specs
+  def all_specs
+    files_matching %r%^spec/.*_spec\.rb$%
+  end
+
+  # Generates a path to some spec given its kind and the match from a mapping
+  #
+  # ==== Arguments
+  # match<String>:: the match from a mapping
+  # kind<String>:: the kind of spec that the match represents
+  #
+  # ==== Returns
+  # String
+  #
+  # ==== Example
+  #   > spec_for('post', :view')
+  #   => "spec/views/post_spec.rb"
+  def spec_for(match, kind)
+    File.join("spec", kind + 's', "#{match}_spec.rb")
+  end
+end

data/{app_generators/merb/templates → lib/generators/templates/application/merb}/config/init.rb

@@ -10,11 +10,11 @@
 # ==== Set up load paths
 #
 
-# Make the app's "gems" directory a place where gems are loaded from.
-# Note that gems directory must have a structure RubyGems uses for
+# Add the app's "gems" directory to the gem load path.
+# Note that the gems directory must mirror the structure RubyGems uses for
 # directories under which gems are kept.
 #
-# To conveniently set it up use gem install -i <merb_app_root/gems>
+# To conveniently set it up, use gem install -i <merb_app_root/gems>
 # when installing gems. This will set up the structure under /gems
 # automagically.
 #
@@ -24,10 +24,10 @@
 # application to be deployment environment independent. To do so,
 # install gems into merb_app_root/gems directory like this:
 #
-# gem install -i ~/dev/merbapp/gems activesupport-post-2.0.2gem activerecord-post-2.0.2.gem
+# gem install -i merb_app_root/gems activesupport-post-2.0.2.gem activerecord-post-2.0.2.gem
 #
 # Since RubyGems will search merb_app_root/gems for dependencies, order
-# in statement above is important: we need to install ActiveSupport which
+# in the statement above is important: we need to install ActiveSupport which
 # ActiveRecord depends on first.
 #
 # Remember that bundling of dependencies as gems with your application
@@ -41,15 +41,12 @@ Gem.path.unshift(Merb.root / "gems")
 # uncomment this.
 # Merb.push_path(:lib, Merb.root / "lib") # uses **/*.rb as path glob.
 
-<% require 'sha1' %>
-
-
 # ==== Dependencies
 
 # These are some examples of how you might specify dependencies.
-# Dependencies load is delayed to one of later Merb app
-# boot stages. It may be important when
-# later part of your configuration relies on libraries specified
+# Dependency loading is delayed to a later Merb app
+# boot stage, but it may be important when
+# another part of your configuration relies on libraries specified
 # here.
 #
 # dependencies "RedCloth", "merb_helpers"
@@ -72,48 +69,62 @@ end
 # if you need a database.
 
 # Uncomment for DataMapper ORM
-<%= "# " unless default_orm?(:datamapper) %>use_orm :datamapper
+<%= "# " unless orm == :datamapper %>use_orm :datamapper
 
 # Uncomment for ActiveRecord ORM
-<%= "# " unless default_orm?(:activerecord) %>use_orm :activerecord
+<%= "# " unless orm == :activerecord %>use_orm :activerecord
 
 # Uncomment for Sequel ORM
-<%= "# " unless default_orm?(:sequel) %>use_orm :sequel
+<%= "# " unless orm == :sequel %>use_orm :sequel
 
 
 #
 # ==== Pick what you test with
 #
 
-# This defines which test framework the generators will use
-# rspec is turned on by default
+# This defines which test framework the generators will use.
+# RSpec is turned on by default.
 #
-# Note that you need to install the merb_rspec if you want to ue
-# rspec and merb_test_unit if you want to use test_unit.
-# merb_rspec is installed by default if you did gem install
-# merb.
+# To use Test::Unit, you need to install the merb_test_unit gem.
+# To use RSpec, you don't have to install any additional gems, since
+# merb-core provides support for RSpec.
 #
-<%= "# " unless default_test_suite?(:test) %>use_test :test_unit
-<%= "# " unless default_test_suite?(:spec) %>use_test :rspec
-
+<%= "# " unless testing_framework == :test_unit %>use_test :test_unit
+<%= "# " unless testing_framework == :rspec %>use_test :rspec
 
 #
 # ==== Set up your basic configuration
 #
+
+# IMPORTANT:
+#
+# early on Merb boot init file is not yet loaded.
+# Thus setting PORT, PID FILE and ADAPTER using init file does not
+# make sense and only can lead to confusion because default settings
+# will be used instead.
+#
+# Please use command line options for them.
+# See http://wiki.merbivore.com/pages/merb-core-boot-process
+# if you want to know more.
 Merb::Config.use do |c|
 
-  # Sets up a custom session id key, if you want to piggyback sessions of other applications
-  # with the cookie session store. If not specified, defaults to '_session_id'.
+  # Sets up a custom session id key which is used for the session persistence
+  # cookie name.  If not specified, defaults to '_session_id'.
   # c[:session_id_key] = '_session_id'
-
+  
+  # The session_secret_key is only required for the cookie session store.
   c[:session_secret_key]  = '<%= SHA1.new(rand(100000000000).to_s).to_s %>'
+  
+  # There are various options here, by default Merb comes with 'cookie', 
+  # 'memory' or 'memcached'.  You can of course use your favorite ORM 
+  # instead: 'datamapper', 'sequel' or 'activerecord'.
   c[:session_store] = 'cookie'
 end
 
 
 # ==== Tune your inflector
 
-# To fine tune your inflector use word, singular_word and plural_word
+# To fine tune your inflector use the word, singular_word and plural_word
 # methods of Language::English::Inflector module metaclass.
 #
 # Here we define erratum/errata exception case:

data/lib/generators/templates/application/merb/config/rack.rb

@@ -0,0 +1,12 @@
+
+# use PathPrefix Middleware if :path_prefix is set in Merb::Config
+if prefix = ::Merb::Config[:path_prefix]
+  use Merb::Rack::PathPrefix, prefix
+end
+
+# comment this out if you are running merb behind a load balancer
+# that serves static files
+use Merb::Rack::Static, Merb.dir_for(:public)
+
+# this is our main merb application
+run Merb::Rack::Application.new

data/{app_generators/merb/templates → lib/generators/templates/application/merb}/spec/spec_helper.rb

@@ -1,7 +1,9 @@
 require 'rubygems'
 require 'merb-core'
-require 'spec' # Satiates Autotest and anyone else not using the Rake tasks
+require 'spec' # Satisfies Autotest and anyone else not using the Rake tasks
 
+# this loads all plugins required in your init file so don't add them
+# here again, Merb will do it for you
 Merb.start_environment(:testing => true, :adapter => 'runner', :environment => ENV['MERB_ENV'] || 'test')
 
 Spec::Runner.configure do |config|

data/lib/generators/templates/application/merb_flat/config/framework.rb

@@ -0,0 +1,7 @@
+Merb::Config[:framework] = {
+  :application => Merb.root / "application.rb",
+  :config => [Merb.root / "config", nil],
+  :public => [Merb.root / "public", nil],
+  :view   => Merb.root / "views"
+}
+

data/{app_generators/merb_flat/templates → lib/generators/templates/application/merb_flat}/config/init.rb

@@ -4,7 +4,6 @@ Merb::Router.prepare do |r|
   r.default_routes
 end
 
-<% require 'sha1' %>
 Merb::Config.use { |c|
   c[:environment]         = 'production',
   c[:framework]           = {},

data/lib/generators/templates/application/merb_plugin/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'merb-core/version'
+require 'merb-core/tasks/merb_rake_helper'
+
+NAME = "<%= base_name %>"
+GEM_VERSION = "0.0.1"
+AUTHOR = "Your Name"
+EMAIL = "Your Email"
+HOMEPAGE = "http://merbivore.com/"
+SUMMARY = "Merb plugin that provides ..."
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= <%= Merb::VERSION %>')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec<%= bin ? ',bin' : '' %>}/**/*")
+  <% if bin %>
+  s.bindir = "bin"
+  s.executables = [NAME]
+  <% end %>
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin locally"
+task :install => [:package] do
+  sh %{#{sudo} gem install #{install_home} pkg/#{NAME}-#{GEM_VERSION} --no-update-sources}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+namespace :jruby do
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
+
+end