ruby-units 4.0.3 → 4.1.0

data/lib/ruby_units/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyUnits
   class << self
     attr_writer :configuration
@@ -7,6 +9,7 @@ module RubyUnits
     @configuration ||= Configuration.new
   end
 
+  # Reset the configuration to the default values
   def self.reset
     @configuration = Configuration.new
   end
@@ -27,16 +30,43 @@ module RubyUnits
     # 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.
+    #
+    # @!attribute [rw] separator
+    #   @return [Boolean] whether to include a space between the scalar and the unit
     attr_reader :separator
 
+    # The style of format to use by default when generating output. When set to `:exponential`, all units will be
+    # represented in exponential notation instead of using a numerator and denominator.
+    #
+    # @!attribute [rw] format
+    #   @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
     end
 
+    # Use a space for the separator to use when generating output.
+    #
+    # @param value [Boolean] whether to include a space between the scalar and the unit
+    # @return [void]
     def separator=(value)
       raise ArgumentError, "configuration 'separator' may only be true or false" unless [true, false].include?(value)
 
-      @separator = value ? ' ' : nil
+      @separator = value ? " " : nil
+    end
+
+    # Set the format to use when generating output.
+    # The `:rational` style will generate units string like `3 m/s^2` and the `:exponential` style will generate units
+    # like `3 m*s^-2`.
+    #
+    # @param value [Symbol] the format to use when generating output (:rational or :exponential)
+    # @return [void]
+    def format=(value)
+      raise ArgumentError, "configuration 'format' may only be :rational or :exponential" unless %i[rational exponential].include?(value)
+
+      @format = value
     end
   end
 end

data/lib/ruby_units/date.rb

@@ -1,4 +1,6 @@
-require 'date'
+# frozen_string_literal: true
+
+require "date"
 
 module RubyUnits
   # Extra methods for [::Date] to allow it to be used as a [RubyUnits::Unit]
@@ -11,8 +13,8 @@ module RubyUnits
     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)
+        other = other.convert_to("d").round if %w[y decade century].include? other.units
+        super(other.convert_to("day").scalar)
       else
         super
       end
@@ -26,8 +28,8 @@ module RubyUnits
     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)
+        other = other.convert_to("d").round if %w[y decade century].include? other.units
+        super(other.convert_to("day").scalar)
       else
         super
       end

data/lib/ruby_units/definition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class RubyUnits::Unit < Numeric
   # Handle the definition of units
   class Definition
@@ -34,8 +36,8 @@ class RubyUnits::Unit < Numeric
     #
     def initialize(name, definition = [])
       yield self if block_given?
-      self.name     ||= name.gsub(/[<>]/, '')
-      @aliases      ||= (definition[0] || [name])
+      self.name     ||= name.gsub(/[<>]/, "")
+      @aliases      ||= definition[0] || [name]
       @scalar       ||= definition[1]
       @kind         ||= definition[2]
       @numerator    ||= definition[3] || RubyUnits::Unit::UNITY_ARRAY
@@ -55,7 +57,7 @@ class RubyUnits::Unit < Numeric
     # @param name_value [String]
     # @return [String]
     def name=(name_value)
-      @name = name_value.gsub(/[<>]/, '')
+      @name = name_value.gsub(/[<>]/, "")
     end
 
     # alias array must contain the name of the unit and entries must be unique
@@ -73,7 +75,6 @@ class RubyUnits::Unit < Numeric
       @kind        = base.kind
       @numerator   = base.numerator
       @denominator = base.denominator
-      self
     end
 
     # is this definition for a prefix?

data/lib/ruby_units/math.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyUnits
   # Math will convert unit objects to radians and then attempt to use the value for
   # trigonometric functions.
@@ -29,14 +31,14 @@ module RubyUnits
     # @param angle [Numeric, RubyUnits::Unit]
     # @return [Numeric]
     def sin(angle)
-      angle.is_a?(RubyUnits::Unit) ? super(angle.convert_to('radian').scalar) : super
+      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
+        [super, "radian"].to_unit
       else
         super
       end
@@ -45,14 +47,14 @@ module RubyUnits
     # @param angle [Numeric, RubyUnits::Unit]
     # @return [Numeric]
     def cos(angle)
-      angle.is_a?(RubyUnits::Unit) ? super(angle.convert_to('radian').scalar) : super
+      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
+        [super, "radian"].to_unit
       else
         super
       end
@@ -61,25 +63,25 @@ module RubyUnits
     # @param number [Numeric, RubyUnits::Unit]
     # @return [Numeric]
     def sinh(number)
-      number.is_a?(RubyUnits::Unit) ? super(number.convert_to('radian').scalar) : super
+      number.is_a?(RubyUnits::Unit) ? super(number.convert_to("radian").scalar) : super
     end
 
     # @param number [Numeric, RubyUnits::Unit]
     # @return [Numeric]
     def cosh(number)
-      number.is_a?(RubyUnits::Unit) ? super(number.convert_to('radian').scalar) : super
+      number.is_a?(RubyUnits::Unit) ? super(number.convert_to("radian").scalar) : super
     end
 
     # @param angle [Numeric, RubyUnits::Unit]
     # @return [Numeric]
     def tan(angle)
-      angle.is_a?(RubyUnits::Unit) ? super(angle.convert_to('radian').scalar) : super
+      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
+      number.is_a?(RubyUnits::Unit) ? super(number.convert_to("radian").scalar) : super
     end
 
     # @param x [Numeric, RubyUnits::Unit]
@@ -98,7 +100,7 @@ module RubyUnits
     # @return [RubyUnits::Unit] if argument is a unit
     def atan(number)
       if number.is_a?(RubyUnits::Unit)
-        [super(number), 'radian'].to_unit
+        [super, "radian"].to_unit
       else
         super
       end
@@ -110,10 +112,10 @@ module RubyUnits
     # @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)
+      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
+        [super(x.base_scalar, y.base_scalar), "radian"].to_unit
       else
         super
       end

data/lib/ruby_units/namespaced.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 # require_relative this file to avoid creating an class alias from Unit to RubyUnits::Unit
-require_relative 'version'
-require_relative 'configuration'
-require_relative 'definition'
-require_relative 'cache'
-require_relative 'array'
-require_relative 'date'
-require_relative 'time'
-require_relative 'math'
-require_relative 'numeric'
-require_relative 'string'
-require_relative 'unit'
-require_relative 'unit_definitions'
+require_relative "version"
+require_relative "configuration"
+require_relative "definition"
+require_relative "cache"
+require_relative "array"
+require_relative "date"
+require_relative "time"
+require_relative "math"
+require_relative "numeric"
+require_relative "string"
+require_relative "unit"
+require_relative "unit_definitions"

data/lib/ruby_units/numeric.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyUnits
   # Extra methods for [::Numeric] to allow it to be used as a [RubyUnits::Unit]
   module Numeric

data/lib/ruby_units/string.rb

@@ -1,4 +1,6 @@
-require 'time'
+# frozen_string_literal: true
+
+require "time"
 
 module RubyUnits
   # Extra methods for converting [String] objects to [RubyUnits::Unit] objects

data/lib/ruby_units/time.rb

@@ -1,4 +1,6 @@
-require 'time'
+# frozen_string_literal: true
+
+require "time"
 
 module RubyUnits
   # Time math is handled slightly differently.  The difference is considered to be an exact duration if
@@ -17,15 +19,15 @@ module RubyUnits
         case args.first
         when RubyUnits::Unit
           options = args.last.is_a?(Hash) ? args.pop : kwargs
-          secondary_unit = args[2] || 'microsecond'
+          secondary_unit = args[2] || "microsecond"
           case args[1]
           when Numeric
-            super((args.first + RubyUnits::Unit.new(args[1], secondary_unit.to_s)).convert_to('second').scalar, **options)
+            super((args.first + RubyUnits::Unit.new(args[1], secondary_unit.to_s)).convert_to("second").scalar, **options)
           else
-            super(args.first.convert_to('second').scalar, **options)
+            super(args.first.convert_to("second").scalar, **options)
           end
         else
-          super(*args, **kwargs)
+          super
         end
       end
 
@@ -52,9 +54,9 @@ module RubyUnits
     def +(other)
       case other
       when RubyUnits::Unit
-        other = other.convert_to('d').round.convert_to('s') if %w[y decade century].include? other.units
+        other = other.convert_to("d").round.convert_to("s") if %w[y decade century].include? other.units
         begin
-          super(other.convert_to('s').scalar)
+          super(other.convert_to("s").scalar)
         rescue RangeError
           to_datetime + other
         end
@@ -68,9 +70,9 @@ module RubyUnits
     def -(other)
       case other
       when RubyUnits::Unit
-        other = other.convert_to('d').round.convert_to('s') if %w[y decade century].include? other.units
+        other = other.convert_to("d").round.convert_to("s") if %w[y decade century].include? other.units
         begin
-          super(other.convert_to('s').scalar)
+          super(other.convert_to("s").scalar)
         rescue RangeError
           public_send(:to_datetime) - other
         end