tchart 1.0.2

data/test/tchart/process/chart_builder_test.rb

@@ -0,0 +1,33 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe ChartBuilder, "build" do
+    
+    before do
+      @layout = stub( 'layout', 
+        x_axis_tick_dates: [Date.new(2001,1,1), Date.new(2002,1,1)], 
+        x_axis_tick_x_coordinates: [0, 100],  
+        x_axis_length: 100, 
+        y_axis_length: 50,
+        x_axis_label_y_coordinate: -3,
+        x_axis_label_width: 10,
+        y_axis_tick_y_coordinates: [ 25 ] )
+      item = stub ; item.stubs(:build).returns [ Label.build_ylabel(xy(-10, 10), 20, "label"), Bar.new(xy(0, 25), xy(50, 25), "style") ]
+      @items = [ item ]
+    end
+    
+    it "builds a chart" do
+      chart = ChartBuilder.build(@layout, @items)
+      chart.elements.length.must_equal 8
+      chart.elements[0].must_equal GridLine.new(xy(0, 50), xy(100, 50))         # top horizontal frame
+      chart.elements[1].must_equal GridLine.new(xy(0, 0), xy(100, 0))           # bottom horizontal frame
+      chart.elements[2].must_equal Label.build_xlabel(xy(0, -3), 10, "2001")    # left x-axis label
+      chart.elements[3].must_equal GridLine.new(xy(0, 0), xy(0, 50))            # left vertical grid line
+      chart.elements[4].must_equal Label.build_xlabel(xy(100, -3), 10, "2002")  # left x-axis label
+      chart.elements[5].must_equal GridLine.new(xy(100, 0), xy(100, 50))        # right vertical grid line
+      chart.elements[6].must_equal Label.build_ylabel(xy(-10, 10), 20, "label") # item y-axis label
+      chart.elements[7].must_equal Bar.new(xy(0, 25), xy(50, 25), "style")      # item bar
+    end
+    
+  end
+end

data/test/tchart/process/command_line_parser_test.rb

@@ -0,0 +1,89 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe CommandLineParser, "parse" do
+    
+    Usage = "Usage: tchart [ --version | --help | input-data-filename output-tikz-filename ]"
+    
+    it "returns CommandLineArgs with appropriate attributes parsed from the command line" do
+      File.expects(:exists?).with('input_filename').returns(true)
+      File.expects(:file?).with('input_filename').returns(true)
+      File.expects(:exists?).with('output_filename').returns(false)
+      args, _ = CommandLineParser.parse( [ 'input_filename', 'output_filename' ] )
+      args.data_filename.must_equal 'input_filename'
+      args.tex_filename.must_equal 'output_filename'
+    end
+    
+    it "returns an error if there are fewer than two arguments" do
+      _, errors = CommandLineParser.parse( [ 'input_filename' ] )
+      errors.must_include Usage
+    end
+    
+    it "returns an error if there are more than two arguments" do
+      _, errors = CommandLineParser.parse( [ 'input_filename', 'output_filename', 'arg3' ] )
+      errors.must_include Usage
+    end
+    
+    it "returns an error if the input and output file names are the same" do
+      File.expects(:exists?).with('input_filename').returns(true)
+      File.expects(:file?).with('input_filename').returns(true)
+      File.expects(:exists?).with('./input_filename').returns(true)
+      File.expects(:file?).with('./input_filename').returns(true)
+      _, errors = CommandLineParser.parse( [ 'input_filename', './input_filename' ] )
+      errors.must_include "Error: input \"input_filename\" and output \"./input_filename\" refer to the same file."
+    end
+    
+    it "returns an error if the input data file does not exist" do
+      File.expects(:exists?).with('input_filename').returns(false)
+      _, errors = CommandLineParser.parse( [ 'input_filename', 'output_filename' ] )
+      errors.must_include "Error: input data file \"input_filename\" not found."
+    end
+    
+    it "returns an error if the input data file is not a file" do
+      File.expects(:exists?).with('input_filename').returns(true)
+      File.expects(:file?).with('input_filename').returns(false)
+      _, errors = CommandLineParser.parse( [ 'input_filename', 'output_filename' ] )
+      errors.must_include "Error: input data file \"input_filename\" is not a file."
+    end
+    
+    it "returns an error if the output data file exists and is not a file" do
+      File.expects(:exists?).with('input_filename').returns(true)
+      File.expects(:file?).with('input_filename').returns(true)
+      File.expects(:exists?).with('output_filename').returns(true)
+      File.expects(:file?).with('output_filename').returns(false)
+      _, errors = CommandLineParser.parse( [ 'input_filename', 'output_filename' ] )
+      errors.must_include "Error: existing output data file \"output_filename\" is not a file."
+    end
+    
+    it "returns an error containing the version if the -v option is specified" do
+      _, errors = CommandLineParser.parse( [ "-v" ] )
+      errors.must_include TChart::Version
+    end
+    
+    it "returns an error containing the version if the --version option is specified" do
+      _, errors = CommandLineParser.parse( [ "--version" ] )
+      errors.must_include TChart::Version
+    end
+    
+    it "other arguments are ignored if -v is specified" do
+      _, errors = CommandLineParser.parse( [ "-v", "input_filename", "output_filename" ] )
+      errors.must_include TChart::Version
+    end
+    
+    it "returns an error containing usage if the -h option is specified" do
+      _, errors = CommandLineParser.parse( [ "-h" ] )
+      errors.must_include Usage
+    end
+    
+    it "returns an error containing usage if the --help option is specified" do
+      _, errors = CommandLineParser.parse( [ "--help" ] )
+      errors.must_include Usage
+    end
+    
+    it "returns an error if an unknown option is specified" do
+      _, errors = CommandLineParser.parse( [ "-a" ] )
+      errors.must_include Usage
+    end
+
+  end
+end

data/test/tchart/process/data_parser_test.rb

@@ -0,0 +1,60 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe DataParser do
+    
+    it "reads all lines from the data source" do
+      data = StringIO.new("1\n2\n3\n")
+      DataParser.parse('filename.txt', data)
+    end
+    
+    it "ignores blank lines" do
+      data = StringIO.new("1\n \n3\n")
+      _, items, _ = DataParser.parse('filename.txt', data)
+      items.map { |item| item.description }.must_equal(['1', '3'])
+    end
+    
+    it "ignores empty lines" do
+      data = StringIO.new("1\n\n3\n")
+      _, items, _ = DataParser.parse('filename.txt', data)
+      items.map { |item| item.description }.must_equal(['1', '3'])
+    end
+    
+    it "ignores comment lines" do
+      data = StringIO.new("1\n# comment\n3\n")
+      _, items, _ = DataParser.parse('filename.txt', data)
+      items.map { |item| item.description }.must_equal(['1', '3'])
+    end
+    
+    it "ignores trailing comments" do
+      data = StringIO.new("1\n2 # comment\n3\n")
+      _, items, _ = DataParser.parse('filename.txt', data)
+      items.map { |item| item.description }.must_equal(['1', '2', '3'])
+    end
+    
+    it "does not treat escaped hashes (#) as comments" do
+      data = StringIO.new("C\\#\n")
+      _, items, _ = DataParser.parse('filename.txt', data)
+      items[0].description.must_equal 'C#'
+    end
+    
+    it "include the data source name and line number in error messages" do
+      data = StringIO.new("unknown_setting_name = 42\n")
+      _, _, errors = DataParser.parse('filename.txt', data)
+      errors.find {|item| item =~ /^filename.txt, 1:/}.wont_be_nil
+    end
+    
+    it "returns a 'no items found' error if no items were found in the data and no other errors were found" do
+      data = StringIO.new("# no chart items\n")
+      _, _, errors = DataParser.parse('filename.txt', data)
+      errors.must_equal [ "filename.txt: no items found" ]
+    end
+    
+    it "does not return a 'no items found' error if no items were found in the data but other errors were found" do
+      data = StringIO.new("unknown_setting = 123\n")
+      _, _, errors = DataParser.parse('filename.txt', data)
+      errors.wont_include [ "filename.txt: no items found" ]
+    end
+    
+  end
+end

data/test/tchart/process/data_reader_test.rb

@@ -0,0 +1,23 @@
+require_relative '../../test_helper'
+require 'stringio'
+
+module TChart
+  describe DataReader, "read" do
+    
+    before do
+      @filename = "_DataReader_read_test.txt"
+      @settings, @items, @errors = stub, stub, stub
+    end
+    
+    after do
+      File.delete(@filename) if File.exists?(@filename)
+    end
+    
+    it "returns settings, items, and errors" do
+      DataParser.stubs(:parse).returns [ @settings, @items, @errors ]
+      File.open(@filename, 'w') { |f| f.puts("C\tlang\t2001.1-2001.11\nchart_width=50\n") }
+      DataReader.read(@filename).must_equal [ @settings, @items, @errors ]
+    end
+    
+  end
+end

data/test/tchart/process/items_parser_test.rb

@@ -0,0 +1,154 @@
+require_relative '../../test_helper'
+
+module TChart  
+  describe ItemsParser, "parse" do
+    
+    before do
+      @parser = ItemsParser.new
+    end
+    
+    it "parses chart items" do
+      @parser.parse("Description | Style | 2000.4.14-2001.2.22\n")
+      @parser.items[0].description.must_equal 'Description'
+      @parser.items[0].bar_style.must_equal 'Style'
+      @parser.items[0].date_ranges.must_equal [ Date.new(2000,4,14)..Date.new(2001,2,22) ]
+    end
+    
+    it "raises an error if the name is missing" do
+      error = ->{ @parser.parse("|Style|2001\n") }.must_raise TChartError
+      error.message.must_equal "description is missing"
+    end
+    
+    it "raises an error if dates where supplied but the style is missing" do
+      error = ->{ @parser.parse("Description||2001\n") }.must_raise TChartError
+      error.message.must_equal "style is missing"
+    end
+    
+    it "allows escaped separator characters" do
+      @parser.parse("Description1\\|\\|Description2|Style|2000\n")
+      @parser.items[0].description.must_equal 'Description1||Description2'
+    end
+    
+    it "allows escaped escape characters" do
+      @parser.parse("Description1\\\\Description2|Style|2000\n")
+      @parser.items[0].description.must_equal 'Description1\Description2'
+    end
+    
+    it "allows separator lines" do
+      @parser.parse("---\n")
+      @parser.items[0].must_be_instance_of Separator
+    end
+    
+    it "allows chart items with no date ranges" do
+      @parser.parse("Description | Style\n")
+      @parser.items[0].description.must_equal 'Description'
+      @parser.items[0].bar_style.must_equal 'Style'
+      @parser.items[0].date_ranges.must_equal []
+    end
+    
+    it "allows chart items with no style and no date ranges" do
+      @parser.parse("Description\n")
+      @parser.items[0].description.must_equal 'Description'
+      @parser.items[0].bar_style.must_equal nil
+      @parser.items[0].date_ranges.must_equal []
+    end
+    
+    it "allows chart items with empty style and empty date ranges" do
+      @parser.parse("Description||\n")
+      @parser.items[0].description.must_equal 'Description'
+      @parser.items[0].bar_style.must_equal nil
+      @parser.items[0].date_ranges.must_equal []
+    end
+    
+    it "allows many date ranges" do
+      @parser.parse("Description|Style|2000|2001|2002\n")
+      @parser.items[0].date_ranges.length.must_equal 3
+    end
+    
+    it "strips leading and trailing spaces from the description" do
+      @parser.parse(" \t Description \t |Style\n")
+      @parser.items[0].description.must_equal 'Description'
+    end
+    
+    it "strips leading and trailing spaces from the style" do
+      @parser.parse("Description| \t Style \t |2000\n")
+      @parser.items[0].bar_style.must_equal 'Style'
+    end
+    
+    it "strips leading and trailing spaces from the dates" do
+      @parser.parse("Description|Style| \t 2000 \t | \t 2001 \t \n")
+      @parser.items[0].date_ranges.must_equal [ Date.new(2000,1,1)..Date.new(2000,12,31), Date.new(2001,1,1)..Date.new(2001,12,31) ]
+    end
+    
+    it "converts a range consisting of just a year to 1st January thru 31st December of that year" do
+      @parser.parse("Description|Style|2000\n")
+      @parser.items[0].date_ranges.must_equal [ Date.new(2000,1,1)..Date.new(2000,12,31) ]
+    end
+    
+    it "converts a range start consisting of just a year to 1st January of the year" do
+      @parser.parse("Description|Style|2000-2001.2.22\n")
+      @parser.items[0].date_ranges.must_equal [ Date.new(2000,1,1)..Date.new(2001,2,22) ]
+    end
+    
+    it "converts a range start consisting of a year and a month to the 1st of the month" do
+      @parser.parse("Description|Style|2000.4-2001.2.22\n")
+      @parser.items[0].date_ranges.must_equal [ Date.new(2000,4,1)..Date.new(2001,2,22) ]
+    end
+    
+    it "converts a range end consisting of just a year to 31st December of the year" do
+      @parser.parse("Description|Style|2000.4.14-2001\n")
+      @parser.items[0].date_ranges.must_equal [ Date.new(2000,4,14)..Date.new(2001,12,31) ]
+    end
+    
+    it "converts a range end consisting of a year and a month to the last day of the month" do
+      @parser.parse("Description|Style|2000.4.14-2001.2\n")
+      @parser.items[0].date_ranges.must_equal [ Date.new(2000,4,14)..Date.new(2001,2,28) ]
+    end
+    
+    it "allows whitespace around the dash (-) in a date range" do
+      @parser.parse("Description|Style|2000.4.14 \t - \t 2001.2.22\n")
+      @parser.items[0].date_ranges.must_equal [ Date.new(2000,4,14)..Date.new(2001,2,22) ]
+    end
+    
+    it "raises an error if a date cannot be parsed" do
+      error = ->{ @parser.parse("Description|Style|2000.-2001\n") }.must_raise TChartError
+      error.message.must_equal "bad date range \"2000.-2001\"; expecting 2000.4.17-2001.7.21 | 2002.4-2003, etc."
+    end
+    
+    it "raises an error if start date in a range is invalid" do
+      error = ->{ @parser.parse("Description|Style|2000.4.34-2001.2.22\n") }.must_raise TChartError
+      error.message.must_equal "2000.4.34: invalid date"
+    end
+    
+    it "raises an error if end date in a range is invalid" do
+      error = ->{ @parser.parse("Description|Style|2000.4.14-2001.2.32\n") }.must_raise TChartError
+      error.message.must_equal "2001.2.32: invalid date"
+    end
+    
+    it "allows ranges to be out of order" do
+      @parser.parse("Description|Style|2001|2000\n")
+      @parser.items[0].date_ranges.must_equal [ Date.new(2001,1,1)..Date.new(2001,12,31), Date.new(2000,1,1)..Date.new(2000,12,31) ]
+    end
+    
+    it "allows ranges to be back-to-back" do
+      @parser.parse("Description|Style|2000|2001\n")
+      @parser.items[0].date_ranges.must_equal [ Date.new(2000,1,1)..Date.new(2000,12,31), Date.new(2001,1,1)..Date.new(2001,12,31) ]
+    end
+    
+    it "raises an error if ranges overlap" do
+      error = ->{ @parser.parse("Description|Style|2000-2001|2002-2004|2003-2005|2006-2007\n") }.must_raise TChartError
+      error.message.must_equal "date range 2002.1.1-2004.12.31 overlaps 2003.1.1-2005.12.31"
+    end
+    
+    it "raises an error if a range end date is before a range start date" do
+      error = ->{ @parser.parse("Description|Style|2001.2.22-2000.4.14\n") }.must_raise TChartError
+      error.message.must_equal "date range end 2000.4.14 before start 2001.2.22"
+    end
+    
+    it "raises an error if two sets of dates are not separated by a pipe" do
+      error = ->{ @parser.parse("Description|Style|2001-2002 2003-2004\n") }.must_raise TChartError
+      error.message.must_equal "bad date range \"2001-2002 2003-2004\"; expecting 2000.4.17-2001.7.21 | 2002.4-2003, etc."
+    end
+    
+  end
+end

data/test/tchart/process/layout_builder_test.rb

@@ -0,0 +1,189 @@
+require_relative '../../test_helper'
+
+module TChart
+  
+  describe LayoutBuilder, "build" do
+    
+    include TestHelper
+    
+    before do
+      @settings = make_settings
+      @items = make_items_with_ranges('2000.11.1-2005.3.21', '2002.4.17-2009.3.30')
+      @errors = stub
+    end
+    
+    it "returns a layout and errors" do
+      LayoutBuilder.stubs(:check_layout).returns @errors
+      layout, errors = LayoutBuilder.build(@settings, @items)
+      layout.wont_be_nil
+      errors.must_be_same_as @errors
+    end
+    
+  end
+  
+  
+  describe LayoutBuilder, "check_layout" do
+    
+    before do
+      @layout = stub
+    end
+    
+    it "returns an error if the plot area is not wide enough" do
+      @layout.stubs(:x_axis_length).returns 0
+      errors = LayoutBuilder.check_layout(@layout)
+      errors.find {|item| item =~ /plot area is too narrow/}.wont_be_nil
+    end
+    
+  end
+  
+  
+  describe LayoutBuilder, "x_axis_tick_dates" do
+    
+    include TestHelper
+    
+    before do
+      @settings = make_settings
+      @this_year = Date.today.year
+    end
+    
+    it "uses 1st January to 31st December when chart items is empty" do
+      items = []
+      layout, _ = LayoutBuilder.build(@settings, items)
+      layout.x_axis_tick_dates.must_equal make_tick_dates(@this_year, @this_year + 1, 1)
+    end
+    
+    it "sets 1st January to 31st December when none of the chart items have date ranges" do
+      items = [ stub( date_ranges: [] ) ]
+      layout, _ = LayoutBuilder.build(@settings, items)
+      layout.x_axis_tick_dates.must_equal make_tick_dates(@this_year, @this_year + 1, 1)
+    end
+    
+    it "sets the correct dates when the items date range is less than 10 years" do
+      items = make_items_with_ranges '2000.3.17-2004.10.4'
+      layout, _ = LayoutBuilder.build(@settings, items)
+      layout.x_axis_tick_dates.must_equal make_tick_dates(2000, 2005, 1)
+    end
+    
+    it "sets the correct dates when the items date range is 10 years" do
+      items = make_items_with_ranges '2000.3.17-2009.10.4'
+      layout, _ = LayoutBuilder.build(@settings, items)
+      layout.x_axis_tick_dates.must_equal make_tick_dates(2000, 2010, 1)
+    end
+    
+    it "sets the correct dates when the items date range is 11 years" do
+      items = make_items_with_ranges '2000.3.17-2010.10.4'
+      layout, _ = LayoutBuilder.build(@settings, items)
+      layout.x_axis_tick_dates.must_equal make_tick_dates(2000, 2015, 5)
+    end
+    
+    it "sets the correct dates when the items date range is less than 50 years" do
+      items = make_items_with_ranges '2000.3.17-2044.10.4'
+      layout, _ = LayoutBuilder.build(@settings, items)
+      layout.x_axis_tick_dates.must_equal make_tick_dates(2000, 2045, 5)
+    end
+    
+    it "sets the correct dates when the items date range is 50 years" do
+      items = make_items_with_ranges '2000.3.17-2049.10.4'
+      layout, _ = LayoutBuilder.build(@settings, items)
+      layout.x_axis_tick_dates.must_equal make_tick_dates(2000, 2050, 5)
+    end
+    
+    it "sets the correct dates when the items date range is less than 60 years" do
+      items = make_items_with_ranges '2000.3.17-2054.10.4'
+      layout, _ = LayoutBuilder.build(@settings, items)
+      layout.x_axis_tick_dates.must_equal make_tick_dates(2000, 2060, 10)
+    end
+    
+    it "sets the correct dates when the items date range is 60 years" do
+      items = make_items_with_ranges '2000.3.17-2059.10.4'
+      layout, _ = LayoutBuilder.build(@settings, items)
+      layout.x_axis_tick_dates.must_equal make_tick_dates(2000, 2060, 10)
+    end
+    
+  end
+
+
+  describe LayoutBuilder, "x_axis_tick_x_coordinates" do
+
+    include TestHelper
+
+    before do
+      @settings = make_settings
+      @items = make_items_with_ranges('2000.11.1-2005.3.21', '2002.4.17-2009.3.30')
+    end
+
+    it "sets an array of x coordinates" do
+      layout, _ = LayoutBuilder.build(@settings, @items)
+      layout.x_axis_tick_x_coordinates.must_equal (0..100).step(10.0).to_a
+    end
+
+  end
+
+
+  describe LayoutBuilder, "x_axis_length" do
+
+    include TestHelper
+
+    before do
+      @settings = make_settings
+      @items = make_items_with_ranges('2000.11.1-2005.3.21', '2002.4.17-2009.3.30')
+    end
+
+    it "sets the correct length" do
+      layout, _ = LayoutBuilder.build(@settings, @items)
+      layout.x_axis_length.must_equal @settings.chart_width - @settings.x_axis_label_width - @settings.y_axis_label_width
+    end
+
+  end
+
+
+  describe LayoutBuilder, "y_axis_length" do
+
+    include TestHelper
+
+    before do
+      @settings = make_settings
+      @items = make_items_with_ranges('2000.11.1-2005.3.21', '2002.4.17-2009.3.30')
+    end
+
+    it "sets the correct length" do
+      layout, _ = LayoutBuilder.build(@settings, @items)
+      layout.y_axis_length.must_equal @settings.line_height * (@items.length + 1)
+    end
+
+  end
+
+
+  describe LayoutBuilder, "y_axis_label_x_coordinate" do
+
+    include TestHelper
+
+    before do
+      @settings = make_settings
+      @items = make_items_with_ranges('2000.11.1-2005.3.21', '2002.4.17-2009.3.30')
+    end
+
+    it "sets the correct value" do
+      layout, _ = LayoutBuilder.build(@settings, @items)
+      layout.y_axis_label_x_coordinate.must_equal 0 - ((@settings.y_axis_label_width / 2.0) + (@settings.x_axis_label_width / 2.0))
+    end
+
+  end
+  
+
+  describe Layout, "y_axis_tick_y_coordinates" do
+
+    include TestHelper
+
+    before do
+      @settings = make_settings
+      @items = make_items_with_ranges('2000.11.1-2005.3.21', '2002.4.17-2009.3.30')
+    end
+
+    it "returns the y coordinates of all items" do
+      layout, _ = LayoutBuilder.build(@settings, @items)
+      layout.y_axis_tick_y_coordinates.must_equal [8, 4]
+    end
+
+  end
+end