tchart 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b23ad54a382777cdf1e500dbcf5539779a0a3d3b
+  data.tar.gz: e484d3aed917693c74abd2557e362b08bbc39de9
+SHA512:
+  metadata.gz: a4ba8ddc34005fba31ddf15d9a1a32225fb9d60077434a66498d2d76f2686b5dcd47ab2b853d1100bff5c74273c18978ff49c8b5982b29d0788b6158acc03fa3
+  data.tar.gz: 2b74530475bc379d20fc6706c750372177ea31f5e8123d7062c50ca0f224da2b04bec43633823df2947ec33099c2abe0df2b44a077cb9ecdd2f8cfae1e286fd7

data/bin/tchart

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'tchart'
+
+TChart.run(ARGV)

data/lib/tchart.rb

@@ -0,0 +1,27 @@
+# 'require' all files except ourselves.
+me = File.absolute_path(__FILE__)
+Dir.glob(File.dirname(me) + '/**/*.rb') {|fn| require fn unless fn == me }
+
+module TChart
+
+  #
+  # Program entry point. Responsible for running the various steps
+  # required to generate TikZ code that renders a chart.  Also
+  # responsible for reporting errors.
+  #
+  def self.run(argv)
+    args, errors = CommandLineParser.parse(argv)                    ; abort_if errors
+    settings, items, errors = DataReader.read(args.data_filename)   ; abort_if errors
+    layout, errors = LayoutBuilder.build(settings, items)           ; abort_if errors
+    chart = ChartBuilder.build(layout, items)
+    tex = chart.render
+    TeXWriter.write(args.tex_filename, tex)
+  end
+  
+private
+  
+  def self.abort_if errors
+    abort(errors.join("\n")) unless errors.empty?
+  end
+    
+end

data/lib/tchart/lang/tchart_error.rb

@@ -0,0 +1,9 @@
+module TChart
+  
+  #
+  # Used to distinguish errors raised within the application code
+  # from errors raised by Ruby or a third-party library.
+  #
+  class TChartError < StandardError ; end
+  
+end

data/lib/tchart/model/bar.rb

@@ -0,0 +1,24 @@
+module TChart
+  
+  #
+  # A bar that represents a date range on the chart.  Responsible 
+  # for generating TikZ code to render the bar.
+  #
+  class Bar
+    
+    attr_reader :from
+    attr_reader :to
+    attr_reader :style    # TikZ style, must be defined in encompasing TeX document.
+    
+    def initialize(from, to, style)
+      @from = from
+      @to = to
+      @style = style
+    end
+    
+    def render(tex)
+      tex.bar @from, @to, @style
+    end
+    
+  end
+end

data/lib/tchart/model/chart.rb

@@ -0,0 +1,25 @@
+module TChart
+  
+  #
+  # The plots of zero or more date ranges.  Includes bars representing the
+  # date ranges, x and y axes lines, gridlines, and labels.  Has overall
+  # responsibility for generating all of the TikZ code to render the chart.
+  #
+  class Chart
+    
+    attr_reader :elements     # Labels, gridlines and bars that make up the chart.
+
+    def initialize(elements)
+      @elements = elements
+    end
+    
+    def render # => String
+      tex = TeXBuilder.new
+      tex.begin_chart
+      @elements.each { |element| element.render(tex) }
+      tex.end_chart
+      tex.to_s
+    end
+    
+  end
+end

data/lib/tchart/model/command_line_args.rb

@@ -0,0 +1,18 @@
+module TChart
+  
+  #
+  # Responsible for storing all command line arguments for use
+  # throughout the lifecycle of the application.
+  #
+  class CommandLineArgs
+    
+    attr_reader :data_filename    # input file
+    attr_reader :tex_filename     # output file
+    
+    def initialize(data_filename, tex_filename)
+      @data_filename = data_filename
+      @tex_filename = tex_filename
+    end
+    
+  end
+end

data/lib/tchart/model/coordinate.rb

@@ -0,0 +1,29 @@
+module TChart
+  
+  #
+  # An (x,y) location on the chart.  x and y can be
+  # in any units, e.g. millimeters, pixels, etc.
+  #
+  class Coordinate
+    
+    attr_reader :x
+    attr_reader :y
+    
+    def initialize(x, y)
+      @x = x
+      @y = y
+    end
+    
+  end
+end
+
+
+module Kernel
+  
+  #
+  # Shorthand for TChart::Coordinate.new(x, t).
+  #
+  def xy(x, y) # => Coordinate
+    TChart::Coordinate.new(x, y)
+  end
+end

data/lib/tchart/model/grid_line.rb

@@ -0,0 +1,25 @@
+module TChart
+  
+  #
+  # A horizontal or vertical line on the chart that spans the
+  # entire width or height of the chart and serves as a reading 
+  # aid.  The x and y axes, and the top and and right frame of 
+  # the chart are also grid lines.  Responsible for generating 
+  # TikZ code to render the grid line.
+  #
+  class GridLine
+    
+    attr_reader :from
+    attr_reader :to
+    
+    def initialize(from, to)
+      @from = from
+      @to = to
+    end
+    
+    def render(tex)
+      tex.gridline @from, @to, "gridline"
+    end
+    
+  end
+end

data/lib/tchart/model/label.rb

@@ -0,0 +1,43 @@
+module TChart
+  
+  #
+  # An x or y axis label on the chart.  X axis labels will be years, e.g. 
+  # "2014", "2015", etc., and y axis labels will be descriptions of the
+  # items being plotted, e.g. "Ruby", "C", "C++", etc.  Responsible for
+  # generating TikZ code to render the label.
+  #
+  class Label
+    
+    attr_reader :coord    # Horizontal and vertical mid-point of label location.
+    attr_reader :width    # Required for text justification.
+    attr_reader :style    # TikZ style, must be defined in encompasing TeX document.
+    attr_reader :text
+    
+    #
+    # The difference between an x axis label and a y axis label is the TikZ style;
+    # x axis labels are generated with the style "xlabel", y axis labels use 
+    # "ylabel".  In the TeX document that embeds the chart, the x axis labels will 
+    # usually be styled with centered text, whereas y axis labels will be left
+    # justified.
+    #
+    def self.build_xlabel(coord, width, text) # => Label
+      Label.new(coord, width, "xlabel", text)
+    end
+    
+    def self.build_ylabel(coord, width, text) # => Label
+      Label.new(coord, width, "ylabel", text)
+    end
+    
+    def initialize(coord, width, style, text)
+      @coord = coord
+      @width = width
+      @style = style
+      @text = text
+    end
+    
+    def render(tex)
+      tex.label @coord, @width, @style, @text
+    end
+    
+  end
+end

data/lib/tchart/model/layout.rb

@@ -0,0 +1,85 @@
+module TChart
+  
+  #
+  # Responsible for storing various chart metrics such as the length of the 
+  # axes, the width of the axes labels, the coordinates of the axes labels,
+  # and so on.  All metrics are unitless, although they should all be in
+  # the same unit.  Also responsible for converting a date range to its
+  # equivalent start and end coordinates on the chart.
+  #
+  class Layout
+    
+    #
+    # The length of the x axis from the leftmost to the rightmost label.
+    #
+    attr_accessor :x_axis_length
+    
+    #
+    # The amount of horizontal space to allocate for each x axis label.
+    # Used to determine the width of the margins to the left and right of
+    # the x axis, and also passed to TikZ/TeX.
+    #
+    attr_accessor :x_axis_label_width
+    
+    #
+    # The distance of the mid point of the x axis labels from the x axis.
+    #
+    attr_accessor :x_axis_label_y_coordinate
+    
+    #
+    # The x coordinates of the x axis labels and associated vertical
+    # grid lines.
+    #
+    attr_accessor :x_axis_tick_x_coordinates
+    
+    #
+    # The dates to be used for the x axis labels.
+    #
+    attr_accessor :x_axis_tick_dates
+    
+    #
+    # The length of the y axis from the topmost to the bottommost item.
+    #
+    attr_accessor :y_axis_length
+    
+    #
+    # The width of the y axis labels.  Used to calculate the amount of 
+    # horizontal space to leave for the labels, and also passed in the
+    # generated TikX code.
+    #
+    attr_accessor :y_axis_label_width
+    
+    #
+    # The distance of the mid point of the y axis labels to the left 
+    # of the y axis.
+    #
+    attr_accessor :y_axis_label_x_coordinate
+    
+    #
+    # The y coordinates of the y axis labels and their associated bars.
+    #
+    attr_accessor :y_axis_tick_y_coordinates
+    
+    #
+    # Convert a date range, e.g. Date.new(2000,1,1)..Date.new(2002,10,3), to
+    # its equivalent start and end coordinates on the chart.
+    #
+    def date_range_to_x_coordinates(date_range) # => [ Numeric, Numeric ]
+      x_from = date_to_x_coordinate(date_range.begin)
+      x_to = date_to_x_coordinate(date_range.end + 1)   # +1 bumps the time to end-of-day of the end date
+      [x_from, x_to]
+    end
+    
+  private
+
+    #
+    # ratio is: x_coordinate / x_axis_length  =  ( date - date_range.begin ) / date_range_length
+    #
+    def date_to_x_coordinate(date) # => Numeric
+      date_range_begin, date_range_end = @x_axis_tick_dates.first.jd, @x_axis_tick_dates.last.jd
+      date_range_length = date_range_end - date_range_begin    
+      ( @x_axis_length * ( date.jd - date_range_begin ) * 1.0 ) / date_range_length 
+    end
+
+  end
+end

data/lib/tchart/model/separator.rb

@@ -0,0 +1,28 @@
+module TChart
+  
+  #
+  # The input data file specifies settings, data lines, and separators.
+  # A separator renders as a horizontal grid line and serves to separate
+  # the charted items into sections.  Responsible for building the grid
+  # line element. 
+  #
+  class Separator
+    
+    #
+    # This is part of the charted item interface.  Separators
+    # have no date ranges so this array will always be empty.
+    #
+    attr_reader :date_ranges  
+    
+    def initialize
+      @date_ranges = []
+    end
+    
+    def build(layout, y) # => [ GridLine ]
+      from = xy(0, y)
+      to = xy(layout.x_axis_length, y)
+      [ GridLine.new(from, to) ]
+    end
+    
+  end
+end

data/lib/tchart/model/settings.rb

@@ -0,0 +1,68 @@
+module TChart
+  
+  #
+  # The input data file specifies settings, data lines, and separators.
+  # This class stores the settings from the data file.  Responsible for
+  # providing default values for those settings that are not specified
+  # in the input file.  Also responsible for answering whether a setting
+  # name is known or not, and for providing a list of all setting names.
+  #
+  # All setting values are in millimeters.  The Settings and TeXBuilder
+  # are the only two classes that know what units are being used.  All
+  # other classes are unit agnostic.
+  #
+  class Settings
+    
+    #
+    # The amount of horizontal space available for the chart.  It must be
+    # large enough to accomodate the width of the y-axis labels, the width
+    # of the x axis, and the margins to the left and right of the x axis.
+    #
+    attr_accessor :chart_width
+    
+    #
+    # The amount of vertical space to allocate for each line of the chart.
+    # It must be large enough to accomodate the larger of the y axis label 
+    # height and the bar height.
+    #
+    attr_accessor :line_height
+
+    #
+    # The amount of horizontal space to allocate for each x axis label.
+    # Used to determine the width of the margins to the left and right of
+    # the x axis, and also passed to TikZ/TeX.
+    #
+    attr_accessor :x_axis_label_width
+
+    #
+    # The distance of the mid point of the x axis labels from the x axis.
+    #
+    attr_accessor :x_axis_label_y_coordinate
+
+    #
+    # The width of the y axis labels.  Used to calculate the amount of 
+    # horizontal space to leave for the labels, and also passed in the
+    # generated TikX code.
+    #
+    attr_accessor :y_axis_label_width
+    
+    def initialize
+      @chart_width                = 164.99
+      @line_height                = 4.6
+      @x_axis_label_width         = 10
+      @x_axis_label_y_coordinate  = -3
+      @y_axis_label_width         = 24
+    end
+    
+    def has_setting?(setting_name)
+      setting_names.include?(setting_name)
+    end
+   
+    def setting_names # => [ "chart_width", "line_height", ... ]
+      methods                                 # => [ "has_setting?", "chart_width", "chart_width=", ... ]
+        .grep(/\w=$/)                         # => [ "chart_width=", ... ]
+        .map {|name| name.to_s.chomp('=')}    # => [ "chart_width", ... ]
+    end
+    
+  end
+end

data/lib/tchart/model/y_item.rb

@@ -0,0 +1,44 @@
+module TChart
+  
+  #
+  # The input data file specifies settings, data lines, and separators.  A
+  # data line consists of a description, which becomes a y axis label, zero
+  # or more date ranges to be plotted on the chart as horizontal bars, and
+  # a TikZ style for the bars.  YItem is reponsible for capturing all of
+  # that information and for building the label and bar elements.
+  #
+  class YItem
+    
+    attr_reader :description    # Used for the y-label.
+    attr_reader :bar_style      # TikZ style, must be defined in encompasing TeX document.
+    attr_reader :date_ranges    # Can be >= 0; drawn as bars on the chart.
+
+    def initialize(description, bar_style, date_ranges)
+       @description = description
+       @bar_style = bar_style
+       @date_ranges = date_ranges
+    end
+    
+    def build(layout, y) # => [ Label, Bar, Bar, ... ]
+      [ new_y_label(layout, y) ].concat new_bars(layout, y)
+    end
+    
+  private
+  
+    def new_y_label(layout, y) # => Label
+      Label.build_ylabel(xy(layout.y_axis_label_x_coordinate, y), layout.y_axis_label_width, @description)
+    end
+    
+    def new_bars(layout, y) # => [ Bar, Bar, ... ]
+      @date_ranges.map do |date_range| 
+        x_from, x_to = layout.date_range_to_x_coordinates(date_range)
+        new_bar(x_from, x_to, y)
+      end
+    end
+    
+    def new_bar(x_from, x_to, y) # => Bar
+      Bar.new(xy(x_from, y), xy(x_to, y), @bar_style)
+    end
+    
+  end
+end