ruby-units 2.4.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cef2eee9d07cdfbb9761babe05cf20dcd2d64fcd8b1c72e1c82f0c7120f0aafe
-  data.tar.gz: 3b7f5ecd1dff12af14de4f9c6eb5109a7a09f0fa3223f5880befbb99a556237b
+  metadata.gz: 9e423976ff1953c233f4085f282b9431d9dc8f7fa840403221eb42d363384809
+  data.tar.gz: 22c656c48317d6af891eb3e3e1fbfcecc48fd113a9fff76004c829417b4ed305
 SHA512:
-  metadata.gz: 44f63528e99535c8d5dd56ce7a2ca4f2a1fe800ace101495be272c5fa9e6c25b6abd3d1f35c695cf69ec848b333c8b9147f044e275122124bf08b1acee432bcb
-  data.tar.gz: cb72ea094586f7750524527c605f151431b0c96d3d3350337eceed2f7fb29d30568f14f0c2f9ee2179b0f8ca638b1cfef580c8929c2551ff9085107bd6d7cd8f
+  metadata.gz: '096f48bed8904c0e450151e1df844493826b665ffaad305b08c3315c215e97b82643ee450b8e6208930aa936128b835d62a661bc9823302442311da16a02bca9'
+  data.tar.gz: 51814f9dc8b31fea8a4bb789a8f7e474a453737d4e9f6eba7ed2548285d99d21608ec14111ec024017abc04e57ea50556be1b597f6cb3688d4d7cd0ba665dfcc

data/.github/workflows/codeql-analysis.yml

@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -53,7 +53,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -67,4 +67,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

data/.solargraph.yml

@@ -9,8 +9,8 @@ exclude:
 require: []
 domains: []
 reporters:
-- rubocop
 - require_not_found
+- typecheck
 require_paths: []
 plugins: []
 max_files: 5000

data/.tool-versions

@@ -0,0 +1,3 @@
+# ruby jruby-9.3.8.0
+# uncomment this to use jruby
+java adoptopenjdk-18.0.1+10

data/CHANGELOG.txt

@@ -1,6 +1,8 @@
 Change Log for Ruby-units
 =========================
-see Github releases (https://github.com/olbrich/ruby-units/releases)
+
+see GitHub releases (https://github.com/olbrich/ruby-units/releases) for more recent releases. This file will no longer
+be updated.
 
 2020-12-29  2.3.2   * Remove Jeweler (see #178) also adds Code of Conduct
                     * Fix specs related to Complex comparisons (see #213)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-units (2.4.1)
+    ruby-units (3.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -75,11 +75,11 @@ GEM
     racc (1.6.0-java)
     rainbow (3.1.1)
     rake (13.0.6)
-    rb-fsevent (0.11.1)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     redcarpet (3.5.1)
-    regexp_parser (2.5.0)
+    regexp_parser (2.6.0)
     reline (0.3.1)
       io-console (~> 0.5)
     reverse_markdown (2.1.1)
@@ -91,14 +91,14 @@ GEM
       rspec-mocks (~> 3.11.0)
     rspec-core (3.11.0)
       rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.35.1)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
@@ -112,8 +112,8 @@ GEM
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.12.1)
-      rubocop (~> 1.31)
+    rubocop-rspec (2.13.2)
+      rubocop (~> 1.33)
     ruby-maven (3.3.13)
       ruby-maven-libs (~> 3.3.9)
     ruby-maven-libs (3.3.9)
@@ -126,7 +126,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    solargraph (0.46.0)
+    solargraph (0.47.2)
       backport (~> 1.2)
       benchmark
       bundler (>= 1.17.2)
@@ -147,7 +147,7 @@ GEM
     terminal-notifier-guard (1.7.0)
     thor (1.2.1)
     tilt (2.0.11)
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.3.0)
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
@@ -156,6 +156,7 @@ PLATFORMS
   java
   ruby
   universal-java-11
+  universal-java-18
   x86_64-darwin-19
 
 DEPENDENCIES

data/lib/ruby_units/array.rb

@@ -1,9 +1,19 @@
-class Array
-  # Construct a unit from an array
-  # @example [1, 'mm'].to_unit => RubyUnits::Unit.new("1 mm")
-  # @return (see RubyUnits::Unit#initialize)
-  # @param [Object] other convert to same units as passed
-  def to_unit(other = nil)
-    other ? RubyUnits::Unit.new(self).convert_to(other) : RubyUnits::Unit.new(self)
+module RubyUnits
+  # Extra methods for [::Array] to support conversion to [RubyUnits::Unit]
+  module Array
+    # Construct a unit from an array
+    #
+    # @example [1, 'mm'].to_unit => RubyUnits::Unit.new("1 mm")
+    # @param [RubyUnits::Unit, String] other convert to same units as passed
+    # @return [RubyUnits::Unit]
+    def to_unit(other = nil)
+      other ? RubyUnits::Unit.new(self).convert_to(other) : RubyUnits::Unit.new(self)
+    end
   end
 end
+
+# @note Do this instead of Array.prepend(RubyUnits::Array) to avoid YARD warnings
+# @see https://github.com/lsegal/yard/issues/1353
+class Array
+  prepend(RubyUnits::Array)
+end

data/lib/ruby_units/cache.rb

@@ -1,21 +1,34 @@
 module RubyUnits
-  class Unit < Numeric
-    @@cached_units = {}
+  # Performance optimizations to avoid creating units unnecessarily
+  class Cache
+    attr_accessor :data
 
-    class Cache
-      def self.get(key = nil)
-        key.nil? ? @@cached_units : @@cached_units[key]
-      end
+    def initialize
+      clear
+    end
+
+    # @param key [String, #to_unit]
+    # @return [RubyUnits::Unit, nil]
+    def get(key)
+      key = key&.to_unit&.units unless key.is_a?(String)
+      data[key]
+    end
 
-      def self.set(key, value)
-        @@cached_units[key] = value
-      end
+    # @param key [String, #to_unit]
+    # @return [void]
+    def set(key, value)
+      key = key.to_unit.units unless key.is_a?(String)
+      data[key] = value
+    end
+
+    # @return [Array<String>]
+    def keys
+      data.keys
+    end
 
-      def self.clear
-        @@cached_units = {}
-        @@base_unit_cache = {}
-        Unit.new(1)
-      end
+    # Reset the cache
+    def clear
+      @data = {}
     end
   end
 end

data/lib/ruby_units/configuration.rb

@@ -1,10 +1,3 @@
-# allow for optional configuration of RubyUnits
-#
-# Usage:
-#
-#     RubyUnits.configure do |config|
-#       config.separator = false
-#     end
 module RubyUnits
   class << self
     attr_writer :configuration
@@ -18,6 +11,13 @@ module RubyUnits
     @configuration = Configuration.new
   end
 
+  # allow for optional configuration of RubyUnits
+  #
+  # Usage:
+  #
+  #     RubyUnits.configure do |config|
+  #       config.separator = false
+  #     end
   def self.configure
     yield configuration
   end
@@ -34,7 +34,7 @@ module RubyUnits
     end
 
     def separator=(value)
-      raise ArgumentError, "configuration 'separator' may only be true or false" unless value == true || value == false
+      raise ArgumentError, "configuration 'separator' may only be true or false" unless [true, false].include?(value)
 
       @separator = value ? ' ' : nil
     end

data/lib/ruby_units/date.rb

@@ -1,64 +1,57 @@
 require 'date'
 
-# Allow date objects to do offsets by a time unit
-# Date.today + Unit.new("1 week") => gives today+1 week
-class Date
-  alias unit_date_add +
-  # @param [Object] other
-  # @return [Unit]
-  def +(other)
-    case other
-    when RubyUnits::Unit
-      other = other.convert_to('d').round if %w[y decade century].include? other.units
-      unit_date_add(other.convert_to('day').scalar)
-    else
-      unit_date_add(other)
+module RubyUnits
+  # Extra methods for [::Date] to allow it to be used as a [RubyUnits::Unit]
+  module Date
+    # Allow date objects to do offsets by a time unit
+    #
+    # @example Date.today + Unit.new("1 week") => gives today+1 week
+    # @param [RubyUnits::Unit, Object] other
+    # @return [RubyUnits::Unit]
+    def +(other)
+      case other
+      when RubyUnits::Unit
+        other = other.convert_to('d').round if %w[y decade century].include? other.units
+        super(other.convert_to('day').scalar)
+      else
+        super
+      end
     end
-  end
 
-  alias unit_date_sub -
-  # @param [Object] other
-  # @return [Unit]
-  def -(other)
-    case other
-    when RubyUnits::Unit
-      other = other.convert_to('d').round if %w[y decade century].include? other.units
-      unit_date_sub(other.convert_to('day').scalar)
-    else
-      unit_date_sub(other)
+    # Allow date objects to do offsets by a time unit
+    #
+    # @example Date.today - Unit.new("1 week") => gives today-1 week
+    # @param [RubyUnits::Unit, Object] other
+    # @return [RubyUnits::Unit]
+    def -(other)
+      case other
+      when RubyUnits::Unit
+        other = other.convert_to('d').round if %w[y decade century].include? other.units
+        super(other.convert_to('day').scalar)
+      else
+        super
+      end
     end
-  end
 
-  # Construct a unit from a Date
-  # @example Date.today.to_unit => Unit
-  # @return (see Unit#initialize)
-  # @param [Object] other convert to same units as passed
-  def to_unit(other = nil)
-    other ? RubyUnits::Unit.new(self).convert_to(other) : RubyUnits::Unit.new(self)
-  end
-
-  # :nocov_19:
-  unless Date.instance_methods.include?(:to_time)
-    # @return [Time]
-    def to_time
-      Time.local(*ParseDate.parsedate(to_s))
+    # Construct a unit from a Date. This returns the number of days since the
+    # start of the Julian calendar as a Unit.
+    #
+    # @example Date.today.to_unit => Unit
+    # @return [RubyUnits::Unit]
+    # @param other [RubyUnits::Unit, String] convert to same units as passed
+    def to_unit(other = nil)
+      other ? RubyUnits::Unit.new(self).convert_to(other) : RubyUnits::Unit.new(self)
     end
-  end
-  # :nocov_19:
 
-  alias units_datetime_inspect inspect
-  # @deprecated
-  def inspect(dump = false)
-    return units_datetime_inspect if dump
-    to_s
-  end
-
-  unless Date.instance_methods.include?(:to_date)
-    # :nocov_19:
-    # @return [Date]
-    def to_date
-      Date.civil(year, month, day)
+    # @deprecated
+    def inspect(dump = false)
+      dump ? super : to_s
     end
-    # :nocov_19:
   end
 end
+
+# @note Do this instead of Date.prepend(RubyUnits::Date) to avoid YARD warnings
+# @see https://github.com/lsegal/yard/issues/1353
+class Date
+  prepend RubyUnits::Date
+end

data/lib/ruby_units/math.rb

@@ -1,125 +1,148 @@
-# Math will convert unit objects to radians and then attempt to use the value for
-# trigonometric functions.
-module Math
-  alias unit_sqrt sqrt
-  # @return [Numeric]
-  def sqrt(n)
-    if n.is_a?(RubyUnits::Unit)
-      (n**Rational(1, 2)).to_unit
-    else
-      unit_sqrt(n)
+module RubyUnits
+  # Math will convert unit objects to radians and then attempt to use the value for
+  # trigonometric functions.
+  module Math
+    # Take the square root of a unit or number
+    #
+    # @param number [Numeric, RubyUnits::Unit]
+    # @return [Numeric, RubyUnits::Unit]
+    def sqrt(number)
+      if number.is_a?(RubyUnits::Unit)
+        (number**Rational(1, 2)).to_unit
+      else
+        super
+      end
     end
-  end
-  # @return [Numeric]
-  module_function :unit_sqrt
-  # @return [Numeric]
-  module_function :sqrt
-
-  #:nocov:
-  if respond_to?(:cbrt)
-    alias unit_cbrt cbrt
+
+    # Take the cube root of a unit or number
+    #
+    # @param number [Numeric, RubyUnits::Unit]
+    # @return [Numeric, RubyUnits::Unit]
+    def cbrt(number)
+      if number.is_a?(RubyUnits::Unit)
+        (number**Rational(1, 3)).to_unit
+      else
+        super
+      end
+    end
+
+    # @param angle [Numeric, RubyUnits::Unit]
     # @return [Numeric]
-    def cbrt(n)
-      if RubyUnits::Unit === n
-        (n**Rational(1, 3)).to_unit
+    def sin(angle)
+      angle.is_a?(RubyUnits::Unit) ? super(angle.convert_to('radian').scalar) : super
+    end
+
+    # @param number [Numeric, RubyUnits::Unit]
+    # @return [Numeric, RubyUnits::Unit]
+    def asin(number)
+      if number.is_a?(RubyUnits::Unit)
+        [super(number), 'radian'].to_unit
       else
-        unit_cbrt(n)
+        super
       end
     end
+
+    # @param angle [Numeric, RubyUnits::Unit]
     # @return [Numeric]
-    module_function :unit_cbrt
+    def cos(angle)
+      angle.is_a?(RubyUnits::Unit) ? super(angle.convert_to('radian').scalar) : super
+    end
+
+    # @param number [Numeric, RubyUnits::Unit]
+    # @return [Numeric, RubyUnits::Unit]
+    def acos(number)
+      if number.is_a?(RubyUnits::Unit)
+        [super(number), 'radian'].to_unit
+      else
+        super
+      end
+    end
+
+    # @param number [Numeric, RubyUnits::Unit]
     # @return [Numeric]
-    module_function :cbrt
-  end
-  #:nocov:
+    def sinh(number)
+      number.is_a?(RubyUnits::Unit) ? super(number.convert_to('radian').scalar) : super
+    end
 
-  alias unit_sin sin
-  # @return [Numeric]
-  def sin(n)
-    RubyUnits::Unit === n ? unit_sin(n.convert_to('radian').scalar) : unit_sin(n)
-  end
-  # @return [Numeric]
-  module_function :unit_sin
-  # @return [Numeric]
-  module_function :sin
-
-  alias unit_cos cos
-  # @return [Numeric]
-  def cos(n)
-    RubyUnits::Unit === n ? unit_cos(n.convert_to('radian').scalar) : unit_cos(n)
-  end
-  # @return [Numeric]
-  module_function :unit_cos
-  # @return [Numeric]
-  module_function :cos
-
-  alias unit_sinh sinh
-  # @return [Numeric]
-  def sinh(n)
-    RubyUnits::Unit === n ? unit_sinh(n.convert_to('radian').scalar) : unit_sinh(n)
-  end
-  # @return [Numeric]
-  module_function :unit_sinh
-  # @return [Numeric]
-  module_function :sinh
-
-  alias unit_cosh cosh
-  # @return [Numeric]
-  def cosh(n)
-    RubyUnits::Unit === n ? unit_cosh(n.convert_to('radian').scalar) : unit_cosh(n)
-  end
-  # @return [Numeric]
-  module_function :unit_cosh
-  # @return [Numeric]
-  module_function :cosh
-
-  alias unit_tan tan
-  # @return [Numeric]
-  def tan(n)
-    RubyUnits::Unit === n ? unit_tan(n.convert_to('radian').scalar) : unit_tan(n)
-  end
-  # @return [Numeric]
-  module_function :tan
-  # @return [Numeric]
-  module_function :unit_tan
-
-  alias unit_tanh tanh
-  # @return [Numeric]
-  def tanh(n)
-    RubyUnits::Unit === n ? unit_tanh(n.convert_to('radian').scalar) : unit_tanh(n)
-  end
-  # @return [Numeric]
-  module_function :unit_tanh
-  # @return [Numeric]
-  module_function :tanh
-
-  alias unit_hypot hypot
-  # Convert parameters to consistent units and perform the function
-  # @return [Numeric]
-  def hypot(x, y)
-    if RubyUnits::Unit === x && RubyUnits::Unit === y
-      (x**2 + y**2)**Rational(1, 2)
-    else
-      unit_hypot(x, y)
+    # @param number [Numeric, RubyUnits::Unit]
+    # @return [Numeric]
+    def cosh(number)
+      number.is_a?(RubyUnits::Unit) ? super(number.convert_to('radian').scalar) : super
     end
-  end
-  # @return [Numeric]
-  module_function :unit_hypot
-  # @return [Numeric]
-  module_function :hypot
-
-  alias unit_atan2 atan2
-  # @return [Numeric]
-  def atan2(x, y)
-    raise ArgumentError, 'Incompatible RubyUnits::Units' if (x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)) && !x.compatible?(y)
-    if (x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)) && x.compatible?(y)
-      Math.unit_atan2(x.base_scalar, y.base_scalar)
-    else
-      Math.unit_atan2(x, y)
+
+    # @param angle [Numeric, RubyUnits::Unit]
+    # @return [Numeric]
+    def tan(angle)
+      angle.is_a?(RubyUnits::Unit) ? super(angle.convert_to('radian').scalar) : super
+    end
+
+    # @param number [Numeric, RubyUnits::Unit]
+    # @return [Numeric]
+    def tanh(number)
+      number.is_a?(RubyUnits::Unit) ? super(number.convert_to('radian').scalar) : super
+    end
+
+    # @param x [Numeric, RubyUnits::Unit]
+    # @param y [Numeric, RubyUnits::Unit]
+    # @return [Numeric]
+    def hypot(x, y)
+      if x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)
+        ((x**2) + (y**2))**Rational(1, 2)
+      else
+        super
+      end
+    end
+
+    # @param number [Numeric, RubyUnits::Unit]
+    # @return [Numeric] if argument is a number
+    # @return [RubyUnits::Unit] if argument is a unit
+    def atan(number)
+      if number.is_a?(RubyUnits::Unit)
+        [super(number), 'radian'].to_unit
+      else
+        super
+      end
+    end
+
+    # @param x [Numeric, RubyUnits::Unit]
+    # @param y [Numeric, RubyUnits::Unit]
+    # @return [Numeric] if all parameters are numbers
+    # @return [RubyUnits::Unit] if parameters are units
+    # @raise [ArgumentError] if parameters are not numbers or compatible units
+    def atan2(x, y)
+      raise ArgumentError, 'Incompatible RubyUnits::Units' if (x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)) && !x.compatible?(y)
+
+      if (x.is_a?(RubyUnits::Unit) && y.is_a?(RubyUnits::Unit)) && x.compatible?(y)
+        [super(x.base_scalar, y.base_scalar), 'radian'].to_unit
+      else
+        super
+      end
+    end
+
+    # @param number [Numeric, RubyUnits::Unit]
+    # @return [Numeric]
+    def log10(number)
+      if number.is_a?(RubyUnits::Unit)
+        super(number.to_f)
+      else
+        super
+      end
+    end
+
+    # @param number [Numeric, RubyUnits::Unit]
+    # @param base [Numeric]
+    # @return [Numeric]
+    def log(number, base = ::Math::E)
+      if number.is_a?(RubyUnits::Unit)
+        super(number.to_f, base)
+      else
+        super
+      end
     end
   end
-  # @return [Numeric]
-  module_function :unit_atan2
-  # @return [Numeric]
-  module_function :atan2
+end
+
+# @see https://github.com/lsegal/yard/issues/1353
+module Math
+  singleton_class.prepend(RubyUnits::Math)
 end

data/lib/ruby_units/numeric.rb

@@ -1,7 +1,23 @@
-class Numeric
-  # make a unitless unit with a given scalar
-  # @return (see RubyUnits::Unit#initialize)
-  def to_unit(other = nil)
-    other ? RubyUnits::Unit.new(self, other) : RubyUnits::Unit.new(self)
+module RubyUnits
+  # Extra methods for [::Numeric] to allow it to be used as a [RubyUnits::Unit]
+  module Numeric
+    # Make a unitless unit with a given scalar.
+    # > In ruby-units <= 2.3.2 this method would create a new [RubyUnits::Unit]
+    # > with the scalar and passed in units. This was changed to be more
+    # > consistent with the behavior of [#to_unit]. Specifically the argument is
+    # > used as a convenience method to convert the unitless scalar unit to a
+    # > compatible unitless unit.
+    #
+    # @param other [RubyUnits::Unit, String] convert to same units as passed
+    # @return [RubyUnits::Unit]
+    def to_unit(other = nil)
+      other ? RubyUnits::Unit.new(self).convert_to(other) : RubyUnits::Unit.new(self)
+    end
   end
 end
+
+# @note Do this instead of Numeric.prepend(RubyUnits::Numeric) to avoid YARD warnings
+# @see https://github.com/lsegal/yard/issues/1353
+class Numeric
+  prepend(RubyUnits::Numeric)
+end