Refactor for improved clarity and update Ruby version (#377)

Co-authored-by: olbrich <22176+olbrich@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

Author: olbrich

.github/workflows/tests.yml

@@ -30,23 +30,6 @@ jobs:
       with:
         token: ${{ secrets.QLTY_COVERAGE_TOKEN }}
         files: coverage/.resultset.json
-  # CodeClimate has become qlth.sh, this integration is currently broken.
-  # coverage:
-  #   needs: test
-  #   runs-on: ubuntu-latest
-  #   env:
-  #     BUNDLE_WITHOUT: optional
-  #   steps:
-  #   - uses: actions/checkout@v6.0.1
-  #   - uses: ruby/setup-ruby@v1
-  #     with:
-  #       bundler-cache: true
-  #   - name: Publish code coverage
-  #     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

.gitignore

@@ -7,5 +7,6 @@
 /spec/reports/
 /tmp/
 /bin/
+/vendor/bundle/
 # rspec failure tracking
 .rspec_status

.qlty/qlty.toml

@@ -77,3 +77,13 @@ threshold = 5
 [[source]]
 name = "default"
 default = true
+
+[[plugin]]
+name = "rubocop"
+package_file = "Gemfile.qlty"
+package_filters = ["rubocop"]
+config_files = [".rubocop.yml", ".rubocop_todo.yml"]
+
+[[plugin]]
+name = "reek"
+mode = "comment"

Gemfile

@@ -10,16 +10,14 @@ group :optional do
   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"
+  eval_gemfile("Gemfile.qlty")
 end
 
 gem "bigdecimal"

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-units (4.1.0)
+    ruby-units (5.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -20,12 +20,10 @@ GEM
       reline (>= 0.3.8)
     diff-lcs (1.6.2)
     docile (1.4.1)
-    e2mmap (0.1.0)
     erb (6.0.1)
     erb (6.0.1-java)
     ffi (1.17.2-arm64-darwin)
     ffi (1.17.2-java)
-    ffi (1.17.2-x86_64-darwin)
     ffi (1.17.2-x86_64-linux-gnu)
     formatador (1.2.3)
       reline
@@ -74,13 +72,12 @@ GEM
       racc (~> 1.4)
     nokogiri (1.18.10-java)
       racc (~> 1.4)
-    nokogiri (1.18.10-x86_64-darwin)
-      racc (~> 1.4)
     nokogiri (1.18.10-x86_64-linux-gnu)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    observer (0.1.2)
     ostruct (0.6.3)
     parallel (1.27.0)
     parser (3.3.10.0)
@@ -110,15 +107,17 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rdoc (7.0.1)
+    rbs (3.10.0)
+      logger
+    rdoc (7.0.2)
       erb
       psych (>= 4.0.0)
       tsort
     redcarpet (3.6.1)
     regexp_parser (2.11.3)
     reline (0.6.3)
       io-console (~> 0.5)
-    reverse_markdown (2.1.1)
+    reverse_markdown (3.0.1)
       nokogiri
     rexml (3.4.4)
     rspec (3.13.2)
@@ -134,7 +133,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.6)
-    rubocop (1.82.0)
+    rubocop (1.82.1)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -167,21 +166,27 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    solargraph (0.48.0)
+    solargraph (0.57.0)
       backport (~> 1.2)
-      benchmark
-      bundler (>= 1.17.2)
+      benchmark (~> 0.4)
+      bundler (~> 2.0)
       diff-lcs (~> 1.4)
-      e2mmap
-      jaro_winkler (~> 1.5)
+      jaro_winkler (~> 1.6, >= 1.6.1)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
+      logger (~> 1.6)
+      observer (~> 0.1)
+      ostruct (~> 0.6)
       parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
+      prism (~> 1.4)
+      rbs (>= 3.6.1, <= 4.0.0.dev.4)
+      reverse_markdown (~> 3.0)
+      rubocop (~> 1.76)
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
+      yard-activesupport-concern (~> 0.0)
+      yard-solargraph (~> 0.1)
     spoon (0.0.6)
       ffi
     stringio (3.2.0)
@@ -195,17 +200,16 @@ GEM
     unicode-emoji (4.2.0)
     webrick (1.9.2)
     yard (0.9.38)
+    yard-activesupport-concern (0.0.1)
+      yard (>= 0.8)
+    yard-solargraph (0.1.0)
+      yard (~> 0.9)
 
 PLATFORMS
-  arm64-darwin-21
-  arm64-darwin-22
-  arm64-darwin-23
-  arm64-darwin-24
   arm64-darwin-25
   java
   universal-java-11
   universal-java-18
-  x86_64-darwin-19
   x86_64-linux
 
 DEPENDENCIES
@@ -232,4 +236,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-  4.0.2
+   2.7.2

Gemfile.qlty

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# These are gems used by qlty to perform code quality checks.
+# They are installed by the qlty cli tool and are included for local development, but are not installed in CI.
+
+gem "rubocop"
+gem "rubocop-rake"
+gem "rubocop-rspec"

README.md

@@ -25,6 +25,8 @@ manipulations to ensure an accurate result.
 
 ## Installation
 
+This package requires Ruby 3.2 or later.
+
 This package may be installed using:
 
 ```bash
@@ -52,6 +54,7 @@ unit = "1 mm".to_unit                # convert string object
 unit = object.to_unit                # convert any object using object.to_s
 unit = Unit.new('1/4 cup')           # Rational number
 unit = Unit.new('1+1i mm')           # Complex Number
+unit = Unit.new(scalar: 1.5, numerator: ["<meter>"], denominator: ["<second>"])  # keyword arguments
 ```
 
 ### Rules

lib/ruby_units/configuration.rb

@@ -42,9 +42,15 @@ class Configuration
     #   @return [Symbol] the format to use when generating output (:rational or :exponential) (default: :rational)
     attr_reader :format
 
-    def initialize
-      self.format = :rational
-      self.separator = true
+    # Initialize configuration with keyword arguments
+    #
+    # @param separator [Boolean] whether to include a space between the scalar and the unit (default: true)
+    # @param format [Symbol] the format to use when generating output (default: :rational)
+    # @param _options [Hash] additional keyword arguments (ignored, for forward compatibility)
+    # @return [Configuration] a new configuration instance
+    def initialize(separator: true, format: :rational, **_options)
+      self.separator = separator
+      self.format = format
     end
 
     # Use a space for the separator to use when generating output.

lib/ruby_units/definition.rb

@@ -79,15 +79,11 @@ def definition=(unit)
 
     # is this definition for a prefix?
     # @return [Boolean]
-    def prefix?
-      kind == :prefix
-    end
+    def prefix? = kind == :prefix
 
     # Is this definition the unity definition?
     # @return [Boolean]
-    def unity?
-      prefix? && scalar == 1
-    end
+    def unity? = prefix? && scalar == 1
 
     # is this a base unit?
     # units are base units if the scalar is one, and the unit is defined in terms of itself.