hemingway 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a574830a78bd7ac89da2dcd37f90b1515c265bd
-  data.tar.gz: c27b6b9773bc3768aac752831fa25190d5b2895e
+  metadata.gz: 6be07dbe35ddfe1b586683f1c0b22794e7224eb6
+  data.tar.gz: f2289732a6e1250a13d475a4301caa3ff575c397
 SHA512:
-  metadata.gz: 8815d0ebdd41a282ed8f1003a05e0748a8fa4112d8ccd59f0b8c0da040d04e374f09f5ae26002501520aa8eeb3548eb18f50b753e170960725c8f0b9c5255fd9
-  data.tar.gz: 3305dd31396f382c5304d407d6b43bfac01224bb5f05f4bf55e4d5bcd7d2fc5e027fa1bdb7f71c06fd4824030c52ddbab21426631c9f29a30f8ab95bb1d46c7a
+  metadata.gz: 9c39102a201abc6ae4a602b91a0cbdbcebfb8c53d2022912688af99a9f973ebc129f12be862392acf1ab1d9a8d801fa17ea8b8ca879c7009e5088b833928b371
+  data.tar.gz: bf781c65504fbf222fcd6a9cb041a22645625818139cbe4cd2f835389215a6bfb2b4fc8f6849cf2df48ac80ef0a08e0843e67c84d61c22653f63f65a6aef0a34

data/README.md

@@ -253,6 +253,9 @@ And looks like this:
 
 </div>
 
+I've added a timestamp onto footnote hrefs and ids to make the unique incase
+you are parsing multiple entries on a given HTML document.
+
 ###### Block Quotes
 
 Pretty standard. You can put anything in there except a footnote. That seemed
@@ -304,6 +307,16 @@ The love, <span class="pull-right">Will</span>
 Charm\'{e}e de vous voir. Je suis tr\`{e} contente de vous voir. : Charm&eacute;e de vous voir. Je suis tr&egrave; contente de vous voir.
 ```
 
+###### Overrides
+
+Some characters need a little help.
+
+```html
+--- : "&mdash;"
+`` : "&#8220;"
+'' : "&#8221;"
+```
+
 ## Contributing
 
 1. Fork it

data/lib/hemingway/block/list/list_nodes.rb

@@ -1,4 +1,4 @@
-module Hemingway 
+module Hemingway
 
   module ItemizeListNode
     def html(block_content)
@@ -26,7 +26,7 @@ module Hemingway
 
     def description_html
       label_tag = label.empty? ? "" : Build.tag("dt", label.html)
-      Build.tag("dd", label_tag + sequence.elements.map { |e| e.html }.join)
+      label_tag + Build.tag("dd", sequence.elements.map { |e| e.html }.join)
     end
   end
 

data/lib/hemingway/footnote/footnote_nodes.rb

@@ -1,21 +1,31 @@
 module Hemingway
   module FootnoteNode
-    # This is the method that will place the anchor tag and id of the 
-    # footnote within the paragraph body itself. 
-    def html(id)
+    # This is the method that will place the anchor tag and id of the
+    # footnote within the paragraph body itself.
+    #
+    # I'm passing in a time variable here to make links unique. You see,
+    # if you parse many of these entries on a single HTML page you'll end up
+    # with multiple #footnote1 divs. To make them unique, we'll pass down
+    # a time variable from above to seed them.
+    def html(id, time)
       inline_footnote_label = Build.tag("span", Build.tag("sup", id.to_s), :class => "inline-footnote-number")
-      Build.tag("a", inline_footnote_label, :href => "#footnote#{id}")
+      Build.tag("a", inline_footnote_label, :href => "#footnote#{id}#{time}")
     end
 
-    # This is the method that will actually spit out the div that the 
-    # footnote's content is in. This will generally be called after all of the 
+    # This is the method that will actually spit out the div that the
+    # footnote's content is in. This will generally be called after all of the
     # paragraph's text has been spit out so that the footnotes can be appended
-    # after. Note that it needs to be passed an id from the caller so that it 
-    # can be linked to corretly with an anchor tag in the body of the main text. 
-    def footnote_html(id)
+    # after. Note that it needs to be passed an id from the caller so that it
+    # can be linked to corretly with an anchor tag in the body of the main text.
+    #
+    # I'm passing in a time variable here to make links unique. You see,
+    # if you parse many of these entries on a single HTML page you'll end up
+    # with multiple #footnote1 divs. To make them unique, we'll pass down
+    # a time variable from above to seed them.
+    def footnote_html(id, time)
       footnote_label = Build.tag("span", Build.tag("sup", id.to_s), :class => "footnote-number")
       footnote_content = sequence.elements.map { |s| s.html }.join
-      Build.tag("div", footnote_label + footnote_content, :id => "footnote#{id}", :class => "footnote")
+      Build.tag("div", footnote_label + footnote_content, :id => "footnote#{id}#{time}", :class => "footnote")
     end
   end
 end

data/lib/hemingway/latex.rb

@@ -6,6 +6,7 @@ require 'hemingway/latex_nodes'
 require "hemingway/block/block"
 require "hemingway/footnote/footnote"
 require "hemingway/math/math"
+require "hemingway/override/override"
 require "hemingway/special/special"
 require "hemingway/symbol/symbol"
 require "hemingway/tag/tag"
@@ -25,6 +26,8 @@ module Hemingway
 
     include Math
 
+    include Override
+
     include Special
 
     include Symbol
@@ -311,12 +314,17 @@ module Hemingway
             if r4
               r0 = r4
             else
-              r5 = _nt_text
+              r5 = _nt_override
               if r5
                 r0 = r5
               else
-                @index = i0
-                r0 = nil
+                r6 = _nt_text
+                if r6
+                  r0 = r6
+                else
+                  @index = i0
+                  r0 = nil
+                end
               end
             end
           end

data/lib/hemingway/latex.treetop

@@ -3,6 +3,7 @@ require 'hemingway/latex_nodes'
 require "hemingway/block/block"
 require "hemingway/footnote/footnote"
 require "hemingway/math/math"
+require "hemingway/override/override"
 require "hemingway/special/special"
 require "hemingway/symbol/symbol"
 require "hemingway/tag/tag"
@@ -14,6 +15,7 @@ module Hemingway
     include Block
     include Footnote
     include Math
+    include Override
     include Special
     include Symbol
     include Tag
@@ -53,7 +55,7 @@ module Hemingway
     #  method need not be defined on it because alas, it already exists as
     #  defined in the text rule itself!
     rule content
-      special / tag / block / math / text
+      special / tag / block / math / override / text
     end
 
     # Treetop does not separate lexing from parsing. Must consume all input.

data/lib/hemingway/latex_nodes.rb

@@ -6,8 +6,10 @@ module Hemingway
       paragraph_html = ""
 
       elements.each do |e|
-        paragraph_html += e.html(footnote_content.size)
-        footnote_content += e.footnote_html(footnote_content.size)
+        # Time.now.to_f => 123123.1231231
+        time = Time.now.to_f.to_s.gsub(".", "-")
+        paragraph_html += e.html(footnote_content.size, time)
+        footnote_content += e.footnote_html(footnote_content.size, time)
       end
 
       footnote_html = footnote_content.join
@@ -17,11 +19,16 @@ module Hemingway
   end
 
   module ParagraphNode
-    def html(footnote_seed)
+
+    # I'm passing in a time variable here to make links unique. You see,
+    # if you parse many of these entries on a single HTML page you'll end up
+    # with multiple #footnote1 divs. To make them unique, we'll pass down
+    # a time variable from above to seed them.
+    def html(footnote_seed, time)
       paragraph_content = sequence.elements.map do |element|
         if element.respond_to?(:footnote_html)
           footnote_seed += 1
-          element.html(footnote_seed)
+          element.html(footnote_seed, time)
         elsif element.respond_to?(:newline)
           element.newline.html
         else
@@ -32,11 +39,15 @@ module Hemingway
       Build.tag("p", paragraph_content)
     end
 
-    def footnote_html(footnote_seed)
+    # I'm passing in a time variable here to make links unique. You see,
+    # if you parse many of these entries on a single HTML page you'll end up
+    # with multiple #footnote1 divs. To make them unique, we'll pass down
+    # a time variable from above to seed them.
+    def footnote_html(footnote_seed, time)
       footnote_content = sequence.elements.reduce([]) do |memo, element|
         if element.respond_to?(:footnote_html)
           footnote_seed += 1
-          memo + [element.footnote_html(footnote_seed)]
+          memo + [element.footnote_html(footnote_seed, time)]
         else
           memo
         end

data/lib/hemingway/override/override.rb

@@ -0,0 +1,73 @@
+# Autogenerated from a Treetop grammar. Edits may be lost.
+
+
+require "hemingway/override/override_nodes"
+
+module Hemingway
+  module Override
+    include Treetop::Runtime
+
+    def root
+      @root ||= :override
+    end
+
+    def _nt_override
+      start_index = index
+      if node_cache[:override].has_key?(index)
+        cached = node_cache[:override][index]
+        if cached
+          cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+          @index = cached.interval.end
+        end
+        return cached
+      end
+
+      i0 = index
+      if has_terminal?("---", false, index)
+        r1 = instantiate_node(MDashNode,input, index...(index + 3))
+        @index += 3
+      else
+        terminal_parse_failure("---")
+        r1 = nil
+      end
+      if r1
+        r0 = r1
+      else
+        if has_terminal?("``", false, index)
+          r2 = instantiate_node(LeftQuoteNode,input, index...(index + 2))
+          @index += 2
+        else
+          terminal_parse_failure("``")
+          r2 = nil
+        end
+        if r2
+          r0 = r2
+        else
+          if has_terminal?("''", false, index)
+            r3 = instantiate_node(RightQuoteNode,input, index...(index + 2))
+            @index += 2
+          else
+            terminal_parse_failure("''")
+            r3 = nil
+          end
+          if r3
+            r0 = r3
+          else
+            @index = i0
+            r0 = nil
+          end
+        end
+      end
+
+      node_cache[:override][start_index] = r0
+
+      r0
+    end
+
+  end
+
+  class OverrideParser < Treetop::Runtime::CompiledParser
+    include Override
+  end
+
+end

data/lib/hemingway/override/override.treetop

@@ -0,0 +1,16 @@
+require "hemingway/override/override_nodes"
+
+module Hemingway
+  grammar Override
+
+    # Plain text to be overridden with more appropriate characters
+    rule override
+      "---" <MDashNode>
+      /
+      "``" <LeftQuoteNode>
+      /
+      "''" <RightQuoteNode>
+    end
+
+  end
+end

data/lib/hemingway/override/override_nodes.rb

@@ -0,0 +1,21 @@
+module Hemingway
+
+	module MDashNode
+		def html
+			"—"
+		end
+	end
+
+	module LeftQuoteNode
+		def html
+			"“"
+		end
+	end
+
+	module RightQuoteNode
+		def html
+			"”"
+		end
+	end
+
+end

data/lib/hemingway/text/text.rb

@@ -100,8 +100,13 @@ module Hemingway
             if r4
               r0 = r4
             else
-              @index = i0
-              r0 = nil
+              r5 = _nt_override
+              if r5
+                r0 = r5
+              else
+                @index = i0
+                r0 = nil
+              end
             end
           end
         end

data/lib/hemingway/text/text.treetop

@@ -28,7 +28,7 @@ module Hemingway
 
     # If you hit any of these while chomping on text you should pop out
     rule non_text
-      escape / tag_end / math_start / newline
+      escape / tag_end / math_start / newline / override
     end
 
   end

data/lib/hemingway/version.rb

@@ -1,3 +1,3 @@
 module Hemingway
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

data/spec/nodes/block/list_spec.rb

@@ -87,7 +87,7 @@ module Hemingway
 
       it 'should wrap labels in the dictionary label tag' do
         html = @parser.parse("\\begin{description} \\item [Frodo] Adventuerer \\item [Sam] Faithful Companion \\end{description}").html
-        html.should == "<div class='entry'><p><dl><dd><dt>Frodo</dt> Adventuerer </dd><dd><dt>Sam</dt> Faithful Companion </dd></dl></p></div>"
+        html.should == "<div class='entry'><p><dl><dt>Frodo</dt><dd> Adventuerer </dd><dt>Sam</dt><dd> Faithful Companion </dd></dl></p></div>"
       end
     end
 

data/spec/nodes/footnote_spec.rb

@@ -6,33 +6,36 @@ module Hemingway
 
     before do
       @parser = Parser.new
+      time = double()
+      Time.stub(:now) { time }
+      time.stub(:to_f) { 100.01 }
     end
 
     describe "#footnote" do
 
       it "should put a footnote at the end of a paragraph" do
         html = @parser.parse("You are what you redpoint\\footnote{sending a lead route}, after all.").html
-        html.should == "<div class='entry'><p>You are what you redpoint<a href='#footnote1'><span class='inline-footnote-number'><sup>1</sup></span></a>, after all.</p><div id='footnote1' class='footnote'><span class='footnote-number'><sup>1</sup></span>sending a lead route</div></div>"
+        html.should == "<div class='entry'><p>You are what you redpoint<a href='#footnote1100-01'><span class='inline-footnote-number'><sup>1</sup></span></a>, after all.</p><div id='footnote1100-01' class='footnote'><span class='footnote-number'><sup>1</sup></span>sending a lead route</div></div>"
       end
 
       it "should put properly increment the footnote count per entry" do
         html = @parser.parse("Slowly, Vader\\footnote{thug} approached Luke\\footnote{homeboy}").html
-        html.should == "<div class='entry'><p>Slowly, Vader<a href='#footnote1'><span class='inline-footnote-number'><sup>1</sup></span></a> approached Luke<a href='#footnote2'><span class='inline-footnote-number'><sup>2</sup></span></a></p><div id='footnote1' class='footnote'><span class='footnote-number'><sup>1</sup></span>thug</div><div id='footnote2' class='footnote'><span class='footnote-number'><sup>2</sup></span>homeboy</div></div>"
+        html.should == "<div class='entry'><p>Slowly, Vader<a href='#footnote1100-01'><span class='inline-footnote-number'><sup>1</sup></span></a> approached Luke<a href='#footnote2100-01'><span class='inline-footnote-number'><sup>2</sup></span></a></p><div id='footnote1100-01' class='footnote'><span class='footnote-number'><sup>1</sup></span>thug</div><div id='footnote2100-01' class='footnote'><span class='footnote-number'><sup>2</sup></span>homeboy</div></div>"
       end
 
       it "should support any type of content in a footnote" do
         html = @parser.parse("Dave Graham\\footnote{\\emph{Boulderer}, and \& all around \\textsc{good} guy $\\gamma$} makes the best mixtapes").html
-        html.should == "<div class='entry'><p>Dave Graham<a href='#footnote1'><span class='inline-footnote-number'><sup>1</sup></span></a> makes the best mixtapes</p><div id='footnote1' class='footnote'><span class='footnote-number'><sup>1</sup></span><em>Boulderer</em>, and & all around <span class='textsc'>good</span> guy &gamma;</div></div>"
+        html.should == "<div class='entry'><p>Dave Graham<a href='#footnote1100-01'><span class='inline-footnote-number'><sup>1</sup></span></a> makes the best mixtapes</p><div id='footnote1100-01' class='footnote'><span class='footnote-number'><sup>1</sup></span><em>Boulderer</em>, and & all around <span class='textsc'>good</span> guy &gamma;</div></div>"
       end
 
       it "should properly place footnotes from all paragraphs after all paragraphs an increment properly" do
         html = @parser.parse("Freddie Gibbs\\footnote{from Gary, Indiana} is hood\\footnote{thug} as all hell.\n\n John Russel\\footnote{of Short Bus fame} almost got raped in Gary, ID\\footnote{but not by Freddie Gibbs}").html
-        html.should == "<div class='entry'><p>Freddie Gibbs<a href='#footnote1'><span class='inline-footnote-number'><sup>1</sup></span></a> is hood<a href='#footnote2'><span class='inline-footnote-number'><sup>2</sup></span></a> as all hell.</p><p> John Russel<a href='#footnote3'><span class='inline-footnote-number'><sup>3</sup></span></a> almost got raped in Gary, ID<a href='#footnote4'><span class='inline-footnote-number'><sup>4</sup></span></a></p><div id='footnote1' class='footnote'><span class='footnote-number'><sup>1</sup></span>from Gary, Indiana</div><div id='footnote2' class='footnote'><span class='footnote-number'><sup>2</sup></span>thug</div><div id='footnote3' class='footnote'><span class='footnote-number'><sup>3</sup></span>of Short Bus fame</div><div id='footnote4' class='footnote'><span class='footnote-number'><sup>4</sup></span>but not by Freddie Gibbs</div></div>"
+        html.should == "<div class='entry'><p>Freddie Gibbs<a href='#footnote1100-01'><span class='inline-footnote-number'><sup>1</sup></span></a> is hood<a href='#footnote2100-01'><span class='inline-footnote-number'><sup>2</sup></span></a> as all hell.</p><p> John Russel<a href='#footnote3100-01'><span class='inline-footnote-number'><sup>3</sup></span></a> almost got raped in Gary, ID<a href='#footnote4100-01'><span class='inline-footnote-number'><sup>4</sup></span></a></p><div id='footnote1100-01' class='footnote'><span class='footnote-number'><sup>1</sup></span>from Gary, Indiana</div><div id='footnote2100-01' class='footnote'><span class='footnote-number'><sup>2</sup></span>thug</div><div id='footnote3100-01' class='footnote'><span class='footnote-number'><sup>3</sup></span>of Short Bus fame</div><div id='footnote4100-01' class='footnote'><span class='footnote-number'><sup>4</sup></span>but not by Freddie Gibbs</div></div>"
       end
 
       it "will obviously allow me to drop a list in a footnote (this is just for my own satisfaction mostly)" do
         html = @parser.parse("There are some rules\\footnote{\\begin{itemize} \\item Steezy socks always \\item Brosend often \\item Everything for the ladies \\end{itemize}} that we all must live by.").html
-        html.should == "<div class='entry'><p>There are some rules<a href='#footnote1'><span class='inline-footnote-number'><sup>1</sup></span></a> that we all must live by.</p><div id='footnote1' class='footnote'><span class='footnote-number'><sup>1</sup></span><ul><li>Steezy socks always </li><li>Brosend often </li><li>Everything for the ladies </li></ul></div></div>"
+        html.should == "<div class='entry'><p>There are some rules<a href='#footnote1100-01'><span class='inline-footnote-number'><sup>1</sup></span></a> that we all must live by.</p><div id='footnote1100-01' class='footnote'><span class='footnote-number'><sup>1</sup></span><ul><li>Steezy socks always </li><li>Brosend often </li><li>Everything for the ladies </li></ul></div></div>"
       end
 
     end

data/spec/nodes/override_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Hemingway
+
+  describe Parser do
+
+    before do
+      @parser = Parser.new
+    end
+
+    describe "#override" do
+
+      it 'should override a dash character' do
+        html = @parser.parse("Please--- wait for me.").html
+        html.should == "<div class='entry'><p>Please&mdash; wait for me.</p></div>"
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hemingway
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - William Myers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-15 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -78,6 +78,9 @@ files:
 - lib/hemingway/math/math.rb
 - lib/hemingway/math/math.treetop
 - lib/hemingway/math/math_nodes.rb
+- lib/hemingway/override/override.rb
+- lib/hemingway/override/override.treetop
+- lib/hemingway/override/override_nodes.rb
 - lib/hemingway/special/special.rb
 - lib/hemingway/special/special.treetop
 - lib/hemingway/special/special_nodes.rb
@@ -101,6 +104,7 @@ files:
 - spec/nodes/block_spec.rb
 - spec/nodes/footnote_spec.rb
 - spec/nodes/math_spec.rb
+- spec/nodes/override_spec.rb
 - spec/nodes/special_spec.rb
 - spec/nodes/tag_spec.rb
 - spec/parser_spec.rb
@@ -138,6 +142,7 @@ test_files:
 - spec/nodes/block_spec.rb
 - spec/nodes/footnote_spec.rb
 - spec/nodes/math_spec.rb
+- spec/nodes/override_spec.rb
 - spec/nodes/special_spec.rb
 - spec/nodes/tag_spec.rb
 - spec/parser_spec.rb