smarky 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 498ca46d8878825f6416da7310e082abbbac9d8b
+  data.tar.gz: fa44aac8e0ec3ce1abc7ea3cfafbfd4a9249a467
+SHA512:
+  metadata.gz: 5954494b1daa014a2d97df8f96cd279d1fbe021d12179f76c9576928a59b82f1c6ac3814660a0e3a496bac112f098dcee593cbc32607a347362032c6fcad63f0
+  data.tar.gz: cd208436b638fff4d9689debc1c4c66856fa1fa82a139440acd56e6276169ffd512554193c7ef4b6fe993368bc81398905fb6831b2559bc3fd430eb05d7f2ece

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Tao
+
+MIT License
+
+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,76 @@
+Smarky
+======
+
+Smarky takes [Markdown](http://daringfireball.net/projects/markdown/) and turns it into **structured** (as opposed to *flat*) HTML.
+
+This is easier to show than to explain. Say we have this Markdown:
+
+```markdown
+# The Trial
+
+## Chapter 1
+
+Someone must have been telling lies about Josef K. [...]
+
+## Chapter 2
+
+K. was informed by telephone [...]
+```
+
+Traditional Markdown renderers will translate this to the following HTML:
+
+```html
+<h1>The Trial</h1>
+<h2>Chapter 1</h2>
+<p>Someone must have been telling lies about Joseph K. [...]</p>
+<h2>Chapter 2</h2>
+<p>K. was informed by telephone [...]</p>
+```
+
+This is *flat*. Smarky will produce this instead:
+
+```html
+<article>
+  <h1>The Trial</h1>
+  <section>
+    <h2>Chapter 1</h2>
+    <p>Someone must have been telling lies about Joseph K. [...]</p>
+  </section>
+  <section>
+    <h2>Chapter 2</h2>
+    <p>K. was informed by telephone [...]</p>
+  </section>
+</article>
+```
+
+Usage
+-----
+
+```ruby
+article = Smarky.parse('This is some *sweet* Markdown.')
+# => a Smarky::Element representing the top-level <article>
+
+article.children
+# => an array of Smarky::Element objects (w/ #to_html and #inner_html methods)
+
+article.sections
+# => an array of just the child sections (useful for, e.g., a table of contents)
+
+article.to_html
+# => the structured HTML
+```
+
+Choosing a Markdown renderer
+----------------------------
+
+Smarky lets you pick which Markdown renderer you want to use. Right now you have three options:
+
+- [Redcarpet](https://github.com/vmg/redcarpet)
+- [Maruku](https://github.com/bhollis/maruku)
+- [Kramdown](https://github.com/gettalong/kramdown)
+
+To specify a renderer, pass an options hash with `:markdown_renderer` to `Smarky.parse`:
+
+    Smarky.parse(markdown, :markdown_renderer => :kramdown)
+
+Obviously, you'll need the appropriate gem installed in order to use it (Smarky doesn't eagerly specify a dependency on any of them). The default is currently Redcarpet.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run specs w/ RSpec"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--format=n --color"
+end
+
+task :default => :spec

data/lib/smarky.rb

@@ -0,0 +1,77 @@
+require 'smarky/element'
+require 'smarky/version'
+require 'nokogiri'
+
+module Smarky
+  def self.parse(markdown, options={})
+    html     = self.markdown_renderer(options).render(markdown)
+    fragment = Nokogiri::HTML.fragment(html)
+
+    article  = Element.new('article')
+    section  = article
+    current_level = nil
+
+    fragment.children.each do |node|
+      if (heading = node.name.match(/^h(\d)$/i))
+        new_section = Element.new('section', heading[0])
+        new_section.add_child(Element.new(node))
+
+        level = heading[1].to_i
+        if current_level.nil? || level > current_level
+          difference = level - (current_level || 1)
+          while difference > 1
+            wrapper_section = Element.new('section')
+            section.add_child(wrapper_section)
+            section = wrapper_section
+            difference -= 1
+          end
+
+          section.add_child(new_section)
+          section = new_section
+
+        elsif level == current_level
+          section.add_next_sibling(new_section)
+          section = new_section
+
+        else
+          difference = current_level - level
+          while difference > 0
+            section = section.parent
+            difference -= 1
+          end
+
+          section.add_next_sibling(new_section)
+          section = new_section
+        end
+
+        current_level = level
+
+      else
+        section.add_child(Element.new(node))
+      end
+    end
+
+    article
+  end
+
+  def self.markdown_renderer(options={})
+    case options[:markdown_renderer]
+    when :redcarpet
+      require 'smarky/markdown/redcarpet'
+      Smarky::Markdown::Redcarpet.new
+
+    when :maruku
+      require 'smarky/markdown/maruku'
+      Smarky::Markdown::Maruku.new
+
+    when :kramdown
+      require 'smarky/markdown/kramdown'
+      Smarky::Markdown::Kramdown.new
+
+    else
+      # Default to Redcarpet
+      require 'smarky/markdown/redcarpet'
+      Smarky::Markdown::Redcarpet.new
+    end
+  end
+end

data/lib/smarky/element.rb

@@ -0,0 +1,83 @@
+module Smarky
+  class Element
+    def initialize(*args)
+      node_or_name, @title = args
+
+      case node_or_name
+      when String
+        @document = Nokogiri::HTML::Document.new
+        @node     = Nokogiri::XML::Node.new(node_or_name, @document)
+
+      else
+        @document = node_or_name.document
+        @node     = node_or_name
+      end
+    end
+
+    def title
+      @title ||= begin
+        first_child = @node.children.first
+        first_child && first_child.name =~ /^h[1-6]$/ && first_child.content
+      end
+    end
+
+    def parent
+      @parent ||= Element.new(@node.parent)
+    end
+
+    def name
+      @node.name
+    end
+
+    def content
+      @node.content
+    end
+
+    def children
+      @children ||= @node.children.map { |node| Element.new(node) }
+    end
+
+    def sections
+      @sections ||= @node.css('> section').map { |node| Element.new(node) }
+    end
+
+    def add_child(child)
+      @node.add_child(child.node)
+      dirty!
+      child
+    end
+
+    def add_next_sibling(sibling)
+      @node.add_next_sibling(sibling.node)
+      dirty!
+      sibling
+    end
+
+    def add_section
+      add_child(Element.new('section'))
+    end
+
+    def to_html
+      @node.to_html
+    end
+
+    def inner_html
+      @node.inner_html
+    end
+
+    protected
+
+    def node
+      @node
+    end
+
+    private
+
+    def dirty!
+      @title    = nil
+      @parent   = nil
+      @children = nil
+      @sections = nil
+    end
+  end
+end

data/lib/smarky/markdown/kramdown.rb

@@ -0,0 +1,11 @@
+require 'kramdown'
+
+module Smarky
+  module Markdown
+    class Kramdown
+      def render(markdown)
+        ::Kramdown::Document.new(markdown).to_html
+      end
+    end
+  end
+end

data/lib/smarky/markdown/maruku.rb

@@ -0,0 +1,11 @@
+require 'maruku'
+
+module Smarky
+  module Markdown
+    class Maruku
+      def render(markdown)
+        ::Maruku.new(markdown).to_html
+      end
+    end
+  end
+end

data/lib/smarky/markdown/redcarpet.rb

@@ -0,0 +1,15 @@
+require 'redcarpet'
+
+module Smarky
+  module Markdown
+    class Redcarpet
+      def initialize
+        @markdown = ::Redcarpet::Markdown.new(::Redcarpet::Render::HTML)
+      end
+
+      def render(markdown)
+        @markdown.render(markdown)
+      end
+    end
+  end
+end

data/lib/smarky/version.rb

@@ -0,0 +1,3 @@
+module Smarky
+  VERSION = "0.0.1"
+end

data/smarky.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smarky/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smarky"
+  spec.version       = Smarky::VERSION
+  spec.authors       = ["Dan Tao"]
+  spec.email         = ["daniel.tao@gmail.com"]
+  spec.description   = %q{Smarky creates structure from Markdown}
+  spec.summary       = %q{Smarky creates structure from Markdown}
+  spec.homepage      = "https://github.com/dtao/smarky"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "nokogiri"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "heredoc_unindent"
+  spec.add_development_dependency "kramdown"
+  spec.add_development_dependency "maruku"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "rspec"
+end

data/spec/element_spec.rb

@@ -0,0 +1,68 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Smarky::Element do
+  let(:result) { Smarky.parse(@input) }
+
+  let(:sections) { result.sections }
+
+  describe 'sections' do
+    before :each do
+      input <<-EOMARKDOWN
+        # Chapter 1
+        This is chapter 1.
+        
+        ## Chapter 1, Part 1
+        This is part 1 of chapter 1.
+        
+        ## Chapter 1, Part 2
+        This is part 2 of chapter 1.
+        
+        # Chapter 2
+        This is chapter 2.
+        
+        ## Chapter 2, Part 1
+        This is part 1 of chapter 2.
+        
+        ## Chapter 2, Part 2
+        This is part 2 of chapter 2.
+      EOMARKDOWN
+    end
+
+    it 'provides access to all of its child sections' do
+      sections.map(&:title).should == ['Chapter 1', 'Chapter 2']
+    end
+
+    it 'every section also provides access to child sections' do
+      sections.map { |s| s.sections.map(&:title) }.should == [
+        ['Chapter 1, Part 1', 'Chapter 1, Part 2'],
+        ['Chapter 2, Part 1', 'Chapter 2, Part 2']
+      ]
+    end
+  end
+
+  describe 'title' do
+    it 'is set to the content of the first header element' do
+      input <<-EOMARKDOWN
+        This is a title
+        ===============
+        
+        Content content content.
+      EOMARKDOWN
+
+      sections.first.title.should == 'This is a title'
+    end
+
+    it "doesn't have a title if its first child is not a heading" do
+      input <<-EOMARKDOWN
+        This is some content before the heading.
+        
+        This is a heading
+        =================
+        
+        This is some content after the heading.
+      EOMARKDOWN
+
+      result.title.should be_nil
+    end
+  end
+end

data/spec/smarky_spec.rb

@@ -0,0 +1,189 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Smarky do
+  let(:result) { Smarky.parse(@input, @options || {}) }
+
+  describe 'parse' do
+    def verify_result(*args)
+      expected, @options = [args.pop, args.pop]
+
+      case expected
+      when Array
+        node_to_array(result)[1..-1].should == expected
+      when String
+        result.to_html.should == expected
+      else
+        raise 'Unable to verify against a #{expected.class}.'
+      end
+    end
+
+    it 'returns a Smarky::Element wrapper around an <article>' do
+      result.should be_a(Smarky::Element)
+      result.name.should == 'article'
+    end
+
+    it 'works in the simplest case: rendering a single paragraph' do
+      input 'Why *hello* there.'
+      verify_result '<article><p>Why <em>hello</em> there.</p></article>'
+    end
+
+    it 'uses RedCarpet for rendering Markdown by default' do
+      input <<-EOMARKDOWN
+        This should look weird.
+        {: .weird }
+      EOMARKDOWN
+      verify_result "<article><p>This should look weird.\n{: .weird }</p></article>"
+    end
+
+    it 'can use Maruku, if specified' do
+      input <<-EOMARKDOWN
+        This should look normal.
+        {: .normal }
+      EOMARKDOWN
+      verify_result({ :markdown_renderer => :maruku }, '<article><p class="normal">This should look normal.</p></article>')
+    end
+
+    it 'can also use Kramdown' do
+      # TODO: Test this properly.
+      input <<-EOMARKDOWN
+        This should also look normal.
+        {: .normal }
+      EOMARKDOWN
+      verify_result({ :markdown_renderer => :kramdown }, '<article><p class="normal">This should also look normal.</p></article>')
+    end
+
+    it 'renders sibling sections for progressive heading elements' do
+      input <<-EOMARKDOWN
+        Section 1
+        =========
+        
+        This is section 1.
+        
+        Section 2
+        =========
+        
+        This is section 2.
+      EOMARKDOWN
+
+      verify_result [
+        [:section,
+          [:h1, 'Section 1'],
+          [:p, 'This is section 1.']
+        ],
+        [:section,
+          [:h1, 'Section 2'],
+          [:p, 'This is section 2.']
+        ]
+      ]
+    end
+
+    it 'renders nested sections for heading elements with descending rank' do
+      input <<-EOMARKDOWN
+        Section 1
+        =========
+        
+        This is section 1.
+        
+        Section 1.1
+        -----------
+        
+        This is section 1.1.
+        
+        ### Section 1.1.1
+        
+        This is section 1.1.1.
+      EOMARKDOWN
+
+      verify_result [
+        [:section,
+          [:h1, 'Section 1'],
+          [:p, 'This is section 1.'],
+          [:section,
+            [:h2, 'Section 1.1'],
+            [:p, 'This is section 1.1.'],
+            [:section,
+              [:h3, 'Section 1.1.1'],
+              [:p, 'This is section 1.1.1.']
+            ]
+          ]
+        ]
+      ]
+    end
+
+    it 'works properly for multiple sections and subsections' do
+      input <<-EOMARKDOWN
+        Section 1
+        =========
+        
+        This is section 1.
+        
+        Section 1.1
+        -----------
+        
+        This is section 1.1.
+        
+        Section 2
+        =========
+        
+        This is section 2.
+        
+        Section 2.1
+        -----------
+        
+        This is section 2.1.
+      EOMARKDOWN
+
+      verify_result [
+        [:section,
+          [:h1, 'Section 1'],
+          [:p, 'This is section 1.'],
+          [:section,
+            [:h2, 'Section 1.1'],
+            [:p, 'This is section 1.1.']
+          ]
+        ],
+        [:section,
+          [:h1, 'Section 2'],
+          [:p, 'This is section 2.'],
+          [:section,
+            [:h2, 'Section 2.1'],
+            [:p, 'This is section 2.1.']
+          ]
+        ]
+      ]
+    end
+
+    it 'handles diving down and then jumping back up by multiple levels' do
+      input <<-EOMARKDOWN
+        # Section 1
+        
+        This is section 1.
+        
+        ### Section 1.1.1
+        
+        This is section 1.1.1.
+        
+        # Section 2
+        
+        This is section 2.
+      EOMARKDOWN
+
+      verify_result [
+        [:section,
+          [:h1, 'Section 1'],
+          [:p, 'This is section 1.'],
+          [:section,
+            [:section,
+              [:h3, 'Section 1.1.1'],
+              [:p, 'This is section 1.1.1.']
+            ]
+          ]
+        ],
+        [:section,
+          [:h1, 'Section 2'],
+          [:p, 'This is section 2.']
+        ]
+      ]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'smarky'
+require 'rspec'
+require 'heredoc_unindent'
+
+def input(markdown)
+  @input = markdown.unindent
+end
+
+def node_to_array(node)
+  array = [node.name.to_sym]
+
+  if node.children.empty?
+    array << node.content
+
+  elsif node.children.length == 1 && node.children[0].name == 'text'
+    array << node.children[0].content
+
+  else
+    node.children.each do |node|
+      array << node_to_array(node) unless node.name == 'text' && node.content =~ /^\s*$/
+    end
+  end
+
+  array
+end
+
+RSpec.configure do |config|
+  config.before :each do
+    @input = ''
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: smarky
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dan Tao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: heredoc_unindent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: maruku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Smarky creates structure from Markdown
+email:
+- daniel.tao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smarky.rb
+- lib/smarky/element.rb
+- lib/smarky/markdown/kramdown.rb
+- lib/smarky/markdown/maruku.rb
+- lib/smarky/markdown/redcarpet.rb
+- lib/smarky/version.rb
+- smarky.gemspec
+- spec/element_spec.rb
+- spec/smarky_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dtao/smarky
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Smarky creates structure from Markdown
+test_files:
+- spec/element_spec.rb
+- spec/smarky_spec.rb
+- spec/spec_helper.rb
+has_rdoc: