smarky 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d899ab9c2c49e0e1ef563a405a33f34ceea8f679
-  data.tar.gz: 517a6dcf52a81fdc4bdd56cc4f49150fe512c872
+  metadata.gz: fa9f31c6225a86adf76e593a27e76edabcd516ee
+  data.tar.gz: e99740f11285229385a36a7e9f9a096e9ab68865
 SHA512:
-  metadata.gz: 23932ef26b235379ba126df3e93e7b20cae2769cc1916a1472b7a83f358a158c5445ecb83bd05c37b23a5c0e7c4f37147ce07095944e4aa36676605fa47bd2ee
-  data.tar.gz: 19c27661e90205aa476c0ffa889e833e2628a7f471466c05d9d18c0b3e859a32a133811669fbf6b09e9b2c2b84d85330fbf94767b74e6ce6f12a07889a674813
+  metadata.gz: a21a8033ed7410766a7c1b7e10f3b53a5548a71cdc9b7514a770c4918332fc15011ebe093edbb9d5f8ab479ae6bc9348e53c17aeb09f555ff01977454d6fc7d0
+  data.tar.gz: e290a87f88a69bd672aaac30968053d55f2819896ac31bad146b5004545d4ac70e8a91022a37ee6c0f85d9b2d05e3d049159a65d72e2633d2bc93b2c8f4948be

data/README.md

@@ -30,13 +30,13 @@ Traditional Markdown renderers will translate this to the following HTML:
 This is *flat*. Smarky will produce this instead:
 
 ```html
-<article>
+<article id="the-trial">
   <h1>The Trial</h1>
-  <section>
+  <section id="chapter-1">
     <h2>Chapter 1</h2>
     <p>Someone must have been telling lies about Joseph K. [...]</p>
   </section>
-  <section>
+  <section id="chapter-2">
     <h2>Chapter 2</h2>
     <p>K. was informed by telephone [...]</p>
   </section>

data/bin/smarky

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'redcarpet'
+require 'smarky'
+
+input_file = ARGV[0] || 'index.md'
+if !File.exist?(input_file)
+  puts "Usage: smarky [input file path] [output file path]"
+  exit
+end
+
+output_file = ARGV[1] || File.basename(input_file, '.*') + '.html'
+
+document = Smarky.parse(File.read(input_file))
+
+File.open(output_file, 'w') do |f|
+  # Hacky way of getting nicely indented HTML:
+  # http://stackoverflow.com/questions/1898829/how-do-i-pretty-print-html-with-nokogiri
+  # This might be a huge mistake.
+  f.write(Nokogiri::XML(document.to_html, &:noblanks).to_xhtml(:indent => 4))
+end

data/lib/smarky.rb

@@ -54,6 +54,13 @@ module Smarky
       end
     end
 
+    # Special case: when an <article> contains exactly one <section> and nothing more.
+    if article.children.length == 1 && article.sections.length == 1
+      only_section = article.sections.first
+      only_section.name = 'article'
+      return only_section
+    end
+
     article
   end
 
@@ -72,9 +79,22 @@ module Smarky
       Smarky::Markdown::Kramdown.new
 
     else
-      # Default to Redcarpet
-      require 'smarky/markdown/redcarpet'
-      Smarky::Markdown::Redcarpet.new
+      # Just use whatever's available.
+      if defined?(::Redcarpet)
+        require 'smarky/markdown/redcarpet'
+        Smarky::Markdown::Redcarpet.new
+
+      elsif defined?(::Kramdown)
+      require 'smarky/markdown/kramdown'
+        Smarky::Markdown::Kramdown.new
+
+      elsif defined?(::Maruku)
+      require 'smarky/markdown/maruku'
+        Smarky::Markdown::Maruku.new
+
+      else
+        raise "Smarky currently requires Redcarpet, Kramdown, or Maruku!"
+      end
     end
   end
 end

data/lib/smarky/element.rb

@@ -29,6 +29,10 @@ module Smarky
       @node.name
     end
 
+    def name=(value)
+      @node.name = value
+    end
+
     def attributes
       @node.attributes
     end

data/lib/smarky/version.rb

@@ -1,3 +1,3 @@
 module Smarky
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/element_spec.rb

@@ -49,7 +49,7 @@ describe Smarky::Element do
         Content content content.
       EOMARKDOWN
 
-      sections.first.title.should == 'This is a title'
+      result.title.should == 'This is a title'
     end
 
     it "doesn't have a title if its first child is not a heading" do

data/spec/smarky_spec.rb

@@ -81,9 +81,30 @@ describe Smarky do
       input <<-EOMARKDOWN
         Section 1
         =========
+        
+        Section 2
+        =========
+      EOMARKDOWN
+
+      # TODO: This is fragile :( Make it not!
+      verify_result '<article>' +
+        '<section id="section-1"><h1>Section 1</h1>' + "\n\n" + '</section>' +
+        '<section id="section-2"><h1>Section 2</h1></section>' +
+        '</article>'
+    end
+
+    it 'adds content directly to the root article if there is only one top-level section' do
+      input <<-EOMARKDOWN
+        Article
+        =======
+        
+        This is some content.
       EOMARKDOWN
 
-      verify_result '<article><section id="section-1"><h1>Section 1</h1></section></article>'
+      verify_result [
+        [:h1, 'Article'],
+        [:p, 'This is some content.']
+      ]
     end
 
     it 'renders nested sections for heading elements with descending rank' do
@@ -104,16 +125,14 @@ describe Smarky do
       EOMARKDOWN
 
       verify_result [
+        [:h1, 'Section 1'],
+        [:p, 'This is section 1.'],
         [:section,
-          [:h1, 'Section 1'],
-          [:p, 'This is section 1.'],
+          [:h2, 'Section 1.1'],
+          [:p, 'This is section 1.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.']
-            ]
+            [:h3, 'Section 1.1.1'],
+            [:p, 'This is section 1.1.1.']
           ]
         ]
       ]

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require 'redcarpet'
 require 'smarky'
 require 'rspec'
 require 'heredoc_unindent'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smarky
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Dan Tao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-09 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -125,7 +125,8 @@ dependencies:
 description: Smarky creates structure from Markdown
 email:
 - daniel.tao@gmail.com
-executables: []
+executables:
+- smarky
 extensions: []
 extra_rdoc_files: []
 files:
@@ -135,6 +136,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/smarky
 - lib/smarky.rb
 - lib/smarky/element.rb
 - lib/smarky/markdown/kramdown.rb
@@ -165,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Smarky creates structure from Markdown
@@ -173,4 +175,3 @@ test_files:
 - spec/element_spec.rb
 - spec/smarky_spec.rb
 - spec/spec_helper.rb
-has_rdoc: