report 0.0.2 → 0.0.3

data/CHANGELOG

@@ -1,3 +1,13 @@
+0.0.3 / 2012-07-06
+
+* Bug fixes
+
+  * Show column names on table bodies in pdf format
+
+* Enhancements
+
+  * Provide Report#cleanup to remove tmp files
+
 0.0.2 / 2012-07-04
 
 * Bug fixes

data/lib/report.rb

@@ -50,4 +50,10 @@ class Report
   def pdf
     @pdf ||= Pdf.new self
   end
+
+  def cleanup
+    @csv.try :cleanup
+    @xlsx.try :cleanup
+    @pdf.try :cleanup
+  end
 end

data/lib/report/csv.rb

@@ -11,6 +11,9 @@ class Report
     def paths
       tables.map { |table| table.path }
     end
+    def cleanup
+      tables.each { |table| table.cleanup }
+    end
     private
     def tables
       @tables ||= report.class.tables.map do |report_table|

data/lib/report/csv/table.rb

@@ -21,6 +21,9 @@ class Report
         end
         @path = tmp_path
       end
+      def cleanup
+        safe_delete @path if @path
+      end
     end
   end
 end

data/lib/report/pdf.rb

@@ -49,12 +49,12 @@ class Report
           else
             pdf.move_down 20
           end
-          if t = make(table._head)
+          if t = make_head(table._head)
             pdf.table t, head
             pdf.move_down 20
           end
           pdf.text table.name, :style => :bold
-          if t = make(table._body)
+          if t = make_body(table._body)
             pdf.move_down 10
             pdf.table t, body
           end
@@ -73,25 +73,42 @@ class Report
       @path = tmp_path
     end
 
+    def cleanup
+      safe_delete @path if @path
+    end
+
     private
 
-    def make(src)
+    def make_head(src)
       return unless src
       memo = []
       src.each(report) do |row|
-        converted = row.to_a.map do |cell|
-          case cell
-          when TrueClass, FalseClass
-            cell.to_s
-          else
-            cell
-          end
-        end
-        memo << converted
+        memo << convert_row(row)
+      end
+      memo if memo.length > 0
+    end
+
+    def make_body(src)
+      return unless src
+      memo = []
+      memo << src.columns.map(&:name)
+      src.each(report) do |row|
+        memo << convert_row(row)
       end
       memo if memo.length > 0
     end
 
+    def convert_row(row)
+      row.to_a.map do |cell|
+        case cell
+        when TrueClass, FalseClass
+          cell.to_s
+        else
+          cell
+        end
+      end
+    end
+
     def font_name
       'MainFont'
     end

data/lib/report/utils.rb

@@ -1,8 +1,9 @@
 require 'tmpdir'
+require 'fileutils'
 
 class Report
+  # stolen from https://github.com/seamusabshere/unix_utils
   module Utils
-    # stolen from https://github.com/seamusabshere/unix_utils
     def tmp_path(options = {})
       ancestor = [ self.class.name, options[:hint] ].compact.join('_')
       extname = options.fetch(:extname, '.tmp')
@@ -11,5 +12,13 @@ class Report
       time = Time.now.strftime('%H%M%S%L')
       File.join Dir.tmpdir, [time, '_', basename[0..(234-extname.length)], extname].join
     end
+
+    def safe_delete(path)
+      path = File.expand_path path
+      unless File.dirname(path).start_with?(Dir.tmpdir)
+        raise "Refusing to rm -rf #{path} because it's not in #{Dir.tmpdir}"
+      end
+      FileUtils.rm_rf path
+    end
   end
 end

data/lib/report/version.rb

@@ -1,3 +1,3 @@
 class Report
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/report/xlsx.rb

@@ -3,10 +3,13 @@ require 'fileutils'
 class Report
   class Xlsx
     include Utils
+    
     attr_reader :report
+    
     def initialize(report)
       @report = report
     end
+
     def path
       return @path if defined?(@path)
       require 'xlsx_writer'
@@ -38,6 +41,11 @@ class Report
       workbook.cleanup
       @path = tmp_path
     end
+
+    def cleanup
+      safe_delete @path if @path
+    end
+
     private
     def calculate_autofilter(table, cursor)
       [ 'A', cursor, ':', XlsxWriter::Cell.excel_column_letter(table._body.columns.length-1), cursor ].join

data/spec/report_spec.rb

@@ -209,6 +209,21 @@ class C1 < Report
 end
 
 describe Report do
+  it "cleans up if asked" do
+    r = A1.new
+    mess = []
+    mess += r.csv.paths
+    mess << r.xlsx.path
+    mess << r.pdf.path
+    mess.each do |path|
+      File.exist?(path).should == true
+    end
+    r.cleanup
+    mess.each do |path|
+      File.exist?(path).should == false
+    end
+  end
+
   describe '#csv' do
     it "writes each table to a separate file" do
       hello = ::CSV.read A1.new.csv.paths.first
@@ -383,10 +398,12 @@ describe Report do
       stdout_utf8 = child.out.force_encoding('UTF-8')
       stdout_utf8.should include('World')
     end
-    it "constructs a body out of rows and columns" do
+    it "constructs a body out of head rows and body rows and column names" do
       how_to_say_hello = A2.new.pdf.path
       child = POSIX::Spawn::Child.new('pdftotext', how_to_say_hello, '-')
       stdout_utf8 = child.out.force_encoding('UTF-8')
+      stdout_utf8.should include('Language')
+      stdout_utf8.should include('Content')
       stdout_utf8.should include('English')
       stdout_utf8.should include('Hello')
       stdout_utf8.should include('Russian')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: report
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-05 00:00:00.000000000 Z
+date: 2012-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport