RubyGems - mab - Versions diffs - 0.0.1 → 0.0.2 - Mend

mab 0.0.1 → 0.0.2

Files changed (88) hide show

data/COPYING +19 -0
data/Gemfile +10 -0
data/Gemfile.lock +12 -0
data/README.md +224 -0
data/Rakefile +8 -0
data/bench.rb +37 -0
data/lib/mab/mixin.rb +58 -42
data/lib/mab/version.rb +1 -1
data/mab-0.0.1.gem +0 -0
data/mab.gemspec +20 -0
data/markaby/CHANGELOG.rdoc +106 -0
data/markaby/Markaby.gemspec +109 -0
data/markaby/README.rdoc +317 -0
data/markaby/Rakefile +78 -0
data/markaby/VERSION +1 -0
data/markaby/garlic.rb +29 -0
data/markaby/init.rb +6 -0
data/markaby/lib/markaby.rb +30 -0
data/markaby/lib/markaby/builder.rb +314 -0
data/markaby/lib/markaby/builder_tags.rb +64 -0
data/markaby/lib/markaby/cssproxy.rb +55 -0
data/markaby/lib/markaby/kernel_method.rb +7 -0
data/markaby/lib/markaby/rails.rb +75 -0
data/markaby/lib/markaby/rails/current.rb +85 -0
data/markaby/lib/markaby/rails/deprecated.rb +124 -0
data/markaby/lib/markaby/rails/rails_builder.rb +91 -0
data/markaby/lib/markaby/sinatra.rb +18 -0
data/markaby/lib/markaby/tags.rb +200 -0
data/markaby/lib/markaby/tilt.rb +8 -0
data/markaby/spec/markaby/builder_spec.rb +118 -0
data/markaby/spec/markaby/css_proxy_test.rb +47 -0
data/markaby/spec/markaby/fragment_test.rb +10 -0
data/markaby/spec/markaby/markaby_other_static.mab +1 -0
data/markaby/spec/markaby/markaby_spec.rb +184 -0
data/markaby/spec/markaby/markaby_test.rb +251 -0
data/markaby/spec/markaby/rails/spec_helper.rb +29 -0
data/markaby/spec/markaby/rails/views/layouts/layout.mab +11 -0
data/markaby/spec/markaby/rails/views/markaby/_a_partial.mab +3 -0
data/markaby/spec/markaby/rails/views/markaby/_form_for_with_body_in_erb.erb +1 -0
data/markaby/spec/markaby/rails/views/markaby/_partial_child_with_locals.mab +1 -0
data/markaby/spec/markaby/rails/views/markaby/access_to_helpers.mab +1 -0
data/markaby/spec/markaby/rails/views/markaby/broken.mab +7 -0
data/markaby/spec/markaby/rails/views/markaby/commented_out_template.mab +1 -0
data/markaby/spec/markaby/rails/views/markaby/correct_template_values.mab +5 -0
data/markaby/spec/markaby/rails/views/markaby/double_output.mab +8 -0
data/markaby/spec/markaby/rails/views/markaby/form_for.mab +2 -0
data/markaby/spec/markaby/rails/views/markaby/form_for_with_fields.mab +3 -0
data/markaby/spec/markaby/rails/views/markaby/form_for_with_multiple_fields.mab +4 -0
data/markaby/spec/markaby/rails/views/markaby/no_values_passed.mab +3 -0
data/markaby/spec/markaby/rails/views/markaby/partial_parent.mab +1 -0
data/markaby/spec/markaby/rails/views/markaby/partial_parent_with_locals.mab +7 -0
data/markaby/spec/markaby/rails/views/markaby/render_erb_without_explicit_render_call.erb +1 -0
data/markaby/spec/markaby/rails/views/markaby/render_explicit_but_empty_markaby_layout.mab +0 -0
data/markaby/spec/markaby/rails/views/markaby/render_mab_without_explicit_render_call.mab +3 -0
data/markaby/spec/markaby/rails/views/markaby/render_with_ivar.mab +3 -0
data/markaby/spec/markaby/rails/views/markaby/renders_erb.rhtml +1 -0
data/markaby/spec/markaby/rails/views/markaby/renders_form_for_with_erb_body.mab +3 -0
data/markaby/spec/markaby/rails/views/markaby/routes.mab +1 -0
data/markaby/spec/markaby/rails/views/markaby/yielding.mab +3 -0
data/markaby/spec/markaby/rails/views/markaby/yielding_content_for_with_block_helper.mab +5 -0
data/markaby/spec/markaby/rails/views/markaby/yielding_two.mab +7 -0
data/markaby/spec/markaby/rails/views/markaby/yielding_with_content_for.mab +3 -0
data/markaby/spec/markaby/rails_test.rb +380 -0
data/markaby/spec/markaby/rails_version_spec.rb +37 -0
data/markaby/spec/markaby/sinatra/app.rb +49 -0
data/markaby/spec/markaby/sinatra/sinatra_spec.rb +67 -0
data/markaby/spec/markaby/sinatra/views/helpers.mab +1 -0
data/markaby/spec/markaby/sinatra/views/layout.mab +7 -0
data/markaby/spec/markaby/sinatra/views/markaby_template.mab +0 -0
data/markaby/spec/markaby/sinatra/views/scope_instance_variables.mab +3 -0
data/markaby/spec/markaby/sinatra/views/simple_html.mab +4 -0
data/markaby/spec/markaby/sinatra/views/variables.mab +3 -0
data/markaby/spec/markaby/tilt/erb.erb +1 -0
data/markaby/spec/markaby/tilt/locals.mab +1 -0
data/markaby/spec/markaby/tilt/markaby.mab +1 -0
data/markaby/spec/markaby/tilt/markaby_other_static.mab +1 -0
data/markaby/spec/markaby/tilt/render_twice.mab +1 -0
data/markaby/spec/markaby/tilt/scope.mab +1 -0
data/markaby/spec/markaby/tilt/yielding.mab +2 -0
data/markaby/spec/markaby/tilt_spec.rb +75 -0
data/markaby/spec/spec.opts +2 -0
data/markaby/spec/spec_helper.rb +44 -0
data/test/helper.rb +4 -0
data/test/test_mab_builder.rb +56 -0
data/test/test_mab_indentation.rb +66 -0
data/test/test_mab_kernel_method.rb +10 -0
data/test/test_mab_mixin.rb +246 -0
metadata +92 -6

data/COPYING ADDED

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Magnus Holm <judofyr@gmail.com>
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Gemfile ADDED

@@ -0,0 +1,10 @@
+source :rubygems
+group :development do
+  gem "rake"
+end
+group :test do
+  gem "minitest"
+end

data/Gemfile.lock ADDED

@@ -0,0 +1,12 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    minitest (2.10.0)
+    rake (0.9.2.2)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  minitest
+  rake

data/README.md ADDED

@@ -0,0 +1,224 @@
+Mab (Markup as Ruby)
+====================
+Mab let's you write HTML in plain Ruby:
+```ruby
+doctype!
+html do
+  head do
+    link :rel => 'stylesheet', :href => 'style.css'
+    script :src => 'jquery.js'
+  end
+  body :id => :frontpage do
+    h1 'Hello World', :class => :main
+  end
+end
+```
+Syntax
+------
+### 1. Tags and Attributes
+There are four basic forms:
+```ruby
+tagname(content)
+tagname(content, attributes)
+tagname do
+  content
+end
+tagname(attributes) do
+  content
+end
+```
+Example:
+```ruby
+doctype!
+html do
+  head do
+    link :rel => 'stylesheet', :href => 'style.css'
+    script :src => 'jquery.js'
+  end
+  body :id => :frontpage do
+    h1 'Hello World', :class => :main
+  end
+end
+```
+Which results in:
+```html
+<!DOCTYPE html>
+<html>
+  <head>
+    <link rel="stylesheet" href="style.css">
+    <script src="jquery"></script>
+  </head>
+  <body id="frontpage">
+    <h1 class="main">Hello World</h1>
+  </body>
+</html>
+```
+Notice how Mab knows that script tag must have content, so although you didn't
+specify anything it closed the tag for you.
+### 2. Element Classes and IDs
+You can easily add classes and IDs by hooking methods onto the container:
+```ruby
+body.frontpage! do
+  h1.main 'Hello World'
+end
+```
+Which results in:
+```html
+<body id="frontpage">
+  <h1 class="main">Hello World</h1>
+</body>
+```
+You can mix and match as you'd like (`div.klass.klass1.id!`), but you can only
+provide content and attributes on the *last* call:
+```ruby
+# This is not valid:
+form(:action => :post).world do
+  input
+end
+# But this is:
+form.world(:action => :post) do
+  input
+end
+```
+### 3. Escape or Not Escape
+Mab uses a very simple convention for escaping: Strings as *arguments* gets
+escaped, strings in *blocks* don't:
+```ruby
+div.comment "<script>alert(1)</script>"
+# <div class="comment">&lt;script&gt;alert(1)&lt;/script&gt;</div>
+div.comment { "I <strong>love</strong> you" }
+# <div class="comment">I <strong>love</strong> you</div>
+```
+Be aware that Mab ignores the string in a block if there's other tags there:
+```ruby
+div.comment do
+  div.author "BitPuffin"
+  "<p>Silence!</p>"
+end
+```
+The p tag above won't appear in the output.
+### 4. Text
+Sometimes you need to insert plain text:
+```ruby
+p.author do
+  text 'Written by '
+  a 'Bluebie', :href => 'http://creativepony.com/'
+end
+```
+Which results in:
+```html
+<p class="author">
+  Written by
+  <a href="http://creativepony.com/">Bluebie</a>
+</p>
+```
+There's also `text!` which doesn't escape:
+```ruby
+p.author do
+  text! '<strong>Written</strong> by'
+  a 'Bluebie', :href => 'http://creativepony.com/'
+```
+Invoking Mab
+------------
+Using #mab:
+```ruby
+require 'mab/kernel_method'
+str = mab do
+  doctype!
+  html do
+    # ...
+  end
+end
+```
+Using Mab::Builder (or Mab::PrettyBuilder if you want indentation):
+```ruby
+class Person
+  attr_reader :name
+  def initialize(name)
+    @name = name
+  end
+  def awesome?; true end
+end
+# Assign instance variables:
+Mab::Builder.new(:person => Person.new('BitBuffin')) do
+  if @person.awesome?
+    h1 @person.name
+  else
+    p @person.name
+  end
+end.to_s
+# Use helper (methods and instance variables will be available):
+Mab::Builder.new({}, Person.new('BitPuffin')) do
+  if awesome?
+    h1 @name
+  else
+    p @name
+  end
+end.to_s
+```
+Extending an object (*advanced usage*):
+```ruby
+r = Object.new
+r.extend Mab::Mixin::HTML5
+r.extend Mab::Indentation
+r.mab do
+  doctype!
+  html do
+    # ...
+  end
+end
+```

data/Rakefile ADDED

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end

data/bench.rb ADDED

@@ -0,0 +1,37 @@
+$: << 'lib'
+TMPL = <<-'EOF'
+div.menu! do
+  [1, 2, 3, 4].map { |n| a("Section #{n}", :href => "/section/#{n}") }.join ' | '
+end
+EOF
+require 'mab'
+class MabExample
+  include Mab::Mixin::XHTML5
+  class_eval "def content() #{TMPL} end"
+  def to_html
+    mab { content }
+  end
+end
+require 'erector'
+class ErectorExample < Erector::Widget
+  class_eval "def content() #{TMPL} end"
+end
+puts MabExample.new.to_html
+puts ErectorExample.new.to_html
+require 'benchmark/ips'
+Benchmark.ips do |x|
+  x.report('Mab')     { MabExample.new.to_html }
+  x.report('Erector') { ErectorExample.new.to_html }
+end

data/lib/mab/mixin.rb CHANGED

@@ -4,9 +4,8 @@ module Mab
   module Mixin
     class Error < StandardError; end
     class Tag
-      attr_accessor :name, :content, :block
+      attr_accessor :name, :content, :attributes, :block, :has_content
       attr_reader :options, :context, :instance
-      attr_writer :attributes, :pos
       def initialize(name, options, context, instance = nil)
         @name = name
@@ -14,57 +13,71 @@ module Mab
         @context = context
         @instance = instance
         @done = false
-        @content = false
+        @content = nil
+        @has_content = nil
+        @attributes = {}
         @pos = @context.size
       end
-      def attributes
-        @attributes ||= {}
+      def block
+        return @block unless block_given?
+        current = @block
+        @block = proc { yield current }
       end
-      def merge_attributes(attrs)
-        if defined?(@attributes)
+      def merge_attributes(*args)
+        args.each do |attrs|
           @attributes.merge!(attrs)
-        else
-          @attributes = attrs
         end
       end
-      def method_missing(name, content = nil, attrs = nil, &blk)
+      def method_missing(name, *args, &blk)
         name = name.to_s
         if name[-1] == ?!
-          attributes[:id] = name[0..-2]
+          @attributes[:id] = name[0..-2]
         else
-          if attributes.has_key?(:class)
-            attributes[:class] += " #{name}"
+          if @attributes.has_key?(:class)
+            @attributes[:class] += " #{name}"
           else
-            attributes[:class] = name
+            @attributes[:class] = name
           end
         end
-        insert(content, attrs, &blk)
+        insert(*args, &blk)
       end
-      def insert(content = nil, attrs = nil, &blk)
+      def insert(*args, &blk)
         raise Error, "This tag is already closed" if @done
-        if content.is_a?(Hash)
-          attrs = content
-          content = nil
+        if !args.empty? && !args[0].is_a?(Hash)
+          content = args.shift
+          raise Error, "Tag doesn't allow content" if @has_content == false
+          @has_content = true
         end
-        merge_attributes(attrs) if attrs
+        if content
+          @content = CGI.escapeHTML(content.to_s)
+          @done = true
+        end
+        if !args.empty?
+          merge_attributes(*args)
+          @done = true
+        end
         if block_given?
+          raise Error, "Tag doesn't allow content" if @has_content == false
+          @has_content = true
           @block = blk
           @done = true
-        elsif content
-          content = content.to_s
-          @content = CGI.escapeHTML(content)
-          @done = !content.empty?
-        elsif attrs
-          @done = true
+        end
+        if @content && @block
+          raise Error, "Both content and block is not allowed"
         end
         @instance.mab_done(self) if @done
@@ -76,7 +89,8 @@ module Mab
           if before >= @context.children
             @content = res.to_s
           else
-            @content = nil
+            # Turn the node into just an opening tag.
+            @has_content = false
             @instance.mab_insert("</#{@name}>")
           end
         end
@@ -102,9 +116,10 @@ module Mab
           @context[@pos] = nil
           @context.children -= 1
         end
         res = "<#{@name}#{attrs_to_s}"
-        res << (@options[:xml] && @content == false ? ' />' : '>')
-        res << "#{@content}</#{@name}>" if @content
+        res << (@options[:xml] && !@block && !@has_content ? ' />' : '>')
+        res << "#{@content}</#{@name}>" if @has_content
         res
       end
     end
@@ -133,11 +148,15 @@ module Mab
       end
     end
-    def tag!(name, content = nil, attrs = nil, &blk)
+    def mab_tag(name)
       ctx = @mab_context || raise(Error, "Tags can only be written within a `mab { }`-block")
       tag = Tag.new(name, mab_options, ctx, self)
       mab_insert(tag)
-      tag.insert(content, attrs, &blk)
+      tag
+    end
+    def tag!(name, *args, &blk)
+      mab_tag(name).insert(*args, &blk)
     end
     def text!(str)
@@ -180,12 +199,10 @@ module Mab
     module HTMLDefiners
       def define_tag(meth, tag)
         class_eval <<-EOF
-          def #{meth}(content = "", attrs = nil, &blk)
-            if content.is_a?(Hash)
-              attrs = content
-              content = ""
-            end
-            tag!(:#{tag}, content, attrs, &blk)
+          def #{meth}(*args, &blk)
+            tag = mab_tag(:#{tag})
+            tag.has_content = true
+            tag.insert(*args, &blk)
           end
         EOF
       end
@@ -198,11 +215,10 @@ module Mab
       def define_empty_tag(meth, tag)
         class_eval <<-EOF
-          def #{meth}(attrs = nil)
-            if (!attrs.nil? && !attrs.is_a?(Hash)) || block_given?
-              raise Error, "#{meth} doesn't allow content"
-            end
-            tag!(:#{tag}, attrs)
+          def #{meth}(*args, &blk)
+            tag = mab_tag(:#{tag})
+            tag.has_content = false
+            tag.insert(*args, &blk)
           end
         EOF
       end