pfm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8ffc1441bca5b36a1f20521b68349d24e613b4c
+  data.tar.gz: af01484f2f9daf15c3ddc4f1c1045f3d865fa40b
+SHA512:
+  metadata.gz: bfeb95b7f659475b07328f4790ae2ea6cba6c69a13f68157d680ea0b144c4d2c5a9d09d1f211a23a039287e2d8be38b7f0e757c5fb85ff745c25d5db73eef0f3
+  data.tar.gz: edc5f01d8af829725d2b24ec7ec1b29fe400b3d78effb9ad7ab394338eae9954bb88b86d67d8e4f1ade69bee7924839a0ea62f9ddfb538c9faff7304cde57e91

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Panda Strike
+
+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,60 @@
+# Panda Flavored Markdown
+
+A few clever extensions to GitHub Flavored Markdown syntax.
+
+* Code block includes
+* Pandoc-style footnotes
+
+## Code Block includes
+
+    Include as a code block all of the content from another file (paths
+    relative to PWD). The code block type will be inferred from the
+    file extension when possible.
+
+    ```path/to/source.coffee```
+
+    Include only a selection of the file content:
+
+
+    ```path/to/source.coffee#L33-42```
+
+
+## Pandoc's footnote syntax
+
+This text:
+
+    Sometimes you wish to have a footnote, but GFM[^gfm] doesn't have a syntax
+    for it.  Pandoc[^pandoc] has a nice syntax as illustrated here.
+
+
+    [^gfm]:  GitHub Flavored Markdown.
+
+    [^pandoc]:  [Pandoc](http://johnmacfarlane.net/pandoc/) is the swiss-army
+    knife of document conversion tools.
+
+    The location of the footnote definitions doesn't matter, as they will be
+    collected and appended to a Notes section at the end of the document.
+
+
+Processes to this markdown:
+
+
+```markdown
+Sometimes you wish to have a footnote, but GFM<sup><a name="__gfm" href="#gfm">1</a>.</sup> doesn't have a syntax
+for it.  Pandoc<sup><a name="__pandoc" href="#pandoc">2</a>.</sup> has a nice syntax as illustrated here.
+
+
+The location of the footnote definitions doesn't matter, as they will be
+collected and appended to a Notes section at the end of the document.
+
+# Notes
+
+<a name="gfm" href="#__gfm">1 &#8617;</a>.  GitHub Flavored Markdown.
+
+<a name="pandoc" href="#__pandoc">2 &#8617;</a>.  [Pandoc](http://johnmacfarlane.net/pandoc/) is the swiss-army
+knife of document conversion tools.
+
+```
+
+
+

data/bin/pfm

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+project = File.expand_path("#{File.dirname(__FILE__)}/../")
+$LOAD_PATH.unshift "#{project}/lib"
+
+require "optparse"
+require "pfm"
+
+options = {}
+
+parser = OptionParser.new do |opts|
+
+  opts.on "-o", "--output FILE", "path to a file to write output" do |file|
+    options[:file] = file
+  end
+
+end
+
+parser.parse!
+
+input = ARGF.read
+
+output = PFM.process(input, options)
+
+if options[:file]
+  File.open options[:file], "w" do |f|
+    f.puts output
+  end
+else
+  STDOUT.puts(output)
+end
+

data/lib/pfm.rb

@@ -0,0 +1,138 @@
+
+module PFM
+
+  def self.process(string, options={})
+    lines = string.split("\n")
+    out = FootnoteProcessor.new.process(lines)
+    out = CodeBlockInclude.new.process(out)
+
+    processed = out.join("\n")
+  end
+
+  class CodeBlockInclude
+    def initialize(options={})
+      @regex = %r{^```([^\s#]+)(#L(\S+))?\s*```$}
+    end
+
+
+    def process(lines)
+      # TODO: handle URLs
+      out = []
+      lines.each do |line|
+        if md = @regex.match(line)
+          _full, source_path, badline, line_spec = md.to_a
+          if line_spec
+            start, stop = line_spec.split("-").map { |s| s.to_i}
+          else
+            start = 1
+          end
+
+          source_path = File.expand_path(source_path).strip
+          extension = File.extname(source_path).slice(1..-1)
+          out << "```#{extension}"
+
+          embed = []
+          File.open(source_path, "r") do |source|
+            source.each_line do |line|
+              embed << line
+            end
+          end
+          start -= 1
+          if stop
+            stop -=1
+          else
+            stop = embed.size - 1
+          end
+          selection = embed.slice(start..stop)
+          while selection.last =~ /^\s+$/
+            selection.pop
+          end
+          out << selection.join()
+          out << "```\n"
+        else
+          out << line
+        end
+      end
+      out
+    end
+
+  end
+
+  # Converts Pandoc-style footnotes into appropriate HTML
+  class FootnoteProcessor
+
+    def initialize(options={})
+      # looking for footnote refs like [^some_identifier]
+      @note_regex = /
+        ^
+        \[\^
+          ([\d\w\-_]+)
+        \]:
+      /x
+      @ref_regex = /
+        \[\^
+          ([\d\w\-_]+)
+        \]
+      /x
+    end
+    
+    def process(lines)
+      out = []
+      refs = []
+      notes = {}
+      ref_counter = 0
+      while line = lines.shift
+        if md = @note_regex.match(line)
+          full, identifier = md.to_a
+          note = notes[identifier] = [line]
+          while (next_line = lines.shift) && next_line !~ /^\s*$/
+            note << next_line
+          end
+
+        elsif md = @ref_regex.match(line)
+          full, identifier = md.to_a
+          ref_counter += 1
+          refs << identifier
+          out << line.sub(full, format_ref(ref_counter, identifier))
+        else
+          out << line
+        end
+      end
+
+      if refs.size > 0
+        out << ""
+        out << "# Notes"
+        out << ""
+        refs.each_with_index do |identifier, index|
+          if note = notes[identifier]
+            start = note.shift
+            anchor = format_anchor(index + 1, identifier)
+            start.sub! /^\[.*\]: /, ""
+            out << "#{anchor} #{start}"
+
+            note.each do |line|
+              out << line
+            end
+            out << ""
+          end
+        end
+      end
+      out << ""
+      out
+    end
+
+
+    def format_anchor(number, identifier)
+      %Q{<a name="#{identifier}" href="#__#{identifier}">#{number} &#8617;</a>.}
+    end
+
+    def format_ref(number, identifier)
+      %Q{
+        <sup><a name="__#{identifier}" href="##{identifier}">#{number}</a>.</sup>
+      }.strip
+    end
+  end
+
+
+end
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: pfm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew King
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: starter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: A few extensions of GitHub Flavored Markdown syntax
+email: matthew@pandastrike.com
+executables:
+- pfm
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/pfm
+- lib/pfm.rb
+homepage: https://github.com/pandastrike/pfm-rb
+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.0
+signing_key: 
+specification_version: 4
+summary: Panda Flavored Markdown
+test_files: []