forme 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fb6883778ebb616402a910c3f46f7bd6ba3734b
-  data.tar.gz: aed74dd741f94bb368e97390d14a4000f4b73f39
+  metadata.gz: 315de851244fa7fd0ccb18fb0d57aa53204fff22
+  data.tar.gz: c880954089f9c59174abdf75eed937a2fddde4a0
 SHA512:
-  metadata.gz: 297661c5e245fcbb2f7c671d59c79f77b4d07d3bcded836ace5c7a6049f237b3d7711923178dcfcfdc3ac704a654b491c217112d114f033bd9d241f2c3f9b2f4
-  data.tar.gz: 68d7a1d1adbae977f2c26649a72633ae2c954f8701bca70883153eac44fe86113aedd1a47015ad261f2e91ad119945aab56355d54480dda0782bc11896557b26
+  metadata.gz: d598b9cb754eb1973685c6b830451a78b3fbf18e0477373a8021966d0f5b210756fdab2f1209ed5b83cf481f530f8e02995776a829555266233bc008842a163f
+  data.tar.gz: a321b164bc8a347573c12cdd1b4bd1e786c45e82c06de27d3219256b8523acdab4e80153dbd4bf7bc82cf6929714987d1002eb5ff27ab043d717ef0c37908814

data/CHANGELOG

@@ -1,3 +1,11 @@
+=== 1.1.0 (2014-09-07)
+
+* Make form without a block in the ERB integration still use hidden tags if method is post (jeremyevans)
+
+* Add Forme::RawString class, Forme.raw, and Form#raw for creating raw strings, so you don't need to use extend(Forme::Raw) (jeremyevans)
+
+* Allow using nil as explicit transformer value when creating a Form, to disable default transformer (jeremyevans)
+
 === 1.0.0 (2014-07-30)
 
 * Add roda plugin for forme (jeremyevans)

data/README.rdoc

@@ -34,17 +34,17 @@ For example, these both compile by default to the same select tag:
 The processing of high level <tt>Forme::Input</tt>s into raw html
 data is broken down to the following steps (called transformers):
 
-* +Formatter+: converts a <tt>Forme::Input</tt> instance into a
-  <tt>Forme::Tag</tt> instance (or array of them).
-* +ErrorHandler+: If the <tt>Forme::Input</tt> instance has a error,
-  takes the formatted tag and marks it as having the error.
-* +Labeler+: If the <tt>Forme::Input</tt> instance has a label,
-  takes the formatted output and labels it.
-* +Wrapper+: Takes the output of the formatter, labeler, and
-  error_handler transformers, and wraps it in another tag (or just
-  returns it unmodified).
-* +Serializer+: converts a <tt>Forme::Tag</tt> instance into an
-  html string.
++Formatter+ :: converts a <tt>Forme::Input</tt> instance into a
+               <tt>Forme::Tag</tt> instance (or array of them).
++ErrorHandler+ :: If the <tt>Forme::Input</tt> instance has a error,
+                  takes the formatted tag and marks it as having the error.
++Labeler+ :: If the <tt>Forme::Input</tt> instance has a label,
+             takes the formatted output and labels it.
++Wrapper+ :: Takes the output of the formatter, labeler, and
+             error_handler transformers, and wraps it in another tag (or just
+             returns it unmodified).
++Serializer+ :: converts a <tt>Forme::Tag</tt> instance into an
+                html string.
 
 Technically, only the +Serializer+ is necessary.  The +input+
 and +tag+ methods return +Input+ and +Tag+ objects.  These objects
@@ -245,7 +245,7 @@ and the second argument if given should be a hash of tag attributes. This allows
 inputs inside tags:
 
   Forme.form do |f|
-    f.tag(:span, :class="foo") do
+    f.tag(:span, :class=>"foo") do
       f.input(:text)
     end
   end
@@ -503,11 +503,12 @@ subform options:
            an :inputs option or are using a block with additional inputs,
            you should specify this option.
 
-= Sinatra Support
+= ERB Support
 
-Forme ships with a Sinatra extension that you can get by <tt>require "forme/sinatra"</tt> and using
-<tt>helpers Forme::Sinatra::ERB</tt> in your Sinatra::Base subclass.  It allows you to use the
-following API in your Sinatra ERB forms:
+Forme ships with a ERB extension that you can get by <tt>require "forme/erb"</tt> and using
+<tt>including Forme::ERB::Helper</tt>.  This is tested to support ERB templates in both the
+Sinatra and Roda web frameworks.  It allows you to use the following API in your erb
+templates:
 
   <% form(@obj, :action=>'/foo') do |f| %>
     <%= f.input(:field) %>
@@ -516,8 +517,8 @@ following API in your Sinatra ERB forms:
     <% end %>
   <% end %>
 
-This example is for ERB/Erubis.  Other Sinatra template libraries work differently and
-do not support this integration.
+In order to this to work transparently, the ERB outvar needs to be <tt>@_out_buf</tt>.  If that
+is not the case, use the :output option to +form+ to specify the outvar.
 
 = Rails Support
 

data/lib/forme.rb

@@ -77,6 +77,12 @@ module Forme
     classes.compact.join(' ')
   end
 
+  # Create a RawString using the given string, which will disable automatic
+  # escaping for that string.
+  def self.raw(s)
+    RawString.new(s)
+  end
+
   # If there is a related transformer, call it with the given +args+ and +block+.
   # Otherwise, attempt to return the initial input without modifying it.
   def self.transform(type, trans_name, default_opts, *args, &block)
@@ -217,7 +223,9 @@ module Forme
         when Symbol
           @opts[t] = Forme.transformer(t, @opts[t], @opts)
         when nil
-          @opts[t] = Forme.transformer(t, config, @opts)
+          unless @opts.has_key?(t)
+            @opts[t] = Forme.transformer(t, config, @opts)
+          end
         end
       end
 
@@ -291,8 +299,8 @@ module Forme
     # You can use array arguments if you want inputs to be created with specific
     # options:
     #
-    #   inputs([:field1, :field2])
-    #   inputs([[:field1, {:name=>'foo'}], :field2])
+    #   f.inputs([:field1, :field2])
+    #   f.inputs([[:field1, {:name=>'foo'}], :field2])
     #
     # The given +opts+ are passed to the +inputs_wrapper+, and the default
     # +inputs_wrapper+ supports a <tt>:legend</tt> option that is used to
@@ -306,11 +314,15 @@ module Forme
     #
     # This can also be called with a single hash argument to just use an options hash:
     #
-    #   inputs(:legend=>'Foo'){...}
+    #   f.inputs(:legend=>'Foo') do
+    #     # ...
+    #   end
     #
     # or even without any arguments:
     #
-    #   inputs{...}
+    #   f.inputs do
+    #     # ...
+    #   end
     def inputs(inputs=[], opts={}, &block)
       _inputs(inputs, opts, &block)
     end
@@ -413,6 +425,11 @@ module Forme
       end
     end
 
+    # Return a new string that will not be html escaped by the default serializer.
+    def raw(s)
+      Forme.raw(s)
+    end
+
     # Marks the string as containing already escaped output.  Returns string given
     # by default, but subclasses for specific web frameworks can handle automatic
     # html escaping by overriding this.
@@ -611,6 +628,12 @@ module Forme
   module Raw
   end
 
+  # A String subclass that includes Raw, which will cause the default
+  # serializer to no longer html escape the string.
+  class RawString < ::String
+    include Raw
+  end
+
   # The default formatter used by the library.  Any custom formatters should
   # probably inherit from this formatter unless they have very special needs.
   #

data/lib/forme/erb.rb

@@ -91,13 +91,10 @@ module Forme
       # Create a +Form+ object tied to the current output buffer,
       # using the standard ERB hidden tags.
       def form(obj=nil, attr={}, opts={}, &block)
-        if block
-          h = {:output=>@_out_buf, :hidden_tags=>Forme::ERB::HIDDEN_TAGS, :env=>env}
-          (obj.is_a?(Hash) ? attr = attr.merge(h) : opts = opts.merge(h))
-          Form.form(obj, attr, opts, &block)
-        else
-          Form.form(obj, attr, opts)
-        end
+        h = {:hidden_tags=>Forme::ERB::HIDDEN_TAGS, :env=>env}
+        h[:output] = @_out_buf if block
+        (obj.is_a?(Hash) ? attr = attr.merge(h) : opts = opts.merge(h))
+        Form.form(obj, attr, opts, &block)
       end
     end 
   end

data/lib/forme/version.rb

@@ -1,6 +1,6 @@
 module Forme
   # Version constant, use <tt>Forme.version</tt> instead.
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 
   # Returns the version as a frozen string (e.g. '0.1.0')
   def self.version

data/spec/erb_helper.rb

@@ -119,6 +119,10 @@ END
     erb "<%= form([:foo, :bar], {:action=>'/baz'}, :inputs=>[:first], :button=>'xyz', :legend=>'123') %>"
   end
 
+  r.get 'noblock_post' do
+    erb "<%= form({:method=>:post}, :button=>'xyz') %>"
+  end
+
   r.get 'noblock_empty' do
     erb "<%= form(:action=>'/baz') %>"
   end
@@ -171,6 +175,10 @@ shared_examples_for "erb integration" do
     sin_get('/noblock').should == '<form action="/baz"><fieldset class="inputs"><legend>123</legend><input id="first" name="first" type="text" value="foo"/></fieldset><input type="submit" value="xyz"/></form>'
   end
 
+  specify "#form should work without a block and still have hidden tags emitted" do
+    sin_get('/noblock_post').sub(%r{<input name=\"_csrf\" type=\"hidden\" value=\"([^\"]+)\"/>}, "<input name=\"_csrf\" type=\"hidden\" value=\"csrf\"/>").should == '<form method="post"><input name="_csrf" type="hidden" value="csrf"/><input type="submit" value="xyz"/></form>'
+  end
+
   specify "#form with an empty form should work" do
     sin_get('/noblock_empty').should == '<form action="/baz"></form>'
   end

data/spec/forme_spec.rb

@@ -515,10 +515,18 @@ describe "Forme plain forms" do
     @f.tag(:div, {}, ['<p></p>']).to_s.should == '<div>&lt;p&gt;&lt;/p&gt;</div>'
   end
 
-  specify "should not escape raw tag content" do
+  specify "should not escape raw tag content using Forme::Raw" do
     @f.tag(:div, {}, ['<p></p>'.extend(Forme::Raw)]).to_s.should == '<div><p></p></div>'
   end
 
+  specify "should not escape raw tag content using Forme.raw" do
+    @f.tag(:div, {}, [Forme.raw('<p></p>')]).to_s.should == '<div><p></p></div>'
+  end
+
+  specify "should not escape raw tag content using Form#raw" do
+    @f.tag(:div, {}, [@f.raw('<p></p>')]).to_s.should == '<div><p></p></div>'
+  end
+
   specify "should escape tag content in attribute values" do
     @f.tag(:div, :foo=>'<p></p>').to_s.should == '<div foo="&lt;p&gt;&lt;/p&gt;"></div>'
   end
@@ -671,6 +679,10 @@ describe "Forme custom" do
   specify "inputs_wrappers can be specified as a proc" do
     Forme::Form.new(:inputs_wrapper=>proc{|f, opts, &block| f.tag(:div, &block)}).inputs([:textarea]).to_s.should == '<div><textarea></textarea></div>'
   end
+
+  specify "can use nil as value to disable default transformer" do
+    Forme::Form.new(:labeler=>nil).input(:textarea, :label=>'foo').to_s.should == '<textarea></textarea>'
+  end
 end
 
 describe "Forme built-in custom" do

data/spec/rails_integration_spec.rb

@@ -172,6 +172,10 @@ END
     render :inline => "<%= forme([:foo, :bar], {:action=>'/baz'}, :inputs=>[:first], :button=>'xyz', :legend=>'123') %>"
   end
 
+  def noblock_post
+    render :inline => "<%= forme({:method=>'post'}, :button=>'xyz') %>"
+  end
+
   def safe_buffer
     render :inline => "<%= forme([:foo, :bar], {:action=>'/baz'}, :inputs=>[:first], :button=>'xyz', :legend=>'<b>foo</b>'.html_safe) %>"
   end
@@ -233,6 +237,10 @@ describe "Forme Rails integration" do
     sin_get('/noblock').should == '<form action="/baz"><fieldset class="inputs"><legend>123</legend><input id="first" name="first" type="text" value="foo"/></fieldset><input type="submit" value="xyz"/></form>'
   end
 
+  specify "#form should work without a block with hidden tags" do
+    sin_get('/noblock_post').sub(%r{<input name=\"authenticity_token\" type=\"hidden\" value=\"([^\"]+)\"/>}, "<input name=\"authenticity_token\" type=\"hidden\" value=\"csrf\"/>").should == '<form method="post"><input name="authenticity_token" type="hidden" value="csrf"/><input type="submit" value="xyz"/></form>'
+  end
+
   specify "#form should handle Rails SafeBuffers" do
     sin_get('/safe_buffer').should == '<form action="/baz"><fieldset class="inputs"><legend><b>foo</b></legend><input id="first" name="first" type="text" value="foo"/></fieldset><input type="submit" value="xyz"/></form>'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forme
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2014-09-08 00:00:00.000000000 Z
 dependencies: []
 description: |
   Forme is a forms library with the following goals: