convenient_service 0.18.0 → 0.19.0

data/lib/convenient_service/dependencies/queries/ruby.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Dependencies
+    module Queries
+      ##
+      # @api private
+      #
+      class Ruby
+        class << self
+          ##
+          # @return [ConvenientService::Dependencies::Queries::Version]
+          #
+          # @internal
+          #   NOTE: Ruby defines `RUBY_VERSION` global variable.
+          #   - https://ruby-doc.org/core-2.7.2/doc/globals_rdoc.html
+          #
+          def version
+            @version ||= Version.new(::RUBY_VERSION)
+          end
+
+          ##
+          # @return [String]
+          #
+          # @internal
+          #   TODO: Add direct specs.
+          #
+          def engine
+            ::RUBY_ENGINE.to_s
+          end
+
+          ##
+          # @return [ConvenientService::Dependencies::Queries::Version]
+          #
+          # @internal
+          #   NOTE: Ruby defines `RUBY_ENGINE_VERSION` global variable.
+          #   - https://ruby-doc.org/core-2.7.2/doc/globals_rdoc.html
+          #
+          #   NOTE: JRuby defines `RUBY_ENGINE_VERSION` global variable.
+          #   - https://github.com/jruby/jruby/blob/9.4.0.0/spec/jruby/compat_spec.rb#L6
+          #
+          #   NOTE: TruffleRuby defines `RUBY_ENGINE_VERSION` global variable.
+          #   - https://github.com/oracle/truffleruby/blob/vm-22.3.0/spec/truffle/identity_spec.rb#L23
+          #
+          #   TODO: Add direct specs.
+          #
+          def engine_version
+            @engine_version ||= Version.new(::RUBY_ENGINE_VERSION)
+          end
+
+          ##
+          # Returns `true` when MRI, `false` otherwise.
+          #
+          # @return [Boolean]
+          #
+          # @see https://github.com/janlelis/ruby_engine
+          #
+          # @internal
+          #   NOTE: Gratefully copied from the `ruby_engine` gem. Version `1.1.4`.
+          #   - https://github.com/janlelis/ruby_engine/blob/v2.0.0/lib/ruby_engine.rb#L19
+          #
+          def mri?
+            ::RUBY_ENGINE.to_s == "ruby"
+          end
+
+          alias_method :ruby?, :mri?
+
+          ##
+          # Returns `true` when JRuby, `false` otherwise.
+          #
+          # @return [Boolean]
+          #
+          # @see https://github.com/rdp/os
+          #
+          # @internal
+          #   NOTE: Gratefully copied from the `os` gem. Version `1.1.4`.
+          #   - https://github.com/rdp/os/blob/v1.1.4/lib/os.rb#L101
+          #
+          #   NOTE: Modified original implementation in order to return a boolean.
+          #   NOTE: Consider to use `RUBY_ENGINE` as for others?
+          #
+          def jruby?
+            ::RUBY_PLATFORM.to_s.match?(/java/)
+          end
+
+          ##
+          # Returns `true` when TruffleRuby, `false` otherwise.
+          #
+          # @return [Boolean]
+          #
+          # @internal
+          #   NOTE: Taken from irb testing. May NOT be stable.
+          #
+          #   TODO: Find a confirmation of stability.
+          #
+          def truffleruby?
+            ::RUBY_ENGINE.to_s.match?(/truffleruby/)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/dependencies/queries/version/null_version.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module Dependencies
+    module Queries
+      class Version
+        ##
+        # @api private
+        #
+        # @internal
+        #   - https://thoughtbot.com/blog/rails-refactoring-example-introduce-null-object
+        #   - https://avdi.codes/null-objects-and-falsiness/
+        #
+        class NullVersion
+          ##
+          # @return [Boolean]
+          #
+          def null_version?
+            true
+          end
+
+          ##
+          # @return [nil]
+          #
+          def gem_version
+            nil
+          end
+
+          ##
+          # @param other [Object] Can be any type.
+          # @return [nil]
+          #
+          def <=>(other)
+            nil
+          end
+
+          ##
+          # @param other [Object] Can be any type.
+          # @return [nil]
+          #
+          def <(other)
+            nil
+          end
+
+          ##
+          # @param other [Object] Can be any type.
+          # @return [nil]
+          #
+          def <=(other)
+            nil
+          end
+
+          ##
+          # @param other [Object] Can be any type.
+          # @return [nil]
+          #
+          def ==(other)
+            nil
+          end
+
+          ##
+          # @param other [Object] Can be any type.
+          # @return [nil]
+          #
+          def >(other)
+            nil
+          end
+
+          ##
+          # @param other [Object] Can be any type.
+          # @return [nil]
+          #
+          def >=(other)
+            nil
+          end
+
+          ##
+          # @return [String]
+          #
+          def to_s
+            ""
+          end
+        end
+      end
+    end
+  end
+end

data/lib/convenient_service/dependencies/queries/version.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require_relative "version/null_version"
+
+module ConvenientService
+  module Dependencies
+    module Queries
+      class Version
+        include ::Comparable
+
+        undef_method :between?
+
+        undef_method :clamp
+
+        ##
+        # @param value [String]
+        # @return [void]
+        #
+        def initialize(value)
+          @value = value
+        end
+
+        class << self
+          ##
+          # @return [ConvenientService::Dependencies::Queries::Version::NullVersion]
+          #
+          def null_version
+            @null_version ||= Version::NullVersion.new
+          end
+        end
+
+        ##
+        # @return [Boolean]
+        #
+        def null_version?
+          false
+        end
+
+        ##
+        # @return [Gem::Version, nil]
+        #
+        def gem_version
+          cast_gem_version(value)
+        end
+
+        ##
+        # @return [String]
+        #
+        # @internal
+        #   TODO: Add direct specs.
+        #
+        def major_minor
+          to_s[/\d+\.\d+/]
+        end
+
+        ##
+        # @param other [Object] Can be any type.
+        # @return [Boolean, nil]
+        #
+        def <=>(other)
+          gem_version <=> cast_gem_version(other)
+        end
+
+        ##
+        # @return [String]
+        #
+        def to_s
+          gem_version.to_s
+        end
+
+        private
+
+        ##
+        # @return [String]
+        #
+        attr_reader :value
+
+        ##
+        # @return [Gem::Version, nil]
+        #
+        def cast_gem_version(value)
+          ::Gem::Version.create(value.to_s) if ::Gem::Version.correct?(value.to_s)
+        end
+      end
+    end
+  end
+end