kramdown-pages 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4eea036a317801cbbb5d54ddb1d2157d7d6f6493
+  data.tar.gz: 3c4cc1eddfca892482a8533d48517010b20c5c73
+SHA512:
+  metadata.gz: bbe82697663cbbe7d885aa1baac6a8b3257722e23c1fab953b340d3d35a97b50c74f7ddfb132c99211a3f9649fc64c60301d2916714ee402a1f877da06f7cdc1
+  data.tar.gz: 7efdac7823c45f8f7a6a03b332893934b95d4df9f4b746692a1ded0e4df8dc4cfef1b6890e8ec237c6c5f9120c663a3d1ebcc669917d095fd8fe4f0bd542b2a1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/vendor
+/.ruby-version

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Michael Lang
+
+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,62 @@
+kramdown-pages
+==============
+
+This gem extends the default [kramdown][] parser with a new block-level
+element which adds support for embedding Custom Page links in a Markdown document.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'kramdown-pages'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kramdown-pages
+
+
+Usage
+-----
+
+### With standalone kramdown and Rails
+
+* Ensure you have a Page model that responds to #title and Page::find_by_path, and #path where
+  * #title returns the Page title
+  * #path returns fully-qualified URL to the page
+  * Page::find_by_path returns a Page instance (or nil) given <permalink>
+
+* Pass the `input` option as shown below when initializing a new Kramdown::Document
+
+    Kramdown::Document.new(content, :input => 'KramdownPages')
+
+Syntax
+------
+
+All kramdown supported markup [syntax][] is supported.  This gem simply extends the parser to support `{page:<permalink>}` span-level element. The element
+will be replaced with an appropriate `<a href="page#path">page#title</a>` tag.
+
+`<permalink>` should be replaced with the identifier of the Page you are referencing.  The identifier can be hyphenated text, underscored text, or numerical identifier, but cannot contain spaces and special characters.  That is, it's regular expression matcher is: `[\_\-\/0-9a-zA-Z]+?`
+  
+
+Contributing
+------------
+
+1. Fork
+2. Create a topic branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+License
+-------
+
+MIT License &mdash; see `MIT-LICENSE` for more information
+
+[kramdown]: http://kramdown.rubyforge.org/
+[syntax]: http://kramdown.rubyforge.org/syntax.html

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kramdown-pages.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kramdown-pages/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "kramdown-pages"
+  gem.version       = Kramdown::Parser::PAGES_VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Michael lang"]
+  gem.email         = ["mwlang@cybrains.net"]
+  gem.description   = %q{Kramdown syntax for embedding Rails app served page links}
+  gem.summary       = %q{Extend Kramdown syntax to generate a href tags for embedded pages}
+  gem.homepage      = "https://github.com/mwlang/kramdown-pages"
+
+  gem.add_dependency('kramdown', '~> 1.6.0')
+
+  gem.add_development_dependency('yard', '~> 0.8.3')
+  gem.add_development_dependency('bundler', '>= 1.0.0')
+  gem.add_development_dependency('rspec', '~> 2.12.0')
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/kramdown-pages.rb

@@ -0,0 +1,12 @@
+require 'kramdown-pages/version'
+
+require 'kramdown'
+
+module Kramdown
+  class Element
+    CATEGORY[:page] = :block
+  end
+end
+
+require 'kramdown-pages/parser'
+require 'kramdown-pages/converter'

data/lib/kramdown-pages/converter.rb

@@ -0,0 +1,32 @@
+module Kramdown
+  module Converter
+
+    class Html
+      def convert_page(el, indent)
+        if page = Page.find_by_path(el.value)
+          %{<a href="#{page.path}">#{page.title}</a>}
+        else
+          %{<a>#{el.value}</a>}
+        end
+      end
+    end
+
+    class Kramdown
+      def convert_page(el, opts)
+        "{page:#{el.value}}"
+      end
+    end
+
+    class Latex
+      def convert_page(el, opts)
+        if page = Page.find_by_path(el.value)
+          "\\href{#{page.path}}{page.title}"
+        else
+          el.value
+        end
+      end
+
+    end
+
+  end
+end

data/lib/kramdown-pages/parser.rb

@@ -0,0 +1 @@
+require 'kramdown-pages/parser/kramdown'

data/lib/kramdown-pages/parser/kramdown.rb

@@ -0,0 +1,24 @@
+require 'kramdown/parser/kramdown'
+
+module Kramdown
+  module Parser
+
+    class KramdownPages < ::Kramdown::Parser::Kramdown
+
+      def initialize(source, options)
+        super
+        @span_parsers.unshift(:page)
+      end
+
+      def parse_page
+        @src.pos += @src.matched_size
+        permalink = @src[1]
+        @tree.children << Element.new(:page, permalink)
+      end
+
+      define_parser(:page, /\{page:([\_\-\/0-9a-zA-Z]+?)\}/)
+
+    end
+
+  end
+end

data/lib/kramdown-pages/version.rb

@@ -0,0 +1,5 @@
+module Kramdown
+  module Parser
+    PAGES_VERSION = "0.0.1"
+  end
+end

data/spec/fixtures/page.html

@@ -0,0 +1,49 @@
+<p>Search me <a href="http://google.com">Google</a>
+Welcome <a href="http://google.com">http://google.com</a> via <span id="test">test</span>.</p>
+
+<blockquote class="test">
+  <p>Red <em class="red">text</em> here!</p>
+</blockquote>
+
+<ul>
+  <li>Simple unordered list</li>
+  <li>presented here</li>
+</ul>
+
+<p>Do links within a paragaph like this, <a href="http://localhost/pages/simple-test">simple test</a> and this <a href="http://localhost/pages/parent-page/child-page">parent page/child page</a> work?</p>
+
+<p>What about <a>bogus</a> pages?</p>
+
+<h1 id="title-time">Title Time</h1>
+
+<h2 id="hot">Another <em>title</em> and more</h2>
+
+<pre><code>Code
+block
+</code></pre>
+
+<dl>
+  <dt>Here</dt>
+  <dd>What</dd>
+  <dd>Not</dd>
+</dl>
+
+<table>
+  <thead>
+    <tr>
+      <th>Uno</th>
+      <th>Dos</th>
+      <th>Tres</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>One</td>
+      <td>Two</td>
+      <td>Three</td>
+    </tr>
+  </tbody>
+</table>
+
+<p>A paragraph
+to consider</p>

data/spec/fixtures/page.md

@@ -0,0 +1,31 @@
+Search me [Google](http://google.com)
+Welcome <http://google.com> via <span id='test'>test</span>. 
+
+> Red *text*{:.red} here!
+{:.test}
+
+* Simple unordered list
+* presented here
+
+Do links within a paragaph like this, {page:simple-test} and this {page:parent-page/child-page} work?
+
+What about {page:bogus} pages?
+
+Title Time
+==================
+
+## Another *title* and more {#hot}
+
+    Code
+    block
+
+Here
+: What
+: Not
+
+| Uno | Dos | Tres |
+|----------------------------|
+| One | Two | Three |
+
+<p markdown='1'>A paragraph
+to consider</p>

data/spec/fixtures/page.tex

@@ -0,0 +1,40 @@
+Search me \href{http://google.com}{Google}
+Welcome \href{http://google.com}{http://google.com} via .
+
+\begin{quote}   %  class="test"
+Red \emph{text} here!
+\end{quote}   %  class="test"
+
+\begin{itemize}
+\item Simple unordered list
+\item presented here
+\end{itemize}
+
+Do links within a paragaph like this, \href{http://localhost/pages/simple-test}{page.title} and this \href{http://localhost/pages/parent-page/child-page}{page.title} work?
+
+What about bogus pages?
+
+\section{Title Time}\hypertarget{title-time}{}\label{title-time}
+
+\subsection{Another \emph{title} and more}\hypertarget{hot}{}\label{hot}
+
+\begin{verbatim}Code
+block
+\end{verbatim}
+
+\begin{description}
+\item[Here] What
+
+
+
+Not
+\end{description}
+
+\begin{longtable}{|l|l|l|}
+\hline
+Uno & Dos & Tres\\
+\hline
+One & Two & Three\\
+\hline
+\end{longtable}
+

data/spec/fixtures/standard.html

@@ -0,0 +1,45 @@
+<p>Search me <a href="http://google.com">Google</a>
+Welcome <a href="http://google.com">http://google.com</a> via <span id="test">test</span>.</p>
+
+<blockquote class="test">
+  <p>Red <em class="red">text</em> here!</p>
+</blockquote>
+
+<ul>
+  <li>Simple unordered list</li>
+  <li>presented here</li>
+</ul>
+
+<h1 id="title-time">Title Time</h1>
+
+<h2 id="hot">Another <em>title</em> and more</h2>
+
+<pre><code>Code
+block
+</code></pre>
+
+<dl>
+  <dt>Here</dt>
+  <dd>What</dd>
+  <dd>Not</dd>
+</dl>
+
+<table>
+  <thead>
+    <tr>
+      <th>Uno</th>
+      <th>Dos</th>
+      <th>Tres</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>One</td>
+      <td>Two</td>
+      <td>Three</td>
+    </tr>
+  </tbody>
+</table>
+
+<p>A paragraph
+to consider</p>

data/spec/fixtures/standard.md

@@ -0,0 +1,27 @@
+Search me [Google](http://google.com)
+Welcome <http://google.com> via <span id='test'>test</span>. 
+
+> Red *text*{:.red} here!
+{:.test}
+
+* Simple unordered list
+* presented here
+
+Title Time
+==================
+
+## Another *title* and more {#hot}
+
+    Code
+    block
+
+Here
+: What
+: Not
+
+| Uno | Dos | Tres |
+|----------------------------|
+| One | Two | Three |
+
+<p markdown='1'>A paragraph
+to consider</p>

data/spec/fixtures/standard.tex

@@ -0,0 +1,36 @@
+Search me \href{http://google.com}{Google}
+Welcome \href{http://google.com}{http://google.com} via .
+
+\begin{quote}   %  class="test"
+Red \emph{text} here!
+\end{quote}   %  class="test"
+
+\begin{itemize}
+\item Simple unordered list
+\item presented here
+\end{itemize}
+
+\section{Title Time}\hypertarget{title-time}{}\label{title-time}
+
+\subsection{Another \emph{title} and more}\hypertarget{hot}{}\label{hot}
+
+\begin{verbatim}Code
+block
+\end{verbatim}
+
+\begin{description}
+\item[Here] What
+
+
+
+Not
+\end{description}
+
+\begin{longtable}{|l|l|l|}
+\hline
+Uno & Dos & Tres\\
+\hline
+One & Two & Three\\
+\hline
+\end{longtable}
+

data/spec/kramdown-pages_spec.rb

@@ -0,0 +1,97 @@
+require 'kramdown-pages'
+
+describe Kramdown::Parser::KramdownPages do
+  class Page
+    attr_accessor :path, :permalink, :title
+    
+    def initialize permalink
+      @permalink = permalink
+      @path = "http://localhost/pages/#{permalink}"
+      @title = permalink.gsub("-", ' ')
+    end
+    
+    def self.find_by_path permalink
+      return nil if permalink == 'bogus'
+      Page.new permalink
+    end
+  end
+
+  def md text
+    ::Kramdown::Document.new(text,  :input => 'KramdownPages')
+  end
+  
+  def md_to_html text
+    md(text).to_html
+  end
+  
+  context "when parsing a simple block" do
+    it "converts a valid public page tag to an href tag" do
+      expect(md_to_html("{page:simple-test}")).to eq "<p><a href=\"http://localhost/pages/simple-test\">simple test</a></p>\n"
+    end
+
+    it "converts a valid child page" do
+      expect(md_to_html("{page:parent-page/child-page}")).to eq "<p><a href=\"http://localhost/pages/parent-page/child-page\">parent page/child page</a></p>\n"
+    end
+
+    it "falls back to default behaviour when the tag is malformed" do
+      expect(md_to_html("{page:garbage page}")).to eq "<p>{page:garbage page}</p>\n"
+    end
+
+    it "treats the page tag as a span-level element" do
+      expect(md_to_html("testing 123 {page:simple-test}")).to eq %{<p>testing 123 <a href="http://localhost/pages/simple-test">simple test</a></p>\n}
+      expect(md_to_html("testing 123\n{page:1234}")).to eq %{<p>testing 123\n<a href="http://localhost/pages/1234">1234</a></p>\n}
+      expect(md_to_html("testing 123\n\n{page:1234}")).to eq %{<p>testing 123</p>\n\n<p><a href="http://localhost/pages/1234">1234</a></p>\n}
+    end
+
+    it "is idempotent when generating kramdown" do
+      expect(md("{page:simple-test}").to_kramdown).to eq "{page:simple-test}\n\n"
+    end
+
+    it "renders to a suitable placeholder when generating LaTeX" do
+      expect(md("{page:simple-test}").to_latex).to eq "\\href{http://localhost/pages/simple-test}{page.title}\n\n"
+    end
+    
+    context "non-existent page" do
+      let(:content) { "{page:bogus}" }
+      
+      it "returns the text of the tag for HTML" do
+        expect(md_to_html(content)).to eq "<p><a>bogus</a></p>\n"
+      end
+      it "returns the text of the tag for LaTeX" do
+        expect(md(content).to_latex).to eq "bogus\n\n"
+      end
+    end
+  end
+
+  context "when parsing a complex document" do
+    # Standard kramdown source and rendered files
+    let(:standard_src)    { File.read(File.expand_path("../fixtures/standard.md", __FILE__)) }
+    let(:standard_html)   { File.read(File.expand_path("../fixtures/standard.html", __FILE__)) }
+    let(:standard_latex)  { File.read(File.expand_path("../fixtures/standard.tex", __FILE__)) }
+
+    # KramdownPages source and rendered files
+    let(:page_src)    { File.read(File.expand_path("../fixtures/page.md", __FILE__)) }
+    let(:page_html)   { File.read(File.expand_path("../fixtures/page.html", __FILE__)) }
+    let(:page_latex)  { File.read(File.expand_path("../fixtures/page.tex", __FILE__)) }
+
+    context "without page tags" do
+      it "produces valid HTML output" do
+        expect(md_to_html(standard_src)).to eq standard_html
+      end
+
+      it "produces valid LaTeX output" do
+        expect(md(standard_src).to_latex).to eq standard_latex
+      end
+    end
+
+    context "with page tags" do
+      it "produces valid HTML output" do
+        expect(md_to_html(page_src)).to eq page_html
+      end
+
+      it "produces valid LaTeX output" do
+        expect(md(page_src).to_latex).to eq page_latex
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-pages
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael lang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Kramdown syntax for embedding Rails app served page links
+email:
+- mwlang@cybrains.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- kramdown-pages.gemspec
+- lib/kramdown-pages.rb
+- lib/kramdown-pages/converter.rb
+- lib/kramdown-pages/parser.rb
+- lib/kramdown-pages/parser/kramdown.rb
+- lib/kramdown-pages/version.rb
+- spec/fixtures/page.html
+- spec/fixtures/page.md
+- spec/fixtures/page.tex
+- spec/fixtures/standard.html
+- spec/fixtures/standard.md
+- spec/fixtures/standard.tex
+- spec/kramdown-pages_spec.rb
+homepage: https://github.com/mwlang/kramdown-pages
+licenses: []
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Extend Kramdown syntax to generate a href tags for embedded pages
+test_files:
+- spec/fixtures/page.html
+- spec/fixtures/page.md
+- spec/fixtures/page.tex
+- spec/fixtures/standard.html
+- spec/fixtures/standard.md
+- spec/fixtures/standard.tex
+- spec/kramdown-pages_spec.rb
+has_rdoc: