geo_vectors 0.5.0 → 0.5.1

data/README.textile

@@ -1,6 +1,6 @@
 h1. Geo Vectors
 
-Vector classes and operations for Geo calculations.
+Vector classes and operations for performing various Geo calculations.
 
 h2. Install
 
@@ -24,30 +24,35 @@ A GeoVector can be any of:
 2) *direction vector* - direction (:N, :NW, :NE, :S, :SE, :SW, :E, :W) and a distance
 3) *point vector* - number of degrees due east/west (+ or -) and a distance due north/south (+ or -)
 
-Note that a direction vector is always converted to a bearing vector when added to a point
-
 A GeoVector can be applied to a GeoPoint (see geo_calc) or to another GeoVector.
-When multiple vectors are added together, the sum becomes a GeoVectors object.
-If a GeoVectors object is applied, the vectors are simply applied in turn.
+
+h3. Multiple vectors
+
+When multiple vectors are added (or grouped) together, the sum becomes a GeoVectors object except when PointVectors are added the result is a new PointVector.
+When a GeoVectors object is applied (added or subtracted) to a GeoPoint instance, all the vectors are applied in succession to the geo point.
+See the specs for more details on the API for a GeoVectors object.
 
 h2. Quick start (Usage guide)
 
-The following gives a quick overview for how to use the GeoVector API.
+The following gives a quick overview on how to use the GeoVectors API.
 
-_Note: This is suggested functionality._
+Note that using @[1, 2].vector@ and similar macros (core Ruby extensions), requires that you include the optional macros:
 
-I plan to use my recently published _geo_calc_ gem as the base for the functionality described here.
-I need a major cleanup up of the current code...
+@require 'geo_vectors/macros'@
 
-h3. Addition
+h3. Vector math
 
-Vectors can be added to form a new Vector, using the simple formula vec = v1 + v2 = (v1.x + v2.y, v1.x + v2.y)
+*Vector on Vector addition*
 
-h3. Vector on Vector addition
+If both vectors are point vectors, the result is simply a new point vector.
+Point vectors can be added to form a new Point vector, using the simple formula 
 
-If both vectors are point vectors, the result is simply a new point vector
+@vec = v1 + v2 = (v1.x + v2.y, v1.x + v2.y)@
 
 <pre>
+  require 'geo_vectors'
+  require 'geo_vectors/macros'  
+  
   v1 = [1, 3].vector
   v2 = [-2, 2].vector
   vec = v1 + v2
@@ -59,7 +64,7 @@ If both vectors are point vectors, the result is simply a new point vector
   vec = v1 << v2  
 </pre>  
 
-h3. Vector subtraction
+*Vector subtraction*
 
 <pre>
   v1 = [1, 3].vector
@@ -69,7 +74,7 @@ h3. Vector subtraction
   vec.lng.should == 2
 </pre>
 
-h3. Vector scaling
+*Vector scaling*
 
 <pre>
   v1 = [1, 3].vector
@@ -78,25 +83,40 @@ h3. Vector scaling
   vec.lng.should == 6
 </pre>
 
-Scale a bearing vector
+Other scale methods: #scale, #scale!
+
+*Inverse scaling (reduction)*
 
 <pre>
-  v1 = [32, 3.km].vector
+  v1 = [4, 2].vector
+  vec = v1 / 2
+  vec.lat.should == 2
+  vec.lng.should == 1
+</pre>
+
+You can also call #reduce to get the same effect
+
+h2. Bearing vectors
+
+*Vector scaling*
+
+<pre>
+  v1 = [3.km, 32].vector
   vec = v1 * 2
   vec.bearing.should == 32
   vec.distance.should == 6.km
 </pre>
 
-
-Using division operator / for inverse scaling
+*Generate random vector*
 
 <pre>
-  v1 = [4, 2].vector
-  vec = v1 / 2
-  vec.lat.should == 2
-  vec.lng.should == 1
+  v1 = [3.km, 32].vector
+  random_vec = v1.random_vector
+  random_vec.distance.number.should be_between(0, 3)
 </pre>
 
+This can be used to generate a random point within a circle (i.e radius of a point).
+
 h3. GeoVectors 
 
 Adding a point Vector to a bearing Vector
@@ -125,9 +145,9 @@ containing both vectors. A GeoVectors is a composite vector.
   p2 = p1 + vec # Add GeoVectors to the point
 </pre>
 
-h3. Vector on Point addition
+h3. GeoPoint addition
 
-Add a point Vector to a GeoPoint
+Add a Vector to a GeoPoint
 
 <pre>
   p1 = [1, 3].geo_point
@@ -137,7 +157,18 @@ Add a point Vector to a GeoPoint
   p2.lng.should == 5  
 </pre>
 
-Add an inverse point Vector (subtract) to a GeoPoint
+Other subtract methods: #add, #add!
+
+<pre>
+  p1 = [1, 3].geo_point
+  p1.add!(-2, 2)
+  p1.lat.should == -1
+  p1.lng.should == 5  
+</pre>
+
+h3. GeoPoint subtraction
+
+Subtract a Vector from a GeoPoint
 
 <pre>
   p1 = [1, 3].geo_point
@@ -147,21 +178,26 @@ Add an inverse point Vector (subtract) to a GeoPoint
   p2.lng.should == 2
 </pre>
 
-Add a bearing Vector to a GeoPoint
+Subtract a bearing Vector from a GeoPoint
 
 <pre>
   p1 = [1, 3].geo_point
 
   # 32 deg bearing, 2.km
   vec = [32, 2.km].vector 
-
-  # use #destination_point from 'geo_calc' project
-  p2 = p1 + vec
+  p2 = p1 - vec
 </pre>
 
-Note: You can also subtract (add with inverse bearing direction)
+Other subtract methods: #sub, #sub!
+
+<pre>
+  p1 = [1, 3].geo_point
+  p1.sub!(2.km, 32)
+  p1.lat.should == -1
+  p1.lng.should == 5  
+</pre>
 
-h2. Contributing to geo_vectors
+h2. Contributing to Geo Vectors
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/geo_vectors.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geo_vectors}
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Kristian Mandrup}]
-  s.date = %q{2011-05-23}
+  s.date = %q{2011-05-24}
   s.description = %q{Works with geo_calc and other geo libraries}
   s.email = %q{kmandrup@gmail.com}
   s.extra_rdoc_files = [
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     "lib/geo_vectors/geo_point.rb",
     "lib/geo_vectors/geo_vector.rb",
     "lib/geo_vectors/geo_vectors.rb",
+    "lib/geo_vectors/macros.rb",
     "lib/geo_vectors/point_vector.rb",
     "lib/geo_vectors/point_vector/point_ops.rb",
     "lib/geo_vectors/point_vector/vector_ops.rb",
@@ -40,23 +41,27 @@ Gem::Specification.new do |s|
     "lib/geo_vectors/util/calc.rb",
     "lib/geo_vectors/util/geo_direction.rb",
     "lib/geo_vectors/util/geo_distance.rb",
+    "lib/geo_vectors/util/geo_distance/units.rb",
     "lib/geo_vectors/util/geo_units.rb",
     "lib/geo_vectors/vector_parser.rb",
-    "spec/geo_vectors/API proposal guide.txt",
     "spec/geo_vectors/bearing_vector/add_vector_spec.rb",
+    "spec/geo_vectors/bearing_vector/point_add_spec.rb",
     "spec/geo_vectors/bearing_vector/random_spec.rb",
+    "spec/geo_vectors/bearing_vector/scale_spec.rb",
     "spec/geo_vectors/bearing_vector_spec.rb",
     "spec/geo_vectors/direction_vector/add_vector_spec.rb",
     "spec/geo_vectors/direction_vector/point_add_spec.rb",
     "spec/geo_vectors/direction_vector/random_spec.rb",
+    "spec/geo_vectors/direction_vector/scale_spec.rb",
     "spec/geo_vectors/direction_vector/subtract_vector_spec.rb",
     "spec/geo_vectors/direction_vector_spec.rb",
     "spec/geo_vectors/geo_vectors_spec.rb",
+    "spec/geo_vectors/macros_spec.rb",
     "spec/geo_vectors/point_vector/add_vector_spec.rb",
     "spec/geo_vectors/point_vector/initializer_spec.rb",
     "spec/geo_vectors/point_vector/point_add_spec.rb",
     "spec/geo_vectors/point_vector/random_spec.rb",
-    "spec/geo_vectors/point_vector/scale_vector_spec.rb",
+    "spec/geo_vectors/point_vector/scale_spec.rb",
     "spec/geo_vectors/point_vector/subtract_vector_spec.rb",
     "spec/geo_vectors/point_vector_spec.rb",
     "spec/geo_vectors/util/geo_direction_spec.rb",
@@ -67,7 +72,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/kristianmandrup/geo_vectors}
   s.licenses = [%q{MIT}]
   s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.0}
+  s.rubygems_version = %q{1.8.3}
   s.summary = %q{Geo vector library for applying vectors to GeoPoints and for basic vector math}
 
   if s.respond_to? :specification_version then

data/lib/geo_vectors/bearing_vector.rb

@@ -39,6 +39,7 @@ class BearingVector < GeoVector
 
   # normalize to within 0-360 degrees
   def bearing= brng
+    raise ArgumentError, "Not a valid bearing: #{brng}. Did you expect a DirectionVector?" if brng.kind_of? Symbol
     @bearing  = brng.normalize_degrees
   end
 

data/lib/geo_vectors/core_ext.rb

@@ -8,47 +8,3 @@ class Float
   include GeoDistance::Unit
 end
 
-class GeoVector
-  module Macros
-    def point_vector
-      PointVector.new self.geo_point
-    end
-    alias_method :vector, :point_vector
-    alias_method :geo_vector, :point_vector
-    alias_method :p_vector, :point_vector
-  end
-end
-
-class GeoPoint
-  include ::GeoVector::Macros
-end
-
-class Hash
-  include GeoVector::Macros
-end
-
-class String
-  include GeoVector::Macros
-end
-
-class Array
-  include GeoVector::Macros
-
-  def b_vector
-    raise ArgumentException, "To create a BearingVector, the Array must contain at least 2 elements, one for bearing and oen for distance" if !(size >= 2)
-    BearingVector.new self[0], self[1]
-  end
-  alias_method :bearing_vector, :b_vector  
-
-  def d_vector
-    raise ArgumentException, "To create a DirectionVector, the Array must contain at least 2 elements, one for bearing and oen for distance" if !(size >= 2)
-    raise ArgumentException, "The second element in the Array must be a Symbol defining the direction of the vector" if !self[1].kind_of?(Symbol)
-    DirectionVector.new self[0], self[1]
-  end  
-  alias_method :direction_vector, :d_vector    
-  
-  def to_point
-    geo_point
-  end
-end    
-  

data/lib/geo_vectors/geo_vector.rb

@@ -46,8 +46,6 @@ class GeoVector
     self.dup.scale! scalar
   end      
   alias_method :*,  :scale
-  alias_method :enhance, :*
-  alias_method :grow_by, :*
 
   def / scalar
     scale (1.0 / scalar)

data/lib/geo_vectors/macros.rb

@@ -0,0 +1,34 @@
+class GeoVector
+  module Macros
+    def point_vector
+      PointVector.new self.geo_point
+    end
+    alias_method :geo_vector, :point_vector
+    alias_method :p_vector, :point_vector
+    
+    def vector
+      GeoVector::Parser.create_vector *self
+    end
+  end
+end
+
+class GeoPoint
+  include ::GeoVector::Macros
+end
+
+class Hash
+  include GeoVector::Macros
+end
+
+class String
+  include GeoVector::Macros
+end
+
+class Array
+  include GeoVector::Macros
+  
+  def to_point
+    geo_point
+  end
+end    
+

data/lib/geo_vectors/point_vector.rb

@@ -21,6 +21,10 @@ class PointVector < GeoVector
     end
   end
 
+  def self.origin
+    [0, 0].geo_point
+  end
+
   def direction
     brng = bearing
     begin
@@ -79,7 +83,7 @@ class PointVector < GeoVector
   end
   
   def origin
-    [0, 0].geo_point
+    PointVector.origin    
   end
 end
 

data/lib/geo_vectors/util/geo_distance/units.rb

@@ -0,0 +1,29 @@
+require 'active_support/inflector'
+
+class GeoDistance
+  # used to extend Fixnum and Float
+  module Unit
+    extend GeoUnits
+    extend GeoUnits::UnitMaps
+  
+    # from GeoUnits    
+    valid_units.map(&:to_s).each do |unit|
+      one  = unit.singularize
+      many = unit.pluralize
+      class_eval %{
+        def #{one}
+          GeoDistance.new self, :#{unit}
+        end          
+        alias_method :to_#{unit}, :#{one}
+        alias_method :in_#{unit}, :#{one}
+        alias_method :as_#{unit}, :#{one}
+        alias_method :#{many},    :#{one}
+      }
+    end   
+  
+    def [] key
+      raise ArgumentError, "Invalid unit key #{key}" if !respond_to? key
+      earth_radius[key] * self
+    end    
+  end   
+end

data/lib/geo_vectors/util/geo_distance.rb

@@ -1,5 +1,5 @@
 require 'geo_vectors/util/geo_units'
-require 'active_support/inflector'
+require 'geo_vectors/util/geo_distance/units'
 
 class GeoDistance
   include NumericCheckExt
@@ -93,31 +93,6 @@ class GeoDistance
     is_numeric?(dist) ? dist.send(unit) : dist  
   end
 
-  # used to extend Fixnum and Float
-  module Unit
-    extend GeoUnits
-    extend GeoUnits::UnitMaps
-    
-    # from GeoUnits    
-    valid_units.map(&:to_s).each do |unit|
-      one_unit = unit.singularize
-      class_eval %{
-        def #{one_unit}
-          GeoDistance.new self, :#{unit}
-        end          
-        alias_method :to_#{unit}, :#{one_unit}
-        alias_method :in_#{unit}, :#{one_unit}
-        alias_method :as_#{unit}, :#{one_unit}
-        alias_method :#{unit.pluralize}, :#{one_unit}
-      }
-    end   
-    
-    def [] key
-      raise ArgumentError, "Invalid unit key #{key}" if !respond_to? key
-      earth_radius[key] * self
-    end    
-  end
-
   module Extract
     def extract_distance dist
       case dist

data/lib/geo_vectors/util/geo_units.rb

@@ -49,5 +49,5 @@ module GeoUnits
        :radians => 111170
       }
     end
-  end  
+  end    
 end

data/spec/geo_vectors/bearing_vector/random_spec.rb

@@ -4,7 +4,7 @@ describe GeoVector do
   describe 'Random module' do
     context 'Bearing vector 4.km at 52 deg' do
       describe '#random_vector' do      
-        let (:vec) { vec = [4.km, 52].b_vector }
+        let (:vec) { vec = [4.km, 52].vector }
         
         it 'should return a random vector of up to 4.kms with any bearing' do
           rvec = vec.random_vector

data/spec/geo_vectors/direction_vector/random_spec.rb

@@ -1,10 +1,11 @@
 require 'spec_helper'
+require 'geo_vectors/macros'
 
 describe GeoVector do
   describe 'Random module' do
     context 'Direction vector 4.km North' do
       describe '#random_vector' do      
-        let (:vec) { vec = [4.km, :north].d_vector }
+        let (:vec) { vec = [4.km, :north].vector }
         
         it 'should return a random vector of up to 4.kms in any direction' do
           rvec = vec.random_vector

data/spec/geo_vectors/geo_vectors_spec.rb

@@ -1,9 +1,10 @@
 require 'spec_helper'
+require 'geo_vectors/macros'
 
 describe GeoVectors do
   context 'an GeoVectors containing a PointVector v1, and a BearingVector v2' do
     let (:v1) { [1, 2].vector }
-    let (:v2) { [30, 4.km].b_vector }
+    let (:v2) { [30, 4.km].vector }
     let (:vecs) { GeoVectors.new v1, v2 }
     let (:point) { [3, 4].geo_point }
 

data/spec/geo_vectors/macros_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'geo_vectors/macros'
+
+describe 'Macros' do
+  describe 'Array macros' do 
+    describe '#vector' do
+      it 'should create Point Vector from lat and lng' do
+        v = [2, 32].vector
+        v.should be_a PointVector
+        v.lat.should == 2
+        v.lng.should == 32      
+      end
+    end
+
+    describe '#vector' do
+      it 'should create Direction Vector from distance and direction' do
+        v = [2.km, :north].vector
+        v.should be_a DirectionVector
+        v.distance.should == 2.km
+        v.direction.should == :N      
+      end
+
+      it 'should create Bearing Vector from distance and degrees' do
+        v = [2.km, 32].vector
+        v.should be_a BearingVector
+        v.distance.should == 2.km
+        v.bearing.should == 32      
+      end
+    end
+  end
+  
+  describe 'Hash macros' do 
+    describe '#point_vector' do
+      it 'should create Point Vector from lat and lng' do
+        v = {:lat => 2, :lng => 32}.point_vector
+        v.should be_a PointVector
+        v.lat.should == 2
+        v.lng.should == 32      
+      end
+    end
+  end
+
+  describe 'String macros' do 
+    describe '#point_vector' do
+      it 'should create Point Vector from lat and lng in String' do
+        v = "2, 32".point_vector
+        v.should be_a PointVector
+        v.lat.should == 2
+        v.lng.should == 32      
+      end
+    end
+  end
+
+  describe 'GeoPoint macros' do 
+    describe '#point_vector' do
+      it 'should create Point Vector from a GeoPoint' do
+        v = "2, 32".geo_point.point_vector
+        v.should be_a PointVector
+        v.lat.should == 2
+        v.lng.should == 32      
+      end
+    end
+  end    
+end

data/spec/geo_vectors/point_vector/add_vector_spec.rb

@@ -44,52 +44,52 @@ describe PointVector do
   describe 'Vector on Vector Addition' do
     context 'Point vector (4, 2)' do
       describe '#+ operator' do      
-        let (:vec) { vec = [4, 2].vector }
+        let (:vec) { vec = PointVector.new 4, 2 }
         
         it 'should Add one geo vector' do
-          v2 = vec + [1, 2].vector
+          v2 = vec + PointVector.new(1, 2)
           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 = PointVector.new [4, 2] }
+        
+        it 'should Add one geo vector' do
+          vec.add!( PointVector.new(1, 2))
+          vec.lng.should == 4
+          vec.lat.should == 5
+        end
+      
+        describe 'converting args to vector' do
+          let (:vec) { vec = PointVector.new [4, 2] }
+      
+          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 }
+        let (:vec) { vec = PointVector.new [4, 2] }
         
         it 'should Add one geo vector' do
-          v2 = vec.add([1,2].vector)
+          v2 = vec.add(PointVector.new 1, 2)
           v2.lng.should == 4
           v2.lat.should == 5
         end
       
         describe 'converting args to vector' do
-          let (:vec) { vec = [4, 2].vector }
+          let (:vec) { vec = PointVector.new [4, 2] }
 
           it 'should Add after converting number args to geo vector' do
             v2 = vec.add(1,2)
@@ -104,32 +104,31 @@ describe PointVector do
           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      
+      context 'Bearing vector (60, 2.km)' do
+        let(:vec) { vec = PointVector.new [4, 2] }        
+        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

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'geo_vectors/macros'
 
 describe PointVector do
   describe '#initialize' do

data/spec/geo_vectors/point_vector/random_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'geo_vectors/macros'
 
 describe GeoVector do
   describe 'Random module' do

data/spec/geo_vectors/point_vector/{scale_vector_spec.rb → scale_spec.rb}

@@ -8,6 +8,7 @@
 # </pre>
 
 require 'spec_helper'
+require 'geo_vectors/macros'
 
 describe PointVector do
   describe 'Scaling' do

data/spec/geo_vectors/point_vector/subtract_vector_spec.rb

@@ -25,6 +25,7 @@
 # </pre>
 
 require 'spec_helper'
+require 'geo_vectors/macros'
 
 describe GeoVector do
   describe 'Vector on Vector Subtraction' do

data/spec/geo_vectors/point_vector_spec.rb

@@ -1,14 +1,9 @@
 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
-    
+  describe '#initialize' do    
     it 'should set origin at 0,0' do
-      origin = [0, 0].geo_point
+      origin = PointVector.origin
       origin.lat.should == 0       
       origin.lng.should == 0
     end
@@ -72,7 +67,7 @@ describe PointVector do
   end
 
   context 'Simple vector at (1, 2) - GeoPoint arg' do
-    let(:vector) { PointVector.new [1, 2].to_point }
+    let(:vector) { PointVector.new [1, 2] }
 
     describe '#length' do  
       it 'should have a distance between 240 - 250 km' do
@@ -91,7 +86,7 @@ describe PointVector do
   
     describe '#point=' do
       before do
-        @vec = PointVector.new [1, 2].to_point
+        @vec = PointVector.new [1, 2]
       end
       
       it 'should set a new vector point of 2,3' do        

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geo_vectors
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-23 00:00:00.000000000Z
+date: 2011-05-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: geo_calc
-  requirement: &2160970420 !ruby/object:Gem::Requirement
+  requirement: &2155680100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.5.4
   type: :runtime
   prerelease: false
-  version_requirements: *2160970420
+  version_requirements: *2155680100
 - !ruby/object:Gem::Dependency
   name: proxy_party
-  requirement: &2160969740 !ruby/object:Gem::Requirement
+  requirement: &2155679500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *2160969740
+  version_requirements: *2155679500
 - !ruby/object:Gem::Dependency
   name: sugar-high
-  requirement: &2160969120 !ruby/object:Gem::Requirement
+  requirement: &2155678960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *2160969120
+  version_requirements: *2155678960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160968300 !ruby/object:Gem::Requirement
+  requirement: &2155667900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *2160968300
+  version_requirements: *2155667900
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2160967640 !ruby/object:Gem::Requirement
+  requirement: &2155667380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2160967640
+  version_requirements: *2155667380
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2160967000 !ruby/object:Gem::Requirement
+  requirement: &2155666860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 1.6.0
   type: :development
   prerelease: false
-  version_requirements: *2160967000
+  version_requirements: *2155666860
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &2160966300 !ruby/object:Gem::Requirement
+  requirement: &2155666380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160966300
+  version_requirements: *2155666380
 - !ruby/object:Gem::Dependency
   name: proxy_party
-  requirement: &2160964320 !ruby/object:Gem::Requirement
+  requirement: &2155665900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: 0.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *2160964320
+  version_requirements: *2155665900
 - !ruby/object:Gem::Dependency
   name: sugar-high
-  requirement: &2160963720 !ruby/object:Gem::Requirement
+  requirement: &2155665380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: 0.4.1
   type: :runtime
   prerelease: false
-  version_requirements: *2160963720
+  version_requirements: *2155665380
 - !ruby/object:Gem::Dependency
   name: geo_calc
-  requirement: &2160963160 !ruby/object:Gem::Requirement
+  requirement: &2155664900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: 0.5.4
   type: :runtime
   prerelease: false
-  version_requirements: *2160963160
+  version_requirements: *2155664900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160962600 !ruby/object:Gem::Requirement
+  requirement: &2155664400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *2160962600
+  version_requirements: *2155664400
 description: Works with geo_calc and other geo libraries
 email: kmandrup@gmail.com
 executables: []
@@ -156,6 +156,7 @@ files:
 - lib/geo_vectors/geo_point.rb
 - lib/geo_vectors/geo_vector.rb
 - lib/geo_vectors/geo_vectors.rb
+- lib/geo_vectors/macros.rb
 - lib/geo_vectors/point_vector.rb
 - lib/geo_vectors/point_vector/point_ops.rb
 - lib/geo_vectors/point_vector/vector_ops.rb
@@ -163,23 +164,27 @@ files:
 - lib/geo_vectors/util/calc.rb
 - lib/geo_vectors/util/geo_direction.rb
 - lib/geo_vectors/util/geo_distance.rb
+- lib/geo_vectors/util/geo_distance/units.rb
 - lib/geo_vectors/util/geo_units.rb
 - lib/geo_vectors/vector_parser.rb
-- spec/geo_vectors/API proposal guide.txt
 - spec/geo_vectors/bearing_vector/add_vector_spec.rb
+- spec/geo_vectors/bearing_vector/point_add_spec.rb
 - spec/geo_vectors/bearing_vector/random_spec.rb
+- spec/geo_vectors/bearing_vector/scale_spec.rb
 - spec/geo_vectors/bearing_vector_spec.rb
 - spec/geo_vectors/direction_vector/add_vector_spec.rb
 - spec/geo_vectors/direction_vector/point_add_spec.rb
 - spec/geo_vectors/direction_vector/random_spec.rb
+- spec/geo_vectors/direction_vector/scale_spec.rb
 - spec/geo_vectors/direction_vector/subtract_vector_spec.rb
 - spec/geo_vectors/direction_vector_spec.rb
 - spec/geo_vectors/geo_vectors_spec.rb
+- spec/geo_vectors/macros_spec.rb
 - spec/geo_vectors/point_vector/add_vector_spec.rb
 - spec/geo_vectors/point_vector/initializer_spec.rb
 - spec/geo_vectors/point_vector/point_add_spec.rb
 - spec/geo_vectors/point_vector/random_spec.rb
-- spec/geo_vectors/point_vector/scale_vector_spec.rb
+- spec/geo_vectors/point_vector/scale_spec.rb
 - spec/geo_vectors/point_vector/subtract_vector_spec.rb
 - spec/geo_vectors/point_vector_spec.rb
 - spec/geo_vectors/util/geo_direction_spec.rb
@@ -201,7 +206,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 893832234360665790
+      hash: 1380233325144833401
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -210,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.0
+rubygems_version: 1.8.3
 signing_key: 
 specification_version: 3
 summary: Geo vector library for applying vectors to GeoPoints and for basic vector

data/spec/geo_vectors/API proposal guide.txt

@@ -1,142 +0,0 @@
-h2. Intro
-
-A GeoVector can be any of:
-
-1) *bearing vector* - bearing (direction in degrees) and a distance
-2) *direction vector* - direction (:N, :NW, :NE, :S, :SE, :SW, :E, :W) and a distance
-3) *point vector* - number of degrees due east/west (+ or -) and a distance due north/south (+ or -)
-
-Note that a direction vector is always converted to a bearing vector when added to a point
-
-A GeoVector can be applied to a GeoPoint (see geo_calc) or to another GeoVector.
-When multiple vectors are added together, the sum becomes a GeoVectors object.
-If a GeoVectors object is applied, the vectors are simply applied in turn.
-
-h2. Quick start (Usage guide)
-
-The following gives a quick overview for how to use the GeoVector API.
-
-_Note: This is suggested functionality._
-
-I plan to use my recently published _geo_calc_ gem as the base for the functionality described here.
-I need a major cleanup up of the current code...
-
-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>
-
-Scale a bearing vector
-
-<pre>
-  v1 = [32, 3.km].vector
-  vec = v1 * 2
-  vec.bearing.should == 32
-  vec.distance.should == 6.km
-</pre>
-
-
-Using division operator / for inverse scaling
-
-<pre>
-  v1 = [4, 2].vector
-  vec = v1 / 2
-  vec.lat.should == 2
-  vec.lng.should == 1
-</pre>
-
-h3. GeoVectors 
-
-Adding a point Vector to a bearing Vector
-
-If the vectors are of different type, a GeoVectors object is created 
-containing both vectors. A GeoVectors is a composite vector.
-
-<pre>
-  p1 = [1, -1]
-
-  v1 = [1, 3].vector # point Vector
-
-  # 32 deg bearing, 2.km
-  v2 = [32, 2.km].vector # bearing Vector
-  v2.bearing.should == 32
-  v2.distance.should == 2.km
-
-  vec = v1 + v2 # create a GeoVectors object
-  vec.should be_a(GeoVectors)
-  vec.vectors.size.should == 2 # should contain 2 vectors
-
-  # Adding more vectors to the GeoVectors object
-  vec.vectors << v3
-  vec << v4
-  
-  p2 = p1 + vec # Add GeoVectors to the point
-</pre>
-
-h3. Vector on Point addition
-
-Add a point Vector to a GeoPoint
-
-<pre>
-  p1 = [1, 3].geo_point
-  vec = [-2, 2].vector
-  p2 = p1 + vec
-  p2.lat.should == -1
-  p2.lng.should == 5  
-</pre>
-
-Add an inverse point Vector (subtract) to a GeoPoint
-
-<pre>
-  p1 = [1, 3].geo_point
-  vec = [2, 1].vector
-  p2 = p1 - vec
-  p2.lat.should == -1
-  p2.lng.should == 2
-</pre>
-
-Add a bearing Vector to a GeoPoint
-
-<pre>
-  p1 = [1, 3].geo_point
-
-  # 32 deg bearing, 2.km
-  vec = [32, 2.km].vector 
-
-  # use #destination_point from 'geo_calc' project
-  p2 = p1 + vec
-</pre>