report 0.0.1 → 0.0.2

data/CHANGELOG

@@ -0,0 +1,16 @@
+0.0.2 / 2012-07-04
+
+* Bug fixes
+
+  * Properly handle true and false values in pdf and xlsx
+
+* Enhancements
+
+  * More sensible default spacing, font size, and page margins for pdf output
+  * If a column is named "Did you really see it?", try #Did_you_really_see_it? and #did_you_really_see_it? (previously we lost ? and ! characters)
+  * If a "body.rows" method yields instead of just returning an enumerable, re-yield it
+  * If a column block takes 2 args (arity = 2), pass it report and row obj. This is useful when each row is calculated using (1) the row object and (2) something defined only on the report instance itself.
+
+0.0.1 / 2012-07-04
+
+Initial release!

data/lib/report.rb

@@ -20,7 +20,9 @@ class Report
     attr_accessor :xlsx_format
 
     def table(table_name, &blk)
-      tables << Table.new(table_name, &blk)
+      t = Table.new table_name
+      t.instance_eval(&blk)
+      tables << t
     end
 
     def format_pdf(hsh)

data/lib/report/body.rb

@@ -1,31 +1,43 @@
 require 'report/body/column'
 require 'report/body/row'
-require 'report/body/rows'
 
 class Report
   class Body
     attr_reader :table
     attr_reader :columns
-    def initialize(table, &blk)
+    attr_reader :method_id
+    attr_reader :method_args
+    def initialize(table)
       @table = table
       @columns = []
-      instance_eval(&blk)
     end
     def rows(*args)
-      @rows = Rows.new(*([self]+args))
+      @method_id = args.shift
+      if args.last.is_a?(Array)
+        @method_args = args.last
+      end
     end
     def column(*args, &blk)
       @columns << Column.new(*([self]+args), &blk)
     end
     def each(report)
-      @rows.each(report) do |obj|
-        yield Row.new(self, obj)
+      block_taken = false
+      if method_args
+        enum = report.send(method_id, *method_args) do |obj|
+          block_taken = true
+          yield Row.new(self, report, obj)
+        end
+      else
+        enum = report.send(method_id) do |obj|
+          block_taken = true
+          yield Row.new(self, report, obj)
+        end
+      end
+      unless block_taken
+        enum.each do |obj|
+          yield Row.new(self, report, obj)
+        end
       end
-    end
-    def to_a(report)
-      a = []
-      each(report) { |row| a << row.to_a }
-      a
     end
   end
 end

data/lib/report/body/column.rb

@@ -4,12 +4,12 @@ class Report
       attr_reader :body
       attr_reader :name
       attr_reader :method_id
-      attr_reader :proc
+      attr_reader :blk
       attr_reader :faded
       attr_reader :row_options
-      def initialize(*args, &proc)
+      def initialize(*args, &blk)
         if block_given?
-          @proc = proc
+          @blk = blk
         end
         @body = args.shift
         @name = args.shift
@@ -18,9 +18,16 @@ class Report
         @faded = options.delete(:faded)
         @row_options = options
       end
-      def read(obj)
-        if @proc
-          obj.instance_eval(&@proc)
+      def read(report, obj)
+        if blk
+          case blk.arity
+          when 0
+            obj.instance_eval(&blk)
+          when 2
+            blk.call report, obj
+          else
+            raise "column block should have 0 or 2 arguments"
+          end
         elsif method_id
           obj.send method_id
         elsif from_name = guesses.detect { |m| obj.respond_to?(m) }
@@ -29,8 +36,8 @@ class Report
           raise "#{obj.inspect} does not respond to any of #{guesses.inspect}"
         end
       end
-      def read_with_options(obj)
-        v = read obj
+      def read_with_options(report, obj)
+        v = read report, obj
         f = case faded
         when Symbol
           obj.send faded
@@ -41,7 +48,10 @@ class Report
       end
       private
       def guesses
-        [ name, name.underscore.gsub(/\W/, '_') ]
+        [
+          name.gsub(' ', '_'),
+          name.underscore.gsub(/[^\w\!\?]/, '_')
+        ]
       end
     end
   end

data/lib/report/body/row.rb

@@ -3,16 +3,18 @@ class Report
     class Row
       attr_reader :body
       attr_reader :obj
-      def initialize(body, obj)
+      attr_reader :report
+      def initialize(body, report, obj)
         @body = body
+        @report = report
         @obj = obj
       end
       def to_a
-        body.columns.map { |column| column.read(obj) }
+        body.columns.map { |column| column.read(report, obj) }
       end
       def to_hash
         body.columns.map do |column|
-          column.read_with_options obj
+          column.read_with_options report, obj
         end
       end
     end

data/lib/report/head.rb

@@ -1,25 +1,30 @@
-require 'report/head/row'
-
 class Report
   class Head
     attr_reader :table
-    def initialize(table, &blk)
+    def initialize(table)
       @table = table
       @rows = []
-      instance_eval(&blk)
     end
     def row(*cells)
-      @rows << Row.new(self, cells)
+      @rows << cells
     end
     def each(report)
       @rows.each do |row|
-        yield row.read(report)
+        actual = row.map do |cell|
+          case cell
+          when String
+            cell
+          when Symbol
+            unless report.respond_to?(cell)
+              raise "#{report.inspect} doesn't respond to #{cell.inspect}"
+            end
+            report.send cell
+          else
+            raise "must pass String or Symbol to head row"
+          end
+        end
+        yield actual
       end
     end
-    def to_a(report)
-      a = []
-      each(report) { |row| a << row.to_a }
-      a
-    end
   end
 end

data/lib/report/pdf.rb

@@ -9,7 +9,7 @@ class Report
       :bold_italic => File.expand_path('../pdf/DejaVuSansMono-BoldOblique.ttf', __FILE__),
     }
     DEFAULT_DOCUMENT = {
-      :top_margin => 118,
+      :top_margin => 72,
       :right_margin => 36,
       :bottom_margin => 72,
       :left_margin => 36,
@@ -40,19 +40,23 @@ class Report
       Prawn::Document.generate(tmp_path, document) do |pdf|
         
         pdf.font_families.update(font_name => font)
-        pdf.font font_name
+        pdf.font font_name, :size => 10
 
+        first = true
         report.class.tables.each do |table|
-          if table._head and (t = table._head.to_a(report)).length > 0
-            pdf.table(t, head)
+          if first
+            first = false
+          else
+            pdf.move_down 20
+          end
+          if t = make(table._head)
+            pdf.table t, head
+            pdf.move_down 20
           end
-
-          pdf.move_down 20
           pdf.text table.name, :style => :bold
-          pdf.move_down 10
-
-          if table._body and (t = table._body.to_a(report)).length > 0
-            pdf.table(t, body)
+          if t = make(table._body)
+            pdf.move_down 10
+            pdf.table t, body
           end
         end
 
@@ -71,6 +75,23 @@ class Report
 
     private
 
+    def make(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
+      end
+      memo if memo.length > 0
+    end
+
     def font_name
       'MainFont'
     end

data/lib/report/table.rb

@@ -1,15 +1,18 @@
 class Report
   class Table
     attr_reader :name
-    def initialize(name, &blk)
+    def initialize(name)
       @name = name
-      instance_eval(&blk)
     end
     def body(&blk)
-      @body = Body.new(self, &blk)
+      b = Body.new self
+      b.instance_eval(&blk)
+      @body = b
     end
     def head(&blk)
-      @head = Head.new(self, &blk)
+      h = Head.new self
+      h.instance_eval(&blk)
+      @head = h
     end
     def _head
       @head

data/lib/report/version.rb

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

data/report.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.version       = Report::VERSION
 
   gem.add_runtime_dependency 'activesupport'
-  gem.add_runtime_dependency 'xlsx_writer'
+  gem.add_runtime_dependency 'xlsx_writer', '>=0.2.2'
   gem.add_runtime_dependency 'prawn'
   gem.add_runtime_dependency 'posix-spawn'
 

data/spec/report_spec.rb

@@ -6,14 +6,14 @@ require 'remote_table'
 require 'unix_utils'
 require 'posix/spawn'
 
-class Translation < Struct.new(:language, :translation)
+class Translation < Struct.new(:language, :content)
   class << self
     def all
       [ new('English', 'Hello'), new('Russian', 'Здравствуйте') ]
     end
   end
   def backward
-    translation.reverse
+    content.reverse
   end
 end
 
@@ -29,7 +29,7 @@ class A2 < Report
     body do
       rows :translations
       column 'Language'
-      column 'Translation'
+      column 'Content'
     end
   end
   def translations
@@ -44,7 +44,7 @@ class A3 < Report
     body do
       rows :translations
       column 'Language'
-      column 'Translation'
+      column 'Content'
     end
   end
   def description
@@ -59,7 +59,7 @@ class A4 < Report
     body do
       rows :translations
       column 'Language'
-      column 'Forward', :translation
+      column 'Forward', :content
       column 'Backward'
     end
   end
@@ -72,14 +72,14 @@ class A5 < Report
     body do
       rows :translations, ['English']
       column 'Language'
-      column 'Translation'
+      column 'Content'
     end
   end
   table 'InRussian' do
     body do
       rows :translations, ['Russian']
       column 'Language'
-      column 'Translation'
+      column 'Content'
     end
   end
   def translations(language)
@@ -91,8 +91,8 @@ class A6 < Report
     body do
       rows :translations
       column 'Language'
-      column('Forward') { translation }
-      column('Backward') { translation.reverse }
+      column('Forward') { content }
+      column('Backward') { content.reverse }
     end
   end
   def translations
@@ -112,6 +112,33 @@ class A7 < Report
     end
   end
 end
+class A8 < Report
+  table 'A8' do
+    body do
+      rows :translations
+      column 'Language'
+      column('ClassForward') { |report, translation| [report.class.name, translation.content].join }
+      column('ClassBackward') { |report, translation| [report.class.name.reverse, translation.content.reverse].join }
+    end
+  end
+  def translations
+    Translation.all
+  end
+end
+class A9 < Report
+  table 'MemorySafe' do
+    body do
+      rows :translations
+      column 'Language'
+      column 'Content'
+    end
+  end
+  def translations
+    Translation.all.each do |translation|
+      yield translation
+    end
+  end
+end
 class Numero < Struct.new(:d_e_c_i_m_a_l, :m_o_n_e_y)
   class << self
     def all
@@ -159,6 +186,27 @@ class B2 < Report
     Numero.all
   end
 end
+class Witness < Struct.new(:really_saw_it)
+  class << self
+    def all
+      [ new(true), new(false) ]
+    end
+  end
+  def did_you_really_see_it?
+    !!really_saw_it
+  end
+end
+class C1 < Report
+  table 'C1' do
+    body do
+      rows :witnesses
+      column 'Did you really see it?'
+    end
+  end
+  def witnesses
+    Witness.all
+  end
+end
 
 describe Report do
   describe '#csv' do
@@ -169,9 +217,9 @@ describe Report do
     it "constructs a body out of rows and columns" do
       how_to_say_hello = ::CSV.read A2.new.csv.paths.first, :headers => :first_row
       how_to_say_hello[0]['Language'].should == 'English'
-      how_to_say_hello[0]['Translation'].should == 'Hello'
+      how_to_say_hello[0]['Content'].should == 'Hello'
       how_to_say_hello[1]['Language'].should == 'Russian'
-      how_to_say_hello[1]['Translation'].should == 'Здравствуйте'
+      how_to_say_hello[1]['Content'].should == 'Здравствуйте'
     end
     it "puts a blank row between head and body" do
       transl_with_head = ::CSV.read A3.new.csv.paths.first, :headers => false
@@ -196,13 +244,13 @@ describe Report do
       en = ::CSV.read en_path, :headers => :first_row
       en.length.should == 1
       en[0]['Language'].should == 'English'
-      en[0]['Translation'].should == 'Hello'
+      en[0]['Content'].should == 'Hello'
       ru = ::CSV.read ru_path, :headers => :first_row
       ru.length.should == 1
       ru[0]['Language'].should == 'Russian'
-      ru[0]['Translation'].should == 'Здравствуйте'
+      ru[0]['Content'].should == 'Здравствуйте'
     end
-    it "instance-evals column blocks against row objects" do
+    it "instance-evals column blocks against row objects if arity is 0" do
       t = ::CSV.read A6.new.csv.paths.first, :headers => :first_row
       en = t[0]
       ru = t[1]
@@ -213,6 +261,29 @@ describe Report do
       ru['Forward'].should == 'Здравствуйте'
       ru['Backward'].should == 'Здравствуйте'.reverse
     end
+    it "calls column blocks with |report, row_obj| if arity == 2" do
+      t = ::CSV.read A8.new.csv.paths.first, :headers => :first_row
+      en = t[0]
+      ru = t[1]
+      en['Language'].should == 'English'
+      en['ClassForward'].should == 'A8Hello'
+      en['ClassBackward'].should == ['A8'.reverse, 'Hello'.reverse].join
+      ru['Language'].should == 'Russian'
+      ru['ClassForward'].should == 'A8Здравствуйте'
+      ru['ClassBackward'].should == ['A8'.reverse, 'Здравствуйте'.reverse].join
+    end
+    it "can have row objects yield to it one by one" do
+      how_to_say_hello = ::CSV.read A9.new.csv.paths.first, :headers => :first_row
+      how_to_say_hello[0]['Language'].should == 'English'
+      how_to_say_hello[0]['Content'].should == 'Hello'
+      how_to_say_hello[1]['Language'].should == 'Russian'
+      how_to_say_hello[1]['Content'].should == 'Здравствуйте'
+    end
+    it "treats ? and ! as valid method characters" do
+      t = ::CSV.read C1.new.csv.paths.first, :headers => :first_row
+      t[0]['Did you really see it?'].should == 'true'
+      t[1]['Did you really see it?'].should == 'false'
+    end
   end
 
   describe '#xlsx' do
@@ -223,9 +294,9 @@ describe Report do
     it "constructs a body out of rows and columns" do
       how_to_say_hello = RemoteTable.new A2.new.xlsx.path, :headers => :first_row
       how_to_say_hello[0]['Language'].should == 'English'
-      how_to_say_hello[0]['Translation'].should == 'Hello'
+      how_to_say_hello[0]['Content'].should == 'Hello'
       how_to_say_hello[1]['Language'].should == 'Russian'
-      how_to_say_hello[1]['Translation'].should == 'Здравствуйте'
+      how_to_say_hello[1]['Content'].should == 'Здравствуйте'
     end
     it "puts a blank row between head and body" do
       transl_with_head = RemoteTable.new A3.new.xlsx.path, :headers => false, :keep_blank_rows => true
@@ -250,11 +321,11 @@ describe Report do
       en = RemoteTable.new(path, :headers => :first_row, :sheet => 'InEnglish').to_a
       en.length.should == 1
       en[0]['Language'].should == 'English'
-      en[0]['Translation'].should == 'Hello'
+      en[0]['Content'].should == 'Hello'
       ru = RemoteTable.new(path, :headers => :first_row, :sheet => 'InRussian').to_a
       ru.length.should == 1
       ru[0]['Language'].should == 'Russian'
-      ru[0]['Translation'].should == 'Здравствуйте'
+      ru[0]['Content'].should == 'Здравствуйте'
     end
     it "instance-evals column blocks against row objects" do
       t = RemoteTable.new A6.new.xlsx.path, :headers => :first_row
@@ -267,6 +338,13 @@ describe Report do
       ru['Forward'].should == 'Здравствуйте'
       ru['Backward'].should == 'Здравствуйте'.reverse
     end
+    it "can have row objects yield to it one by one" do
+      how_to_say_hello = RemoteTable.new A9.new.xlsx.path, :headers => :first_row
+      how_to_say_hello[0]['Language'].should == 'English'
+      how_to_say_hello[0]['Content'].should == 'Hello'
+      how_to_say_hello[1]['Language'].should == 'Russian'
+      how_to_say_hello[1]['Content'].should == 'Здравствуйте'
+    end
     it "accepts a formatter that works on the raw XlsxWriter::Document" do
       path = A7.new.xlsx.path
       dir = UnixUtils.unzip path
@@ -290,6 +368,12 @@ describe Report do
       FileUtils.rm_f path
       FileUtils.rm_rf dir
     end
+    it "treats ? and ! as valid method characters" do
+      path = C1.new.xlsx.path
+      t = RemoteTable.new path, :headers => :first_row
+      t[0]['Did you really see it?'].should == 'TRUE'
+      t[1]['Did you really see it?'].should == 'FALSE'
+    end
   end
 
   describe '#pdf' do
@@ -350,11 +434,27 @@ describe Report do
       stdout_utf8.should include('Здравствуйте')
       stdout_utf8.should include('Здравствуйте'.reverse)
     end
+    it "can have row objects yield to it one by one" do
+      t = A9.new.pdf.path
+      child = POSIX::Spawn::Child.new('pdftotext', t, '-')
+      stdout_utf8 = child.out.force_encoding('UTF-8')
+      stdout_utf8.should include('English')
+      stdout_utf8.should include('Hello')
+      stdout_utf8.should include('Russian')
+      stdout_utf8.should include('Здравствуйте')
+    end
     it "accepts pdf formatting options, including the ability to stamp with pdftk" do
       path = B2.new.pdf.path
       child = POSIX::Spawn::Child.new('pdftotext', path, '-')
       stdout_utf8 = child.out.force_encoding('UTF-8')
       stdout_utf8.should include('Firefox')
     end
+    it "treats ? and ! as valid method characters" do
+      t = C1.new.pdf.path
+      child = POSIX::Spawn::Child.new('pdftotext', t, '-')
+      stdout_utf8 = child.out.force_encoding('UTF-8')
+      stdout_utf8.should include('true')
+      stdout_utf8.should include('false')
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: report
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-04 00:00:00.000000000 Z
+date: 2012-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: prawn
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +149,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .yardopts
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
@@ -158,13 +159,11 @@ files:
 - lib/report/body.rb
 - lib/report/body/column.rb
 - lib/report/body/row.rb
-- lib/report/body/rows.rb
 - lib/report/csv.rb
 - lib/report/csv/table.rb
 - lib/report/filename.rb
 - lib/report/formatter.rb
 - lib/report/head.rb
-- lib/report/head/row.rb
 - lib/report/pdf.rb
 - lib/report/pdf/DejaVuSansMono-Bold.ttf
 - lib/report/pdf/DejaVuSansMono-BoldOblique.ttf

data/lib/report/body/rows.rb

@@ -1,21 +0,0 @@
-class Report
-  class Body
-    class Rows
-      attr_reader :body
-      attr_accessor :method_id
-      attr_accessor :args
-      def initialize(*args)
-        @body = args.shift
-        @method_id = args.shift
-        if args.last.is_a?(Array)
-          @args = args.last
-        end
-      end
-      def each(report, &blk)
-        (args ? report.send(method_id, *args) : report.send(method_id)).each do |obj|
-          blk.call obj
-        end
-      end
-    end
-  end
-end

data/lib/report/head/row.rb

@@ -1,27 +0,0 @@
-class Report
-  class Head
-    class Row
-      attr_reader :head
-      attr_reader :cells
-      def initialize(head, cells)
-        @head = head
-        @cells = cells
-      end
-      def read(report)
-        cells.map do |cell|
-          case cell
-          when String
-            cell
-          when Symbol
-            unless report.respond_to?(cell)
-              raise "#{report.inspect} doesn't respond to #{cell.inspect}"
-            end
-            report.send cell
-          else
-            raise "must pass String or Symbol to head row"
-          end
-        end
-      end
-    end
-  end
-end