Markaby 0.6.3 → 0.6.5

data/CHANGELOG.rdoc

@@ -1,3 +1,34 @@
+= 0.6.4
+
+* Fixed a bug in which direct string values to Markaby::Builder wouldn't evaluate:
+    Markaby::Builder.new { 'foo' }.to_s #=> "foo"
+
+* Fix critical bug with form_for, which was raising an error
+* Introduce proxy object for form_for:
+
+    form_for :foo do |f|
+      f.text_field :bar
+      f.text_field :baz
+    end
+
+* Remove support for rails 2.1.x series.  We'll accept patches for them, if anyone cares enough.
+
+== 0.6.2 / 0.6.3
+
+* Add basic support for the Tilt templating engine (used with Sinatra):
+
+  require 'markaby'
+  require 'markaby/tilt'
+
+== 0.6.1
+
+* Support the following rails versions:
+    1.2.2, 1.2.3, 1.2.4, 1.2.5, 1.2.6, 2.1.0, 2.1.1, 2.1.2, 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
+* Only run rails tests when inside a rails plugins
+* Run tests of the various versions of rails with garlic
+* Start conversion to rspec.  Use test/spec temporarily until conversion is done.
+
 = 0.6
 === 23 August, 2009
 

data/Markaby.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{Markaby}
-  s.version = "0.6.3"
+  s.version = "0.6.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["_why", "Tim Fletcher", "John Barton", "spox", "smtlaissezfaire"]
-  s.date = %q{2009-10-10}
+  s.date = %q{2009-10-12}
   s.description = %q{Tim Fletcher and _why's ruby driven HTML templating system}
   s.email = %q{jrbarton@gmail.com}
   s.extra_rdoc_files = [
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
      "lib/markaby/rails.rb",
      "lib/markaby/rails/current.rb",
      "lib/markaby/rails/deprecated.rb",
+     "lib/markaby/rails/rails_builder.rb",
      "lib/markaby/tags.rb",
      "lib/markaby/tilt.rb",
      "spec/markaby/builder_spec.rb",
@@ -45,6 +46,9 @@ Gem::Specification.new do |s|
      "spec/markaby/rails/views/markaby/access_to_helpers.mab",
      "spec/markaby/rails/views/markaby/broken.mab",
      "spec/markaby/rails/views/markaby/correct_template_values.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",

data/README.rdoc

@@ -24,8 +24,9 @@ Write Rails templates in pure Ruby.  Example layout:
 
 Markaby supports many versions of rails:
 
-  1.2.2, 1.2.3, 1.2.4, 1.2.5, 1.2.6, 2.1.0, 2.1.1, 2.1.2, 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
+  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
 
 == Using Markaby as a Ruby class
 

data/Rakefile

@@ -1,7 +1,18 @@
 require 'rake'
 require 'spec/rake/spectask'
 require 'rake/clean'
-require 'rake/rdoctask'
+
+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
 
@@ -11,12 +22,6 @@ Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ["--color"]
 end
 
-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
-
 begin
   require 'jeweler'
   
@@ -46,3 +51,27 @@ desc "Start a Markaby-aware IRB session"
 task :irb do
   sh 'irb -I lib -r markaby -r markaby/kernel_method'
 end
+
+namespace :gemspec do
+  task :commit do
+    sh "git add ."
+    sh "git commit -m 'Update gemspec'"
+  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"

data/VERSION

@@ -1 +1 @@
-0.6.3
+0.6.5

data/lib/markaby/builder.rb

@@ -91,7 +91,7 @@ module Markaby
 
       @builder = XmlMarkup.new(:indent => @indent, :target => @streams.last)
 
-      instance_eval(&block) if block
+      text(capture(&block)) if block
     end
 
     def helper=(helper)
@@ -132,7 +132,7 @@ module Markaby
     # stream for the builder object, running the block and passing back its stream as a string.
     #
     #   >> Markaby::Builder.new.capture { h1 "TEST"; h2 "CAPTURE ME" }
-    #   => "<h1>TITLE</h1>\n<h2>CAPTURE ME</h2>\n"
+    #   => "<h1>TEST</h1><h2>CAPTURE ME</h2>"
     #
     def capture(&block)
       @streams.push(@builder.target = [])

data/lib/markaby/rails.rb

@@ -1,28 +1,31 @@
 module Markaby
   module Rails
+    UNSUPPORTED_RAILS_VERSIONS = [
+      "2.0.0",
+      "2.0.1",
+      "2.0.2",
+      "2.0.3",
+      "2.0.4",
+      "2.0.5",
+      "2.1.0",
+      "2.1.1",
+      "2.1.2",
+      "2.3.0"
+    ]
+    
     DEPRECATED_RAILS_VERSIONS = [
       "1.2.2",
       "1.2.3",
       "1.2.4",
       "1.2.5",
-      "1.2.6",
+      "1.2.6"
     ]
-
+    
     FULLY_SUPPORTED_RAILS_VERSIONS = [
-      # "2.0.0",
-      # "2.0.1",
-      # "2.0.2",
-      # "2.0.3",
-      # "2.0.4",
-      # "2.0.5",
-      "2.1.0",
-      "2.1.1",
-      "2.1.2",
       "2.2.0",
       "2.2.1",
       "2.2.2",
       "2.2.3",
-      # "2.3.0",
       "2.3.1",
       "2.3.2",
       "2.3.2.1",
@@ -49,7 +52,7 @@ module Markaby
       end
 
       def check_rails_version
-        unless SUPPORTED_RAILS_VERSIONS.include?(detected_rails_version)
+        if UNSUPPORTED_RAILS_VERSIONS.include?(detected_rails_version)
           error_message = "Cannot load markaby under rails version #{detected_rails_version}.  "
           error_message << "See Markaby::Rails::SUPPORTED_RAILS_VERSIONS for exactly that, or redefine this constant."
           raise LoadError, error_message

data/lib/markaby/rails/current.rb

@@ -1,6 +1,10 @@
+require 'markaby/rails/rails_builder'
+
 module Markaby
   module Rails
     class TemplateHandler < ::ActionView::TemplateHandler
+      include ActionView::TemplateHandlers::Compilable
+      
       def compile(template, local_assigns={})
         <<-CODE
           handler = Markaby::Rails::TemplateHandler.new
@@ -10,8 +14,9 @@ module Markaby
       end
 
       def render(template, local_assigns = (template.respond_to?(:locals) ? template.locals : {}))
-        builder = Markaby::Builder.new(instance_variables.merge(local_assigns), @view)
-
+        builder = RailsBuilder.new(instance_variables.merge(local_assigns), @view)
+        @view.output_buffer = builder
+        
         template.is_a?(Proc) ?
           builder.instance_eval(&template) :
           builder.instance_eval(template.source)

data/lib/markaby/rails/deprecated.rb

@@ -1,3 +1,5 @@
+require 'markaby/rails/rails_builder'
+
 module ActionView # :nodoc:
   class Base # :nodoc:
     def render_template(template_extension, template, file_path = nil, local_assigns = {})
@@ -64,7 +66,7 @@ module Markaby
       end
     end
 
-    class Builder < ::Markaby::Builder # :nodoc:
+    class Builder < RailsBuilder # :nodoc:
       def initialize(*args, &block)
         super *args, &block
 

data/lib/markaby/rails/rails_builder.rb

@@ -0,0 +1,50 @@
+module Markaby
+  module Rails
+    class RailsBuilder < Markaby::Builder
+      def form_for(*args, &block)
+        @template.form_for(*args) do |__form_for_variable|
+          yield(FormHelperProxy.new(self, __form_for_variable))
+        end
+      end
+
+      # This is used for the block variable given to form_for.  Typically, an erb template looks as so:
+      #
+      #   <% form_for :foo do |f|
+      #     <%= f.text_field :bar %>
+      #   <% end %>
+      #
+      # form_for adds the form tag to the input stream, and assumes that later the user will append
+      # the <input> tag to the input stream himself (in erb, this is done with the <%= %> tags).
+      #
+      # We could do the following in Markaby:
+      #
+      #   form_for :foo do |f|
+      #     text f.text_field(:bar)
+      #   end
+      #
+      # But this is ugly.  This is prettier:
+      #
+      #   form_for :foo do |f|
+      #     f.text_field :bar
+      #   end
+      class FormHelperProxy
+        def initialize(builder, proxied_object)
+          @builder = builder
+          @proxied_object = proxied_object
+        end
+
+        def respond_to?(sym, include_private = false)
+          @proxied_object.respond_to?(sym, include_private) || super
+        end
+
+      private
+
+        def method_missing(sym, *args, &block)
+          result = @proxied_object.__send__(sym, *args, &block)
+          @builder.text(result) if result.is_a?(String)
+          result
+        end
+      end
+    end
+  end
+end

data/spec/markaby/builder_spec.rb

@@ -1,40 +1,116 @@
 require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
-class BuilderTest < Test::Unit::TestCase
-  def setup
-    Markaby::Builder.restore_defaults!
-  end
+module Markaby
+  describe Builder do
+    before do
+      Markaby::Builder.restore_defaults!
+    end
 
-  def teardown
-    Markaby::Builder.restore_defaults!
-  end
+    after do
+      Markaby::Builder.restore_defaults!
+    end
 
-  def test_method_missing_is_private
-    assert Markaby::Builder.private_instance_methods.include?("method_missing")
-  end
-  
-  # setting options
-  def test_should_be_able_to_restore_defaults_after_setting
-    Markaby::Builder.set :indent, 2
-    Markaby::Builder.restore_defaults!
+    it "should have method missing as a private method" do
+      Markaby::Builder.private_instance_methods.should include("method_missing")
+    end
     
-    assert_equal 0, Markaby::Builder.get(:indent)
-  end
+    describe "setting options" do
+      it "should be able to restore defaults after setting" do
+        Markaby::Builder.set :indent, 2
+        Markaby::Builder.restore_defaults!
   
-  def test_should_be_able_set_global_options
-    Markaby::Builder.set :indent, 2
-    assert_equal 2, Markaby::Builder.get(:indent)
-  end
-  
-  # internal clobbering by passed in assigns
-  def test_internal_helpers_ivar_should_not_be_overwritten_by_assigns
-    helper = Class.new do
-      def some_method
-        "a value"
+        Markaby::Builder.get(:indent).should == 0
+      end
+
+      it "should be able to set global options" do
+        Markaby::Builder.set :indent, 2
+        Markaby::Builder.get(:indent).should == 2
       end
-    end.new
+    end
     
-    builder = Markaby::Builder.new({:helpers => nil}, helper)
-    assert_equal "a value", builder.some_method
+    describe "hidden internal variables" do
+      # internal clobbering by passed in assigns
+      it "should not overwrite internal helpers ivar when assigning a :helpers key" do
+        helper = Class.new do
+          def some_method
+            "a value"
+          end
+        end.new
+
+        builder = Markaby::Builder.new({:helpers => nil}, helper)
+        builder.some_method.should == "a value"
+      end
+    end
+    
+    describe "evaluating blocks" do
+      it "should evaluate a pure-string block (without requiring a call to the text method)" do
+        b = Builder.new do
+          "foo"
+        end
+        
+        b.to_s.should == "foo"
+      end
+      
+      it "should only evaluate the last argument in a pure-string block" do
+        b = Builder.new do
+          "foo"
+          "bar"
+        end
+        
+        b.to_s.should == "bar"
+      end
+      
+      it "should evaluate pure-strings inside an tag" do
+        b = Builder.new do
+          h1 do
+            "foo"
+          end
+        end
+        
+        b.to_s.should == "<h1>foo</h1>"
+      end
+      
+      it "should ignore a pure string in the block, even if comes last, if there has been any markup whatsoever" do
+        b = Builder.new do
+          h1
+          "foo"
+        end
+        
+        b.to_s.should == "<h1/>"
+      end
+    end
+    
+    describe "capture" do
+      before do
+        @builder = Builder.new
+      end
+      
+      it "should return the string captured" do
+        out = @builder.capture do
+          h1 "TEST"
+          h2 "CAPTURE ME"
+        end
+        
+        out.should == "<h1>TEST</h1><h2>CAPTURE ME</h2>"
+      end
+      
+      it "should not change the output buffer" do
+        lambda {
+          @builder.capture do
+            h1 "FOO!"
+          end
+        }.should_not change { @builder.to_s }
+      end
+      
+      it "should be able to capture inside a capture" do
+        out = @builder.capture do
+          capture do
+            h1 "foo"
+          end
+        end
+        
+        out.should == "<h1>foo</h1>"
+      end
+    end
   end
 end

data/spec/markaby/rails/spec_helper.rb

@@ -9,6 +9,7 @@ unless defined?(RUNNING_RAILS)
 end
 
 if RUNNING_RAILS
+  ENV["RAILS_ENV"] ||= "test"
   require RAILS_BOOT_FILE
   Rails::Initializer.run
   require 'action_controller/test_process'

data/spec/markaby/rails/views/markaby/form_for.mab

@@ -0,0 +1,2 @@
+form_for :obj do
+end

data/spec/markaby/rails/views/markaby/form_for_with_fields.mab

@@ -0,0 +1,3 @@
+form_for :foo do |f|
+  f.text_field :foo
+end

data/spec/markaby/rails/views/markaby/form_for_with_multiple_fields.mab

@@ -0,0 +1,4 @@
+form_for :foo do |f|
+  f.text_field :foo
+  f.text_field :baz
+end

data/spec/markaby/rails_spec.rb

@@ -84,6 +84,34 @@ if RUNNING_RAILS
     def render_which_raises_error
       render :template => "markaby/broken"
     end
+    
+    def renders_form_for
+      @obj = Object.new
+      render :template => "markaby/form_for"
+    end
+    
+    def render_form_for_with_fields
+      @obj = Object.new
+      def @obj.foo
+        "bar"
+      end
+      
+      render :template => "markaby/form_for_with_fields"
+    end
+    
+    def render_form_for_with_multiple_fields
+      @obj = Object.new
+      
+      def @obj.foo
+        "bar"
+      end
+      
+      def @obj.baz
+        "quxx"
+      end
+      
+      render :template => "markaby/form_for_with_multiple_fields"
+    end
   end
   
   class MarkabyOnRailsTest < ActionController::TestCase
@@ -180,6 +208,37 @@ if RUNNING_RAILS
       assert %r(undefined local variable or method `supercalifragilisticexpialidocious' for #<Markaby::.*Builder.*) =~
              @controller.last_exception.message.to_s
     end
+    
+    def test_renders_form_for_properly
+      get :renders_form_for
+      
+      assert_response :success
+      
+      assert %r(<form.*></form>) =~ @response.body
+    end
+    
+    def test_renders_form_for_with_fields_for
+      get :render_form_for_with_fields
+      
+      assert_response :success
+      
+      assert_equal "<form action=\"/markaby/render_form_for_with_fields\" method=\"post\"><input id=\"foo_foo\" name=\"foo[foo]\" size=\"30\" type=\"text\" /></form>",
+                   @response.body
+    end
+    
+    def test_renders_form_for_with_multiple_fields
+      get :render_form_for_with_multiple_fields
+      
+      assert_response :success
+      
+      expected_output =  "<form action=\"/markaby/render_form_for_with_multiple_fields\" method=\"post\">"
+      expected_output << "<input id=\"foo_foo\" name=\"foo[foo]\" size=\"30\" type=\"text\" />"
+      expected_output << "<input id=\"foo_baz\" name=\"foo[baz]\" size=\"30\" type=\"text\" />"
+      expected_output << "</form>"
+      
+      assert_equal expected_output,
+                   @response.body
+    end
   end
   
   describe "rails version" do

data/spec/markaby/rails_version_spec.rb

@@ -6,7 +6,7 @@ unless RUNNING_RAILS
   describe "when rails is loaded, but is not a supported version" do
     module MockRails
       module VERSION
-        STRING = "0.0.0"
+        STRING = ::Markaby::Rails::UNSUPPORTED_RAILS_VERSIONS.first
       end
     end
     
@@ -31,7 +31,7 @@ unless RUNNING_RAILS
     it "should raise" do
       lambda {
         ::Markaby::Rails.load
-      }.should raise_error(LoadError, "Cannot load markaby under rails version 0.0.0.  See Markaby::Rails::SUPPORTED_RAILS_VERSIONS for exactly that, or redefine this constant.")
+      }.should raise_error(LoadError, "Cannot load markaby under rails version 2.0.0.  See Markaby::Rails::SUPPORTED_RAILS_VERSIONS for exactly that, or redefine this constant.")
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Markaby
 version: !ruby/object:Gem::Version 
-  version: 0.6.3
+  version: 0.6.5
 platform: ruby
 authors: 
 - _why
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-10 00:00:00 -04:00
+date: 2009-10-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,6 +51,7 @@ files:
 - lib/markaby/rails.rb
 - lib/markaby/rails/current.rb
 - lib/markaby/rails/deprecated.rb
+- lib/markaby/rails/rails_builder.rb
 - lib/markaby/tags.rb
 - lib/markaby/tilt.rb
 - spec/markaby/builder_spec.rb
@@ -64,6 +65,9 @@ files:
 - spec/markaby/rails/views/markaby/access_to_helpers.mab
 - spec/markaby/rails/views/markaby/broken.mab
 - spec/markaby/rails/views/markaby/correct_template_values.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