tchart 1.0.2

data/lib/tchart/process/settings_parser.rb

@@ -0,0 +1,63 @@
+module TChart
+  
+  #
+  # Responsible for parsing a line of source data that contains a
+  # setting.  Also responsible for accumulating parsed settings.
+  #
+  class SettingsParser
+   
+    #
+    # The accumulated settings.  All settings start with their default
+    # values and get updated as setting lines are parsed.  If a setting
+    # is specified more than once in the source data, the last value 
+    # found will be the one used.
+    #
+    attr_reader :settings
+    
+    def initialize
+      @settings = Settings.new
+    end
+    
+    #
+    # Return true if the passed line is a recognizable settings line
+    # (which may nonetheless have errors, such as unknown setting, etc.), 
+    # false otherwise.
+    #
+    def parse?(line)
+      return false if (match = /^([^=]+)=(.+)$/.match(line)).nil?
+      name, value_as_string = match[1].strip, match[2].strip
+      raise_unknown_setting(name) unless known_setting?(name)
+      raise_not_a_recognizable_value(value_as_string) unless recognizable_value?(value_as_string)
+      save_setting(name, value_as_string)
+      true
+    end
+
+  private
+  
+    def known_setting?(name)
+      @settings.has_setting?(name)
+    end
+
+    #
+    # "chart_width = 42"      => true
+    # "gobbledygook = junk"   => true
+    # "chart_width 42"        => false
+    #
+    def recognizable_value?(value_as_string)
+      value_as_string =~ /^(\+|-)?\d+(\.\d*)?$/
+    end
+
+    def save_setting(name, value_as_string)
+      @settings.send("#{name}=", value_as_string.to_f)
+    end
+    
+    def raise_unknown_setting(name)
+      raise TChartError, "unknown setting \"#{name}\"; expecting one of: #{@settings.setting_names.join(', ')}"
+    end
+
+    def raise_not_a_recognizable_value(value_as_string)
+      raise TChartError, "\"#{value_as_string}\" is not a recognizable setting value; expecting e.g. 123 or 123.45"
+    end
+    
+  end
+end

data/lib/tchart/process/tex_builder.rb

@@ -0,0 +1,85 @@
+require 'stringio'
+
+module TChart
+  
+  #
+  # Responsible for generating TikZ/TeX code for the various chart elements,
+  # including labels, bars, (grid)lines, etc.  Also responsible for escaping
+  # TeX special characters, such as {, }, \, etc., and for accumulating the
+  # generated code.
+  #
+  class TeXBuilder
+    
+    def initialize
+      @output = StringIO.new
+    end
+    
+    def begin_chart
+      @output << "\\tikzpicture\n"
+    end
+    
+    def end_chart
+      @output << "\\endtikzpicture\n"
+    end
+    
+    def comment(text)
+      @output << "% #{escape_tex_special_chars text.to_s}\n"
+    end
+    
+    def gridline(from, to, style)
+      @output << "\\draw [#{style}] (#{f from.x}mm, #{f from.y}mm) -- (#{f to.x}mm, #{f to.y}mm);\n"
+    end
+    
+    def label(coord, width, style, text)
+      @output << "\\node [#{style}, text width = #{f width}mm] at (#{f coord.x}mm, #{f coord.y}mm) {#{escape_tex_special_chars text.to_s}};\n"
+    end
+    
+    def bar(from, to, style)
+      x_mid, width = to_tikz_coords(from.x, to.x)
+      @output << "\\node [#{style}] at (#{f x_mid}mm, #{f from.y}mm) [minimum width = #{f width}mm] {};\n"
+    end
+    
+    def to_s # => String
+      @output.string
+    end
+    
+  private
+
+    #
+    # f(1.2345)  =>  "1.23"
+    #
+    def f(number)
+      '%.02f' % number
+    end
+    
+    #
+    # escape_tex_special_chars('# $ % & _ { } \ ~ ^ |')  =>  '\# \$ \% \& \_ \{ \} \textbackslash{} \~{} \^{} $\vert$'
+    #
+    def escape_tex_special_chars(text)
+      text.gsub(/([#$%&_{}~^\\|])/) do |match|
+        case match
+        when '#', '$', '%', '&', '_', '{', '}'
+          "\\#{match}"
+        when '\\'
+          '$\\backslash$'
+        when '~'
+          '\\~{}'
+        when '^'
+          '\\^{}'
+        when '|'
+          '$\\vert$'
+        end
+      end
+    end
+    
+    #
+    # to_tikx_coords(x_from, x_to)  =>  [ x_mid, width ]
+    #
+    def to_tikz_coords(x_from, x_to)
+      width = x_to - x_from
+      x_mid = x_from + (width / 2.0)
+      [x_mid, width]
+    end
+  
+  end
+end

data/lib/tchart/process/tex_writer.rb

@@ -0,0 +1,13 @@
+module TChart
+  
+  #
+  # Responsible for writing TeX code to a file.
+  #
+  module TeXWriter
+    
+    def self.write(tex_filename, tex_content)
+      File.open(tex_filename, 'w') {|f| f.puts(tex_content)}
+    end
+    
+  end
+end

data/lib/tchart/version.rb

@@ -0,0 +1,3 @@
+module TChart
+  Version = "1.0.2"
+end

data/test/integration_test.rb

@@ -0,0 +1,82 @@
+require_relative 'test_helper'
+
+module TChart
+  describe "integration test" do
+    
+    before do
+      delete_test_files(data_filename, tex_filename)
+    end
+    
+    after do
+      delete_test_files(data_filename, tex_filename)
+    end
+    
+    it do
+      create_file(data_filename, data)
+      TChart.run( [ data_filename, tex_filename ] )
+      contents_of(tex_filename).must_equal expected_tex
+    end
+    
+    def data_filename 
+      "integration_test.txt"
+    end
+    
+    def tex_filename
+      "integration_test.tex"
+    end
+    
+    def data
+      <<-'EOS'.gsub(/^\s+/, '')
+        chart_width = 100
+        line_height = 5
+        x_axis_label_width = 15
+        x_axis_label_y_coordinate = -5
+        y_axis_label_width = 30
+    
+        Objective-C | lang  | 2001.5-2002.6
+        -----------------------------------
+        OS X        | os    | 2001.3-2002.7
+      EOS
+    end
+    
+    def expected_tex
+      <<-'EOS'.gsub(/^\s+/, '')
+        \tikzpicture
+        \draw [gridline] (0.00mm, 20.00mm) -- (55.00mm, 20.00mm);
+        \draw [gridline] (0.00mm, 0.00mm) -- (55.00mm, 0.00mm);
+      
+        \node [xlabel, text width = 15.00mm] at (0.00mm, -5.00mm) {2001};
+        \draw [gridline] (0.00mm, 0.00mm) -- (0.00mm, 20.00mm);
+      
+        \node [xlabel, text width = 15.00mm] at (27.50mm, -5.00mm) {2002};
+        \draw [gridline] (27.50mm, 0.00mm) -- (27.50mm, 20.00mm);
+      
+        \node [xlabel, text width = 15.00mm] at (55.00mm, -5.00mm) {2003};
+        \draw [gridline] (55.00mm, 0.00mm) -- (55.00mm, 20.00mm);
+      
+        \node [ylabel, text width = 30.00mm] at (-22.50mm, 15.00mm) {Objective-C};
+      
+        \node [lang] at (25.09mm, 15.00mm) [minimum width = 32.10mm] {};
+        \draw [gridline] (0.00mm, 10.00mm) -- (55.00mm, 10.00mm);
+      
+        \node [ylabel, text width = 30.00mm] at (-22.50mm, 5.00mm) {OS X};
+      
+        \node [os] at (23.96mm, 5.00mm) [minimum width = 39.03mm] {};
+        \endtikzpicture
+      EOS
+    end
+    
+    def create_file(filename, contents)
+      File.open(filename, "w") { |f| f.puts(contents) }
+    end
+    
+    def contents_of(filename)
+      File.open(filename, "r") { |f| f.read }
+    end
+    
+    def delete_test_files(*filenames)
+      filenames.each { |fn| File.delete(fn) if File.exists?(fn) }
+    end
+    
+  end
+end

data/test/tchart/model/bar_test.rb

@@ -0,0 +1,17 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe Bar, "render" do
+    
+    before do
+      @tex = TeXBuilder.new
+      @bar = Bar.new(xy(0,30), xy(50, 30), "bar_style")
+    end
+    
+    it "generates TeX code to render itself" do
+      @tex.expects(:bar).once
+      @bar.render(@tex)
+    end
+    
+  end
+end

data/test/tchart/model/coordinate_test.rb

@@ -0,0 +1,10 @@
+require_relative '../../test_helper'
+
+describe "xy" do
+  it "returns a newly allocated coordinate with the passed x,y coordinates" do
+    coordinate = xy(4, 2)
+    coordinate.must_be_kind_of TChart::Coordinate
+    coordinate.x.must_equal 4
+    coordinate.y.must_equal 2
+  end
+end

data/test/tchart/model/grid_line_test.rb

@@ -0,0 +1,17 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe GridLine, "render" do
+    
+    before do
+      @tex = TeXBuilder.new
+      @gridline = GridLine.new(xy(0,0), xy(10,0))
+    end
+    
+    it "generates TeX code to render the grid line" do
+      @tex.expects(:gridline).once
+      @gridline.render(@tex)
+    end
+    
+  end
+end

data/test/tchart/model/label_test.rb

@@ -0,0 +1,31 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe Label, "build_xlabel" do
+    it "returns a label with style 'xlabel'" do
+      Label.build_xlabel(xy(4,2), 42, "text").style.must_equal "xlabel"
+    end
+  end
+  
+  
+  describe Label, "build_ylabel" do
+    it "returns a label with style 'ylabel'" do
+      Label.build_ylabel(xy(4,2), 42, "text").style.must_equal "ylabel"
+    end
+  end
+  
+  
+  describe Label, "render" do
+    
+    before do
+      @tex = TeXBuilder.new
+      @label = Label.build_ylabel(xy(-10,20), xy(30,20), "description")
+    end
+    
+    it "generates TikZ code to render and item" do
+      @tex.expects(:label)
+      @label.render(@tex)
+    end
+    
+  end
+end

data/test/tchart/model/layout_test.rb

@@ -0,0 +1,17 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe Layout, "date_range_to_x_coordinates" do
+    
+    before do
+      @layout = Layout.new
+      @layout.x_axis_tick_dates = [Date.new(2001,1,1), Date.new(2002,1,1)]
+      @layout.x_axis_length = 100
+    end
+    
+    it "converts a date range to its equivalent x_coordinate range on the chart" do
+      @layout.date_range_to_x_coordinates(Date.new(2001,1,1)..Date.new(2001,12,31)).must_equal [0.0, 100.0]
+    end
+    
+  end
+end

data/test/tchart/model/separator_test.rb

@@ -0,0 +1,19 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe Separator, "build" do
+    
+    before do
+      @layout = stub( x_axis_length: 100 )
+      @separator = Separator.new
+      @y = 10
+    end
+    
+    it "returns an array containing a horizontal gridline" do
+      elements = @separator.build(@layout, @y)
+      elements.length.must_equal 1
+      elements[0].must_equal GridLine.new(xy(0,10), xy(100,10))
+    end
+    
+  end
+end

data/test/tchart/model/settings_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe Settings, "initialize" do
+    
+    before do
+      @settings = Settings.new
+    end
+    
+    it "sets its settings to default values" do
+      @settings.setting_names.each do |setting_name|
+        @settings.send(setting_name).wont_be_nil "\"#{setting_name}\" is not being set to a default value in Settings#initialize"
+      end
+    end
+    
+  end
+  
+  
+  describe Settings, "has_setting?" do
+    
+    before do
+      @settings = Settings.new
+    end
+    
+    it "returns true if the setting exists" do
+      @settings.has_setting?('chart_width').must_equal true
+    end
+    it "returns false if the setting does not exist" do
+      @settings.has_setting?('gobbledygook').must_equal false
+    end
+    it "returns false when asked about itself" do
+      @settings.has_setting?('has_setting?').must_equal false
+    end
+  end
+  
+  
+  describe Settings, "setting_names" do
+    
+    before do
+      @settings = Settings.new
+    end
+    
+    it "returns the list of setting names" do
+      @settings.setting_names.must_equal ['chart_width', 'line_height', 'x_axis_label_width', 
+        'x_axis_label_y_coordinate', 'y_axis_label_width']
+    end
+  end
+end

data/test/tchart/model/y_item_test.rb

@@ -0,0 +1,24 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe YItem, "build" do
+    
+    before do
+      @layout = stub
+      @layout.stubs(:x_axis_date_range).returns( Date.new(2001,1,1)..Date.new(2003,1,1) )
+      @layout.stubs(:y_axis_label_x_coordinate).returns(-10)
+      @layout.stubs(:y_axis_label_width).returns(20)
+      @layout.stubs(:date_range_to_x_coordinates).returns [0, 50]
+      @item = YItem.new("description", "bar_style", [ Date.new(2001,1,1)..Date.new(2001,12,31) ])
+      @y = 10
+    end
+    
+    it "returns an array containing a label and bars" do
+      elements = @item.build(@layout, @y)
+      elements.length.must_equal 2
+      elements[0].must_be_kind_of Label
+      elements[1].must_be_kind_of Bar
+    end
+    
+  end
+end