vector2d 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4a4ed3c9fc3c47783fa81e5959d89b1cbadc94a
-  data.tar.gz: 93c385328a4335f272844e31ba882814746c1f92
+  metadata.gz: 12566131225e489c9e3f3404fbe3a223d51adf44
+  data.tar.gz: 45476593bbdbab2330fe991f1aa96aea00b9d3bd
 SHA512:
-  metadata.gz: 7279a2e6b24a90359ef10068d8e54b1887699af0218b51ea977665a6c7f919e6f4597e106ba137cd9e75bc4d289983ca33c5f28da8a88a61b3a31188fa5d65cd
-  data.tar.gz: 71ece7a02af784784c5d5f757744d6fea21de21dc513507c5ba92ccf0b8f93632c122bdb9d3e6ac58c055fa72a2b5989a82c34468be8e3576f172e9033c22f91
+  metadata.gz: 3ded7745491872050fc9c92a98d11b6757478f5f7ab13e5c91031921854007adcd3d417d606fd8bf91d9ff6267296a2d363d792af4b77b4c6bf1e9095dc2a7ef
+  data.tar.gz: da6376921f75c0ccbe9ee65048b465f039379f18aead466620a9d36ffaa8258d83c1b96b8cf38c2b26e630804e762ad3782f3b9ac0c2ca9e1daeb592a511393e

data/Gemfile.lock

@@ -1,25 +1,32 @@
 PATH
   remote: .
   specs:
-    vector2d (2.1.0)
+    vector2d (2.2.0)
+      contracts
 
 GEM
   remote: http://rubygems.org/
   specs:
     codeclimate-test-reporter (0.3.0)
       simplecov (>= 0.7.1, < 1.0.0)
+    contracts (0.7)
     diff-lcs (1.2.5)
     docile (1.1.4)
     multi_json (1.10.1)
     rake (10.3.2)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.1)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
     simplecov (0.8.2)
       docile (~> 1.1.0)
       multi_json
@@ -32,5 +39,5 @@ PLATFORMS
 DEPENDENCIES
   codeclimate-test-reporter
   rake (~> 10.3)
-  rspec (~> 2.1)
+  rspec (~> 3.2)
   vector2d!

data/lib/vector2d.rb

@@ -1,5 +1,19 @@
 # encoding: utf-8
 
+require "contracts"
+
+class Vector2d
+  include Contracts
+  VectorLike = Or[
+    [Num, Num],
+    { x: Num, y: Num },
+    { 'x' => Num, 'y' => Num },
+    Num,
+    String,
+    Vector2d
+  ]
+end
+
 require 'vector2d/calculations'
 require 'vector2d/coercions'
 require 'vector2d/fitting'
@@ -27,6 +41,7 @@ class Vector2d
     #   Vector2d.parse({x: 150, y: 100})
     #   Vector2d.parse({"x" => 150.0, "y" => 100.0})
     #   Vector2d.parse(Vector2d(150, 100))
+    Contract VectorLike => Vector2d
     def parse(arg, second_arg=nil)
       if second_arg.nil?
         parse_single_arg(arg)
@@ -37,6 +52,7 @@ class Vector2d
 
     private
 
+    Contract VectorLike => Vector2d
     def parse_single_arg(arg)
       case arg
       when Vector2d
@@ -52,12 +68,14 @@ class Vector2d
       end
     end
 
+    Contract Hash => Vector2d
     def parse_hash(hash)
       hash[:x] ||= hash['x'] if hash.has_key?('x')
       hash[:y] ||= hash['y'] if hash.has_key?('y')
       self.new(hash[:x], hash[:y])
     end
 
+    Contract String => Vector2d
     def parse_str(str)
       if str =~ /^[\s]*[\d\.]*[\s]*x[\s]*[\d\.]*[\s]*$/
         self.new(*str.split("x").map(&:to_f))
@@ -78,6 +96,7 @@ class Vector2d
   #   Vector2d(2, 3) == Vector2d(2, 3) # => true
   #   Vector2d(2, 3) == Vector2d(1, 0) # => false
   #
+  Contract Vector2d => Bool
   def ==(comp)
     comp.x === x && comp.y === y
   end
@@ -89,4 +108,4 @@ end
 #
 def Vector2d(*args)
   Vector2d.parse(*args)
-end
+end

data/lib/vector2d/calculations.rb

@@ -2,13 +2,18 @@
 
 class Vector2d
   module Calculations
+    include Contracts
+
     module ClassMethods
+      include Contracts
+
       # Calculates cross product of two vectors.
       #
       #   v1 = Vector2d(2, 1)
       #   v2 = Vector2d(2, 3)
       #   Vector2d.cross_product(v1, v2) # => 4
       #
+      Contract Vector2d, Vector2d => Num
       def cross_product(vector1, vector2)
         vector1.x * vector2.y - vector1.y * vector2.x
       end
@@ -19,6 +24,7 @@ class Vector2d
       #   v2 = Vector2d(2, 3)
       #   Vector2d.dot_product(v1, v2) # => 10
       #
+      Contract Vector2d, Vector2d => Num
       def dot_product(vector1, vector2)
         vector1.x * vector2.x + vector1.y * vector2.y
       end
@@ -29,6 +35,7 @@ class Vector2d
       #   v2 = Vector2d(4, 5)
       #   Vector2d.angle_between(v1, v2) # => 0.0867..
       #
+      Contract Vector2d, Vector2d => Num
       def angle_between(vector1, vector2)
         one = vector1.normalized? ? vector1 : vector1.normalize
         two = vector2.normalized? ? vector2 : vector2.normalize
@@ -41,6 +48,7 @@ class Vector2d
     #   Vector2d(1, 2) * Vector2d(2, 3) # => Vector2d(2, 6)
     #   Vector2d(1, 2) * 2              # => Vector2d(2, 4)
     #
+    Contract VectorLike => Vector2d
     def *(other)
       calculate_each(:*, other)
     end
@@ -50,6 +58,7 @@ class Vector2d
     #   Vector2d(4, 2) / Vector2d(2, 1) # => Vector2d(2, 2)
     #   Vector2d(4, 2) / 2              # => Vector2d(2, 1)
     #
+    Contract VectorLike => Vector2d
     def /(other)
       calculate_each(:/, other)
     end
@@ -59,6 +68,7 @@ class Vector2d
     #   Vector2d(1, 2) + Vector2d(2, 3) # => Vector2d(3, 5)
     #   Vector2d(1, 2) + 2              # => Vector2d(3, 4)
     #
+    Contract VectorLike => Vector2d
     def +(other)
       calculate_each(:+, other)
     end
@@ -68,6 +78,7 @@ class Vector2d
     #   Vector2d(2, 3) - Vector2d(2, 1) # => Vector2d(0, 2)
     #   Vector2d(4, 3) - 1              # => Vector2d(3, 2)
     #
+    Contract VectorLike => Vector2d
     def -(other)
       calculate_each(:-, other)
     end
@@ -78,6 +89,7 @@ class Vector2d
     #   v2 = Vector2d(5, 6)
     #   v1.distance(v2) # => 1.4142..
     #
+    Contract VectorLike => Num
     def distance(other)
       Math.sqrt(squared_distance(other))
     end
@@ -88,6 +100,7 @@ class Vector2d
     #   v2 = Vector2d(5, 6)
     #   v1.distance_squared(v2) # => 18
     #
+    Contract VectorLike => Num
     def squared_distance(other)
       v, _ = coerce(other)
       dx = v.x - x
@@ -101,6 +114,7 @@ class Vector2d
     #   v2 = Vector2d(2, 3)
     #   v1.dot_product(v2) # => 10
     #
+    Contract VectorLike => Num
     def dot_product(other)
       v, _ = coerce(other)
       self.class.dot_product(self, v)
@@ -112,6 +126,7 @@ class Vector2d
     #   v2 = Vector2d(2, 3)
     #   v1.cross_product(v2) # => 4
     #
+    Contract VectorLike => Num
     def cross_product(other)
       v, _ = coerce(other)
       self.class.cross_product(self, v)
@@ -123,6 +138,7 @@ class Vector2d
     #   v2 = Vector2d(4, 5)
     #   v1.angle_between(v2) # => 0.0867..
     #
+    Contract VectorLike => Num
     def angle_between(other)
       v, _ = coerce(other)
       self.class.angle_between(self, v)
@@ -138,4 +154,4 @@ class Vector2d
       )
     end
   end
-end
+end

data/lib/vector2d/coercions.rb

@@ -2,6 +2,9 @@
 
 class Vector2d
   module Coercions
+    include Contracts
+
+    Contract VectorLike => [Vector2d, Vector2d]
     def coerce(other)
       case other
       when Vector2d
@@ -17,6 +20,7 @@ class Vector2d
     #
     #   Vector2d(2, 3).inspect # => "Vector2d(2,3)"
     #
+    Contract None => String
     def inspect
       "Vector2d(#{x},#{y})"
     end
@@ -25,6 +29,7 @@ class Vector2d
     #
     #   Vector2d(2, 3).to_a # => [2,3]
     #
+    Contract None => [Num, Num]
     def to_a
       [x, y]
     end
@@ -33,6 +38,7 @@ class Vector2d
     #
     #   Vector2d(2, 3).to_hash # => {x: 2, y: 3}
     #
+    Contract None => Hash
     def to_hash
       { x: x, y: y }
     end
@@ -41,6 +47,7 @@ class Vector2d
     #
     #   Vector2d(2.0, 3.0).to_i_vector # => Vector2d(2,3)
     #
+    Contract None => Vector2d
     def to_i_vector
       self.class.new(x.to_i, y.to_i)
     end
@@ -49,6 +56,7 @@ class Vector2d
     #
     #   Vector2d(2, 3).to_f_vector # => Vector2d(2.0,3.0)
     #
+    Contract None => Vector2d
     def to_f_vector
       self.class.new(x.to_f, y.to_f)
     end
@@ -57,8 +65,9 @@ class Vector2d
     #
     #   Vector2d.new(150, 100).to_s # => "150x100"
     #
+    Contract None => String
     def to_s
       "#{x}x#{y}"
     end
   end
-end
+end

data/lib/vector2d/fitting.rb

@@ -2,6 +2,7 @@
 
 class Vector2d
   module Fitting
+    include Contracts
 
     # Scales down the given vector unless it fits inside.
     #
@@ -10,6 +11,7 @@ class Vector2d
     #   vector.contain(Vector2d(40, 20)) # => Vector2d(20,10)
     #   vector.contain(Vector2d(20, 40)) # => Vector2d(10,20)
     #
+    Contract VectorLike => Vector2d
     def contain(other)
       v, _ = coerce(other)
       (v.x > x || v.y > y) ? other.fit(self) : other
@@ -24,6 +26,7 @@ class Vector2d
     #
     # Note: Either axis will be disregarded if zero or nil. This is a feature, not a bug.
     #
+    Contract VectorLike => Vector2d
     def fit(other)
       v, _ = coerce(other)
       scale = v.to_f_vector / self
@@ -37,6 +40,7 @@ class Vector2d
     #   Vector2d(20, 10).fit_either(constraint) # => Vector2d(10,5)
     #   Vector2d(10, 20).fit_either(constraint) # => Vector2d(5,10)
     #
+    Contract VectorLike => Vector2d
     def fit_either(other)
       v, _ = coerce(other)
       scale = v.to_f_vector / self
@@ -49,4 +53,4 @@ class Vector2d
     end
     alias_method :constrain_one, :fit_either
   end
-end
+end

data/lib/vector2d/properties.rb

@@ -2,10 +2,13 @@
 
 class Vector2d
   module Properties
+    include Contracts
+
     # Angle of vector.
     #
     #   Vector2d(2, 3).angle # => 0.9827..
     #
+    Contract None => Num
     def angle
       Math.atan2(y, x)
     end
@@ -14,6 +17,7 @@ class Vector2d
     #
     #   Vector2d(2, 3).aspect_ratio # => 0.6667..
     #
+    Contract None => Num
     def aspect_ratio
       (x.to_f / y.to_f).abs
     end
@@ -22,6 +26,7 @@ class Vector2d
     #
     #   Vector2d(2, 3).length # => 3.6055..
     #
+    Contract None => Num
     def length
       Math.sqrt(squared_length)
     end
@@ -30,6 +35,7 @@ class Vector2d
     #
     #   Vector2d(2, 3).squared_length # => 13
     #
+    Contract None => Num
     def squared_length
       x * x + y * y
     end
@@ -39,8 +45,9 @@ class Vector2d
     #   Vector2d(0, 1).normalized? # => true
     #   Vector2d(2, 3).normalized? # => false
     #
+    Contract None => Bool
     def normalized?
       self.length.to_f == 1.0
     end
   end
-end
+end

data/lib/vector2d/transformations.rb

@@ -2,10 +2,13 @@
 
 class Vector2d
   module Transformations
+    include Contracts
+
     # Rounds vector to up nearest integer.
     #
     #   Vector2d(2.4, 3.6).ceil # => Vector2d(3,4)
     #
+    Contract None => Vector2d
     def ceil
       self.class.new(x.ceil, y.ceil)
     end
@@ -14,6 +17,7 @@ class Vector2d
     #
     #   Vector2d(2.4, 3.6).floor # => Vector2d(2,3)
     #
+    Contract None => Vector2d
     def floor
       self.class.new(x.floor, y.floor)
     end
@@ -24,6 +28,7 @@ class Vector2d
     #   vector.normalize        # => Vector2d(0.5547.., 0.8320..)
     #   vector.normalize.length # => 1.0
     #
+    Contract None => Vector2d
     def normalize
       resize(1.0)
     end
@@ -32,6 +37,7 @@ class Vector2d
     #
     #   Vector2d(2, 3).perpendicular # => Vector2d(-3,2)
     #
+    Contract None => Vector2d
     def perpendicular
       Vector2d.new(-y, x)
     end
@@ -40,6 +46,7 @@ class Vector2d
     #
     #   Vector2d(2, 3).resize(1.0) # => Vector2d(0.5547.., 0.8320..)
     #
+    Contract Num => Vector2d
     def resize(new_length)
       self * (new_length / self.length)
     end
@@ -48,6 +55,7 @@ class Vector2d
     #
     #   Vector2d(2, 3).reverse # => Vector2d(-2,-3)
     #
+    Contract None => Vector2d
     def reverse
       self.class.new(-x, -y)
     end
@@ -56,8 +64,12 @@ class Vector2d
     #
     #   Vector2d(1, 0).rotate(Math:PI/2) => Vector2d(1,0)
     #
+    Contract Num => Vector2d
     def rotate(angle)
-      Vector2d.new(x * Math.cos(angle) - y * Math.sin(angle), x * Math.sin(angle) + y * Math.cos(angle))
+      Vector2d.new(
+        x * Math.cos(angle) - y * Math.sin(angle),
+        x * Math.sin(angle) + y * Math.cos(angle)
+      )
     end
 
     # Rounds vector to nearest integer.
@@ -65,6 +77,7 @@ class Vector2d
     #   Vector2d(2.4, 3.6).round # => Vector2d(2,4)
     #   Vector2d(2.4444, 3.666).round(2) # => Vector2d(2.44, 3.67)
     #
+    Contract Or[None, Num] => Vector2d
     def round(digits=0)
       self.class.new(x.round(digits), y.round(digits))
     end
@@ -75,8 +88,9 @@ class Vector2d
     #   vector.truncate(5.0) # => Vector2d(2.0, 3.0)
     #   vector.truncate(1.0) # => Vector2d(0.5547.., 0.8320..)
     #
+    Contract Num => Vector2d
     def truncate(max)
       resize([max, self.length].min)
     end
   end
-end
+end

data/lib/vector2d/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 class Vector2d
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/spec/lib/vector2d/properties_spec.rb

@@ -33,11 +33,11 @@ describe Vector2d::Properties do
     subject { vector.normalized? }
     context "when vector is normalized" do
       let(:vector) { Vector2d.new(2, 3).normalize }
-      it { should be_true }
+      it { is_expected.to eq(true) }
     end
     context "when vector isn't normalized" do
       let(:vector) { Vector2d.new(2, 3) }
-      it { should be_false }
+      it { is_expected.to eq(false) }
     end
   end
-end
+end

data/spec/lib/vector2d_spec.rb

@@ -70,17 +70,17 @@ describe Vector2d do
 
     context "with both arguments equal" do
       let(:comp) { Vector2d.new(2, 3) }
-      it { should be_true }
+      it { is_expected.to eq(true) }
     end
 
     context "with x differing" do
       let(:comp) { Vector2d.new(3, 3) }
-      it { should be_false }
+      it { is_expected.to eq(false) }
     end
 
     context "with y differing" do
       let(:comp) { Vector2d.new(2, 4) }
-      it { should be_false }
+      it { is_expected.to eq(false) }
     end
   end
-end
+end

data/vector2d.gemspec

@@ -1,3 +1,4 @@
+# coding: utf-8
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
@@ -25,5 +26,6 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rake", "~> 10.3"
-  s.add_development_dependency "rspec", "~> 2.1"
+  s.add_development_dependency "rspec", "~> 3.2"
+  s.add_dependency "contracts"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vector2d
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Inge Jørgensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-07 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Vector2d allows for easy handling of two-dimensionals coordinates and
   vectors
 email: