markdownplus 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59b5fb6c0a410a172db5e2aeba391eac6653eaff
-  data.tar.gz: 42154e62a00f5ec65919c512ad6398be9498fc64
+  metadata.gz: b122d954d5f9a9b2fa74b04626054c7d4bb3fdd4
+  data.tar.gz: 812679f9e80a65de77281ec0d5f53b95038022cd
 SHA512:
-  metadata.gz: c25d9c37887e2d41a4a3a12796fcb19badf60a4615c0e437c3ad2f5d1d0db6710a55b94f524c2fe76494d8c062180290c752309a374f9135c7bf8749724b575b
-  data.tar.gz: 97334f94d603ac07051958b58a074703a798485943f9a5b1dccc556517c02eb3301d3c7addf5405040e44c3b1be45353cd7b1af0dd4c36dd47fed65e03163a6b
+  metadata.gz: 6506836776c5df3516be8187fe47441a0f0170133596b498d72ccf8046f0106ee49d1722631a52c84ec0db6a7ac98b8b20b75b1d04116c0ce3ba00d292bf893f
+  data.tar.gz: 6977a66ef13badcee4bf28594346313c66b0d01c8f516daabed6b718d7a8382fcb587546d1366b6bf2fd3330f55bdedf1d22da0f73d1f3307dfbc01efb538d36

data/README.md

@@ -1,6 +1,141 @@
 # Markdownplus
 
-Coming soon. This is a prerelease gem.
+Markdownplus extends [Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/) by bringing programmatic features to the language portion of the fenced code blocks. A Markdownplus document can be transformed into a valid Markdown document, or taken all the way to html.
+
+## Usage
+
+### Syntax
+
+Markdownplus files look like normal [Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/) files. However, the fenced code blocks have most functionality. You can still use 
+
+```markdown
+  ```ruby
+```
+
+or
+
+```markdown
+  ```json
+```
+
+to add syntax hightlight, but you can also use a pipeline of functions to bring in other files, or perform more drastic formatting.
+
+For instance, you could download a json file, format it, then highlight it as usual using:
+
+```
+  ```include('https://gist.githubusercontent.com/cpetersen/c6571117df132443ac81/raw/e5ac97e8e0665a0e4014ebc85ecef214763a7729/fake.json'),pretty_json()
+```
+
+or, you could download a csv file and turn it into an html table:
+
+```
+  ```include('https://gist.githubusercontent.com/cpetersen/b5a473ddf0b796cd9502/raw/e140bdc32ff2f6a600e357c2575220c0312a88ee/fake.csv'),csv2html()
+```
+
+### Execution
+
+Given a markdown plus file, you can get the resulting Markdown using the following:
+
+```ruby
+require 'markdownplus'
+
+parser = Markdownplus::Parser.parse(File.read("kitchensink.mdp")); nil
+parser.execute; nil
+puts parser.output_markdown; nil
+```
+
+If the resulting HTML is what you're interested in, you can use ```html```:
+
+```ruby
+require 'markdownplus'
+
+parser = Markdownplus::Parser.parse(File.read("kitchensink.mdp")); nil
+parser.execute; nil
+puts parser.html; nil
+```
+
+## Function Pipeline
+
+The function pipeline is the heart of Markdownplus. 
+
+### Functions
+
+A function looks like:
+
+```
+function_name()
+function_name(symbol_parameter)
+function_name("string parameter", 'other string parameter')
+function_name(mix, 'and', match, "parameters")
+function_name(you, "may pass", nested_methods("also"))
+```
+
+The first function in the pipeline gets the contents of the fenced code block as input. For instance:
+
+```
+   ```pretty_json()
+   {"a":1,"b":2,"c":3}
+```
+
+would get `{"a":1,"b":2,"c":3}` as the input variable and produce the following:
+
+```json
+{
+  "a": 1,
+  "b": 2,
+  "c": 3
+}
+```
+
+### Pipeline
+
+You create pipeline, you string multiple functions together with a comma:
+
+```
+  ```include("some url"), csv2html()
+```
+
+In this case, the first function (include) gets the contents of the fenced code block as input. The second function (csv2html) gets the output of the first function as input.
+
+The output of the last function in the pipeline is used as the content when generating the `output_markdown` and ultimately the resulting `html`
+
+## Built in functions:
+
+### include()
+
+`include` takes a single parameter, a url. It downloads this url and outputs the result.
+
+### csv2html()
+
+`csv2html` takes no parameters, but expects valid CSV as input. It creates an HTML table from the given CSV.
+
+### pretty_json()
+
+`pretty_json` takes no parameters, but expects valid JSON as input. It formats the JSON nicely using Ruby's `JSON.pretty_generate` and outputs a fenced code block with the language specified as `json`.
+
+### set('variable_name')
+
+Stores the input in a `variable_name` for use later in the page.
+
+### get('variable_name')
+
+Outputs the content stored at a the `variable_name`.
+
+### empty()
+
+Hides the output. Often used with `set()`
+
+### raw()
+
+Output the content as raw html and skip any markdown formatting that may apply.
+
+### strip_whitespace()
+
+Strips any leading or trailing whitespace from the `input` and outputs the result.
+
+## Extendable
+
+
 
 ## Installation
 
@@ -23,7 +158,6 @@ Or install it yourself as:
 Use a fenced code block:
 
 ```markdown
-  ```include|csv
-  https://gist.githubusercontent.com/cpetersen/b5a473ddf0b796cd9502/raw/e140bdc32ff2f6a600e357c2575220c0312a88ee/fake.csv
+  ```include('https://gist.githubusercontent.com/cpetersen/b5a473ddf0b796cd9502/raw/e140bdc32ff2f6a600e357c2575220c0312a88ee/fake.csv'),csv()
   ```
 ```

data/lib/markdownplus.rb

@@ -1,5 +1,10 @@
 require "markdownplus/version"
+require "markdownplus/github_renderer"
 require "markdownplus/parser"
+require "markdownplus/literals"
+require "markdownplus/directive_parser"
+require "markdownplus/handler_registry"
+require "markdownplus/handler"
 
 module Markdownplus
   # Your code goes here...

data/lib/markdownplus/directive_parser.rb

@@ -0,0 +1,17 @@
+require 'treetop'
+
+module Markdownplus
+  class DirectiveParser
+    def self.parse(data)
+      Treetop.load(File.expand_path("../directives", __FILE__))
+      @@parser ||= TransformationParser.new
+      tree = @@parser.parse(data)
+      # If the AST is nil then there was an error during parsing
+      # we need to report a simple error message to help the user
+      raise "Parse error at offset: #{@@parser.index}" if(tree.nil?)
+
+      return tree
+    end
+  end
+end
+

data/lib/markdownplus/directives.treetop

@@ -0,0 +1,33 @@
+grammar Transformation
+  rule transformations
+    ( function / "" ) (',' function)*  <Markdownplus::Literals::TransformationLiteral>
+  end
+
+  rule expression
+    ( function / single_quote_string / double_quote_string / symbol / "" ) (',' expression)*  <Markdownplus::Literals::ExpressionLiteral>
+  end
+
+  rule function
+    symbol parameters <Markdownplus::Literals::FunctionLiteral>
+  end
+
+  rule parameters
+    "(" expression ")" <Markdownplus::Literals::ParensLiteral>
+  end
+
+  rule single_quote_string
+     space? "'" [a-zA-Z0-9\-_@ \t:\/\.]+ "'" space? <Markdownplus::Literals::StringLiteral>
+  end
+
+  rule double_quote_string
+     space? '"' [a-zA-Z0-9\-_@ \t:\/\.]+ '"' space? <Markdownplus::Literals::StringLiteral>
+  end
+
+  rule symbol
+     space? [a-zA-Z0-9\-_]+ space? <Markdownplus::Literals::SymbolLiteral>
+  end
+
+  rule space
+    [\s]+
+  end
+end

data/lib/markdownplus/github_renderer.rb

@@ -0,0 +1,19 @@
+require 'pygments'
+require 'redcarpet'
+
+module Markdownplus
+  class GithubRenderer < Redcarpet::Render::HTML
+    # alias_method :existing_block_code, :block_code
+    def block_code(code, language)
+      if language == "raw"
+        code
+      else
+        begin
+          Pygments.highlight(code, lexer: language)
+        rescue
+          "<pre><code>#{code}</code></pre>"
+        end
+      end
+    end
+  end
+end

data/lib/markdownplus/handler.rb

@@ -0,0 +1,120 @@
+module Markdownplus
+  class Handler
+    def execute(input, parameters)
+    end
+  end
+
+  class IncludeHandler < Handler
+    def execute(input, parameters, variables, warnings, errors)
+      output = nil
+      warnings << "Include handler ignores input" if(input!=nil && !input.strip.empty?)
+      if parameters==nil
+        errors << "No url given"
+      elsif parameters.count == 0
+        errors << "No url given"
+      else
+        begin
+          output = IncludeHandler.cached(parameters.first.to_s)
+        rescue => e
+          errors << "Error opening [#{parameters.first}] [#{e.message}]"
+        end
+      end
+      output
+    end
+
+    @@cache = {}
+    def self.cached(url)
+      return @@cache[url] if @@cache[url]
+      @@cache[url] = open(url).read
+      @@cache[url]
+    end
+  end
+  HandlerRegistry.register("include", IncludeHandler)
+
+  class Csv2HtmlHandler < Handler
+    def execute(input, parameters, variables, warnings, errors)
+      output = "<table class='table table-striped'>"
+      row_num = 0
+      CSV.parse(input) do |row|
+        if row_num == 0
+          output += "<thead><tr>#{row.collect { |c| "<th>#{c}</th>"}.join}</tr></thead>\n<tbody>\n"
+        else
+          output += "<tr>#{row.collect { |c| "<td>#{c}</td>"}.join}</tr>\n"
+        end
+        row_num += 1
+      end
+      output += "</tbody></table>"
+      output
+    end
+  end
+  HandlerRegistry.register("csv2html", Csv2HtmlHandler)
+
+  class PrettyJsonHandler < Handler
+    def execute(input, parameters, variables, warnings, errors)
+      begin
+        obj = JSON.parse(input)
+        output = JSON.pretty_generate(obj)
+      rescue => e
+        output = input
+        errors << "Invalid json"
+      end
+      "```json\n#{output}\n```"
+    end
+  end
+  HandlerRegistry.register("pretty_json", PrettyJsonHandler)
+
+  class StripWhitespaceHandler < Handler
+    def execute(input, parameters, variables, warnings, errors)
+      input.gsub(/\s*\n\s*/,"\n")
+    end
+  end
+  HandlerRegistry.register("strip_whitespace", StripWhitespaceHandler)
+
+  class RawHandler < Handler
+    def execute(input, parameters, variables, warnings, errors)
+      "```raw\n#{input}\n```"
+    end
+  end
+  HandlerRegistry.register("raw", RawHandler)
+
+  class EmptyHandler < Handler
+    def execute(input, parameters, variables, warnings, errors)
+      ""
+    end
+  end
+  HandlerRegistry.register("empty", EmptyHandler)
+
+  ### START VARIABLES ###
+  class SetHandler < Handler
+    def execute(input, parameters, variables, warnings, errors)
+      if parameters==nil
+        errors << "No variable name given"
+      elsif parameters.count == 0
+        errors << "No variable name given"
+      else
+        warnings << "More than one variable name given [#{parameters.inspect}]" if parameters.count > 1
+        variables[parameters.first.to_s] = input
+      end
+      input
+    end
+  end
+
+  class GetHandler < Handler
+    def execute(input, parameters, variables, warnings, errors)
+      output = input
+      if parameters==nil
+        errors << "No variable name given"
+      elsif parameters.count == 0
+        errors << "No variable name given"
+      else
+        warnings << "More than one variable name given [#{parameters.inspect}]" if parameters.count > 1
+        output = variables[parameters.first.to_s]
+      end
+      output
+    end
+  end
+
+  HandlerRegistry.register("set", SetHandler)
+  HandlerRegistry.register("get", GetHandler)
+  #### END VARIABLES ####
+end

data/lib/markdownplus/handler_registry.rb

@@ -0,0 +1,17 @@
+module Markdownplus
+  class HandlerRegistry
+    @@registry = {}
+
+    def self.handler_instance(name)
+      handler_class(name).new if handler_class(name)
+    end
+
+    def self.handler_class(name)
+      @@registry[name]
+    end
+
+    def self.register(name, handler)
+      @@registry[name] = handler
+    end
+  end
+end

data/lib/markdownplus/literals.rb

@@ -0,0 +1,101 @@
+require 'treetop'
+
+module Markdownplus
+  module Literals
+    class ExpressionLiteral < Treetop::Runtime::SyntaxNode
+      def functions
+        _functions(self.elements).flatten.compact
+      end
+
+      def _functions(elements)
+        return unless elements
+        results = elements.select { |e| e.class==Markdownplus::Literals::FunctionLiteral }
+        elements.each do |element|
+          if [Treetop::Runtime::SyntaxNode, Markdownplus::Literals::ExpressionLiteral, Markdownplus::Literals::TransformationLiteral].include?(element.class)
+            results << _functions(element.elements)
+          end
+        end
+        results
+      end
+      def symbols
+        self.elements.select { |e| e.class==SymbolLiteral }
+      end
+      def parens
+        self.elements.select { |e| e.class==ParensLiteral }
+      end
+    end
+
+    class TransformationLiteral < ExpressionLiteral
+      #Specific subclass, the root should only match this
+    end
+
+    class FunctionLiteral < ExpressionLiteral
+      def function_name
+        self.symbols[0].text_value.strip
+      end
+
+      def function_parameters
+        self.parens.first.function_parameters
+      end
+
+      def function_parameter_values(input, variables, warnings, errors)
+        self.parens.first.function_parameters.collect { |fp| fp.value(input, variables, warnings, errors) }
+      end
+
+      def execute(input, variables, warnings, errors)
+        handler = HandlerRegistry.handler_instance(self.function_name)
+        if handler
+          output = handler.execute(input, self.function_parameter_values(nil, variables, warnings, errors), variables, warnings, errors)
+        else
+          errors << "No handler defined for [#{self.function_name}]"
+        end
+        output
+      end
+
+      def value(input, variables, warnings, errors)
+        execute(input, variables, warnings, errors)
+      end
+
+    end
+
+    class ParensLiteral < ExpressionLiteral
+      def function_parameters
+        self.find_parameters(self.elements)
+      end
+
+      def find_parameters(elements, params=[])
+        return params unless elements
+        elements.each do |element|
+          if [StringLiteral, SymbolLiteral, FunctionLiteral].include?(element.class)
+            params << element 
+          else
+            find_parameters(element.elements, params)
+          end
+        end
+        return params
+      end
+    end
+
+    class StringLiteral < ExpressionLiteral
+      def to_s
+        v = self.text_value.strip
+        v[1..v.length-2]
+      end
+
+      def value(input, variables, warnings, errors)
+        to_s
+      end
+    end
+
+    class SymbolLiteral < ExpressionLiteral
+      def to_s
+        self.text_value.strip
+      end
+
+      def value(input, variables, warnings, errors)
+        to_s
+      end
+    end
+  end
+end
+