vector2d 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7dbfd81a3fed2f7614e10055078fdbdd37755693
-  data.tar.gz: e3e0f41142cba937a0eba3a16b94a33ebd8d3a7e
+SHA256:
+  metadata.gz: fc16e15dbb07e3fe138a13fdc3cc8edd6c1369e53bf337a47b8034359b826fa2
+  data.tar.gz: b4077e6730cd248749960253a22b78a89a9f876ebfd5ca4a097d42c44c246aa7
 SHA512:
-  metadata.gz: 526d578d2c1ca5b1c47c7e5552b0fd7493188ac58bf80a21768d5c2e0ce42baab3bbbd22e256c16561f30546c8cdf3aa46426857713da6494c27809171e3cedb
-  data.tar.gz: 5a139955b82cee23628966909c1dd8d12e46e7e8bafc539c48c9339e57fddc43bdf1712345f1576b5998a103a44df4fc1b220ace19b1b96cf8498b18ff776a87
+  metadata.gz: a93da54adf875ed88cc5f2fc7ab31a8f919d8352ddf2ee7259290ac2ed0a160b8edbf178f40788fd0e1f57c1c125877a20b6f3bbc3f8320d3929efb64da6862c
+  data.tar.gz: d1ed6fab76e6c0cd4c74104ed997927fb377dad0fd75790f576777392fc73d235b5e828a73b2d7c3bc2b00c54246c21a48fc36539f00870eb23c07767a80b477

data/.github/workflows/build.yml

@@ -0,0 +1,41 @@
+---
+name: Build
+on:
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+jobs:
+  rubocop-test:
+    name: Rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+      - name: Check code
+        run: bundle exec rubocop
+
+  rspec-test:
+    name: RSpec
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.0', '3.1', '3.2']
+    steps:
+      - uses: actions/checkout@v1
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec
+      - name: Send results to Code Climate
+        uses: paambaati/codeclimate-action@v3.2.0
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        with:
+          coverageCommand: ls

data/.gitignore

@@ -1,2 +1,3 @@
+coverage
 rdoc
 pkg

data/.rubocop.yml

@@ -0,0 +1,26 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "*.gemspec"
+    - "**/*_spec.rb"
+
+Naming/MethodName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - "x"
+    - "y"

data/.travis.yml

@@ -1,11 +1,10 @@
-addons:
-  code_climate:
-    repo_token: bf65d5faaf8dc80d0d58f2e7c663323734237c0a3e91cba16b1c556a98b0971e
 language: ruby
+sudo: false
+cache: bundler
+dist: bionic
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.2
-  - 2.2.2
+  - 2.4.5
+  - 2.6.3
+  - 2.7.1
 script:
   - bundle exec rspec spec

data/Gemfile

@@ -1,7 +1,15 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 gemspec
 
-group :test do
-  gem "codeclimate-test-reporter", require: false
-end
+group :development, :test do
+  gem "rake"
+  gem "rspec", "~> 3.8"
+  gem "rspec-its", "~> 1.3"
+  gem "rubocop", require: false
+  gem "rubocop-rake", require: false
+  gem "rubocop-rspec", require: false
+  gem "simplecov", "~> 0.17.1"
+end

data/Gemfile.lock

@@ -1,43 +1,77 @@
 PATH
   remote: .
   specs:
-    vector2d (2.2.3)
-      contracts (~> 0.9.0)
+    vector2d (2.2.4)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    codeclimate-test-reporter (0.4.7)
-      simplecov (>= 0.7.1, < 1.0.0)
-    contracts (0.9)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    json (1.8.3)
-    rake (10.4.2)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.12.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    simplecov (0.10.0)
-      docile (~> 1.1.0)
-      json (~> 1.8)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  codeclimate-test-reporter
-  rake (~> 10.3)
-  rspec (~> 3.2)
+  rake
+  rspec (~> 3.8)
+  rspec-its (~> 1.3)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+  simplecov (~> 0.17.1)
   vector2d!
+
+BUNDLED WITH
+   2.2.3

data/README.md

@@ -1,4 +1,9 @@
-# Vector2d [![Build Status](https://travis-ci.org/elektronaut/vector2d.png)](https://travis-ci.org/elektronaut/vector2d) [![Code Climate](https://codeclimate.com/github/elektronaut/vector2d.png)](https://codeclimate.com/github/elektronaut/vector2d) [![Code Climate](https://codeclimate.com/github/elektronaut/vector2d/coverage.png)](https://codeclimate.com/github/elektronaut/vector2d)
+[![Version](https://img.shields.io/gem/v/vector2d.svg?style=flat)](https://rubygems.org/gems/vector2d)
+![Build](https://github.com/elektronaut/vector2d/workflows/Build/badge.svg)
+[![Code Climate](https://codeclimate.com/github/elektronaut/vector2d/badges/gpa.svg)](https://codeclimate.com/github/elektronaut/vector2d)
+[![Code Climate](https://codeclimate.com/github/elektronaut/vector2d/badges/coverage.svg)](https://codeclimate.com/github/elektronaut/vector2d)
+
+# Vector2d
 
 Vector2d handles two-dimensional coordinates and vectors.
 Vectors are immutable, meaning this is a purely functional library.
@@ -24,10 +29,10 @@ Vector2d.parse("50x70")    # => Vector2d(50,70)
 
 ## Documentation
 
-[API documentation](http://rdoc.info/github/elektronaut/vector2d)
+[API documentation](https://rdoc.info/github/elektronaut/vector2d/main)
 
 ## License
 
-Copyright (c) 2006-2014 Inge Jørgensen
+Copyright (c) 2006-2019 Inge Jørgensen
 
-Vector2d is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+Vector2d is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+
+desc "Run tests"
+task test: :spec

data/lib/vector2d/calculations.rb

@@ -1,21 +1,16 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 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
+        (vector1.x * vector2.y) - (vector1.y * vector2.x)
       end
 
       # Calculates dot product of two vectors.
@@ -24,9 +19,8 @@ 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
+        (vector1.x * vector2.x) + (vector1.y * vector2.y)
       end
 
       # Calculates angle between two vectors in radians.
@@ -35,11 +29,10 @@ 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
-        Math.acos(self.dot_product(one, two))
+        Math.acos(dot_product(one, two))
       end
     end
 
@@ -48,7 +41,6 @@ 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
@@ -58,7 +50,6 @@ 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
@@ -68,7 +59,6 @@ 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
@@ -78,7 +68,6 @@ 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
@@ -89,7 +78,6 @@ class Vector2d
     #   v2 = Vector2d(5, 6)
     #   v1.distance(v2) # => 1.4142..
     #
-    Contract VectorLike => Num
     def distance(other)
       Math.sqrt(squared_distance(other))
     end
@@ -100,12 +88,11 @@ class Vector2d
     #   v2 = Vector2d(5, 6)
     #   v1.distance_squared(v2) # => 18
     #
-    Contract VectorLike => Num
     def squared_distance(other)
-      v, _ = coerce(other)
+      v, = coerce(other)
       dx = v.x - x
       dy = v.y - y
-      dx * dx + dy * dy
+      (dx * dx) + (dy * dy)
     end
 
     # Dot product of this vector and another vector.
@@ -114,9 +101,8 @@ class Vector2d
     #   v2 = Vector2d(2, 3)
     #   v1.dot_product(v2) # => 10
     #
-    Contract VectorLike => Num
     def dot_product(other)
-      v, _ = coerce(other)
+      v, = coerce(other)
       self.class.dot_product(self, v)
     end
 
@@ -126,9 +112,8 @@ class Vector2d
     #   v2 = Vector2d(2, 3)
     #   v1.cross_product(v2) # => 4
     #
-    Contract VectorLike => Num
     def cross_product(other)
-      v, _ = coerce(other)
+      v, = coerce(other)
       self.class.cross_product(self, v)
     end
 
@@ -138,16 +123,15 @@ class Vector2d
     #   v2 = Vector2d(4, 5)
     #   v1.angle_between(v2) # => 0.0867..
     #
-    Contract VectorLike => Num
     def angle_between(other)
-      v, _ = coerce(other)
+      v, = coerce(other)
       self.class.angle_between(self, v)
     end
 
     private
 
     def calculate_each(method, other)
-      v, _ = coerce(other)
+      v, = coerce(other)
       self.class.new(
         x.send(method, v.x),
         y.send(method, v.y)

data/lib/vector2d/coercions.rb

@@ -1,10 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 class Vector2d
   module Coercions
-    include Contracts
-
-    Contract VectorLike => [Vector2d, Vector2d]
     def coerce(other)
       case other
       when Vector2d
@@ -20,7 +17,6 @@ class Vector2d
     #
     #   Vector2d(2, 3).inspect # => "Vector2d(2,3)"
     #
-    Contract None => String
     def inspect
       "Vector2d(#{x},#{y})"
     end
@@ -29,7 +25,6 @@ class Vector2d
     #
     #   Vector2d(2, 3).to_a # => [2,3]
     #
-    Contract None => [Num, Num]
     def to_a
       [x, y]
     end
@@ -38,7 +33,6 @@ class Vector2d
     #
     #   Vector2d(2, 3).to_hash # => {x: 2, y: 3}
     #
-    Contract None => Hash
     def to_hash
       { x: x, y: y }
     end
@@ -47,7 +41,6 @@ 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
@@ -56,7 +49,6 @@ 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
@@ -65,7 +57,6 @@ class Vector2d
     #
     #   Vector2d.new(150, 100).to_s # => "150x100"
     #
-    Contract None => String
     def to_s
       "#{x}x#{y}"
     end

data/lib/vector2d/fitting.rb

@@ -1,9 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 class Vector2d
   module Fitting
-    include Contracts
-
     # Scales down the given vector unless it fits inside.
     #
     #   vector = Vector2d(20, 20)
@@ -11,46 +9,52 @@ 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
+      v, = coerce(other)
+      v.x > x || v.y > y ? other.fit(self) : other
     end
 
-    # Scales the vector to fit inside another vector, retaining the aspect ratio.
+    # Scales the vector to fit inside another vector, retaining the
+    # aspect ratio.
     #
     #   vector = Vector2d(20, 10)
     #   vector.fit(Vector2d(10, 10)) # => Vector2d(10,5)
     #   vector.fit(Vector2d(20, 20)) # => Vector2d(20,10)
     #   vector.fit(Vector2d(40, 40)) # => Vector2d(40,20)
     #
-    # Note: Either axis will be disregarded if zero or nil. This is a feature, not a bug.
+    # 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)
+      v, = coerce(other)
       scale = v.to_f_vector / self
-      self * ((scale.y == 0 || (scale.x > 0 && scale.x < scale.y)) ? scale.x : scale.y)
+      self * (
+        if scale.y.zero? || (scale.x.positive? && scale.x < scale.y)
+          scale.x
+        else
+          scale.y
+        end
+      )
     end
-    alias_method :constrain_both, :fit
+    alias constrain_both fit
 
-    # Constrain/expand so that one of the coordinates fit within (the square implied by) another vector.
+    # Constrain/expand so that one of the coordinates fit within (the
+    # square implied by) another vector.
     #
     #   constraint = Vector2d(5, 5)
     #   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)
+      v, = coerce(other)
       scale = v.to_f_vector / self
-      if (scale.x > 0 && scale.y > 0)
-        scale = (scale.x < scale.y) ? scale.y : scale.x
+      if scale.x.positive? && scale.y.positive?
+        scale = [scale.x, scale.y].max
         self * scale
       else
         fit(v)
       end
     end
-    alias_method :constrain_one, :fit_either
+    alias constrain_one fit_either
   end
 end

data/lib/vector2d/properties.rb

@@ -1,14 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 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
@@ -17,16 +14,14 @@ class Vector2d
     #
     #   Vector2d(2, 3).aspect_ratio # => 0.6667..
     #
-    Contract None => Num
     def aspect_ratio
-      (x.to_f / y.to_f).abs
+      (x.to_f / y).abs
     end
 
     # Length of vector.
     #
     #   Vector2d(2, 3).length # => 3.6055..
     #
-    Contract None => Num
     def length
       Math.sqrt(squared_length)
     end
@@ -35,9 +30,8 @@ class Vector2d
     #
     #   Vector2d(2, 3).squared_length # => 13
     #
-    Contract None => Num
     def squared_length
-      x * x + y * y
+      (x * x) + (y * y)
     end
 
     # Is this a normalized vector?
@@ -45,9 +39,8 @@ class Vector2d
     #   Vector2d(0, 1).normalized? # => true
     #   Vector2d(2, 3).normalized? # => false
     #
-    Contract None => Bool
     def normalized?
-      self.length.to_f == 1.0
+      (length.to_f - 1.0).abs < Float::EPSILON
     end
   end
 end