tn_pdf 0.0.2 → 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 91cb0ad993ddca5fbf6fe2c810cd947e59c5cb3f
+  data.tar.gz: 2aa092c489969b92567973b078b52dd90aac4c4b
+SHA512:
+  metadata.gz: c7e55005eecbf3e0dce9b5997efd57e33a62bb1075921ffddb4639e133175ef00ba3ecbbf9ed554eb5ba7c7ee5cc7ed3d7d59086e82d5c95f57c3c8d5bdf787e
+  data.tar.gz: 92dd019191ee1f274d5ea381ce53feb5ce45ded1816643e6c2f570bbabdde97bc239e55079f97f799a5b8fb9847dd133a766abb8712d24256e10886aed33461d

data/.gitignore

@@ -7,3 +7,6 @@ coverage
 *.gem
 Gemfile.lock
 pkg/*
+doc/
+.yardoc
+*.rbc

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7 || rvm use ree || rvm use default

data/Gemfile

@@ -2,3 +2,6 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in tn_pdf.gemspec
 gemspec
+
+gem 'rake'
+gem 'pry'

data/Gemfile.lock

@@ -1,47 +1,56 @@
+PATH
+  remote: .
+  specs:
+    tn_pdf (0.0.8)
+      backports
+      prawn (~> 0.11.1)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    Ascii85 (1.0.1)
-    ZenTest (4.5.0)
-    activesupport (2.3.5)
-    autotest (4.4.6)
-      ZenTest (>= 4.4.1)
+    Ascii85 (1.0.2)
+    afm (0.2.2)
+    backports (3.6.0)
     coderay (0.9.8)
     diff-lcs (1.1.2)
-    method_source (0.4.1)
+    hashery (2.1.1)
+    method_source (0.6.0)
       ruby_parser (>= 2.0.5)
-    pdf-reader (0.9.2)
-      Ascii85 (>= 0.9)
+    pdf-reader (1.3.3)
+      Ascii85 (~> 1.0.0)
+      afm (~> 0.2.0)
+      hashery (~> 2.0)
+      ruby-rc4
+      ttfunk
     prawn (0.11.1)
       pdf-reader (>= 0.9.0)
       ttfunk (~> 1.0.0)
-    pry (0.8.3)
-      coderay (>= 0.9.7)
-      method_source (>= 0.4.0)
+    pry (0.9.2)
+      coderay (>= 0.9.8)
+      method_source (>= 0.6.0)
       ruby_parser (>= 2.0.5)
-      slop (>= 1.5.3)
-    rcov (0.9.9)
+      slop (~> 1.9.0)
+    rake (0.9.2)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)
       rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.1)
+    rspec-core (2.6.4)
     rspec-expectations (2.6.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
+    ruby-rc4 (0.1.5)
     ruby_parser (2.0.6)
       sexp_processor (~> 3.0)
     sexp_processor (3.0.5)
-    slop (1.6.0)
-    ttfunk (1.0.1)
+    slop (1.9.1)
+    ttfunk (1.0.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport
-  autotest
-  prawn (~> 0.11.1)
   pry
-  rcov
+  rake
   rspec (~> 2.6.0)
+  tn_pdf!

data/Rakefile

@@ -2,11 +2,10 @@ require 'rake'
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
 
 desc "Run all examples with RCov"
-Spec::Rake::SpecTask.new('examples_with_rcov') do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
+RSpec::Core::RakeTask.new('examples_with_rcov') do |t|
   t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec,.bundle']
+  # t.rcov_opts = ['--exclude', 'spec,.bundle']
 end

data/lib/prawn/table_fix.rb

@@ -0,0 +1,11 @@
+module Prawn
+  class Table
+    alias_method :column_widths_broken=, :column_widths=
+
+    def column_widths_fixed=(value)
+      @column_widths = (column_widths_broken = value)
+    end
+
+    alias_method :column_widths=, :column_widths_fixed=
+  end
+end

data/lib/tn_pdf/box.rb

@@ -2,34 +2,38 @@ module TnPDF
   class PageSection
 
     class Box
-      attr_reader :image_path, :image_options
+      attr_reader :image_file, :image_options
       attr_reader :text, :text_options
+      attr_accessor :width
 
       def initialize(options)
         parse_options(options)
       end
 
-      def render(document, pos, width, height=nil)
+      def render(document, pos, height=nil)
         options_hash = { :width => width }
         options_hash[:height] = height unless height.nil?
 
         document.bounding_box(pos, options_hash) do
           if has_image?
-            image_args = [image_path]
+            image_args = [image_file]
             image_args << image_options unless image_options.empty?
             document.image *image_args
           end
 
           if has_text?
             text_args = [text]
-            text_args << text_options unless text_options.empty?
-            document.text *text_args
+            text_options.merge!({:inline_format => true})
+            text_args << text_options
+            document.font(text_options[:font], text_options[:font_options]) do
+              document.text *text_args
+            end
           end
         end
       end
 
       def has_image?
-        !image_path.nil?
+        !image_file.nil?
       end
 
       def has_text?
@@ -39,8 +43,9 @@ module TnPDF
       private
 
       def parse_options(options)
-        options.to_options!
+        options = Configuration.perform_conversions(options)
 
+        self.width = options[:width]
         options[:align]  ||= :justify
         options[:valign] ||= :center
 
@@ -51,19 +56,31 @@ module TnPDF
           options[:text][:align]  = options[:align]
           options[:text][:valign] = options[:valign]
 
+          options[:text][:font] ||= Configuration[:font]
+          options[:text][:font_options] = {}
+          options[:text][:font_options][:size] =
+            options[:text][:font_size] if options[:text][:font_size]
+
+          options[:text][:font_options][:style] =
+            options[:text][:font_style] if options[:text][:font_style]
+
           @text = options[:text][:text]
           @text_options = options[:text].reject { |k,_| k == :text }
         end
 
         if options[:image]
           unless options[:image].kind_of? Hash
-            options[:image] = { :path => options[:image] }
+            options[:image] = { :file => options[:image] }
           end
           options[:image][:position] = options[:align]
           options[:image][:vposition] = options[:valign]
 
-          @image_path = options[:image][:path]
-          @image_options = options[:image].reject { |k,_| k == :path }
+          path = Configuration[:images_path]
+          @image_file = options[:image][:file]
+          unless @image_file =~ /^#{path}/
+            @image_file = File.join(path, @image_file)
+          end
+          @image_options = options[:image].reject { |k,_| k == :file }
         end
       end
 

data/lib/tn_pdf/configuration.rb

@@ -4,27 +4,24 @@ module TnPDF
   class Configuration
     class << self
 
-
       def [](property)
-        property = property.to_s
-        case property
-          when /^page_header_/
-            property_key = property.sub('page_header_','').to_sym
-            header[property_key]
-          when /^page_footer_/
-            property_key = property.sub('page_footer_','').to_sym
-            footer[property_key]
-          when /^table_/
-            property_key = property.sub('table_','').to_sym
-            table[property_key]
-          when /^column_/
-            property_key = property.sub('column_','').to_sym
-            column[property_key]
-          else
-            report[property.to_sym]
+        (hash, key) = filter_property(property)
+        value = hash[key]
+
+        if value.kind_of?(Proc)
+          value.call
+        else
+          value
         end
       end
 
+      def []=(property, value)
+        (hash, key) = filter_property(property)
+        value = perform_conversions(value)
+
+        hash[key] = value
+      end
+
       def report_properties_names
         report.keys
       end
@@ -50,9 +47,31 @@ module TnPDF
 
       def load_from(yaml_file)
         configurations = YAML.load_file(yaml_file)
-        configurations.to_options!
-        configurations.each_key do |item|
-          self.send(item).merge! configurations[item].to_options!
+
+        configurations.each do |item, value|
+          value = perform_conversions(value)
+          self.send(item).merge! value
+        end
+      end
+
+      def perform_conversions(value)
+        match = value.match(/^(\d+\.?\d*)(cm|mm)$/) rescue nil
+        if match
+          num = match[1].to_f
+          conversion = match[2].to_sym
+          num.send(conversion)
+        elsif value.kind_of? Hash
+          value.inject({}) do |hash, (key, value)|
+            hash[key.to_sym] = perform_conversions(value)
+            hash
+          end
+        elsif value.kind_of? Array
+          value.inject([]) do |array, value|
+            array << perform_conversions(value)
+            array
+          end
+        else
+          value
         end
       end
 
@@ -68,6 +87,9 @@ module TnPDF
           :bottom_margin => 0.cm,
           :font => "Courier",
           :font_size => 10,
+          :images_path => "./",
+          :text_before_table => "",
+          :text_after_table => "",
         }
       end
 
@@ -76,6 +98,9 @@ module TnPDF
           :height =>  1.cm,
           :top => 0.5.cm,
           :bottom => 0.2.cm,
+          :left => {},
+          :right => {},
+          :center => {}
         }
       end
 
@@ -85,17 +110,30 @@ module TnPDF
           :height =>  1.cm,
           :top => 0.2.cm,
           :bottom => 0.1.cm,
+          :left => {},
+          :right => {},
+          :center => {}
         }
       end
 
       def table
         @table ||= {
           :align => :center,
+          :text_before => "",
+          :text_after  => "",
           :multipage_headers => true,
-          :borders => false,
+          :font_size => 10,
+          :header_font_style => :bold,
+          :header_font_size => 10,
+          :header_font => 'Courier',
           :header_color => "FF0000",
+          :footer_font_style => :bold,
+          :footer_font_size => 10,
+          :footer_font => 'Courier',
+          :footer_color => "FF0000",
           :odd_row_color => "00FF00",
           :even_row_color => "0000FF",
+          :borders => false,
         }
       end
 
@@ -116,9 +154,33 @@ module TnPDF
                            :decimal => "," },
 
           :text => { :format => "%s",
-                     :align => :left }
+                     :align => :left },
+
+          :right_text => { :format => "%s",
+                     :align => :right },
         }
       end
+
+      def filter_property(property)
+        property = property.to_s
+        case property
+          when /^page_header_/
+            property_key = property.sub('page_header_','').to_sym
+            [header,property_key]
+          when /^page_footer_/
+            property_key = property.sub('page_footer_','').to_sym
+            [footer,property_key]
+          when /^table_/
+            property_key = property.sub('table_','').to_sym
+            [table,property_key]
+          when /^column_/
+            property_key = property.sub('column_','').to_sym
+            [column,property_key]
+          else
+            [report,property.to_sym]
+        end
+      end
+
     end
   end
 end

data/lib/tn_pdf/page_section.rb

@@ -28,7 +28,7 @@ module TnPDF
     end
 
     def boxes
-      [left_box, center_box, right_box].compact
+      [left_box, center_box, right_box]
     end
 
     def top
@@ -42,13 +42,20 @@ module TnPDF
     def render(document, position)
       width ||= document.bounds.width
 
-      box_width = width/(boxes.count)
+      box_width = width/(boxes.compact.count)
 
-      boxes.inject(0) do |offset, box|
-        x_pos = position[0] + offset
-        y_pos = position[1] - top
-        box.render(document, [x_pos, y_pos], box_width, height )
-        offset += box_width
+      boxes.each do |box|
+        box.width ||= box_width
+      end
+
+      boxes_with_positions = [
+        boxes,
+        [position[0], (width-boxes[1].width)/2, width-boxes[2].width],
+        [position[1]-top]*3
+      ].transpose
+
+      boxes_with_positions.each do |box, x_pos, y_pos|
+        box.render(document, [x_pos, y_pos], height )
       end
     end
 

data/lib/tn_pdf/report.rb

@@ -1,6 +1,118 @@
 module TnPDF
+  # @author Renato Zannon
+  # The {TnPDF::Report} class is the easier, best supported and more complete
+  # way to access the TnPDF API. It delegates most of it's work to fellow classes
+  # such as {TnPDF::Table} and {TnPDF::PageSection}, but the delegation
+  # itself and all the necessary setup is made under the hood.
+  # This means that everything the code needs to do is access methods such as
+  # {#record_collection} and {#table_columns}, and then it is forwarded to the
+  # appropriate member.
+  #
+  # For more specific needs, methods such as {#table} and {#page_header}, which
+  # give direct access to the report's members, are provided, so that the user can
+  # make low-level/bleeding edge adjustments without being restricted to this
+  # classe's interface.
+  #
+  # @attr [String] page_size
+  #   The report's page size, in paper sizes such as "A4" and "Letter".
+  #   Supports as much as much paper sizes as Prawn does.
+  #
+  # @attr [Symbol] page_layout
+  #   The resulting pages' layout. Must be :landscape or :portrait
+  #
+  # @attr [Double] left_margin
+  #   Sets the document's left margin. Accepts a Double value, defined in PDF
+  #   points (1/72 inch) or a String "in" cm or mm, such as "1.5cm" and
+  #   "50mm".
+  #
+  # @attr [Double] right_margin
+  #   Sets the document's right margin. Accepts a Double value, defined in PDF
+  #   points (1/72 inch) or a String "in" cm or mm, such as "1.5cm" and
+  #   "50mm".
+  #
+  # @attr [Double] bottom_margin
+  #   Sets the document's bottom margin. Accepts a Double value, defined in PDF
+  #   points (1/72 inch) or a String "in" cm or mm, such as "1.5cm" and
+  #   "50mm".
+  #
+  # @attr [Double] top_margin
+  #   Sets the document's top margin. Accepts a Double value, defined in PDF
+  #   points (1/72 inch) or a String "in" cm or mm, such as "1.5cm" and
+  #   "50mm".
+  #
+  # @attr [String] font
+  #   The default font to be used on the report. The only (currently) supported
+  #   choices are "Helvetica" and "Courier", although Prawn's font embedding
+  #   mechanism is a probable upcoming addition
+  #
+  # @attr [Fixnum] font_size
+  #   The default report font size. In the usual "points" unit.
+  #
+  # @attr [String] images_path
+  #   The path from where we will search for the requested images. Defaults to
+  #   the current path, "./". In a Rails application, for instance, you would
+  #   probably want to set this guy to RAILS_ROOT+"public/images"
+  #
+  # @attr [String, Array] text_before_table
+  #   Some text to be rendered before the report's table. Can be used as some
+  #   kind of prelude/explanation/introduction etc.
+  #   It accepts a normal string, that will be rendered using the settings on
+  #   {#font} and {#font_size}, or an Array containing a String and a Hash,
+  #   the last being an hash of options, as accepted by Prawn's Document#text
+  #   method.
+  #   @example
+  #     report.text_before_table = "Some text"
+  #   @example
+  #     report.text_before_table = ["Some text", :size => 20]
+  #
+  # @attr [String, Array] text_after_table
+  #   Some text to be rendered after the report's table. Can be used as a
+  #   confirmation, a conclusion, an acceptance term etc.
+  #   It accepts a normal string, that will be rendered using the settings on
+  #   {#font} and {#font_size}, or an Array containing a String and a Hash,
+  #   the last being an hash of options, as accepted by Prawn's Document#text
+  #   method.
+  #   @example
+  #     report.text_after_table = "Some text"
+  #   @example
+  #     report.text_after_table = ["Some text", :size => 20]
   class Report
-    attr_reader :page_header, :page_footer, :table, :record_collection
+
+    # The underlying {PageSection} that represents the report pages' headers. Direct
+    # manipulation is disencouraged.
+    # @return [PageSection]
+    attr_reader :page_header
+
+    # The underlying {PageSection} that represents the report pages' footers. Direct
+    # manipulation is disencouraged.
+    # @return [PageSection]
+    attr_reader :page_footer
+
+    # The underlying {Table}. Direct manipulation is disencouraged, except in
+    # cases where fine adjustments are required, or when some (possibly
+    # bleeding-edge) functionality is not implemented on {Report} (yet).
+    # @return [Table]
+    attr_reader :table
+
+    def table
+      @table ||= Table.new(document)
+    end
+
+    # The underlying {Table}'s collection of objects. Each of these objects
+    # will be represented as a table row, by the application of the procedures
+    # described using {#table_columns=}. The order in which this property and
+    # {#table_columns} are called isn't an issue, as soon as *both* are set
+    # before {#render} is called.
+    # @return [Array]
+    attr_accessor :record_collection
+
+    def record_collection=(collection)
+      unless collection.kind_of? Array
+        raise ArgumentError, "collection should be an Array!"
+      end
+      @record_collection = table.collection = collection
+    end
+
     attr_accessor *Configuration.report_properties_names
 
     def initialize(properties = {})
@@ -39,24 +151,40 @@ module TnPDF
       forward_property("table", property)
     end
 
-    def record_collection=(collection)
-      unless collection.kind_of? Array
-        raise ArgumentError, "collection should be an Array!"
-      end
-      @record_collection = table.collection = collection
-    end
-
+    # The underlying {Table}'s collection of columns. Refer to
+    # {Table#add_column} for reference on the Array's structure.
+    # @return [Array]
     def table_columns
       table.columns || Array.new
     end
 
+    # Forwards the received arguments to {Table}. Refer to {Table#add_column}
+    # for a reference on the valid structure.
+    # Be advised that calling this method *resets* the columns set previously,
+    # insted of just adding new ones.
+    # @param [Array] columns An Array of elements as accepted by {Table#add_column}
+    # @raise [ArgumentError] When the argument isn't an Array
     def table_columns=(columns)
       raise ArgumentError unless columns.kind_of? Array
+      table.reset_columns
       columns.each do |column|
         table.add_column column
       end
     end
 
+    # Forwards the arguments to the underlying {Table}. Refer to
+    # {Table#add_footer Table#add_footer} for a full description of the
+    # required syntax
+    def add_table_footer(row=nil, &block)
+      table.add_footer(row, &block)
+    end
+
+    # Renders the report on filename. This method also calls render on the
+    # report's members - {#table}, {#page_header} and {#page_footer} - which means
+    # that, on a straightforward report, the process is reduced to set up {#table_columns}
+    # and {#record_collection}, and then calling {#render}. This alone already does all the
+    # trick to generate the PDF.
+    # @param [String, IO] filename The file on which the report will render
     def render(filename)
       document_width = document.bounds.width
       page_header_position = [0, document.cursor]
@@ -71,9 +199,10 @@ module TnPDF
       end
 
       table_height = page_body_height
-      document.bounding_box([0, page_body_height+page_footer.total_height],
+
+      document.bounding_box([0, document.cursor],
                             :width  => document.bounds.width) do
-        table.render(document, table_height)
+        table.render(table_height)
       end
 
       document.repeat :all do
@@ -83,21 +212,15 @@ module TnPDF
       document.render_file filename
     end
 
-    def page_body_height
-      height  = document.bounds.height
-      height -= page_header.total_height
-      height -= page_footer.total_height
-    end
-
+    # The underlying {Prawn::Document}. Direct manipulation is highly
+    # disencouraged, except for querying information.
+    # @return [Prawn::Document]
+    attr_reader :document
     def document
       @document ||= Prawn::Document.new(properties)
     end
 
-    def table
-      @table ||= Table.new
-    end
-
-    # Configurable properties
+    private
 
     def properties
       Configuration.report_properties_names.inject({}) do |properties_hash, property|
@@ -106,7 +229,11 @@ module TnPDF
       end
     end
 
-    private
+    def page_body_height
+      height  = document.bounds.height
+      height -= page_header.total_height
+      height -= page_footer.total_height
+    end
 
     def initialize_properties(properties)
       owned_properties  = Configuration.report_properties_names