RubyGems - mab-cj - Versions diffs - 0.0.4 - Mend

mab-cj 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (48) hide show

checksums.yaml +7 -0
data/COPYING +19 -0
data/Gemfile +14 -0
data/README.md +224 -0
data/Rakefile +16 -0
data/lib/mab.rb +6 -0
data/lib/mab/builder.rb +45 -0
data/lib/mab/indentation.rb +33 -0
data/lib/mab/kernel_method.rb +6 -0
data/lib/mab/mixin.rb +262 -0
data/lib/mab/rails.rb +20 -0
data/lib/mab/tilt.rb +42 -0
data/lib/mab/version.rb +4 -0
data/mab.gemspec +20 -0
data/test/helper.rb +4 -0
data/test/rails/Rakefile +7 -0
data/test/rails/app/assets/images/rails.png +0 -0
data/test/rails/app/assets/javascripts/application.js +15 -0
data/test/rails/app/assets/stylesheets/application.css +13 -0
data/test/rails/app/controllers/application_controller.rb +17 -0
data/test/rails/app/helpers/application_helper.rb +2 -0
data/test/rails/app/views/application/content_for.html.mab +6 -0
data/test/rails/app/views/application/normal.html.mab +2 -0
data/test/rails/app/views/application/variables.html.mab +2 -0
data/test/rails/app/views/layouts/application.html.mab +15 -0
data/test/rails/config.ru +4 -0
data/test/rails/config/application.rb +54 -0
data/test/rails/config/boot.rb +6 -0
data/test/rails/config/environment.rb +5 -0
data/test/rails/config/environments/development.rb +27 -0
data/test/rails/config/environments/production.rb +67 -0
data/test/rails/config/environments/test.rb +29 -0
data/test/rails/config/initializers/backtrace_silencers.rb +7 -0
data/test/rails/config/initializers/inflections.rb +15 -0
data/test/rails/config/initializers/mime_types.rb +5 -0
data/test/rails/config/initializers/secret_token.rb +7 -0
data/test/rails/config/initializers/session_store.rb +8 -0
data/test/rails/config/initializers/wrap_parameters.rb +14 -0
data/test/rails/config/locales/en.yml +5 -0
data/test/rails/config/routes.rb +3 -0
data/test/rails/script/rails +6 -0
data/test/rails/test/helper.rb +7 -0
data/test/rails/test/test_mab.rb +40 -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 +250 -0
metadata +118 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b56014736fcafd7c7f040d47c1b3d6ee14cfa27
+  data.tar.gz: 4d6e5b38d9532ef9dab04f6c2b945332ad345f6f
+SHA512:
+  metadata.gz: 7b5a2d08f46788cdda2061f7201fea7f4aae7067143e9bc35d714339b431e3033580c97222245d1fc5f81e6eb8e61168e924d231eac4d243c1500293336016f6
+  data.tar.gz: 3350aa5ddb6ad086ef32b691c21741592e44f0a8a568de64d4ca1db2f45bf1e1f6457d5d8a2756c8b54f62734ff0949ac4c4c50644eaa24e7e2320f625a975e6

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,14 @@
+source 'https://rubygems.org/'
+group :development do
+  gem "rake"
+end
+group :test do
+  gem "minitest"
+end
+if ENV['RAILS']
+  gem 'rails', '= 3.2.12'
+end

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,16 @@
+require 'rake/testtask'
+task :default => :test
+task :test => 'test:core'
+namespace 'test' do
+  Rake::TestTask.new('core') do |t|
+    t.libs << 'lib' << 'test'
+  end
+  Rake::TestTask.new('rails') do |t|
+    t.libs << 'lib'
+    t.test_files = FileList['test/rails/test/test_*.rb']
+  end
+end

data/lib/mab.rb ADDED

@@ -0,0 +1,6 @@
+require 'mab/version'
+require 'mab/mixin'
+require 'mab/indentation'
+require 'mab/builder'
+require 'mab/rails' if defined?(::ActionView)
+require 'mab/tilt' if defined?(::Tilt)

data/lib/mab/builder.rb ADDED

@@ -0,0 +1,45 @@
+module Mab
+  class SimpleBuilder
+    include Mixin
+    def initialize(assigns = {}, helper = nil, &blk)
+      @_helper = helper
+      @_result = []
+      assigns.each do |key, value|
+        instance_variable_set(:"@#{key}", value)
+      end
+      if helper
+        helper.instance_variables.each do |var|
+          instance_variable_set(var, helper.instance_variable_get(var))
+        end
+      end
+      capture(&blk) if blk
+    end
+    def capture(&blk)
+      @_result << mab(&blk)
+    end
+    def to_s; @_result.join end
+    def method_missing(name, *args, &blk)
+      if @_helper && @_helper.respond_to?(name, true)
+        @_helper.send(name, *args, &blk)
+      else
+        super
+      end
+    end
+  end
+  class Builder < SimpleBuilder
+    include HTML5
+  end
+  class PrettyBuilder < Builder
+    include Indentation
+  end
+end

data/lib/mab/indentation.rb ADDED

@@ -0,0 +1,33 @@
+module Mab
+  module Indentation
+     def mab_insert(str)
+      if i = @mab_context.options[:indentation]
+        super([$/ + "  " * i, str])
+      else
+        @mab_context.options[:indentation] = 0
+        super
+      end
+    end
+    def mab_done(tag)
+      if blk = tag._block
+        tag._block = proc do
+          begin
+            @mab_context.options[:indentation] += 1
+            blk.call
+          ensure
+            @mab_context.options[:indentation] -= 1
+          end
+        end
+      end
+      super
+    end
+    def reindent!(str)
+      str.split(/\r?\n/).each do |s|
+        text! s
+      end
+    end
+  end
+end

data/lib/mab/kernel_method.rb ADDED

@@ -0,0 +1,6 @@
+require 'mab'
+def mab(&blk)
+  Mab::PrettyBuilder.new({}, self, &blk).to_s
+end

data/lib/mab/mixin.rb ADDED

@@ -0,0 +1,262 @@
+require 'cgi'
+module Mab
+  module Mixin
+    class Error < StandardError; end
+    class Tag
+      attr_accessor :_name, :_content, :_attributes, :_block, :_has_content
+      attr_reader :_options, :_context, :_instance
+      def initialize(name, options, context, instance = nil)
+        @_name = name
+        @_options = options
+        @_context = context
+        @_instance = instance
+        @_done = false
+        @_content = nil
+        @_has_content = nil
+        @_attributes = {}
+        @_pos = @_context.size
+      end
+      def _block
+        return @_block unless block_given?
+        current = @_block
+        @_block = proc { yield current }
+      end
+      def _merge_attributes(*args)
+        args.each do |attrs|
+          @_attributes.merge!(attrs)
+        end
+      end
+      def method_missing(name, *args, &blk)
+        name = name.to_s
+        if name[-1] == ?!
+          @_attributes[:id] = name[0..-2]
+        else
+          if @_attributes.has_key?(:class)
+            @_attributes[:class] += " #{name}"
+          else
+            @_attributes[:class] = name
+          end
+        end
+        _insert(*args, &blk)
+      end
+      def _insert(*args, &blk)
+        raise Error, "This tag is already closed" if @_done
+        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
+        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
+        end
+        if @_content && @_block
+          raise Error, "Both content and _block is not allowed"
+        end
+        @_instance.mab_done(self) if @_done
+        if @_block
+          before = @_context.children
+          res = @_block.call
+          if before >= @_context.children
+            @_content = res.to_s
+          else
+            # Turn the node into just an opening tag.
+            @_has_content = false
+            @_instance.mab_insert("</#{@_name}>")
+          end
+        end
+        self
+      end
+      def to_ary() nil end
+      def to_str() to_s end
+      def _attrs_to_s
+        @_attributes.inject("") do |res, (name, value)|
+          if value
+            value = (value == true) ? name : CGI.escapeHTML(value.to_s)
+            res << " #{name}=\"#{value}\""
+          end
+          res
+        end
+      end
+      def to_s
+        if !@_context.joining? && @_context[@_pos]
+          @_context[@_pos] = nil
+          @_context.children -= 1
+        end
+        res = "<#{@_name}#{_attrs_to_s}"
+        res << (@_options[:xml] && !@_block && !@_has_content ? ' />' : '>')
+        res << "#{@_content}</#{@_name}>" if @_has_content
+        res
+      end
+    end
+    class Context < Array
+      attr_accessor :children, :options
+      def initialize
+        @children = 0
+        @joining = false
+        @options = {}
+      end
+      def <<(str)
+        @children += 1
+        super(str)
+      end
+      def join(*)
+        @joining = true
+        super
+      end
+      def joining?
+        @joining
+      end
+    end
+    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
+    end
+    def tag!(name, *args, &blk)
+      mab_tag(name)._insert(*args, &blk)
+    end
+    def text!(str)
+      mab_insert(str)
+    end
+    def text(str)
+      text! CGI.escapeHTML(str.to_s)
+    end
+    def mab(&blk)
+      prev = defined?(@mab_context) && @mab_context
+      ctx = @mab_context = Context.new
+      res = instance_eval(&blk)
+      ctx.empty? ? res : ctx.join
+    ensure
+      @mab_context = prev
+    end
+    def mab_insert(tag)
+      ctx = @mab_context || raise(Error, 'mab { }-block required')
+      ctx << tag
+    end
+    def mab_done(tag)
+    end
+    def mab_options
+      @mab_options ||= {}
+    end
+    module XML
+      include Mixin
+      def mab_options
+        @mab_options ||= super.update(:xml => true)
+      end
+    end
+    module HTMLDefiners
+      def define_tag(meth, tag)
+        class_eval <<-EOF
+          def #{meth}(*args, &blk)
+            tag = mab_tag(:#{tag})
+            tag._has_content = true
+            tag._insert(*args, &blk)
+          end
+        EOF
+      end
+      def define_tags(*tags)
+        tags.flatten.each do |tag|
+          define_tag(tag, tag)
+        end
+      end
+      def define_empty_tag(meth, tag)
+        class_eval <<-EOF
+          def #{meth}(*args, &blk)
+            tag = mab_tag(:#{tag})
+            tag._has_content = false
+            tag._insert(*args, &blk)
+          end
+        EOF
+      end
+      def define_empty_tags(*tags)
+        tags.flatten.each do |tag|
+          define_empty_tag(tag, tag)
+        end
+      end
+    end
+    module HTML5
+      extend HTMLDefiners
+      include Mixin
+      define_tags %w[a abbr acronym address applet article aside audio b
+        basefont bdi bdo big blockquote body button canvas caption
+        center cite code colgroup datalist dd del details dfn dir div dl
+        dt em fieldset figcaption figure font footer form frame frameset
+        h1 h2 h3 h4 h5 h6 head header hgroup html i iframe ins kbd label
+        legend li link map mark math menu meter nav noframes noscript
+        object ol optgroup option output p pre progress q rp rt ruby s
+        samp script section select small span strike strong style sub
+        summary sup svg table tbody td textarea tfoot th thead time
+        title tr tt u ul var video xmp]
+      define_empty_tags %w[base link meta hr br wbr img embed param source
+        track area col input keygen command]
+      def doctype!
+        text! '<!DOCTYPE html>'
+      end
+    end
+    module XHTML5
+      include HTML5
+      include XML
+    end
+  end
+end