prawn-graph 0.0.4 → 0.9.0

data/lib/prawn/graph/base.rb

@@ -1,231 +0,0 @@
-module Prawn
-  module Chart
-    
-    # Prawn::Chart::Base implements the common methods shared by most of the graphs
-    # and charts whcih will need to be plotted. 
-    #
-    # All Prawn::Chart::Base instances and their children will have the following
-    # associated with them:
-    #
-    #   1. A Prawn::Chart::Grid  which is where the graph will be drawn
-    #   2. A refernce to the Prawn::Document being affected
-    #   3. A set of data to be plotted.
-    #
-    # A public draw method is available which does what it says on the tin and... 
-    # well.. draws the graph on the document it has a reference to.
-    #
-    class Base
-      
-      attr_accessor :grid, :headings, :values, :highest_value, :document, :colour
-      
-      # Returns a new instance of a graph to be drawn, really only useful for the
-      # subclasses which actually have a plot_values method declared so the data
-      # is actually rendered as a graph.
-      #
-      # Takes an Array of +data+, which should contain complete rows of data for
-      # values to be plotted; a reference to a +document+ which should be an 
-      # instance of Prawn::Document and an +options+ with at least a value for :at
-      # specified.
-      #
-      # Options are:
-      #
-      #  :at , which should be an Array representing the point at which the graph
-      #  should be drawn.
-      #
-      #  :title, the title for this graph, wil be rendered centered to the top of 
-      #  the Grid.
-      #
-      #  :label_x, a label to be shown along the X axis of he graph, rendered centered
-      #  on the grid.
-      #
-      #  :label_y, a label to be shown along the Y axis of he graph, rendered centered
-      #  on the grid and rotated to be perpendicular to the axis.
-      #
-      # :theme, the theme to be used to draw this graph, defaults to monochrome.
-      #
-      def initialize(data, document, options = {})
-        if options[:at].nil? || options[:at].empty?
-          raise Prawn::Errors::NoGraphStartSet,
-            "you must specify options[:at] as the coordinates where you" +
-            " wish this graph to be drawn from."
-        end
-        opts = { :theme => Prawn::Chart::Themes.monochrome, :width => 500, :height => 200, :spacing => 20 }.merge(options)
-        (@headings, @values, @highest_value) = process_the data
-        (grid_x_start, grid_y_start, grid_width, grid_height) = parse_sizing_from opts 
-        @colour = (!opts[:use_color].nil? || !opts[:use_colour].nil?)
-        @document = document
-        @theme = opts[:theme]
-        off = 20
-        @grid = Prawn::Chart::Grid.new(grid_x_start, grid_y_start, grid_width, grid_height, opts[:spacing], document, @theme)
-      end
-  
-      # Draws the graph on the document which we have a reference to.
-      #
-      def draw
-        draw_bounding_box
-        @grid.draw
-        label_axes
-        if @title
-          draw_title
-        end
-        plot_values
-        if @x_label
-          draw_x_axis_label
-        end 
-        if @y_label
-          draw_y_axis_label
-        end 
-       reset
-      end
-
-      private
-
-      def draw_bounding_box
-        @document.fill_color @theme.background_colour
-        @document.fill_and_stroke_rectangle [(@point.first - 10), (@point.last + ( @total_height + 40 ))], @document.bounds.width, (@total_height + 40)
-        @document.fill_color '000000'
-      end   
- 
-      def label_axes
-        @document.fill_color @theme.font_colour
-        base_x = @grid.start_x + 1
-        base_y = @grid.start_y + 1
-
-        # Put the values up the Y Axis
-        #
-        @document.draw_text @highest_value, :at => [base_x - 15, base_y + @grid.height], :size => 5
-        @document.draw_text '0', :at => [base_x - 15, base_y ], :size => 5
-    
-        # Put the column headings along the X Axis
-        #
-        point_spacing = calculate_plot_spacing 
-        last_position = base_x + (point_spacing / 2)
-        @headings.each do |heading|
-          @document.draw_text heading, :at => [last_position, base_y - 15 ], :size => 5
-          last_position += point_spacing
-        end
-        @document.fill_color @theme.background_colour
-      end
-
-      def draw_title
-        @document.fill_color @theme.font_colour
-        x_coord = calculate_x_axis_center_point(@title, 10)
-        y_coord = @grid.start_y + @grid.height + 10
-        @document.draw_text @title, :at => [x_coord, y_coord] ,:size => 10
-        @document.fill_color @theme.background_colour
-      end
-
-      def draw_x_axis_label
-        @document.fill_color @theme.font_colour
-        x_coord = calculate_x_axis_center_point(@x_label, 8)
-        y_coord = @grid.start_y - 30
-        @document.draw_text @x_label, :at => [x_coord, y_coord] ,:size => 8
-        @document.fill_color @theme.background_colour
-      end
-
-      def draw_y_axis_label
-        @document.fill_color @theme.font_colour
-        y_coord = calculate_y_axis_center_point(@y_label, 8)
-        x_coord = @grid.start_x - 30
-        @document.draw_text @y_label, :at => [x_coord, y_coord] ,:size => 8, :rotate => 90
-        @document.fill_color @theme.background_colour
-      end
-      
-      # All subclasses of Prawn::Chart::Base must implement thier own plot_values
-      # method, which does the actual real heavy lifting of drawing the graph.
-      #
-      def plot_values
-        raise Prawn::Errors::NoPlotValuesMethod, 'subclasses of Prawn::Chart::Base must implement '
-                                              +  'their own plot_values method.'
-      end
-
-      def reset
-        @document.line_width 1
-        @document.stroke_color '000000'
-        @document.fill_color '000000'
-        @document.move_to @grid.point
-      end
-
-
-      # Utility methods for dealing with working out where things should be
-      # the calculations and such done here are all very rough, but are
-      # sufficient for now to plot just what we need.
-      #
-      
-      
-      def parse_sizing_from(o)
-        x_offset = 15
-        y_offset = 0
-        move_y_up = 0
-        grid_width = o[:width]
-        grid_height = o[:height]
-      
-        @total_width = o[:width]
-        @total_height = o[:height]
-        @point = o[:at].dup 
-
-        # Make room for the title if we're choosing to Render it.
-        #
-        if o[:title]
-          @title = o[:title]
-          y_offset += 10 
-        end
-
-        # Make room for X Axis labels if we're using them.
-        #
-        if o[:label_x]
-          y_offset += 30
-          move_y_up += 30
-          @x_label = o[:label_x]
-        end
-
-        # Make room for Y Axis labels if we're using them.
-        #
-        if o[:label_y]
-          @y_label = o[:label_y]
-          x_offset += 15
-        end
-
- 
-        # Return the values calculated here.
-        #
-        [ (o[:at][0] + x_offset), (o[:at][1] + move_y_up + 20), (grid_width - (x_offset - 20)), (grid_height - y_offset) ]
-      end
-
-      def process_the(data_array)
-        col = []
-        val = []
-        data_array.each { |i| val << i[1]; col << i[0] }
-        [ col, val ,val.sort.last ]
-      end
-
-      def calculate_x_axis_center_point(text, text_size, graph_start_x = @grid.start_x, graph_width = @grid.width)
-        ((graph_start_x + (graph_width / 2)) - ((text.length * text_size) / 4))
-      end
-      alias calculate_x_axis_centre_point calculate_x_axis_center_point
-
-      def calculate_y_axis_center_point(text, text_size, graph_start_y = @grid.start_y, graph_height = @grid.height)
-        ((graph_start_y + (graph_height / 2)) - ((text.length * text_size) / 4))
-      end
-      alias calculate_y_axis_centre_point calculate_y_axis_center_point
-
-      def calculate_plot_spacing
-        (@grid.width / @values.nitems)
-      end
-
-      def calculate_bar_width
-        calculate_plot_spacing / 2
-      end
-
-      def calculate_point_height_from(column_value)
-        cv = BigDecimal("#{column_value}")
-        hv = BigDecimal("#{@highest_value}")
-        gh = BigDecimal("#{@grid.height}")
-        percentage = (cv / (hv / 100))
-        ((gh / 100) * percentage).to_i
-      end
-
-
-    end
-  end
-end

data/lib/prawn/graph/chart.rb

@@ -1,4 +0,0 @@
-module Prawn
-  module Chart
-  end
-end

data/lib/prawn/graph/errors.rb

@@ -1,7 +0,0 @@
-module Prawn
-  module Errors
-    NoGraphData =  Class.new(StandardError) 
-    NoGraphStartSet =  Class.new(StandardError)
-    NoPlotValuesMethod =  Class.new(StandardError) 
-  end
-end

data/lib/prawn/graph/grid.rb

@@ -1,50 +0,0 @@
-module Prawn
-  module Chart
-    
-    # Prawn::Chart::Grid represents the area whcih your data will be plotted. It
-    # is drawn before your data is plotted and serves to mark where the axes of
-    # your plot will be and to give an indication of scale.
-    #
-    class Grid
-
-      attr_accessor :width, :height, :point, :spacing, :document
-
-      def initialize(grid_x_start, grid_y_start, grid_width, grid_height, spacing, document, theme)
-        @point = [grid_x_start, grid_y_start]
-        @width = grid_width
-        @height = grid_height
-        @spacing = spacing
-        @document = document
-        @theme = theme
-      end
-
-      def start_x; @point.first; end
-      def start_y; @point.last; end
-
-      # Draws the Grid on the specified Prawn::Document
-      #
-      def draw
-        @document.stroke_color @theme.marker_colour
-        if @theme.stroke_grid_markers?
-          (@height / @spacing).times do |x|
-            offset = @spacing * (x + 1)
-            @document.move_to [@point.first, (@point.last + offset)]
-            @document.line_width(0.5)
-            @document.stroke_line_to([(@point.first + @width), (@point.last + offset)])
-          end
-        end
-        @document.move_to @point
-        @document.line_width(2)
-        @document.stroke_line_to([@point.first, @point.last + @height])
-        @document.move_to @point
-        @document.line_width(2)
-        @document.stroke_line_to([(@point.first + @width), @point.last])
-        @document.move_to @point.first, (@point.last + height)
-        @document.stroke_color '000000'
-        @document.line_width(1)
-        @document.move_to @point
-      end
-
-    end
-  end
-end

data/lib/prawn/graph/line.rb

@@ -1,74 +0,0 @@
-module Prawn
-  module Chart
-    
-    # Prawn::Chart::Line plots its values as a Line graph, relatively
-    # sized to fit within the space defined by the Prawn::Chart::Grid
-    # associated with it.
-    #
-    # Call to new will return a new instance of Prawn::Chart::Line ready to
-    # be rendered.
-    #
-    # Takes an Array of +data+, which should contain complete rows of data for
-    # values to be plotted; a reference to a +document+ which should be an 
-    # instance of Prawn::Document and an +options+ with at least a value for :at
-    # specified.
-    #
-    # Options are:
-    #
-    #  :at , which should be an Array representing the point at which the graph
-    #  should be drawn.
-    #
-    #  :title, the title for this graph, wil be rendered centered to the top of 
-    #  the Grid.
-    #
-    #  :label_x, a label to be shown along the X axis of he graph, rendered centered
-    #  on the grid.
-    #
-    #  :label_y, a label to be shown along the Y axis of he graph, rendered centered
-    #  on the grid and rotated to be perpendicular to the axis.
-    #
-    # Data should be formatted like:
-    #
-    #    [
-    #      [ 'Column Heading', SomeValue ],
-    #      [ 'Column Heading', SomeValue ],
-    #      [ 'Column Heading', SomeValue ],
-    #      [ 'Column Heading', SomeValue ],
-    #      [ 'Column Heading', SomeValue ],
-    #      [ 'Column Heading', SomeValue ]
-    #    ]
-    #
-
-    class Line < Base
-
-      private
-      
-      def plot_values
-        base_x = @grid.start_x + 1
-        base_y = @grid.start_y + 1
-        p = [ [base_x, base_y] ]
-        bar_width = calculate_bar_width
-        @document.line_width bar_width
-        last_position = base_x + bar_width
-        point_spacing = calculate_plot_spacing
-        @values.each do |value|
-          @document.move_to [base_x + last_position, base_y]
-          bar_height = calculate_point_height_from value
-          point = [base_x + last_position, base_y + bar_height]
-          p << point
-          @document.fill_color @theme.colours.first
-          @document.fill_circle_at point, :radius => 1
-          last_position += point_spacing
-        end
-        @document.line_width 2
-        @document.stroke_color @theme.colours.first
-        p.each_with_index do |point,i|
-          next if point == p.last
-          @document.move_to point
-          @document.stroke_line_to p[i+1]
-        end
-      end
-
-    end
-  end
-end

data/lib/prawn/graph/themes.rb

@@ -1,116 +0,0 @@
-require 'yaml'
-
-module Prawn
-  module Chart
-
-    # Themes serves as a point of interaction between the user and the underlying
-    # collection of themes made available to Prawn::Graph.
-    #
-    class Themes
-
-      # Called once when Prawn::Graph is loaded, initializes the list of
-      # themes currently bundled. If you have your own custom theme you'd
-      # like to use instead, use _register_theme and give it the path to
-      # your theme file.
-      #
-      def self.initialize_themes
-        path = File.expand_path(File.dirname(__FILE__) + '/themes/')
-        Dir.open(path) do |dir|
-          dir.each do |file|
-            _register_theme(path + '/' + file) if file.include?('.yml')
-          end
-        end
-      end
-
-      # Adds the theme defined by the yaml file specified to the mapping of
-      # registered themes stored in +@@_themes_list+. Converts the YAML object
-      # into a Theme object for use in the application.
-      #
-      def self._register_theme(theme_file_path)
-        theme = Theme.new(YAML.load(IO.read(File.expand_path(theme_file_path))))
-        if !defined? @@_themes_list
-          @@_themes_list = {}
-        end
-        @@_themes_list[theme.name.to_sym] = theme
-      end    
-
-      # Returns an array of the themes currently registered.
-      #
-      def self.list
-        @@_themes_list.keys
-      end
-      
-      protected 
-
-      # Hook into method_missing to allow us to do things like:
-      #   Prawn::Chart::Themes.theme_name
-      # To return the theme object being looked for.
-      #
-      def self.method_missing(method, *args)
-        if @@_themes_list.keys.include?(method)
-          return @@_themes_list[method]
-        end
-      end
- 
-  
-      class Theme
-        attr_accessor :name, :title, :colours, :font_colour, :background_colour, :marker_colour
-
-        # Creates a new theme from a theme hash. The hash comes from the 
-        # library parsing YAML definitions of a theme. 
-        #
-        def initialize(theme_hash)
-          @name = theme_hash['name']
-          @title = theme_hash['title']
-
-          if theme_hash.keys.include?('colours') 
-            @colours = theme_hash['colours']        
-          elsif theme_hash.keys.include?('colors')
-            @colours = theme_hash['colors']        
-          end
-
-          if theme_hash.keys.include?('font_colour') 
-            @font_colour = theme_hash['font_colour']        
-          elsif theme_hash.keys.include?('font_color')
-            @font_colour = theme_hash['font_color']        
-          end
-
-          if theme_hash.keys.include?('background_colour') 
-            @background_colour = theme_hash['background_colour']        
-          elsif theme_hash.keys.include?('background_color')
-            @background_colour = theme_hash['background_color']        
-          end
-
-          if theme_hash.keys.include?('marker_colour') 
-            @marker_colour = theme_hash['marker_colour']        
-          elsif theme_hash.keys.include?('marker_color')
-            @marker_colour = theme_hash['marker_color']        
-          end
-
-          @stroke_grid_markers = theme_hash['stroke_grid_markers'].to_i
-        end
-      
-        # Returns the next colour in the array of colours associated
-        # with this theme. If it gets to the end, it starts again from
-        # the beginning.
-        #
-        def next_colour
-          unless @current_colour
-            @current_colour = 0
-            return @colours[0]
-          end
-          @current_colour += 1
-          @current_colour = 0 if @current_colour == @colours.nitems
-          @colours[@current_colour]
-        end
-        alias next_color next_colour
-
-        def stroke_grid_markers?
-          @stroke_grid_markers == 1
-        end
-
-      end
-    end
-
-  end
-end