RubyGems - bookie - Versions diffs - 0.0.3 → 0.0.4 - Mend

bookie 0.0.3 → 0.0.4

Files changed (11) hide show

data/CHANGELOG.md +5 -0
data/doc/markdown_syntax.pdf +0 -0
data/examples/preformatted.rb +11 -0
data/examples/simple_emitters.rb +6 -5
data/lib/bookie/document.rb +2 -2
data/lib/bookie/emitters.rb +35 -16
data/lib/bookie/parser.rb +51 -9
data/lib/bookie/version.rb +1 -1
data/test/fixtures/preformatted_blocks.md +39 -0
data/test/units/parser_test.rb +11 -1
metadata +5 -2

data/CHANGELOG.md CHANGED Viewed

@@ -14,3 +14,8 @@ anything else.
 Added some basic emitters for PDF and HTML paragraphs. Note these are proofs of
 concept ONLY, not meant for practical use. See examples/simple_emitters.rb to
 see how they're used.
+## 0.0.4 (2011.04.24)
+Removed HTML emitter for now. Expanded parser and PDF emitter to support
+preformatted text. See examples/preformatted.rb for to see how it works.

data/doc/markdown_syntax.pdf ADDED Viewed

Binary file

data/examples/preformatted.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require_relative "../lib/bookie"
+Prawn.debug = true
+file = "#{File.dirname(__FILE__)}/../test/fixtures/preformatted_blocks.md"
+pdf_document = Bookie::Document.new(file, Bookie::Emitters::PDF.new)
+File.open("output.pdf", "w") do |f|
+  f << pdf_document.render(header: "Practicing Ruby: Issue #1",
+                           title:  "Ruby's Method Lookup Path")
+end

data/examples/simple_emitters.rb CHANGED Viewed

@@ -1,10 +1,11 @@
 require_relative "../lib/bookie"
 Prawn.debug = true
-test_file = "#{File.dirname(__FILE__)}/../test/fixtures/multi_paragraph_document.md"
+file = "#{File.dirname(__FILE__)}/../test/fixtures/multi_paragraph_document.md"
-html_document = Bookie::Document.new(test_file, Bookie::Emitters::HTML.new)
-File.open("output.html", "w") { |f| f << html_document.render }
+pdf_document = Bookie::Document.new(file, Bookie::Emitters::PDF.new)
-pdf_document = Bookie::Document.new(test_file, Bookie::Emitters::PDF.new)
-File.open("output.pdf", "w") { |f| f << pdf_document.render }
+File.open("output.pdf", "w") do |f|
+  f << pdf_document.render(header: "Majestic Sea Creature Blog",
+                           title: "Why does RbMU exist?")
+end

data/lib/bookie/document.rb CHANGED Viewed

@@ -7,8 +7,8 @@ module Bookie
     attr_reader :emitter, :contents
-    def render
-      @emitter.render
+    def render(*args)
+      @emitter.render(*args)
     end
   end
 end

data/lib/bookie/emitters.rb CHANGED Viewed

@@ -3,20 +3,8 @@ module Bookie
     class Null
       def build_paragraph(paragraph)
       end
-    end
-    class HTML
-      def initialize
-        @output = ""
-      end
-      def build_paragraph(paragraph)
-        @output << "<p>#{paragraph.children.first}</p>"
-      end
-      def render
-        "<html><body>#{@output}</body></html>"
+      def build_raw_text(paragraphs)
       end
     end
@@ -25,18 +13,49 @@ module Bookie
       def initialize
         @document    = new_prawn_document
+        @document.extend(Prawn::Measurements)
         @paragraphs  = []
       end
       def build_paragraph(paragraph)
-        @paragraphs << paragraph.children.first.gsub(/\s+/," ")
+        @paragraphs << { text: paragraph.children.first.strip }
       end
-      def render
-        @document.text(@paragraphs.join("\n\n"), align: :justify, size: 10)
+      def build_raw_text(raw_text)
+        sanitized_text = raw_text.children.first.
+                                  gsub(" ", Prawn::Text::NBSP).strip
+        @paragraphs << { text: sanitized_text,
+                         font: "Courier",
+                         size: 8               }
+      end
+      def render(params)
+        render_header(params)
+        # there needs to be a better way
+        @paragraphs = @paragraphs.reduce([]) { |s,r| s + [r, { text: "\n\n" }] }
+        @paragraphs.pop
+        @document.formatted_text(@paragraphs, align: :justify, size: 10)
         @document.render
       end
+      def render_header(params)
+        @document.instance_eval do
+          text "<b>#{params[:header]}</b>",
+            size: 12, align: :right, inline_format: true
+          stroke_horizontal_rule
+          move_down in2pt(0.1)
+          text "<b>#{params[:title]}</b>",
+            size: 18, align: :right, inline_format: true
+          move_down in2pt(1.25)
+        end
+      end
       private
       def new_prawn_document

data/lib/bookie/parser.rb CHANGED Viewed

@@ -1,6 +1,7 @@
 module Bookie
-  ContentTree = Struct.new(:children)
-  Paragraph   = Struct.new(:children)
+  ContentTree      = Struct.new(:children)
+  Paragraph        = Struct.new(:children)
+  RawText          = Struct.new(:children)
   class Parser
     def self.parse(contents, emitter=Bookie::Emitters::Null.new)
@@ -15,19 +16,60 @@ module Bookie
       generate_document_tree(contents)
     end
-    def extract_paragraphs(contents)
-      contents.split(/\n\n+/).each do |e|
-        paragraph = Paragraph.new([e])
-        @emitter.build_paragraph(paragraph)
-        document_tree.children << paragraph
-      end
+    def extract_paragraph(contents)
+      paragraph = Paragraph.new([contents.gsub(/\s+/," ")])
+      @emitter.build_paragraph(paragraph)
+      document_tree.children << paragraph
+    end
+    def extract_raw_text(contents)
+      raw_text = RawText.new([contents])
+      @emitter.build_raw_text(raw_text)
+      document_tree.children << raw_text
     end
     private
     def generate_document_tree(contents)
       @document_tree = ContentTree.new([])
-      extract_paragraphs(contents)
+      lines = contents.lines.to_a
+      mode  = nil
+      until lines.empty?
+        line = lines.shift
+        case
+        when mode == nil
+          if line[/^ {4,}/]
+            mode = :raw
+            chunk = line[4..-1]
+          else
+            mode = :paragraph
+            chunk = line
+          end
+        when mode == :raw
+          chunk << (line.chomp.empty? ? "\n" : line[4..-1].to_s)
+          if lines.first =~ /^ {0,3}\S/
+            mode = nil
+            extract_raw_text(chunk)
+          end
+        when mode == :paragraph
+          if line.chomp.empty?
+            mode = nil
+            extract_paragraph(chunk)
+          else
+            chunk << line
+          end
+        end
+      end
+      case mode
+      when :paragraph
+        extract_paragraph(chunk)
+      when :raw
+        extract_raw_text(chunk)
+      end
     end
   end
 end

data/lib/bookie/version.rb CHANGED Viewed

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

data/test/fixtures/preformatted_blocks.md ADDED Viewed

@@ -0,0 +1,39 @@
+I decided to start off this newsletter with one of the most basic but
+essential pieces of knowledge you can have about Ruby's object model:
+the way it looks up methods.  Let's do a little exploration by working
+through a few examples.
+Below we have a simple report class who's job is to perform some basic
+data manipulations and then produce some text output.
+    class Report
+      def initialize(ledger)
+        @balance          = ledger.inject(0) { |sum, (k,v)| sum + v }
+        @credits, @debits = ledger.partition { |k,v| v > 0 }
+      end
+      attr_reader :credits, :debits, :balance
+      def formatted_output
+        "Current Balance: #{balance}\n\n" +
+        "Credits:\n\n#{formatted_line_items(credits)}\n\n" +
+        "Debits:\n\n#{formatted_line_items(debits)}"
+      end
+      def formatted_line_items(items)
+        items.map { |k, v| "#{k}: #{'%.2f' % v.abs}" }.join("\n")
+      end
+    end
+The following code demonstrates how we'd make use of this newly created class.
+    ledger = [ ["Deposit Check #123", 500.15],
+               ["Fancy Shoes",       -200.25],
+               ["Fancy Hat",          -54.40],
+               ["ATM Deposit",       1200.00],
+               ["Kitteh Litteh",       -5.00] ]
+    report = Report.new(ledger)
+    puts report.formatted_output
+Amazing, right? (Yadda... yadda.. yadda)

data/test/units/parser_test.rb CHANGED Viewed

@@ -5,7 +5,8 @@ context "A Parser" do
     sample_text           = File.read(fixture("multi_paragraph_document.md"))
     # NOTE: Is this the behavior we'd expect?
-    sample_paragraph_text = File.read(fixture("single_paragraph.md")).chomp
+    sample_paragraph_text = File.read(fixture("single_paragraph.md"))
+                                .gsub(/\s+/," ")
     tree = Bookie::Parser.parse(sample_text)
@@ -16,4 +17,13 @@ context "A Parser" do
     assert_equal sample_paragraph_text, actual_paragraph_text
   end
+  test "should know about preformatted text" do
+    sample_text = File.read(fixture("preformatted_blocks.md"))
+    tree = Bookie::Parser.parse(sample_text)
+    assert_equal 7, tree.children.length
+  end
 end

metadata CHANGED Viewed

@@ -2,7 +2,7 @@
 name: bookie
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Gregory Brown
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-04-23 00:00:00 -04:00
+date: 2011-04-24 00:00:00 -04:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -40,12 +40,15 @@ files:
 - lib/bookie/version.rb
 - lib/bookie.rb
 - test/fixtures/multi_paragraph_document.md
+- test/fixtures/preformatted_blocks.md
 - test/fixtures/single_paragraph.md
 - test/suite.rb
 - test/test_helper.rb
 - test/units/document_test.rb
 - test/units/parser_test.rb
+- examples/preformatted.rb
 - examples/simple_emitters.rb
+- doc/markdown_syntax.pdf
 - GPLv3
 - README.md
 - CHANGELOG.md