ruport 1.6.3 → 1.8.0

data/test/html_formatter_test.rb

@@ -1,8 +1,8 @@
-#!/usr/bin/env ruby -w  
+#!/usr/bin/env ruby -w
 require File.join(File.expand_path(File.dirname(__FILE__)), "helpers")
 
-class TestRenderHTMLTable < Test::Unit::TestCase
-  
+class TestRenderHTMLTable < Minitest::Test
+
   def setup
     Ruport::Formatter::Template.create(:simple) do |format|
       format.table = {
@@ -14,7 +14,7 @@ class TestRenderHTMLTable < Test::Unit::TestCase
       }
     end
   end
-  
+
   def test_html_table
     a = Ruport::Formatter::HTML.new
 
@@ -23,34 +23,34 @@ class TestRenderHTMLTable < Test::Unit::TestCase
   end
 
   def test_render_html_basic
-    
+
     actual = Ruport::Controller::Table.render_html { |r|
-      r.data = Table([], :data => [[1,2,3],[4,5,6]])
-    }          
-    
+      r.data = Ruport.Table([], :data => [[1,2,3],[4,5,6]])
+    }
+
     assert_equal("\t<table>\n\t\t<tr>\n\t\t\t<td>1</td>\n\t\t\t<td>2"+
                  "</td>\n\t\t\t<td>3</td>\n\t\t</tr>\n\t\t<tr>\n\t\t"+
                  "\t<td>4</td>\n\t\t\t<td>5</td>\n\t\t\t<td>6</td>\n\t"+
                  "\t</tr>\n\t</table>\n",actual)
 
-    actual = Ruport::Controller::Table.render_html { |r| 
-      r.data = Table(%w[a b c], :data => [ [1,2,3],[4,5,6]]) 
+    actual = Ruport::Controller::Table.render_html { |r|
+      r.data = Ruport.Table(%w[a b c], :data => [ [1,2,3],[4,5,6]])
     }
-    
-    assert_equal("\t<table>\n\t\t<tr>\n\t\t\t<th>a</th>\n\t\t\t<th>b</th>"+
-      "\n\t\t\t<th>c</th>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>1</td>"+
+
+    assert_equal("\t<table>\n\t\t<thead>\n\t\t<tr>\n\t\t\t<th>a</th>\n\t\t\t<th>b</th>"+
+      "\n\t\t\t<th>c</th>\n\t\t</tr>\n\t\t</thead>\n\t\t<tr>\n\t\t\t<td>1</td>"+
       "\n\t\t\t<td>2</td>\n\t\t\t<td>3</td>\n\t\t</tr>\n\t\t<tr>"+
       "\n\t\t\t<td>4</td>\n\t\t\t<td>5</td>\n\t\t\t<td>6</td>\n\t"+
-      "\t</tr>\n\t</table>\n",actual)   
-    
+      "\t</tr>\n\t</table>\n",actual)
+
   end
-  
+
   def test_render_with_template
     formatter = Ruport::Formatter::HTML.new
     formatter.options = Ruport::Controller::Options.new
     formatter.options.template = :simple
     formatter.apply_template
-    
+
     assert_equal false, formatter.options.show_table_headers
 
     assert_equal :justified, formatter.options.style
@@ -59,7 +59,7 @@ class TestRenderHTMLTable < Test::Unit::TestCase
 
   def test_options_hashes_override_template
     opts = nil
-    table = Table(%w[a b c])
+    table = Ruport.Table(%w[a b c])
     table.to_html(
       :template => :simple,
       :table_format => {
@@ -72,7 +72,7 @@ class TestRenderHTMLTable < Test::Unit::TestCase
     ) do |r|
       opts = r.options
     end
-    
+
     assert_equal true, opts.show_table_headers
 
     assert_equal :inline, opts.style
@@ -81,7 +81,7 @@ class TestRenderHTMLTable < Test::Unit::TestCase
 
   def test_individual_options_override_template
     opts = nil
-    table = Table(%w[a b c])
+    table = Ruport.Table(%w[a b c])
     table.to_html(
       :template => :simple,
       :show_table_headers => true,
@@ -90,35 +90,35 @@ class TestRenderHTMLTable < Test::Unit::TestCase
     ) do |r|
       opts = r.options
     end
-    
+
     assert_equal true, opts.show_table_headers
 
     assert_equal :inline, opts.style
     assert_equal true, opts.show_group_headers
   end
 end
-   
 
-class TestRenderHTMLRow < Test::Unit::TestCase
-  
+
+class TestRenderHTMLRow < Minitest::Test
+
   def test_render_html_row
     actual = Ruport::Controller::Row.render_html { |r| r.data = [1,2,3] }
     assert_equal("\t\t<tr>\n\t\t\t<td>1</td>\n\t\t\t<td>2"+
                  "</td>\n\t\t\t<td>3</td>\n\t\t</tr>\n",actual)
   end
 end
-   
 
-class TestRenderHTMLGroup < Test::Unit::TestCase
-    
+
+class TestRenderHTMLGroup < Minitest::Test
+
   def test_render_html_group
     group = Ruport::Data::Group.new(:name => 'test',
                                     :data => [[1,2,3],[4,5,6]],
                                     :column_names => %w[a b c])
     actual = Ruport::Controller::Group.render(:html, :data => group)
     assert_equal "\t<p>test</p>\n"+
-      "\t<table>\n\t\t<tr>\n\t\t\t<th>a</th>\n\t\t\t<th>b</th>"+
-      "\n\t\t\t<th>c</th>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>1</td>"+
+      "\t<table>\n\t\t<thead>\n\t\t<tr>\n\t\t\t<th>a</th>\n\t\t\t<th>b</th>"+
+      "\n\t\t\t<th>c</th>\n\t\t</tr>\n\t\t</thead>\n\t\t<tr>\n\t\t\t<td>1</td>"+
       "\n\t\t\t<td>2</td>\n\t\t\t<td>3</td>\n\t\t</tr>\n\t\t<tr>"+
       "\n\t\t\t<td>4</td>\n\t\t\t<td>5</td>\n\t\t\t<td>6</td>\n\t"+
       "\t</tr>\n\t</table>\n", actual
@@ -134,14 +134,14 @@ class TestRenderHTMLGroup < Test::Unit::TestCase
       "\n\t\t\t<td>2</td>\n\t\t\t<td>3</td>\n\t\t</tr>\n\t\t<tr>"+
       "\n\t\t\t<td>4</td>\n\t\t\t<td>5</td>\n\t\t\t<td>6</td>\n\t"+
       "\t</tr>\n\t</table>\n", actual
-  end                                           
+  end
 end
 
 
-class TestRenderHTMLGrouping < Test::Unit::TestCase
+class TestRenderHTMLGrouping < Minitest::Test
 
   def test_render_html_grouping
-    table = Table(%w[a b c]) << [1,2,3] << [1,1,3] << [2,7,9]
+    table = Ruport.Table(%w[a b c]) << [1,2,3] << [1,1,3] << [2,7,9]
     g = Grouping(table,:by => "a")
     actual = Ruport::Controller::Grouping.render(:html, :data => g,
                                                :show_table_headers => false)
@@ -153,27 +153,27 @@ class TestRenderHTMLGrouping < Test::Unit::TestCase
   end
 
   def test_render_html_grouping_with_table_headers
-    table = Table(%w[a b c]) << [1,2,3] << [1,1,3] << [2,7,9]
+    table = Ruport.Table(%w[a b c]) << [1,2,3] << [1,1,3] << [2,7,9]
     g = Grouping(table,:by => "a")
     actual = Ruport::Controller::Grouping.render(:html, :data => g)
 
-    assert_equal "\t<p>1</p>\n\t<table>\n\t\t<tr>\n\t\t\t<th>b</th>\n"+
-                 "\t\t\t<th>c</th>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>"+
+    assert_equal "\t<p>1</p>\n\t<table>\n\t\t<thead>\n\t\t<tr>\n\t\t\t<th>b</th>\n"+
+                 "\t\t\t<th>c</th>\n\t\t</tr>\n\t\t</thead>\n\t\t<tr>\n\t\t\t<td>"+
                  "2</td>\n\t\t\t<td>3</td>\n\t\t</tr>\n\t\t<tr>\n\t\t"+
                  "\t<td>1</td>\n\t\t\t<td>3</td>\n\t\t</tr>\n\t</table>\n\n"+
-                 "\t<p>2</p>\n\t<table>\n\t\t<tr>\n\t\t\t<th>b</th>\n\t\t"+
-                 "\t<th>c</th>\n\t\t</tr>\n\t\t<tr>\n\t\t\t<td>7</td>\n"+
+                 "\t<p>2</p>\n\t<table>\n\t\t<thead>\n\t\t<tr>\n\t\t\t<th>b</th>\n\t\t"+
+                 "\t<th>c</th>\n\t\t</tr>\n\t\t</thead>\n\t\t<tr>\n\t\t\t<td>7</td>\n"+
                  "\t\t\t<td>9</td>\n\t\t</tr>\n\t</table>\n\n", actual
   end
 
   def test_render_justified_html_grouping
-    table = Table(%w[a b c]) << [1,2,3] << [1,1,3] << [2,7,9]
+    table = Ruport.Table(%w[a b c]) << [1,2,3] << [1,1,3] << [2,7,9]
     g = Grouping(table,:by => "a")
     actual = Ruport::Controller::Grouping.render(:html, :data => g,
                                                :style => :justified)
 
-    assert_equal "\t<table>\n\t\t<tr>\n\t\t\t<th>a</th>\n\t\t\t<th>b</th>\n"+
-                 "\t\t\t<th>c</th>\n\t\t</tr>\n\t\t<tr>\n\t\t\t"+
+    assert_equal "\t<table>\n\t\t<thead>\n\t\t<tr>\n\t\t\t<th>a</th>\n\t\t\t<th>b</th>\n"+
+                 "\t\t\t<th>c</th>\n\t\t</tr>\n\t\t</thead>\n\t\t<tr>\n\t\t\t"+
                  "<td class=\"groupName\">1</td>\n\t\t\t<td>"+
                  "2</td>\n\t\t\t<td>3</td>\n\t\t</tr>\n\t\t<tr>\n\t\t\t"+
                  "<td>&nbsp;</td>\n\t\t\t<td>1</td>\n\t\t\t<td>3</td>"+
@@ -181,21 +181,21 @@ class TestRenderHTMLGrouping < Test::Unit::TestCase
                  "<td class=\"groupName\">2</td>\n\t\t\t<td>7</td>\n"+
                  "\t\t\t<td>9</td>\n\t\t</tr>\n\t</table>\n", actual
   end
-end  
-     
+end
 
-class TestHTMLFormatterHelpers < Test::Unit::TestCase
+
+class TestHTMLFormatterHelpers < Minitest::Test
   begin
     require "rubygems"
   rescue LoadError
     nil
   end
-  
-  def test_textile     
+
+  def test_textile
     require "redcloth"
     a = Ruport::Formatter::HTML.new
     assert_equal "<p><strong>foo</strong></p>", a.textile("*foo*")
   rescue LoadError
-    STDERR.puts "Skipping textile test... needs redcloth"
+    STDERR.puts "Skipping textile test... needs RedCloth gem"
   end
 end

data/test/markdown_formatter_test.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "helpers")
+
+class TestRenderMarkdownTable < Minitest::Test
+  def test_render_markdown_table_basic
+    actual = Ruport::Controller::Table.render_markdown do |r|
+      r.data = Ruport::Table([:foo, :bar, :baz], data: [[1, 2, 3], [], [4, 5], [6]])
+    end
+
+    assert_equal([
+      "|foo|bar|baz|\n",
+      "|:--|:--|:--|\n",
+      "|1|2|3|\n",
+      "||||\n",
+      "|4|5||\n",
+      "|6|||\n"
+    ].join, actual)
+  end
+
+  def test_render_markdown_table_without_column_names
+    actual = Ruport::Controller::Table.render_markdown do |r|
+      r.data = Ruport::Table(data: [[:foo, :bar], [1, 2], [3, 4]])
+    end
+
+    assert_equal([
+      "|foo|bar|\n",
+      "|:--|:--|\n",
+      "|1|2|\n",
+      "|3|4|\n",
+    ].join, actual)
+
+    actual = Ruport::Controller::Table.render_markdown do |r|
+      r.data = Ruport::Table([], data: [[:foo, :bar], [1, 2], [3, 4]])
+    end
+
+    assert_equal([
+      "|foo|bar|\n",
+      "|:--|:--|\n",
+      "|1|2|\n",
+      "|3|4|\n",
+    ].join, actual)
+  end
+
+  def test_escape_virtical_bar
+    actual = Ruport::Controller::Table.render_markdown do |r|
+      r.data = Ruport::Table([:foo], data: [['foo0|foo1']])
+    end
+
+    assert_equal([
+      "|foo|\n",
+      "|:--|\n",
+      "|foo0&#124;foo1|\n"
+    ].join, actual)
+  end
+
+  def test_escape_newline_code
+    actual = Ruport::Controller::Table.render_markdown do |r|
+      r.data = Ruport::Table([:foo], data: [["foo0\nfoo1"]])
+    end
+
+    assert_equal([
+      "|foo|\n",
+      "|:--|\n",
+      "|foo0<br>foo1|\n"
+    ].join, actual)
+  end
+
+  def test_alignment_option
+    actual = Ruport::Controller::Table.render_markdown(alignment: :left) do |r|
+      r.data = Ruport::Table([:foo, :bar], data: [[1, 2], [3, 4]])
+    end
+
+    assert_equal([
+      "|foo|bar|\n",
+      "|:--|:--|\n",
+      "|1|2|\n",
+      "|3|4|\n"
+    ].join, actual)
+
+    actual = Ruport::Controller::Table.render_markdown(alignment: :center) do |r|
+      r.data = Ruport::Table([:foo, :bar], data: [[1, 2], [3, 4]])
+    end
+
+    assert_equal([
+      "|foo|bar|\n",
+      "|:-:|:-:|\n",
+      "|1|2|\n",
+      "|3|4|\n"
+    ].join, actual)
+
+    actual = Ruport::Controller::Table.render_markdown(alignment: :right) do |r|
+      r.data = Ruport::Table([:foo, :bar], data: [[1, 2], [3, 4]])
+    end
+
+    assert_equal([
+      "|foo|bar|\n",
+      "|--:|--:|\n",
+      "|1|2|\n",
+      "|3|4|\n"
+    ].join, actual)
+  end
+
+  def test_column_alignments_option
+    actual = Ruport::Controller::Table.render_markdown(
+      column_alignments: { foo: :left, bar: :right, baz: :center }
+    ) do |r|
+      r.data = Ruport::Table([:foo, :bar, :baz, :qux], data: [[1, 2, 3, 4], [5, 6, 7, 8]])
+    end
+
+    assert_equal([
+      "|foo|bar|baz|qux|\n",
+      "|:--|--:|:-:|:--|\n",
+      "|1|2|3|4|\n",
+      "|5|6|7|8|\n"
+    ].join, actual)
+  end
+
+  def test_options_hash_override_template
+    Ruport::Formatter::Template.create(:a_template) do |format|
+      format.table = {
+        alignment: :center,
+        column_alignments: { foo: :right }
+      }
+    end
+
+    actual = Ruport::Controller::Table.render_markdown(
+      template: :a_template,
+      alignment: :right,
+      column_alignments: { foo: :left, bar: :center }
+    ) do |r|
+      r.data = Ruport::Table([:foo, :bar, :baz], data: [[1, 2, 3], [4, 5, 6]])
+    end
+
+    assert_equal([
+      "|foo|bar|baz|\n",
+      "|:--|:-:|--:|\n",
+      "|1|2|3|\n",
+      "|4|5|6|\n"
+    ].join, actual)
+  end
+end

data/test/prawn_pdf_formatter_test.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby -w
+
+require_relative 'helpers'
+
+class TestRenderPDFTable < Minitest::Test
+
+  def setup
+    Ruport::Formatter::Template.create(:simple) do |format|
+      format.page = {
+        size:    "LETTER",
+        layout:  :landscape
+      }
+      format.text = {
+        font_size:  16
+      }
+      format.table = {
+        show_headings:   false
+      }
+      format.column = {
+        alignment:   :center,
+        width:       50
+      }
+      format.heading = {
+        alignment:   :right,
+        bold:        false,
+        title:       "Test"
+      }
+      format.grouping = {
+        style:  :separated
+      }
+    end
+  end
+
+  def test_render_pdf_errors
+    # can't render without column names
+    data = Ruport.Table([], data:  [[1,2],[3,4]])
+    assert_raises(Ruport::FormatterError) do
+      data.to_prawn_pdf
+    end
+
+    data.column_names = %w[a b]
+
+    data.to_prawn_pdf
+  end
+
+  def test_render_pdf_basic
+    expected_output = IO.binread(File.join(__dir__, 'expected_outputs/prawn_pdf_formatter/pdf_basic.pdf.test')).bytes
+
+    data = Ruport.Table(%w[a b c], data: [[1,2,3]])
+    # debugging:
+    # data.to_prawn_pdf(:file => File.join(__dir__, 'expected_outputs/prawn_pdf_formatter/pdf_actual.pdf.test'))
+    actual_output = data.to_prawn_pdf.bytes
+
+    assert_equal expected_output, actual_output
+  end
+
+  # this is mostly to check that the transaction hack gets called
+  def test_relatively_large_pdf
+     table = Ruport.Table(File.join(File.expand_path(File.dirname(__FILE__)), "../test/",
+                   %w[samples dates.csv]))
+     table.reduce(0..99)
+     table.to_prawn_pdf
+  end
+
+  #--------BUG TRAPS--------#
+
+  # PDF::SimpleTable does not handle symbols as column names
+  # Ruport should smartly fix this surprising behaviour (#283)
+  def test_tables_should_render_with_symbol_column_name
+    data = Ruport.Table([:a,:b,:c], data:  [[1,2,3],[4,5,6]])
+    data.to_prawn_pdf
+  end
+
+end
+
+class TestRenderPDFGrouping < Minitest::Test
+
+  #--------BUG TRAPS----------#
+
+  def test_grouping_should_have_consistent_font_size
+    a = Ruport.Table(%w[a b c]) <<  %w[eye like chicken] << %w[eye like liver] <<
+                               %w[meow mix meow ] << %w[mix please deliver ]
+    b = Grouping(a, by:  "a")
+    splat = b.to_prawn_pdf.split("\n")
+    splat.grep(/meow/).each do |m|
+      assert_equal '10.0', m.split[5]
+    end
+    splat.grep(/mix/).each do |m|
+      assert_equal '10.0', m.split[5]
+    end
+    splat.grep(/eye/).each do |m|
+      assert_equal '10.0', m.split[5]
+    end
+  end
+
+end
+
+class TestPDFFormatterHelpers < Minitest::Test
+
+  def test_move_up
+    a = Ruport::Formatter::PrawnPDF.new
+    a.move_cursor_to(500)
+    a.move_up(50)
+    assert_equal(550,a.cursor)
+    a.move_down(100)
+    assert_equal(450,a.cursor)
+  end
+end