kramdown-tablerize 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b83c03bc46d69faff77aee6e5eab7947a4c9cf08
+  data.tar.gz: b2c3def4fcaa0fb5a18343a18fa10c0a19e9284d
+SHA512:
+  metadata.gz: f6cd7b548ad410e5270f6366029a92fea99bb39013b0dae51cf7bdbdac74cb8206236233dd5a337bc28efd70ba8c8093d1b2b4d2d99af9340bf4c95c4b5bed35
+  data.tar.gz: 077504cd4575d3e1bb7e4d0878475c74151a13937c20f0ae9f3d5f89bf8d064fed6ac972a8e281d4ff71bd07f081fa0aeae0f83077b88b1e6f10d1212c2cd0c0

data/.gitignore

@@ -0,0 +1 @@
+/kramdown-tablerize-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=documentation
+--tty

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: rspec
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 IFTTT Inc
+
+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/Makefile

@@ -0,0 +1,15 @@
+GEM_NAME := kramdown-tablerize
+
+all:
+	gem build $(GEM_NAME).gemspec
+
+install: all
+	gem install $(GEM_NAME)
+
+uninstall:
+	gem uninstall $(GEM_NAME)
+
+clean:
+	rm -fv -- $(GEM_NAME)-*.gem
+
+.PHONY: all install clean

data/README.md

@@ -0,0 +1,134 @@
+kramdown-tablerize
+==================
+
+A [kramdown] plugin to convert YAML to HTML tables inside Markdown, using
+[Tablerize].
+
+[kramdown]: http://kramdown.gettalong.org/
+[Tablerize]: https://github.com/IFTTT/tablerize
+
+
+## Usage
+
+To install:
+
+```shell
+cd kramdown-tablerize
+make install
+# or (soon)
+gem install kramdown-tablerize
+```
+
+Then, in Ruby...
+
+```ruby
+require 'kramdown-tablerize'
+
+Kramdown::Document.new(content, input: 'KramdownYamlTablerize').to_html
+```
+
+...and in Markdown
+
+```markdown
+## Surveillance conducted pursuant to Titles I, III, IV and VII of FISA
+
+--- table ---
+
+    class: [statistics-table, nsa-surveillance-details]
+
+    cols:
+    - name: authority
+    - name: num_orders
+    - name: num_targets
+
+    data:
+    - class: table-header
+      authority: Legal Authority
+      num_orders: Annual Number of Orders
+      num_targets: Estimated Number of Targets Affected
+    - authority: |
+                  __FISA Orders__
+                  Based on probable cause
+                  (Title I and III of FISA, Sections 703 and 704 of FISA)
+      num_orders: "1,167 orders"
+      num_targets: "1,144"
+    - authority: |
+                  __Section 702__
+                  of FISA
+      num_orders: "1 order"
+      num_targets: "89,138"
+    - authority: |
+                  __FISA Pen Register/Trap and Trace__
+                  (Title IV of FISA)
+      num_orders: "131 orders"
+      num_targets: "319"
+
+--- /table ---
+
+wow such surveillance
+```
+
+
+## Tips
+
+  - In YAML, leading indent doesn't matter, so you might want to indent
+    everything (as shown above) so that it renders as a code block in naive
+    Markdown implementations.
+
+  - You currently can't nest `--- table ---`…`--- /table ---` blocks
+    (the parser doesn't keep track of nesting levels). However, you can nest
+    tables within each other within the YAML itself:
+
+    ```markdown
+    --- table ---
+
+        cols:
+        - name: 1
+        - name: 2
+        data:
+        - 1: cell 1,1
+          2: cell 1,2
+        - 1: cell 2,1
+          2:
+            cols:
+            - name: a
+            - name: b
+            data:
+            - a: "wow it's"
+            - b: a nested table
+
+    --- /table ---
+    ```
+
+
+## Wish List
+
+  - Support using custom delimiters for the start and end of the YAML. Find a
+    custom delimiter that plays nicely with kramdown and markdown, i.e. one that
+    renders the best when the plugin is not enabled. It should ideally also be
+    easy for text editors to target in case anyone wants to make a syntax
+    highlighter for it (which should involve little more than marking off a
+    region of Markdown as YAML).
+
+  - Allow outputting to Markdown, for GitHub and other sites that don't allow
+    HTML in Markdown.
+
+  - Improve interactive error handling, including outputting on which line of
+    kramdown source the error occurred. Possibly also do some pre-emptive error
+    checking for less confusion down the line.
+
+  - After the delimiters are finalized, add support to syntax-highlight YAML
+    inside Markdown.
+
+
+## Credit
+
+The structure of [rfc1459/kramdown-gist] was used as a guideline for making this
+library.
+
+**kramdown-tablerize** was originally designed and written by [@szhu] at
+[@IFTTT].
+
+[rfc1459/kramdown-gist]: https://github.com/rfc1459/kramdown-gist
+[@szhu]: https://github.com/szhu
+[@IFTTT]: https://github.com/IFTTT

data/bin/kramdown-tablerize

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# Command-line interface to the kramdown-tablerize gem.
+
+if ARGV.empty?
+  $stderr.puts "usage: #{$PROGRAM_NAME} path/to/document.md [...]"
+  exit 1
+end
+
+begin
+  require_relative '../lib/kramdown-tablerize'
+rescue LoadError
+  require 'kramdown-tablerize'
+end
+
+ARGV.each do |path|
+  puts Kramdown::Document.new(File.read(path), input: 'KramdownYamlTablerize').to_html
+end

data/examples/example-1.html

@@ -0,0 +1,14 @@
+<h2 id="surveillance-conducted-pursuant-to-titles-i-iii-iv-and-vii-of-fisa">Surveillance conducted pursuant to Titles I, III, IV and VII of FISA</h2>
+
+<table class="statistics-table nsa-surveillance-details"><tbody>
+<tr class="table-header"><td class="statistics-table-authority">Legal Authority</td><td class="statistics-table-num_orders">Annual Number of Orders</td><td class="statistics-table-num_targets">Estimated Number of Targets Affected</td></tr>
+<tr><td class="statistics-table-authority"><strong>FISA Orders</strong>
+Based on probable cause
+(Title I and III of FISA, Sections 703 and 704 of FISA)</td><td class="statistics-table-num_orders">1,167 orders</td><td class="statistics-table-num_targets">1,144</td></tr>
+<tr><td class="statistics-table-authority"><strong>Section 702</strong>
+of FISA</td><td class="statistics-table-num_orders">1 order</td><td class="statistics-table-num_targets">89,138</td></tr>
+<tr><td class="statistics-table-authority"><strong>FISA Pen Register/Trap and Trace</strong>
+(Title IV of FISA)</td><td class="statistics-table-num_orders">131 orders</td><td class="statistics-table-num_targets">319</td></tr>
+</tbody></table>
+
+<p>wow such surveillance</p>

data/examples/example-1.md

@@ -0,0 +1,36 @@
+## Surveillance conducted pursuant to Titles I, III, IV and VII of FISA
+
+--- table ---
+
+    class: [statistics-table, nsa-surveillance-details]
+
+    cols:
+    - name: authority
+    - name: num_orders
+    - name: num_targets
+
+    data:
+    - class: table-header
+      authority: Legal Authority
+      num_orders: Annual Number of Orders
+      num_targets: Estimated Number of Targets Affected
+    - authority: |
+                  __FISA Orders__
+                  Based on probable cause
+                  (Title I and III of FISA, Sections 703 and 704 of FISA)
+      num_orders: "1,167 orders"
+      num_targets: "1,144"
+    - authority: |
+                  __Section 702__
+                  of FISA
+      num_orders: "1 order"
+      num_targets: "89,138"
+    - authority: |
+                  __FISA Pen Register/Trap and Trace__
+                  (Title IV of FISA)
+      num_orders: "131 orders"
+      num_targets: "319"
+
+--- /table ---
+
+wow such surveillance

data/examples/example-2.error.out

@@ -0,0 +1,17 @@
+.*
+Tablerize YAML error for the following table:
+.*
+  1 
+  2 
+  3     class: \[statistics-table, nsa-surveillance-details\]
+  4 
+\* 5     cols
+  6     - name
+  7     - num_orders
+  8     - name: num_targets
+  9 
+  10     data:
+backtrace:
+.*
+could not find expected ':' while scanning a simple key at line 5 column 5
+.*

data/examples/example-2.md

@@ -0,0 +1,36 @@
+## Surveillance conducted pursuant to Titles I, III, IV and VII of FISA
+
+--- table ---
+
+    class: [statistics-table, nsa-surveillance-details]
+
+    cols
+    - name
+    - num_orders
+    - name: num_targets
+
+    data:
+    - class: table-header
+      authority: Legal Authority
+      num_orders: Annual Number of Orders
+      num_targets: Estimated Number of Targets Affected
+    - authority: |
+                  __FISA Orders__
+                  Based on probable cause
+                  (Title I and III of FISA, Sections 703 and 704 of FISA)
+      num_orders: "1,167 orders"
+      num_targets: "1,144"
+    - authority: |
+                  __Section 702__
+                  of FISA
+      num_orders: "1 order"
+      num_targets: "89,138"
+    - authority: |
+                  __FISA Pen Register/Trap and Trace__
+                  (Title IV of FISA)
+      num_orders: "131 orders"
+      num_targets: "319"
+
+--- /table ---
+
+wow such surveillance

data/kramdown-tablerize.gemspec

@@ -0,0 +1,23 @@
+require './lib/kramdown-tablerize/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'kramdown-tablerize'
+  gem.summary       = 'Convert YAML to HTML tables in kramdown.'
+  gem.description   = <<-END
+      This kramdown plugin uses Tablerize to convert YAML tables in Markdown
+      to HTML.
+    END
+
+  gem.version       = Tablerize::Plugin::Kramdown::VERSION
+
+  gem.homepage      = 'https://github.com/IFTTT/kramdown-tablerize'
+  gem.authors       = ['Sean Zhu']
+  gem.email         = 'opensource+tablerize@szhu.me'
+  gem.license       = 'MIT'
+
+  gem.add_dependency 'kramdown', '~> 1.2', '>= 1.2.0'
+  gem.add_dependency 'tablerize', '~> 1.0', '>= 1.0.0'
+  gem.executables   = ['kramdown-tablerize']
+  gem.files         = `git ls-files`.split
+  gem.require_paths = ['lib']
+end

data/lib/kramdown-tablerize/kramdown.rb

@@ -0,0 +1,56 @@
+require_relative 'tablerize'
+
+require 'kramdown'
+
+module Kramdown
+  # Register :yaml_tablerize as a block-level element
+  # @private
+  class Element
+    # Register :yaml_tablerize as a block-level element
+    CATEGORY[:yaml_tablerize] = :block
+  end
+
+  module Converter
+    class Html
+      # Convert :yaml_tablerize -> HTML
+      # @api private
+      def convert_yaml_tablerize(el, _indent)
+        Tablerize::Plugin::Kramdown.convert_yaml_tablerize_to_html(el.value)
+      end
+    end
+
+    class Kramdown
+      # Convert :yaml_tablerize -> Markdown (not implemented)
+      def convert_yaml_tablerize(_el, _opts)
+        raise NotImplementedError
+      end
+    end
+
+    class Latex
+      # Convert :yaml_tablerize -> LaTEX (not implemented)
+      def convert_yaml_tablerize(_el, _opts)
+        raise NotImplementedError
+      end
+    end
+  end
+
+  module Parser
+    class KramdownYamlTablerize < ::Kramdown::Parser::Kramdown
+      YAML_TABLE_PATTERN = /^#{OPT_SPACE}---[ \t]*table[ \t]*---(.*?)---[ \t]*\/table[ \t]*---/m
+
+      def initialize(source, options)
+        super
+        @block_parsers.unshift(:yaml_tablerize)
+      end
+
+      # Convert Markdown -> :yaml_tablerize
+      # @api private
+      def parse_yaml_tablerize
+        @src.pos += @src.matched_size
+        @tree.children << Element.new(:yaml_tablerize, @src[1])
+      end
+
+      define_parser(:yaml_tablerize, YAML_TABLE_PATTERN)
+    end
+  end
+end

data/lib/kramdown-tablerize/tablerize.rb

@@ -0,0 +1,36 @@
+require 'tablerize'
+
+module Tablerize
+  module Plugin
+    module Kramdown
+      ERROR_CONTEXT_LINES = 5
+
+      # Prints out the 5 lines before and after the line where an error
+      # occurred. This is useful for debugging embedded YAML, as the line
+      # number where the error occurred in YAML won't be the same as where it
+      # occurred in the Markdown source.
+      def self.printable_error_context(text, target_line)
+        raw_lines = text.lines
+        start_line = [target_line - ERROR_CONTEXT_LINES, 1].max
+        end_line   = [target_line + ERROR_CONTEXT_LINES, raw_lines.length].min
+        fmt_lines = (start_line..end_line).map do |line|
+          marker = line == target_line ? '*' : ' '
+          "#{marker} #{line} #{raw_lines[line - 1].chomp}"
+        end
+        fmt_lines.join("\n")
+      end
+
+      def self.convert_yaml_tablerize_to_html(yaml_tablerize)
+        Tablerize.load(yaml_tablerize).to_html + "\n"
+      rescue Psych::SyntaxError => e
+        e.message.prepend [
+          "Tablerize YAML error for the following table:",
+          printable_error_context(yaml_tablerize, e.line),
+          "backtrace:",
+          ''
+        ].join("\n")
+        raise e
+      end
+    end
+  end
+end

data/lib/kramdown-tablerize/version.rb

@@ -0,0 +1,7 @@
+module Tablerize
+  module Plugin
+    module Kramdown
+      VERSION = "1.0.1"
+    end
+  end
+end

data/lib/kramdown-tablerize.rb

@@ -0,0 +1,2 @@
+require_relative 'kramdown-tablerize/version'
+require_relative 'kramdown-tablerize/kramdown'

data/spec/kramdown-tablerize_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Tablerize do
+  ['example-1'].each do |test_name|
+    context test_name do
+      reference_result = File.read "examples/#{test_name}.html"
+
+      it "should be correctly converted" do
+        test_result = Kramdown::Document.new(
+          File.read("examples/#{test_name}.md"), input: 'KramdownYamlTablerize'
+        ).to_html
+        expect(test_result.chomp).to eq(reference_result.chomp)
+      end
+    end
+  end
+
+  ['example-2'].each do |test_name|
+    context test_name do
+      reference_result = File.read "examples/#{test_name}.error.out"
+      reference_result.gsub!(/\n?\.\*\n?/, '.*')
+
+      it "should have the appropriate error output" do
+        document = Kramdown::Document.new(
+          File.read("examples/#{test_name}.md"), input: 'KramdownYamlTablerize'
+        )
+        expect { document.to_html }.to raise_error Regexp.new(reference_result, Regexp::MULTILINE)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require_relative '../lib/kramdown-tablerize'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-tablerize
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Sean Zhu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: tablerize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: |2
+        This kramdown plugin uses Tablerize to convert YAML tables in Markdown
+        to HTML.
+email: opensource+tablerize@szhu.me
+executables:
+- kramdown-tablerize
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- LICENSE
+- Makefile
+- README.md
+- bin/kramdown-tablerize
+- examples/example-1.html
+- examples/example-1.md
+- examples/example-2.error.out
+- examples/example-2.md
+- kramdown-tablerize.gemspec
+- lib/kramdown-tablerize.rb
+- lib/kramdown-tablerize/kramdown.rb
+- lib/kramdown-tablerize/tablerize.rb
+- lib/kramdown-tablerize/version.rb
+- spec/kramdown-tablerize_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/IFTTT/kramdown-tablerize
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Convert YAML to HTML tables in kramdown.
+test_files: []