triangular 0.0.2 → 0.1.1

data/spec/triangular/line_spec.rb

@@ -0,0 +1,285 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Triangular::Line do
+  describe '#intersects_z?' do
+    context 'for a line that intersects the target Z plane' do
+      context 'with a positive Z vector' do
+        before do
+          @line = Triangular::Line.new(Triangular::Vertex.new(0.0, 0.0, 0.0), Triangular::Vertex.new(0.0, 0.0, 6.0))
+        end
+
+        it 'should return true' do
+          expect(@line.intersects_z?(3.0)).to be true
+        end
+      end
+
+      context 'with a negative Z vector' do
+        before do
+          @line = Triangular::Line.new(Triangular::Vertex.new(0.0, 0.0, 6.0), Triangular::Vertex.new(0.0, 0.0, 0.0))
+        end
+
+        it 'should return true' do
+          expect(@line.intersects_z?(3.0)).to be true
+        end
+      end
+    end
+
+    context 'for a line that does not intersect the target Z plane' do
+      before do
+        @line = Triangular::Line.new(Triangular::Vertex.new(0.0, 0.0, 4.0), Triangular::Vertex.new(0.0, 0.0, 6.0))
+      end
+
+      it 'should return false' do
+        expect(@line.intersects_z?(3.0)).to be false
+      end
+    end
+  end
+
+  describe '#intersection_at_z' do
+    context 'for a line that intersects the target Z plane' do
+      context 'and spans both positive and negative space' do
+        context 'with a positive Z vector' do
+          before do
+            @line = Triangular::Line.new(Triangular::Vertex.new(-1.0, 1.0, 1.0), Triangular::Vertex.new(1.0, 1.0, -1.0))
+          end
+
+          it 'should return a Point representing the intersection' do
+            expect(@line.intersection_at_z(0).x).to eq(0.0)
+            expect(@line.intersection_at_z(0).y).to eq(1.0)
+            expect(@line.intersection_at_z(0).z).to eq(0.0)
+          end
+        end
+
+        context 'with a negative Z vector' do
+          before do
+            @line = Triangular::Line.new(Triangular::Vertex.new(1.0, 1.0, 1.0),
+                                         Triangular::Vertex.new(-1.0, -1.0, -1.0))
+          end
+
+          it 'should return a Point representing the intersection' do
+            expect(@line.intersection_at_z(0).x).to eq(0)
+            expect(@line.intersection_at_z(0).y).to eq(0)
+            expect(@line.intersection_at_z(0).z).to eq(0)
+          end
+        end
+      end
+    end
+
+    context 'for a line that lies on the target Z plane' do
+      before do
+        @line = Triangular::Line.new(Triangular::Vertex.new(0.0, 0.0, 3.0), Triangular::Vertex.new(0.0, 6.0, 3.0))
+      end
+
+      it 'should raise an error' do
+        expect(@line.intersection_at_z(3.0)).to eq(nil)
+      end
+    end
+
+    context 'for a line that does not intersect the target Z plane' do
+      before do
+        @line = Triangular::Line.new(Triangular::Vertex.new(0.0, 0.0, 4.0), Triangular::Vertex.new(0.0, 0.0, 6.0))
+      end
+
+      it 'should return nil' do
+        expect(@line.intersection_at_z(3.0)).to be_nil
+      end
+    end
+  end
+
+  describe '#intersects_x?' do
+    context 'for a line that intersects the target X plane' do
+      context 'with a positive X vector' do
+        before do
+          @line = Triangular::Line.new(Triangular::Vertex.new(2.0, 0.0, 0.0), Triangular::Vertex.new(3.2, 0.0, 6.0))
+        end
+
+        it 'should return true' do
+          expect(@line.intersects_x?(3.0)).to be true
+        end
+      end
+
+      context 'with a negative X vector' do
+        before do
+          @line = Triangular::Line.new(Triangular::Vertex.new(3.2, 0.0, 6.0), Triangular::Vertex.new(2.0, 0.0, 0.0))
+        end
+
+        it 'should return true' do
+          expect(@line.intersects_x?(3.0)).to be true
+        end
+      end
+    end
+
+    context 'for a line that does not intersect the target X plane' do
+      before do
+        @line = Triangular::Line.new(Triangular::Vertex.new(0.0, 0.0, 4.0), Triangular::Vertex.new(0.0, 0.0, 6.0))
+      end
+
+      it 'should return false' do
+        expect(@line.intersects_x?(3.0)).to be false
+      end
+    end
+  end
+
+  describe '#intersection_at_x' do
+    context 'for a line that intersects the target X plane' do
+      context 'and spans both positive and negative space' do
+        context 'with a positive X vector' do
+          before do
+            @line = Triangular::Line.new(Triangular::Vertex.new(-1.0, 2.0, 1.0), Triangular::Vertex.new(1.0, 2.0, -1.0))
+          end
+
+          it 'should return a Point representing the intersection' do
+            expect(@line.intersection_at_x(0).x).to eq(0.0)
+            expect(@line.intersection_at_x(0).y).to eq(2.0)
+            expect(@line.intersection_at_x(0).z).to eq(0.0)
+          end
+        end
+
+        context 'with a negative X vector' do
+          before do
+            @line = Triangular::Line.new(Triangular::Vertex.new(1.0, 1.0, 1.0),
+                                         Triangular::Vertex.new(-1.0, -1.0, -1.0))
+          end
+
+          it 'should return a Point representing the intersection' do
+            expect(@line.intersection_at_x(0).x).to eq(0)
+            expect(@line.intersection_at_x(0).y).to eq(0)
+            expect(@line.intersection_at_x(0).z).to eq(0)
+          end
+        end
+      end
+    end
+
+    context 'for a line that lies on the target X plane' do
+      before do
+        @line = Triangular::Line.new(Triangular::Vertex.new(3.0, 0.0, 3.0), Triangular::Vertex.new(3.0, 6.0, 6.0))
+      end
+
+      it 'should raise an error' do
+        expect(@line.intersection_at_x(3.0)).to eq(nil)
+      end
+    end
+
+    context 'for a line that does not intersect the target X plane' do
+      before do
+        @line = Triangular::Line.new(Triangular::Vertex.new(4.0, 0.0, 4.0), Triangular::Vertex.new(6.0, 0.0, 6.0))
+      end
+
+      it 'should return nil' do
+        expect(@line.intersection_at_x(3.0)).to be_nil
+      end
+    end
+  end
+
+  describe '#intersects_y?' do
+    context 'for a line that intersects the target Y plane' do
+      context 'with a positive Y vector' do
+        before do
+          @line = Triangular::Line.new(Triangular::Vertex.new(0.0, 2.0, 0.0), Triangular::Vertex.new(0.0, 3.1, 6.0))
+        end
+
+        it 'should return true' do
+          expect(@line.intersects_y?(3.0)).to be true
+        end
+      end
+
+      context 'with a negative Y vector' do
+        before do
+          @line = Triangular::Line.new(Triangular::Vertex.new(0.0, 3.1, 6.0), Triangular::Vertex.new(0.0, 2.0, 0.0))
+        end
+
+        it 'should return true' do
+          expect(@line.intersects_y?(3.0)).to be true
+        end
+      end
+    end
+
+    context 'for a line that does not intersect the target Y plane' do
+      before do
+        @line = Triangular::Line.new(Triangular::Vertex.new(0.0, 0.0, 4.0), Triangular::Vertex.new(0.0, 0.0, 6.0))
+      end
+
+      it 'should return false' do
+        expect(@line.intersects_y?(3.0)).to be false
+      end
+    end
+  end
+
+  describe '#intersection_at_y' do
+    context 'for a line that intersects the target Y plane' do
+      context 'and spans both positive and negative space' do
+        context 'with a positive Y vector' do
+          before do
+            @line = Triangular::Line.new(Triangular::Vertex.new(2.0, -1.0, 1.0), Triangular::Vertex.new(2.0, 1.0, -1.0))
+          end
+
+          it 'should return a Point representing the intersection' do
+            expect(@line.intersection_at_y(0).x).to eq(2.0)
+            expect(@line.intersection_at_y(0).y).to eq(0.0)
+            expect(@line.intersection_at_y(0).z).to eq(0.0)
+          end
+        end
+
+        context 'with a negative Y vector' do
+          before do
+            @line = Triangular::Line.new(Triangular::Vertex.new(1.0, 1.0, 1.0),
+                                         Triangular::Vertex.new(-1.0, -1.0, -1.0))
+          end
+
+          it 'should return a Point representing the intersection' do
+            expect(@line.intersection_at_y(0).x).to eq(0)
+            expect(@line.intersection_at_y(0).y).to eq(0)
+            expect(@line.intersection_at_y(0).z).to eq(0)
+          end
+        end
+      end
+    end
+
+    context 'for a line that lies on the target Y plane' do
+      before do
+        @line = Triangular::Line.new(Triangular::Vertex.new(3.0, 3.0, 3.0), Triangular::Vertex.new(3.0, 3.0, 6.0))
+      end
+
+      it 'should raise an error' do
+        expect(@line.intersection_at_y(3.0)).to eq(nil)
+      end
+    end
+
+    context 'for a line that does not intersect the target Y plane' do
+      before do
+        @line = Triangular::Line.new(Triangular::Vertex.new(4.0, 4.0, 4.0), Triangular::Vertex.new(6.0, 6.0, 6.0))
+      end
+
+      it 'should return nil' do
+        expect(@line.intersection_at_y(3.0)).to be_nil
+      end
+    end
+  end
+
+  describe '==' do
+    it 'should return true when the two lines are identical' do
+      expect(
+        Triangular::Line.new(Triangular::Vertex.new(-1.0, -1.0, -1.0), Triangular::Vertex.new(1.0, 1.0, 1.0)) ==
+        Triangular::Line.new(Triangular::Vertex.new(-1.0, -1.0, -1.0), Triangular::Vertex.new(1.0, 1.0, 1.0))
+      ).to be true
+    end
+
+    it 'should not return true when the lines are not identical' do
+      expect(
+        Triangular::Line.new(Triangular::Vertex.new(-1.0, -1.0, -1.1), Triangular::Vertex.new(1.0, 1.0, 1.0)) ==
+        Triangular::Line.new(Triangular::Vertex.new(-1.0, -1.0, -1.0), Triangular::Vertex.new(1.0, 1.0, 1.0))
+      ).to be false
+    end
+  end
+
+  describe '#to_svg_path' do
+    it 'should return a string containing an SVG path' do
+      line = Triangular::Line.new(Triangular::Vertex.new(0.0, 0.0, 0.0), Triangular::Vertex.new(1.0, 1.0, 1.0))
+      expected_output = '<path d="M 0.0 0.0 L 1.0 1.0" fill="none" stroke="black" stroke-width="0.005" />'
+
+      expect(line.to_svg_path(:inches)).to eq(expected_output)
+    end
+  end
+end

data/spec/triangular/point_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Triangular::Point do
+  describe '.parse' do
+    context 'with a correctly formatted point' do
+      before do
+        @result = Triangular::Point.parse('  16.5 0.0 -0.75 ')
+      end
+
+      it 'should return a point object' do
+        expect(@result).to be_a Triangular::Point
+      end
+
+      it 'should correctly set the X value' do
+        expect(@result.x).to eq(16.5)
+      end
+
+      it 'should correctly set the Y value' do
+        expect(@result.y).to eq(0)
+      end
+
+      it 'should correctly set the Z value' do
+        expect(@result.z).to eq(-0.75)
+      end
+    end
+
+    context 'with a point that contains exponential notation' do
+      before do
+        @result = Triangular::Point.parse('  -5.23431439438796e-32 0.0 5.23431439438796e32 ')
+      end
+
+      it 'should correctly set the X value' do
+        expect(@result.x).to eq(-5.23431439438796e-32)
+      end
+
+      it 'should correctly set the Y value' do
+        expect(@result.y).to eq(0.0)
+      end
+
+      it 'should correctly set the Z value' do
+        expect(@result.z).to eq(5.23431439438796e32)
+      end
+    end
+
+    context 'with a point with no fractional part' do
+      before do
+        @result = Triangular::Point.parse('  -5 0 5 ')
+      end
+
+      it 'should correctly set the X value' do
+        expect(@result.x).to eq(-5.0)
+      end
+
+      it 'should correctly set the Y value' do
+        expect(@result.y).to eq(0.0)
+      end
+
+      it 'should correctly set the Z value' do
+        expect(@result.z).to eq(5.0)
+      end
+    end
+  end
+
+  describe '#to_s' do
+    it 'should return the XYZ components separated by spaces' do
+      point = Triangular::Point.new(1.0, 2.0, -3.1)
+      expect(point.to_s).to eq('1.0 2.0 -3.1')
+    end
+
+    it 'should convert integers into floats for output' do
+      point = Triangular::Point.new(1, 2, 3)
+      expect(point.to_s).to eq('1.0 2.0 3.0')
+    end
+  end
+
+  describe '#==' do
+    it 'should return true when the points have identical values' do
+      expect(Triangular::Point.new(1.0, 2.0, -3.1) == Triangular::Point.new(1.0, 2.0, -3.1)).to be true
+    end
+
+    it 'should return false when the points do not have identical values' do
+      expect(Triangular::Point.new(1.0, 2.0, -3.1) == Triangular::Point.new(1.0, 2.0, -3.2)).to be false
+    end
+  end
+
+  describe '#translate!' do
+    before do
+      @point = Triangular::Point.new(1.0, 1.0, 1.0)
+    end
+
+    it 'should add the supplied value to X' do
+      @point.translate!(16.5, 9.5, 0.75)
+      expect(@point.x).to eq(17.5)
+    end
+
+    it 'should add the supplied value to Y' do
+      @point.translate!(16.5, 9.5, 0.75)
+      expect(@point.y).to eq(10.5)
+    end
+
+    it 'should add the supplied value to Z' do
+      @point.translate!(16.5, 9.5, 0.75)
+      expect(@point.z).to eq(1.75)
+    end
+  end
+end

data/spec/triangular/polyline_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Triangular::Polyline do
+  describe '#to_svg' do
+    it 'should output an SVG document as a string' do
+      line = Triangular::Line.new(Triangular::Vertex.new(0.0, 0.0, 0.0), Triangular::Vertex.new(1.0, 1.0, 1.0))
+      polyline = Triangular::Polyline.new([line])
+
+      expected_svg  = "<?xml version=\"1.0\" standalone=\"no\"?>\n"
+      expected_svg += "<!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\">\n"
+      expected_svg += "<svg x=\"0\" y=\"0\" width=\"20in\" height=\"30in\" viewBox=\"0 0 20 30\" xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\">\n"
+      expected_svg += "  <g transform=\"translate(1in,2in)\">\n"
+      expected_svg += "    #{line.to_svg_path(:inches)}\n"
+      expected_svg += "  </g>\n"
+      expected_svg += '</svg>'
+
+      expect(polyline.to_svg(20, 30, :inches, 1, 2)).to eq(expected_svg)
+    end
+  end
+end

data/spec/triangular/ray_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Triangular::Ray do
+  describe '#intersection' do
+    before do
+      @ray = Triangular::Ray.new(1.0, 1.0)
+    end
+
+    context 'with facet that does not intersect the Ray' do
+      it 'should return nil' do
+        vertex1 = Triangular::Vertex.new(1.1, 1.1, 1.0)
+        vertex2 = Triangular::Vertex.new(2.0, 1.1, 1.0)
+        vertex3 = Triangular::Vertex.new(2.0, 2.0, 1.0)
+
+        facet = Triangular::Facet.new(nil, vertex1, vertex2, vertex3)
+
+        expect(@ray.intersection(facet)).to eq(nil)
+      end
+    end
+
+    context 'with flat facet that intersects the Ray' do
+      it 'should return Point that represents intersection' do
+        vertex1 = Triangular::Vertex.new(0.0, 0.0, 1.2)
+        vertex2 = Triangular::Vertex.new(2.0, 0.0, 1.2)
+        vertex3 = Triangular::Vertex.new(2.0, 2.0, 1.2)
+
+        facet = Triangular::Facet.new(nil, vertex1, vertex2, vertex3)
+
+        expect(@ray.intersection(facet)).to eq(Triangular::Point.new(1.0, 1.0, 1.2))
+      end
+    end
+
+    context 'with simple angled facet that intersects the Ray' do
+      it 'should return Point that represents intersection' do
+        vertex1 = Triangular::Vertex.new(0.0, 0.0, 0.0)
+        vertex2 = Triangular::Vertex.new(2.0, 0.0, 2.0)
+        vertex3 = Triangular::Vertex.new(2.0, 2.0, 2.0)
+
+        facet = Triangular::Facet.new(nil, vertex1, vertex2, vertex3)
+
+        expect(@ray.intersection(facet)).to eq(Triangular::Point.new(1.0, 1.0, 1.0))
+      end
+    end
+
+    context 'with compound angled facet that intersects the Ray' do
+      before do
+        @ray = Triangular::Ray.new(0.5, 0.5)
+      end
+
+      it 'should return Point that represents intersection' do
+        vertex1 = Triangular::Vertex.new(0.0, 0.0, 0.0)
+        vertex2 = Triangular::Vertex.new(2.0, 0.0, 1.0)
+        vertex3 = Triangular::Vertex.new(0.0, 2.0, 2.0)
+
+        facet = Triangular::Facet.new(nil, vertex1, vertex2, vertex3)
+
+        expect(@ray.intersection(facet)).to eq(Triangular::Point.new(0.5, 0.5, 0.75))
+      end
+    end
+  end
+end