hypertext 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ed751f7bacf414010a50e266e61ad2124e9694b2f58e063c86c07aafdf6a7d0
+  data.tar.gz: f49d0b5f3ebed4ca55ca4ccb1d92eb01491f52069698ab8636da2cb6acae61a0
+SHA512:
+  metadata.gz: 8f2fe8239fe6cf432af39a8b2382abe3097b1e9f0b092374cfadc588f5f595a1f690d42ae152c1a389e813d27d2481daa9c2f205ed4f3c10a0624a015d9d969e
+  data.tar.gz: f6da75a9e0c066a835e35abd2583b063b85c0d39d04aa0fe35036a7648625b93e22b0bb296beecd58fef3264f593975da6666ab1d9dfa7352bbb3cd800fad308

data/CONTRIBUTING

@@ -0,0 +1,19 @@
+This code tries to solve a particular problem with a very simple
+implementation. We try to keep the code to a minimum while making
+it as clear as possible. The design is very likely finished, and
+if some feature is missing it is possible that it was left out on
+purpose. That said, new usage patterns may arise, and when that
+happens we are ready to adapt if necessary.
+
+A good first step for contributing is to meet us on IRC and discuss
+ideas. We spend a lot of time on #lesscode at freenode, always ready
+to talk about code and simplicity. If connecting to IRC is not an
+option, you can create an issue explaining the proposed change and
+a use case. We pay a lot of attention to use cases, because our
+goal is to keep the code base simple. Usually the result of a
+conversation is the creation of a different tool.
+
+Please don't start the conversation with a pull request. The code
+should come at last, and even though it may help to convey an idea,
+more often than not it draws the attention to a particular
+implementation.

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2021 Michel Martens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+Hypertext
+=========
+
+Hypertext authoring
+
+Description
+-----------
+
+Hypertext allows you to write HTML from Ruby.
+
+Usage
+-----
+
+A basic example would look like this:
+
+```ruby
+html = Hypertext.new do |h|
+  h.tag :div, class: "greeting" do |h|
+    h.tag :h1 do |h|
+      h.text "hello world"
+    end
+
+    h.tag :hr
+
+    h.tag :p do |h|
+      h.text "nice to meet you"
+    end
+  end
+end
+
+puts html.to_s
+
+# <div class="greeting">
+#   <h1>
+#     hello world
+#   </h1>
+#   <hr />
+#   <p>
+#     nice to meet you
+#   </p>
+# </div>
+```
+
+Installation
+------------
+
+```
+$ gem install hypertext
+```

data/hypertext.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name              = "hypertext"
+  s.version           = "0.0.1"
+  s.summary           = "Hypertext authoring"
+  s.description       = "Hypertext authoring with Ruby"
+  s.authors           = ["Michel Martens"]
+  s.email             = ["michel@soveran.com"]
+  s.homepage          = "https://github.com/soveran/hypertext"
+  s.license           = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_development_dependency "cutest"
+end

data/lib/hypertext.rb

@@ -0,0 +1,95 @@
+# encoding: UTF-8
+#
+# Copyright (c) 2021 Michel Martens
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+class Hypertext
+  ENTITIES = {
+    "'" => ''',
+    '&' => '&',
+    '"' => '"',
+    '<' => '&lt;',
+    '>' => '&gt;',
+  }
+
+  def self.render(array, indent = "  ", level = 0)
+    array.map do |element|
+      if Array === element
+        render(element, indent, level + 1)
+      else
+        sprintf "%s%s\n", indent * level, element
+      end
+    end.join
+  end
+
+  def self.escape(str)
+    str.gsub(/['&\"<>]/, ENTITIES)
+  end
+
+  def initialize
+    @dom = []
+
+    if block_given?
+      yield self
+    end
+  end
+
+  def tag(name, attributes = {}, &block)
+    atts = compile(attributes)
+
+    if block_given?
+      @dom.push "<#{name}#{atts}>"
+      @dom.push yield(self.class.new).to_a
+      @dom.push "</#{name}>"
+    else
+      @dom.push "<#{name}#{atts} />"
+    end
+  end
+
+  def text(value)
+    @dom.push(escape(value))
+  end
+
+  def to_a
+    @dom
+  end
+
+  def to_s(indent = "  ")
+    self.class.render(@dom, indent)
+  end
+
+private
+
+  def escape(str)
+    self.class.escape(str)
+  end
+
+  def compile(attributes)
+    attributes.map do |key, val|
+      case val
+      when false
+      when true
+        %[ #{key}]
+      else
+        %[ #{key}="#{escape(val.to_s)}"]
+      end
+    end.join
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest -r ./test/helper.rb ./test/*.rb

data/test/all.rb

@@ -0,0 +1,75 @@
+scope "Hypertext" do
+  test "text" do
+    expected = "hello world\n"
+
+    observed = Hypertext.new
+    observed.text "hello world"
+
+    assert_equal expected, observed.to_s
+  end
+
+  test "self-closing tags" do
+    expected = "<br />\n"
+
+    observed = Hypertext.new
+    observed.tag :br
+
+    assert_equal expected, observed.to_s
+  end
+
+  test "opening and closing tags" do
+    expected = "<span>\n  hello world\n</span>\n"
+
+    observed = Hypertext.new
+    observed.tag :span do |ht|
+      ht.text "hello world"
+    end
+
+    assert_equal expected, observed.to_s
+  end
+
+  test "nested tags" do
+    expected = "<div>\n  <p>\n    hello world\n  </p>\n</div>\n"
+
+    observed = Hypertext.new
+    observed.tag :div do |ht|
+      ht.tag :p do |ht|
+        ht.text "hello world"
+      end
+    end
+
+    assert_equal expected, observed.to_s
+  end
+
+  test "passing a block to Hypertext.new" do
+    expected = "<br />\n"
+
+    observed = Hypertext.new do |ht|
+      ht.tag :br
+    end
+
+    assert_equal expected, observed.to_s
+  end
+
+  test "tags with attributes" do
+    expected = "<input type=\"text\" name=\"person[name]\" value=\"Foo\" />\n"
+
+    observed = Hypertext.new do |ht|
+      ht.tag :input, :type => "text", :name => "person[name]", :value => "Foo"
+    end
+
+    assert_equal expected, observed.to_s
+  end
+
+  test "custom indentation" do
+    expected = "<p>\n....hello world\n</p>\n"
+
+    observed = Hypertext.new do |ht|
+      ht.tag :p do |ht|
+        ht.text "hello world"
+      end
+    end
+
+    assert_equal expected, observed.to_s("....")
+  end
+end

data/test/helper.rb

@@ -0,0 +1 @@
+require_relative "../lib/hypertext"

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: hypertext
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Hypertext authoring with Ruby
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- CONTRIBUTING
+- LICENSE
+- README.md
+- hypertext.gemspec
+- lib/hypertext.rb
+- makefile
+- test/all.rb
+- test/helper.rb
+homepage: https://github.com/soveran/hypertext
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Hypertext authoring
+test_files: []