tchart 1.0.2

data/test/tchart/process/settings_parser_test.rb

@@ -0,0 +1,75 @@
+require_relative "../../test_helper"
+
+module TChart
+  describe SettingsParser, "parse" do
+    
+    before do
+      @parser = SettingsParser.new
+    end
+    
+    it "returns true if the passed line is recognized as a setting" do
+      @parser.parse?("chart_width=42").must_equal true
+      @parser.parse?("chart_width = 42").must_equal true
+    end
+    
+    it "returns false if the passed line is not recognizable as a setting" do
+      @parser.parse?("C++ | lang | 2003").must_equal false
+    end
+    
+    it "parses settings with no sign" do
+      @parser.parse?("chart_width=42\n")
+      @parser.settings.chart_width.must_equal 42
+    end
+    
+    it "parses settings with a plus sign" do
+      @parser.parse?("chart_width=+42\n")
+      @parser.settings.chart_width.must_equal 42
+    end
+    
+    it "parses settings with a minus sign" do
+      @parser.parse?("chart_width=-42\n")
+      @parser.settings.chart_width.must_equal (-42)
+    end
+    
+    it "parses settings with a decimal but no decimal places" do
+      @parser.parse?("chart_width=42.\n")
+      @parser.settings.chart_width.must_equal 42
+    end
+    
+    it "parses settings with decimal places" do
+      @parser.parse?("chart_width=42.24\n")
+      @parser.settings.chart_width.must_equal 42.24
+    end
+    
+    it "parses settings with trailing zeros after the decimal place" do
+      @parser.parse?("chart_width=42.240\n")
+      @parser.settings.chart_width.must_equal 42.24
+    end
+    
+    it "parses settings with leading zeros" do
+      @parser.parse?("chart_width=0042\n")
+      @parser.settings.chart_width.must_equal 42
+    end
+    
+    it "ignores spaces around the equals sign in a setting" do
+      @parser.parse?("chart_width = 42\n")
+      @parser.settings.chart_width.must_equal 42
+    end
+    
+    it "ignores leading spaces before the setting name" do
+      @parser.parse?(" chart_width=42\n")
+      @parser.settings.chart_width.must_equal 42
+    end
+    
+    it "returns an error if the settings value is not a number for numeric settings" do
+      error = ->{ @parser.parse?("chart_width=42mm\n") }.must_raise TChartError
+      error.message.must_equal "\"42mm\" is not a recognizable setting value; expecting e.g. 123 or 123.45"
+    end
+    
+    it "returns an error if the setting name is unknown" do
+      error = ->{ @parser.parse?("unknown=42\n") }.must_raise TChartError
+      error.message.must_match( /^unknown setting \"unknown\"; expecting one of:/ )
+    end
+ 
+  end
+end

data/test/tchart/process/tex_builder_test.rb

@@ -0,0 +1,120 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe TeXBuilder, "begin_chart" do
+    
+    before do
+      @tex = TeXBuilder.new
+    end
+    
+    it "generates \\tikzpicture" do
+      @tex.begin_chart
+      @tex.to_s.must_equal "\\tikzpicture\n"
+    end
+    
+  end
+  
+  
+  describe TeXBuilder, "end_chart" do
+    
+    before do
+      @tex = TeXBuilder.new
+    end
+    
+    it "generates \\endtikzpicture" do
+      @tex.end_chart
+      @tex.to_s.must_equal "\\endtikzpicture\n"
+    end
+    
+  end
+  
+  
+  describe TeXBuilder, "comment" do
+    
+    before do
+      @tex = TeXBuilder.new
+    end
+    
+    it "generates a TeX comment" do
+      @tex.comment "this is a comment"
+      @tex.to_s.must_equal "% this is a comment\n"
+    end
+    
+    it "escapes TeX special characters in comments" do
+      @tex.comment '# $ % & _ { } \ ~ ^ |'
+      @tex.to_s.must_include '\# \$ \% \& \_ \{ \} $\backslash$ \~{} \^{} $\vert$'
+    end
+    
+    it "handles non-string arguments" do
+      @tex.comment 123
+      @tex.to_s.must_equal "% 123\n"
+    end
+    
+  end
+  
+  
+  describe TeXBuilder, "gridline" do
+  
+    before do
+      @tex = TeXBuilder.new
+    end
+  
+    it "generates a TikZ code for a grid line" do
+      @tex.gridline xy(10,20), xy(30,40), "line_style"   # x1, y1, x2, y2, style
+      @tex.to_s.must_equal "\\draw [line_style] (10.00mm, 20.00mm) -- (30.00mm, 40.00mm);\n"
+    end
+  
+  end
+  
+  
+  describe TeXBuilder, "label" do
+  
+    before do
+      @tex = TeXBuilder.new
+    end
+  
+    it "generates TikZ code for a chart label" do
+      @tex.label xy(10,20), 15, 'some_style', 'the label text'  # x_mid, y, width, style, text
+      @tex.to_s.must_equal "\\node [some_style, text width = 15.00mm] at (10.00mm, 20.00mm) {the label text};\n"
+    end
+  
+    it "escapes TeX special characters in the label text" do
+      @tex.label xy(10,20), 15, 'some_style', 'TeX special characters: # $ % & _ { } \ ~ ^ |'  # x_mid, y, width, style, text
+      @tex.to_s.must_include '{TeX special characters: \# \$ \% \& \_ \{ \} $\backslash$ \~{} \^{} $\vert$}'
+    end
+  
+    it "handles non-string label text" do
+      @tex.label xy(10,20), 15, 'some_style', 123  # x_mid, y, width, style, text
+      @tex.to_s.must_equal "\\node [some_style, text width = 15.00mm] at (10.00mm, 20.00mm) {123};\n"
+    end
+  
+  end
+  
+  
+  describe TeXBuilder, "bar" do
+  
+    before do
+      @tex = TeXBuilder.new
+    end
+  
+    it "generates TikZ code for a horizontal bar on the chart" do
+      @tex.bar xy(10,50), xy(40,50), 'some_style'  # from, to, style
+      @tex.to_s.must_equal "\\node [some_style] at (25.00mm, 50.00mm) [minimum width = 30.00mm] {};\n"
+    end
+  
+  end
+  
+  
+  describe TeXBuilder, "to_s" do
+  
+    before do
+      @tex = TeXBuilder.new
+    end
+  
+    it "returns the generated TeX code" do
+      @tex.comment "a comment"
+      @tex.to_s.must_equal "% a comment\n"
+    end
+  
+  end
+end

data/test/tchart/process/tex_writer_test.rb

@@ -0,0 +1,38 @@
+require_relative '../../test_helper'
+
+module TChart
+  describe TeXWriter, "write" do
+    
+    before do
+      @filename = "_test_.tex"
+      @content = "some content\n"
+      File.delete(@filename) if File.exists?(@filename)
+    end
+    
+    after do
+      File.delete(@filename) if File.exists?(@filename)
+    end
+    
+    it "writes output" do
+      TeXWriter.write(@filename, @content)
+      File.exists?(@filename).must_equal true
+      IO.read(@filename).must_equal @content
+    end
+    
+    it "silently overwrites an already existing output file" do
+      File.open(@filename, 'w') { |f| f.write('should be overwritten') }
+      TeXWriter.write(@filename, @content)
+      IO.read(@filename).must_equal @content
+    end
+    
+    it "throws a 'not writable' error if the output file already exists and cannot be overwritten" do
+      begin
+        Dir.mkdir(@filename)
+        proc { TeXWriter.write(@filename, @content) }.must_raise Errno::EISDIR
+      ensure
+        Dir.rmdir(@filename)
+      end
+    end
+  
+  end
+end

data/test/tchart_test.rb

@@ -0,0 +1,47 @@
+require_relative 'test_helper'
+
+module TChart
+  describe TChart do
+    
+    before do
+      @argv = ["smoke_test.txt", "smoke_test.tex"]
+      File.open(@argv[0], 'w') {|f| f.puts("skill \t style \t 2001-2005\n---")}
+    end
+    
+    after do
+      @argv.each { |filename| File.delete(filename) if File.exist?(filename) }
+    end
+    
+    it "is silent when everything runs successfully" do
+      proc { TChart.run(@argv) }.must_be_silent
+    end
+    
+    it "writes errors and aborts if command line argument errors are found" do
+      CommandLineParser.stubs(:parse).returns [ stub, [ 'an error'] ]
+      proc do
+        proc do
+          TChart.run(@argv)
+        end.must_raise SystemExit
+      end.must_output nil, "an error\n"
+    end
+    
+    it "writes errors and aborts if parsing errors are found" do
+      DataReader.stubs(:read).returns [ stub, stub, [ 'an error' ] ]
+      proc do
+        proc do
+          TChart.run(@argv)
+        end.must_raise SystemExit
+      end.must_output nil, "an error\n"
+    end
+    
+    it "writes errors and aborts if layout errors are found" do
+      LayoutBuilder.stubs(:build).returns [ stub, [ 'an error' ] ]
+      proc do
+        proc do
+          TChart.run(@argv)
+        end.must_raise SystemExit
+      end.must_output nil, "an error\n"
+    end
+  
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: tchart
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Michael Lewandowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+description: "                                  tchart reads a text file containing
+  date-based data,\n                                  for example employment history,
+  and generates TikZ\n                                  code to render a chart of
+  the data.  The generated \n                                  TikZ chart can then
+  be embedded in a TeX or LaTeX\n                                  document, such
+  as a resume.\n"
+email: milewdev@gmail.com
+executables:
+- tchart
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tchart/lang/tchart_error.rb
+- lib/tchart/model/bar.rb
+- lib/tchart/model/chart.rb
+- lib/tchart/model/command_line_args.rb
+- lib/tchart/model/coordinate.rb
+- lib/tchart/model/grid_line.rb
+- lib/tchart/model/label.rb
+- lib/tchart/model/layout.rb
+- lib/tchart/model/separator.rb
+- lib/tchart/model/settings.rb
+- lib/tchart/model/y_item.rb
+- lib/tchart/process/chart_builder.rb
+- lib/tchart/process/command_line_parser.rb
+- lib/tchart/process/data_parser.rb
+- lib/tchart/process/data_reader.rb
+- lib/tchart/process/items_parser.rb
+- lib/tchart/process/layout_builder.rb
+- lib/tchart/process/settings_parser.rb
+- lib/tchart/process/tex_builder.rb
+- lib/tchart/process/tex_writer.rb
+- lib/tchart/version.rb
+- lib/tchart.rb
+- test/integration_test.rb
+- test/tchart/model/bar_test.rb
+- test/tchart/model/coordinate_test.rb
+- test/tchart/model/grid_line_test.rb
+- test/tchart/model/label_test.rb
+- test/tchart/model/layout_test.rb
+- test/tchart/model/separator_test.rb
+- test/tchart/model/settings_test.rb
+- test/tchart/model/y_item_test.rb
+- test/tchart/process/chart_builder_test.rb
+- test/tchart/process/command_line_parser_test.rb
+- test/tchart/process/data_parser_test.rb
+- test/tchart/process/data_reader_test.rb
+- test/tchart/process/items_parser_test.rb
+- test/tchart/process/layout_builder_test.rb
+- test/tchart/process/settings_parser_test.rb
+- test/tchart/process/tex_builder_test.rb
+- test/tchart/process/tex_writer_test.rb
+- test/tchart_test.rb
+- bin/tchart
+homepage: https://github.com/milewdev/tchart
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Ruby 2
+- A TeX distribution (e.g. tug.org/mactex) to render the generated TikZ chart code.
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Generate TikZ code to plot date-based data.
+test_files:
+- test/integration_test.rb
+- test/tchart/model/bar_test.rb
+- test/tchart/model/coordinate_test.rb
+- test/tchart/model/grid_line_test.rb
+- test/tchart/model/label_test.rb
+- test/tchart/model/layout_test.rb
+- test/tchart/model/separator_test.rb
+- test/tchart/model/settings_test.rb
+- test/tchart/model/y_item_test.rb
+- test/tchart/process/chart_builder_test.rb
+- test/tchart/process/command_line_parser_test.rb
+- test/tchart/process/data_parser_test.rb
+- test/tchart/process/data_reader_test.rb
+- test/tchart/process/items_parser_test.rb
+- test/tchart/process/layout_builder_test.rb
+- test/tchart/process/settings_parser_test.rb
+- test/tchart/process/tex_builder_test.rb
+- test/tchart/process/tex_writer_test.rb
+- test/tchart_test.rb