ht5 0.1.1

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,4 @@
+ht5
+===
+
+A Ruby HTML5 generation library

data/lib/ht5.rb

@@ -0,0 +1,117 @@
+#  Copyright 2014 ePark Labs Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+module HT5
+
+  VERSION = "0.1.1"
+
+  class HT5OUT < ::Array
+    def to_s
+      join
+    end
+  end
+
+  # The container that holds the output.
+  def ht5
+    @ht5 ||= start_ht5
+  end
+
+  def start_ht5
+    @ht5 = ::HT5::HT5OUT.new
+  end
+
+  # Add a <!-- comment -->
+  # Usage: comment_{"This is a comment."}
+  def comment_(&b)
+    ht5 << "<!-- #{yield} -->"
+  end
+  alias _! comment_
+
+  # Add a string with no tags (or your own tags)
+  def __(&b)
+    ht5 << yield
+  end
+
+  alias _ __
+
+  # Adds the HTML5 DOCTYPE tag
+  def doctype_
+    start_ht5
+    ht5 << "<!DOCTYPE html>"
+  end
+
+  # Escape HTML
+  # Returns an escaped string for ['"&<>]
+  def h_(str)
+    str.to_s.gsub(/['&\"<>]/, {"'"=>"&#39;", "&"=>"&amp;", '"'=>"&quot;", "<"=>"&lt;", ">"=>"&gt;"})
+  end
+
+  # Escape URL query string
+  # Returns an escaped string for all characters except [a-zA-Z0-9_.-]
+  def url_(str)
+    encoding = str.encoding
+    str.b.gsub(/([^ a-zA-Z0-9_.-]+)/) do |m|
+      '%' + m.unpack('H2' * m.bytesize).join('%').upcase
+    end.tr(' ', '+').force_encoding(encoding)
+  end
+
+  # Support other tags
+  # Usage: tag_(:person, class: 'active'){"Joe"}
+  # Returns: <person class="active">Joe</person>
+  def tag_(el, opts={}, &b)
+    ht5 << "<#{el}#{opts.map{|n,v| " #{n}=\"#{v}\""}.join}>"
+    if block_given?
+      ht5 << yield
+      ht5 << "</#{el}>"
+    end
+    nil
+  end
+
+  def _tag(el)
+    ht5 << "</#{el}>"
+    nil
+  end
+
+  %w(
+    a abbr address area article aside audio b base bdi bdo blockquote body br button canvas caption
+    cite code col colgroup data datagrid datalist dd del details dfn dialog div dl dt em embed
+    eventsource fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header hr html i
+    iframe img input ins kbd keygen label legend li link main mark map menu menuitem meta meter nav
+    noscript object ol optgroup option output p param pre progress q ruby rp rt s samp script section
+    select small source span strong style sub summary sup table tbody td textarea tfoot th thead time
+    title tr track u ul var video wbr
+  ).each{|el|
+    opts = '#{opts.map{|n,v| " #{n}=\"#{v}\""}.join}'
+    tag = <<-EL
+    def #{el}_ opts={}, &b
+      ht5 << "<#{el}#{opts}>"
+      if block_given?
+        ht5 << yield
+        ht5 << "</#{el}>"
+      end
+      nil
+    end
+    def _#{el}
+      ht5 << "</#{el}>"
+      nil
+    end
+    EL
+    eval tag
+  }
+end
+
+# Handle both cases HT5 and Ht5
+module Ht5
+  include HT5
+end

data/test/test_ht5.rb

@@ -0,0 +1,138 @@
+gem "minitest"
+require "minitest/autorun"
+require "./lib/ht5"
+
+class TestHT5 < Minitest::Test
+
+  include HT5
+
+  def test_comment
+    start_ht5
+    comment_{"This is a comment"}
+    _!{"Another"}
+    assert_equal "<!-- This is a comment --><!-- Another -->", ht5.to_s
+  end
+
+  def test_no_tag
+    start_ht5
+    _{"This is plain text. "}
+    __{"more"}
+    assert_equal "This is plain text. more", ht5.to_s
+  end
+
+  def test_doctype
+    doctype_
+    assert_equal "<!DOCTYPE html>", ht5.to_s
+  end
+
+  def test_escape_html
+    start_ht5
+    p_{h_("<b>Joe said:</b> <i>\"Hello 'Jan' & 'Jane'.\"</i>")}
+    assert_equal "<p>&lt;b&gt;Joe said:&lt;/b&gt; &lt;i&gt;&quot;Hello &#39;Jan&#39; &amp; &#39;Jane&#39;.&quot;&lt;/i&gt;</p>", ht5.to_s
+  end
+
+  def test_escape_url
+    start_ht5
+    a_(href: "/goto?url=#{url_("http://waxx.co/a b.html?d=$;x=1;y=2&z=`~!@#\$%^&*()_+=-{}[]|\'\";<>,.?/;")};remote=true"){"Link"}
+    assert_equal %(<a href="/goto?url=http%3A%2F%2Fwaxx.co%2Fa+b.html%3Fd%3D%24%3Bx%3D1%3By%3D2%26z%3D%60%7E%21%40%23%24%25%5E%26%2A%28%29_%2B%3D-%7B%7D%5B%5D%7C%27%22%3B%3C%3E%2C.%3F%2F%3B;remote=true">Link</a>), ht5.to_s
+  end
+
+  def test_undefined_tag
+    start_ht5
+    tag_(:new, style:"font-weight:bold"){"This is a new tag"}
+    tag_(:x)
+    _{"txt"}
+    _tag(:x)
+    assert_equal %(<new style="font-weight:bold">This is a new tag</new><x>txt</x>), ht5.to_s
+  end
+
+  def test_all_tags
+    start_ht5
+    %w(
+    a abbr address area article aside audio b base bdi bdo blockquote body br button canvas caption
+    cite code col colgroup data datagrid datalist dd del details dfn dialog div dl dt em embed
+    eventsource fieldset figcaption figure footer form h1 h2 h3 h4 h5 h6 head header hr html i
+    iframe img input ins kbd keygen label legend li link main mark map menu menuitem meta meter nav
+    noscript object ol optgroup option output p param pre progress q ruby rp rt s samp script section
+    select small source span strong style sub summary sup table tbody td textarea tfoot th thead time
+    title tr track u ul var video wbr
+    ).each{|el|
+      send("#{el}_")
+      send("_#{el}")
+    }
+    assert_equal %(<a></a><abbr></abbr><address></address><area></area><article></article><aside></aside><audio></audio><b></b><base></base><bdi></bdi><bdo></bdo><blockquote></blockquote><body></body><br></br><button></button><canvas></canvas><caption></caption><cite></cite><code></code><col></col><colgroup></colgroup><data></data><datagrid></datagrid><datalist></datalist><dd></dd><del></del><details></details><dfn></dfn><dialog></dialog><div></div><dl></dl><dt></dt><em></em><embed></embed><eventsource></eventsource><fieldset></fieldset><figcaption></figcaption><figure></figure><footer></footer><form></form><h1></h1><h2></h2><h3></h3><h4></h4><h5></h5><h6></h6><head></head><header></header><hr></hr><html></html><i></i><iframe></iframe><img></img><input></input><ins></ins><kbd></kbd><keygen></keygen><label></label><legend></legend><li></li><link></link><main></main><mark></mark><map></map><menu></menu><menuitem></menuitem><meta></meta><meter></meter><nav></nav><noscript></noscript><object></object><ol></ol><optgroup></optgroup><option></option><output></output><p></p><param></param><pre></pre><progress></progress><q></q><ruby></ruby><rp></rp><rt></rt><s></s><samp></samp><script></script><section></section><select></select><small></small><source></source><span></span><strong></strong><style></style><sub></sub><summary></summary><sup></sup><table></table><tbody></tbody><td></td><textarea></textarea><tfoot></tfoot><th></th><thead></thead><time></time><title></title><tr></tr><track></track><u></u><ul></ul><var></var><video></video><wbr></wbr>), ht5.to_s
+  end
+
+  def test_table
+    start_ht5
+    table_(id:"one"){
+      thead_{
+        tr_{
+          th_{"One"}
+          th_{"Two"}
+          th_{"Three"}
+        }
+      }
+      tbody_{
+        tr_{
+          td_{div_{"1"}}
+          td_{span_{"2"}}
+          td_{p_{"3"}}
+        }
+        tr_{
+          td_{div_{"1"}}
+          td_{span_{"2"}}
+          td_{p_{"3"}}
+        }
+      }
+      tfoot_{
+        tr_{
+          td_(colspan:3){"the footer"}
+        }
+      }
+    }
+    assert_equal %(<table id="one"><thead><tr><th>One</th><th>Two</th><th>Three</th></tr></thead><tbody><tr><td><div>1</div></td><td><span>2</span></td><td><p>3</p></td></tr><tr><td><div>1</div></td><td><span>2</span></td><td><p>3</p></td></tr></tbody><tfoot><tr><td colspan="3">the footer</td></tr></tfoot></table>), ht5.to_s
+  end
+
+  def test_document_blocks
+    doctype_
+    html_{
+      head_{
+        title_{"A Page"}
+        meta_(name:"robots", content:"index,follow")
+        script_(type:"text/javascript"){%<alert("Hello from HT5");>}
+      }
+      body_{
+        h1_{"A web page"}
+        section_(id:"one"){
+          article_{
+            p_{"This is an article."}
+            blockquote_{"and Joe said..."}
+          }
+        }
+      }
+    }
+    assert_equal %(<!DOCTYPE html><html><head><title>A Page</title><meta name="robots" content="index,follow"><script type="text/javascript">alert("Hello from HT5");</script></head><body><h1>A web page</h1><section id="one"><article><p>This is an article.</p><blockquote>and Joe said...</blockquote></article></section></body></html>), ht5.to_s
+  end
+
+  def test_document_closing_tags
+    doctype_
+    html_
+      head_
+        title_{"A Page"}
+        meta_(name:"robots", content:"index,follow")
+        script_(type:"text/javascript"){%<alert("Hello from HT5");>}
+      _head
+      body_
+        h1_{"A web page"}
+        section_(id:"one")
+          article_
+            p_{"This is an article."}
+            blockquote_{"and Joe said..."}
+          _article
+        _section
+      _body
+    _html
+    assert_equal %(<!DOCTYPE html><html><head><title>A Page</title><meta name="robots" content="index,follow"><script type="text/javascript">alert("Hello from HT5");</script></head><body><h1>A web page</h1><section id="one"><article><p>This is an article.</p><blockquote>and Joe said...</blockquote></article></section></body></html>), ht5.to_s
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: ht5
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Dan Fitzpatrick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-24 00:00:00.000000000 Z
+dependencies: []
+description: Import into a class to generate HTML5 using Ruby code. Tags are methods.
+email: dan@waxx.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/ht5.rb
+- test/test_ht5.rb
+homepage: https://github.com/waxxio/ht5
+licenses:
+- Apache2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: An HTML5 generator
+test_files: []