ruby_checker 1.0.0

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020 Miquel Sabaté Solà <mikisabate@gmail.com>
+#
+# This file is part of ruby_checker
+#
+# ruby_checker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ruby_checker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ruby_checker.  If not, see <http://www.gnu.org/licenses/>.
+
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,68 @@
+# ruby_checker [![Build Status](https://travis-ci.org/mssola/ruby_checker.svg?branch=master)](https://travis-ci.org/mssola/ruby_checker) [![Gem Version](https://badge.fury.io/rb/ruby_checker.svg)](https://badge.fury.io/rb/ruby_checker)
+
+`ruby_checker` provides a simple framework to enforce a specific ruby version and interpreter to be used. This is useful for projects that want to support only a sigle ruby version/interpreter.
+
+## Basic usage
+
+Using it is as easy as follows:
+
+```ruby
+require "ruby_checker"
+
+RubyChecker::RubyChecker.new.check!(supported: "2.6.5")
+```
+
+This will enforce the `2.6.5` version for your application. Note though that it
+is not restricting the interpreter being used. In order to do this, just
+instantiate the object as follows:
+
+```ruby
+require "ruby_checker"
+
+RubyChecker::RubyChecker.new.check!(interpreter: RubyChecker::MRI, supported: "2.6.5")
+```
+
+This gem supports the major ruby vendors by using the following constants:
+`RubyChecker::MRI`, `RubyChecker::JRUBY`, `RubyChecker::MRUBY` and
+`RubyChecker::TRUFFLE`.
+
+## Ruby on Rails integration
+
+If you are using this gem from within a Ruby on Rails project, you will notice the following:
+
+- This gem will use the `Rails.logger` for logging purposes instead of printing
+  everything on the standard output.
+- You don't have to provide the `support` argument for the `RubyChecker` class,
+  since it will be guessed from the `.ruby-version` file from the root of your
+  project.
+
+## Contributing
+
+Read the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
+
+## [Changelog](https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg&name=small)
+
+Read the [CHANGELOG.md](./CHANGELOG.md) file.
+
+## License
+
+This project is based on work I did for the
+[Portus](https://github.com/SUSE/Portus) project. I've extracted my code into a
+gem so it can be also used for other projects that might be interested in this.
+
+```
+Copyright (C) 2020 Miquel Sabaté Solà <mikisabate@gmail.com>
+
+ruby_checker is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+ruby_checker is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with ruby_checker.  If not, see <http://www.gnu.org/licenses/>.
+```

data/Rakefile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020 Miquel Sabaté Solà <mikisabate@gmail.com>
+#
+# This file is part of ruby_checker
+#
+# ruby_checker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ruby_checker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ruby_checker.  If not, see <http://www.gnu.org/licenses/>.
+
+require "git_validation/task"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ["--display-cop-names"]
+end
+
+GitValidation::Task.new(:"git-validation") do |t|
+  t.from = "74a6c20fc4d3"
+end
+
+task default: :all
+task all: %i[test rubocop git-validation]

data/lib/ruby_checker/errors.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020 Miquel Sabaté Solà <mikisabate@gmail.com>
+#
+# This file is part of ruby_checker.
+#
+# ruby_checker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ruby_checker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ruby_checker.  If not, see <http://www.gnu.org/licenses/>.
+
+module RubyChecker
+  # MissingSupportedVersionError is raised whenever the supported version could
+  # not be guessed and it was not given.
+  class MissingSupportedVersionError < StandardError
+    def initialize
+      super("Supported version could not be guessed and it was not provided")
+    end
+  end
+
+  # RubyEngineNotAvailableError is raised whenever RUBY_ENGINE is detected to
+  # not be available.
+  class RubyEngineNotAvailableError < StandardError
+    def initialize
+      super("Apparently your Ruby interpreter does not define the 'RUBY_ENGINE' constant." \
+            " This is not supported.")
+    end
+  end
+
+  # NotSupportedError is raised when the current interpreter is detected to not
+  # be supported.
+  class NotSupportedError < StandardError
+    def initialize(interpreter)
+      super("Current interpreter is not supported. You should use '#{interpreter}' instead.")
+    end
+  end
+
+  # OutdatedRubyError is raised whenever the current Ruby is detected to be too
+  # old.
+  class OutdatedRubyError < StandardError
+    def initialize(supported)
+      super("Please, use Ruby #{supported}")
+    end
+  end
+end

data/lib/ruby_checker/interpreter.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020 Miquel Sabaté Solà <mikisabate@gmail.com>
+#
+# This file is part of ruby_checker.
+#
+# ruby_checker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ruby_checker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ruby_checker.  If not, see <http://www.gnu.org/licenses/>.
+
+require "ruby_checker/errors"
+
+module RubyChecker
+  ANY     = 0
+  MRI     = 1
+  JRUBY   = 2
+  MRUBY   = 3
+  TRUFFLE = 4
+
+  # Interpreter adds checking capabilities for interpreters.
+  class Interpreter
+    def initialize(required)
+      @required = required
+    end
+
+    # check! performs checks for interpreter, ruby engines, etc. It might raise
+    # the following exceptions:
+    #
+    # - NotSupportedError: if the current interpreter does not match with the
+    #   expectation.
+    # - RubyEngineNotAvailableError: if the RUBY_ENGINE constant has not been
+    #   defined.
+    def check!
+      return true if @required == ANY
+
+      raise NotSupportedError, stringify(@required) if current_interpreter != @required
+
+      true
+    end
+
+    # Returns the constant representing the current ruby interpreter. It will
+    # return nil if the interpreter is not supported by this gem and it will
+    # raise a RubyEngineNotAvailableError if the RUBY_ENGINE constant has not
+    # been defined.
+    def current_interpreter
+      raise RubyEngineNotAvailableError if ruby_engine.nil?
+
+      case ruby_engine
+      when "ruby"
+        MRI
+      when "jruby"
+        JRUBY
+      when "mruby"
+        MRUBY
+      when "truffleruby"
+        TRUFFLE
+      end
+    end
+
+    # ruby_engine returns the value for RUBY_ENGINE, or nil if this constant is
+    # not defined.
+    #
+    # This method lives mainly so it can be stubbed in tests.
+    def ruby_engine
+      defined?(RUBY_ENGINE) ? RUBY_ENGINE : nil
+    end
+
+    # Returns a string representation for the given interpreter.
+    def stringify(interpreter)
+      return "unknown interpreter" unless interpreter.is_a?(Integer)
+
+      %w[MRI JRuby mruby truffleruby][interpreter - 1] || "unknown interpreter"
+    end
+  end
+end

data/lib/ruby_checker/logger.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020 Miquel Sabaté Solà <mikisabate@gmail.com>
+#
+# This file is part of ruby_checker.
+#
+# ruby_checker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ruby_checker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ruby_checker.  If not, see <http://www.gnu.org/licenses/>.
+
+module RubyChecker
+  # Logger handles logging by delegating the task:
+  #
+  # - If we are in Rails, use the default Rails logger.
+  # - If we are not in Rails, simply use the `puts` method.
+  class Logger
+    # warn logs the given message as a warning.
+    def warn(msg)
+      if defined?(Rails)
+        Rails.logger.tagged("ruby_checker") { Rails.logger.warn(msg) }
+      else
+        puts "[ruby_checker] Warning: #{msg}"
+      end
+    end
+  end
+end

data/lib/ruby_checker/ruby_checker.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020 Miquel Sabaté Solà <mikisabate@gmail.com>
+#
+# This file is part of ruby_checker.
+#
+# ruby_checker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ruby_checker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ruby_checker.  If not, see <http://www.gnu.org/licenses/>.
+
+require "ruby_checker/errors"
+require "ruby_checker/interpreter"
+require "ruby_checker/versions"
+
+require "rubygems/version"
+
+module RubyChecker
+  # RubyChecker is the main class for this gem. See the README.md on how to use it.
+  class RubyChecker
+    def initialize(interpreter: ::RubyChecker::ANY, supported: nil)
+      @interpreter = interpreter
+      @supported   = supported
+      @current     = Gem::Version.new(RUBY_VERSION)
+    end
+
+    # check! performs all the checks that are required.
+    def check!
+      @supported = parsed_supported_version
+      raise MissingSupportedVersionError if @supported.nil?
+
+      perform_checks!
+    end
+
+    protected
+
+    # parsed_supported_version normalizes the @supported instance variable so it
+    # can be passed to the different checkers.
+    def parsed_supported_version
+      return Gem::Version.new(@supported) if @supported.is_a?(String) && @supported != ""
+
+      file = ruby_version_file
+      return nil if file.nil? || !File.file?(file)
+
+      Gem::Version.new(File.read(file).strip)
+    end
+
+    # perform_checks! does the actual calls to the diferent checkers.
+    def perform_checks!
+      Interpreter.new(@interpreter).check!
+      Versions.new(current: @current, supported: @supported).check!
+    end
+
+    # ruby_version_file returns the path to the .ruby-version file if it can be
+    # guessed. Otherwise it returns nil.
+    def ruby_version_file
+      return nil unless defined?(Rails)
+
+      Rails.root.join(".ruby-version")
+    end
+  end
+end

data/lib/ruby_checker/version.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020 Miquel Sabaté Solà <mikisabate@gmail.com>
+#
+# This file is part of ruby_checker
+#
+# ruby_checker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ruby_checker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ruby_checker.  If not, see <http://www.gnu.org/licenses/>.
+
+module RubyChecker
+  # The current version of RubyChecker.
+  VERSION = "1.0.0"
+end

data/lib/ruby_checker/versions.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020 Miquel Sabaté Solà <mikisabate@gmail.com>
+#
+# This file is part of ruby_checker.
+#
+# ruby_checker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ruby_checker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ruby_checker.  If not, see <http://www.gnu.org/licenses/>.
+
+require "ruby_checker/logger"
+require "rubygems/version"
+
+module RubyChecker
+  # Versions performs checks on the given versions (current and supported).
+  class Versions
+    def initialize(current:, supported:)
+      @current   = current
+      @supported = supported
+      @logger    = Logger.new
+    end
+
+    # check! performs tests for the current and the supported versions of
+    # ruby. It returns true if nothing bad is happening, false if there was a
+    # warning, and it will raise an OutdatedRubyError if the version mismatch
+    # is unbearable.
+    def check!
+      if @current > @supported
+        check_newer_versions
+      elsif @current < @supported
+        check_older_versions!
+      else
+        true
+      end
+    end
+
+    protected
+
+    # check_newer_versions performs checks by assuming that the supported
+    # version is older than the current one.
+    #
+    # Returns true if the difference is on the patch level, false otherwise.
+    def check_newer_versions
+      return true if same_major_minor?
+
+      @logger.warn "Using #{@current}, but #{@supported} is the one supported."
+      false
+    end
+
+    # check_older_versions! performs checks by assuming that the supported
+    # version is newer than the current one.
+    #
+    # It returns false if the mismatch is only on the patch level, otherwise it
+    # will raise an OutdatedRubyError.
+    def check_older_versions!
+      # Raise an error if this is not a patch-level release mistake, but a major
+      # or minor version difference.
+      raise OutdatedRubyError, @supported unless same_major_minor?
+
+      # Recommend an upgrade of a patch-level version.
+      @logger.warn "Using #{@current}, but #{@supported} is the one supported."
+      false
+    end
+
+    # same_major_minor returns true of the supported and the current versions
+    # match by the major and the minor numbers of the version.
+    def same_major_minor?
+      if RUBY_ENGINE == "truffleruby"
+        @current.to_s.split(".")[0..1] == @supported.to_s.split(".")[0..1]
+      else
+        @current.canonical_segments[0..1] == @supported.canonical_segments[0..1]
+      end
+    end
+  end
+end

data/lib/ruby_checker.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2020 Miquel Sabaté Solà <mikisabate@gmail.com>
+#
+# This file is part of ruby_checker
+#
+# ruby_checker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ruby_checker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ruby_checker.  If not, see <http://www.gnu.org/licenses/>.
+
+# RubyChecker contains all the classes and modules that implement this library.
+module RubyChecker
+end
+
+require "ruby_checker/ruby_checker"