Merge pull request #43 from red-data-tools/check_border_type

Check border type

Author: mrkn

lib/unicode_plot/plot.rb

@@ -17,7 +17,7 @@ def initialize(title: nil,
       @title = title
       @xlabel = xlabel
       @ylabel = ylabel
-      @border = border
+      @border = check_border(border)
       @margin = check_margin(margin)
       @padding = padding
       @labels_left = {}
@@ -142,5 +142,10 @@ def to_s
         raise ArgumentError, "row_index out of bounds"
       end
     end
+
+    private def check_border(border)
+      return border if BORDER_MAP.key?(border)
+      raise ArgumentError, "unknown border type: #{border}"
+    end
   end
 end

lib/unicode_plot/renderer.rb

@@ -40,6 +40,10 @@ module BorderMaps
     barplot: BorderMaps::BORDER_BARPLOT,
   }.freeze
 
+  def self.border_types
+    BORDER_MAP.keys
+  end
+
   module BorderPrinter
     include StyledPrinter
 

test/test-barplot.rb

@@ -12,6 +12,14 @@ class BarplotTest < Test::Unit::TestCase
       end
     end
 
+    sub_test_case("with invalid arguments") do
+      test("unknown border type") do
+        assert_raise(ArgumentError.new("unknown border type: invalid_border_name")) do
+          UnicodePlot.barplot(data: {bar: 23, foo: 37}, border: :invalid_border_name)
+        end
+      end
+    end
+
     test("colored") do
       data = { bar: 23, foo: 37 }
       plot = UnicodePlot.barplot(data: data)

test/test-boxplot.rb

@@ -3,6 +3,14 @@ class BoxplotTest < Test::Unit::TestCase
   include Helper::WithTerm
 
   sub_test_case("UnicodePlot.boxplot") do
+    sub_test_case("with invalid arguments") do
+      test("unknown border type") do
+        assert_raise(ArgumentError.new("unknown border type: invalid_border_name")) do
+          UnicodePlot.boxplot([1, 2, 3, 4, 5], border: :invalid_border_name)
+        end
+      end
+    end
+
     sub_test_case("print to tty") do
       test("without name") do
         plot = UnicodePlot.boxplot([1, 2, 3, 4, 5])

test/test-densityplot.rb

@@ -10,6 +10,14 @@ def setup
     assert_equal(1000, @dy.length)
   end
 
+  sub_test_case("with invalid arguments") do
+    test("unknown border type") do
+      assert_raise(ArgumentError.new("unknown border type: invalid_border_name")) do
+        UnicodePlot.densityplot(@dx, @dy, border: :invalid_border_name)
+      end
+    end
+  end
+
   test("default") do
     plot = UnicodePlot.densityplot(@dx, @dy)
     dx2 = @dx.map {|x| x + 2 }

test/test-histogram.rb

@@ -7,6 +7,14 @@ def setup
       @x = fixture_path("randn.txt").read.lines.map(&:to_f)
     end
 
+    sub_test_case("with invalid arguments") do
+      test("unknown border type") do
+        assert_raise(ArgumentError.new("unknown border type: invalid_border_name")) do
+          UnicodePlot.histogram(@x, border: :invalid_border_name)
+        end
+      end
+    end
+
     test("default") do
       plot = UnicodePlot.histogram(@x)
       _, output = with_term { plot.render($stdout) }

test/test-lineplot.rb

@@ -23,6 +23,14 @@ def setup
       assert_raise(ArgumentError) { UnicodePlot.lineplot(1..3, 1..2) }
     end
 
+    sub_test_case("with invalid arguments") do
+      test("unknown border type") do
+        assert_raise(ArgumentError.new("unknown border type: invalid_border_name")) do
+          UnicodePlot.lineplot(@x, @y, border: :invalid_border_name)
+        end
+      end
+    end
+
     sub_test_case("with numeric array") do
       test("default") do
         plot = UnicodePlot.lineplot(@x, @y)

test/test-scatterplot.rb

@@ -22,6 +22,14 @@ def setup
     end
   end
 
+  sub_test_case("with invalid arguments") do
+    test("unknown border type") do
+      assert_raise(ArgumentError.new("unknown border type: invalid_border_name")) do
+        UnicodePlot.scatterplot(@x, @y, border: :invalid_border_name)
+      end
+    end
+  end
+
   test("default") do
     plot = UnicodePlot.scatterplot(@x, @y)
     _, output = with_term { plot.render($stdout, newline: false) }

test/test-utils.rb

@@ -1,7 +1,13 @@
 class UnicodePlotTest < Test::Unit::TestCase
   test("UnicodePlot.canvas_types") do
     available_canvas_types = [:ascii, :block, :braille, :density, :dot]
-    assert_equal(available_canvas_types,
-                 UnicodePlot.canvas_types)
+    assert_equal(available_canvas_types.sort,
+                 UnicodePlot.canvas_types.sort)
+  end
+
+  test("UnicodePlot.border_types") do
+    available_border_types = [:solid, :corners, :barplot]
+    assert_equal(available_border_types.sort,
+                 UnicodePlot.border_types.sort)
   end
 end