markaby 0.7.2 → 0.8.0

data/.gitignore

@@ -0,0 +1,21 @@
+.garlic
+pkg
+_site
+
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'builder'
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+end

data/Markaby.gemspec

@@ -1,109 +1,24 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'markaby/version'
 
-Gem::Specification.new do |s|
-  s.name = %q{markaby}
-  s.version = "0.7.2"
+Gem::Specification.new do |spec|
+  spec.name          = "markaby"
+  spec.version       = Markaby::VERSION
+  spec.authors       = ["Scott Taylor", "judofyr", "_why"]
+  spec.email         = ["scott@railsnewbie.com"]
+  spec.description   = "_why's markaby templating language"
+  spec.summary       = "A pure ruby based, html markup language"
+  spec.homepage      = ""
+  spec.license       = "MIT"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{_why}, %q{Tim Fletcher}, %q{John Barton}, %q{spox}, %q{smtlaissezfaire}]
-  s.date = %q{2011-08-23}
-  s.description = %q{Tim Fletcher and _why's ruby driven HTML templating system}
-  s.email = %q{scott@railsnewbie.com}
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    "CHANGELOG.rdoc",
-    "Markaby.gemspec",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "garlic.rb",
-    "init.rb",
-    "lib/markaby.rb",
-    "lib/markaby/builder.rb",
-    "lib/markaby/builder_tags.rb",
-    "lib/markaby/cssproxy.rb",
-    "lib/markaby/kernel_method.rb",
-    "lib/markaby/rails.rb",
-    "lib/markaby/rails/current.rb",
-    "lib/markaby/rails/deprecated.rb",
-    "lib/markaby/rails/rails_builder.rb",
-    "lib/markaby/sinatra.rb",
-    "lib/markaby/tags.rb",
-    "lib/markaby/tilt.rb",
-    "spec/markaby/builder_spec.rb",
-    "spec/markaby/css_proxy_test.rb",
-    "spec/markaby/fragment_test.rb",
-    "spec/markaby/markaby_other_static.mab",
-    "spec/markaby/markaby_spec.rb",
-    "spec/markaby/markaby_test.rb",
-    "spec/markaby/rails/spec_helper.rb",
-    "spec/markaby/rails/views/layouts/layout.mab",
-    "spec/markaby/rails/views/markaby/_a_partial.mab",
-    "spec/markaby/rails/views/markaby/_form_for_with_body_in_erb.erb",
-    "spec/markaby/rails/views/markaby/_partial_child_with_locals.mab",
-    "spec/markaby/rails/views/markaby/access_to_helpers.mab",
-    "spec/markaby/rails/views/markaby/broken.mab",
-    "spec/markaby/rails/views/markaby/commented_out_template.mab",
-    "spec/markaby/rails/views/markaby/correct_template_values.mab",
-    "spec/markaby/rails/views/markaby/double_output.mab",
-    "spec/markaby/rails/views/markaby/form_for.mab",
-    "spec/markaby/rails/views/markaby/form_for_with_fields.mab",
-    "spec/markaby/rails/views/markaby/form_for_with_multiple_fields.mab",
-    "spec/markaby/rails/views/markaby/no_values_passed.mab",
-    "spec/markaby/rails/views/markaby/partial_parent.mab",
-    "spec/markaby/rails/views/markaby/partial_parent_with_locals.mab",
-    "spec/markaby/rails/views/markaby/render_erb_without_explicit_render_call.erb",
-    "spec/markaby/rails/views/markaby/render_explicit_but_empty_markaby_layout.mab",
-    "spec/markaby/rails/views/markaby/render_mab_without_explicit_render_call.mab",
-    "spec/markaby/rails/views/markaby/render_with_ivar.mab",
-    "spec/markaby/rails/views/markaby/renders_erb.rhtml",
-    "spec/markaby/rails/views/markaby/renders_form_for_with_erb_body.mab",
-    "spec/markaby/rails/views/markaby/routes.mab",
-    "spec/markaby/rails/views/markaby/yielding.mab",
-    "spec/markaby/rails/views/markaby/yielding_content_for_with_block_helper.mab",
-    "spec/markaby/rails/views/markaby/yielding_two.mab",
-    "spec/markaby/rails/views/markaby/yielding_with_content_for.mab",
-    "spec/markaby/rails_test.rb",
-    "spec/markaby/rails_version_spec.rb",
-    "spec/markaby/sinatra/app.rb",
-    "spec/markaby/sinatra/sinatra_spec.rb",
-    "spec/markaby/sinatra/views/helpers.mab",
-    "spec/markaby/sinatra/views/layout.mab",
-    "spec/markaby/sinatra/views/markaby_template.mab",
-    "spec/markaby/sinatra/views/scope_instance_variables.mab",
-    "spec/markaby/sinatra/views/simple_html.mab",
-    "spec/markaby/sinatra/views/variables.mab",
-    "spec/markaby/tilt/erb.erb",
-    "spec/markaby/tilt/locals.mab",
-    "spec/markaby/tilt/markaby.mab",
-    "spec/markaby/tilt/markaby_other_static.mab",
-    "spec/markaby/tilt/render_twice.mab",
-    "spec/markaby/tilt/scope.mab",
-    "spec/markaby/tilt/yielding.mab",
-    "spec/markaby/tilt_spec.rb",
-    "spec/spec.opts",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://markaby.github.com/markaby/}
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.6}
-  s.summary = %q{Markup as Ruby, write HTML in your native Ruby tongue}
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<builder>, [">= 2.0.0"])
-    else
-      s.add_dependency(%q<builder>, [">= 2.0.0"])
-    end
-  else
-    s.add_dependency(%q<builder>, [">= 2.0.0"])
-  end
+  spec.add_dependency "builder"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
 end
-

data/README.rdoc

@@ -5,70 +5,27 @@ It is an alternative to ERb which weaves the two languages together.
 Also a replacement for templating languages which use primitive languages
 that blend with HTML.
 
-== Using Markaby as a Rails plugin / gem
-
-Write Rails templates in pure Ruby.  Example layout:
-
-  html do
-    head do
-      title 'Products: ' + action_name
-      stylesheet_link_tag 'scaffold'
-    end
-
-    body do
-      p flash[:notice], :style => "color: green"
-
-      div.signup! do
-        form_for @user do |f|
-          f.text_field :email
-        end
-      end
-
-      yield
-    end
-  end
-
-Markaby templates end in .mab
-
-Markaby supports many versions of rails, including the latest rails:
-
-  1.2.2, 1.2.3, 1.2.4, 1.2.5, 1.2.6, 2.2.0,
-  2.2.1, 2.2.2, 2.2.3, 2.3.1, 2.3.2, 2.3.2.1,
-  2.3.3, 2.3.3.1, 2.3.4, 2.3.5, 2.3.6, 2.3.7,
-  2.3.8
-
-Rails 3.0 support is planned.
-
-=== Install it as a plugin
-
-  script/plugin install git://github.com/markaby/markaby.git
-
 === Install it as a gem
 
   gem install markaby
 
-If you are loading it in a different way (from a gem), make sure
-it's on the $LOAD_PATH, and add the following in
-an initializer (config/initializers/markaby.rb will work):
-
-  require 'markaby'
-  require 'markaby/rails'
-
-  Markaby::Rails.load
-
-Or, you could try config.gem, but that's now known as a bad idea.
-
-
 == Using Markaby with Sinatra (1.0+)
 
-  require 'markaby/sinatra'
-
   get '/foo' do
     mab :my_template # my_template.mab in the sinatra view path
   end
 
 If you are looking for sinatra support pre 0.7, see http://github.com/sbfaulkner/sinatra-markaby
 
+A note on Tilt - using markaby with html5 doesn't quite yet work properly.  If you'd like to render a template with html 5, call this at the start of a .mab template:
+
+enable_html5!
+
+Or enable html 5 globally:
+
+Markaby::Builder.class_eval do
+  @@options = Markaby::Builder::HTML5_OPTIONS
+end
 
 == Using Markaby with other frameworks
 
@@ -174,15 +131,15 @@ Which results in:
 == 3. Validate Your XHTML 1.0 Output
 
 If you'd like Markaby to help you assemble valid XHTML documents,
-you can use the <tt>xhtml_transitional</tt> or <tt>xhtml_strict</tt>
+you can use the <tt>html5</tt>, <tt>xhtml_transitional</tt> or <tt>xhtml_strict</tt>
 methods in place of the normal <tt>html</tt> tag.
 
-  xhtml_strict do
+  html5 do
     head { ... }
     body { ... }
   end
 
-This will add the XML instruction and the doctype tag to your document.
+This will add the XML instruction and the doctype tag to your document (for xhtml_strict and xhtml_transitional).
 Also, a character set meta tag will be placed inside your <tt>head</tt>
 tag.
 
@@ -263,45 +220,6 @@ won't work with this technique.
     end
   end
 
-= A Note About Rails Helpers
-
-When used in Rails templates, the Rails helper object is passed into
-Markaby::Builder.  When you call helper methods inside Markaby, the output
-from those methods will be output to the stream.  This is incredibly
-handy, since most Rails helpers output HTML tags.
-
-  head do
-    javascript_include_tag 'prototype'
-    autodiscovery_link_tag
-  end
-
-However, some methods are designed to give back a String which you can use
-elsewhere.  That's okay!  Every method returns a Fragment object, which can
-be used as a string.
-
-  p { "Total is: #{number_to_human_size @file_bytes}" }
-
-Also see the Quick Tour above, specifically the stuff about auto-stringification.
-
-If for any reason you have trouble with fragments, you can just
-call the <tt>@helpers</tt> object with the method and you'll get
-the String back and nothing will be output.
-
-  p { "Total is: #{@helpers.number_to_human_size @file_bytes}" }
-
-Conversely, you may call instance variables from your controller by using
-a method and its value will be returned, nothing will be output.
-
-  # Inside imaginary ProductController
-  def list
-    @products = Product.find :all
-  end
-
-  # Inside app/views/product/list.mab
-  products.each do |product|
-    p product.title
-  end
-
 = Credits
 
 Markaby is a work of immense hope by Tim Fletcher and why the lucky stiff.

data/Rakefile

@@ -1,43 +1,12 @@
 require 'rake'
+require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
-require 'rake/testtask'
 require 'rake/clean'
 
-begin
-  require 'hanna/rdoctask'
-
-  Rake::RDocTask.new do |rdoc|
-    rdoc.rdoc_dir = 'doc/rdoc'
-    rdoc.options << '--line-numbers'
-    rdoc.rdoc_files.add(['README.rdoc', 'CHANGELOG.rdoc', 'lib/**/*.rb'])
-  end
-rescue LoadError
-  puts "Could not load hanna-rdoc.  Please install with mislav-hanna package"
-end
-
-task :default => [:spec, :test]
-
-Rake::TestTask.new(:test) do |t|
-  t.pattern = 'spec/markaby/*_test.rb'
-end
-
 RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
 
-begin
-  require 'jeweler'
-
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name          = "markaby"
-    gemspec.summary       = "Markup as Ruby, write HTML in your native Ruby tongue"
-    gemspec.description   = "Tim Fletcher and _why's ruby driven HTML templating system"
-    gemspec.email         = "scott@railsnewbie.com"
-    gemspec.homepage      = "http://markaby.github.com/markaby/"
-    gemspec.authors       = ["_why", "Tim Fletcher", "John Barton", "spox", "smtlaissezfaire"]
-    gemspec.add_dependency 'builder', '>=2.0.0'
-  end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
+Bundler::GemHelper.install_tasks
 
 desc "List any Markaby specific warnings"
 task :warnings do
@@ -60,19 +29,19 @@ namespace :gemspec do
   end
 end
 
-namespace :release do
-  task :patch => [:spec, "version:bump:patch", :update_gemspec, :rerdoc, :tag_release, :build, :push_tags]
-
-  task :update_gemspec => ["gemspec:generate", "gemspec:validate", "gemspec:commit"]
-  task :tag_release do
-    require File.dirname(__FILE__) + "/lib/markaby"
-    version = "v#{Markaby::VERSION}"
-    sh "git tag #{version}"
-  end
-
-  task :push_tags do
-    sh "git push --tags"
-  end
-end
-
-task :release => "release:patch"
+# namespace :release do
+#   task :patch => [:spec, "version:bump:patch", :update_gemspec, :rerdoc, :tag_release, :build, :push_tags]
+#
+#   task :update_gemspec => ["gemspec:generate", "gemspec:validate", "gemspec:commit"]
+#   task :tag_release do
+#     require File.dirname(__FILE__) + "/lib/markaby"
+#     version = "v#{Markaby::VERSION}"
+#     sh "git tag #{version}"
+#   end
+#
+#   task :push_tags do
+#     sh "git push --tags"
+#   end
+# end
+#
+# task :release => "release:patch"

data/lib/markaby.rb

@@ -16,15 +16,11 @@ $:.unshift File.expand_path(File.dirname(__FILE__))
 # * Markaby::MetAid: metaprogramming helper methods.
 # * Markaby::Tags: lists the roles of various XHTML tags to help Builder
 #   use these tags as they are intended.
-# * Markaby::Template: a class for hooking Markaby into Rails as a
-#   proper templating language.
 module Markaby
-  version_file = File.expand_path(File.dirname(__FILE__) + "/../VERSION")
-  VERSION      = File.read(version_file).strip
-
   class InvalidXhtmlError < StandardError; end
 end
 
+require "markaby/version"
 require 'builder' unless defined?(Builder)
 require 'markaby/builder'
 require 'markaby/cssproxy'

data/lib/markaby/builder.rb

@@ -28,7 +28,7 @@ module Markaby
       :indent                 => 0,
       :output_helpers         => true,
       :output_xml_instruction => true,
-      :output_meta_tag        => true,
+      :output_meta_tag        => 'xhtml',
       :auto_validation        => true,
       :tagset                 => Markaby::XHTMLTransitional,
       :root_attributes => {
@@ -38,12 +38,26 @@ module Markaby
       }
     }
 
+    HTML5_OPTIONS = {
+      :indent                 => 0,
+      :output_helpers         => true,
+      :output_xml_instruction => false,
+      :output_meta_tag        => 'html5',
+      :auto_validation        => true,
+      :tagset                 => Markaby::HTML5,
+      :root_attributes        => {}
+    }
+
     @@options = DEFAULT_OPTIONS.dup
 
     def self.restore_defaults!
       @@options = DEFAULT_OPTIONS.dup
     end
 
+    def self.set_html5_options!
+      @@options = HTML5_OPTIONS.dup
+    end
+
     def self.set(option, value)
       @@options[option] = value
     end

data/lib/markaby/builder_tags.rb

@@ -1,6 +1,6 @@
 module Markaby
   module BuilderTags
-    (XHTMLTransitional.tags - [:head]).each do |k|
+    (HTML5.tags - [:head]).each do |k|
       class_eval <<-CODE, __FILE__, __LINE__
         def #{k}(*args, &block)
           html_tag(#{k.inspect}, *args, &block)
@@ -28,7 +28,8 @@ module Markaby
     # set to <tt>text/html; charset=utf-8</tt>.
     def head(*args, &block)
       tag!(:head, *args) do
-        tag!(:meta, "http-equiv" => "Content-Type", "content" => "text/html; charset=utf-8") if @output_meta_tag
+        tag!(:meta, "http-equiv" => "Content-Type", "content" => "text/html; charset=utf-8") if @output_meta_tag == 'xhtml'
+        tag!(:meta, "charset" => "utf-8") if @output_meta_tag == 'html5'
         instance_eval(&block)
       end
     end
@@ -53,6 +54,20 @@ module Markaby
       xhtml_html(attrs, &block)
     end
 
+    # Builds an html tag with HTML5 doctype instead.
+    def html5(attrs = {}, &block)
+      enable_html5!
+      html5_html(attrs, &block)
+    end
+
+    def enable_html5!
+      self.tagset = Markaby::HTML5
+
+      Markaby::Builder::HTML5_OPTIONS.each do |k, v|
+        self.instance_variable_set("@#{k}".to_sym, v)
+      end
+    end
+
   private
 
     def xhtml_html(attrs = {}, &block)
@@ -60,5 +75,10 @@ module Markaby
       declare!(:DOCTYPE, :html, :PUBLIC, *tagset.doctype)
       tag!(:html, @root_attributes.merge(attrs), &block)
     end
+
+    def html5_html(attrs = {}, &block)
+      declare!(:DOCTYPE, :html)
+      tag!(:html, @root_attributes.merge(attrs), &block)
+    end
   end
 end