ruby-units 4.0.2 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 515d78b788c31cefd79643b9a145f4cecf0448ac9e0df785453a2b19d31268d5
-  data.tar.gz: b10b08bf4d1d23d94603a9e0c5ca0d6c4962587225f9b04b6f74bac5ae521816
+  metadata.gz: 498cbfa626e9e9620fe35cf426b6616564445a91111000bb34bf7d9ed7145251
+  data.tar.gz: 01db463b77e1b90cfe9307ee80d3ffac4232ba15baa0a8828176058b09e8ef1d
 SHA512:
-  metadata.gz: 86df302207791952b19f06923111cb9305cf0e3cfeffab1869db061748925aa164b0f5d0eec453b546869b4895c0e1b41f38e2bfc4cb5f0b16986fdd41d5d576
-  data.tar.gz: 5f5c690e1dbb1f222fa95f8e0050cac04d1431dfb2ee0517921c819961ec3c3b1f57b3ab97807d3ccf04f00e13f8aac91577d21aedfba2b8c2d98b0703449782
+  metadata.gz: 9152a60487f32e3f3191667430ce82eeb13bfa5764ec4ab9e1aaa9a95178445d7b430364743ab430d2d9c5190d11284b814dcd483b53f65e18edea9d4d7a0add
+  data.tar.gz: 770749d72b82a1b80ce2a4c58e5dc9d7633ded01091088841b30138591ef524ec5b3e60df70565013950f70b4847764340cd4ea67ad296f8ff20ca43bf1ff1ea

data/.github/workflows/tests.yml

@@ -15,11 +15,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.0', '3.1', '3.2', '3.3', 'jruby-9.4']
+        ruby: ['3.1', '3.2', '3.3', 'jruby-9.4']
     env:
       BUNDLE_WITHOUT: optional
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
@@ -29,21 +29,25 @@ jobs:
   coverage:
     needs: test
     runs-on: ubuntu-latest
+    env:
+      BUNDLE_WITHOUT: optional
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
     - name: Publish code coverage
-      uses: paambaati/codeclimate-action@v2.7.5
+      uses: paambaati/codeclimate-action@v9
       env:
         CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
       with:
         coverageCommand: bundle exec rake
   yard:
     runs-on: ubuntu-latest
+    env:
+      BUNDLE_WITHOUT: optional
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 require:
   - rubocop-rake
   - rubocop-rspec
@@ -7,14 +9,10 @@ AllCops:
   Exclude:
     - ruby-units.gemspec
     - bin/*
-Style/CaseEquality:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
 Layout/LineLength:
   Enabled: false
-Style/SingleLineBlockParams:
-  Enabled: false
 Naming/FileName:
   Exclude:
     - 'lib/ruby-units.rb'
@@ -22,7 +20,13 @@ Naming/MethodParameterName:
   Enabled: false
 Style/FormatString:
   Enabled: false
-Style/DateTime:
-  Enabled: false
 Metrics/ClassLength:
   Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,193 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-09-01 18:40:26 UTC using RuboCop version 1.66.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Lint/BinaryOperatorWithIdenticalOperands:
+  Exclude:
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
+# SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
+Naming/VariableNumber:
+  Exclude:
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+RSpec/BeEq:
+  Exclude:
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 2
+RSpec/BeforeAfterAll:
+  Exclude:
+    - '**/spec/spec_helper.rb'
+    - '**/spec/rails_helper.rb'
+    - '**/spec/support/**/*.rb'
+    - 'spec/ruby_units/temperature_spec.rb'
+
+# Offense count: 95
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/ruby_units/temperature_spec.rb'
+    - 'spec/ruby_units/unit_spec.rb'
+    - 'spec/ruby_units/utf-8/unit_spec.rb'
+
+# Offense count: 12
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Exclude:
+    - '**/spec/features/**/*'
+    - '**/spec/requests/**/*'
+    - '**/spec/routing/**/*'
+    - '**/spec/system/**/*'
+    - '**/spec/views/**/*'
+    - 'spec/ruby_units/bugs_spec.rb'
+    - 'spec/ruby_units/definition_spec.rb'
+    - 'spec/ruby_units/temperature_spec.rb'
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 1
+RSpec/DescribeMethod:
+  Exclude:
+    - 'spec/ruby_units/utf-8/unit_spec.rb'
+
+# Offense count: 22
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: SkipBlocks, EnforcedStyle, OnlyStaticConstants.
+# SupportedStyles: described_class, explicit
+RSpec/DescribedClass:
+  Exclude:
+    - 'spec/ruby_units/complex_spec.rb'
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 8
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 7
+
+# Offense count: 2
+# Configuration parameters: Max, AllowedIdentifiers, AllowedPatterns.
+RSpec/IndexedLet:
+  Exclude:
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 11
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 1
+RSpec/MultipleDescribes:
+  Exclude:
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 10
+RSpec/MultipleExpectations:
+  Max: 6
+
+# Offense count: 59
+# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
+# SupportedStyles: always, named_only
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/ruby_units/complex_spec.rb'
+    - 'spec/ruby_units/range_spec.rb'
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 50
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 6
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Strict, EnforcedStyle, AllowedExplicitMatchers.
+# SupportedStyles: inflected, explicit
+RSpec/PredicateMatcher:
+  Exclude:
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 2
+RSpec/RepeatedExample:
+  Exclude:
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 8
+RSpec/RepeatedExampleGroupBody:
+  Exclude:
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 8
+RSpec/RepeatedExampleGroupDescription:
+  Exclude:
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
+# Include: **/*_spec.rb
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/ruby_units/utf-8/unit_spec.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/ruby_units/definition.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/ruby_units/configuration.rb'
+
+# Offense count: 5
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/GlobalStdStream:
+  Exclude:
+    - 'spec/benchmarks/bigdecimal.rb'
+    - 'spec/ruby_units/unit_spec.rb'
+
+# Offense count: 1
+Style/OpenStructUse:
+  Exclude:
+    - 'Guardfile'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/ruby_units/date.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowSend.
+Style/SendWithLiteralMethodName:
+  Exclude:
+    - 'lib/ruby_units/time.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Mode.
+Style/StringConcatenation:
+  Exclude:
+    - 'spec/ruby_units/bugs_spec.rb'
+    - 'spec/ruby_units/unit_spec.rb'
+    - 'spec/ruby_units/utf-8/unit_spec.rb'

data/.ruby-version

@@ -1 +1 @@
-3.0.6
+3.1.6

data/.tool-versions

@@ -1,2 +1,2 @@
 java adoptopenjdk-18.0.1+10
-ruby 3.0.6
+ruby 3.1.6

data/Gemfile

@@ -1,25 +1,27 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # 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'
+  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"
 end
 
-gem 'simplecov'
+gem "simplecov"
+gem "yard"
 
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-units (4.0.2)
+    ruby-units (4.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,14 +10,16 @@ GEM
     backport (1.2.0)
     benchmark (0.3.0)
     coderay (1.1.3)
-    debug (1.9.1)
+    debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.5.1)
-    docile (1.4.0)
+    docile (1.4.1)
     e2mmap (0.1.0)
-    ffi (1.16.3)
-    ffi (1.16.3-java)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-java)
+    ffi (1.17.0-x86_64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
     formatador (1.1.0)
     guard (2.18.1)
       formatador (>= 0.2.4)
@@ -35,38 +37,38 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     io-console (0.7.2)
     io-console (0.7.2-java)
-    irb (1.11.1)
-      rdoc
+    irb (1.14.0)
+      rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     jar-dependencies (0.4.1)
-    jaro_winkler (1.5.6)
-    jaro_winkler (1.5.6-java)
-    json (2.7.1)
-    json (2.7.1-java)
+    jaro_winkler (1.6.0)
+    jaro_winkler (1.6.0-java)
+    json (2.7.2)
+    json (2.7.2-java)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     language_server-protocol (3.17.0.3)
-    listen (3.8.0)
+    listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.10)
-    method_source (1.0.0)
+    method_source (1.1.0)
     nenv (0.3.0)
-    nokogiri (1.16.2-arm64-darwin)
+    nokogiri (1.16.7-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.2-java)
+    nokogiri (1.16.7-java)
       racc (~> 1.4)
-    nokogiri (1.16.2-x86_64-darwin)
+    nokogiri (1.16.7-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.2-x86_64-linux)
+    nokogiri (1.16.7-x86_64-linux)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.26.3)
+    parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -80,59 +82,53 @@ GEM
       stringio
     psych (5.1.2-java)
       jar-dependencies (>= 0.1.7)
-    racc (1.7.3)
-    racc (1.7.3-java)
+    racc (1.8.1)
+    racc (1.8.1-java)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.1)
     rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
+    rb-inotify (0.11.1)
       ffi (~> 1.0)
     rbs (2.8.4)
-    rdoc (6.6.2)
+    rdoc (6.7.0)
       psych (>= 4.0.0)
     redcarpet (3.6.0)
-    regexp_parser (2.9.0)
-    reline (0.4.2)
+    regexp_parser (2.9.2)
+    reline (0.5.9)
       io-console (~> 0.5)
     reverse_markdown (2.1.1)
       nokogiri
-    rexml (3.2.6)
+    rexml (3.3.6)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.0)
-    rubocop (1.60.2)
+    rspec-support (3.13.1)
+    rubocop (1.66.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
+    rubocop-ast (1.32.1)
+      parser (>= 3.3.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.26.1)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
+    rubocop-rspec (3.0.4)
+      rubocop (~> 1.61)
     ruby-maven (3.3.13)
       ruby-maven-libs (~> 3.3.9)
     ruby-maven-libs (3.3.9)
@@ -163,14 +159,16 @@ GEM
       yard (~> 0.9, >= 0.9.24)
     spoon (0.0.6)
       ffi
-    stringio (3.1.0)
+    stringio (3.1.1)
+    strscan (3.1.0)
+    strscan (3.1.0-java)
     terminal-notifier (2.0.0)
     terminal-notifier-guard (1.7.0)
-    thor (1.3.0)
-    tilt (2.3.0)
+    thor (1.3.2)
+    tilt (2.4.0)
     unicode-display_width (2.5.0)
     webrick (1.8.1)
-    yard (0.9.34)
+    yard (0.9.36)
 
 PLATFORMS
   arm64-darwin-21
@@ -204,4 +202,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.5.3
+   2.5.18

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
@@ -7,7 +9,7 @@ directories %w[lib spec]
 ## Uncomment to clear the screen before every task
 clearing :on
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'
@@ -16,14 +18,14 @@ clearing :on
 #  * zeus: 'zeus rspec' (requires the server to be started separately)
 #  * 'just' rspec: 'rspec'
 
-guard :rspec, cmd: 'bundle exec rspec' do
-  require 'ostruct'
+guard :rspec, cmd: "bundle exec rspec" do
+  require "ostruct"
 
   # Generic Ruby apps
   rspec = OpenStruct.new
   rspec.spec = ->(m) { "spec/#{m}_spec.rb" }
-  rspec.spec_dir = 'spec'
-  rspec.spec_helper = 'spec/spec_helper.rb'
+  rspec.spec_dir = "spec"
+  rspec.spec_helper = "spec/spec_helper.rb"
 
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| rspec.spec.call(m[1]) }

data/README.md

@@ -296,14 +296,15 @@ Configuration options can be set like:
 
 ```ruby
 RubyUnits.configure do |config|
+  config.format = :rational
   config.separator = false
 end
 ```
 
-Currently there is only one configuration you can set:
-
-1. separator (true/false): should a space be used to separate the scalar from
-   the unit part during output.
+| Option    | Description                                                                                                            | Valid Values              | Default     |
+|-----------|------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------|
+| format    | Only used for output formatting. `:rational` is formatted like `3 m/s^2`. `:exponential` is formatted like `3 m*s^-2`. | `:rational, :exponential` | `:rational` |
+| separator | Use a space separator for output. `true` is formatted like `3 m/s`, `false` is like `3m/s`.                            | `true, false`             | `true`      |
 
 ### NOTES
 
@@ -316,6 +317,10 @@ calculations. This in turn can have a negative impact on performance. The design
 of ruby-units has emphasized accuracy over speed. YMMV if you are doing a lot of
 math involving units.
 
+## Support Policy
+
+Only currently maintained versions of ruby and jruby are supported.
+
 ## License
 
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Folbrich%2Fruby-units.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Folbrich%2Fruby-units?ref=badge_large)

data/Rakefile

@@ -1,5 +1,7 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/ruby-units.rb

@@ -1,2 +1,4 @@
-require_relative 'ruby_units/namespaced'
+# frozen_string_literal: true
+
+require_relative "ruby_units/namespaced"
 Unit = RubyUnits::Unit

data/lib/ruby_units/array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyUnits
   # Extra methods for [::Array] to support conversion to [RubyUnits::Unit]
   module Array

data/lib/ruby_units/cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyUnits
   # Performance optimizations to avoid creating units unnecessarily
   class Cache