CHANGELOG merb-builder/LICENSE merb-builder/README merb-builder/Rakefile merb-builder/TODO merb-builder/lib/merb-builder.rb merb-builder/lib/merb-builder/template.rb merb-builder/spec/builder_spec.rb merb-builder/spec/controllers/builder.rb merb-builder/spec/controllers/views/builder_config/index.xml.builder merb-builder/spec/controllers/views/builder_controller/index.xml.builder merb-builder/spec/controllers/views/partial_builder/_partial_builder.xml.builder merb-builder/spec/controllers/views/partial_builder/index.xml.builder merb-builder/spec/controllers/views/partial_ivars/_partial_builder.xml.builder merb-builder/spec/controllers/views/partial_ivars/index.xml.builder merb-builder/spec/spec_helper.rb merb-cache/LICENSE merb-cache/README merb-cache/Rakefile merb-cache/TODO merb-cache/lib/merb-cache.rb merb-cache/lib/merb-cache/cache-action.rb merb-cache/lib/merb-cache/cache-fragment.rb merb-cache/lib/merb-cache/cache-page.rb merb-cache/lib/merb-cache/cache-store/database-activerecord.rb merb-cache/lib/merb-cache/cache-store/database-datamapper.rb merb-cache/lib/merb-cache/cache-store/database-sequel.rb merb-cache/lib/merb-cache/cache-store/database.rb merb-cache/lib/merb-cache/cache-store/dummy.rb merb-cache/lib/merb-cache/cache-store/file.rb merb-cache/lib/merb-cache/cache-store/memcache.rb merb-cache/lib/merb-cache/cache-store/memory.rb merb-cache/lib/merb-cache/merb-cache.rb merb-cache/lib/merb-cache/merbtasks.rb merb-cache/spec/config/database.yml merb-cache/spec/controller.rb merb-cache/spec/merb-cache-action_spec.rb merb-cache/spec/merb-cache-fragment_spec.rb merb-cache/spec/merb-cache-page_spec.rb merb-cache/spec/merb-cache_spec.rb merb-cache/spec/spec_helper.rb merb-cache/spec/views/cache_controller/action1.html.erb merb-cache/spec/views/cache_controller/action2.html.haml merb-gen/app_generators/merb/templates/autotest/discover.rb merb-gen/app_generators/merb/templates/autotest/merb.rb merb-gen/app_generators/merb/templates/autotest/merb_rspec.rb merb-gen/app_generators/merb/templates/config/environments/rake.rb merb-gen/app_generators/merb/templates/public/.DS_Store merb-gen/app_generators/merb/templates/public/.htaccess merb-gen/app_generators/merb/templates/public/images/.DS_Store merb-gen/app_generators/merb_flat/templates/config/framework.rb merb-gen/merb_default_generators/resource_controller/templates/app/views/%controller_file_name%/delete.html.erb merb-gen/rspec_generators/merb_resource_controller_test/templates/spec/views/%controller_full_file_path%/delete.html.erb_spec.rb merb-haml/lib/merb-haml/merbtasks.rb merb-haml/spec/controllers/views/capture_haml/index.html.haml merb-haml/spec/controllers/views/concat_haml/index.html.haml merb-parts/spec/fixtures/views/main/part_within_view.html.erb @@ -1,17 +1,21 @@ ## THESE ARE CRUCIAL module Merb # Set this to the version of merb-core that you are building against/for - VERSION = "0.9.0" + VERSION = "0.9.2" # Set this to the version of merb-more you plan to release - MORE_VERSION = "0.9.0" + MORE_VERSION = "0.9.2" end +require "rake/clean" require "rake/gempackagetask" require 'fileutils' include FileUtils -gems = %w[merb-action-args merb-assets merb-gen merb-haml merb-mailer merb-parts merb-test] +gems = %w[ + merb-action-args merb-assets merb-gen merb-haml + merb-builder merb-mailer merb-parts merb-cache +] merb_more_spec = Gem::Specification.new do |s| s.name = "merb-more" @@ -22,7 +26,7 @@ merb_more_spec = Gem::Specification.new do |s| s.homepage = "http://www.merbivore.com" s.summary = "(merb - merb-core) == merb-more. The Full Stack. Take what you need; leave what you don't." s.description = s.summary - s.files = %w( LICENSE README Rakefile TODO ) + s.files = %w( LICENSE README Rakefile TODO lib/merb-more.rb ) s.add_dependency "merb-core", ">= #{Merb::VERSION}" gems.each do |gem| s.add_dependency gem, [">= #{Merb::VERSION}", "<= 1.0"] @@ -41,8 +45,11 @@ merb_spec = Gem::Specification.new do |s| s.files = %w( LICENSE README Rakefile TODO ) s.add_dependency "merb-core", "= #{Merb::VERSION}" s.add_dependency "merb-more", "= #{Merb::MORE_VERSION}" + s.add_dependency "mongrel", ">= 1.0.1" end +CLEAN.include ["**/.*.sw?", "pkg", "lib/*.bundle", "*.gem", "doc/rdoc", ".config", "coverage", "cache", "lib/merb-more.rb"] + windows = (PLATFORM =~ /win32|cygwin/) rescue nil SUDO = windows ? "" : "sudo" @@ -60,21 +67,21 @@ end desc "Install it all" task :install => [:install_gems, :package] do - sh %{#{SUDO} gem install pkg/merb-more-#{Merb::MORE_VERSION}.gem} - sh %{#{SUDO} gem install pkg/merb-#{Merb::MORE_VERSION}.gem} + sh %{#{SUDO} gem install --local pkg/merb-more-#{Merb::MORE_VERSION}.gem --no-update-sources} + sh %{#{SUDO} gem install --local pkg/merb-#{Merb::MORE_VERSION}.gem --no-update-sources} end desc "Build the merb-more gems" task :build_gems do gems.each do |dir| - sh %{cd #{dir}; rake package} + Dir.chdir(dir){ sh "rake package" } end end desc "Install the merb-more sub-gems" task :install_gems do gems.each do |dir| - sh %{cd #{dir}; #{SUDO} rake install} + Dir.chdir(dir){ sh "#{SUDO} rake install" } end end @@ -85,9 +92,22 @@ task :uninstall_gems do end end +task :package => ["lib/merb-more.rb"] +desc "Create merb-more.rb" +task "lib/merb-more.rb" do + mkdir_p "lib" + File.open("lib/merb-more.rb","w+") do |file| + file.puts "### AUTOMATICALLY GENERATED. DO NOT EDIT." + gems.each do |gem| + next if gem == "merb-gen" + file.puts "require '#{gem}'" + end + end +end + desc "Bundle up all the merb-more gems" task :bundle => [:package, :build_gems] do - mkdir "bundle" + mkdir_p "bundle" cp "pkg/merb-#{Merb::MORE_VERSION}.gem", "bundle" cp "pkg/merb-more-#{Merb::MORE_VERSION}.gem", "bundle" gems.each do |gem| Rakefile @@ -3,7 +3,7 @@ require 'rake/gempackagetask' PLUGIN = "merb-action-args" NAME = "merb-action-args" -VERSION = "0.9.0" +VERSION = "0.9.2" AUTHOR = "Yehuda Katz" EMAIL = "ykatz@engineyard.com" HOMEPAGE = "http://merb-plugins.rubyforge.org/merb-haml/" @@ -20,7 +20,7 @@ spec = Gem::Specification.new do |s| s.author = AUTHOR s.email = EMAIL s.homepage = HOMEPAGE - s.add_dependency('merb-core', '>= 0.9.0') + s.add_dependency('merb-core', '>= 0.9.2') s.require_path = 'lib' s.autorequire = PLUGIN s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*") @@ -31,7 +31,7 @@ Rake::GemPackageTask.new(spec) do |pkg| end task :install => [:package] do - sh %{sudo gem install pkg/#{NAME}-#{VERSION}} + sh %{sudo gem install pkg/#{NAME}-#{VERSION} --no-update-sources} end namespace :jruby do @@ -41,4 +41,4 @@ namespace :jruby do sh %{#{SUDO} jruby -S gem install pkg/#{NAME}-#{Merb::VERSION}.gem --no-rdoc --no-ri} end -end \ No newline at end of file +end merb-action-args/Rakefile @@ -3,7 +3,12 @@ class Merb::AbstractController class << self attr_accessor :action_argument_list alias_method :old_inherited, :inherited - + + # Stores the argument lists for all methods for this class. + # + # ==== Parameters + # klass<Class>:: + # The controller that is being inherited from Merb::AbstractController. def inherited(klass) klass.action_argument_list = Hash.new do |h,k| h[k] = ParseTreeArray.translate(klass, k.to_sym).get_args @@ -11,13 +16,21 @@ class Merb::AbstractController old_inherited(klass) end end - + + # Calls an action and maps the params hash to the action parameters. + # + # ==== Parameters + # action<Symbol>:: The action to call + # + # ==== Raises + # BadRequest:: The params hash doesn't have a required parameter. def _call_action(action) args = self.class.action_argument_list[action].map do |arg, default| arg = arg - raise BadRequest unless params.key?(arg.to_sym) || default - params.key?(arg.to_sym) ? params[arg.to_sym] : default + p = params.key?(arg.to_sym) + raise BadRequest unless p || default + p ? params[arg.to_sym] : default end - send(action, *args) + __send__(action, *args) end end \ No newline at end of file merb-action-args/lib/merb-action-args/abstract_controller.rb @@ -22,11 +22,19 @@ class ParseTreeArray < Array #:nodoc: end def get_args - arg_node = deep_array_node(:args) - return nil unless arg_node - args = arg_node.arg_nodes - default_node = arg_node.deep_array_node(:block) - return args unless default_node + if arg_node = deep_array_node(:args) + # method defined with def keyword + args = arg_node.arg_nodes + default_node = arg_node.deep_array_node(:block) + return args unless default_node + else + # assuming method defined with Module#define_method + return [] + end + + # if it was defined with def, and we found the default_node, + # that should bring us back to regularly scheduled programming.. + lasgns = default_node[1..-1] lasgns.each do |asgn| args.assoc(asgn[1]) << eval(RubyToRuby.new.process(asgn[2])) @@ -38,14 +46,16 @@ end # Used in mapping controller arguments to the params hash. # NOTE: You must have the 'ruby2ruby' gem installed for this to work. -# Example: -# (In PostsController) +# +# ==== Examples +# # In PostsController # def show(id) #=> id is the same as params[:id] - module GetArgs - # Returns an array of method arguments and their default values - # Example: + # ==== Returns + # Array:: Method arguments and their default values. + # + # ==== Examples # class Example # def hello(one,two="two",three) # end @@ -54,7 +64,8 @@ module GetArgs # end # end # - # Example.instance_method(:hello).get_args #=> [[:one], [:two, "two"], [:three, "three"]] + # Example.instance_method(:hello).get_args + # #=> [[:one], [:two, "two"], [:three, "three"]] # Example.instance_method(:goodbye).get_args #=> nil def get_args klass, meth = self.to_s.split(/ /).to_a[1][0..-2].split("#") merb-action-args/lib/merb-action-args/get_args.rb @@ -22,4 +22,8 @@ describe Merb::AbstractController do lambda { dispatch_to(ActionArgs, :index) }.should raise_error(Merb::ControllerExceptions::BadRequest) end + it "should treat define_method actions as equal" do + dispatch_to(ActionArgs, :dynamic_define_method).body.should == "mos def" + end + end \ No newline at end of file merb-action-args/spec/action_args_spec.rb @@ -16,4 +16,8 @@ class ActionArgs < Merb::Controller "#{foo} #{bar} #{baz}" end + define_method :dynamic_define_method do + "mos def" + end + end \ No newline at end of file merb-action-args/spec/controllers/action-args.rb @@ -1,14 +1,14 @@ $TESTING=true $:.unshift File.join(File.dirname(__FILE__), '..', 'lib') +require "rubygems" require "merb-core" require "merb-action-args" require File.dirname(__FILE__) / "controllers" / "action-args" +require "spec" -Merb.start :environment => 'test', :adapter => 'runner' +Merb.start :environment => 'test' -require "merb-core/test/fake_request" -require "merb-core/test/request_helper" Spec::Runner.configure do |config| config.include Merb::Test::RequestHelper end \ No newline at end of file merb-action-args/spec/spec_helper.rb @@ -3,7 +3,7 @@ require 'rake/gempackagetask' PLUGIN = "merb-assets" NAME = "merb-assets" -VERSION = "0.9.0" +VERSION = "0.9.2" AUTHOR = "Ezra Zygmuntowicz" EMAIL = "ez@engineyard.com" HOMEPAGE = "http://merb-plugins.rubyforge.org/merb-assets/" @@ -20,7 +20,7 @@ spec = Gem::Specification.new do |s| s.author = AUTHOR s.email = EMAIL s.homepage = HOMEPAGE - s.add_dependency('merb-core', '>= 0.9.0') + s.add_dependency('merb-core', '>= 0.9.2') s.require_path = 'lib' s.autorequire = PLUGIN s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*") @@ -31,7 +31,7 @@ Rake::GemPackageTask.new(spec) do |pkg| end task :install => [:package] do - sh %{sudo gem install pkg/#{NAME}-#{VERSION}} + sh %{sudo gem install pkg/#{NAME}-#{VERSION} --no-update-sources --no-update-sources} end namespace :jruby do @@ -41,4 +41,4 @@ namespace :jruby do sh %{#{SUDO} jruby -S gem install pkg/#{NAME}-#{Merb::VERSION}.gem --no-rdoc --no-ri} end -end \ No newline at end of file +end merb-assets/Rakefile @@ -1,4 +1,14 @@ require 'merb-assets/assets' require 'merb-assets/assets_mixin' -Merb::Controller.send(:include, Merb::AssetsMixin) \ No newline at end of file +Merb::BootLoader.before_app_loads do + Merb::Controller.send(:include, Merb::AssetsMixin) +end + + +Merb::Plugins.config[:asset_helpers] = { + :max_hosts => 4, + :asset_domain => "assets%s", + :domain => "my-awesome-domain.com", + :use_ssl => false + } if Merb::Plugins.config[:asset_helpers].nil? \ No newline at end of file merb-assets/lib/merb-assets.rb @@ -7,7 +7,6 @@ module Merb # Boolean:: # True if the assets should be bundled (e.g., production mode or # :bundle_assets is explicitly enabled). - # def self.bundle? (Merb.environment == 'production') || (!!Merb::Config[:bundle_assets]) @@ -28,7 +27,6 @@ module Merb # ==== Parameters # asset_type<Symbol>:: Type of the asset (e.g. :javascript). # filename<~to_s>:: The path to the file. - # # local_path<Boolean>:: # If true, the returned path will be relative to the Merb.root, # otherwise it will be the public URI path. Defaults to false. @@ -42,7 +40,6 @@ module Merb # # asset_path(:javascript, :dingo, true) # # => "public/javascripts/dingo.js" - # def asset_path(asset_type, filename, local_path = false) filename = filename.to_s if filename !~ /#{'\\' + ASSET_FILE_EXTENSIONS[asset_type]}\Z/ @@ -57,15 +54,55 @@ module Merb end end + # Helper for creating unique paths to a file name + # Can increase speend for browsers that are limited to a certain number of connections per host + # for downloading static files (css, js, images...) + class UniqueAssetPath + class << self + @@config = Merb::Plugins.config[:asset_helpers] + + # Builds the path to the file based on the name + # + # ==== Parameters + # filename<String>:: Name of file to generate path for + # + # ==== Returns + # String:: The path to the asset. + # + # ==== Examples + # build("/javascripts/my_fancy_script.js") + # # => "https://assets5.my-awesome-domain.com/javascripts/my_fancy_script.js" + # + def build(filename) + #%{#{(USE_SSL ? 'https' : 'http')}://#{sprintf(@@config[:asset_domain],self.calculate_host_id(file))}.#{@@config[:domain]}/#{filename}} + path = @@config[:use_ssl] ? 'https://' : 'http://' + path << sprintf(@@config[:asset_domain],self.calculate_host_id(filename)) << ".#{@@config[:domain]}" + path << "/" if filename.index('/') != 0 + path << filename + end + + protected + + # Calculates the id for the host + def calculate_host_id(filename) + ascii_total = 0 + filename.each_byte {|byte| + ascii_total += byte + } + (ascii_total % @@config[:max_hosts] + 1) + end + end + end + # An abstract class for bundling text assets into single files. class AbstractAssetBundler class << self - # Add a post-bundle callback. + # ==== Parameters + # &block:: A block to add as a post-bundle callback. # # ==== Examples # add_callback { |filename| `yuicompressor #{filename}` } - # def add_callback(&block) callbacks << block end @@ -74,8 +111,7 @@ module Merb # Retrieve existing callbacks. # # ==== Returns - # Array:: An array of existing callbacks. - # + # Array[Proc]:: An array of existing callbacks. def callbacks @callbacks ||= [] return @callbacks @@ -85,21 +121,19 @@ module Merb # this method in your bundler code. # # ==== Raises - # NotImplementedError:: - # If this method has not been implemented by the bundler. + # NotImplementedError:: This method is implemented by the bundler. # # ==== Returns # Symbol:: The type of the asset - # def asset_type raise NotImplementedError, "should return a symbol for the first argument to be passed to asset_path" end end - - # Create a new asset bundler, which will produce a bundled file containing - # the contents of +files+. If +name+ is +true+ (as in, is an instance of - # +TrueClass+), the filename is written out as "all", otherwise +name+ - # is coerced into a string. + + # ==== Parameters + # name<~to_s>:: + # Name of the bundle. If name is true, it will be converted to :all. + # *files<String>:: Names of the files to bundle. def initialize(name, *files) @bundle_name = name == true ? :all : name @bundle_filename = asset_path(self.class.asset_type, @bundle_name, true) @@ -110,7 +144,6 @@ module Merb # # ==== Returns # Symbol:: Name of the bundle. - # def bundle! # TODO: Move this file check out into an in-memory cache. Also, push it out to the helper level so we don't have to create the helper object. unless File.exist?(@bundle_filename) @@ -128,8 +161,7 @@ module Merb # # ==== Parameters # filename<String>:: Name of the bundle file. - # files<Array>:: An array of filenames to be bundled. - # + # *files<String>:: Filenames to be bundled. def bundle_files(filename, *files) File.open(filename, "w") do |f| files.each { |file| f.puts(File.read(file)) } @@ -142,6 +174,9 @@ module Merb # # javascripts/#{name}.js class JavascriptAssetBundler < AbstractAssetBundler + + # ==== Returns + # Symbol:: The asset type, i.e. :javascript. def self.asset_type :javascript end @@ -151,6 +186,9 @@ module Merb # # stylesheets/#{name}.css class StylesheetAssetBundler < AbstractAssetBundler + + # ==== Returns + # Symbol:: The asset type, i.e. :stylesheet. def self.asset_type :stylesheet end merb-assets/lib/merb-assets/assets.rb @@ -4,37 +4,40 @@ module Merb module AssetsMixin include Merb::Assets::AssetHelpers # :section: Accessing Assets - # Merb provides views with convenience methods for links images and other assets. - - # Creates a link for the URL given in +url+ with the text in +name+; HTML options are given in the +opts+ - # hash. - # - # ==== Options - # The +opts+ hash is used to set HTML attributes on the tag. + # Merb provides views with convenience methods for links images and other + # assets. + + # ==== Parameters + # name<~to_s>:: The text of the link. + # url<~to_s>:: The URL to link to. Defaults to an empty string. + # opts<Hash>:: Additional HTML options for the link. # # ==== Examples # link_to("The Merb home page", "http://www.merbivore.com/") - # # => <a href="http://www.merbivore.com/">The Merb home page</a> + # # => <a href="http://www.merbivore.com/">The Merb home page</a> # # link_to("The Ruby home page", "http://www.ruby-lang.org", {'class' => 'special', 'target' => 'blank'}) - # # => <a href="http://www.ruby-lang.org" class="special" target="blank">The Ruby home page</a> + # # => <a href="http://www.ruby-lang.org" class="special" target="blank">The Ruby home page</a> # # link_to p.title, "/blog/show/#{p.id}" - # # => <a href="blog/show/13">The Entry Title</a> + # # => <a href="blog/show/13">The Entry Title</a> # def link_to(name, url='', opts={}) opts[:href] ||= url %{<a #{ opts.to_xml_attributes }>#{name}</a>} end - # Creates an image tag with the +src+ attribute set to the +img+ argument. The path - # prefix defaults to <tt>/images/</tt>. The path prefix can be overriden by setting a +:path+ - # parameter in the +opts+ hash. The rest of the +opts+ hash sets HTML attributes. + # ==== Parameters + # img<~to_s>:: The image path. + # opts<Hash>:: Additional options for the image tag (see below). # - # ==== Options - # path:: Sets the path prefix for the image (defaults to +/images/+) + # ==== Options (opts) + # :path<String>:: + # Sets the path prefix for the image. Defaults to "/images/" or whatever + # is specified in Merb::Config. This is ignored if img is an absolute + # path or full URL. # - # All other options in +opts+ set HTML attributes on the tag. + # All other options set HTML attributes on the tag. # # ==== Examples # image_tag('foo.gif') @@ -48,63 +51,71 @@ module Merb # # image_tag('http://test.com/foo.gif') # # => <img src="http://test.com/foo.gif"> + # + # image_tag('charts', :path => '/dynamic/') + # or + # image_tag('/dynamic/charts') + # # => <img src="/dynamic/charts"> def image_tag(img, opts={}) - opts[:path] ||= - if img =~ %r{^https?://} - '' - else - if Merb::Config[:path_prefix] - Merb::Config[:path_prefix] + '/images/' + if img[0].chr == '/' + opts[:src] = img + else + opts[:path] ||= + if img =~ %r{^https?://} + '' else - '/images/' + if Merb::Config[:path_prefix] + Merb::Config[:path_prefix] + '/images/' + else + '/images/' + end end - end - opts[:src] ||= opts.delete(:path) + img + opts[:src] ||= opts.delete(:path) + img + end %{<img #{ opts.to_xml_attributes } />} end # :section: JavaScript related functions # - # Escapes text for use in JavaScript, replacing unsafe strings with their - # escaped equivalent. + # ==== Parameters + # javascript<String>:: Text to escape for use in JavaScript. # # ==== Examples # escape_js("'Lorem ipsum!' -- Some guy") - # # => "\\'Lorem ipsum!\\' -- Some guy" + # # => "\\'Lorem ipsum!\\' -- Some guy" # # escape_js("Please keep text\nlines as skinny\nas possible.") - # # => "Please keep text\\nlines as skinny\\nas possible." + # # => "Please keep text\\nlines as skinny\\nas possible." def escape_js(javascript) (javascript || '').gsub('\\','\0\0').gsub(/\r\n|\n|\r/, "\\n").gsub(/["']/) { |m| "\\#{m}" } end - # Creates a link tag with the text in +name+ and the <tt>onClick</tt> handler set to a JavaScript - # string in +function+. + # ==== Parameters + # name<~to_s>:: The text in the link. + # function<~to_s>:: The onClick event in JavaScript. # # ==== Examples # link_to_function('Click me', "alert('hi!')") - # # => <a href="#" onclick="alert('hi!'); return false;">Click me</a> + # # => <a href="#" onclick="alert('hi!'); return false;">Click me</a> # # link_to_function('Add to cart', "item_total += 1; alert('Item added!');") - # # => <a href="#" onclick="item_total += 1; alert('Item added!'); return false;">Add to cart</a> - # + # # => <a href="#" onclick="item_total += 1; alert('Item added!'); return false;">Add to cart</a> def link_to_function(name, function) %{<a href="#" onclick="#{function}; return false;">#{name}</a>} end - # The js method simply calls +to_json+ on an object in +data+; if the object - # does not implement a +to_json+ method, then it calls +to_json+ on - # +data.inspect+. + # ==== Parameters + # data<Object>:: + # Object to translate into JSON. If the object does not respond to + # :to_json, then data.inspect.to_json is returned instead. # # ==== Examples # js({'user' => 'Lewis', 'page' => 'home'}) - # # => "{\"user\":\"Lewis\",\"page\":\"home\"}" - # - # my_array = [1, 2, {"a"=>3.141}, false, true, nil, 4..10] - # js(my_array) - # # => "[1,2,{\"a\":3.141},false,true,null,\"4..10\"]" + # # => "{\"user\":\"Lewis\",\"page\":\"home\"}" # + # js([ 1, 2, {"a"=>3.141}, false, true, nil, 4..10 ]) + # # => "[1,2,{\"a\":3.141},false,true,null,\"4..10\"]" def js(data) if data.respond_to? :to_json data.to_json @@ -117,8 +128,9 @@ module Merb # # You can use require_js(:prototype) or require_css(:shinystyles) # from any view or layout, and the scripts will only be included once - # in the head of the final page. To get this effect, the head of your layout you will - # need to include a call to include_required_js and include_required_css. + # in the head of the final page. To get this effect, the head of your + # layout you will need to include a call to include_required_js and + # include_required_css. # # ==== Examples # # File: app/views/layouts/application.html.erb @@ -234,10 +246,12 @@ module Merb # # require_js :bundle => :posts - # The require_js method can be used to require any JavaScript - # file anywhere in your templates. Regardless of how many times - # a single script is included with require_js, Merb will only include - # it once in the header. + # The require_js method can be used to require any JavaScript file anywhere + # in your templates. Regardless of how many times a single script is + # included with require_js, Merb will only include it once in the header. + # + # ==== Parameters + # *js<~to_s>:: JavaScript files to include. # # ==== Examples # <% require_js 'jquery' %> @@ -254,10 +268,12 @@ module Merb @required_js |= js end - # The require_css method can be used to require any CSS - # file anywhere in your templates. Regardless of how many times - # a single stylesheet is included with require_css, Merb will only include - # it once in the header. + # The require_css method can be used to require any CSS file anywhere in + # your templates. Regardless of how many times a single stylesheet is + # included with require_css, Merb will only include it once in the header. + # + # ==== Parameters + # *css<~to_s>:: CSS files to include. # # ==== Examples # <% require_css('style') %> @@ -274,15 +290,16 @@ module Merb @required_css |= css end - # A method used in the layout of an application to create +<script>+ tags to include JavaScripts required in - # in templates and subtemplates using require_js. + # A method used in the layout of an application to create +<script>+ tags + # to include JavaScripts required in in templates and subtemplates using + # require_js. # - # ==== Options - # bundle:: The name of the bundle the scripts should be combined into. - # If +nil+ or +false+, the bundle is not created. If +true+, a - # bundle named <tt>all.js</tt> is created. Otherwise, - # <tt>:bundle</tt> is treated as an asset name. + # ==== Parameters + # options<Hash>:: Options to pass to js_include_tag. # + # ==== Returns + # String:: The JavaScript tag. + # # ==== Examples # # my_action.herb has a call to require_js 'jquery' # # File: layout/application.html.erb @@ -301,14 +318,15 @@ module Merb js_include_tag(*(@required_js + [options])) end - # A method used in the layout of an application to create +<link>+ tags for CSS stylesheets required in - # in templates and subtemplates using require_css. + # A method used in the layout of an application to create +<link>+ tags for + # CSS stylesheets required in in templates and subtemplates using + # require_css. # - # ==== Options - # bundle:: The name of the bundle the stylesheets should be combined into. - # If +nil+ or +false+, the bundle is not created. If +true+, a - # bundle named <tt>all.css</tt> is created. Otherwise, - # <tt>:bundle</tt> is treated as an asset name. + # ==== Parameters + # options<Hash>:: Options to pass to css_include_tag. + # + # ==== Returns + # String:: The CSS tag. # # ==== Examples # # my_action.herb has a call to require_css 'style' @@ -327,16 +345,19 @@ module Merb css_include_tag(*(@required_css + [options])) end - # The js_include_tag method will create a JavaScript - # +<include>+ tag for each script named in the arguments, appending - # '.js' if it is left out of the call. - # + # ==== Parameters + # *scripts:: + # The scripts to include. If the last element is a Hash, it will be used + # as options (see below). If ".js" is left out from the script names, it + # will be added to them. + # # ==== Options - # bundle:: The name of the bundle the scripts should be combined into. - # If +nil+ or +false+, the bundle is not created. If +true+, a - # bundle named <tt>all.js</tt> is created. Otherwise, - # <tt>:bundle</tt> is treated as an asset name. - # + # :bundle<~to_s>:: + # The name of the bundle the scripts should be combined into. + # + # ==== Returns + # String:: The JavaScript include tag(s). + # # ==== Examples # js_include_tag 'jquery' # # => <script src="/javascripts/jquery.js" type="text/javascript"></script> @@ -369,41 +390,47 @@ module Merb :src => asset_path(:javascript, script), :type => "text/javascript" } - tags << %Q{<script #{attrs.to_xml_attributes}>//</script>} + tags << %Q{<script #{attrs.to_xml_attributes}></script>} end return tags end - # The css_include_tag method will create a CSS stylesheet - # +<link>+ tag for each stylesheet named in the arguments, appending - # '.css' if it is left out of the call. - # + # ==== Parameters + # *stylesheets:: + # The stylesheets to include. If the last element is a Hash, it will be + # used as options (see below). If ".css" is left out from the stylesheet + # names, it will be added to them. + # # ==== Options - # bundle:: The name of the bundle the stylesheets should be combined into. - # If +nil+ or +false+, the bundle is not created. If +true+, a - # bundle named <tt>all.css</tt> is created. Otherwise, - # <tt>:bundle</tt> is treated as an asset name. - # media:: The media attribute for the generated link element. Defaults - # to <tt>:all</tt>. + # :bundle<~to_s>:: + # The name of the bundle the stylesheets should be combined into. + # :media<~to_s>:: + # The media attribute for the generated link element. Defaults to :all. + # + # ==== Returns + # String:: The CSS include tag(s). # # ==== Examples # css_include_tag 'style' - # # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" /> + # # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" /> # # css_include_tag 'style.css', 'layout' - # # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" /> - # # <link href="/stylesheets/layout.css" media="all" rel="Stylesheet" type="text/css" /> + # # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" /> + # # <link href="/stylesheets/layout.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" /> # # css_include_tag :menu - # # => <link href="/stylesheets/menu.css" media="all" rel="Stylesheet" type="text/css" /> + # # => <link href="/stylesheets/menu.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" /> # # css_include_tag :style, :screen - # # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" /> - # # <link href="/stylesheets/screen.css" media="all" rel="Stylesheet" type="text/css" /> + # # => <link href="/stylesheets/style.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" /> + # # <link href="/stylesheets/screen.css" media="all" rel="Stylesheet" type="text/css" charset="utf-8" /> # # css_include_tag :style, :media => :print - # # => <link href="/stylesheets/style.css" media="print" rel="Stylesheet" type="text/css" /> + # # => <link href="/stylesheets/style.css" media="print" rel="Stylesheet" type="text/css" charset="utf-8" /> + # + # css_include_tag :style, :charset => 'iso-8859-1' + # # => <link href="/stylesheets/style.css" media="print" rel="Stylesheet" type="text/css" charset="iso-8859-1" /> def css_include_tag(*stylesheets) options = stylesheets.last.is_a?(Hash) ? stylesheets.pop : {} return nil if stylesheets.empty? @@ -421,6 +448,7 @@ module Merb :href => asset_path(:stylesheet, stylesheet), :type => "text/css", :rel => "Stylesheet", + :charset => options[:charset] || 'utf-8', :media => options[:media] || :all } tags << %Q{<link #{attrs.to_xml_attributes} />} @@ -428,5 +456,107 @@ module Merb return tags end + + # ==== Parameters + # *assets:: + # The assets to include. These should be the full paths to any static served file + # + # ==== Returns + # Array:: Full unique paths to assets OR + # String:: if only a single path is requested + # ==== Examples + # uniq_path("/javascripts/my.js","/javascripts/my.css") + # #=> ["http://assets2.my-awesome-domain.com/javascripts/my.js", "http://assets2.my-awesome-domain.com/javascripts/my.css"] + # + # uniq_path(["/javascripts/my.js","/stylesheets/my.css"]) + # #=> ["http://assets2.my-awesome-domain.com/javascripts/my.js", "http://assets1.my-awesome-domain.com/stylesheets/my.css"] + # + # uniq_path(%w(/javascripts/my.js /stylesheets/my.css)) + # #=> ["http://assets2.my-awesome-domain.com/javascripts/my.js", "http://assets1.my-awesome-domain.com/stylesheets/my.css"] + # + # uniq_path('/stylesheets/somearbitrary.css') + # #=> "http://assets3.my-awesome-domain.com/stylesheets/somearbitrary.css" + # + # uniq_path('/images/hostsexypicture.jpg') + # #=>"http://assets1.my-awesome-domain.com/images/hostsexypicture.jpg" + def uniq_path(*assets) + paths = [] + assets.collect.flatten.each do |filename| + paths.push(UniqueAssetPath.build(filename)) + end + paths.length > 1 ? paths : paths.first + end + + # ==== Parameters + # *assets:: + # Creates unique paths for javascript files (prepends "/javascripts" and appends ".js") + # + # ==== Returns + # Array:: Full unique paths to assets OR + # String:: if only a single path is requested + # ==== Examples + # uniq_js_path("my") + # #=> "http://assets2.my-awesome-domain.com/javascripts/my.js" + # + # uniq_js_path(["admin/secrets","home/signup"]) + # #=> ["http://assets2.my-awesome-domain.com/javascripts/admin/secrets.js", + # "http://assets1.my-awesome-domain.com/javascripts/home/signup.js"] + def uniq_js_path(*assets) + paths = [] + assets.collect.flatten.each do |filename| + paths.push(UniqueAssetPath.build(asset_path(:javascript,filename,true))) + end + paths.length > 1 ? paths : paths.first + end + + # ==== Parameters + # *assets:: + # Creates unique paths for stylesheet files (prepends "/stylesheets" and appends ".css") + # + # ==== Returns + # Array:: Full unique paths to assets OR + # String:: if only a single path is requested + # ==== Examples + # uniq_css_path("my") + # #=> "http://assets2.my-awesome-domain.com/stylesheets/my.css" + # + # uniq_css_path(["admin/secrets","home/signup"]) + # #=> ["http://assets2.my-awesome-domain.com/stylesheets/admin/secrets.css", + # "http://assets1.my-awesome-domain.com/stylesheets/home/signup.css"] + def uniq_css_path(*assets) + paths = [] + assets.collect.flatten.each do |filename| + paths.push(UniqueAssetPath.build(asset_path(:stylesheet,filename,true))) + end + paths.length > 1 ? paths : paths.first + end + + # ==== Parameters + # *assets:: + # As js_include_tag but has unique path + # + # ==== Returns + # Array:: Full unique paths to assets OR + # String:: if only a single path is requested + # ==== Examples + # uniq_js_tag("my") + # #=> <script type="text/javascript" src="http://assets2.my-awesome-domain.com/javascripts/my.js"></script> + def uniq_js_tag(*assets) + js_include_tag(uniq_js_path(assets)) + end + + # ==== Parameters + # *assets:: + # As uniq_css_tag but has unique path + # + # ==== Returns + # Array:: Full unique paths to assets OR + # String:: if only a single path is requested + # ==== Examples + # uniq_css_tag("my") + # #=> <link href="http://assets2.my-awesome-domain.com/stylesheets/my.css" type="text/css" /> + def uniq_css_tag(*assets) + css_include_tag(uniq_css_path(assets)) + end end end merb-assets/lib/merb-assets/assets_mixin.rb @@ -2,7 +2,7 @@ require 'rubygems' require 'rake/gempackagetask' GEM = "merb-gen" -VERSION = "0.9.0" +VERSION = "0.9.2" AUTHOR = "Yehuda Katz" EMAIL = "wycats@gmail.com" HOMEPAGE = "http://www.merbivore.com" @@ -23,8 +23,8 @@ spec = Gem::Specification.new do |s| s.executables = %w( merb-gen ) # Uncomment this to add a dependency - s.add_dependency "merb-core", ">= 0.9" - s.add_dependency "rubigen" + s.add_dependency "merb-core", ">= 0.9.2" + s.add_dependency "rubigen", ">= 1.2.4" s.require_path = 'lib' s.autorequire = GEM @@ -38,10 +38,10 @@ end namespace :jruby do task :install do - sh %{sudo jruby -S gem install pkg/#{GEM}-#{VERSION}} + sh %{sudo jruby -S gem install pkg/#{GEM}-#{VERSION} --no-update-sources} end end task :install => [:package] do - sh %{sudo gem install pkg/#{GEM}-#{VERSION}} -end \ No newline at end of file + sh %{sudo gem install pkg/#{GEM}-#{VERSION} --no-update-sources} +end merb-gen/Rakefile @@ -15,8 +15,22 @@ class MerbGenerator < Merb::GeneratorBase <<-EOS.split("\n").map{|x| x.strip}.join("\n") Creates a Merb application stub. - USAGE: #{spec.name} -g path" + USAGE: #{spec.name} -g path + + Set environment variable MERB_ORM=[activerecord|datamapper|sequel] + to pre-enabled an ORM. EOS end + def default_orm?(orm) + ENV['MERB_ORM'] == orm.to_s + end + + def default_test_suite?(suite) + return ENV['MERB_TEST_SUITE'] == suite.to_s if ENV['MERB_TEST_SUITE'] + options[suite] + end + + def display_framework_selections + end end merb-gen/app_generators/merb/merb_generator.rb @@ -9,52 +9,23 @@ require 'spec/rake/spectask' require 'fileutils' require 'merb-core' require 'rubigen' - -$RAKE_ENV = true - -Merb.start :environment => (ENV['MERB_ENV'] || 'development'), - :adapter => 'runner', - :merb_root => File.dirname(__FILE__) - include FileUtils -# # # Get Merb plugins and dependencies -Merb::Plugins.rakefiles.each {|r| require r } - -# -#desc "Packages up Merb." -#task :default => [:package] - -desc "load merb_init.rb" -task :merb_init do - require 'merb-core' - require File.dirname(__FILE__)+'/config/init.rb' -end - -task :uninstall => [:clean] do - sh %{sudo gem uninstall #{NAME}} -end - -desc 'Run all tests, specs and finish with rcov' -task :aok do - sh %{rake rcov} - sh %{rake spec} -end -unless Gem.cache.search("haml").empty? - namespace :haml do - desc "Compiles all sass files into CSS" - task :compile_sass do - gem 'haml' - require 'sass' - puts "*** Updating stylesheets" - Sass::Plugin.update_stylesheets - puts "*** Done" - end - end +# Load the basic runtime dependencies; this will include +# any plugins and therefore plugin rake tasks. +init_env = ENV['MERB_ENV'] || 'rake' +Merb.load_dependencies(:environment => init_env) + +# Get Merb plugins and dependencies +Merb::Plugins.rakefiles.each { |r| require r } + +desc "start runner environment" +task :merb_env do + Merb.start_environment(:environment => init_env, :adapter => 'runner') end ############################################################################## -# SVN +# ADD YOUR CUSTOM TASKS BELOW ############################################################################## desc "Add new files to subversion" merb-gen/app_generators/merb/templates/Rakefile @@ -1,6 +1,6 @@ <html> <head> - <meta http-equiv="Content-type" content="text/html; charset=utf-8"> + <meta http-equiv="Content-type" content="text/html; charset=utf-8" /> <title><%%= @exception_name %></title> <style type="text/css" media="screen"> body { merb-gen/app_generators/merb/templates/app/views/exceptions/internal_server_error.html.erb @@ -1,6 +1,6 @@ <div id="container"> <div id="header-container"> - <img src="/images/merb.jpg"> + <img src="/images/merb.jpg" /> <!-- <h1>Mongrel + Erb</h1> --> <h2>pocket rocket web framework</h2> <hr /> @@ -15,10 +15,27 @@ <h3>Why am I seeing this page?</h3> <p>Merb couldn't find an appropriate content_type to return, based on what you said was available via provides() and - what the client requested. For more information, visit - http://merbivore.com/fixing_406_issues - </p> - + what the client requested.</p> + + <h3>How to add a mime-type</h3> + <pre><code> + Merb.add_mime_type :pdf, :to_pdf, %w[application/pdf], &quot;Content-Encoding&quot; =&gt; &quot;gzip&quot; + </code></pre> + <h3>What this means is:</h3> + <ul> + <li>Add a mime-type for :pdf</li> + <li>Register the method for converting objects to PDF as <code>#to_pdf</code>.</li> + <li>Register the incoming mime-type "Accept" header as <code>application/pdf</code>.</li> + <li>Specify a new header for PDF types so it will set <code>Content-Encoding</code> to gzip.</li> + </ul> + + <h3>You can then do:</h3> + <pre><code> + class Foo &lt; Application + provides :pdf + end + </code></pre> + <h3>Where can I find help?</h3> <p>If you have any questions or if you can't figure something out, please take a look at our <a href="http://merb.devjavu.com/"> project development page</a> or, @@ -26,7 +43,7 @@ <h3>How do I edit this page?</h3> <p>You can change what people see when this happens byy editing <tt>app/views/exceptions/not_found.html.erb</tt>.</p> - + </div> <div id="footer-container"> merb-gen/app_generators/merb/templates/app/views/exceptions/not_acceptable.html.erb @@ -1,6 +1,6 @@ <div id="container"> <div id="header-container"> - <img src="/images/merb.jpg"> + <img src="/images/merb.jpg" /> <!-- <h1>Mongrel + Erb</h1> --> <h2>pocket rocket web framework</h2> <hr /> @@ -23,7 +23,6 @@ <h3>How do I edit this page?</h3> <p>You're seeing this page because you need to edit the following files: <ul> - <li>config/merb.yml <strong><em>(optional)</em></strong></li> <li>config/router.rb <strong><em>(recommended)</em></strong></li> <li>app/views/exceptions/not_found.html.erb <strong><em>(recommended)</em></strong></li> <li>app/views/layout/application.html.erb <strong><em>(change this layout)</em></strong></li> merb-gen/app_generators/merb/templates/app/views/exceptions/not_found.html.erb @@ -3,7 +3,7 @@ <head> <title>Fresh Merb App</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> - <link rel="stylesheet" href="/stylesheets/master.css" type="text/css" media="screen" charset="utf-8"> + <link rel="stylesheet" href="/stylesheets/master.css" type="text/css" media="screen" charset="utf-8" /> </head> <body> <%%= catch_content :for_layout %> merb-gen/app_generators/merb/templates/app/views/layout/application.html.erb @@ -1,6 +1,5 @@ Merb.logger.info("Loaded TEST Environment...") Merb::Config.use { |c| + c[:testing] = true c[:exception_details] = true - c[:reload_classes] = true - c[:reload_time] = 0.5 } \ No newline at end of file merb-gen/app_generators/merb/templates/config/environments/test.rb @@ -7,6 +7,11 @@ $LOAD_PATH.unshift(Merb.root / "lib") <% require 'sha1' %> 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'. + # c[:session_id_key] = '_session_id' + c[:session_secret_key] = '<%= SHA1.new(rand(100000000000).to_s).to_s %>' c[:session_store] = 'cookie' end @@ -16,19 +21,25 @@ end ### if you need a database. ### Uncomment for DataMapper ORM -# use_orm :datamapper +<%= "# " unless default_orm?(:datamapper) %>use_orm :datamapper ### Uncomment for ActiveRecord ORM -# use_orm :activerecord +<%= "# " unless default_orm?(:activerecord) %>use_orm :activerecord ### Uncomment for Sequel ORM -# use_orm :sequel +<%= "# " unless default_orm?(:sequel) %>use_orm :sequel ### This defines which test framework the generators will use ### rspec is turned on by default -# use_test :test_unit -use_test :rspec +### +### 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. +### +<%= "# " unless default_test_suite?(:test) %>use_test :test_unit +<%= "# " unless default_test_suite?(:spec) %>use_test :rspec ### Add your other dependencies here merb-gen/app_generators/merb/templates/config/init.rb merb-gen/app_generators/merb/templates/public/images/merb.jpg @@ -1,4 +1,22 @@ #!/usr/bin/env ruby + +require 'rubygems' +require 'merb-core' -argv = ARGV + %w[-a fcgi] -Merb.start(argv) \ No newline at end of file +# this is Merb.root, change this if you have some funky setup. +merb_root = File.expand_path(File.dirname(__FILE__) / '../') + +# If the fcgi process runs as apache, make sure +# we have an inlinedir set for Rubyinline action-args to work +unless ENV["INLINEDIR"] || ENV["HOME"] + tmpdir = merb_root / "tmp" + unless File.directory?(tmpdir) + Dir.mkdir(tmpdir) + end + ENV["INLINEDIR"] = tmpdir +end + +# start merb with the fcgi adapter, add options or change the log dir here +Merb.start(:adapter => 'fcgi', + :merb_root => merb_root, + :log_file => merb_root /'log'/'merb.log') \ No newline at end of file merb-gen/app_generators/merb/templates/public/merb.fcgi @@ -1,14 +1,11 @@ -$TESTING=true require 'rubygems' require 'merb-core' -require 'merb-core/test/fake_request' -require 'merb-core/test/request_helper' +require 'spec' # Satiates Autotest and anyone else not using the Rake tasks -# TODO: Boot Merb, via the Test Rack adapter -Merb.start :environment => (ENV['MERB_ENV'] || 'test'), - :adapter => 'runner', - :merb_root => File.join(File.dirname(__FILE__), ".." ) +Merb.start_environment(:testing => true, :adapter => 'runner', :environment => ENV['MERB_ENV'] || 'test') Spec::Runner.configure do |config| - config.include(Merb::Test::RequestHelper) + config.include(Merb::Test::ViewHelper) + config.include(Merb::Test::RouteHelper) + config.include(Merb::Test::ControllerHelper) end merb-gen/app_generators/merb/templates/spec/spec_helper.rb @@ -1,10 +1,12 @@ -# TODO: Boot Merb, via the Rack test adapter - $TESTING=true +require 'rubygems' +require 'merb-core' + + +# TODO: Boot Merb, via the Test Rack adapter +Merb.start :environment => (ENV['MERB_ENV'] || 'test'), + :merb_root => File.join(File.dirname(__FILE__), ".." ) -require 'test/unit' -require 'merb/test/fake_request' -require 'merb/test/request_helper' class Test::Unit::TestCase include Merb::Test::RequestHelper merb-gen/app_generators/merb/templates/test/test_helper.rb @@ -1,7 +1,7 @@ class Foo < Merb::Controller def _template_location(action, type = nil, controller = controller_name) - "#{action}.#{type}" + controller == "layout" ? "layout.#{action}.#{type}" : "#{action}.#{type}" end def index merb-gen/app_generators/merb_flat/templates/application.rb @@ -1,11 +1,9 @@ -Merb.push_path(:view, Merb.root / "views") +# Move this to application.rb if you want it to be reloadable in dev mode. Merb::Router.prepare do |r| r.match('/').to(:controller => 'foo', :action =>'index') r.default_routes end -require 'application' - <% require 'sha1' %> Merb::Config.use { |c| c[:environment] = 'production', @@ -13,6 +11,7 @@ Merb::Config.use { |c| c[:log_level] = 'debug', c[:use_mutex] = false, c[:session_store] = 'cookie', + c[:session_id_key] = '_session_id', c[:session_secret_key] = '<%= SHA1.new(rand(100000000000).to_s).to_s %>', c[:exception_details] = true, c[:reload_classes] = true, merb-gen/app_generators/merb_flat/templates/config/init.rb @@ -6,5 +6,13 @@ if defined?(Merb::Plugins) :chickens => false } + Merb::BootLoader.before_app_loads do + # require code that must be loaded before the application + end + + Merb::BootLoader.after_app_loads do + # code that can be required after the application loads + end + Merb::Plugins.add_rakefiles "<%= base_name %>/merbtasks" end \ No newline at end of file merb-gen/app_generators/merb_plugin/templates/lib/%base_name%.rb @@ -2,14 +2,14 @@ at_exit { exit } -command = ARGV.shift if %w( generate destroy update ).include?(ARGV[0]) +command = ARGV.shift if %w(generate destroy update).include?(ARGV[0]) %w(rubygems merb-core).each do |file| require file end # start merb -Merb.start :environment => 'development', :adapter => 'runner', :log_level => 'error' +Merb.start :environment => 'development', :log_level => 'error' # remove dependency module Kernel @@ -21,11 +21,57 @@ end require file end -if ARGV.empty? +app_help = <<-EOF + Application Generators: + To generate an application use one of the following + merb-gen app app_name (for a standard application) + merb-gen app app_name --flat (for a flattened application) + merb-gen app app_name --very-flat (for a single file application) + merb-gen frozen-merb (script to run from frozen gems/framework) + merb-gen plugin plugin_name (creates a plugin gem skeleton) + + Other Generators: + merb-gen generators + with no args will display all availble generators for the current configuration. +EOF + +# merb-gen || merb-gen help || merb-gen help app || merb-gen app +if ARGV.empty? || (ARGV[0] == "help" && ARGV.length == 1) || + (ARGV[0] == "help" && ARGV[1] == "app") || (ARGV[0] == "app" && ARGV.length == 1) + puts app_help + +# merb-gen generators +elsif ARGV[0] == "generators" # List all the Available Generators RubiGen::Base.use_component_sources! Merb.generator_scope - RubiGen::Scripts::Generate.new.run(ARGV) - + RubiGen::Scripts::Generate.new.run([]) + +# merb-gen help foo +elsif ARGV[0] && ARGV[0] == "help" + begin + RubiGen::Base.use_component_sources! Merb.generator_scope + RubiGen::Base.lookup(ARGV[1]) + Merb::ComponentGenerator.run ARGV[1], ARGV[2..-1], ARGV[1], command || "generate" + rescue RubiGen::GeneratorError + # List all the Available Generators + RubiGen::Base.use_component_sources! Merb.generator_scope + RubiGen::Scripts::Generate.new.run([]) + rescue => e + puts e.message + end + +# merb-gen app myapp +elsif ARGV[0] && ARGV[0] == "app" && ARGV[1] && ARGV[1] !~ /^-/ + app_type = case ARGV[2] + when "--flat" + "merb_flat" + when "--very-flat" + "merb_very_flat" + else + "merb" + end + Merb::ApplicationGenerator.run ARGV[1], ARGV[3..-1], app_type, command || "generate" + # merb-gen plugin foo elsif ARGV[0] && ARGV[0] == "plugin" Merb::ApplicationGenerator.run ARGV[1], ARGV[2..-1], "merb_plugin", command || "generate" @@ -39,32 +85,9 @@ elsif ARGV[0] && ARGV[0] == "frozen-merb" elsif ARGV[1] && ARGV[1] !~ /^-/ Merb::ComponentGenerator.run ARGV[1], ARGV[1..-1], ARGV.first, command || "generate" -# merb-gen foo --flat -elsif ARGV[1] && ARGV[1] == "--flat" - Merb::ApplicationGenerator.run ARGV.first, ARGV[2..-1], "merb_flat", command || "generate" - -# merb-gen foo --very-flat -elsif ARGV[1] && ARGV[1] == "--very-flat" - Merb::ApplicationGenerator.run ARGV.first, ARGV[2..-1], "merb_very_flat", command || "generate" - - # catch all merb-gen -??? and display help instead of creating application in -??? elsif ARGV[0] && ARGV[0] =~ /^-/ - puts <<-EOF - Application Generators: - To generate an application use one of the following - merb-gen app_name (for a standard application) - merb-gen app_name --flat (for a flattened application) - merb-gen app_name --very-flat (for a single file application) - merb-gen frozen-merb (script to run from frozen gems/framework) - merb-gen plugin plugin_name (creates a plugin gem skeleton) - - Other Generators: - merb-gen - with no args will display all availble generators for the current configuration. - EOF - - + puts app_help else begin @@ -72,10 +95,9 @@ else RubiGen::Base.use_component_sources! Merb.generator_scope RubiGen::Base.lookup(ARGV[0]) Merb::ComponentGenerator.run ARGV[0], ARGV[1..-1], ARGV.first, command || "generate" + rescue RubiGen::GeneratorError + puts app_help rescue => e puts e.message - # merb-gen foo - # merb-gen foo --test - Merb::ApplicationGenerator.run ARGV.first, ARGV[1..-1], "merb", command || "generate" end end merb-gen/bin/merb-gen @@ -24,7 +24,7 @@ module Merb def self.run(name, argv, generator, command) app_root = Dir.pwd - # Merb.start :environment => 'development', :adapter => 'runner' + # Merb.start :environment => 'development' Gem.clear_paths Gem.path.unshift(app_root / "gems") @@ -32,7 +32,7 @@ module Merb require "rubigen/scripts/#{command}" RubiGen::Base.use_component_sources! Merb.generator_scope - RubiGen::Scripts.const_get(command.capitalize).new.run(argv, :generator => generator) + RubiGen::Scripts.const_get(command.capitalize).new.run(argv, :generator => generator, :destination => app_root) end end end \ No newline at end of file merb-gen/lib/merb-gen.rb @@ -24,15 +24,16 @@ class Merb::GeneratorBase < RubiGen::Base options["spec"] = true unless options["test"] # Set directories that should be optional based on command-line args - @choices = %w( test spec ) + @choices = %w(test spec) # Set the assigns that should be used for path-interpolation and building templates - @assigns = {:base_name => File.basename(@name)} + @assigns = {:base_name => File.basename(@name), :test_type => options["spec"] ? "rspec" : "test_unit"} FileUtils.mkdir_p @name copy_dirs copy_files + display_framework_selections end end @@ -50,4 +51,12 @@ class Merb::GeneratorBase < RubiGen::Base opts.on("-T", "--[no-]test", "Generate with Test::Unit") {|t| @options["test"] = true} end + def display_framework_selections + puts + puts "Your app will use the #{@assigns[:test_type]} test framework." + if Gem.cache.search("merb_#{@assigns[:test_type]}").size == 0 + puts "You need to install the merb_#{@assigns[:test_type]} gem." + end + puts + end end merb-gen/lib/merb-gen/base.rb @@ -1,6 +1,15 @@ MAIN_BINDING = binding unless defined?(MAIN_BINDING) module Merb::GeneratorHelpers + + # Remove "template/" from a file name + # + # ==== Parameters + # +path+<String>:: the path to relative-ize + # +dir+<String>:: a prefix directory to add into the relative-ized path + # + # ==== Returns + # String:: a relative-ized path def relative(path, dir = nil) path.gsub(/^#{base}\/templates(\/#{dir ? dir + "/" : ""})?/, "") end @@ -9,53 +18,91 @@ module Merb::GeneratorHelpers path.gsub(/%([^\}]*)%/) {|x| assigns[$1.to_sym]} end + # Establishes the directories of the template layout def copy_dirs - basedirs = Dir["#{base}/templates/**/*"]. - select {|x| File.directory?(x) && (!choices.include?(relative(x)) || options[relative(x)]) }. - map {|x| relative(x) } - - basedirs.each do |path| + select_template_directories.map { |x| relative(x) }.each do |path| m.directory interpolate_path(path) end end + # Copies all files within each directory of the template layout def copy_files - (Dir["#{base}/templates/**/*"] + Dir["#{base}/templates"]).each do |file| - - # Only continue if the file is a directory - next unless File.directory?(file) - - # Skip it if it's a choice (rspec vs. test/unit, for instance), and options["spec"] is not set. - next if (choices.include?(relative(file)) && !options[relative(file)]) - + select_template_directories(true).each do |file| # Remove "template/" from the glob filename dir = relative(file) - # Get all the files under the directory that are not directories or in the list of excluded templates above. - files = Dir["#{file}/*"].reject {|f| File.directory?(f)} + # Get all the files under the directory that are not directories or in + # the list of excluded templates above. + files = Dir["#{file.empty? ? "." : file}/*"].reject { |f| File.directory?(f) } next if files.empty? # We want to templatize any files that contain <% %> characters + #-- + # This is old code, should we need it: # templates, to_copy = files.partition {|file| !(file =~ /\.erb$/) && File.read(file) =~ /<%.*%>/} - templates, to_copy = files.partition {|file| File.read(file) =~ /<%.*%>/} + templates, to_copy = files.partition { |file| File.read(file) =~ /<%.*%>/ } # Make the paths relative to the directory we're inspecting - to_copy.map! {|f| relative(f, dir) } - templates.map! {|f| relative(f, dir) } + [to_copy, templates].each do |paths| + paths.map! { |f| relative(f, dir) } + end # Copy the files over - to_copy.each do |file_name| - m.file "#{dir}#{"/" unless dir.empty?}#{file_name}", - "#{interpolate_path(dir)}#{"/" unless dir.empty?}#{interpolate_path(file_name)}" + to_copy.each do |filename| + m.file( + file_name(dir, filename), + file_name(interpolate_path(dir), filename) + ) end # Copy the templates over - templates.each do |file_name| - m.template "#{dir}#{"/" unless dir.empty?}#{file_name}", - "#{interpolate_path(dir)}#{"/" unless dir.empty?}#{interpolate_path(file_name)}", assigns + templates.each do |filename| + m.template( + file_name(dir, filename), + file_name(interpolate_path(dir), interpolate_path(filename)) + ) end end - end + end + +private + + # Selects all *directories* in the 'templates' folder. This accounts for + # +choices+ and +options+. + # + # ==== Arguments + # +with_root+<true,false>:: whether or not to include the base/templates + # directory + # + # ==== Returns + # Array:: all directories found in the 'templates' folder. + def select_template_directories(with_root=false) + selected = Dir["#{base}/templates/**/*"].compact.select do |f| + File.directory?(f) && + (!choices.include?(relative(f)) || options[relative(f)]) + end + selected += ["#{base}/templates"] if with_root + return selected + end + + # This was extracted from +copy_files+. It appears to do the same thing as + # File.join, but it doesn't account for the OS. + # + # ==== Arguments + # +dir+<String>:: the directory to place the file in + # +name+<String>:: the name of said file + # + # ==== Returns + # String:: a string representing the path for some file + # + # ==== Examples + # > file_name("folder", "some_file.txt") + # => "folder/some_file.txt" + # > file_name("", "some_file.txt") + # => "some_file.txt" + def file_name(dir, name) + "#{dir}#{"/" unless dir.empty?}#{name}" + end end \ No newline at end of file merb-gen/lib/merb-gen/helpers.rb @@ -22,6 +22,10 @@ <%= " " * counter %> render <%= " " * counter %> end +<%= " " * counter %> def delete +<%= " " * counter %> render +<%= " " * counter %> end + <%= " " * counter %> def create <%= " " * counter %> render <%= " " * counter %> end merb-gen/merb_default_generators/resource_controller/templates/app/controllers/%controller_file_name%.rb @@ -1 +1 @@ -Your in index of the <%= full_controller_const %> \ No newline at end of file +You're in index of the <%= full_controller_const %> \ No newline at end of file merb-gen/merb_generators/controller/templates/app/views/%controller_file_name%/index.html.erb @@ -26,12 +26,18 @@ if File.directory?(framework) require "merb-core/core_ext/rubygems" else gem = Dir.glob(__DIR__ + "/gems/gems/merb-core-*").last - raise "Can't run frozen without framework/ or loca gem" unless gem - require gem + "/lib/core_ext/kernel" - require gem + "/lib/core_ext/rubygems" + raise "Can't run frozen without framework/ or local gem" unless gem + require gem + "/lib/merb-core/core_ext/kernel" + require gem + "/lib/merb-core/core_ext/rubygems" + + Gem.clear_paths + Gem.path.unshift(__DIR__+"/gems") end - require 'merb-core' +unless %w[-a --adapter -i --irb-console -r --script-runner].any? { |o| ARGV.index(o) } + ARGV.push *%w[-a mongrel] +end + Merb.frozen! Merb.start merb-gen/merb_generators/freezer/templates/script/frozen-merb @@ -2,7 +2,6 @@ require File.join(File.dirname(__FILE__), "<%= Array.new((controller_modules.siz describe <%= full_controller_const %>, "index action" do before(:each) do - @controller = <%= full_controller_const %>.build(fake_request) - @controller.dispatch('index') + dispatch_to(<%= full_controller_const %>, :index) end end \ No newline at end of file merb-gen/rspec_generators/merb_controller_test/templates/spec/controllers/%controller_full_file_path%_spec.rb @@ -2,7 +2,6 @@ require File.join(File.dirname(__FILE__), "<%= Array.new((controller_modules.siz describe <%= full_controller_const %>, "index action" do before(:each) do - @controller = <%= full_controller_const %>.build(fake_request) - @controller.dispatch('index') + dispatch_to(<%= full_controller_const %>, :index) end end \ No newline at end of file merb-gen/rspec_generators/merb_resource_controller_test/templates/spec/controllers/%controller_full_file_path%_spec.rb @@ -1,4 +1,4 @@ -class MerbControllerTestGenerator < Merb::GeneratorBase +class MerbResourceControllerTestGenerator < Merb::GeneratorBase attr_reader :controller_modules, :controller_class_name, :controller_file_name, merb-gen/test_unit_generators/merb_resource_controller_test/merb_resource_controller_test_generator.rb @@ -3,7 +3,7 @@ require 'rake/gempackagetask' PLUGIN = "merb-haml" NAME = "merb-haml" -VERSION = "0.9.0" +VERSION = "0.9.2" AUTHOR = "Yehuda Katz" EMAIL = "ykatz@engineyard.com" HOMEPAGE = "http://merb-plugins.rubyforge.org/merb-haml/" @@ -20,7 +20,7 @@ spec = Gem::Specification.new do |s| s.author = AUTHOR s.email = EMAIL s.homepage = HOMEPAGE - s.add_dependency('merb-core', '>= 0.9.0') + s.add_dependency('merb-core', '>= 0.9.2') s.require_path = 'lib' s.autorequire = PLUGIN s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*") @@ -31,7 +31,7 @@ Rake::GemPackageTask.new(spec) do |pkg| end task :install => [:package] do - sh %{sudo gem install pkg/#{NAME}-#{VERSION}} + sh %{sudo gem install pkg/#{NAME}-#{VERSION} --no-update-sources} end namespace :jruby do merb-haml/Rakefile @@ -1,6 +1,20 @@ -require "haml" -require "merb-haml/template" +# make sure we're running inside Merb +if defined?(Merb::Plugins) + require "haml" + require "merb-haml/template" + Merb::Plugins.add_rakefiles(File.join(File.dirname(__FILE__) / "merb-haml" / "merbtasks")) -Merb::BootLoader.after_app_loads do - require "sass/plugin" if File.directory?(Merb.dir_for(:stylesheet) / "sass") + Merb::BootLoader.after_app_loads do + if File.directory?(Merb.dir_for(:stylesheet) / "sass") + require "sass/plugin" + Sass::Plugin.options = Merb::Config[:sass] if Merb::Config[:sass] + end + end + + # Hack because Haml uses symbolize_keys + class Hash + def symbolize_keys! + self + end + end end \ No newline at end of file merb-haml/lib/merb-haml.rb @@ -1,26 +1,56 @@ module Merb::Template class Haml + + # Defines a method for calling a specific HAML template. + # + # ==== Parameters + # path<String>:: Path to the template file. + # name<~to_s>:: The name of the template method. + # mod<Class, Module>:: + # The class or module wherein this method should be defined. def self.compile_template(path, name, mod) path = File.expand_path(path) - config = (Merb::Plugins.config[:haml] || {}).inject({}) do |c, (k, v)| + config = (Merb::Config[:haml] || {}).inject({}) do |c, (k, v)| c[k.to_sym] = v c end.merge :filename => path template = ::Haml::Engine.new(File.read(path), config) template.def_method(mod, name) - name + name end module Mixin - def self.included(mod) - mod.alias_method :capture, :capture_haml - end - - def _buffer( binding ) - @_buffer = eval( "buffer.buffer", binding ) + # ==== Parameters + # string<String>:: The string to add to the HAML buffer. + # binding<Binding>:: + # Not used by HAML, but is necessary to conform to the concat_* + # interface. + def concat_haml(string, binding) + haml_buffer.buffer << string end + end Merb::Template.register_extensions(self, %w[haml]) end end + +module Haml + class Engine + + # ==== Parameters + # object<Class, Module>:: + # The class or module wherein this method should be defined. + # name<~to_s>:: The name of the template method. + # *local_names:: Local names to define in the HAML template. + def def_method(object, name, *local_names) + method = object.is_a?(Module) ? :module_eval : :instance_eval + + setup = "@_engine = 'haml'" + + object.send(method, "def #{name}(_haml_locals = {}); #{setup}; #{precompiled_with_ambles(local_names)}; end", + @options[:filename], 0) + end + + end +end merb-haml/lib/merb-haml/template.rb @@ -6,15 +6,9 @@ class HamlController < Merb::Controller end class PartialHaml < HamlController - def index - render - end end class HamlConfig < HamlController - def index - render - end end class PartialIvars < HamlController @@ -23,3 +17,15 @@ class PartialIvars < HamlController render end end + +class CaptureHaml < HamlController +end + +module Merb::ConcatHamlHelper + def concatter(&blk) + concat("<p>Concat</p>", blk.binding) + end +end + +class ConcatHaml < HamlController +end \ No newline at end of file merb-haml/spec/controllers/haml.rb @@ -11,7 +11,7 @@ describe "HAML" do c.body.should == ::Haml::Engine.new("#foo\n %p Partial").render end - it "should use the haml configuration in config/plugins.yml" do + it "should use the haml configuration in Merb::Config" do c = dispatch_to(HamlConfig, :index) c.body.should == ::Haml::Engine.new("#foo\n %foo", :autoclose => ["foo"]).render end @@ -20,4 +20,14 @@ describe "HAML" do c = dispatch_to(PartialIvars, :index) c.body.should == ::Haml::Engine.new("#foo\n %p Partial HAML").render end + + it "should support capture" do + c = dispatch_to(CaptureHaml, :index) + c.body.should == "<p>Hello</p>\n" + end + + it "should support concat" do + c = dispatch_to(ConcatHaml, :index) + c.body.should == "<p>Concat</p>" + end end merb-haml/spec/haml_spec.rb @@ -2,16 +2,14 @@ $TESTING=true $:.unshift File.join(File.dirname(__FILE__), '..', 'lib') require "rubygems" require "merb-core" - -Merb::Plugins.config[:haml] = {"autoclose" => ["foo"]} +require "spec" require "merb-haml" require File.dirname(__FILE__) / "controllers" / "haml" -Merb.start :environment => 'test', :adapter => 'runner' +Merb::Plugins.config[:haml] = { "autoclose" => ["foo"] } +Merb.start :environment => 'test' -require "merb-core/test/fake_request" -require "merb-core/test/request_helper" Spec::Runner.configure do |config| config.include Merb::Test::RequestHelper end merb-haml/spec/spec_helper.rb @@ -1,9 +1,10 @@ require 'rubygems' require 'rake/gempackagetask' +require "spec/rake/spectask" PLUGIN = "merb-mailer" NAME = "merb-mailer" -VERSION = "0.9.0" +VERSION = "0.9.2" AUTHOR = "Yehuda Katz" EMAIL = "wycats@gmail.com" HOMEPAGE = "http://merb-plugins.rubyforge.org/merb-mailer/" @@ -20,7 +21,8 @@ spec = Gem::Specification.new do |s| s.author = AUTHOR s.email = EMAIL s.homepage = HOMEPAGE - s.add_dependency('merb-core', '>= 0.9.0') + s.add_dependency('merb-core', '>= 0.9.2') + s.add_dependency("mailfactory", ">= 1.2.3") s.require_path = 'lib' s.autorequire = PLUGIN s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*") @@ -31,7 +33,7 @@ Rake::GemPackageTask.new(spec) do |pkg| end task :install => [:package] do - sh %{sudo gem install pkg/#{NAME}-#{VERSION}} + sh %{sudo gem install pkg/#{NAME}-#{VERSION} --no-update-sources} end namespace :jruby do @@ -41,4 +43,10 @@ namespace :jruby do sh %{#{SUDO} jruby -S gem install pkg/#{NAME}-#{Merb::VERSION}.gem --no-rdoc --no-ri} end -end \ No newline at end of file +end + +desc "Run all specs" +Spec::Rake::SpecTask.new("specs") do |t| + t.spec_opts = ["--format", "specdoc", "--colour"] + t.spec_files = Dir["spec/**/*_spec.rb"].sort +end merb-mailer/Rakefile @@ -1,3 +1,3 @@ require "merb-mailer/mailer" require "merb-mailer/mail_controller" -require "merb-mailer/merb_controller" \ No newline at end of file +require "merb-mailer/merb_controller" merb-mailer/lib/merb-mailer.rb @@ -1,5 +1,5 @@ module Merb - + # Sending mail from a controller involves three steps: # # * Set mail settings in merb_init.rb (Not shown here...see the Mailer docs). @@ -62,39 +62,64 @@ module Merb # * Attach files. # * Render layouts and other templates. # * Use any template engine supported by Merb. - + class MailController < AbstractController - - self._template_root = File.expand_path(self._template_root / "../mailers/views") + class_inheritable_accessor :_mailer_klass self._mailer_klass = Merb::Mailer - + attr_accessor :params, :mailer, :mail attr_reader :session, :base_controller - + + # ==== Parameters + # action<~to_s>:: The name of the action that will be rendered. + # type<~to_s>:: + # The mime-type of the template that will be rendered. Defaults to nil. + # controller<~to_s>:: + # The name of the controller that will be rendered. Defaults to + # controller_name. + # + # ==== Returns + # String:: The template location, i.e. ":controller/:action.:type". def _template_location(action, type = nil, controller = controller_name) "#{controller}/#{action}.#{type}" end - - # You can initialize a MailController with a series of parameters that can - # be used by methods in the class. You can also pass in a controller - # object, which will be available to the MailController methods as - # base_controller. + + # ==== Parameters + # params<Hash>:: Configuration parameters for the MailController. + # controller<Merb::Controller>:: The base controller. def initialize(params = {}, controller = nil) @params = params @base_controller = controller @session = (controller && controller.session) || {} super end - + + # Sets the template root to the default mailer view directory. + # + # ==== Parameters + # klass<Class>:: + # The Merb::MailController inheriting from the base class. + def self.inherited(klass) + super + klass.class_eval %{self._template_root = Merb.dir_for(:mailer) / "views"} + end + + # Override filters halted to return nothing. def filters_halted end - + # Allows you to render various types of things into the text and HTML parts # of an email If you include just text, the email will be sent as # plain-text. If you include HTML, the email will be sent as a multi-part # email. # + # ==== Parameters + # options<~to_s, Hash>:: + # Options for rendering the email or an action name. See examples below + # for usage. + # + # ==== Examples # There are a lot of ways to use render_mail, but it works similarly to the # default Merb render method. # @@ -159,15 +184,15 @@ module Merb # render_mail :html => :foo, :text => "BAR" def render_mail(options = @method) @_missing_templates = false # used to make sure that at least one template was found - # # If the options are not a hash, normalize to an action hash + # If the options are not a hash, normalize to an action hash options = {:action => {:html => options, :text => options}} if !options.is_a?(Hash) - + # Take care of the options opts_hash = {} opts = options.dup actions = opts.delete(:action) if opts[:action].is_a?(Hash) templates = opts.delete(:template) if opts[:template].is_a?(Hash) - + # Prepare the options hash for each format # We need to delete anything relating to the other format here # before we try to render the template. @@ -176,19 +201,16 @@ module Merb opts_hash[fmt] ||= actions[fmt] if actions && actions[fmt] opts_hash[:template] = templates[fmt] if templates && templates[fmt] end - - # require 'ruby-debug' - # debugger if $DEBUGGER - + # Send the result to the mailer { :html => "rawhtml=", :text => "text="}.each do |fmt,meth| begin local_opts = opts.merge(:format => fmt) local_opts.merge!(:layout => false) if opts_hash[fmt].is_a?(String) - + value = render opts_hash[fmt], local_opts @mail.send(meth,value) unless value.nil? || value.empty? - rescue => e + rescue Merb::ControllerExceptions::TemplateNotFound => e # An error should be logged if no template is found instead of an error raised if @_missing_templates Merb.logger.error(e) @@ -199,47 +221,56 @@ module Merb end @mail end - + # Attaches a file or multiple files to an email. You call this from a # method in your MailController (including a before filter). # + # ==== Parameters + # file_or_files<File, Array[File]>:: File(s) to attach. + # filename<String>:: + # type<~to_s>:: + # The attachment MIME type. If left out, it will be determined from + # file_or_files. + # headers<String, Array>:: Additional attachment headers. + # + # ==== Examples # attach File.open("foo") # attach [File.open("foo"), File.open("bar")] # - # You can also include the filename, mime-type, or headers in the - # subsequent parameters. - # # If you are passing an array of files, you should use an array of the # allowed parameters: # # attach [[File.open("foo"), "bar", "text/html"], [File.open("baz"), - # "bat", "text/css"] + # "bat", "text/css"] # # which would attach two files ("foo" and "baz" in the filesystem) as # "bar" and "bat" respectively. It would also set the mime-type as # "text/html" and "text/css" respectively. def attach( file_or_files, filename = file_or_files.is_a?(File) ? File.basename(file_or_files.path) : nil, type = nil, headers = nil) - @mail.attach(file_or_files, filename, type, headers) + @mailer.attach(file_or_files, filename, type, headers) end - - # take a method name to dispatch to and mail parameters for the MailFactory object. - # - # Available mail parameters include: - # to - # from - # replyto - # subject - # body - # cc - # - # Other parameters passed in will be interpreted as email headers, with _'s converted - # to -'s. + + # ==== Parameters + # method<~to_s>:: The method name to dispatch to. + # mail_params<Hash>:: Parameters to send to MailFactory (see below). + # + # ==== Options (mail_params) + # MailFactory recognizes the following parameters: + # * :to + # * :from + # * :replyto + # * :subject + # * :body + # * :cc + # + # Other parameters passed in will be interpreted as email headers, with + # underscores converted to dashes. def dispatch_and_deliver(method, mail_params) @mailer = self.class._mailer_klass.new(mail_params) @mail = @mailer.mail @method = method - + # dispatch and render use params[:action], so set it self.action_name = method @@ -252,26 +283,46 @@ module Merb end end - # A convenience method that creates a blank copy of the MailController and runs - # dispatch_and_deliver on it. + # A convenience method that creates a blank copy of the MailController and + # runs dispatch_and_deliver on it. + # + # ==== Parameters + # method<~to_s>:: The method name to dispatch to. + # mail_params<Hash>:: Parameters to send to MailFactory. + # send_params<Hash>:: Configuration parameters for the MailController. def self.dispatch_and_deliver(method, mail_params, send_params = {}) new(send_params).dispatch_and_deliver method, mail_params end - + protected + + # ==== Returns + # Hash:: The route from base controller. def route @base_controller.route if @base_controller end private # This method is here to overwrite the one in the general_controller mixin - # The method ensures that when a url is generated with a hash, it contains a controller + # The method ensures that when a url is generated with a hash, it contains + # a controller. + # + # ==== Parameters + # opts<Hash>:: The options to get the controller from (see below). + # + # ==== Options (opts) + # :controller<Merb::Controller>:: The controller. + # + # ==== Returns + # Merb::Controller:: + # The controller. If no controller was specified in opts, attempt to find + # it in the base controller params. def get_controller_for_url_generation(opts) controller = opts[:controller] || ( @base_controller.params[:controller] if @base_controller) - raise "No Controller Specified for url()" unless controller - controller + raise "No Controller Specified for url()" unless controller + controller end - - + + end end \ No newline at end of file merb-mailer/lib/merb-mailer/mail_controller.rb @@ -11,15 +11,16 @@ end module Merb - # You'll need a simple config like this in merb_init.rb if you want + # You'll need a simple config like this in init.rb if you want # to actually send mail: # # Merb::Mailer.config = { - # :host=>'smtp.yourserver.com', - # :port=>'25', - # :user=>'user', - # :pass=>'pass', - # :auth=>:plain # :plain, :login, :cram_md5, the default is no auth + # :host => 'smtp.yourserver.com', + # :port => '25', + # :user => 'user', + # :pass => 'pass', + # :auth => :plain # :plain, :login, :cram_md5, the default is no auth + # :domain => "localhost.localdomain" # the HELO domain provided by the client to the server # } # # or @@ -37,33 +38,48 @@ module Merb # m.deliver! class Mailer - + class_inheritable_accessor :config, :delivery_method, :deliveries attr_accessor :mail self.deliveries = [] - + + # Sends the mail using sendmail. def sendmail sendmail = IO.popen("#{config[:sendmail_path]} #{@mail.to}", 'w+') sendmail.puts @mail.to_s sendmail.close end - - # :plain, :login, or :cram_md5 + + # Sends the mail using SMTP. def net_smtp Net::SMTP.start(config[:host], config[:port].to_i, config[:domain], config[:user], config[:pass], config[:auth]) { |smtp| smtp.send_message(@mail.to_s, @mail.from.first, @mail.to.to_s.split(/[,;]/)) } end - + + # Tests mail sending by adding the mail to deliveries. def test_send deliveries << @mail end - + + # Delivers the mail with the specified delivery method, defaulting to + # net_smtp. def deliver! send(delivery_method || :net_smtp) end - + + # ==== Parameters + # file_or_files<File, Array[File]>:: File(s) to attach. + # filename<String>:: + # type<~to_s>:: + # The attachment MIME type. If left out, it will be determined from + # file_or_files. + # headers<String, Array>:: Additional attachment headers. + # + # ==== Raises + # ArgumentError:: + # file_or_files was not a File or an Array of File instances. def attach(file_or_files, filename = file_or_files.is_a?(File) ? File.basename(file_or_files.path) : nil, type = nil, headers = nil) if file_or_files.is_a?(Array) @@ -74,6 +90,8 @@ module Merb end end + # ==== Parameters + # o<Hash{~to_s => Object}>:: Configuration commands to send to MailFactory. def initialize(o={}) self.config = {:sendmail_path => '/usr/sbin/sendmail'} if config.nil? o[:rawhtml] = o.delete(:html) merb-mailer/lib/merb-mailer/mailer.rb @@ -1,19 +1,20 @@ class Merb::Controller # Sends mail via a MailController (a tutorial can be found in the # MailController docs). - # - # send_mail FooMailer, :bar, :from => "foo@bar.com", :to => "baz@bat.com" - # - # would send an email via the FooMailer's bar method. - # - # The mail_params hash would be sent to the mailer, and includes items - # like from, to subject, and cc. See - # Merb::MailController#dispatch_and_deliver for more details. - # - # The send_params hash would be sent to the MailController, and is - # available to methods in the MailController as <tt>params</tt>. If you do - # not send any send_params, this controller's params will be available to - # the MailController as <tt>params</tt> + # + # ==== Parameters + # klass<Class>:: The mailer class. + # method<~to_s>:: The method to call on the mailer. + # mail_params<Hash>:: + # Mailing parameters, e.g. :to and :cc. See + # Merb::MailController#dispatch_and_deliver for details. + # send_params<Hash>:: + # Params to send to the mailer. Defaults to the params of the current + # controller. + # + # ==== Examples + # # Send an email via the FooMailer's bar method. + # send_mail FooMailer, :bar, :from => "foo@bar.com", :to => "baz@bat.com" def send_mail(klass, method, mail_params, send_params = nil) klass.new(send_params || params, self).dispatch_and_deliver(method, mail_params) end merb-mailer/lib/merb-mailer/merb_controller.rb @@ -1,72 +1,22 @@ -Sat, 02 Feb 2008 12:23:56 GMT ~ info ~ Logfile created -Sat, 02 Feb 2008 12:23:56 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:24:11 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:24:21 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:25:42 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:30:41 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:30:45 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:33:00 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:34:37 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:38:07 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:38:54 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:43:21 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:44:15 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:44:33 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:48:30 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:51:27 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:51:51 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:52:06 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:52:16 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:53:21 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:57:17 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 12:57:45 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:01:00 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:01:11 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:01:19 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:02:52 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:03:00 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:04:40 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:05:02 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:05:11 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:07:12 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:08:37 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:09:59 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:10:21 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:11:04 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:11:31 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:11:47 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:12:11 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:13:24 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:13:46 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:13:56 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:15:47 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:17:23 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:17:40 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:18:56 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:21:26 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:21:38 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:21:42 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:22:31 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:22:43 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:22:46 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:23:54 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:24:05 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:24:10 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:27:16 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:31:01 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:31:17 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:32:48 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:32:58 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:33:04 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:33:17 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:36:04 GMT ~ Not Using Sessions -Sat, 02 Feb 2008 13:36:04 GMT ~ first sent to foo@bar.com about -Sat, 02 Feb 2008 13:36:04 GMT ~ second sent to foo@bar.com about -Sat, 02 Feb 2008 13:36:04 GMT ~ third sent to foo@bar.com about -Sat, 02 Feb 2008 13:36:04 GMT ~ fourth sent to foo@bar.com about -Sat, 02 Feb 2008 13:36:04 GMT ~ fifth sent to foo@bar.com about -Sat, 02 Feb 2008 13:36:04 GMT ~ sixth sent to foo@bar.com about -Sat, 02 Feb 2008 13:36:04 GMT ~ seventh sent to foo@bar.com about -Sat, 02 Feb 2008 13:36:04 GMT ~ eighth sent to foo@bar.com about -Sat, 02 Feb 2008 13:36:04 GMT ~ ninth sent to foo@bar.com about -Sat, 02 Feb 2008 13:36:04 GMT ~ {:before_filters_time=>5.0e-06, :after_filters_time=>5.0e-06, :action_time=>0.00041} + ~ Not Using Sessions + ~ first sent to foo@bar.com about + ~ second sent to foo@bar.com about + ~ third sent to foo@bar.com about + ~ fourth sent to foo@bar.com about + ~ fifth sent to foo@bar.com about + ~ sixth sent to foo@bar.com about + ~ seventh sent to foo@bar.com about + ~ eighth sent to foo@bar.com about + ~ ninth sent to foo@bar.com about + ~ {:action_time=>0.003697, :before_filters_time=>9.0e-06, :after_filters_time=>8.0e-06} + ~ Not Using Sessions + ~ first sent to foo@bar.com about + ~ second sent to foo@bar.com about + ~ third sent to foo@bar.com about + ~ fourth sent to foo@bar.com about + ~ fifth sent to foo@bar.com about + ~ sixth sent to foo@bar.com about + ~ seventh sent to foo@bar.com about + ~ eighth sent to foo@bar.com about + ~ ninth sent to foo@bar.com about + ~ {:action_time=>0.001046, :before_filters_time=>6.0e-06, :after_filters_time=>7.0e-06} merb-mailer/log/merb_test.log @@ -1,7 +1,5 @@ require File.dirname(__FILE__) + '/spec_helper' -require "merb-core/test/fake_request" -require "merb-core/test/request_helper" Spec::Runner.configure do |config| config.include Merb::Test::RequestHelper end @@ -10,6 +8,8 @@ class Merb::Mailer self.delivery_method = :test_send end +Merb.push_path(:mailer, File.join(File.dirname(__FILE__), "mailers")) + class TestMailController < Merb::MailController def first merb-mailer/spec/mail_controller_spec.rb @@ -3,9 +3,5 @@ $:.unshift File.join(File.dirname(__FILE__), '..', 'lib') require "rubygems" require "merb-core" require "merb-mailer" -module Merb - class MailController - self._template_root = File.expand_path(File.join(File.dirname(__FILE__), "mailers/views")) - end -end -Merb.start :environment => 'test', :adapter => 'runner' \ No newline at end of file + +Merb.start :environment => 'test' \ No newline at end of file merb-mailer/spec/spec_helper.rb @@ -4,7 +4,7 @@ require "spec/rake/spectask" PLUGIN = "merb-parts" NAME = "merb-parts" -VERSION = "0.9.0" +VERSION = "0.9.2" AUTHOR = "Hassox" EMAIL = "" HOMEPAGE = "http://merb-plugins.rubyforge.org/merb-parts/" @@ -21,7 +21,7 @@ spec = Gem::Specification.new do |s| s.author = AUTHOR s.email = EMAIL s.homepage = HOMEPAGE - s.add_dependency('merb-core', '>= 0.9.0') + s.add_dependency('merb-core', '>= 0.9.2') s.require_path = 'lib' s.autorequire = PLUGIN s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*") @@ -32,7 +32,7 @@ Rake::GemPackageTask.new(spec) do |pkg| end task :install => [:package] do - sh %{sudo gem install pkg/#{NAME}-#{VERSION}} + sh %{sudo gem install pkg/#{NAME}-#{VERSION} --no-update-sources} end namespace :jruby do @@ -48,4 +48,4 @@ desc "Run all specs" Spec::Rake::SpecTask.new("specs") do |t| t.spec_opts = ["--format", "specdoc", "--colour"] t.spec_files = Dir["spec/**/*_spec.rb"].sort -end \ No newline at end of file +end merb-parts/Rakefile @@ -1,6 +1,5 @@ require File.join(File.dirname(__FILE__), 'merb-parts','part_controller') - module Merb class Controller # Dispatches a PartController. merb-parts/lib/merb-parts.rb @@ -12,22 +12,42 @@ module Merb include Merb::Mixins::WebController attr_reader :params - + cattr_accessor :_subclasses self._subclasses = Set.new - def self.subclasses_list() _subclasses end - - self._template_root = File.expand_path(self._template_root / "../parts/views") + # ==== Returns + # Array[Class]:: Classes that inherit from Merb::PartController. + def self.subclasses_list() _subclasses end + + # ==== Parameters + # action<~to_s>:: The name of the action that will be rendered. + # type<~to_s>:: + # The mime-type of the template that will be rendered. Defaults to nil. + # controller<~to_s>:: + # The name of the controller that will be rendered. Defaults to + # controller_name. + # + # ==== Returns + # String:: The template location, i.e. ":controller/:action.:type". def _template_location(action, type = nil, controller = controller_name) "#{controller}/#{action}.#{type}" end - + + # Sets the template root to the default parts view directory. + # + # ==== Parameters + # klass<Class>:: + # The Merb::PartController inheriting from the base class. def self.inherited(klass) _subclasses << klass.to_s super + klass.class_eval %{self._template_root = Merb.dir_for(:part) / "views"} end + # ==== Parameters + # web_controller<Merb::Controller>:: The controller calling this part. + # opts<Hash>:: Additional options for this part. def initialize(web_controller, opts = {}) @web_controller = web_controller @params = @web_controller.params @@ -36,10 +56,20 @@ module Merb @content_type = @web_controller.content_type end + # ==== Parameters + # action<~to_s>:: An action to dispatch to. Defaults to :to_s. + # + # ==== Returns + # String:: The part body. def _dispatch(action=:to_s) self.action_name = action super(action) @body end + + # Send any methods that are missing back up to the web controller + def method_missing(sym, *args, &blk) + @web_controller.send(sym, *args, &blk) + end end end \ No newline at end of file merb-parts/lib/merb-parts/part_controller.rb @@ -1,4 +1,5 @@ class Main < Merb::Controller + self._template_root = File.dirname(__FILE__) / ".." / "views" def index part TodoPart => :list @@ -21,4 +22,8 @@ class Main < Merb::Controller part(TodoPart => :part_with_params, :my_param => "my_value") end + def part_within_view + render + end + end \ No newline at end of file merb-parts/spec/fixtures/controllers/main.rb @@ -47,6 +47,11 @@ describe "A Merb PartController" do controller.body.should match( /my_param = my_value/) end + it "should render from inside a view" do + controller = dispatch_to(Main, :part_within_view) + controller.body.should match( /Do this/) + end + end merb-parts/spec/merb-parts_spec.rb @@ -5,10 +5,7 @@ require File.join( File.dirname(__FILE__), "..", "lib", "merb-parts" ) # Require the fixtures Dir[File.join(File.dirname(__FILE__), "fixtures", "*/**.rb")].each{|f| require f } -Merb.start :environment => 'test', :adapter => 'runner' - -require "merb-core/test/fake_request" -require "merb-core/test/request_helper" +Merb.start :environment => 'test' Spec::Runner.configure do |config| config.include Merb::Test::RequestHelper merb-parts/spec/spec_helper.rb merb-test/LICENSE merb-test/README merb-test/Rakefile merb-test/TODO merb-test/lib/helpers/controller_helper.rb merb-test/lib/helpers/hpricot_helper.rb merb-test/lib/merb-test.rb merb-test/lib/test_ext/hpricot.rb merb-test/lib/test_ext/object.rb merb-test/spec/helpers/hpricot_helper_spec.rb merb-test/spec/merb-test/fake_request_spec.rb merb-test/spec/merb-test/multipart_spec.rb merb-test/spec/spec_helper.rb bf1c5f2764d5123200899dca5ad4c0993be9df07 d87c825208e831f2cae153475d461c7f93ec39ba Simon Rozet simon@rozet.name http://github.com/sr/merb-more/commit/1ec0dd01c760b024a74804356b37425d52dae8d6 1ec0dd01c760b024a74804356b37425d52dae8d6 2008-03-25T12:26:36-07:00 2008-03-25T12:26:36-07:00 Merge git://github.com/wycats/merb-more be05c50014111edbd6f8da831eda491d046d73e6 Simon Rozet simon@rozet.name