ruby-units 2.4.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cef2eee9d07cdfbb9761babe05cf20dcd2d64fcd8b1c72e1c82f0c7120f0aafe
-  data.tar.gz: 3b7f5ecd1dff12af14de4f9c6eb5109a7a09f0fa3223f5880befbb99a556237b
+  metadata.gz: 572cf98377411ff41dd490f784564f3b50401a7342552a7999688ea0763eec5b
+  data.tar.gz: 735696cb4410be7d1d7a1d03fabaa4fa734a2dc6f5c4a8a37648dcd88a461168
 SHA512:
-  metadata.gz: 44f63528e99535c8d5dd56ce7a2ca4f2a1fe800ace101495be272c5fa9e6c25b6abd3d1f35c695cf69ec848b333c8b9147f044e275122124bf08b1acee432bcb
-  data.tar.gz: cb72ea094586f7750524527c605f151431b0c96d3d3350337eceed2f7fb29d30568f14f0c2f9ee2179b0f8ca638b1cfef580c8929c2551ff9085107bd6d7cd8f
+  metadata.gz: d0d994f5f9a10375fad35fa00905dc23ae5227e08157f10f27c85955e1d0df98500bb6d1174298b9f95f02a4f568a6d363af21204f6564e1c28f8b19c44a229f
+  data.tar.gz: 491e25dbb90dc0e7f5829b46c4973b178a49119ed3343fc6fe9931131d08525b0e8655079a6321bbbfef4f3624c0746dbbfde5b9dc866828fbe1a97d691b9569

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/.github/workflows/tests.yml

@@ -15,7 +15,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.6', '2.7', '3.0', '3.1', 'jruby-9.3']
+        ruby: ['3.0', '3.1', '3.2', '3.3', 'jruby-9.4']
+    env:
+      BUNDLE_WITHOUT: optional
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1

data/.rubocop.yml

@@ -18,6 +18,8 @@ Style/SingleLineBlockParams:
 Naming/FileName:
   Exclude:
     - 'lib/ruby-units.rb'
+Naming/MethodParameterName:
+  Enabled: false
 Style/FormatString:
   Enabled: false
 Style/DateTime:

data/.ruby-version

@@ -1 +1 @@
-2.6.10
+3.0.6

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,2 @@
+java adoptopenjdk-18.0.1+10
+ruby 3.0.6

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

@@ -1,10 +1,25 @@
 source 'https://rubygems.org'
 
-group :development do
+# These are gems that are only used for local development and don't need to be included at runtime or for running tests.
+# The CI process will not install them.
+group :optional do
   gem 'debug', '>= 1.0.0', platform: :mri
+  gem 'guard-rspec'
+  gem 'pry'
   gem 'redcarpet', platform: :mri # redcarpet doesn't support jruby
+  gem 'rubocop'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
   gem 'ruby-maven', platform: :jruby
   gem 'ruby-prof', platform: :mri
+  gem 'simplecov-html'
+  gem 'solargraph'
+  gem 'terminal-notifier'
+  gem 'terminal-notifier-guard'
+  gem 'webrick'
+  gem 'yard'
 end
 
+gem 'simplecov'
+
 gemspec

data/Gemfile.lock

@@ -1,25 +1,26 @@
 PATH
   remote: .
   specs:
-    ruby-units (2.4.1)
+    ruby-units (4.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     backport (1.2.0)
-    benchmark (0.2.0)
+    base64 (0.1.1)
+    benchmark (0.2.1)
     coderay (1.1.3)
-    debug (1.6.2)
-      irb (>= 1.3.6)
+    debug (1.8.0)
+      irb (>= 1.5.0)
       reline (>= 0.3.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
     e2mmap (0.1.0)
-    ffi (1.15.5)
-    ffi (1.15.5-java)
+    ffi (1.16.1)
+    ffi (1.16.1-java)
     formatador (1.1.0)
-    guard (2.18.0)
+    guard (2.18.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -33,130 +34,154 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    io-console (0.5.11)
-    irb (1.4.1)
-      reline (>= 0.3.0)
-    jaro_winkler (1.5.4)
-    jaro_winkler (1.5.4-java)
-    json (2.6.2)
-    json (2.6.2-java)
+    io-console (0.6.0)
+    io-console (0.6.0-java)
+    irb (1.8.1)
+      rdoc
+      reline (>= 0.3.8)
+    jar-dependencies (0.4.1)
+    jaro_winkler (1.5.6)
+    jaro_winkler (1.5.6-java)
+    json (2.6.3)
+    json (2.6.3-java)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    listen (3.7.1)
+    language_server-protocol (3.17.0.3)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.8)
+    lumberjack (1.2.9)
     method_source (1.0.0)
-    mini_portile2 (2.8.0)
     nenv (0.3.0)
-    nokogiri (1.13.8)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.15.4-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.8-java)
+    nokogiri (1.15.4-java)
       racc (~> 1.4)
-    nokogiri (1.13.8-x86_64-darwin)
+    nokogiri (1.15.4-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-linux)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry (0.14.1-java)
+    pry (0.14.2-java)
       coderay (~> 1.1)
       method_source (~> 1.0)
       spoon (~> 0.0)
-    racc (1.6.0)
-    racc (1.6.0-java)
+    psych (5.1.0)
+      stringio
+    psych (5.1.0-java)
+      jar-dependencies (>= 0.1.7)
+    racc (1.7.1)
+    racc (1.7.1-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)
-    reline (0.3.1)
+    rbs (2.8.4)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    redcarpet (3.6.0)
+    regexp_parser (2.8.1)
+    reline (0.3.8)
       io-console (~> 0.5)
     reverse_markdown (2.1.1)
       nokogiri
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.35.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.4)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.12.1)
-      rubocop (~> 1.31)
+    rubocop-rspec (2.24.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-maven (3.3.13)
       ruby-maven-libs (~> 3.3.9)
     ruby-maven-libs (3.3.9)
-    ruby-prof (1.4.3)
-    ruby-progressbar (1.11.0)
+    ruby-prof (1.6.3)
+    ruby-progressbar (1.13.0)
     shellany (0.0.1)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    solargraph (0.46.0)
+    solargraph (0.49.0)
       backport (~> 1.2)
       benchmark
-      bundler (>= 1.17.2)
+      bundler (~> 2.0)
       diff-lcs (~> 1.4)
       e2mmap
       jaro_winkler (~> 1.5)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
       parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
     spoon (0.0.6)
       ffi
+    stringio (3.0.8)
     terminal-notifier (2.0.0)
     terminal-notifier-guard (1.7.0)
-    thor (1.2.1)
-    tilt (2.0.11)
-    unicode-display_width (2.2.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    thor (1.2.2)
+    tilt (2.3.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    yard (0.9.34)
 
 PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
   java
-  ruby
   universal-java-11
+  universal-java-18
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   debug (>= 1.0.0)
@@ -180,4 +205,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.3.13
+   2.4.19

data/README.md

@@ -131,6 +131,8 @@ The `to_s` also accepts some options.
 ```ruby
 Unit.new('1.5 mm').to_s("%0.2f")  # "1.50 mm".  Enter any valid format
                                   #   string.  Also accepts strftime format
+Unit.new('10 mm').to_s("%0.2f in")# "0.39 in". can also format and convert in
+                                  # the same time.
 Unit.new('1.5 mm').to_s("in")     # converts to inches before printing
 Unit.new("2 m").to_s(:ft)         # returns 6'7"
 Unit.new("100 kg").to_s(:lbs)     # returns 220 lbs, 7 oz

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