smarky 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa9f31c6225a86adf76e593a27e76edabcd516ee
-  data.tar.gz: e99740f11285229385a36a7e9f9a096e9ab68865
+  metadata.gz: d05d56103e40567d3fcce54bcb24aed503602374
+  data.tar.gz: 06b7fc4c4085fedba1c436c21a6101a0bc915282
 SHA512:
-  metadata.gz: a21a8033ed7410766a7c1b7e10f3b53a5548a71cdc9b7514a770c4918332fc15011ebe093edbb9d5f8ab479ae6bc9348e53c17aeb09f555ff01977454d6fc7d0
-  data.tar.gz: e290a87f88a69bd672aaac30968053d55f2819896ac31bad146b5004545d4ac70e8a91022a37ee6c0f85d9b2d05e3d049159a65d72e2633d2bc93b2c8f4948be
+  metadata.gz: 1a921f9d2d5677922e4d519641c185843570c2829e422316facf6233143727e3fe9d70a6ba936a4d3c97c201a1b78b2675b26544a74c44c830cc203075de6cac
+  data.tar.gz: a8786f43275b7c9d91a1ff72e5467e4b66c4d91373fd4e52c1f40096d09475809bf2cc88680f17652f9d865706bd97a415a0f2ffa1c1201d1b82d36837fa5a87

data/README.md

@@ -59,6 +59,9 @@ article.sections
 article.to_html
 # => the structured HTML
 
+article.to_html(:omit_titles => true)
+# => if you want to exclude the <h1>, <h2>, etc. tags from the HTML output
+
 article.inner_html
 # => if you want to inject the HTML into an existing container
 ```

data/bin/smarky

@@ -14,8 +14,5 @@ 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))
+  document.to_html
 end

data/lib/smarky/element.rb

@@ -69,8 +69,20 @@ module Smarky
       add_child(Element.new('section'))
     end
 
-    def to_html
-      @node.to_html
+    def to_html(options={})
+      node = @node
+
+      if options[:omit_titles]
+        node = node.clone
+        node.css('h1,h2,h3,h4,h5,h6').each do |child|
+          child.remove()
+        end
+      end
+
+      # Getting nicely indented HTML:
+      # http://stackoverflow.com/questions/1898829/how-do-i-pretty-print-html-with-nokogiri
+      # This might be a huge mistake?
+      node.to_xhtml(:indent => 2, :indent_text => ' ')
     end
 
     def inner_html

data/lib/smarky/version.rb

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

data/spec/element_spec.rb

@@ -65,4 +65,24 @@ describe Smarky::Element do
       result.title.should be_nil
     end
   end
+
+  describe 'to_html' do
+    it 'can omit section titles if desired' do
+      input <<-EOMARKDOWN
+        This is a title
+        ===============
+        
+        Content content content.
+      EOMARKDOWN
+
+      # TODO: This still sucks :(
+      verify_result(:html_options => { :omit_titles => true }) do
+        <<-EOHTML
+          <article id="this-is-a-title">
+          
+          <p>Content content content.</p></article>
+        EOHTML
+      end
+    end
+  end
 end

data/spec/smarky_spec.rb

@@ -1,22 +1,9 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe Smarky do
-  let(:result) { Smarky.parse(@input, @options || {}) }
+  let(:result) { Smarky.parse(@input, @parse_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'
@@ -24,7 +11,12 @@ describe Smarky do
 
     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>'
+
+      verify_result <<-EOHTML
+        <article>
+          <p>Why <em>hello</em> there.</p>
+        </article>
+      EOHTML
     end
 
     it 'uses RedCarpet for rendering Markdown by default' do
@@ -32,7 +24,13 @@ describe Smarky do
         This should look weird.
         {: .weird }
       EOMARKDOWN
-      verify_result "<article><p>This should look weird.\n{: .weird }</p></article>"
+
+      verify_result <<-EOHTML
+        <article>
+          <p>This should look weird.
+        {: .weird }</p>
+        </article>
+      EOHTML
     end
 
     it 'can use Maruku, if specified' do
@@ -40,7 +38,14 @@ describe Smarky do
         This should look normal.
         {: .normal }
       EOMARKDOWN
-      verify_result({ :markdown_renderer => :maruku }, '<article><p class="normal">This should look normal.</p></article>')
+
+      verify_result(:parse_options => { :markdown_renderer => :maruku }) do
+        <<-EOHTML
+          <article>
+            <p class="normal">This should look normal.</p>
+          </article>
+        EOHTML
+      end
     end
 
     it 'can also use Kramdown' do
@@ -49,7 +54,14 @@ describe Smarky do
         This should also look normal.
         {: .normal }
       EOMARKDOWN
-      verify_result({ :markdown_renderer => :kramdown }, '<article><p class="normal">This should also look normal.</p></article>')
+
+      verify_result(:parse_options => { :markdown_renderer => :kramdown }) do
+        <<-EOHTML
+          <article>
+            <p class="normal">This should also look normal.</p>
+          </article>
+        EOHTML
+      end
     end
 
     it 'renders sibling sections for progressive heading elements' do
@@ -65,7 +77,7 @@ describe Smarky do
         This is section 2.
       EOMARKDOWN
 
-      verify_result [
+      verify_result([
         [:section,
           [:h1, 'Section 1'],
           [:p, 'This is section 1.']
@@ -74,7 +86,7 @@ describe Smarky do
           [:h1, 'Section 2'],
           [:p, 'This is section 2.']
         ]
-      ]
+      ])
     end
 
     it 'attaches IDs to HTML sections' do
@@ -86,11 +98,16 @@ describe Smarky do
         =========
       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>'
+      verify_result(:array_options => { :include_attributes => true }) do
+        [
+          [:section, { :id => 'section-1' },
+            [:h1, 'Section 1'],
+          ],
+          [:section, { :id => 'section-2' },
+            [:h1, 'Section 2']
+          ]
+        ]
+      end
     end
 
     it 'adds content directly to the root article if there is only one top-level section' do

data/spec/spec_helper.rb

@@ -7,12 +7,14 @@ def input(markdown)
   @input = markdown.unindent
 end
 
-def node_to_array(node)
+def node_to_array(node, options={})
+  options ||= {}
+
   array = [node.name.to_sym]
 
-  # if node.attributes.any?
-  #   array << attribute_hash(node.attributes)
-  # end
+  if options[:include_attributes] && node.attributes.any?
+    array << attribute_hash(node.attributes)
+  end
 
   if node.children.empty?
     array << node.content
@@ -22,7 +24,7 @@ def node_to_array(node)
 
   else
     node.children.each do |node|
-      array << node_to_array(node) unless node.name == 'text' && node.content =~ /^\s*$/
+      array << node_to_array(node, options) unless node.name == 'text' && node.content =~ /^\s*$/
     end
   end
 
@@ -40,4 +42,23 @@ RSpec.configure do |config|
   config.before :each do
     @input = ''
   end
+
+  def verify_result(*args)
+    # Allow expected HTML to be specified either as a last parameter or via a block.
+    expected, options = block_given? && [yield, args.pop] || [args.pop, args.pop]
+
+    options ||= {}
+    @parse_options = options[:parse_options]
+    array_options  = options[:array_options]
+    html_options   = options[:html_options]
+
+    case expected
+    when Array
+      node_to_array(result, array_options)[1..-1].should == expected
+    when String
+      result.to_html(html_options || {}).should == expected.unindent.strip
+    else
+      raise "Unable to verify against a #{expected.class}."
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smarky
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Dan Tao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri