isaac-malline 1.1.0

data/lib/malline/view_proxy.rb

@@ -0,0 +1,87 @@
+# 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
+	# Every tag returns a ViewProxy object that binds the tag to the template.
+	# ViewProxy also chains the process by returning itself.
+	#
+	# This Proxy object then makes possible the attribute syntax:
+	# 	div.foo.bar! { stuff }
+	#
+	# div returns new ViewProxy instance, so div.foo actually calls
+	# ViewProxy#foo, which is then generated to class="foo" -attribute to the
+	# original tag div. div.foo returns the same ViewProxy, and foo.bar! calls
+	# ViewProxy#bar!, which is interpreted as a id="bar" -attribute.
+	#
+	# Finally the given block { stuff } is evaluated the same way than it would
+	# be evaluated without the ViewProxy:
+	#   div { stuff }
+	class ViewProxy
+		def initialize template, tag
+			@tpl = template
+			@tag = tag
+		end
+
+		# Allows to add new content to already closed tag, for example:
+		# 	t = div do
+		# 		_'text'
+		# 	end
+		# 	t.__yld :whitespace { stuff }
+		#
+		# Intended for internal use only
+		def __yld *args, &block
+			# div :title => 'data'
+			if args.last.is_a?(Hash)
+				@tag[:attrs].merge!(args.pop)
+			end
+
+			# Modifiers
+			whitespace = @tpl.whitespace
+			@tpl.whitespace = true if args.delete(:whitespace)
+
+			# Rest is just content separated by a space
+			txt = args.flatten.join ' '
+			@tag[:children] << txt unless txt.empty?
+
+			# Block
+			@tpl.execute @tag[:children], &block if block_given?
+
+			# Restore modifiers
+			@tpl.whitespace = whitespace
+
+			# Chain the calls, for example: div.foo.bar!.yeah.boring
+			self
+		end
+
+		# Capture attribute definitions, special modifiers and blocks
+		def method_missing s, *args, &block
+			# div.id!
+			if /^(.*)!$/ =~ s.to_s
+				@tag[:attrs]['id'] = $1
+			elsif s
+				# div.class
+				if @tag[:attrs]['class']
+					@tag[:attrs]['class'] << " #{s}"
+				else
+					@tag[:attrs]['class'] = s.to_s
+				end
+			end
+
+			__yld *args, &block
+		end
+	end
+end

data/lib/malline/view_wrapper.rb

@@ -0,0 +1,95 @@
+# 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
+	# ViewWrapper is extended into used view object, like ActiveView::Base.
+	# Every method in ViewWrapper will pollute the original namespace.
+	module ViewWrapper
+		# List of all methods that may override some custom view methods
+		# If is_malline?, then their _malline_ -prefix versions are called
+		@@malline_methods = %w{_erbout capture _ tag! << txt!}
+
+		# Initialize @@malline_methods
+		def init_malline_methods
+			@malline_methods_inited = true
+			@@malline_methods.each do |m|
+				mf = m.gsub('<', 'lt')
+				eval %{def #{m}(*x, &b) is_malline? ? _malline_#{mf}(*x, &b) : super; end}
+			end
+		end
+
+		# Returns a current Template instance, makes a new if called first time
+		# Can also be used to set options to Template by giving them as hash opts:
+		# 	malline :whitespace => true
+		def malline opts = nil
+			if @malline
+				@malline.options.merge!(opts) if opts.is_a?(Hash)
+			else
+				@malline = Template.new(self, opts || {})
+			end
+			init_malline_methods unless @malline_methods_inited
+			@malline
+		end
+		
+		# erbout emulator
+		def _malline__erbout
+			@_erbout ||= ErbOut.new(self)
+		end
+
+		# capture and return the output of the block
+		def _malline_capture &block
+			@malline.run &block
+		end
+
+		# _'escaped text'
+		def _malline__ *args
+			@malline.add_text(*args)
+		end
+		alias_method :_malline_txt!, :_malline__
+
+		# self << "<unescaped text>"
+		def _malline_ltlt *args
+			@malline.add_unescaped_text *args
+		end
+
+		# Define a new tag of call a helper (if _prefixed)
+		def method_missing s, *args, &block
+			return super unless is_malline?
+			if @malline.tags[s]
+				@malline.tag s, *args, &block
+			else
+				helper = ((s.to_s[0] == ?_) ? s.to_s[1..-1] : s).to_sym
+				if respond_to?(helper)
+					@malline.helper(helper, *args, &block)
+				else
+					return super if @malline.options[:strict]
+					_malline_tag! s, *args, &block
+				end
+			end
+		end
+
+		# Define a new tag
+		def _malline_tag! *args, &block
+			@malline.tag *args, &block
+		end
+
+		# Are we in a Malline template
+		def is_malline?
+			true
+		end
+	end
+end

data/malline.gemspec

@@ -0,0 +1,34 @@
+Gem::Specification.new do |s|
+  s.name = %q{malline}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Riku Palom\303\244ki"]
+  s.date = %q{2008-09-06}
+  s.default_executable = %q{malline}
+  s.description = %q{Malline is a full-featured template system designed to be a replacement for ERB views in Rails or any other framework. It also includes standalone bin/malline to compile Malline templates to XML in commandline. All Malline templates are pure Ruby, see http://www.malline.org/ for more info.  See documentation on http://www.malline.org/  Copyright © 2007,2008 Riku Palomäki, riku@palomaki.fi Malline is released under GNU Lesser General Public License.   Example Rails template file images.html.mn:  xhtml do _render :partial => 'head' body do div.images! "There are some images:" do images.each do |im| a(:href => img_path(im)) { img :src => im.url } span.caption im.caption end _"No more images" end div.footer! { _render :partial => 'footer' } end end}
+  s.email = ["riku@palomaki.fi"]
+  s.executables = ["malline"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["COPYING", "COPYING.LESSER", "History.txt", "Manifest.txt", "README", "README.txt", "Rakefile", "bin/malline", "github.rb", "init.rb", "lib/malline.rb", "lib/malline/adapters/rails-2.0.rb", "lib/malline/adapters/rails-2.1.rb", "lib/malline/erb_out.rb", "lib/malline/form_builder.rb", "lib/malline/plugin.rb", "lib/malline/plugins/xhtml.rb", "lib/malline/rails.rb", "lib/malline/template.rb", "lib/malline/view_proxy.rb", "lib/malline/view_wrapper.rb", "malline.gemspec", "scripts/html2mn.rb", "test/examples/_action.mn", "test/examples/_action.target", "test/examples/_one.mn", "test/examples/_one.target", "test/examples/_partial.mn", "test/examples/_partial.target", "test/examples/_three.rhtml", "test/examples/_two.mn", "test/examples/_two.target", "test/examples/capture.mn", "test/examples/capture.target", "test/examples/class.mn", "test/examples/class.target", "test/examples/escape.mn", "test/examples/escape.target", "test/examples/frontpage.mn", "test/examples/frontpage.target", "test/examples/hello_world.mn", "test/examples/hello_world.target", "test/examples/helper.mn", "test/examples/helper.target", "test/examples/helper2.mn", "test/examples/helper2.target", "test/examples/helper_shortcut.mn", "test/examples/helper_shortcut.target", "test/examples/id.mn", "test/examples/id.target", "test/examples/layout.mn", "test/examples/layout.target", "test/examples/lists.mn", "test/examples/lists.target", "test/examples/nested.mn", "test/examples/nested.target", "test/examples/options.mn", "test/examples/options.target", "test/examples/partials.mn", "test/examples/partials.target", "test/examples/self.mn", "test/examples/self.target", "test/examples/text.mn", "test/examples/text.target", "test/examples/whitespace.mn", "test/examples/whitespace.target", "test/examples/xhtml.mn", "test/examples/xhtml.target", "test/kernel.org.html", "test/kernel.org.mn", "test/malline_test.rb", "test/malline_test_helpers.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://www.malline.org/}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{malline}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Malline is a full-featured template system designed to be a replacement for ERB views in Rails or any other framework}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_runtime_dependency(%q<hoe>, [">= 1.5.3"])
+    else
+      s.add_dependency(%q<hoe>, [">= 1.5.3"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 1.5.3"])
+  end
+end

data/scripts/html2mn.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# 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 "rexml/document"
+include REXML
+
+def html_unescape str
+	str.to_s.gsub('&amp;', '&').gsub('&quot;', '"').gsub('&gt;', '>').gsub('&lt;', '<')
+end
+
+def esc str
+	if str =~ /["#]/ || !(str =~ /'/)
+		"'"+(str.split("'").join("\\'"))+"'"
+	else
+		"\"#{str}\""
+	end
+end
+
+def attributes element
+	element.attributes.keys.collect {|k| "#{esc k} => #{esc html_unescape(element.attributes[k])}" }.join(', ')
+end
+
+def txtize txt
+	#txt.gsub(/(\s)\s*$/, '\1').gsub(/^(\s)\s*/, '\1')
+	txt.gsub(/\s*$/, '').gsub(/^\s*/, '')
+end
+
+def convert element, prefix=''
+	valid_method = /^[A-Za-z][\w_]*$/
+	output = ''
+	if element.is_a?(Array)
+		element.each {|e| output << convert(e) }
+	elsif element.is_a?(Element)
+		output << prefix << element.name
+		attrs = []
+		element.attributes['class'].to_s.split.uniq.each do |cl|
+			if valid_method =~ cl
+				output << ".#{cl}"
+			else
+				attrs << cl
+			end
+		end
+		element.attributes.delete('class')
+		element.attributes['class'] = attrs.join(' ') unless attrs.empty?
+		if element.attributes['id'].to_s =~ valid_method
+			output << ".#{element.attributes['id']}!"
+			element.attributes.delete('id')
+		end
+		txt = ''
+		children = element.children
+		unless children.empty?
+			if children.first.is_a?(Text)
+				txt = txtize children.shift.to_s
+				output << " #{esc html_unescape(txt)}" unless txt.empty?
+			end
+		end
+
+		output << (txt.empty? ? ' ' : ', ') << attributes(element) if element.has_attributes?
+		unless children.empty?
+			output << " do\n"
+			children.each {|e| output << convert(e, prefix + "\t") }
+			output << prefix << "end"
+		end
+		output << "\n"
+	elsif element.is_a?(Text)
+		txt = txtize(element.to_s)
+		output << prefix << "txt! #{esc html_unescape(txt)}\n" unless txt.empty?
+	end
+	output
+end
+
+input = File.open(ARGV.shift, 'r') rescue $stdin
+output = File.open(ARGV.shift, 'w') rescue $stdout
+
+doc = Document.new input
+
+
+output.puts convert(doc.children)

data/test/examples/_action.mn

@@ -0,0 +1,4 @@
+@title = 'Data'
+ul.data! do
+	3.times {|i| li "Data #{i}" }
+end

data/test/examples/_action.target

@@ -0,0 +1 @@
+<ul id="data"><li>Data 0</li><li>Data 1</li><li>Data 2</li></ul>

data/test/examples/_one.mn

@@ -0,0 +1 @@
+span.one 'This is the first'

data/test/examples/_one.target

@@ -0,0 +1 @@
+<span class="one">This is the first</span>

data/test/examples/_partial.mn

@@ -0,0 +1,2 @@
+# This is just a stupid partial
+div 'I always thought something was fundamentally wrong with the universe.'

data/test/examples/_partial.target

@@ -0,0 +1 @@
+<div>I always thought something was fundamentally wrong with the universe.</div>

data/test/examples/_three.rhtml

@@ -0,0 +1,2 @@
+Blop, <%= 'this is rhtml'.upcase %>.
+<%= render :partial => 'examples/two' %>

data/test/examples/_two.mn

@@ -0,0 +1 @@
+img :src => image_path('second')

data/test/examples/_two.target

@@ -0,0 +1 @@
+<img src="/images/img"/>

data/test/examples/capture.mn

@@ -0,0 +1,13 @@
+div do
+	@foo = capture do
+		div do
+			img :src => '/images/image.png'
+			br
+			span.caption 'Taken at the location of the event'
+		end
+	end
+
+	h4 'Captured'
+	self << @foo
+	_'EOF'
+end

data/test/examples/capture.target

@@ -0,0 +1 @@
+<div><h4>Captured</h4><div><img src="/images/image.png"/><br/><span class="caption">Taken at the location of the event</span></div>EOF</div>

data/test/examples/class.mn

@@ -0,0 +1,6 @@
+# These two things are the same
+div :class => 'page'
+div.page
+
+# You can even give more than one class
+div.foo.bar.many

data/test/examples/class.target

@@ -0,0 +1 @@
+<div class="page"></div><div class="page"></div><div class="foo bar many"></div>

data/test/examples/escape.mn

@@ -0,0 +1,4 @@
+p 'Do you know, that 2 < 5?', :title => '2 < 5'
+p do
+	_'Me & Myself & Malline'
+end

data/test/examples/escape.target

@@ -0,0 +1 @@
+<p title="2 &lt; 5">Do you know, that 2 &lt; 5?</p><p>Me &amp; Myself &amp; Malline</p>

data/test/examples/frontpage.mn

@@ -0,0 +1,6 @@
+div.page do
+	h1 'Header one'
+	ul.list! do
+		li { a 'Link to somewhere', :href => '/foo' }
+	end
+end

data/test/examples/frontpage.target

@@ -0,0 +1 @@
+<div class="page"><h1>Header one</h1><ul id="list"><li><a href="/foo">Link to somewhere</a></li></ul></div>

data/test/examples/hello_world.mn

@@ -0,0 +1,2 @@
+# Lets say hello to the world
+div 'Hello world', :title => 'Hello'

data/test/examples/hello_world.target

@@ -0,0 +1 @@
+<div title="Hello">Hello world</div>

data/test/examples/helper.mn

@@ -0,0 +1,5 @@
+def rot13 name
+	'<div>' + (name.tr "A-Za-z", "N-ZA-Mn-za-m") + '</div>'
+end
+
+self << rot13('secret stuff')

data/test/examples/helper.target

@@ -0,0 +1 @@
+<div>frperg fghss</div>

data/test/examples/helper2.mn

@@ -0,0 +1,5 @@
+def rot13 name
+	div name.tr("A-Za-z", "N-ZA-Mn-za-m")
+end
+
+rot13('frperg fghss')

data/test/examples/helper2.target

@@ -0,0 +1 @@
+<div>secret stuff</div>

data/test/examples/helper_shortcut.mn

@@ -0,0 +1,5 @@
+p do
+	# These two do exactly the same
+	self << link_to('Frontpage', '/')
+	_link_to('Frontpage', '/')
+end

data/test/examples/helper_shortcut.target

@@ -0,0 +1 @@
+<p>linklink</p>

data/test/examples/id.mn

@@ -0,0 +1,3 @@
+# id:s are given by shouting loud enough
+div.page!
+div.foo.page!.bar

data/test/examples/id.target

@@ -0,0 +1 @@
+<div id="page"></div><div class="foo bar" id="page"></div>

data/test/examples/layout.mn

@@ -0,0 +1,8 @@
+xhtml do
+	head do
+		title @title
+	end
+	body do
+		self << @content_for_layout
+	end
+end