koara-html 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2daab273db0f5c73aceb653b38791f2dae6e268b
+  data.tar.gz: 5d365037c6e3aab4be193fd10bba0476c348e7e8
+SHA512:
+  metadata.gz: 991b54240e34fafc40e2c363b8e505f90d4ee18d707811c155732bcff144fefe36f4c0e9d2bbe53293633376465bf08724a0e1e930038bb0c2250c059f6afaf6
+  data.tar.gz: da6cb46e4e637c6972a000bd5185368c577a4b1c6a6ef052fcd2d308ad57bbed7f832c80b8badb477990d4fb9e7d27a8e86cb0caf7ff090c0f4059d3c842ebe9

data/.gitignore

@@ -0,0 +1,2 @@
+.idea
+.DS_Store

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "testsuite"]
+	path = testsuite
+	url = http://github.com/koara/testsuite

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - jruby-19mode
+  - rbx-2

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'koara', '= 0.9.0'
+
+gemspec

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,40 @@
+[![Koara](http://www.koara.io/logo.png)](http://www.koara.io)
+
+[![Build Status](https://img.shields.io/travis/koara/koara-rb-html.svg)](https://travis-ci.org/koara/koara-rb-html)
+[![Coverage Status](https://img.shields.io/coveralls/koara/koara-rb-html.svg)](https://coveralls.io/github/koara/koara-rb-html?branch=master)
+[![Gem](https://img.shields.io/gem/v/koara-html.svg?maxAge=2592000)]()
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/koara/koara-rb-html/blob/master/LICENSE)
+
+# Koara-rb-html
+[Koara](http://www.koara.io) is a modular lightweight markup language. This project can render the koara AST to Html in Ruby.
+The AST is created by the [core koara parser](https://github.com/koara/koara-rb).
+
+## Getting started
+- Gem
+
+  ```bash
+  gem install koara-html
+  ```
+
+## Usage
+
+```ruby
+require 'koara'
+require 'koara/html'
+
+parser = Koara::Parser.new
+result = parser.parse('Hello World!')
+renderer = Koara::Html::Html5Renderer.new
+result.accept(renderer)
+puts renderer.output
+```
+  
+
+
+## Configuration
+You can configure the Renderer:
+
+-  **renderer.partial**  
+   Default:	`true`
+   
+   When false, the output will be wrapped with a `<html>` and `<body>` tag to make a complete Html document.

data/Rakefile

@@ -0,0 +1,11 @@
+task :default => 'test:unit'
+
+require 'rake/testtask'
+
+Rake::TestTask.new('test:unit') do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/*.rb'
+  t.verbose = true
+  t.warning = false
+end

data/koara-html.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'koara-html'
+  s.version       = '0.9.0'
+  s.authors       = ['Andy Van Den Heuvel']
+  s.email         = ['andy.vandenheuvel@gmail.com']
+  s.summary       = 'Koara to HTML parser written in Ruby'
+  s.description = s.summary
+  s.homepage      = 'https://github.com/koara/koara-rb-html'
+  s.license       = 'Apache-2.0'
+
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
+end

data/lib/koara/html.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require 'koara/html/html5renderer'
+
+module Koara
+  module Html
+    VERSION = "0.9.0"
+  end
+end

data/lib/koara/html/html5renderer.rb

@@ -0,0 +1,197 @@
+# encoding: utf-8
+module Koara
+  module Html
+    class Html5Renderer
+      attr_accessor :partial
+
+      def initialize
+        @partial = true
+      end
+
+      def visit_document(node)
+        @level = 0
+        @list_sequence = Array.new
+        @out = StringIO.new
+        node.children_accept(self)
+      end
+
+      def visit_heading(node)
+        @out << indent + '<h' + node.value.to_s + '>'
+        node.children_accept(self)
+        @out << '</h' + node.value.to_s + ">\n"
+        unless node.nested
+          @out << "\n"
+        end
+      end
+
+      def visit_blockquote(node)
+        @out << indent + '<blockquote>'
+        if !node.children.nil? && node.children.any?
+          @out << "\n"
+        end
+        @level += 1
+        node.children_accept(self)
+        @level-=1
+        @out << indent + "</blockquote>\n"
+        if !node.nested
+          @out << "\n"
+        end
+      end
+
+      def visit_list_block(node)
+        @list_sequence.push(0)
+        tag = node.ordered ? 'ol' : 'ul'
+        @out << "#{indent}<#{tag}>\n"
+        @level += 1
+        node.children_accept(self)
+        @level -= 1
+        @out << "#{indent}</#{tag}>\n"
+        if !node.nested
+          @out << "\n"
+        end
+        @list_sequence.pop
+      end
+
+      def visit_list_item(node)
+        seq = @list_sequence.last.to_i + 1
+        @list_sequence[-1] = seq
+        @out << "#{indent}<li"
+
+        if node.number && seq != node.number.to_i
+          @out << " value=\"#{node.number}\""
+          @list_sequence.push(node.number)
+        end
+        @out << '>'
+        if !node.children.nil?
+          block = node.children[0].instance_of?(Koara::Ast::Paragraph) || node.children[0].instance_of?(Koara::Ast::BlockElement)
+          if (node.children.length > 1 || !block)
+            @out << "\n"
+          end
+          @level += 1
+          node.children_accept(self)
+          @level -= 1
+          if (node.children.length > 1 || !block)
+            @out << indent
+          end
+        end
+        @out << "</li>\n"
+      end
+
+      def visit_codeblock(node)
+        @out << indent + '<pre><code'
+        if node.language
+          @out << " class=\"language-" + escape(node.language) + "\""
+        end
+        @out << '>'
+        @out << escape(node.value) + "</code></pre>\n"
+        @out << ("\n") if !node.nested
+      end
+
+      def visit_paragraph(node)
+        if node.nested && node.parent.instance_of?(Koara::Ast::ListItem) && node.is_single_child
+          node.children_accept(self)
+        else
+          @out << indent + '<p>'
+          node.children_accept(self)
+          @out << "</p>\n"
+          unless node.nested
+            @out << "\n"
+          end
+        end
+      end
+
+      def visit_block_element(node)
+        if node.nested && node.parent.instance_of?(Koara::Ast::ListItem) && node.is_single_child
+          node.children_accept(self)
+        else
+          @out << indent
+          node.children_accept(self)
+          if !node.nested
+            @out << "\n"
+          end
+        end
+      end
+
+      def visit_image(node)
+        @out << "<img src=\"" + escape_url(node.value) + "\" alt=\""
+        node.children_accept(self)
+        @out << "\" />"
+      end
+
+      def visit_link(node)
+        @out << "<a href=\"" + escape_url(node.value) + "\">"
+        node.children_accept(self)
+        @out << '</a>'
+      end
+
+      def visit_strong(node)
+        @out << '<strong>'
+        node.children_accept(self)
+        @out << '</strong>'
+      end
+
+      def visit_em(node)
+        @out << '<em>'
+        node.children_accept(self)
+        @out << '</em>'
+      end
+
+      def visit_code(node)
+        @out << '<code>'
+        node.children_accept(self)
+        @out << '</code>'
+      end
+
+      def visit_text(node)
+        @out << escape(node.value.to_s)
+      end
+
+      #
+      def escape(text)
+        return text.gsub(/&/, '&amp;')
+                   .gsub(/</, '&lt;')
+                   .gsub(/>/, '&gt;')
+                   .gsub(/"/, '&quot;')
+      end
+
+      def visit_linebreak(node)
+        @out << "<br>\n" + indent
+        node.children_accept(self)
+      end
+
+      def escape_url(text)
+        text.gsub(/ /, '%20')
+            .gsub(/"/, '%22')
+            .gsub(/`/, '%60')
+            .gsub(/</, '%3C')
+            .gsub(/>/, '%3E')
+            .gsub(/\[/, '%5B')
+            .gsub(/\]/, '%5D')
+            .gsub(/\\/, '%5C')
+      end
+
+      def indent
+        repeat = @level * 2
+        str = StringIO.new
+        repeat.times {
+          str << ' '
+        }
+        str.string
+      end
+
+      def output
+        if(!partial)
+          wrapper = "<!DOCTYPE html>\n";
+          wrapper << "<html>\n";
+          wrapper << "  <body>\n";
+          wrapper << @out.string.strip.gsub(/^/, "    ") + "\n";
+          wrapper << "  </body>\n";
+          wrapper << "</html>\n";
+          return wrapper;
+        end
+        @out.string.strip
+      end
+
+    end
+  end
+end