geo_vectors 0.5.0

data/spec/geo_vectors/point_vector/add_vector_spec.rb

@@ -0,0 +1,135 @@
+# h3. Addition
+# 
+# Vectors can be added to form a new Vector, using the simple formula vec = v1 + v2 = (v1.x + v2.y, v1.x + v2.y)
+# 
+# h3. Vector on Vector addition
+# 
+# If both vectors are point vectors, the result is simply a new point vector
+# 
+# <pre>
+#   v1 = [1, 3].vector
+#   v2 = [-2, 2].vector
+#   vec = v1 + v2
+#   vec.unit.should == :degrees
+#   vec.lat.should == -1
+#   vec.lng.should == 5
+# 
+#   # alternative addition operators
+#   vec = v1 << v2  
+# </pre>  
+# 
+# h3. Vector subtraction
+# 
+# <pre>
+#   v1 = [1, 3].vector
+#   v2 = [2, 1].vector
+#   vec = v1 - v2 # here v2 inversed (scaled by -1) and then added 
+#   vec.lat.should == -1
+#   vec.lng.should == 2
+# </pre>
+# 
+
+# h3. Vector scaling
+# 
+# <pre>
+#   v1 = [1, 3].vector
+#   vec = v1 * 2
+#   vec.lat.should == 2
+#   vec.lng.should == 6
+# </pre>
+
+require 'spec_helper'
+
+describe PointVector do
+  describe 'Vector on Vector Addition' do
+    context 'Point vector (4, 2)' do
+      describe '#+ operator' do      
+        let (:vec) { vec = [4, 2].vector }
+        
+        it 'should Add one geo vector' do
+          v2 = vec + [1, 2].vector
+          v2.lat.should == 5
+          v2.lng.should == 4
+        end
+      end #+
+
+      # describe '#add! operator' do      
+      #   let (:vec) { vec = [4, 2].vector }
+      #   
+      #   it 'should Add one geo vector' do
+      #     vec.add!([1,2].vector)
+      #     vec.lng.should == 4
+      #     vec.lat.should == 5
+      #   end
+      # 
+      #   describe 'converting args to vector' do
+      #     let (:vec) { vec = [4, 2].vector }
+      # 
+      #     it 'should Add after converting number args to geo vector' do
+      #       vec.add!(1,2)
+      #       vec.lat.should == 5
+      #       vec.lng.should == 4
+      #     end
+      # 
+      #     it 'should Add one geo vector' do
+      #       vec.add!("1,2")
+      #       vec.lat.should == 5
+      #       vec.lng.should == 4
+      #     end
+      #   end # add!
+      # end # point vector
+
+      describe '#add operator' do      
+        let (:vec) { vec = [4, 2].vector }
+        
+        it 'should Add one geo vector' do
+          v2 = vec.add([1,2].vector)
+          v2.lng.should == 4
+          v2.lat.should == 5
+        end
+      
+        describe 'converting args to vector' do
+          let (:vec) { vec = [4, 2].vector }
+
+          it 'should Add after converting number args to geo vector' do
+            v2 = vec.add(1,2)
+            v2.lat.should == 5
+            v2.lng.should == 4
+          end
+
+          it 'should Add one geo vector' do
+            v2 = vec.add("1,2")
+            v2.lat.should == 5
+            v2.lng.should == 4
+          end
+        end # add!
+      end # point vector
+
+      
+      # context 'Bearing vector (60, 2.km)' do
+      #   let(:vec) { vec = [4, 2].vector }        
+      #   let(:brng_vec) { BearingVector.new 60, 2.km }
+      #   
+      #   describe '#add!' do
+      #     it 'should raise error when applying bearing vector directly on a point vector' do
+      #       lambda {vec.apply!(brng_vec)}.should raise_error
+      #     end
+      #   end
+      #   
+      #   describe '#+ (add)' do
+      #     it 'should add the vector and create a new PointVectors from result' do
+      #       vectors = vec + brng_vec
+      #       vectors.should be_a GeoVectors
+      #     end
+      #   end
+      # 
+      #   describe '#<< (push)' do
+      #     it 'should add the vector and create a new point from result' do
+      #       vectors = vec << brng_vec
+      #       vectors.should be_a GeoVectors
+      #     end
+      #   end        
+      # end      
+    end
+  end
+end

data/spec/geo_vectors/point_vector/initializer_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe PointVector do
+  describe '#initialize' do
+    describe 'pure call' do    
+      it 'should init from an Array' do
+        vec = PointVector.new [11.1, 2]
+        vec.should be_a(PointVector)
+        vec.lat.should == 11.1
+        vec.lng.should == 2      
+      end
+
+      it 'should init from a Hash' do
+        vec = PointVector.new :lat => 11.1, :lon => 2
+        vec.should be_a(PointVector)
+        vec.lat.should == 11.1
+        vec.lng.should == 2
+      end
+
+      it 'should init from a String' do
+        vec = PointVector.new "11.1, 2"
+        vec.should be_a(PointVector)
+        vec.lat.should == 11.1
+        vec.lng.should == 2
+      end
+
+      describe 'two args' do
+        it 'should init from two Strings' do
+          vec = PointVector.new "11.1", "2"
+          vec.should be_a(PointVector)
+          vec.lat.should == 11.1
+          vec.lng.should == 2
+        end
+
+        it 'should init from two numbers' do
+          vec = PointVector.new 11.1, 2
+          vec.should be_a(PointVector)
+          vec.lat.should == 11.1
+          vec.lng.should == 2
+        end
+
+        it 'should init from a number and a String' do
+          vec = PointVector.new 11.1, "2"
+          vec.should be_a(PointVector)
+          vec.lat.should == 11.1
+          vec.lng.should == 2
+        end
+      end
+    end
+    
+    describe 'factory methods on other class' do
+      it 'should init from an Array' do
+        vec = [11.1, 2].geo_vector
+        vec.should be_a(PointVector)
+        vec.lat.should == 11.1
+        vec.lng.should == 2      
+      end
+
+      it 'should init from a GeoPoint' do
+        vec = "11.1, 2".geo_point.geo_vector
+        vec.should be_a(PointVector)
+        vec.lat.should == 11.1
+        vec.lng.should == 2
+      end
+
+      it 'should init from a Hash' do
+        vec = {:lat => 11.1, :lon => 2}.geo_vector
+        vec.should be_a(PointVector)
+        vec.lat.should == 11.1
+        vec.lng.should == 2
+      end
+
+      it 'should init from a String' do
+        vec = "11.1, 2".geo_vector
+        vec.should be_a(PointVector)
+        vec.lat.should == 11.1
+        vec.lng.should == 2
+      end
+    end
+  end
+end
+      

data/spec/geo_vectors/point_vector/point_add_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe PointVector do
+  describe 'PointAdd module' do
+    context 'GeoPoint (3, 5)' do
+      let(:point) { GeoPoint.new 3, 5 }
+    
+      context 'Simple vector (1, 2)' do
+        let(:vector) { PointVector.new 1, 2 }
+
+        describe '#add!' do
+          before :each do
+            @p = GeoPoint.new 3, 5
+          end
+          
+          it 'should Add the vector: (1, 2)' do
+            @p.add!(vector)
+            @p.lat.should == 4
+            @p.lng.should == 7
+          end
+        end
+
+        describe '#+ (add)' do
+          it 'should add the vector (1, 2) and create a new point from result' do
+            p2 = point + vector
+            point.lat.should == 3 # no change
+            point.lng.should == 5
+            p2.lat.should == 4 # new point should be result of addition
+            p2.lng.should == 7
+          end
+        end
+
+        describe '#<< (push)' do
+          it 'should add the vector (1, 2) and create a new point from result' do
+            p2 = point << vector
+            point.lat.should == 3 # no change
+            point.lng.should == 5
+            p2.lat.should == 4 # new point should be result of addition
+            p2.lng.should == 7
+          end
+        end
+      end # context Simple vector      
+    end
+  end
+end

data/spec/geo_vectors/point_vector/random_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe GeoVector do
+  describe 'Random module' do
+    context 'Point vector (4, 2)' do
+      describe '#random_vector' do      
+        let (:vec) { vec = [4, 2].vector }
+        
+        it 'should return a random vector to a point within bounding box' do
+          rvec = vec.random_vector
+          rvec.lat.should be_between(-4, 4)
+          rvec.lng.should be_between(-2, 2)
+        end
+      end
+    end
+  end
+end

data/spec/geo_vectors/point_vector/scale_vector_spec.rb

@@ -0,0 +1,52 @@
+# h3. Vector scaling
+# 
+# <pre>
+#   v1 = [1, 3].vector
+#   vec = v1 * 2
+#   vec.lat.should == 2
+#   vec.lng.should == 6
+# </pre>
+
+require 'spec_helper'
+
+describe PointVector do
+  describe 'Scaling' do
+    let (:vec) { [4, 2].geo_vector }
+
+    describe '#* operator' do
+      it 'should scale the vector 2 times bigger (* 2)' do
+        v2 = vec * 2
+        v2.lat.should == 8
+        v2.lng.should == 4
+      end
+
+      it 'should scale the vector to half size (* 0.5)' do
+        v2 = vec * 0.5
+        v2.lat.should == 2
+        v2.lng.should == 1
+      end
+    end
+
+    describe '#/ operator' do
+      it 'should scale the vector 2 times bigger (/ 0.5)' do
+        v2 = vec / 0.5
+        v2.lat.should == 8
+        v2.lng.should == 4
+      end
+
+      it 'should scale the vector to half size bigger (/ 2)' do
+        v2 = vec / 2
+        v2.lat.should == 2
+        v2.lng.should == 1
+      end
+    end
+    
+    describe '# scale! operator' do
+      it 'should scale the vector 2 times bigger (* 2)' do
+        vec.scale!(2)
+        vec.lat.should == 8
+        vec.lng.should == 4      
+      end
+    end
+  end
+end

data/spec/geo_vectors/point_vector/subtract_vector_spec.rb

@@ -0,0 +1,80 @@
+# h3. Addition
+# 
+# Vectors can be added to form a new Vector, using the simple formula vec = v1 + v2 = (v1.x + v2.y, v1.x + v2.y)
+# 
+# h3. Vector on Vector subtraction
+# 
+# h3. Vector subtraction
+# 
+# <pre>
+#   v1 = [1, 3].vector
+#   v2 = [2, 1].vector
+#   vec = v1 - v2 # here v2 inversed (scaled by -1) and then added 
+#   vec.lat.should == -1
+#   vec.lng.should == 2
+# </pre>
+# 
+
+# h3. Vector scaling
+# 
+# <pre>
+#   v1 = [1, 3].vector
+#   vec = v1 * 2
+#   vec.lat.should == 2
+#   vec.lng.should == 6
+# </pre>
+
+require 'spec_helper'
+
+describe GeoVector do
+  describe 'Vector on Vector Subtraction' do
+    describe '#- operator' do
+      let (:vec) { vec = [4, 3].vector }
+      
+      it 'should Subtract one geo vector' do
+        v = [1, 2].vector
+        v2 = vec - v
+        v2.should_not == vec
+        v2.lat.should == 3
+        v2.lng.should == 1
+      end
+    end
+
+    describe '#sub operator (alias for -)' do
+      let (:vec) { vec = [4, 3].vector }
+      
+      it 'should Subtract one geo vector' do
+        v = [1, 2].vector
+        v2 = vec.sub(v)
+        v2.should_not == vec
+        v2.lat.should == 3
+        v2.lng.should == 1
+      end
+    end
+
+    describe '#sub! operator' do
+      let (:vec) { vec = [4, 3].vector }
+      
+      it 'should Subtract one geo vector' do
+        v2 = vec.sub!([1,2].vector)
+        v2.should == vec        
+        vec.lat.should == 3
+        vec.lng.should == 1
+      end
+
+      describe 'converting args to vector' do
+        it 'should Subtract after converting number args to geo vector' do
+          vec.sub!(1,2)
+          vec.lat.should == 3
+          vec.lng.should == 1
+        end
+
+        it 'should Subtract one geo vector' do
+          vec.sub!("1,2")
+          vec.lat.should == 3
+          vec.lng.should == 1
+        end
+      end
+    end
+  end
+end

data/spec/geo_vectors/point_vector_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe PointVector do
+  describe '#initialize' do
+    it 'should initialize from an Array' do
+      vec = [1, 2].point_vector
+      vec.should be_a PointVector
+    end
+    
+    it 'should set origin at 0,0' do
+      origin = [0, 0].geo_point
+      origin.lat.should == 0       
+      origin.lng.should == 0
+    end
+  end
+
+  context 'Simple vector at (1, 2) - x,y arg' do
+    let(:vector) { PointVector.new 1, 2 }
+    
+    it 'should create a PointVector: x=1, y=1' do
+      vector.should be_a PointVector
+      vector.y.should == 1          
+      vector.x.should == 2      
+    end
+
+    it 'should create a vector: lat=1, lng=1' do
+      vector.lat.should == 1
+      vector.lng.should == 2
+    end
+
+    it 'should create a vector: latitude=1, longitude=1' do
+      vector.latitude.should == 1
+      vector.longitude.should == 2
+    end
+  end
+
+  context 'Simple vector at (1, 2) - Array arg' do
+    let(:vector) { PointVector.new [1, 2] }
+
+    it 'should create a vector: x=1, y=2' do
+      vector.y.should == 1
+      vector.x.should == 2
+    end
+  end
+
+  context 'Vectors from points: p1 = (1,2) ; p2 = (4,6) ' do
+    before do
+      @p1 = GeoPoint.new 1,2
+      @p2 = GeoPoint.new 4,6      
+    end
+
+    it 'should create a vector between the points p1 and p2' do
+      @vec = PointVector.new @p1, @p2
+      @vec.y.should == 3
+      @vec.x.should == 4      
+    end
+  end
+
+  pending 'TODO' do
+    context 'Simple vector at (1, 2) and a direction vector' do
+      before do
+        @p1     = GeoPoint.new 1,2
+        @east_4 = DirectionVector.new 4.km, :east
+      end
+  
+      it 'should create a vector between a point and a new point generated from applying the direction to the point' do
+        @vec = PointVector.new @p1, @east_4
+        @vec.x.should == 1
+        @vec.y.should == 6      
+      end
+    end
+  end
+
+  context 'Simple vector at (1, 2) - GeoPoint arg' do
+    let(:vector) { PointVector.new [1, 2].to_point }
+
+    describe '#length' do  
+      it 'should have a distance between 240 - 250 km' do
+        kms = vector.length
+        kms.should be_between(240, 250)
+      end
+    end
+  
+    describe '#distance' do  
+      it 'should have a distance between 240 - 250 km' do
+        dist = vector.distance
+        dist.should be_a GeoDistance
+        dist.in_meters.should be_between(240000, 250000)
+      end
+    end
+  
+    describe '#point=' do
+      before do
+        @vec = PointVector.new [1, 2].to_point
+      end
+      
+      it 'should set a new vector point of 2,3' do        
+        @vec.y.should == 1
+        @vec.x.should == 2
+        @vec.point = 2, 3
+        @vec.y.should == 2      
+        @vec.x.should == 3
+      end
+      
+      it 'should return a new distance between 240 - 250' do
+        kms = @vec.distance.in_kms
+        kms.should be_between(240, 250)
+      end
+    end
+  end  
+end