prawn 1.1.0 → 1.2.1

data/lib/prawn/table/cell/image.rb

@@ -1,69 +0,0 @@
-# encoding: utf-8
-
-# image.rb: Table image cells.
-#
-# Copyright September 2010, Brad Ediger. All Rights Reserved.
-#
-# This is free software. Please see the LICENSE and COPYING files for details.
-module Prawn
-  class Table
-    class Cell
-
-      # @private
-      class Image < Cell
-
-        def initialize(pdf, point, options={})
-          @image_options = {}
-          super
-
-          @pdf_object, @image_info = @pdf.build_image_object(@file)
-          @natural_width, @natural_height = @image_info.calc_image_dimensions(
-            @image_options)
-        end
-
-        def image=(file)
-          @file = file
-        end
-
-        def scale=(s)
-          @image_options[:scale] = s
-        end
-
-        def fit=(f)
-          @image_options[:fit] = f
-        end
-
-        def image_height=(h)
-          @image_options[:height] = h
-        end
-
-        def image_width=(w)
-          @image_options[:width] = w
-        end
-
-        def position=(p)
-          @image_options[:position] = p
-        end
-
-        def vposition=(vp)
-          @image_options[:vposition] = vp
-        end
-
-        def natural_content_width
-          @natural_width
-        end
-
-        def natural_content_height
-          @natural_height
-        end
-
-        # Draw the image on the page.
-        #
-        def draw_content
-          @pdf.embed_image(@pdf_object, @image_info, @image_options)
-        end
-
-      end
-    end
-  end
-end

data/lib/prawn/table/cell/in_table.rb

@@ -1,33 +0,0 @@
-# encoding: utf-8
-
-# Accessors for using a Cell inside a Table.
-#
-# Contributed by Brad Ediger.
-#
-# This is free software. Please see the LICENSE and COPYING files for details.
-
-module Prawn
-  class Table
-
-    class Cell
-
-      # This module extends Cell objects when they are used in a table (as
-      # opposed to standalone). Its properties apply to cells-in-tables but not
-      # cells themselves.
-      #
-      # @private
-      module InTable
-
-        # Row number (0-based).
-        #
-        attr_accessor :row
-
-        # Column number (0-based).
-        #
-        attr_accessor :column
-
-      end
-
-    end
-  end
-end

data/lib/prawn/table/cell/span_dummy.rb

@@ -1,93 +0,0 @@
-# encoding: utf-8
-
-# span_dummy.rb: Placeholder for non-master spanned cells.
-#
-# Copyright December 2011, Brad Ediger. All Rights Reserved.
-#
-# This is free software. Please see the LICENSE and COPYING files for details.
-module Prawn
-  class Table
-    class Cell
-
-      # A Cell object used to represent all but the topmost cell in a span
-      # group.
-      #
-      # @private
-      class SpanDummy < Cell
-        def initialize(pdf, master_cell)
-          super(pdf, [0, pdf.cursor])
-          @master_cell = master_cell
-          @padding = [0, 0, 0, 0]
-        end
-
-        # By default, a span dummy will never increase the height demand.
-        #
-        def natural_content_height
-          0
-        end
-
-        # By default, a span dummy will never increase the width demand.
-        #
-        def natural_content_width
-          0
-        end
-
-        def avg_spanned_min_width
-          @master_cell.avg_spanned_min_width
-        end
-
-        # Dummy cells have nothing to draw.
-        #
-        def draw_borders(pt)
-        end
-
-        # Dummy cells have nothing to draw.
-        #
-        def draw_bounded_content(pt)
-        end
-
-        def padding_right=(val)
-          @master_cell.padding_right = val if rightmost?
-        end
-
-        def padding_bottom=(val)
-          @master_cell.padding_bottom = val if bottommost?
-        end
-
-        def border_right_color=(val)
-          @master_cell.border_right_color = val if rightmost?
-        end
-
-        def border_bottom_color=(val)
-          @master_cell.border_bottom_color = val if bottommost?
-        end
-
-        def border_right_width=(val)
-          @master_cell.border_right_width = val if rightmost?
-        end
-
-        def border_bottom_width=(val)
-          @master_cell.border_bottom_width = val if bottommost?
-        end
-
-        def background_color
-          @master_cell.background_color
-        end
-
-        private
-
-        # Are we on the right border of the span?
-        #
-        def rightmost?
-          @column == @master_cell.column + @master_cell.colspan - 1
-        end
-
-        # Are we on the bottom border of the span?
-        #
-        def bottommost?
-          @row == @master_cell.row + @master_cell.rowspan - 1
-        end
-      end
-    end
-  end
-end

data/lib/prawn/table/cell/subtable.rb

@@ -1,66 +0,0 @@
-# encoding: utf-8
-
-# subtable.rb: Yo dawg.
-#
-# Copyright January 2010, Brad Ediger. All Rights Reserved.
-#
-# This is free software. Please see the LICENSE and COPYING files for details.
-module Prawn
-  class Table
-    class Cell
-
-      # A Cell that contains another table.
-      #
-      # @private
-      class Subtable < Cell
-
-        attr_reader :subtable
-
-        def initialize(pdf, point, options={})
-          super
-          @subtable = options[:content]
-
-          # Subtable padding defaults to zero
-          @padding = [0, 0, 0, 0]
-        end
-
-        # Sets the text color of the entire subtable.
-        #
-        def text_color=(color)
-          @subtable.cells.text_color = color
-        end
-
-        # Proxied to subtable.
-        #
-        def natural_content_width
-          @subtable.cells.width
-        end
-
-        # Proxied to subtable.
-        #
-        def min_width
-          @subtable.cells.min_width
-        end
-
-        # Proxied to subtable.
-        #
-        def max_width
-          @subtable.cells.max_width
-        end
-
-        # Proxied to subtable.
-        #
-        def natural_content_height
-          @subtable.cells.height
-        end
-
-        # Draws the subtable.
-        #
-        def draw_content
-          @subtable.draw
-        end
-
-      end
-    end
-  end
-end

data/lib/prawn/table/cell/text.rb

@@ -1,154 +0,0 @@
-# encoding: utf-8
-
-# text.rb: Text table cells.
-#
-# Copyright December 2009, Gregory Brown and Brad Ediger. All Rights Reserved.
-#
-# This is free software. Please see the LICENSE and COPYING files for details.
-module Prawn
-  class Table
-    class Cell
-
-      # A Cell that contains text. Has some limited options to set font family,
-      # size, and style.
-      #
-      # @private
-      class Text < Cell
-
-        TextOptions = [:inline_format, :kerning, :size, :align, :valign,
-          :rotate, :rotate_around, :leading, :single_line, :skip_encoding,
-          :overflow, :min_font_size]
-
-        TextOptions.each do |option|
-          define_method("#{option}=") { |v| @text_options[option] = v }
-          define_method(option) { @text_options[option] }
-        end
-
-        attr_writer :font, :text_color
-
-        def initialize(pdf, point, options={})
-          @text_options = {}
-          super
-        end
-
-        # Returns the font that will be used to draw this cell.
-        #
-        def font
-          with_font { @pdf.font }
-        end
-
-        # Sets the style of the font in use. Equivalent to the Text::Box
-        # +style+ option, but we already have a style method.
-        #
-        def font_style=(style)
-          @text_options[:style] = style
-        end
-
-        # Returns the width of this text with no wrapping. This will be far off
-        # from the final width if the text is long.
-        #
-        def natural_content_width
-          @natural_content_width ||= [styled_width_of(@content), @pdf.bounds.width].min
-        end
-
-        # Returns the natural height of this block of text, wrapped to the
-        # preset width.
-        #
-        def natural_content_height
-          with_font do
-            b = text_box(:width => spanned_content_width + FPTolerance)
-            b.render(:dry_run => true)
-            b.height + b.line_gap
-          end
-        end
-
-        # Draws the text content into its bounding box.
-        #
-        def draw_content
-          with_font do
-            @pdf.move_down((@pdf.font.line_gap + @pdf.font.descender)/2)
-            with_text_color do
-              text_box(:width => spanned_content_width + FPTolerance,
-                       :height => spanned_content_height + FPTolerance,
-                       :at => [0, @pdf.cursor]).render
-            end
-          end
-        end
-
-        def set_width_constraints
-          # Sets a reasonable minimum width. If the cell has any content, make
-          # sure we have enough width to be at least one character wide. This is
-          # a bit of a hack, but it should work well enough.
-          unless defined?(@min_width) && @min_width
-            min_content_width = [natural_content_width, styled_width_of_single_character].min
-            @min_width = padding_left + padding_right + min_content_width
-            super
-          end
-        end
-
-        protected
-
-        def with_font
-          @pdf.save_font do
-            options = {}
-            options[:style] = @text_options[:style] if @text_options[:style]
-            options[:style] ||= @pdf.font.options[:style] if @pdf.font.options[:style]
-
-            @pdf.font(defined?(@font) && @font || @pdf.font.family, options)
-
-            yield
-          end
-        end
-
-        def with_text_color
-          if defined?(@text_color) && @text_color
-            begin
-              old_color = @pdf.fill_color || '000000'
-              @pdf.fill_color(@text_color)
-              yield
-            ensure
-              @pdf.fill_color(old_color)
-            end
-          else
-            yield
-          end
-        end
-
-        def text_box(extra_options={})
-          if p = @text_options[:inline_format]
-            p = [] unless p.is_a?(Array)
-            options = @text_options.dup
-            options.delete(:inline_format)
-            options.merge!(extra_options)
-            options[:document] = @pdf
-
-            array = @pdf.text_formatter.format(@content, *p)
-            ::Prawn::Text::Formatted::Box.new(array,
-              options.merge(extra_options).merge(:document => @pdf))
-          else
-            ::Prawn::Text::Box.new(@content, @text_options.merge(extra_options).
-               merge(:document => @pdf))
-          end
-        end
-
-        # Returns the width of +text+ under the given text options.
-        #
-        def styled_width_of(text)
-          @pdf.width_of(text, @text_options)
-        end
-
-        private
-
-        # Returns the greatest possible width of any single character
-        #   under the given text options.
-        # (We use this to determine the minimum width of a table cell)
-        # (Although we currently determine this by measuring "M", it should really
-        #   use whichever character is widest under the current font)
-        #
-        def styled_width_of_single_character
-          styled_width_of("M")
-        end
-      end
-    end
-  end
-end

data/lib/prawn/table/cells.rb

@@ -1,255 +0,0 @@
-# encoding: utf-8
-
-# cells.rb: Methods for accessing rows, columns, and cells of a Prawn::Table.
-#
-# Copyright December 2009, Brad Ediger. All Rights Reserved.
-#
-# This is free software. Please see the LICENSE and COPYING files for details.
-
-module Prawn
-  class Table
-    # Selects the given rows (0-based) for styling. Returns a Cells object --
-    # see the documentation on Cells for things you can do with cells.
-    #
-    def rows(row_spec)
-      cells.rows(row_spec)
-    end
-    alias_method :row, :rows
-
-    # Selects the given columns (0-based) for styling. Returns a Cells object
-    # -- see the documentation on Cells for things you can do with cells.
-    #
-    def columns(col_spec)
-      cells.columns(col_spec)
-    end
-    alias_method :column, :columns
-
-    # Represents a selection of cells to be styled. Operations on a CellProxy
-    # can be chained, and cell properties can be set one-for-all on the proxy.
-    #
-    # To set vertical borders only:
-    #
-    #   table.cells.borders = [:left, :right]
-    #
-    # To highlight a rectangular area of the table:
-    #
-    #   table.rows(1..3).columns(2..4).background_color = 'ff0000'
-    #
-    class Cells < Array
-
-      # @group Experimental API
-
-      # Limits selection to the given row or rows. +row_spec+ can be anything
-      # that responds to the === operator selecting a set of 0-based row
-      # numbers; most commonly a number or a range.
-      #
-      #   table.row(0)     # selects first row
-      #   table.rows(3..4) # selects rows four and five
-      #
-      def rows(row_spec)
-        index_cells unless defined?(@indexed) && @indexed
-        row_spec = transform_spec(row_spec, @first_row, @row_count)
-        Cells.new(@rows[row_spec] ||= select { |c|
-                    row_spec.respond_to?(:include?) ?
-                      row_spec.include?(c.row) : row_spec === c.row })
-      end
-      alias_method :row, :rows
-
-      # Returns the number of rows in the list.
-      #
-      def row_count
-        index_cells unless defined?(@indexed) && @indexed
-        @row_count
-      end
-
-      # Limits selection to the given column or columns. +col_spec+ can be
-      # anything that responds to the === operator selecting a set of 0-based
-      # column numbers; most commonly a number or a range.
-      #
-      #   table.column(0)     # selects first column
-      #   table.columns(3..4) # selects columns four and five
-      #
-      def columns(col_spec)
-        index_cells unless defined?(@indexed) && @indexed
-        col_spec = transform_spec(col_spec, @first_column, @column_count)
-        Cells.new(@columns[col_spec] ||= select { |c|
-                    col_spec.respond_to?(:include?) ?
-                      col_spec.include?(c.column) : col_spec === c.column })
-      end
-      alias_method :column, :columns
-
-      # Returns the number of columns in the list.
-      #
-      def column_count
-        index_cells unless defined?(@indexed) && @indexed
-        @column_count
-      end
-
-      # Allows you to filter the given cells by arbitrary properties.
-      #
-      #   table.column(4).filter { |cell| cell.content =~ /Yes/ }.
-      #     background_color = '00ff00'
-      #
-      def filter(&block)
-        Cells.new(select(&block))
-      end
-
-      # Retrieves a cell based on its 0-based row and column. Returns an
-      # individual Cell, not a Cells collection.
-      #
-      #   table.cells[0, 0].content # => "First cell content"
-      #
-      def [](row, col)
-        return nil if empty?
-        index_cells unless defined?(@indexed) && @indexed
-        row_array, col_array = @rows[@first_row + row] || [], @columns[@first_column + col] || []
-        if row_array.length < col_array.length
-          row_array.find { |c| c.column == @first_column + col }
-        else
-          col_array.find { |c| c.row == @first_row + row }
-        end
-      end
-
-      # Puts a cell in the collection at the given position. Internal use only.
-      #
-      def []=(row, col, cell) # :nodoc:
-        cell.extend(Cell::InTable)
-        cell.row = row
-        cell.column = col
-
-        if defined?(@indexed) && @indexed
-          (@rows[row]    ||= []) << cell
-          (@columns[col] ||= []) << cell
-          @first_row    = row if !@first_row    || row < @first_row
-          @first_column = col if !@first_column || col < @first_column
-          @row_count    = @rows.size
-          @column_count = @columns.size
-        end
-
-        self << cell
-      end
-
-      # Supports setting multiple properties at once.
-      #
-      #   table.cells.style(:padding => 0, :border_width => 2)
-      #
-      # is the same as:
-      #
-      #   table.cells.padding = 0
-      #   table.cells.border_width = 2
-      #
-      # You can also pass a block, which will be called for each cell in turn.
-      # This allows you to set more complicated properties:
-      #
-      #   table.cells.style { |cell| cell.border_width += 12 }
-      #
-      def style(options={}, &block)
-        each do |cell|
-          next if cell.is_a?(Cell::SpanDummy)
-          cell.style(options, &block)
-        end
-      end
-
-      # Returns the total width of all columns in the selected set.
-      #
-      def width
-        widths = {}
-        each do |cell|
-          per_cell_width = cell.width_ignoring_span.to_f / cell.colspan
-          cell.colspan.times do |n|
-            widths[cell.column+n] = [widths[cell.column+n], per_cell_width].
-              compact.max
-          end
-        end
-        widths.values.inject(0, &:+)
-      end
-
-      # Returns minimum width required to contain cells in the set.
-      #
-      def min_width
-        aggregate_cell_values(:column, :avg_spanned_min_width, :max)
-      end
-
-      # Returns maximum width that can contain cells in the set.
-      #
-      def max_width
-        aggregate_cell_values(:column, :max_width_ignoring_span, :max)
-      end
-
-      # Returns the total height of all rows in the selected set.
-      #
-      def height
-        aggregate_cell_values(:row, :height_ignoring_span, :max)
-      end
-
-      # Supports setting arbitrary properties on a group of cells.
-      #
-      #   table.cells.row(3..6).background_color = 'cc0000'
-      #
-      def method_missing(id, *args, &block)
-        if id.to_s =~ /=\z/
-          each { |c| c.send(id, *args, &block) if c.respond_to?(id) }
-        else
-          super
-        end
-      end
-
-      protected
-
-      # Defers indexing until rows() or columns() is actually called on the
-      # Cells object. Without this, we would needlessly index the leaf nodes of
-      # the object graph, the ones that are only there to be iterated over.
-      #
-      # Make sure to call this before using @rows or @columns.
-      #
-      def index_cells
-        @rows = {}
-        @columns = {}
-
-        each do |cell|
-          @rows[cell.row] ||= []
-          @rows[cell.row] << cell
-
-          @columns[cell.column] ||= []
-          @columns[cell.column] << cell
-        end
-
-        @first_row    = @rows.keys.min
-        @first_column = @columns.keys.min
-
-        @row_count    = @rows.size
-        @column_count = @columns.size
-
-        @indexed = true
-      end
-
-      # Sum up a min/max value over rows or columns in the cells selected.
-      # Takes the min/max (per +aggregate+) of the result of sending +meth+ to
-      # each cell, grouped by +row_or_column+.
-      #
-      def aggregate_cell_values(row_or_column, meth, aggregate)
-        ColumnWidthCalculator.new(self).aggregate_cell_values(row_or_column, meth, aggregate)
-      end
-
-      # Transforms +spec+, a column / row specification, into an object that
-      # can be compared against a row or column number using ===. Normalizes
-      # negative indices to be positive, given a total size of +total+. The
-      # first row/column is indicated by +first+; this value is considered row
-      # or column 0.
-      #
-      def transform_spec(spec, first, total)
-        case spec
-        when Range
-          transform_spec(spec.begin, first, total) ..
-            transform_spec(spec.end, first, total)
-        when Integer
-          spec < 0 ? (first + total + spec) : first + spec
-        when Enumerable
-          spec.map { |x| first + x }
-        else # pass through
-          raise "Don't understand spec #{spec.inspect}"
-        end
-      end
-    end
-  end
-end