ruby-units 2.3.2 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb1ccadd6b955b26c4853ecba154e78c4313ef1baa953d9bac365aeccf152912
-  data.tar.gz: 6c88b7f180d6b30f216dca3a6e990d2a5a4406dd515cc3e756d9f3cb5a5df2c6
+  metadata.gz: cef2eee9d07cdfbb9761babe05cf20dcd2d64fcd8b1c72e1c82f0c7120f0aafe
+  data.tar.gz: 3b7f5ecd1dff12af14de4f9c6eb5109a7a09f0fa3223f5880befbb99a556237b
 SHA512:
-  metadata.gz: 060c9895cc09a6a0de5f6e3a4c28e9c780f8a7b81ac1f73e8e5601f895edb00a6289cfacac4822d6d4bdb6f933985192e8791edb1a33f858b33d0ad75d1f55e4
-  data.tar.gz: 51b19481a8fbb8fce5a4f37c20ecffb2f5869853f261908a95339ff1b8c8504f2183ab48d26a0981f0e87e63f7c5eac104234eaa5086eb92fb84ca49e38bfa08
+  metadata.gz: 44f63528e99535c8d5dd56ce7a2ca4f2a1fe800ace101495be272c5fa9e6c25b6abd3d1f35c695cf69ec848b333c8b9147f044e275122124bf08b1acee432bcb
+  data.tar.gz: cb72ea094586f7750524527c605f151431b0c96d3d3350337eceed2f7fb29d30568f14f0c2f9ee2179b0f8ca638b1cfef580c8929c2551ff9085107bd6d7cd8f

data/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "10:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: solargraph
+    versions:
+    - 0.40.2
+    - 0.40.3
+  - dependency-name: nokogiri
+    versions:
+    - 1.11.1

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

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '15 17 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # 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
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.github/workflows/tests.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.5', '2.6', '2.7', '3.0', 'jruby-9.2']
+        ruby: ['2.6', '2.7', '3.0', '3.1', 'jruby-9.3']
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
@@ -38,3 +38,12 @@ jobs:
         CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
       with:
         coverageCommand: bundle exec rake
+  yard:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - name: Build YARD docs
+      run: bundle exec yard doc --fail-on-warning

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+2.6.10

data/CHANGELOG.txt

@@ -1,5 +1,7 @@
 Change Log for Ruby-units
 =========================
+see Github releases (https://github.com/olbrich/ruby-units/releases)
+
 2020-12-29  2.3.2   * Remove Jeweler (see #178) also adds Code of Conduct
                     * Fix specs related to Complex comparisons (see #213)
                     * Add support for Ruby 3.0 (also drop support for 2.3 and 2.4) (see #211)

data/Gemfile

@@ -1,7 +1,8 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem 'pry-byebug', platform: :mri
+  gem 'debug', '>= 1.0.0', platform: :mri
+  gem 'redcarpet', platform: :mri # redcarpet doesn't support jruby
   gem 'ruby-maven', platform: :jruby
   gem 'ruby-prof', platform: :mri
 end

data/Gemfile.lock

@@ -1,29 +1,31 @@
 PATH
   remote: .
   specs:
-    ruby-units (2.3.2)
+    ruby-units (2.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
-    backport (1.1.2)
-    benchmark (0.1.1)
-    byebug (11.1.3)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.0)
     coderay (1.1.3)
-    diff-lcs (1.4.4)
-    docile (1.3.4)
+    debug (1.6.2)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
     e2mmap (0.1.0)
-    ffi (1.14.2)
-    ffi (1.14.2-java)
-    formatador (0.2.5)
-    guard (2.16.2)
+    ffi (1.15.5)
+    ffi (1.15.5-java)
+    formatador (1.1.0)
+    guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
@@ -31,97 +33,109 @@ 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)
-    kramdown (2.3.0)
+    json (2.6.2)
+    json (2.6.2-java)
+    kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    listen (3.3.3)
+    listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    mini_portile2 (2.4.0)
+    mini_portile2 (2.8.0)
     nenv (0.3.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    nokogiri (1.10.10-java)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.13.8-java)
+      racc (~> 1.4)
+    nokogiri (1.13.8-x86_64-darwin)
+      racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.20.1)
-    parser (2.7.2.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
-    pry (0.13.1)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry (0.13.1-java)
+    pry (0.14.1-java)
       coderay (~> 1.1)
       method_source (~> 1.0)
       spoon (~> 0.0)
-    pry-byebug (3.9.0)
-      byebug (~> 11.0)
-      pry (~> 0.13.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    rb-fsevent (0.10.4)
+    racc (1.6.0)
+    racc (1.6.0-java)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.0.3)
-    reverse_markdown (2.0.0)
+    redcarpet (3.5.1)
+    regexp_parser (2.5.0)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    reverse_markdown (2.1.1)
       nokogiri
-    rexml (3.2.4)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.7.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.35.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
-      parser (>= 2.7.1.5)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.1.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    ruby-maven (3.3.12)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-maven (3.3.13)
       ruby-maven-libs (~> 3.3.9)
     ruby-maven-libs (3.3.9)
-    ruby-prof (1.4.2)
-    ruby-progressbar (1.10.1)
+    ruby-prof (1.4.3)
+    ruby-progressbar (1.11.0)
     shellany (0.0.1)
-    simplecov (0.20.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
-    solargraph (0.40.1)
-      backport (~> 1.1)
+    simplecov_json_formatter (0.1.4)
+    solargraph (0.46.0)
+      backport (~> 1.2)
       benchmark
       bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
       e2mmap
       jaro_winkler (~> 1.5)
       kramdown (~> 2.3)
       kramdown-parser-gfm (~> 1.1)
-      parser (~> 2.3)
+      parser (~> 3.0)
       reverse_markdown (>= 1.0.5, < 3)
       rubocop (>= 0.52)
       thor (~> 1.0)
@@ -131,10 +145,12 @@ GEM
       ffi
     terminal-notifier (2.0.0)
     terminal-notifier-guard (1.7.0)
-    thor (1.0.1)
-    tilt (2.0.10)
-    unicode-display_width (1.7.0)
-    yard (0.9.26)
+    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)
 
 PLATFORMS
   java
@@ -143,10 +159,11 @@ PLATFORMS
   x86_64-darwin-19
 
 DEPENDENCIES
+  debug (>= 1.0.0)
   guard-rspec
   pry
-  pry-byebug
   rake
+  redcarpet
   rspec (~> 3.0)
   rubocop
   rubocop-rake
@@ -159,6 +176,8 @@ DEPENDENCIES
   solargraph
   terminal-notifier
   terminal-notifier-guard
+  webrick
+  yard
 
 BUNDLED WITH
-   2.2.3
+   2.3.13

data/lib/ruby-units.rb

@@ -1,3 +1,2 @@
-$LOAD_PATH << File.dirname(__FILE__)
 require_relative 'ruby_units/namespaced'
 Unit = RubyUnits::Unit

data/lib/ruby_units/configuration.rb

@@ -24,9 +24,9 @@ module RubyUnits
 
   # holds actual configuration values for RubyUnits
   class Configuration
-    # used to separate the scalar from the unit when generating output.
-    # set to nil to prevent adding a space to the string representation of a unit
-    # separators other than ' ' and '' may work, but you may encounter problems
+    # Used to separate the scalar from the unit when generating output. A value
+    # of `true` will insert a single space, and `false` will prevent adding a
+    # space to the string representation of a unit.
     attr_reader :separator
 
     def initialize
@@ -34,7 +34,8 @@ module RubyUnits
     end
 
     def separator=(value)
-      raise ArgumentError, "configuration 'separator' may only be true or false" unless value.class == TrueClass || value.class == FalseClass
+      raise ArgumentError, "configuration 'separator' may only be true or false" unless value == true || value == false
+
       @separator = value ? ' ' : nil
     end
   end

data/lib/ruby_units/definition.rb

@@ -16,6 +16,10 @@ class RubyUnits::Unit < Numeric
     # @return [Array]
     attr_accessor :denominator
 
+    # Unit name to be used when generating output. This MUST be a parseable
+    # string or it won't be possible to round trip the unit to a String and
+    # back.
+    #
     # @return [String]
     attr_accessor :display_name
 
@@ -48,7 +52,7 @@ class RubyUnits::Unit < Numeric
     end
 
     # set the name, strip off '<' and '>'
-    # @param [String]
+    # @param name_value [String]
     # @return [String]
     def name=(name_value)
       @name = name_value.gsub(/[<>]/, '')
@@ -57,7 +61,7 @@ class RubyUnits::Unit < Numeric
     # alias array must contain the name of the unit and entries must be unique
     # @return [Array]
     def aliases
-      [[@aliases], @name].flatten.compact.uniq
+      [[@aliases], @name, @display_name].flatten.compact.uniq
     end
 
     # define a unit in terms of another unit

data/lib/ruby_units/namespaced.rb

@@ -1,6 +1,3 @@
-
-$LOAD_PATH << File.dirname(__FILE__)
-
 # require_relative this file to avoid creating an class alias from Unit to RubyUnits::Unit
 require_relative 'version'
 require_relative 'configuration'