Module: AppStatus::Checks::RubyVersion

Defined in:
lib/app_status/checks/ruby_version.rb

Overview

verify that running ruby version is as expected

Examples:

reading expected version from .ruby-version file

# config/initializers/app_status.rb
require 'app_status/checks/ruby_version'
AppStatus::Checks::RubyVersion.install!

specifying expected ruby version

# config/initializers/app_status.rb
require 'app_status/checks/ruby_version'
AppStatus::Checks::RubyVersion.install!(expected_version: '2.5.0')

Class Method Summary collapse

Class Method Details

.check(expected_version: nil) ⇒ Object

compare expected ruby version to actual ruby version

Parameters:

  • expected_version (String) (defaults to: nil) —

    which ruby version is expected? if nil, value will be read from .ruby-version file



28
29
30
31
32
 
# File 'lib/app_status/checks/ruby_version.rb', line 28

def self.check(expected_version: nil)
  expected_version ||= File.read(Rails.root.join('.ruby-version')).strip
  status = RUBY_VERSION == expected_version ? :ok : :critical
  [status, "expected: #{expected_version}, actual: #{RUBY_VERSION}"]
end

.install!(expected_version: nil) ⇒ Object

add a ruby version check to AppStatus::CheckCollection

Parameters:

  • expected_version (String) (defaults to: nil) —

    which ruby version is expected?



18
19
20
21
22
 
# File 'lib/app_status/checks/ruby_version.rb', line 18

def self.install!(expected_version: nil)
  AppStatus::CheckCollection.add_check('ruby_version') do
    AppStatus::Checks::RubyVersion.check(expected_version: expected_version)
  end
end