data_doc 0.1.0 → 0.2.0

data/History.txt

@@ -1,3 +1,14 @@
+=== 0.2.0 2012-10-25
+
+* 1 major enhancement:
+  * Generates PDF (using prince)
+  
+* 1 minor enhancement:
+  * Improved examples
+
+* 1 known issue:
+  * ERB processing under $SAFE = 4 unavailable 
+
 === 0.1.0 2012-10-23
 
 * 2 major enhancements:

data/README.rdoc

@@ -5,10 +5,10 @@
 == DEVELOPMENT STATUS: 
 
 Generates html from markdown files containing erb, including layout and 
-headers. DSL in place for stores, attributes and simple tables. Testing 
-doesn't quite cover the Present DSL.
+headers. DSL in place for stores, attributes and simple tables, but no 
+alternate keys. Error messages are raw, fit for technical only.
 
-{<img src="https://secure.travis-ci.org/alilee/data_doc.png" alt="Build Status" />}[http://travis-ci.org/alilee/data_doc] {<img src="https://gemnasium.com/alilee/data_doc.png" alt="Dependency Status" />}[https://gemnasium.com/alilee/data_doc]
+{<img src="https://secure.travis-ci.org/alilee/data_doc.png" alt="Build Status" />}[http://travis-ci.org/alilee/data_doc] {<img src="https://gemnasium.com/alilee/data_doc.png" alt="Dependency Status" />}[https://gemnasium.com/alilee/data_doc] {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/alilee/data_doc]
 
 == DESCRIPTION:
 
@@ -24,7 +24,7 @@ Note: See security implications below.
 * Main document is Markdown for convenient content authoring.
 * Builds up data in relational database, facilitating review and 
   analysis.
-* Generates HTML from Markdown.
+* Generates HTML from Markdown, and pdf if {prince}[princexml.com] is available.
 * Provides fine-grained control over the HTML headers, including 
   CSS, for the output.
 * Simple DSL for capturing structured data.
@@ -52,7 +52,8 @@ your level of risk.
       -r, --read-only                  Use data already in database rather than document data
       -d, --data-only                  Use document data but do not change database schema
       -o, --output FILENAME            Put generated output in FILENAME
-      -f, --format TYPE                Select type of output from html (default: html)
+      -f, --format TYPE                Select type of output from html, pdf (default: html)
+      -p, --prince PATH                Path for prince pdf generator
       -v, --[no-]verbose               Run verbosely
 
   Common options:

data/lib/data_doc.rb

@@ -6,10 +6,9 @@ $:.unshift(File.dirname(__FILE__)) unless
 #
 module DataDoc
   # Gem version
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
   # A summary of purpose of the tool.  
   DESCRIPTION = 'Processes structured data embedded in a markdown document and then renders it into configurable tables.'
 end
 
 require 'data_doc/document.rb'
-# require 'data_doc/table.rb'

data/lib/data_doc/cli.rb

@@ -32,9 +32,9 @@ module DataDoc
         opts.separator "Specific options:"
 
         opts.on("-c", "--connection FILENAME", 
-                "Override document connection settings with FILENAME") do |filename|
+                "Override document connection settings with FILENAME") do |conn_filename|
           begin
-            doc.connection = YAML.load(File.read(filename))
+            doc.connection = conn_filename
           rescue Exception => e
             stdout.puts "ERROR with connection file (#{e.message})"
             return 1
@@ -58,6 +58,11 @@ module DataDoc
         opts.on("-f", "--format TYPE", DataDoc::Document::OUTPUT_TYPES, "Select type of output from #{type_list} (default: #{doc.format})") do |format|
           doc.format = format
         end
+        
+        opts.on("-p", "--prince PATH", 
+                "Path for prince pdf generator") do |p|  
+          doc.prince = p
+        end        
 
         opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
           doc.verbose = v

data/lib/data_doc/document.rb

@@ -1,5 +1,6 @@
 require 'rdiscount'
 require 'erb'
+require 'tempfile'
 require 'data_doc/store.rb'
 require 'data_doc/present.rb'
 
@@ -23,6 +24,7 @@ module DataDoc
     #
     def initialize
       @format = 'html'
+      @prince_path = 'prince'
       @verbose = false
       @read_only = false
       @data_only = false
@@ -37,7 +39,7 @@ module DataDoc
     attr_accessor :format 
 
     # Available mime types that can be generated.
-    OUTPUT_TYPES = ['html']
+    OUTPUT_TYPES = ['html', 'pdf']
 
     # display verbose output during processing
     attr_accessor :verbose
@@ -75,6 +77,13 @@ module DataDoc
     def layout=(filename)
       @layout_filename = filename
     end
+
+    # 
+    # Sets path to find the pdf generator.
+    #
+    def prince=(prince_path)
+      @prince_path = prince_path
+    end
         
     #
     # :section: 2. Main function
@@ -94,7 +103,13 @@ module DataDoc
         # @store.untaint
       end
       content_html = RDiscount.new(mark_down).to_html
-      wrap_in_layout(content_html)
+      html = wrap_in_layout(content_html)
+      case @format 
+      when 'pdf'
+        html_to_pdf(html)
+      else
+        html
+      end  
     end
     
     #
@@ -147,7 +162,7 @@ module DataDoc
     # Adds a meta tag to the headers
     #
     def meta(attrs = {})
-      add_header "<meta #{html_attrs(attrs)}>"    
+      add_header "<meta #{html_attrs(attrs)} />"    
     end
 
     #
@@ -161,7 +176,7 @@ module DataDoc
     # Adds a link tag to the headers
     #
     def link(attrs = {})
-      add_header "<link #{html_attrs(attrs)}>"
+      add_header "<link #{html_attrs(attrs)} />"
     end
             
             
@@ -181,7 +196,7 @@ module DataDoc
     # Define a table store.
     #
     def store(name, opts = {}, &blk)
-      @stores[name.to_s] = DataDoc::Store.new(self, name, opts, &blk)
+      @stores[name.to_s] = DataDoc::Store.store(self, name, opts, &blk)
       name
     end
     
@@ -193,8 +208,8 @@ module DataDoc
     # Present a table. Pass a block to set options for display.
     # For more information see DataDoc::Present
     #
-    def present(arel_or_str)
-      DataDoc::Present.present(self, arel_or_str)
+    def present(arel_or_str, &blk)
+      DataDoc::Present.present(self, arel_or_str, &blk)
     end
             
   protected
@@ -264,7 +279,20 @@ module DataDoc
       end 
     end
     
-    
+    #
+    # Make PDF from HTML.
+    #
+    def html_to_pdf(html)
+      pdf_file = Tempfile.new('prince')
+      pdf_file.close
+      html_file = Tempfile.open('prince', '.') do |f|
+        f.write(html)
+        f
+      end 
+      system("#{@prince_path} -o #{pdf_file.path} #{html_file.path}")
+      File.read(pdf_file.path)
+    end
+        
   end
   
 end

data/lib/data_doc/present.rb

@@ -10,10 +10,18 @@ module DataDoc
     #
     # Accept display options from a block. Returns html table.
     #
+    #   present 'select one, two from relation' do
+    #     caption 'Table caption'
+    #     column_order 'two', 'one'
+    #   end
+    #
+    # For more table configuration options see the member functions
+    # of DataDoc::Present
+    #
     def self.present(doc, arel_or_str, &blk)
       rows = doc.connection.select_all(arel_or_str)
       p = Present.new(doc, rows)
-      p.instance_eval(&blk) if block_given?
+      p.instance_eval(&blk) unless blk.nil?
       p.render
     end
     
@@ -22,6 +30,10 @@ module DataDoc
     #
     # Not every field queried needs to be presented.
     #
+    #   present 'select one, two from relation' do 
+    #     column_order 'two', 'one'
+    #   end
+    #
     def column_order(*order)
       @column_order = order
     end
@@ -29,6 +41,10 @@ module DataDoc
     #
     # Set the caption for the table
     #
+    #   present 'select 1' do 
+    #     caption 'Table caption'
+    #   end
+    #
     def caption(text)
       @caption = text
     end
@@ -36,6 +52,10 @@ module DataDoc
     #
     # Rename the column heading text for a particular column.
     #
+    #   present 'select one, two from relation' do 
+    #     label 'one', 'New column heading'
+    #   end
+    #
     def label(column, text)
       @labels[column] = text
     end
@@ -46,17 +66,40 @@ module DataDoc
     #
     # Return nil to revert to the default behaviour.
     #
-    def each_cell(&blk) # :yields: col, row
-      @each_cell = blk
+    #   present 'select one, two from relation' do 
+    #     each_cell 'one' do |col, row|
+    #       row[col] == 'true' ? 'Short' : 'Long'
+    #     end
+    #   end
+    #
+    def each_cell(col, &blk) # :yields: col, row
+      @each_cell[col] = blk
     end
     
     #
     # Define a calculated column based on a block.
     #
-    def calculate(col, &blk) # :yields: row
+    #   present 'select one, two from relation' do 
+    #     calculated 'three' do |col, row|
+    #       row['two'] == 'true' ? 'Short' : 'Long'
+    #     end
+    #   end
+    #
+    def calculated(col, &blk) # :yields: row
       @calculated[col] = blk
     end
     
+    #
+    # Suppress header row.
+    #
+    #   present 'select one, two from relation' do 
+    #     no_headers
+    #   end
+    #
+    def no_headers
+      @no_headers = true
+    end    
+    
     #
     # Generate html.
     #
@@ -64,20 +107,23 @@ module DataDoc
       h = Builder::XmlMarkup.new
       h.table {
         h.caption(@caption) unless @caption.nil?
-        h.thead {
-          h.tr {
-            @column_order.each { |c| h.th(@labels[c] || c.to_s.humanize) }
+        unless @no_headers 
+          h.thead {
+            h.tr {
+              @column_order.each { |c| h.th(@labels[c] || c.to_s.humanize) }
+            }
           }
-        }
+        end
         h.tfoot
         h.tbody {
           @rows.each do |r|
             h.tr {
-              if @each_cell.nil?
-                @column_order.each {|col| h.td(r[col.to_s]) }
-              else
-                @column_order.each do |col|
-                  h.td(@each_cell.call(r, col) || r[col.to_s])
+              @column_order.each do |col|
+                r[col.to_s] = @calculated[col].call(col, r) unless @calculated[col].nil?
+                if @each_cell[col].nil?
+                  h.td(r[col.to_s])
+                else
+                  h.td(@each_cell[col].call(col, r) || r[col.to_s])
                 end
               end
             }
@@ -95,9 +141,10 @@ module DataDoc
       @doc = doc
       @rows = rows
       @caption = nil
-      @each_cell = nil
+      @each_cell = Hash.new
       @labels = Hash.new
       @calculated = Hash.new
+      @no_headers = false
       @column_order = rows.first.keys
     end
         

data/lib/data_doc/store.rb

@@ -17,10 +17,11 @@ module DataDoc
     # schema definition. Table is re-created and emptied unless 
     # read_only, and just emptied if data_only.
     #
-    def initialize(doc, table_name_or_sym, opts = {}, &blk)
-      @doc = doc
-      @connection = @doc.connection
-      create_store(table_name_or_sym, opts, &blk)
+    def self.store(doc, table_name_or_sym, opts = {}, &blk) # :yields:
+      s = Store.new(doc)
+      s.create_store(table_name_or_sym, opts)
+      s.instance_eval(&blk) unless blk.nil?
+      s
     end
     
     # AREL object encapsulating table.
@@ -29,6 +30,11 @@ module DataDoc
     #
     # Define a string field.
     #
+    #   store 'relation' do
+    #     string 'field_name', default: 'value'
+    #     string :another_field, null: false
+    #   end
+    #
     def string(name, opts = {})
       @connection.add_column(@arel.name, name, :string, opts)
     end
@@ -36,6 +42,11 @@ module DataDoc
     #
     # Define an integer field.
     #
+    #   store 'relation' do
+    #     integer 'field_name', default: 42
+    #     integer :another_field
+    #   end
+    #
     def integer(name, opts = {})
       @connection.add_column(@arel.name, name, :integer, opts)
     end
@@ -43,6 +54,11 @@ module DataDoc
     # 
     # Define a text field.
     #
+    #   store 'relation' do
+    #     text 'field_name'
+    #     text :another_field
+    #   end
+    #
     def text(name, opts = {})
       @connection.add_column(@arel.name, name, :text, opts)
     end
@@ -50,10 +66,63 @@ module DataDoc
     # 
     # Define a datetime field.
     #
+    #   store 'relation' do
+    #     datetime 'field_name'
+    #     datetime :another_field
+    #   end
+    #
     def datetime(name, opts = {})
       @connection.add_column(@arel.name, name, :datetime, opts)
     end    
     
+    # 
+    # Define a datetime field.
+    #
+    #   store 'relation' do
+    #     time 'field_name'
+    #     time :another_field
+    #   end
+    #
+    def time(name, opts = {})
+      @connection.add_column(@arel.name, name, :time, opts)
+    end
+    
+    # 
+    # Define a date field.
+    #
+    #   store 'relation' do
+    #     date 'field_name'
+    #     date :another_field
+    #   end
+    #
+    def date(name, opts = {})
+      @connection.add_column(@arel.name, name, :date, opts)
+    end
+    
+    # 
+    # Define a boolean field.
+    #
+    #   store 'relation' do
+    #     boolean 'field_name'
+    #     boolean :another_field
+    #   end
+    #
+    def boolean(name, opts = {})
+      @connection.add_column(@arel.name, name, :boolean, opts)
+    end
+    
+    # 
+    # Define a float field.
+    #
+    #   store 'relation' do
+    #     float 'field_name'
+    #     float :another_field
+    #   end
+    #
+    def float(name, opts = {})
+      @connection.add_column(@arel.name, name, :float, opts)
+    end   
+  
     #
     # Insert a row from a hash. 
     #
@@ -64,13 +133,11 @@ module DataDoc
       manager.insert(columns.zip(record.values))
       @connection.insert(manager)
     end
-
-  protected
     
     #
     # Create and empty the store unless options prevent. 
     #
-    def create_store(table_name_or_sym, opts = {}, &blk)
+    def create_store(table_name_or_sym, opts = {})
       table_name = table_name_or_sym.to_s 
       @arel = Arel::Table.new(table_name)
       unless @doc.read_only
@@ -80,9 +147,16 @@ module DataDoc
           @connection.create_table(table_name, opts.merge(force: true))
         end
       end
-      self.instance_eval(&blk) if block_given?
-      table_name_or_sym
     end
+    
+    #
+    # Create new.
+    #
+    def initialize(doc)
+      @doc = doc
+      @connection = @doc.connection
+    end
+    
             
   end
   

data/test/test_data_doc_cli.rb

@@ -80,6 +80,14 @@ YAML
         execute_cli("--format", 'html', @filename)
       end
 
+      it "should accept a pdf format option" do
+        execute_cli("--format", 'pdf', @filename)
+      end
+
+      it "should accept a path to prince option" do
+        execute_cli("--prince", '/usr/local/bin/prince', @filename)
+      end
+
       it "should require a format for format option" do
         proc { execute_cli("--format") }.must_raise OptionParser::MissingArgument
       end

data/test/test_data_doc_document.rb

@@ -7,11 +7,19 @@ describe DataDoc::Document do
     @input = ""
     @expected_output = ""
     @expected_rows = nil
+    @expected_matches = Array.new
   end
 
   after do
     output = @doc.generate(StringIO.new(@input))
-    output.strip.must_equal @expected_output.strip
+    output.strip.must_equal @expected_output.strip unless @expected_output.nil?
+    @expected_matches.each do |m|
+      if m.kind_of?(String)
+        output.force_encoding("ASCII-8BIT").scan(m).first.must_equal(m)
+      else
+        output.must_match(m)
+      end
+    end
     unless @expected_rows.nil?
       @doc.connection.select_value("select count(1) from #{@expected_table_name}").must_equal(@expected_rows)
     end
@@ -23,10 +31,28 @@ describe DataDoc::Document do
     @expected_output = ""
   end
   
-  it "should process markdown into html" do
-    @input = '# Introduction'
-    @doc.layout = temp_file('<%= yield %>')
-    @expected_output = '<h1>Introduction</h1>'
+  describe "for a simple document" do
+    
+    before do
+      @input = '# Introduction'
+      @doc.layout = temp_file('<%= yield %>')
+    end
+    
+    it "should process markdown into html" do
+      @expected_output = '<h1>Introduction</h1>'
+    end
+  
+    it "should process markdown into pdf" do
+      @expected_output = nil
+      if system("prince 1> /dev/null 2> /dev/null")
+        @doc.format = 'pdf'
+        @expected_matches.push("%PDF")
+        @doc.layout = temp_file('<%= yield %>')
+      else
+        skip "can't test pdf without prince"
+      end
+    end
+  
   end
   
   describe "layout" do
@@ -51,7 +77,7 @@ describe DataDoc::Document do
     it "should insert meta tags into the head" do
       @input = '<% meta author: "Author" %>'
       @doc.layout = temp_file('<%= yield :head %>')
-      @expected_output = '<meta author="Author">'
+      @expected_output = '<meta author="Author" />'
     end
   
     it "should insert script tags into the head" do
@@ -63,7 +89,7 @@ describe DataDoc::Document do
     it "should insert link tags into the head" do
       @input = '<% link rel: "stylesheet", type: "text/css", href: "mystyle.css" %>'
       @doc.layout = temp_file('<%= yield :head %>')
-      @expected_output = '<link rel="stylesheet" type="text/css" href="mystyle.css">'
+      @expected_output = '<link rel="stylesheet" type="text/css" href="mystyle.css" />'
     end
   
     it "should set the html document title in the head and in a div.title in the content" do
@@ -157,7 +183,16 @@ EOS
     end
     
     it "should present an arel" do
-      @doc.present(@doc.relation.project('*')).must_match(/<table>.*<\/table>/)
+      table = @doc.present(@doc.relation.project('*'))
+      table.must_match(/<table>.*<\/table>/)
+    end
+
+    it "should call a block for table configuration" do
+      table = @doc.present(@doc.relation.project('*')) do
+        caption 'Caption'
+      end
+      table.must_match(/<table>.*<\/table>/)
+      table.must_match(/<caption>Caption<\/caption>/)
     end
     
   end

data/test/test_data_doc_present.rb

@@ -14,5 +14,66 @@ describe DataDoc::Present do
     DataDoc::Present.present(@mock_doc, "select 1").must_match(/<table>.*<\/table>/)
   end
   
+  describe "generating a table" do
+    
+    before do
+      @mock_doc.connection.execute("create table relation (one integer, two varchar)")
+      @mock_doc.connection.insert_sql("insert into relation(one, two) values (1, 'one')")
+      @mock_doc.connection.insert_sql("insert into relation(one, two) values (2, 'two')")
+      @mock_doc.connection.insert_sql("insert into relation(one, two) values (3, 'three')")
+    end
+    
+    describe "for a complex table" do
+      
+      before do
+        @result = DataDoc::Present.present(@mock_doc, "select * from relation") do
+          caption "Caption"
+          label :one, "Renamed"
+          column_order :two, :one, :three
+          each_cell(:two) do |col, row|
+            "two-changed"
+          end
+          calculated(:three) do |col, row|
+            "column-three"
+          end
+        end
+      end
+    
+      it "should accept a caption" do
+        @result.must_match(/<caption>Caption<\/caption>/)
+      end
+
+      it "should rename a field label" do
+        @result.must_match(/<th>Renamed<\/th>/)
+      end
+
+      it "should define the order of columns" do
+        @result.must_match(/<th>Two<\/th><th>Renamed<\/th>/)
+      end
+
+      it "should allow a cell's contents to be programmed" do
+        @result.must_match(/<td>two-changed<\/td>/)
+      end
+
+      it "should allow a calculation for a new column" do
+        @result.must_match(/<td>column-three<\/td>/)
+      end  
+      
+    end
+    
+    describe "for a table with headers" do
+      before do
+        @result = DataDoc::Present.present(@mock_doc, "select * from relation") do
+          no_headers
+        end
+      end
+    
+      it "should suppress headers" do
+        @result.wont_match(/<th>/)
+      end
+    end
+        
+  end
+  
 end
     

data/test/test_data_doc_store.rb

@@ -19,7 +19,7 @@ describe DataDoc::Store do
       end
 
       after do
-        DataDoc::Store.new(@mock_doc, 'relation')
+        DataDoc::Store.store(@mock_doc, 'relation')
         @mock_doc.connection.select_value('select count(1) from relation').must_equal @expected_rows
         if @confirm_old_table_value
           @mock_doc.connection.select_value('select string from relation limit 1').must_equal 'present'
@@ -61,33 +61,60 @@ describe DataDoc::Store do
       end
           
       it "adds a string attribute" do
-        DataDoc::Store.new(@mock_doc, 'relation') do
+        DataDoc::Store.store(@mock_doc, 'relation') do
           string 'string'
         end
         check_insert('string', 'a string')
       end
           
       it "adds an integer attribute" do
-        DataDoc::Store.new(@mock_doc, 'relation') do
+        DataDoc::Store.store(@mock_doc, 'relation') do
           integer 'number'
         end
         check_insert('number', 42)
       end
           
       it "adds a text attribute" do
-        DataDoc::Store.new(@mock_doc, 'relation') do
+        DataDoc::Store.store(@mock_doc, 'relation') do
           text 'description'
         end
         check_insert('description', 'a string')            
       end
           
       it "adds a datetime attribute" do
-        DataDoc::Store.new(@mock_doc, 'relation') do
+        DataDoc::Store.store(@mock_doc, 'relation') do
           datetime 'timestamp'
         end
         check_insert('timestamp', '2012-10-12')
       end
 
+      it "adds a date attribute" do
+        DataDoc::Store.store(@mock_doc, 'relation') do
+          date 'datestamp'
+        end
+        check_insert('datestamp', Date.today)
+      end
+
+      it "adds a time attribute" do
+        DataDoc::Store.store(@mock_doc, 'relation') do
+          time 'timestamp'
+        end
+        check_insert('timestamp', Time.now)
+      end
+
+      it "adds a float attribute" do
+        DataDoc::Store.store(@mock_doc, 'relation') do
+          float 'value'
+        end
+        check_insert('value', 42.234)
+      end
+
+      it "adds a boolean attribute" do
+        DataDoc::Store.store(@mock_doc, 'relation') do
+          boolean 'flag'
+        end
+        check_insert('flag', true)
+      end
     end
 
     describe "alternate keys" do
@@ -98,7 +125,7 @@ describe DataDoc::Store do
   describe "accepting rows" do
           
     before do
-      @store = DataDoc::Store.new(@mock_doc, 'relation') do
+      @store = DataDoc::Store.store(@mock_doc, 'relation') do
         string 's'
         integer 'i'
         text 't'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_doc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
+date: 2012-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -141,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1350312980764895826
+      hash: -3309162244341749974
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: