tagz 4.6.0 → 5.0.0

data/a.rb

@@ -1,5 +1,10 @@
 require 'tagz'
 
-include Tagz.globally
+include Tagz.privately
 
-p a_{ false }
+def bar
+  missing
+end
+
+puts div_{ 'foobar' }
+bar

data/gemspec.rb

@@ -24,10 +24,10 @@ Gem::Specification::new do |spec|
   
   spec.require_path = "lib" 
 
-  spec.has_rdoc = File::exist? "doc" 
-  spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"
+  spec.has_rdoc = true #File::exist? "doc" 
+  spec.test_suite_file = "test/#{ lib }.rb" if File::file?("test/#{ lib }.rb")
   #spec.add_dependency 'lib', '>= version'
-  spec.add_dependency 'fattr'
+  #spec.add_dependency 'fattr'
 
   spec.extensions << "extconf.rb" if File::exists? "extconf.rb"
 

data/gen_readme.rb

@@ -1,3 +1,5 @@
+#! /usr/bin/env ruby
+
 require 'pathname'
 
 $VERBOSE=nil

data/lib/tagz.rb

@@ -3,28 +3,174 @@ unless defined? Tagz
   module Tagz
     unless defined?(Tagz::VERSION)
       Tagz::VERSION = [
-        Tagz::VERSION_MAJOR = 4,
-        Tagz::VERSION_MINOR = 6,
+        Tagz::VERSION_MAJOR = 5,
+        Tagz::VERSION_MINOR = 0,
         Tagz::VERSION_TEENY = 0 
       ].join('.')
       def Tagz.version() Tagz::VERSION end
     end
 
-    def Tagz.escapeHTML string
-      string = string.to_s.dup
-      string.gsub!(%r/&/n, '&')
-      string.gsub!(%r/\"/n, '"')
-      string.gsub!(%r/>/n, '>')
-      string.gsub!(%r/</n, '&lt;')
-      string
+  private
+
+  # open_tag
+  #
+    def tagz__ name, *argv, &block
+      options = argv.last.is_a?(Hash) ? argv.pop : {}
+      content = argv
+
+      unless options.empty?
+        attributes = ' ' << 
+          options.map do |key, value|
+            key = XChar.escape key.to_s
+            value = XChar.escape value.to_s
+            if value =~ %r/"/
+              raise ArgumentError, value if value =~ %r/'/
+              value = "'#{ value }'"
+            else
+              raise ArgumentError, value if value =~ %r/"/
+              value = "\"#{ value }\""
+            end
+            [key, value].join('=')
+          end.join(' ')
+      else
+        attributes = ''
+      end
+
+      tagz.concat "<#{ name }#{ attributes }>"
+
+      if content.empty?
+        if block
+          size = tagz.size
+          value = block.call(tagz)
+          if NilClass === value
+            tagz[-1] = "/>"
+          else
+            tagz << value.to_s unless(tagz.size > size)
+            tagz.concat "</#{ name }>"
+          end
+        end
+      else
+        tagz << content.join
+        if block
+          size = tagz.size
+          value = block.call(tagz)
+          tagz << value.to_s unless(tagz.size > size)
+        end
+        tagz.concat "</#{ name }>"
+      end
+
+      tagz
     end
 
-    class Fragment < ::String
-      def << other
-        super other.to_s
+  # close_tag
+  #
+    def __tagz tag, *a, &b
+      tagz.concat "</#{ tag }>"
+    end
+
+  # access tagz doc and enclose tagz operations
+  #
+    def tagz document = nil, &block
+      @tagz ||= nil ## shut wornings up
+      previous = @tagz
+
+      if block
+        @tagz ||= (Document.for(document) || Document.new)
+        begin
+          size = @tagz.size
+          value = instance_eval(&block)
+          @tagz << value unless(@tagz.size > size)
+          @tagz
+        ensure
+          @tagz = previous
+        end
+      else
+        document ? Document.for(document) : @tagz
+      end
+    end
+
+  # catch special tagz methods
+  #
+    def method_missing m, *a, &b
+      strategy =
+        case m.to_s
+          when %r/^(.*[^_])_(!)?$/o
+            :open_tag
+          when %r/^_([^_].*)$/o
+            :close_tag
+          when 'e'
+            :element
+          when '__', '___'
+            :puts
+          else
+            nil
+        end
+
+      if(strategy.nil? or (tagz.nil? and not Globally===self))
+        begin
+          super
+        ensure
+          $!.set_backtrace caller(skip=1) if $!
+        end
+      end
+      
+      case strategy
+        when :open_tag
+          m, bang = $1, $2
+          b ||= lambda{} if bang
+          tagz{ tagz__(m, *a, &b) }
+        when :close_tag
+          m = $1
+          tagz{ __tagz(m, *a, &b) }
+        when :element
+          Element.new(*a, &b)
+        when :puts
+          tagz do
+            tagz.concat("\n")
+            unless a.empty?
+              tagz.concat(a.join)
+              tagz.concat("\n")
+            end
+          end
+      end
+    end
+
+    class Document < ::String
+      def Document.for other
+        Document === other ? other : Document.new(other.to_s)
+      end
+
+      def element
+        Element.new(*a, &b)
+      end
+      alias_method 'e', 'element'
+
+      def << string 
+        case string
+          when Document
+            super string.to_s
+          else
+            super XChar.escape(string.to_s)
+        end
         self
       end
 
+      def escape(*strings)
+        XChar.escape(strings.join)
+      end
+      alias_method 'h', 'escape'
+
+      def puts string
+        concat "#{ string }\n"
+      end
+      alias_method 'push', 'concat'
+      alias_method 'write', 'concat'
+
+      def document
+        self
+      end
+      alias_method 'doc', 'document'
+
       def + other
         self.dup << other
       end
@@ -43,8 +189,8 @@ unless defined? Tagz
         unless options.empty?
           ' ' << 
             options.map do |key, value|
-              key = Tagz.escapeHTML key.to_s
-              value = Tagz.escapeHTML value.to_s
+              key = XChar.escape key.to_s
+              value = XChar.escape value.to_s
               if value =~ %r/"/
                 raise ArgumentError, value if value =~ %r/'/
                 value = "'#{ value }'"
@@ -87,144 +233,79 @@ unless defined? Tagz
       end
     end
 
-    def Tagz.export *methods 
-      methods.flatten.compact.uniq.each do |m|
-        module_function m
-      end
-    end
-
-    def Tagz.<< other
-      Tagz.tagz << other
-      self
-    end
-
-    module Globally
-    private
-      include Tagz
-      def method_missing m, *a, &b 
-        tagz{ super }
-      end
-    end
-
-    def Tagz.globally
-      Globally
-    end
-
-  private
+    module XChar
+    # http://intertwingly.net/stories/2004/04/14/i18n.html#CleaningWindows
+    #
+      CP1252 = {
+        128 => 8364, # euro sign
+        130 => 8218, # single low-9 quotation mark
+        131 =>  402, # latin small letter f with hook
+        132 => 8222, # double low-9 quotation mark
+        133 => 8230, # horizontal ellipsis
+        134 => 8224, # dagger
+        135 => 8225, # double dagger
+        136 =>  710, # modifier letter circumflex accent
+        137 => 8240, # per mille sign
+        138 =>  352, # latin capital letter s with caron
+        139 => 8249, # single left-pointing angle quotation mark
+        140 =>  338, # latin capital ligature oe
+        142 =>  381, # latin capital letter z with caron
+        145 => 8216, # left single quotation mark
+        146 => 8217, # right single quotation mark
+        147 => 8220, # left double quotation mark
+        148 => 8221, # right double quotation mark
+        149 => 8226, # bullet
+        150 => 8211, # en dash
+        151 => 8212, # em dash
+        152 =>  732, # small tilde
+        153 => 8482, # trade mark sign
+        154 =>  353, # latin small letter s with caron
+        155 => 8250, # single right-pointing angle quotation mark
+        156 =>  339, # latin small ligature oe
+        158 =>  382, # latin small letter z with caron
+        159 =>  376} # latin capital letter y with diaeresis
 
-    def tagz__ name, *argv, &block
-      options = {}
-      content = []
+    # http://www.w3.org/TR/REC-xml/#dt-chardata
+    #
+      PREDEFINED = {
+        38 => '&amp;', # ampersand
+        60 => '&lt;',  # left angle bracket
+        62 => '&gt;'}  # right angle bracket
 
-      argv.each do |arg|
-        case arg
-          when Hash
-            options.update arg
-          else
-            content.push arg
-        end
-      end
+    # http://www.w3.org/TR/REC-xml/#charsets
+    #
+      VALID = [[0x9, 0xA, 0xD], (0x20..0xD7FF), (0xE000..0xFFFD), (0x10000..0x10FFFF)]
 
-      unless options.empty?
-        attributes = ' ' << 
-          options.map do |key, value|
-            key = Tagz.escapeHTML key.to_s
-            value = Tagz.escapeHTML value.to_s
-            if value =~ %r/"/
-              raise ArgumentError, value if value =~ %r/'/
-              value = "'#{ value }'"
-            else
-              raise ArgumentError, value if value =~ %r/"/
-              value = "\"#{ value }\""
-            end
-            [key, value].join('=')
-          end.join(' ')
-      else
-        attributes = ''
+      def XChar.escape(string)
+        string.unpack('U*').map{|n| xchr(n)}.join # ASCII, UTF-8
+      rescue
+        string.unpack('C*').map{|n| xchr(n)}.join # ISO-8859-1, WIN-1252
       end
 
-      tagz << "<#{ name }#{ attributes }>"
-
-      if content.empty?
-        if block
-          size = tagz.size
-          value = block.call(tagz)
-          if NilClass === value
-            tagz[-1] = "/>"
-          else
-            tagz << value.to_s unless(Fragment === value or tagz.size > size)
-            tagz << "</#{ name }>"
-          end
-        end
-      else
-        content.each{|c| tagz << c.to_s unless Fragment === c}
-        if block
-          size = tagz.size
-          value = block.call(tagz)
-          tagz << value.to_s unless(Fragment === value or tagz.size > size)
-        end
-        tagz << "</#{ name }>"
+      def XChar.xchr(n)
+        (@xchr ||= {})[n] ||= ((
+          n = XChar::CP1252[n] || n
+          n = 42 unless XChar::VALID.find{|range| range.include? n}
+          XChar::PREDEFINED[n] or (n<128 ? n.chr : "&##{n};")
+        ))
       end
-
-      tagz
     end
 
-    def __tagz tag, *a, &b
-      tagz << "</#{ tag }>"
+    def Tagz.escapeHTML string
+      XChar.escape(string)
     end
 
-    def tagz &block
-      if block
-        if not defined?(@tagz) or @tagz.nil?
-          @tagz = Fragment.new
-          top = true
-        end
-        begin
-          size = @tagz.size
-          value = instance_eval(&block)
-          @tagz << value unless(Fragment === value or @tagz.size > size)
-          @tagz
-        ensure
-          @tagz = nil if top
-        end
-      else
-        @tagz if defined? @tagz
-      end
+    module Globally; include Tagz; end
+    def Tagz.globally
+      Globally
     end
 
-    def method_missing m, *a, &b
-      if not Globally === self
-        unless defined?(@tagz) and @tagz
-          begin
-            super
-          ensure
-            $!.set_backtrace caller(skip=1) if $!
-          end
-        end
-      end
-      
-      case m.to_s
-        when %r/^(.*[^_])_(!)?$/o
-          m, bang = $1, $2
-          b ||= lambda{} if bang
-          tagz{ tagz__(m, *a, &b) }
-        when %r/^_([^_].*)$/o
-          m = $1 
-          tagz{ __tagz(m, *a, &b) }
-        when 'e'
-          Element.new(*a, &b)
-        when '__'
-          tagz{ tagz << "\n"; a.each{|s| tagz << s}; }
-        else
-          begin
-            super
-          ensure
-            $!.set_backtrace caller(skip=1) if $!
-          end
-      end
+    module Privately; include Tagz; end
+    def Tagz.privately
+      Privately
     end
 
-    export %w( tagz tagz__ __tagz method_missing )
+    %w( tagz tagz__ __tagz method_missing ).each{|m| module_function(m)}
   end
 
   def Tagz *argv, &block

data/prof.rb

@@ -0,0 +1,25 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'ruby-prof'
+
+$:.unshift File.dirname(__FILE__)
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+
+require 'tagz'
+
+RubyProf.start
+
+include Tagz.globally
+
+1000.times do
+  div_(:class => 'speedtest'){
+    a_(:href => 'foo&bar'){ 'foo&bar' }
+  }
+end
+
+
+result = RubyProf.stop
+
+printer = RubyProf::FlatPrinter.new(result)
+printer.print(STDOUT, 0)

data/samples/b.rb

@@ -3,7 +3,8 @@
 # the need for '<% rows.each do |row| %> ... <% row.each do |cell| %> '
 # madness and other types of logic to be coded in the templating language,
 # leaving templating to template engines and logic and looping to ruby -
-# unencumbered by extra funky syntax
+# unencumbered by extra funky syntax.  in rails tagz will automatically be
+# available in your erb templates.
 #
 
 require 'tagz'
@@ -17,21 +18,15 @@ template = ERB.new <<-ERB
   <html>
     <body>
       <%=
-
-        if rows
-
-          table_{
-            rows.each do |row|
-              tr_{
-                row.each do |cell|
-                  td_{ cell }
-                end
-              }
-            end
-          }
-
-        end
-
+        table_{
+          rows.each do |row|
+            tr_{
+              row.each do |cell|
+                td_{ cell }
+              end
+            }
+          end
+        }
       %>
     </body>
   </html>

data/samples/d.rb

@@ -12,13 +12,13 @@ def header
     html_
       body_(:class => 'ninja-like', :id => 'giraffe-slayer')
 
-      tagz << "\n<!-- this is the header -->\n"
+      ___ "<!-- this is the header -->"
   }
 end
 
 def footer
   tagz{
-    tagz << "\n<!-- this is the footer -->\n"
+    ___ "<!-- this is the footer -->"
 
     body_
       html_

data/samples/f.rb

@@ -3,15 +3,20 @@
 # but can sometimes make reading the generated html a bit rough.  of course
 # using tidy or the dom inspector in firebug obviates the issue; nevertheless
 # it's sometime nice to break things up a little.  you can use 'tagz << "\n"'
-# or the special shorthand '__' to accomplish this
+# or the special shorthand '__' or '___' to accomplish this
 #
 
 require 'tagz'
 include Tagz.globally
 
-p div_{
-  span_{ true }
-  __
-  span_{ false }  # hey ryan, i fixed this ;-)
-  __
-}
+html =
+  div_{
+    span_{ true }
+    __
+    span_{ false }  # hey ryan, i fixed this ;-)
+    ___
+
+    ___ 'foo & escaped bar'
+  }
+
+puts html

data/samples/g.rb

@@ -0,0 +1,19 @@
+# tagz gives you low-level control of the output and makes even dashersized
+# xml tagz easy enough to work with
+#
+
+require 'tagz'
+include Tagz.globally
+
+xml =
+  root_{
+    tagz__('foo-bar', :key => 'foo&bar'){ 'content' }
+
+    tagz__('bar-foo')
+    tagz.concat 'content'
+    tagz.concat tagz.escape('foo&bar')
+    __tagz('bar-foo')
+  }
+
+puts xml
+

data/test/tagz.rb

@@ -1,8 +1,13 @@
+#! /usr/bin/env ruby
+
 require 'test/unit'
+
+$VERBOSE = 2
 STDOUT.sync = true
 $:.unshift 'lib'
 $:.unshift '../lib'
 $:.unshift '.'
+
 require 'tagz'
 
 class TagzTest < Test::Unit::TestCase
@@ -395,7 +400,7 @@ class TagzTest < Test::Unit::TestCase
     actual = tagz{ 
       html_{
         body_{
-          links.map{|link| e(:a, :href => link){ link }}.join e(:span){ '|' } 
+          tagz.write links.map{|link| e(:a, :href => link){ link }}.join(e(:span){ '|' })
         }
       }
     }
@@ -467,4 +472,68 @@ class TagzTest < Test::Unit::TestCase
     }
     assert_equal expected, actual
   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>') } }
+    actual = tagz{ div_(:class => 'bar&foo>'){ 'foo&bar>' } }
+    assert_equal expected, actual
+
+    expected = %|<div class="bar&amp;foo&gt;">#{ expected }</div>|
+    actual = tagz{ div_(:class => 'bar&foo>'){ actual } }
+    assert_equal expected, actual
+  end
+
+  def test_400
+    expected = '<div><span>foo&amp;bar</span></div>'
+    actual = tagz{ div_{ span_{ 'foo&bar' } } }
+    assert_equal expected, actual
+  end
+
+  def test_410
+    expected = '<div>false</div>'
+    actual = tagz{ div_{ false } }
+    assert_equal expected, actual
+  end
+
+  def test_420
+    expected = "<div>\n<span>foobar</span>\nfoobar\n</div>"
+    actual = tagz{ div_{ __; span_{ :foobar }; ___('foobar'); } }
+    assert_equal expected, actual
+  end
+
+  def test_430
+    c = Class.new{
+      include Tagz.globally
+      def foobar() div_{ 'foobar' } end
+    }.new
+
+    actual=nil
+    assert_nothing_raised{ actual=c.foobar }
+    expected = '<div>foobar</div>'
+    assert_equal expected, actual
+
+=begin
+    e = nil
+    assert_raises(NoMethodError){ begin; c.missing; ensure; e=$!; end }
+    assert e
+    messages = e.backtrace.map{|line| line.split(%r/:/, 3).last}
+    assert messages.all?{|message| message !~ /tagz/}
+=end
+  end
+
+  def test_440
+    c = Class.new{
+      include Tagz
+      def foobar() tagz{ div_{ 'foobar' } } end
+      def barfoo() div_{ 'barfoo' } end
+    }.new
+
+    actual=nil
+    assert_nothing_raised{ actual=c.foobar }
+    expected = '<div>foobar</div>'
+    assert_equal expected, actual
+
+    assert_raises(NoMethodError){ c.barfoo }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: tagz
 version: !ruby/object:Gem::Version 
-  version: 4.6.0
+  version: 5.0.0
 platform: ruby
 authors: 
 - Ara T. Howard
@@ -9,19 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-06 00:00:00 -07:00
+date: 2009-03-23 00:00:00 -06:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: fattr
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+dependencies: []
+
 description: 
 email: ara.t.howard@gmail.com
 executables: []
@@ -37,6 +28,7 @@ files:
 - install.rb
 - lib
 - lib/tagz.rb
+- prof.rb
 - README
 - samples
 - samples/a.rb
@@ -45,9 +37,10 @@ files:
 - samples/d.rb
 - samples/e.rb
 - samples/f.rb
+- samples/g.rb
 - test
 - test/tagz.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://codeforpeople.com/lib/ruby/tagz/
 post_install_message: 
 rdoc_options: []