sketch-in-ruby 0.0.1

data/test/sketch.rb

@@ -0,0 +1,189 @@
+require 'minitest/autorun'
+require 'sketch'
+
+describe Sketch do
+    Size = Geometry::Size
+
+    let(:sketch)    { Sketch.new }
+
+    it "should create a Sketch object" do
+	sketch.must_be_kind_of Sketch
+    end
+
+    it "should have a read only elements accessor" do
+	sketch.must_respond_to :elements
+	sketch.wont_respond_to :elements=
+    end
+
+    it "must have a push method that pushes an element" do
+	sketch.push Rectangle.new size:[5, 5]
+	sketch.elements.last.must_be_kind_of Rectangle
+    end
+
+    it "must push a sketch with a transformation" do
+	sketch.push Sketch.new(), origin:[1,2]
+	sketch.elements.last.must_be_kind_of Sketch
+	sketch.elements.last.transformation.must_equal Geometry::Transformation.new(origin:[1,2])
+    end
+
+    describe "parameters" do
+	it "must define custom parameters" do
+	    Sketch.define_parameter(:a_parameter) { 42 }
+	    Sketch.new.a_parameter.must_equal 42
+	end
+
+	it "must bequeath custom parameters to subclasses" do
+	    Sketch.define_parameter(:a_parameter) { 42 }
+	    Class.new(Sketch).new.must_respond_to(:a_parameter)
+	end
+
+	it "must not allow access to parameters defined on a subclass" do
+	    Sketch.define_parameter(:a_parameter) { 42 }
+	    Class.new(Sketch).define_parameter(:b_parameter) { 24 }
+	    Sketch.new.wont_respond_to :b_parameter
+	end
+    end
+
+    it "should have a circle command that makes a new circle from a center point and radius" do
+	circle = sketch.add_circle [1,2], 3
+	circle.must_be_kind_of Geometry::Circle
+	circle.center.must_equal Point[1,2]
+	circle.radius.must_equal 3
+    end
+
+    it "should have a point creation method" do
+	point = sketch.add_point(5,6)
+	point.must_be_kind_of Sketch::Point
+	point.x.must_equal 5
+	point.y.must_equal 6
+    end
+
+    it "have a line creation method" do
+	line = sketch.add_line([5,6], [7,8])
+	line.must_be_kind_of Sketch::Line
+    end
+
+    it "have a rectangle creation method" do
+	rectangle = sketch.add_rectangle size:[10, 20]
+	rectangle.must_be_kind_of Geometry::Rectangle
+	rectangle.points.must_equal [Point[0,0], Point[0,20], Point[10,20], Point[10,0]]
+    end
+
+    it "should have a method for adding a square" do
+	square = sketch.add_square 10
+	square.must_be_kind_of Geometry::Square
+	square.width.must_equal 10
+	square.height.must_equal 10
+	square.center.must_equal Point[0,0]
+	square.points.must_equal [Point[-5,-5], Point[5,-5], Point[5,5], Point[-5,5]]
+    end
+
+    describe "when constructed with a block" do
+	before do
+	    @sketch = Sketch.new do
+		add_circle [1,2], 3
+	    end
+	end
+
+	it "should execute the block" do
+	    circle = @sketch.elements.last
+	    circle.must_be_kind_of Geometry::Circle
+	    circle.center.must_equal Point[1,2]
+	    circle.radius.must_equal 3
+	end
+    end
+
+    describe "object creation" do
+	it "must create an Arc" do
+	    arc = sketch.add_arc center:[1,2], radius:3, start:0, end:90
+	    sketch.elements.last.must_be_kind_of Geometry::Arc
+	    arc.center.must_equal Point[1,2]
+	    arc.radius.must_equal 3
+	    arc.start_angle.must_equal 0
+	    arc.end_angle.must_equal 90
+	end
+
+	it "triangle" do
+	    triangle = sketch.add_triangle [0,0], [1,0], [0,1]
+	    sketch.elements.last.must_be_kind_of Geometry::Triangle
+	end
+    end
+
+    describe "properties" do
+	subject { Sketch.new { add_circle [1,-2], 3; add_circle([-1,2], 3) } }
+
+	it "must have a bounds rectangle" do
+	    subject.bounds.must_equal Rectangle.new(from:[-4,-5], to:[4,5])
+	end
+
+	it "must have an accessor for the first element" do
+	    subject.first.must_be_instance_of(Geometry::Circle)
+	end
+
+	it "must have an accessor for the last element" do
+	    subject.last.must_be_instance_of(Geometry::Circle)
+	end
+
+	it "must have a max property that returns the upper right point of the bounding rectangle" do
+	    subject.max.must_equal Point[4,5]
+	end
+
+	it "must have a min property that returns the lower left point of the bounding rectangle" do
+	    subject.min.must_equal Point[-4,-5]
+	end
+
+	it "must have a minmax property that returns the corners of the bounding rectangle" do
+	    subject.minmax.must_equal [Point[-4,-5], Point[4,5]]
+	end
+
+	it "must have a size" do
+	    subject.size.must_equal Size[8,10]
+	    subject.size.must_be_instance_of(Size)
+	end
+
+	describe "when the Sketch is empty" do
+	    subject { Sketch.new }
+
+	    it "max must return nil" do
+		subject.max.must_be_nil
+	    end
+
+	    it "min must return nil" do
+		subject.min.must_be_nil
+	    end
+
+	    it "minmax must return an array of nils" do
+		subject.minmax.each {|a| a.must_be_nil }
+	    end
+	end
+
+	describe "when the Sketch is rotated" do
+	    subject do
+		s = Sketch.new { add_rectangle center:[0, -1.5], size:[6.5, 50.5] }
+		s.transformation = Geometry::Transformation.new(angle:Math::PI/2)
+		s
+	    end
+
+	    it "must have a min property that returns the lower left point of the bounding rectangle" do
+		subject.min.x.must_be_close_to -23.75
+		subject.min.y.must_be_close_to -3.25
+	    end
+	end
+    end
+
+    describe "when the Sketch contains a group" do
+	subject { Sketch::Builder.new(Sketch.new).evaluate { translate [1,2] { circle [1,-2], 3; circle([-1,2], 3) } } }
+
+	it "must have a max property" do
+	    subject.max.must_equal Point[5,7]
+	end
+
+	it "must have a min property" do
+	    subject.min.must_equal Point[-3,-3]
+	end
+
+	it "must have a minmax property" do
+	    subject.minmax.must_equal [Point[-3,-3], Point[5,7]]
+	end
+    end
+end

data/test/sketch/builder.rb

@@ -0,0 +1,167 @@
+require 'minitest/autorun'
+require 'geometry'
+require 'sketch/builder'
+
+describe Sketch::Builder do
+    Builder = Sketch::Builder
+    Rectangle = Geometry::Rectangle
+
+    subject { Builder.new }
+
+    describe "when initialized without a block" do
+	let(:builder) { Builder.new }
+
+	it "should create a new Sketch when initialized without a Sketch" do
+	    builder.sketch.must_be_instance_of(Sketch)
+	end
+
+	it "should use the given sketch when initialized with an existing Sketch" do
+	    sketch = Sketch.new
+	    Builder.new(sketch).sketch.must_be_same_as(sketch)
+ 	end
+
+	it "must have a push method that pushes elements" do
+	    builder.push Rectangle.new size:[5, 5]
+	    builder.sketch.elements.last.must_be_kind_of Rectangle
+	end
+
+	describe "command handlers" do
+	    it "must recognize the rectangle command" do
+		builder.rectangle([1,2], [3,4]).must_be_instance_of(Rectangle)
+		builder.sketch.elements.last.must_be_kind_of Rectangle
+	    end
+	end
+
+	describe "when evaluating a block" do
+	    describe "with simple geometry" do
+		before do
+		    builder.evaluate do
+			square 5
+		    end
+		end
+
+		it "should create the commanded elements" do
+		    builder.sketch.elements.last.must_be_kind_of Geometry::Square
+		end
+
+		it "triangle" do
+		    builder.evaluate { triangle [0,0], [1,0], [0,1] }
+		end
+	    end
+
+	    describe "that defines a parameter" do
+		before do
+		    builder.evaluate do
+			let(:parameterA) { 42 }
+			circle [1,2], parameterA
+		    end
+		end
+
+		it "must define the parameter" do
+		    builder.sketch.parameterA.must_equal 42
+		end
+
+		it "must use the parameter" do
+		    builder.sketch.elements.last.must_be_instance_of Geometry::Circle
+		    builder.sketch.elements.last.radius.must_equal 42
+		end
+	    end
+
+	    describe "with a path block" do
+		before do
+		    builder.evaluate do
+			path do
+			end
+		    end
+		end
+
+		it "must add a Path object to the Sketch" do
+		    builder.sketch.elements.last.must_be_instance_of Geometry::Path
+		end
+	    end
+	end
+    end
+
+    describe "when initialized with a block " do
+	let(:builder) {
+	    Builder.new do
+		square 5
+	    end
+	}
+
+	it "must evaluate the block" do
+	    builder.sketch.elements.last.must_be_kind_of Geometry::Square
+ 	end
+    end
+
+    describe "when adding a group" do
+	describe "without a block" do
+	    before do
+		subject.group origin:[1,2,3]
+	    end
+
+	    it "must have a group element" do
+		subject.sketch.elements.first.must_be_kind_of Sketch::Group
+		subject.sketch.elements.first.translation.must_equal Point[1,2,3]
+	    end
+	end
+
+	describe "with a block" do
+	    before do
+		subject.group origin:[1,2,3] { circle diameter:1 }
+	    end
+
+	    it "must have a group element" do
+		subject.sketch.elements.first.must_be_kind_of Sketch::Group
+	    end
+
+	    it "must have the correct property values" do
+		subject.sketch.elements.first.translation.must_equal Point[1,2,3]
+	    end
+	end
+    end
+
+    describe "when adding a translation" do
+	before do
+	    subject.translate [1,2] { circle diameter:1 }
+	end
+
+	it "must have a group element" do
+	    subject.sketch.elements.first.must_be_kind_of Sketch::Group
+	end
+
+	it "must have the correct property values" do
+	    subject.sketch.elements.first.translation.must_equal Point[1,2]
+	end
+
+	it 'must reject higher dimensions' do
+	    -> { subject.translate [1,2,3] }.must_raise ArgumentError
+	end
+    end
+
+    describe "when adding a nested translation" do
+	before do
+	    subject.translate [1,2] do
+		translate [3,4] { circle diameter:2 }
+	    end
+	end
+
+	it "must have a group element" do
+	    subject.sketch.elements.first.must_be_kind_of Sketch::Group
+	end
+
+	it "must have the correct property values" do
+	    subject.sketch.elements.first.translation.must_equal Point[1,2]
+	end
+
+	it "must have a sub-group element" do
+	    outer_group = subject.sketch.elements.first
+	    outer_group.elements.first.must_be_kind_of Sketch::Group
+	end
+
+	it "must set the sub-group properties" do
+	    outer_group = subject.sketch.elements.first
+	    outer_group.elements.first.translation.must_equal Point[3,4]
+	end
+    end
+end

data/test/sketch/builder/path.rb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+require 'sketch/builder/path'
+
+describe Sketch::Builder::Path do
+    Path = Sketch::Path
+    Point = Geometry::Point
+
+    let(:builder) { Sketch::Builder::Path.new }
+
+    it "must build a Path from a block" do
+	builder.evaluate {}.must_be_kind_of Path
+    end
+end

data/test/sketch/builder/polygon.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require 'sketch/builder/polygon'
+
+describe Sketch do
+    let(:builder)   { Sketch::Builder::Polygon.new }
+
+    it "build a polygon with a block" do
+	polygon = builder.evaluate do
+	end
+	assert_kind_of(Sketch::Polygon, polygon)
+    end
+end

data/test/sketch/builder/polyline.rb

@@ -0,0 +1,12 @@
+require 'minitest/autorun'
+require 'sketch/builder/polyline'
+
+describe Sketch::Builder::Polyline do
+    Polyline = Sketch::Polyline
+
+    let(:builder) { Sketch::Builder::Polyline.new }
+
+    it "must build a Polyline from a block" do
+	builder.evaluate {}.must_be_kind_of Polyline
+    end
+end

data/test/sketch/dsl.rb

@@ -0,0 +1,104 @@
+require 'minitest/autorun'
+require 'sketch/dsl'
+
+class Fake
+    attr_accessor :elements
+
+    include Sketch::DSL
+
+    def initialize
+	@elements = []
+    end
+
+    def push(*args)
+	elements.push args.first
+    end
+end
+
+describe Sketch::DSL do
+    Point = Geometry::Point
+
+    subject { Fake.new }
+
+    it "must have a first command that returns the first element" do
+	point = Geometry::Point[1,2]
+	subject.elements.push point
+	subject.first.must_be_same_as point
+    end
+
+    it "must have a last command that returns the last element" do
+	point = Point[1,2]
+	subject.elements.push Point[3,4]
+	subject.elements.push point
+	subject.last.must_be_same_as point
+    end
+
+    it "must have a hexagon command" do
+	subject.hexagon center:[1,2], radius:5
+	subject.last.must_be_instance_of Geometry::RegularPolygon
+	subject.last.center.must_equal Point[1,2]
+	subject.last.edge_count.must_equal 6
+	subject.last.radius.must_equal 5
+    end
+
+    it 'must have a path command that takes a list of points' do
+	subject.path [1,2], [2,3]
+	subject.last.must_be_kind_of Geometry::Path
+	subject.last.elements.count.must_equal 1
+    end
+
+    it 'must have a path command that takes a block' do
+	subject.path do
+	    start_at    [0,0]
+	    move_to	[1,1]
+	end
+	subject.last.must_be_kind_of Geometry::Path
+	subject.last.elements.count.must_equal 1
+    end
+
+    describe "when layout" do
+	describe "without spacing" do
+	    it "must do a horizontal layout" do
+		subject.layout :horizontal do
+		    rectangle from:[0,0], to:[5,5]
+		    rectangle from:[0,0], to:[6,6]
+		end
+
+		group = subject.first
+		group.must_be_instance_of Sketch::Layout
+
+		group.first.must_be_kind_of Geometry::Rectangle
+		group.last.must_be_kind_of Sketch::Group
+	    end
+
+	    it "must do a vertical layout" do
+	    end
+	end
+
+	describe "with spacing" do
+	    it "must do a horizontal layout" do
+	    end
+
+	    it "must do a vertical layout" do
+	    end
+	end
+    end
+
+    it 'must have a polygon command that takes a list of points' do
+	polygon = subject.polygon [0,0], [1,0], [1,1], [0,1]
+	polygon.must_be_kind_of Sketch::Polygon
+	subject.last.vertices.size.must_equal 4
+    end
+
+    it 'must have a polygon command that takes a block' do
+	subject.polygon do
+	    start_at    [0,0]
+	    move_to	    [1,0]
+	    move_to	    [1,1]
+	    move_to	    [0,1]
+	end
+	subject.last.must_be_kind_of Sketch::Polygon
+	subject.elements.size.must_equal 1
+	subject.last.vertices.size.must_equal 4
+    end
+end