koara 0.9.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bba89278b2604ce234d22609f49a0d6814524527
-  data.tar.gz: e719bf6bba3af0decbd8f1035ec01dc0fd434bcf
+  metadata.gz: fc7029d454ab5f3cd266894cc965ec575751d685
+  data.tar.gz: 0af2a51f42a06a469092d3a854059c5d0f1fdb0b
 SHA512:
-  metadata.gz: d26cbe40a7e74f5345e2c15965a12d2c3ea5206e3ce5027628ad123bb5ff7792a8c33e54c91160762b4dd9fd75b4a16e44cf7ad012b1de2bc404c6e9a6215a2f
-  data.tar.gz: 32a13742f23bf5d452411575242d697348d0eff0933a0e9d43bafaa69c1a67a025e64f221a2f66ce7b548cda71485f6f85f1dddcd9bc93a8c17308132dfa3152
+  metadata.gz: 1dd105c745b2370d83042539a2504ae50840782f8ea5a587ad3d2192b64960e7bd461ba2889eecc9bf9b6028d96d5c9fdb9471bf4d19e4d333928a260335c124
+  data.tar.gz: ec73b2f2047e1944cfb9a8c63dea64206f13657035e305e451c79560db98f65da9c42eef3cbc292b6b96884357e16e57b58d9a4c623c53ecf355e164392c5090

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,38 @@
+[![Koara](http://www.koara.io/logo.png)](http://www.koara.io)
+
+[![Build Status](https://img.shields.io/travis/koara/koara-rb.svg)](https://travis-ci.org/koara/koara-rb)
+[![Coverage Status](https://img.shields.io/coveralls/koara/koara-rb.svg)](https://coveralls.io/github/koara/koara-rb?branch=master)
+[![Gem](https://img.shields.io/gem/v/koara.svg?maxAge=2592000)](https://rubygems.org/gems/koara)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/koara/koara-rb/blob/master/LICENSE)
+
+# Koara-rb
+[Koara](http://www.koara.io) is a modular lightweight markup language. This project is the core koara parser written in Ruby.
+If you are interested in converting koara to a specific outputFormat, please look the [Related Projects](#related-projects) section.
+
+## Getting started
+- Gem
+
+  ```bash
+  gem install koara
+  ```
+
+## Usage
+```ruby
+require 'koara'
+
+parser = Koara::Parser.new
+result1 = parser.parse('Hello World!') # parse a string
+```
+
+## Configuration
+You can configure the Parser:
+
+-  **parser.modules**  
+   Default:	`["paragraphs", "headings", "lists", "links", "images", "formatting", "blockquotes", "code"]`
+   
+   Specify which parts of the syntax are allowed to be parsed. The rest will render as plain text.
+
+## Related Projects
+
+- [koara / koara-rb-html](http://www.github.com/koara/koara-rb-html): Koara to Html renderer written in Ruby
+- [koara / koara-rb-xml](http://www.github.com/koara/koara-rb-html): Koara to Xml renderer written in Ruby

data/lib/koara.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'koara/charstream'
 require 'koara/koararenderer'
 require 'koara/parser'
@@ -5,3 +6,7 @@ require 'koara/ast/document'
 require 'koara/io/stringreader'
 require 'koara/io/filereader'
 require 'koara/token_manager'
+
+module Koara
+
+end

data/lib/koara/ast/blockelement.rb

@@ -1,40 +1,45 @@
+# encoding: utf-8
 require_relative 'node'
 
-class BlockElement < Node
-  
-  def has_children
-    self.children && self.children.length > 0
-  end
-  
-  def is_first_child
-    parent.children[0] == self
-  end
-  
-  def is_last_child
-    parent.children.last == self
-  end
-  
-  def nested
-    !parent.instance_of? Document
-  end
-  
-  def is_single_child
-    parent.children.length == 1
-  end
-  
-  def next
-    i = 0
-    while (i < parent.children.length - 1)
-      if(parent.children[i] == self)
-        return parent.children[i + 1]
+module Koara
+  module Ast
+    class BlockElement < Node
+
+      def has_children
+        self.children && self.children.length > 0
+      end
+
+      def is_first_child
+        parent.children[0] == self
+      end
+
+      def is_last_child
+        parent.children.last == self
       end
-      i+=1
+
+      def nested
+        !parent.instance_of? Document
+      end
+
+      def is_single_child
+        parent.children.length == 1
+      end
+
+      def next
+        i = 0
+        while (i < parent.children.length - 1)
+          if (parent.children[i] == self)
+            return parent.children[i + 1]
+          end
+          i+=1
+        end
+        return nil
+      end
+
+      def accept(renderer)
+        renderer.visit_block_element(self)
+      end
+
     end
-    return nil
-  end
-  
-  def accept(renderer)
-    renderer.visit_block_element(self)
   end
-  
 end

data/lib/koara/ast/blockquote.rb

@@ -1,7 +1,12 @@
+# encoding: utf-8
 require_relative 'blockelement'
 
-class BlockQuote < BlockElement
-  def accept(renderer)
-    renderer.visit_blockquote(self)
+module Koara
+  module Ast
+    class BlockQuote < BlockElement
+      def accept(renderer)
+        renderer.visit_blockquote(self)
+      end
+    end
   end
-end
+end

data/lib/koara/ast/code.rb

@@ -1,7 +1,12 @@
+# encoding: utf-8
 require_relative 'node'
 
-class Code < Node
-  def accept(renderer)
-    renderer.visit_code(self)
+module Koara
+  module Ast
+    class Code < Node
+      def accept(renderer)
+        renderer.visit_code(self)
+      end
+    end
   end
-end
+end

data/lib/koara/ast/codeblock.rb

@@ -1,9 +1,14 @@
+# encoding: utf-8
 require_relative 'blockelement'
 
-class CodeBlock < BlockElement
-  attr_accessor :language
-  
-  def accept(renderer)
-      renderer.visit_codeblock(self)
+module Koara
+  module Ast
+    class CodeBlock < BlockElement
+      attr_accessor :language
+
+      def accept(renderer)
+        renderer.visit_codeblock(self)
+      end
+    end
   end
-end
+end

data/lib/koara/ast/document.rb

@@ -1,8 +1,12 @@
+# encoding: utf-8
 require_relative 'node'
 
-class Document < Node
-  def accept(renderer)
-    renderer.visit_document(self)
+module Koara
+  module Ast
+    class Document < Node
+      def accept(renderer)
+        renderer.visit_document(self)
+      end
+    end
   end
-
 end

data/lib/koara/ast/em.rb

@@ -1,7 +1,12 @@
+# encoding: utf-8
 require_relative 'node'
 
-class Em < Node
-  def accept(renderer)
-    renderer.visit_em(self)
+module Koara
+  module Ast
+    class Em < Node
+      def accept(renderer)
+        renderer.visit_em(self)
+      end
+    end
   end
-end
+end

data/lib/koara/ast/heading.rb

@@ -1,8 +1,12 @@
-require_relative 'heading'
+# encoding: utf-8
+require 'koara/ast/blockelement'
 
-class Heading < BlockElement
-  def accept(renderer)
-    renderer.visit_heading(self)
+module Koara
+  module Ast
+    class Heading < BlockElement
+      def accept(renderer)
+        renderer.visit_heading(self)
+      end
+    end
   end
-
 end