isaac-malline 1.1.0

data/lib/malline/adapters/rails-2.0.rb

@@ -0,0 +1,72 @@
+# Copyright © 2007,2008 Riku Palomäki
+#
+# This file is part of Malline.
+#
+# Malline is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Malline is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Malline.  If not, see <http://www.gnu.org/licenses/>.
+
+ActionView::Base.register_template_handler 'rb', Malline::Base
+module ActionView
+	# We need to redefine some ActionView::Base methods, Since Rails 2.0 doesn't
+	# offer any better way to do some things.
+	class Base
+		alias_method :orig_render_template, :render_template
+		# We want to save the name of the current file to @current_tpl_path,
+		# because then the error backtrace from Rails will include the
+		# name of the file. I didn't find better way to get this
+		def render_template template_extension, template, file_path = nil, *rest
+			@current_tpl_path = file_path
+			orig_render_template(template_extension, template, file_path, *rest)
+		end
+
+		alias_method :orig_compile_and_render_template, :compile_and_render_template
+		def compile_and_render_template handler, *rest
+			if self.respond_to? :is_malline?
+				old, @malline_is_active = is_malline?, false
+				output = orig_compile_and_render_template handler, *rest
+				@malline_is_active = old
+				output
+			else
+				@malline_is_active = false
+				orig_compile_and_render_template handler, *rest
+			end
+		end
+
+		alias_method :orig_delegate_render, :delegate_render
+		# Update the current file to malline and tell Malline to be deactivated
+		# if there is a non-Malline partial inside Malline template.
+		def delegate_render(handler, template, local_assigns)
+			old = is_malline?
+			tmp = if handler == Malline::Base
+				h = handler.new(self)
+				h.path = @current_tpl_path if @current_tpl_path
+				@malline_is_active = true
+				h.render(template, local_assigns)
+			else
+				@malline_is_active = false
+				orig_delegate_render(handler, template, local_assigns)
+			end
+			@malline_is_active = old
+			tmp
+		end
+	end
+end
+
+module Malline::ViewWrapper
+	# Activate Malline if we are not using ActionView::Base or if
+	# the current template is a Malline template
+	def is_malline?
+		@malline_is_active.nil? ? true : @malline_is_active
+	end
+end
+

data/lib/malline/adapters/rails-2.1.rb

@@ -0,0 +1,103 @@
+# Copyright © 2007,2008 Riku Palomäki
+#
+# This file is part of Malline.
+#
+# Malline is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Malline is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Malline.  If not, see <http://www.gnu.org/licenses/>.
+
+module Malline
+	# Malline template handler for Rails 2.1
+	#
+	# We use Compilable-interface, even though Malline templates really doesn't
+	# compile into anything, but at least template files won't always be re-read
+	# from files. Builder templates (.builder|.rxml) also use this interface.
+	class RailsHandler < ActionView::TemplateHandler
+		include ActionView::TemplateHandlers::Compilable
+
+		# We have three lines framework code before real template code in
+		# 'compiled code'
+		def self.line_offset
+			3
+		end
+
+		# Compiles the template, i.e. return a runnable ruby code that initializes
+		# a new Malline::Base objects and renders the template.
+		def compile template
+			path = template.path.gsub('\\', '\\\\\\').gsub("'", "\\\\'")
+			"__malline_handler = Malline::Base.new self
+			malline.path = '#{path}'
+			__malline_handler.render do
+				#{template.source}
+			end"
+		end
+
+		# Get the rendered fragment contents
+		def cache_fragment block, name = {}, options = nil
+			@view.fragment_for(block, name, options) do
+				eval("__malline_handler.rendered", block.binding)
+			end
+		end
+	end
+end
+
+module Malline::ViewWrapper
+	# Activate Malline if we are not using ActionView::Base or if
+	# the current template is a Malline template
+	def is_malline?
+		!(is_a?(ActionView::Base) && ActionView::Template.handler_class_for_extension(
+				current_render_extension) != Malline::RailsHandler)
+	end
+end
+
+# Rails has a bug with current_render_extension, lets fix it
+if ActionView.const_defined?('Renderer')
+	module ActionView::Renderer
+		alias_method :orig_render, :render
+		def render *args
+			out = orig_render *args
+			@view.current_render_extension = @prev_extension 
+			out
+		end
+
+		alias_method :orig_prepare!, :prepare!
+		def prepare! *args
+			@prev_extension = @view.current_render_extension
+			orig_prepare! *args
+		end
+	end
+else
+	class ActionView::Template
+		alias_method :orig_render, :render
+		def render *args
+			out = orig_render *args
+			@view.current_render_extension = @prev_extension
+			out
+		end
+
+		alias_method :orig_prepare!, :prepare!
+		def prepare! *args
+			@prev_extension = @view.current_render_extension
+			orig_prepare! *args
+		end
+	end
+	class ActionView::PartialTemplate
+		alias_method :orig_render, :render
+		def render *args
+			out = orig_render *args
+			@view.current_render_extension = @prev_extension
+			out
+		end
+	end
+end
+
+ActionView::Template.register_template_handler 'rb', Malline::RailsHandler

data/lib/malline/erb_out.rb

@@ -0,0 +1,34 @@
+# Copyright © 2007,2008 Riku Palomäki
+#
+# This file is part of Malline.
+#
+# Malline is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Malline is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Malline.  If not, see <http://www.gnu.org/licenses/>.
+
+module Malline
+	# Since some parts of Rails use ERB directly instead of current template
+	# handler, we have to capture all that data.
+	#
+	# In practice the erb buffer object (named ActiveView::Base.erb_variable)
+	# is a string, where data is simply concatted.
+	class ErbOut
+		def initialize view
+			@view = view
+		end
+		# Redirect all data to view
+		def concat value
+			@view << value
+		end
+		alias_method :<<, :concat
+	end
+end

data/lib/malline/form_builder.rb

@@ -0,0 +1,44 @@
+# Copyright © 2007,2008 Riku Palomäki
+#
+# This file is part of Malline.
+#
+# Malline is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Malline is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Malline.  If not, see <http://www.gnu.org/licenses/>.
+
+module Malline
+	# Capture form elements directly from FormBuilder, so that there is no
+	# need to specially render any elements.
+	# In other words, with our own FormBuilder-wrapper we can do this:
+	# 	form_for :comment, Comment.new, :url => edit_url do |f|
+	# 		f.text_field :name
+	# 	end
+	# instead of
+	# 	..
+	# 	self << f.text_field(:name)
+	class FormBuilder
+		# Wrap the Rails FormBuilder in @builder
+		def initialize *args, &block
+			@view = eval('self', args.last)
+			@builder = ::ActionView::Helpers::FormBuilder.new(*args, &block)
+		end
+		# Render every f.foo -method to view, unless we aren't using
+		# Malline template now
+		def method_missing *args, &block
+			if @view && @view.is_malline?
+				@view << @builder.send(*args, &block)
+			else
+				@builder.send(*args, &block)
+			end
+		end
+	end
+end

data/lib/malline/plugin.rb

@@ -0,0 +1,34 @@
+# Copyright © 2007,2008 Riku Palomäki
+#
+# This file is part of Malline.
+#
+# Malline is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Malline is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Malline.  If not, see <http://www.gnu.org/licenses/>.
+
+# Malline very incomplete Plugin interface.
+class Malline::Plugin
+	# Install a new plugin: Malline::WhatEverPlugin.install view
+	def self.install view
+		return if view.malline.plugins.include? self
+		self.do_install view
+		view.malline.plugins << self
+	end
+
+	protected
+	def self.do_install view
+		raise NotImplementedError.new
+	end
+	def self.do_uninstall view
+		raise NotImplementedError.new("#{self} cannot be uninstalled")
+	end
+end

data/lib/malline/plugins/xhtml.rb

@@ -0,0 +1,77 @@
+# Copyright © 2007,2008 Riku Palomäki
+#
+# This file is part of Malline.
+#
+# Malline is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Malline is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Malline.  If not, see <http://www.gnu.org/licenses/>.
+
+# Quite stupid plugin for XHTML, we should be able to do this only with a DTD
+# or similar.
+#
+# Defines all usable tags, list which one can be self-close, defines a short
+# cut tag *xhtml*. Also makes sure that there is some necessary elements in
+# the document.
+class Malline::XHTML < Malline::Plugin
+	CUSTOM_TAGS = %w{head title meta}
+
+	# grep ELEMENT xhtml1-transitional.dtd | cut -d' ' -f2 | tr "\n" " "
+	XHTML_TAGS = %w{html head title base meta link style script noscript iframe
+		noframes body div p h1 h2 h3 h4 h5 h6 ul ol menu dir li dl dt dd address
+		hr pre blockquote center ins del a span bdo br em strong dfn code samp
+		kbd var cite abbr acronym q sub sup tt i b big small u s strike basefont
+		font object param applet img map area form label input select optgroup
+		option textarea fieldset legend button isindex table caption thead tfoot
+		tbody colgroup col tr th td} - CUSTOM_TAGS
+
+	# grep 'ELEMENT.*EMPTY' xhtml1-transitional.dtd | cut -d' ' -f2 | tr "\n" " "
+	SHORT_TAG_EXCLUDES = XHTML_TAGS + CUSTOM_TAGS - %w{base meta link hr br
+		basefont param img area input isindex col}
+
+	module Tags
+	 	def xhtml *args, &block
+			attrs = { :xmlns => 'http://www.w3.org/1999/xhtml', 'xml:lang' => malline.options[:lang] }
+			attrs.merge!(args.pop) if args.last.is_a?(Hash)
+
+			self << "<?xml version=\"1.0\" encoding=\"#{malline.options[:encoding] || 'UTF-8'}\"?>\n"
+			self << "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 #{malline.options[:xhtml_dtd] || 'Transitional'}//EN\"\n"
+			self << "  \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-#{(malline.options[:xhtml_dtd] || 'Transitional').downcase}.dtd\">\n"
+
+			tag! 'html', args.join(''), attrs, &block
+		end
+
+		def title *args, &block
+			@__xhtml_title = true
+			tag! 'title', *args, &block
+		end
+
+		def meta *args, &block
+			@__xhtml_meta = true
+			tag! 'meta', *args, &block
+		end
+
+		def head *args, &block
+			@__xhtml_title = false
+			proxy = tag! 'head', *args, &block
+			proxy.__yld { title } unless @__xhtml_title
+			proxy.__yld do
+				meta :content => "text/html; charset=#{malline.options[:encoding] || 'UTF-8'}", 'http-equiv' => 'Content-Type'
+			end unless @__xhtml_meta
+		end
+	end
+
+	def self.do_install view
+		view.malline.definetags! XHTML_TAGS
+		view.malline.short_tag_excludes += SHORT_TAG_EXCLUDES
+		view.extend Tags
+	end
+end

data/lib/malline/rails.rb

@@ -0,0 +1,46 @@
+# Copyright © 2007,2008 Riku Palomäki
+#
+# This file is part of Malline.
+#
+# Malline is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Malline is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Malline.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'malline' unless Kernel.const_defined?('Malline')
+require 'malline/form_builder.rb'
+
+if Rails::VERSION::STRING <= "2.0.z"
+	require 'malline/adapters/rails-2.0'
+else
+	require 'malline/adapters/rails-2.1'
+end
+
+# Activate our FormBuilder wrapper, so we can use forms more easily
+ActionView::Base.default_form_builder = Malline::FormBuilder
+
+module Malline::ViewWrapper
+	@@malline_methods << 'cache'
+
+	# Rails caching
+	def _malline_cache name = {}, options = {}, &block
+		return block.call unless @controller.perform_caching
+		cache = @controller.read_fragment(name, options)
+
+		unless cache
+			cache = _malline_capture { block.call }
+			@controller.write_fragment(name, cache, options)
+		end
+		@malline.add_unescaped_text cache
+	end
+end
+
+

data/lib/malline/template.rb

@@ -0,0 +1,185 @@
+# Copyright © 2007,2008 Riku Palomäki
+#
+# This file is part of Malline.
+#
+# Malline is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Malline is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Malline.  If not, see <http://www.gnu.org/licenses/>.
+
+module Malline
+	# This is the class that really evaluates the template and is accessible
+	# from the view by "malline", for example:
+	# 	malline.path = 'File name'
+	class Template
+		# Current options (like @@options in Base)
+		attr_accessor :options
+		# List of every tag that doesn't support self-closing syntax
+		attr_accessor :short_tag_excludes
+		# Current state of :whitespace-modifier (bool)
+		attr_accessor :whitespace
+		# Current file name
+		attr_accessor :path
+		# Every overriden (in definetags!) helper method (:name => method)
+		attr_accessor :helper_overrides
+		# Every available tag, excluding the specific methods (:name => bool)
+		attr_accessor :tags
+		# Render result of the last #render
+		attr_reader :rendered
+		# List all installed plugins
+		attr_accessor :plugins
+
+		def initialize view, opts
+			@view = view
+			@whitespace = false
+			@path = 'Malline template'
+			@options = opts
+			@short_tag_excludes = []
+			@helper_overrides = {}
+			@tags = {}
+			@plugins = []
+			@inited = false
+		end
+
+		# Install plugins and do every thing that cannot be done in initialize
+		# Plugin install will use @view.malline, that will create a duplicate
+		# Template instance, if it's called from initialize.
+		def init
+			return if @inited
+			XHTML.install @view if @options[:xhtml]
+		end
+
+		# Stolen from ERB, © 1999-2000,2002,2003 Masatoshi SEKI
+		def self.html_escape(s)
+			s.to_s.gsub(/&/, "&amp;").gsub(/\"/, "&quot;").gsub(/>/, "&gt;").gsub(/</, "&lt;")
+		end
+		# Stolen from ERB, © 1999-2000,2002,2003 Masatoshi SEKI
+		def self.url_encode(s)
+			s.to_s.gsub(/[^a-zA-Z0-9_\-.]/n){ sprintf("%%%02X", $&.unpack("C")[0]) }
+		end
+
+		# Changes dom to active @dom, and executes tpl / block
+		def execute dom, tpl = nil, &block
+			tmp = @dom
+			@dom = dom
+			if block_given?
+				@view.instance_eval &block
+			else
+				@view.instance_eval tpl, @path
+			end
+			@dom = tmp
+		end
+
+		# Add escaped string to @dom
+		def add_text *values
+			@dom << ' ' if @whitespace
+			@dom << Template.html_escape(values.join(' '))
+		end
+
+		# Add unescaped string to @dom
+		def add_unescaped_text value
+			@dom << ' ' if @whitespace
+			@dom << value.to_s unless value.nil?
+		end
+
+		# Call a helper (a method defined outside malline whose
+		# output is stored to @dom)
+		def helper helper, *args, &block
+			helper = helper.to_sym
+			tmp = if h = @helper_overrides[helper]
+				h.call *args, &block
+			else
+				@view.send helper, *args, &block
+			end
+			@dom << ' ' if @whitespace
+			@dom << tmp.to_s
+			tmp
+		end
+
+		# Add a tag to @dom
+		def tag s, *args, &block
+			tag = { :name => s.to_s, :attrs => {}, :children => [] }
+
+			tag[:whitespace] = true if @whitespace
+			whitespace = @whitespace
+			@whitespace = true if args.delete(:whitespace)
+
+			if args.last.is_a?(Hash)
+				tag[:attrs].merge!(args.pop)
+			end
+
+			txt = args.flatten.join('')
+			tag[:children] << Template.html_escape(txt) unless txt.empty?
+
+			@dom << tag
+			execute tag[:children], &block if block_given?
+			@whitespace = whitespace
+
+			ViewProxy.new self, tag
+		end
+
+		# Render the XML tree at dom or @dom
+		def render dom = nil
+			@rendered = (dom || @dom).inject('') do |out, tag|
+				if tag.is_a?(String)
+					out << tag
+				else
+					out << ' ' if tag[:whitespace]
+					out << "<#{tag[:name]}"
+					out << tag[:attrs].inject(''){|s, a| s + " #{a.first}=\"#{Template.html_escape(a.last)}\""}
+
+					if tag[:children].empty?
+						if @short_tag_excludes.include?(tag[:name])
+							out << "></#{tag[:name]}>"
+						else
+							out << '/>'
+						end
+					else
+						out << '>'
+						out << render(tag[:children])
+						out << "</#{tag[:name]}>"
+					end
+				end
+			end
+		end
+
+		# Execute and render a text or block
+		def run tpl = nil, &block
+			init
+			tmp = []
+			execute tmp, tpl, &block
+			render tmp
+		end
+
+		# Define tags as a methods, overriding all same named methods
+		def definetags! *tags
+			tags.flatten.each do |tag|
+				tag = tag.to_sym
+				@helper_overrides[tag] = @view.method(tag) if @view.respond_to?(tag)
+				define_tag! tag
+			end
+		end
+
+		# Marking tags as usable, but not overriding anything
+		def definetags *tags
+			tags.flatten.each{|tag| @tags[tag] = true }
+		end
+
+		# Define a method tag
+		def define_tag! tag
+			eval %{
+				def @view.#{tag}(*args, &block)
+					tag!('#{tag}', *args, &block)
+				end
+			}
+		end
+	end
+end