ramaze 2011.01.30 → 2011.07.25

data/lib/ramaze/spec/bacon.rb

@@ -10,9 +10,9 @@ require File.expand_path('../', __FILE__) unless defined?(Ramaze)
 require 'innate/spec/bacon'
 
 # minimal middleware, no exception handling
-Ramaze.middleware!(:spec){|m|
+Ramaze.middleware!(:spec) do |m|
   m.run(Ramaze::AppMap)
-}
+end
 
 shared :rack_test do
   Ramaze.setup_dependencies
@@ -26,8 +26,11 @@ shared :webrat do
 
   require 'webrat'
 
-  Webrat.configure{|config| config.mode = :rack }
+  Webrat.configure { |config| config.mode = :rack }
 
   extend Webrat::Methods
   extend Webrat::Matchers
 end
+
+# Ignore log messages
+Ramaze::Log.level = Logger::ERROR

data/lib/ramaze/spec/helper/bacon.rb

@@ -4,5 +4,4 @@ require 'bacon'
 require 'ramaze/spec/helper/pretty_output'
 
 Bacon.extend Bacon::PrettyOutput
-# Bacon.extend Bacon::TestUnitOutput
 Bacon.summary_on_exit

data/lib/ramaze/version.rb

@@ -1,3 +1,3 @@
 module Ramaze
-  VERSION = "2011.01.30"
+  VERSION = "2011.07.25"
 end

data/lib/ramaze/view.rb

@@ -7,21 +7,14 @@ module Ramaze
   # This is a container module for wrappers of templating engines and handles
   # lazy requiring of needed engines.
   module View
-
     # Combine Kernel#autoload and Innate::View::register
-
     def self.auto_register(name, *exts)
       autoload(name, "ramaze/view/#{name}".downcase)
       register("Innate::View::#{name}", *exts)
     end
 
-    # TODO:
-    # * markaby - though we should advertise remarkably instead
-    # * XSLT    - this one is just crazy, someone up for the task?
-
     # Engines provided by Innate are:
     # ERB, Etanni, None
-
     auto_register :Erector,    :erector
     auto_register :Erubis,     :erubis,  :rhtml
     auto_register :Ezamar,     :zmr
@@ -30,14 +23,12 @@ module Ramaze
     auto_register :Less,       :lss, :less
     auto_register :Liquid,     :liquid
 	  auto_register :Lokar,      :lok
-    auto_register :Maruku,     :mkd, :md
     auto_register :Nagoro,     :nag
-    auto_register :RedCloth,   :redcloth
     auto_register :Remarkably, :rem
     auto_register :Sass,       :sass
     auto_register :Tagz,       :tagz
     auto_register :Tenjin,     :rbhtml, :tenjin
     auto_register :Slippers,   :st
     auto_register :Mustache,   :mt
-  end
-end
+  end # View
+end # Ramaze

data/lib/ramaze/view/erector.rb

@@ -3,26 +3,36 @@ require 'erector'
 module Ramaze  
   module View
     ##
-    # Adapter for Erector. Erector is a view engine that works a bit like Markably but offers
-    # a much more pleasant way of building your views. By creating classes in plain ruby you can generate
-    # layouts and views without having to write a single line of HTML.
+    # Adapter for Erector. Erector is a view engine that works a bit like
+    # Markably but offers a much more pleasant way of building your views. By
+    # creating classes in plain ruby you can generate layouts and views without
+    # having to write a single line of HTML.
     #
-    # Each layout or view is a simple class that matches the filename. A layout named "default.erector" would result in
-    # a class with the name "Default". It's *very* important to know that you should ALWAYS extend Ramaze::View::Erector.
-    # Without extending this class you won't be able to use Erector at all.
+    # Each layout or view is a simple class that matches the filename. A layout
+    # named "default.erector" would result in a class with the name "Default".
+    # It's *very* important to know that you should ALWAYS extend
+    # Ramaze::View::Erector.  Without extending this class you won't be able to
+    # use Erector at all.
     #
-    # When working with the Erector adapter there are a few things you'll need to know. First all your views and layouts should be classes
-    # as explained earlier on. Each class should have at least a single method named "content". This method is executed by Erector and 
-    # the HTML it produces will either be stored in the @content instance variable (if it's a view) or sent to the browser if it's a layout.
-    # The @content variable can be displayed by calling the rawtext() method and passing the variable as it's parameter.
+    # When working with the Erector adapter there are a few things you'll need
+    # to know. First all your views and layouts should be classes as explained
+    # earlier on. Each class should have at least a single method named
+    # "content". This method is executed by Erector and the HTML it produces
+    # will either be stored in the @content instance variable (if it's a view)
+    # or sent to the browser if it's a layout.  The @content variable can be
+    # displayed by calling the rawtext() method and passing the variable as it's
+    # parameter.
     #
-    # Using helper methods, such as the render_* methods is also possible although slightly different than you're used to. Due to the way
-    # the Erector adapter works it isn't possible to directly call a helper method. As a workaround you can access these methods from the 
-    # "@controller" instance variable. Don't forget to render the output of these helpers using rawtext(). Feel free to submit any patches if you
-    # think you have a better solution so that developers don't have to use the @controller instance variable.
+    # Using helper methods, such as the render_* methods is also possible
+    # although slightly different than you're used to. Due to the way the
+    # Erector adapter works it isn't possible to directly call a helper method.
+    # As a workaround you can access these methods from the "@controller"
+    # instance variable. Don't forget to render the output of these helpers
+    # using rawtext(). Feel free to submit any patches if you think you have a
+    # better solution so that developers don't have to use the @controller
+    # instance variable.
     #
     # @example
-    # 
     #   # This is the code for the layout
     #   class Default < Erector::Widget
     #     html do
@@ -54,19 +64,22 @@ module Ramaze
     # @author  Yorick Peterse
     #
     module Erector
-      # Include the Erector gem. By doing this Erector views can extend the Erector gem without
-      # causing any namespace errors.
+      # Include the Erector gem. By doing this Erector views can extend the
+      # Erector gem without causing any namespace errors.
       include ::Erector
       
       ##
-      # The call method is called whenever a view is loaded. A view can either be a layout or an actual view
-      # since they're treated the same way. First the view is loaded, followed by the layout.
+      # The call method is called whenever a view is loaded. A view can either
+      # be a layout or an actual view since they're treated the same way. First
+      # the view is loaded, followed by the layout.
       #
       # @author Yorick Peterse
-      # @param [Object] action Object containing a copy of the current Action class data.
-      # @param [String] string The content of the currently loaded layout. This variable isn't used by the Erector adapter
-      # but is required since Ramaze expects 2 parameters. Usually this string is used to inline load (or evaluate) the content
-      # of a view.
+      # @param [Object] action Object containing a copy of the current Action 
+      #  class data.
+      # @param [String] string The content of the currently loaded layout. This
+      #  variable isn't used by the Erector adapter but is required since Ramaze 
+      #  expects 2 parameters. Usually this string is used to inline load (or 
+      #  evaluate) the content of a view.
       # @return [String] The generated HTML.
       #
       def self.call action, string
@@ -79,23 +92,25 @@ module Ramaze
         eval string
 
         # Generate the class name based on the filename.
-        # Class names are a CamelCased version of the filename (without the extension).
+        # Class names are a CamelCased version of the filename (without the 
+        # extension).
         klass    = File.basename action.view, '.erector'
         klass    = klass.camel_case
         view_obj = self.const_get(klass)
         
-        # Synchronize the methods of action.instance with the view. These methods can be accessed
-        # by calling @controller.METHOD
+        # Synchronize the methods of action.instance with the view. These 
+        # methods can be accessed by calling @controller.METHOD
         action.variables[:controller] = action.instance
 
         # Now that we have all the data we can start rendering the HTML.
-        # Note that we pass the action.variables hash to the new() method. This is done to give the view access to all existing 
-        # (instance) variables. Syncing them using action.copy_variables didn't seem to do the trick.
+        # Note that we pass the action.variables hash to the new() method. This
+        # is done to give the view access to all existing (instance) variables. 
+        # Syncing them using action.copy_variables didn't seem to do the trick.
         html = view_obj.new(action.variables).to_html
 
         # All done
         return html, 'text/html'
       end
-    end
-  end
-end
+    end # Erector
+  end # View
+end # Ramaze

data/lib/ramaze/view/erubis.rb

@@ -5,6 +5,10 @@ require 'erubis'
 
 module Ramaze
   module View
+    ##
+    # View adapter for the Erubis template engine. More information about Erubis
+    # can be found here: http://www.kuwata-lab.com/erubis/
+    #
     module Erubis
       OPTIONS = { :engine => ::Erubis::Eruby }
 
@@ -18,6 +22,6 @@ module Ramaze
 
         return html, 'text/html'
       end
-    end
-  end
-end
+    end # Erubis
+  end # View
+end # Ramaze

data/lib/ramaze/view/ezamar.rb

@@ -2,6 +2,10 @@ require 'ezamar'
 
 module Ramaze
   module View
+    ##
+    # View adapter for the Ezamar template engine. More information about this
+    # engine can be found here: https://github.com/manveru/ezamar
+    #
     module Ezamar
       TRANSFORM_PIPELINE = [ ::Ezamar::Element ]
 
@@ -18,6 +22,6 @@ module Ramaze
 
         ::Ezamar::Template.new(template, :file => file)
       end
-    end
-  end
-end
+    end # Ezamar
+  end # View
+end # Ramaze

data/lib/ramaze/view/gestalt.rb

@@ -2,6 +2,12 @@ require 'ramaze/gestalt'
 
 module Ramaze
   module View
+    ##
+    # View adapter that allows you to use Ramaze::Gestalt in your views. See the
+    # documentation of Ramaze::Gestalt for more information.
+    #
+    # @see Ramaze::Gestalt
+    #
     module Gestalt
       def self.call(action, string)
         string = action.instance.instance_eval(string) if action.view
@@ -9,6 +15,6 @@ module Ramaze
 
         return html, 'text/html'
       end
-    end
-  end
-end
+    end # Gestalt
+  end # View
+end # Ramaze

data/lib/ramaze/view/haml.rb

@@ -3,6 +3,10 @@ require 'haml/engine'
 
 module Ramaze
   module View
+    ##
+    # View adapter that allows views to use Haml, for more information see the
+    # following website: http://haml-lang.com/
+    #
     module Haml
       def self.call(action, string)
         options = action.options
@@ -17,6 +21,6 @@ module Ramaze
 
         return html, 'text/html'
       end
-    end
-  end
-end
+    end # Haml
+  end # View
+end # Ramaze

data/lib/ramaze/view/liquid.rb

@@ -95,6 +95,6 @@ module Ramaze
         @arg =~ /^(['"])(.*?)\1\s+(.*)/
         Ramaze::Current.action.node.anchor($2, $3)
       end
-    end
-  end
-end
+    end # Liquid
+  end # View
+end # Ramaze

data/lib/ramaze/view/lokar.rb

@@ -2,6 +2,10 @@ require 'lokar'
 
 module Ramaze
   module View
+    ##
+    # Allows views to use Lokar as the template engine. See the following
+    # website for more information: https://github.com/Zoxc/Lokar
+    #
     module Lokar
       def self.call(action, string)
         compiled = View.compile(string){|s| ::Lokar.compile(s, action.view || __FILE__) }
@@ -9,6 +13,6 @@ module Ramaze
 
         return html, 'text/html'
       end
-    end
-  end
-end
+    end # Helper
+  end # View
+end # Ramaze

data/lib/ramaze/view/mustache.rb

@@ -9,6 +9,12 @@ module Ramaze
     #
     # @see http://github.com/defunkt/mustache
     module Mustache
+      class RamazeContext < ::Mustache::Context
+        def escapeHTML(str)
+          str.escape(:html)
+        end
+      end
+
       def self.call(action, string)
         context, path, ext = class_defined?(action)
 
@@ -22,7 +28,7 @@ module Ramaze
       end
 
       def self.class_defined?(action)
-        return ::Mustache::Context.new(nil), nil, nil unless action.view
+        return RamazeContext.new(nil), nil, nil unless action.view
 
         path = File.dirname(action.view)
 
@@ -33,8 +39,8 @@ module Ramaze
           ::Mustache
         end
 
-        return ::Mustache::Context.new(klass.new), path, View.exts_of(self).first
+        return RamazeContext.new(klass.new), path, View.exts_of(self).first
       end
-    end
-  end
-end
+    end # Mustache
+  end # View
+end # Ramaze

data/lib/ramaze/view/nagoro.rb

@@ -39,6 +39,6 @@ module Ramaze
 
         return html, 'text/html'
       end
-    end
-  end
-end
+    end # Nagoro
+  end # View
+end # Ramaze

data/lib/ramaze/view/sass.rb

@@ -1,5 +1,5 @@
 require 'haml/util'
-require 'sass/engine'
+require 'sass'
 
 module Ramaze
   module View

data/lib/ramaze/view/slippers.rb

@@ -2,23 +2,50 @@ require 'slippers'
 
 module Ramaze
   module View
+    ##
+    # View adapter for Slippers, see the website of Slippers for more
+    # information: http://starapor.github.com/slippers/
+    #
+    #
     module Slippers
       def self.call(action, string)
-        slippers = View.compile(string){|s| ::Slippers::Engine.new(s, :template_group => template_group(action)) }
+        slippers = View.compile(string) do |s|
+          ::Slippers::Engine.new(s, :template_group => template_group(action))
+        end
+
         object_to_render = ::Slippers::BindingWrapper.new(action.instance.binding)
-        html = slippers.render(object_to_render)
+        html             = slippers.render(object_to_render)
+
         return html, 'text/html'
       end
-      
+
       private
-        def self.template_group(action)
-          subtemplates = action.instance.ancestral_trait[:slippers_options] || {}
-          missing_template_handler = action.instance.ancestral_trait[:slippers_missing_template_handler]
-          default_string = action.instance.ancestral_trait[:slippers_default_string]
-          views = action.instance.options[:views].map{|view| "#{action.instance.options[:roots]}/#{view}" }
-          super_group = ::Slippers::TemplateGroup.new(:templates => subtemplates, :missing_template_handler => missing_template_handler, :default_string => default_string)
-          ::Slippers::TemplateGroupDirectory.new(views, :super_group => super_group, :missing_template_handler => missing_template_handler, :default_string => default_string)          
+
+      def self.template_group(action)
+        subtemplates = action.instance.ancestral_trait[:slippers_options] || {}
+        missing_template_handler = action.instance.ancestral_trait[
+          :slippers_missing_template_handler
+        ]
+        default_string = action.instance.ancestral_trait[
+          :slippers_default_string
+        ]
+
+        views = action.instance.options[:views].map do |view|
+          "#{action.instance.options[:roots]}/#{view}"
         end
-    end
-  end
-end
+
+        super_group = ::Slippers::TemplateGroup.new(
+          :templates                => subtemplates, 
+          :missing_template_handler => missing_template_handler, 
+          :default_string           => default_string
+        )
+        
+        ::Slippers::TemplateGroupDirectory.new(
+          views, :super_group       => super_group, 
+          :missing_template_handler => missing_template_handler, 
+          :default_string           => default_string
+        )
+      end
+    end # Slippers
+  end # View
+end # Ramaze

data/lib/ramaze/view/tagz.rb

@@ -39,11 +39,15 @@ module Ramaze
         end
 
         def p(*a)
-          a.each{|elem| tagz << "#{ Rack::Utils.escape_html elem.inspect }#{ eol }"}
+          a.each do |elem|
+            tagz << "#{ Rack::Utils.escape_html elem.inspect }#{ eol }"
+          end
         end
 
         def pp(*a)
-          a.each{|elem| tagz << "#{ Rack::Utils.escape_html PP.pp(elem, '') }#{ eol }"}
+          a.each do |elem|
+            tagz << "#{ Rack::Utils.escape_html PP.pp(elem, '') }#{ eol }"
+          end
         end
 
         def eol
@@ -58,6 +62,6 @@ module Ramaze
           concat eol
         end
       end
-    end
-  end
-end
+    end # Tagz
+  end # View
+end # Ramaze