tagz 6.0.0 → 7.0.0

data/README

@@ -97,6 +97,28 @@ URIS
   http://rubyforge.org/projects/codeforpeople
 
 HISTORY
+  7.0.0
+    - * IMPORTANT * NOT BACKWARD COMPATIBLE (thus version bump)
+    the tagz functionality itself has not changed, but the defaults for
+    excaping have!  now tagz will escape attributes, but NOT content, in the
+    default mode.  you can easily configure something else with
+
+      Tagz.escape!(:content => true, :attributes => true)
+
+    which would be like saying
+
+      Tagz.xml_mode!
+
+    or
+
+      Tagz.escape!(:content => false, :attributes => true)
+
+    which would be like saying
+
+      Tagz.html_mode!
+
+    to repeat, the default is 'Tagz.html_mode!'
+
   6.0.0 
     - reorganize lib to avoid dumping a few constants into the includee - aka
     don't absolutely minimize namespace pollution. there is now reason to

data/lib/tagz.rb

@@ -1,7 +1,7 @@
 unless defined? Tagz
 
   module Tagz
-    def Tagz.version() '6.0.0' end
+    def Tagz.version() '7.0.0' end
 
   private
 
@@ -134,12 +134,11 @@ unless defined? Tagz
       end
     end
 
-  # escape support
+  # escape utils
   #
     def Tagz.escapeHTML(*strings)
       XChar.escape(strings.join)
     end
-
     def Tagz.escape(*strings)
       XChar.escape(strings.join)
     end
@@ -150,66 +149,75 @@ unless defined? Tagz
       previous = @escape_attribute if defined?(@escape_attribute)
       unless args.empty? and block.nil?
         value = block ? block : args.shift
-        @escape_attribute = value ? value.to_proc : NoEscape
+        value = Escape if value==true
+        value = NoEscape if(value==false or value==nil)
+        @escape_attribute = value.to_proc
         return previous
       end
       @escape_attribute
     end
-
     def Tagz.escape_attributes!(*args, &block)
       Tagz.escape_attribute!(*args, &block)
     end
-
     def Tagz.escape_attribute(value)
       @escape_attribute.call(value.to_s)
     end
 
-  # default escape
-  #
-    escape_attribute!{|value| XChar.escape(value)}
-
   # support for configuring content escaping
   #
     def Tagz.escape_content!(*args, &block)
       previous = @escape_content if defined?(@escape_content)
       unless args.empty? and block.nil?
         value = block ? block : args.shift
-        @escape_content = value ? value.to_proc : NoEscape
+        value = Escape if value==true
+        value = NoEscape if(value==false or value==nil)
+        @escape_content = value.to_proc
         return previous
       end
       @escape_content
     end
-
     def Tagz.escape_contents!(*args, &block)
       Tagz.escape_content!(*args, &block)
     end
-
     def Tagz.escape_content(value)
       @escape_content.call(value.to_s)
     end
 
-  # default escape
-  #
-    escape_content!{|value| XChar.escape(value)}
-
-  # make tagz escape nothing
+  # configure tagz escaping
   #
+    def Tagz.escape!(options = {})
+      options = {:attributes => options, :content => options} unless options.is_a?(Hash)
+      escape_attributes = options[:attributes]||options['attributes']
+      escape_content = options[:content]||options['content']
+      Tagz.escape_attributes!(!!escape_attributes)
+      Tagz.escape_content!(!!escape_content)
+    end
     def Tagz.i_know_what_the_hell_i_am_doing!
-      Tagz.escape_attributes! false
-      Tagz.escape_content! false
+      escape!(false)
     end
-
-  # make tagz escape everything 
-  #
     def Tagz.i_do_not_know_what_the_hell_i_am_doing!
-      escape_attribute!{|value| XChar.escape(value)}
-      escape_content!{|value| XChar.escape(value)}
+      escape!(true)
+    end
+    def Tagz.xml_mode!
+      Tagz.escape!(
+        :attributes => true,
+        :content => true
+      )
     end
+    def Tagz.html_mode!
+      Tagz.escape!(
+        :attributes => true,
+        :content => false
+      )
+    end
+
 
+
+  # module shortcuts - namespace preserving
+  #
     def Tagz.globally
       Globally
     end
-
     def Tagz.privately
       Privately
     end
@@ -378,7 +386,8 @@ unless defined? Tagz
         end
       end
 
-      NoEscape = lambda{|v|v}
+      NoEscape = lambda{|*values| values.join}
+      Escape = lambda{|*values| XChar.escape(values.join)}
 
       module Globally; include ::Tagz; end
       module Privately; include ::Tagz; end
@@ -391,20 +400,20 @@ unless defined? Tagz
       TagzConstants.const_get(const)
     end
 
+  # allow access to instance methods via module handle
+  #
     %w( tagz tagz__ __tagz method_missing ).each{|m| module_function(m)}
   end
 
   def Tagz *argv, &block
-    if argv.empty? and block.nil?
-      ::Tagz
-    else
-      Tagz.tagz(*argv, &block)
-    end
+    (argv.empty? and block.nil?) ? ::Tagz : Tagz.tagz(*argv, &block)
   end
 
   if defined?(Rails)
+    _=ActionView,ActionView::Base,ActionController,ActionController::Base
     ActionView::Base.send(:include, Tagz.globally)
     ActionController::Base.send(:include, Tagz)
   end
 
+  Tagz.html_mode!
 end

data/readme.erb

@@ -97,6 +97,28 @@ URIS
   http://rubyforge.org/projects/codeforpeople
 
 HISTORY
+  7.0.0
+    - * IMPORTANT * NOT BACKWARD COMPATIBLE (thus version bump)
+    the tagz functionality itself has not changed, but the defaults for
+    excaping have!  now tagz will escape attributes, but NOT content, in the
+    default mode.  you can easily configure something else with
+
+      Tagz.escape!(:content => true, :attributes => true)
+
+    which would be like saying
+
+      Tagz.xml_mode!
+
+    or
+
+      Tagz.escape!(:content => false, :attributes => true)
+
+    which would be like saying
+
+      Tagz.html_mode!
+
+    to repeat, the default is 'Tagz.html_mode!'
+
   6.0.0 
     - reorganize lib to avoid dumping a few constants into the includee - aka
     don't absolutely minimize namespace pollution. there is now reason to

data/tagz.gemspec

@@ -3,7 +3,7 @@
 
 Gem::Specification::new do |spec|
   spec.name = "tagz"
-  spec.version = "6.0.0"
+  spec.version = "7.0.0"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "tagz"
 

data/test/tagz.rb

@@ -474,8 +474,7 @@ class TagzTest < Test::Unit::TestCase
   end
 
   def test_390
-    expected = '<div class="bar&amp;foo&gt;">foo&amp;bar&gt;</div>'
-    # actual = tagz{ div_(:class => 'bar&foo>'){|t| t.h('foo&bar>') } }
+    expected = '<div class="bar&amp;foo&gt;">foo&bar></div>'
     actual = tagz{ div_(:class => 'bar&foo>'){ 'foo&bar>' } }
     assert_equal expected, actual
 
@@ -485,7 +484,7 @@ class TagzTest < Test::Unit::TestCase
   end
 
   def test_400
-    expected = '<div><span>foo&amp;bar</span></div>'
+    expected = '<div><span>foo&bar</span></div>'
     actual = tagz{ div_{ span_{ 'foo&bar' } } }
     assert_equal expected, actual
   end
@@ -603,27 +602,27 @@ class TagzTest < Test::Unit::TestCase
 
     actual = nil
     assert_nothing_raised{ actual=c.a}
-    expected = %(<div>a&gt;b</div>)
+    expected = %(<div>a>b</div>)
     assert_equal expected, actual
 
-    original = Tagz.escape_content! false
+    original = Tagz.escape_content!(true)
     assert original
     actual = nil
     assert_nothing_raised{ actual=c.a}
-    expected = %(<div>a>b</div>)
+    expected = %(<div>a&gt;b</div>)
     assert_equal expected, actual
 
-    upcased = Tagz.escape_content! lambda{|value| original.call(value).upcase} 
+    upcased = Tagz.escape_content!(lambda{|value| original.call(value).upcase})
     assert upcased
     actual = nil
     assert_nothing_raised{ actual=c.a}
-    expected = %(<div>A&GT;B</div>)
+    expected = %(<div>A>B</div>)
     assert_equal expected, actual
 
-    Tagz.escape_content! original
+    Tagz.escape_content!(original)
     actual = nil
     assert_nothing_raised{ actual=c.a}
-    expected = %(<div>a&gt;b</div>)
+    expected = %(<div>a>b</div>)
     assert_equal expected, actual
   ensure
     Tagz.escape_content!(original)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tagz
 version: !ruby/object:Gem::Version 
-  version: 6.0.0
+  version: 7.0.0
 platform: ruby
 authors: 
 - Ara T. Howard
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-25 00:00:00 -06:00
+date: 2009-07-26 00:00:00 -06:00
 default_executable: 
 dependencies: []