host-os 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f86c0a89682b428496bf02a65b5807d1caaa30b5a9d70a34b27595436d1a3746
+  data.tar.gz: b788605d3bdf9b5c851012502d665c6a8ef1ab4ef21b6fbf8828edaf40d78298
+SHA512:
+  metadata.gz: e87cb31326255c7e359a5d2110ea81bb43971e9b6d524ccd12eefa7c38368e88c1aec56e68b3beccb06dbfbb078244cfbef0ceefdeacc6d9f856835eac177fc8
+  data.tar.gz: e6e316ad63c38c00d01aeefa252ae2cfd3027d0669ac7b023e40b926c493cb11f78b8f237876d9964c91bc6088cf55e5dac64626e5f3b56dd4b43d3c9d21470c

data/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2017-2021, Mike Blumtritt. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,94 @@
+# HostOS
+
+![version](https://img.shields.io/gem/v/host-os?label=)
+
+HostOS is a module that offers details about the host operating system, the current Ruby interpreter, and the environment currently in use.
+
+- Gem: [rubygems.org](https://rubygems.org/gems/host-os)
+- Source: [github.com](https://github.com/mblumtritt/host-os)
+- Help: [rubydoc.info](https://rubydoc.info/gems/host-os/HostOS)
+
+## Description
+
+This gem helps you write environment-specific code in a clean way.
+It provides a simple API to get information about the operating system, the current Ruby interpreter, and the configured environment.
+
+## Usage
+
+Here is a very simple example of OS dependent code:
+
+```ruby
+require 'host-os'
+
+if HostOS.unix?
+  puts 'Hello Unix world!'
+elsif HostOS.windows?
+  puts 'Clean your Windows!'
+elsif HostOS.os2? || HostOS.vms?
+  puts 'Hello old school!'
+end
+```
+
+You are free to write your code in whatever way you prefer. Here is a functionally identical but alternative to the example above:
+
+```ruby
+require 'host-os'
+
+if HostOS.is? :unix
+  puts 'Hello Unix world!'
+elsif HostOS.is? 'windows'
+  puts 'Clean your Windows!'
+elsif %i[os2 vms].include?(HostOS.type)
+  puts 'Hello old school!'
+end
+```
+
+The module also assists with environment- or interpreter-specific code:
+
+```ruby
+require 'host-os'
+
+Logger.log_level = HostOS.env.production? ? Logger::WARN : Logger::INFO
+# => set the log level to 'WARN' in production, 'INFO' otherwise
+
+require 'java' if HostOS.interpreter.jruby?
+# => load the Java support for JRuby
+```
+
+There are additional methods that can support you on various platforms:
+
+```ruby
+require 'host-os/support'
+
+HostOS.dev_null
+# => returns 'NUL' on Windows, 'nul' for OS2 and '/dev/null' on Unix platforms
+
+HostOS.app_config_path('my_app')
+# => returns the directory name where 'my_app' stores its configuration files
+
+HostOS.rss_bytes
+# => memory consumtion of current process in bytes
+# means "total in memory footprint"
+```
+
+📕 See [the online help](https://rubydoc.info/gems/host-os/HostOS) for more details.
+
+## Installation
+
+This gem is compatible with Ruby 2.3 and higher. You can install it in your system with
+
+```shell
+gem install host-os
+```
+
+or you can use [Bundler](http://gembundler.com/) to add HostOS just to your own project:
+
+```shell
+bundle add 'host-os'
+```
+
+After that you only need one line of code to have everything together
+
+```ruby
+require 'host-os'
+```

data/examples/current.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+#
+# This example prints an overview of detected information about your current
+# OS, environment and Ruby interpreter.
+#
+# Just run
+# $ ruby examples/current.rb
+#
+# or play around with eg.:
+# $ ruby --jit examples/current.rb
+# $ ENV=test ruby examples/current.rb
+#
+
+require 'host-os/support'
+
+puts <<~INFORMATION
+  # OS Information
+    - id: #{HostOS.id}
+    - type: #{HostOS.type}
+    - POSIX compatible: #{HostOS.posix?}
+    - suggested_thread_count: #{HostOS.suggested_thread_count}
+    - temp_dir: #{HostOS.temp_dir}
+    - dev_null: #{defined?(HostOS.dev_null) ? HostOS.dev_null : '*unsupported*'}
+    - open_command: #{
+       defined?(HostOS.open_command) ? HostOS.open_command : '*unsupported*'
+     }
+    - rss_bytes: #{
+       defined?(HostOS.rss_bytes) ? HostOS.rss_bytes : '*unsupported*'
+     }
+    - app_config_path: #{
+       if defined?(HostOS.app_config_path)
+         HostOS.app_config_path('')
+       else
+         '*unsupported*'
+       end
+     }
+
+  # Environment
+    - id: #{HostOS.env.id}
+
+  # Ruby Interpreter
+    - id: #{HostOS.interpreter.id}
+    - JIT: #{HostOS.interpreter.jit_type}
+INFORMATION

data/lib/host-os/support.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require_relative('../host-os') unless defined?(HostOS.id)
+
+module HostOS
+  # This module provides helpful support methods for the {HostOS} module.
+  #
+  # It adds attributes and methods depending on the detected operating system and
+  # Ruby interpreter.
+  #
+  # @note You need to require `host-os/support` explicitly.
+  module Support
+    # @attribute [r] dev_null
+    # @return [String] name of or path to the null device
+    # @note This attribute is only available on Windows, OS2 and Unix systems.
+
+    # @attribute [r] open_command
+    # @return [String] name of the open command
+    # @note This attribute is only available on Windows, MacOS and Linux systems.
+
+    # @attribute [r] rss_bytes
+    # @return [Integer] number of bytes used by the current process
+    # @note This attribute is only available on Windows and Unix or when using
+    #   JRuby
+
+    # @attribute [r] suggested_thread_count
+    # @return [Integer] suggested number of threads to use
+
+    # @attribute [r] temp_dir
+    # @return [String] name of the temporary directory
+
+    # @!method app_config_path(app_name)
+    # @param app_name [String] name of the application
+    # @return [String] absolute name of the directory
+    # Determines the name of the directory where application specific data should
+    # be stored.
+    # @note This method is only available on Windows and Posix-compatible
+    #   systems.
+
+    # @comment YARD requires this emoty line :/
+    module Windows
+      def dev_null
+        'NUL'
+      end
+
+      def open_command
+        'start'
+      end
+
+      def rss_bytes
+        `tasklist /FI "PID eq #{Process.pid}" /FO CSV`.split(',"')[-1].tr(
+          ',.',
+          '__'
+        ).to_i * 1024
+      end
+
+      private
+
+      def _app_config_path
+        ENV['LOCALAPPDATA'] ||
+          "#{ENV['USERPROFILE']}/Local Settings/Application Data"
+      end
+    end
+
+    module Unix
+      def dev_null
+        '/dev/null'
+      end
+
+      def rss_bytes
+        `ps -o rss= -p #{Process.pid}`.to_i * 1024
+      end
+
+      private
+
+      def _app_config_path
+        (ENV['XDG_CONFIG_HOME'] || '~/.config')
+      end
+    end
+
+    module OS2
+      def dev_null
+        'nul'
+      end
+    end
+
+    module MacOS
+      def open_command
+        'open'
+      end
+
+      private
+
+      def _app_config_path
+        '~/Library/Application Support'
+      end
+    end
+
+    module Linux
+      def open_command
+        'xdg-open'
+      end
+    end
+
+    module AppConfigPath
+      def app_config_path(app_name)
+        File.expand_path(app_name, _app_config_path)
+      end
+    end
+
+    module JRuby
+      def rss_bytes
+        require 'java' unless defined?(java)
+        bean = java.lang.management.ManagementFactory.getMemoryMXBean
+        bean.heap_memory_usage.used + bean.non_heap_memory_usage.used
+      end
+    end
+
+    module Tools
+      def suggested_thread_count
+        @suggested_thread_count ||= find_suggested_thread_count
+      end
+
+      def temp_dir
+        @temp_dir ||= find_temp_dir
+      end
+
+      private
+
+      def find_suggested_thread_count
+        count = ENV['TC'].to_i
+        count > 0 ? count : with_etc(4) { Etc.nprocessors }
+      end
+
+      def find_temp_dir
+        return Dir.tmpdir if defined?(Dir.tmpdir)
+        as_dir('TMPDIR') || as_dir('TMP') || as_dir('TEMP') ||
+          as_dir(
+            'system temp dir',
+            with_etc("#{ENV['LOCALAPPDATA']}/Temp") { Etc.systmpdir }
+          ) || as_dir('/tmp', '/tmp') || as_dir('.', '.')
+      end
+
+      def as_dir(name, dirname = ENV[name])
+        return if dirname.nil? || dirname.empty?
+        dirname = File.expand_path(dirname)
+        stat = File.stat(dirname)
+        stat.directory? or warn("#{name} is not a valid directory - #{dirname}")
+        stat.writable? or warn("#{name} is not writable - #{dirname}")
+        (stat.world_writable? && !stat.sticky?) and
+          warn("#{name} is world-writable - #{dirname}")
+        dirname
+      rescue SystemCallError
+        nil
+      end
+
+      def with_etc(default)
+        require('etc') unless defined?(Etc)
+        yield
+      rescue LoadError
+        default
+      end
+    end
+  end
+
+  extend Support::Windows if windows?
+  extend Support::Unix if unix?
+  extend Support::MacOS if macosx?
+  extend Support::OS2 if os2?
+  extend Support::Linux if linux?
+  extend Support::AppConfigPath if windows? || unix?
+  extend Support::JRuby if Interpreter.jruby?
+  extend Support::Tools
+
+  module Support
+    private_constant :Windows
+    private_constant :Unix
+    private_constant :OS2
+    private_constant :MacOS
+    private_constant :Linux
+    private_constant :AppConfigPath
+    private_constant :JRuby
+    private_constant :Tools
+  end
+end

data/lib/host-os/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module HostOS
+  # @return [String] the version number of the gem
+  VERSION = '0.1.0'
+end

data/lib/host-os.rb

@@ -0,0 +1,367 @@
+# frozen_string_literal: true
+
+#
+# HostOS is a module that provides information about the operating system,
+# the current Ruby interpreter ({interpreter}) and configured environment ({env}).
+# It helps you write environment-specific code in a clean way.
+#
+module HostOS
+  module Helper
+    def is?(what)
+      return true if id == what
+      id == (defined?(what.to_sym) ? what.to_sym : what.to_s.to_sym)
+    end
+
+    protected
+
+    def respond_to_missing?(name, _include_all = false)
+      (name[-1] == '?') || super
+    end
+
+    def method_missing(name, *args)
+      return super if name[-1] != '?'
+      return is?(name[0..-2]) if args.empty?
+      raise(
+        ArgumentError,
+        "wrong number of arguments (given #{args.size}, expected 0)"
+      )
+    end
+  end
+  private_constant :Helper
+
+  #
+  # This module allows to identify the current environment by checking the `ENV`
+  # for the following variables in order:
+  #
+  # * RAILS_ENV
+  # * RACK_ENV
+  # * ENVIRONMENT
+  # * ENV
+  #
+  # You can check for any boolean attribute:
+  #
+  # @example Query if the environment is configured as "staging"
+  #   HostOS.env.staging?
+  # @example Test if the environment is configured as "production"
+  #   HostOS.env.is? :production
+  #
+  # @note When no environment is configured 'prod
+  #
+  module Env
+    extend Helper
+
+    class << self
+      # @attribute [r] production?
+      # @return [true, false] whether the environment is configured as "production"
+      # @note This will return true if the environment is not configured.
+
+      # @attribute [r] test?
+      # @return [true, false] whether the environment is configured as "test"
+
+      # @attribute [r] development?
+      # @return [true, false] whether the environment is configured as
+      #   "development"
+
+      # @attribute [r] id
+      # @return [Symbol] environment identifier
+      def id
+        ID
+      end
+
+      # @!method is?(what)
+      # @param what [Symbol, String] the identifier to check
+      # @return [true, false] whether the environment is the given identifier
+
+      # @comment YARD requires this line
+
+      private
+
+      def identify
+        found =
+          (
+            ENV['RAILS_ENV'] || ENV['RACK_ENV'] || ENV['ENVIRONMENT'] ||
+              ENV['ENV']
+          )
+        return :production if found.nil? || found.empty?
+        found.downcase.tr(' -', '__').to_sym
+      end
+    end
+
+    # @return [Symbol] environment identifier
+    ID = identify
+  end
+
+  #
+  # This module allows to identify the used Ruby interpreter.
+  #
+  # Besides here documented boolean attributes you can also check for any other
+  # boolean attribute or interpreter name:
+  #
+  # @example Query for the Opal interpreter
+  #   HostOS.interpreter.opal?
+  # @example Query for TruffleRuby
+  #   HostOS.interpreter.truffleruby?
+  #
+  module Interpreter
+    extend Helper
+
+    class << self
+      # @attribute [r] id
+      # @return [Symbol] interpreter identifier
+      def id
+        ID
+      end
+
+      # @attribute [r] mri?
+      # @return [true, false] whether the interpreter is the Yukihiro Matsumoto's
+      #   C-based (default) Ruby Interpreter
+      def mri?
+        ID == :mri
+      end
+      alias cruby? mri?
+      alias default? mri?
+
+      # @attribute [r] cardinal?
+      # @return [true, false] whether the interpreter is the Parrot based Cardinal
+      #   interpreter
+      def cardinal?
+        ID == :cardinal
+      end
+      alias parrot? cardinal?
+
+      # @attribute [r] jruby?
+      # @return [true, false] whether the interpreter is the Java based JRuby
+      #  Interpreter
+      def jruby?
+        ID == :jruby
+      end
+      alias java? jruby?
+
+      # @attribute [r] rbx?
+      # @return [true, false] whether the interpreter is the Rubinius Interpreter
+      def rbx?
+        ID == :rbx
+      end
+      alias rubinius? rbx?
+
+      # @attribute [r] ree?
+      # @return [true, false] whether the interpreter is the Ruby Enterprise
+      #   Edition
+      def ree?
+        ID == :ree
+      end
+      alias enterprise? ree?
+
+      # @attribute [r] jit_enabled?
+      # @return [true, false] whether the interpreter currently uses a JIT
+      #   Compiler
+      def jit_enabled?
+        jit_type != :none
+      end
+
+      # @attribute [r] jit_type
+      # @return [:mjit, :rjit, :yjit, :java, :none] type of currently used JIT
+      #   Compiler
+      def jit_type
+        return :mjit if defined?(RubyVM::MJIT) && RubyVM::MJIT.enabled?
+        return :yjit if defined?(RubyVM::YJIT) && RubyVM::YJIT.enabled?
+        return :rjit if defined?(RubyVM::RJIT) && RubyVM::RJIT.enabled?
+        jruby? ? :java : :none
+      end
+
+      # @!visibility private
+      def to_s
+        case ID
+        when :mri
+          'CRuby'
+        when :ree
+          'Enterprise Ruby'
+        when :cardinal
+          'Cardinal'
+        when :jruby
+          'JRuby'
+        when :rby
+          'Rubinius'
+        when :truffleruby
+          'TruffleRuby'
+        else
+          ID.to_s.upcase
+        end
+      end
+
+      # @!method is?(what)
+      # @param what [Symbol, String] the identifier to check
+      # @return [true, false] whether the interpreter is the given identifier
+
+      # @comment YARD requires this line
+
+      private
+
+      def identify
+        if defined?(RUBY_PLATFORM) && (RUBY_PLATFORM == 'parrot')
+          return :cardinal
+        end
+        return :mri unless defined?(RUBY_ENGINE)
+        return RUBY_ENGINE.to_sym if RUBY_ENGINE != 'ruby'
+        RUBY_DESCRIPTION.downcase.include?('enterprise') ? :ree : :mri
+      end
+    end
+
+    # @return [Symbol] interpreter identifier
+    ID = identify
+  end
+
+  extend Helper
+
+  class << self
+    # @attribute [r] id
+    # @return [Symbol] OS identifier
+    def id
+      ID
+    end
+
+    # @attribute [r] type
+    # @return [:unix,  :windows, :vms, :os2, :unknown] OS type
+    def type
+      TYPE
+    end
+
+    # @attribute [r] interpreter
+    # @return [Interpreter] interpreter information
+    def interpreter
+      Interpreter
+    end
+
+    # @attribute [r] env
+    # @return [Env] environment information
+    def env
+      Env
+    end
+
+    # @attribute [r] unix?
+    # @return [true, false] whether the host OS is a Unix OS
+    def unix?
+      TYPE == :unix
+    end
+
+    # @attribute [r] windows?
+    # @return [true, false] whether the host OS is a Windows OS
+    def windows?
+      TYPE == :windows
+    end
+
+    # @attribute [r] vms?
+    # @return [true, false] whether the host OS is VMS
+    def vms?
+      TYPE == :vms
+    end
+
+    # @attribute [r] os2?
+    # @return [true, false] whether the host OS is OS/2
+    def os2?
+      TYPE == :os2
+    end
+
+    # @attribute [r] macosx?
+    # @return [true, false] whether the host OS is identified as MacOS
+    def macosx?
+      ID == :macosx
+    end
+
+    # @attribute [r] linux?
+    # @return [true, false] whether the host OS is identified as Linux derivate
+    def linux?
+      ID == :linux
+    end
+
+    # @attribute [r] cygwin?
+    # @return [true, false] whether the host OS is Windows/Cygwin
+    def cygwin?
+      ID == :cygwin
+    end
+
+    # @attribute [r] posix?
+    # @return [true, false] whether the host OS is Posix compatible
+    # This attribute is `true` when Posix compatible commands like `fork` are
+    # available.
+    def posix?
+      Process.respond_to?(:fork)
+    end
+
+    # @param what [Symbol, String] the identifier to check
+    # @return [true, false] whether the host OS is the given identifier or type
+    def is?(what)
+      return true if (ID == what) || (TYPE == what)
+      what = defined?(what.to_sym) ? what.to_sym : what.to_s.to_sym
+      (ID == what) || (TYPE == what)
+    end
+
+    # @!visibility private
+    def to_s
+      case ID
+      when :linux
+        'Linux'
+      when :macosx
+        'MacOSX'
+      when :freebsd
+        'FreeBSD'
+      when :netbsd
+        'NetBSD'
+      when :openbsd
+        'OpenBSD'
+      when :dragonfly
+        'Dragonly'
+      when :sunis
+        'SunOS'
+      when :mswin
+        'MSWin'
+      when :mingw
+        'MinGW'
+      when :bccwin
+        'BCCWin'
+      when :wince
+        'WinCE'
+      when :windows, :cygwin
+        ID.to_s.capitalize
+      else
+        ID.to_s.upcase
+      end
+    end
+
+    private
+
+    def identify
+      require('rbconfig') unless defined?(RbConfig)
+      id = RbConfig::CONFIG['host_os'].downcase
+      id, type, normalized =
+        [
+          ['linux', :unix],
+          ['arch', :unix, :linux],
+          ['darwin', :unix, :macosx],
+          ['mac', :unix, :macosx],
+          ['freebsd', :unix],
+          ['netbsd', :unix],
+          ['openbsd', :unix],
+          ['dragonfly', :unix],
+          ['aix', :unix],
+          ['irix', :unix],
+          ['hpux', :unix],
+          ['solaris', :unix, :sunos],
+          ['sunos', :unix, :sunos],
+          ['windows', :windows],
+          ['cygwin', :windows],
+          ['mswin', :windows],
+          ['mingw', :windows],
+          ['bccwin', :windows],
+          ['djgpp', :windows],
+          ['wince', :windows],
+          ['emc', :windows],
+          ['vms', :vms],
+          ['os2', :os2]
+        ].find { |info| id.include?(info[0]) }
+      id ? [normalized || id.to_sym, type] : %i[unknown unknown]
+    end
+  end
+
+  ID, TYPE = identify
+end

data/lib/host_os.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'host-os'

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: host-os
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Blumtritt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-30 00:00:00.000000000 Z
+dependencies: []
+description: |
+  This gem helps you write environment-specific code in a clean way.
+  It provides a simple API to get information about the operating system,
+  the current Ruby interpreter, and the configured environment.
+email:
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- examples/current.rb
+- lib/host-os.rb
+- lib/host-os/support.rb
+- lib/host-os/version.rb
+- lib/host_os.rb
+homepage: https://github.com/mblumtritt/host-os
+licenses:
+- BSD-3-Clause
+metadata:
+  source_code_uri: https://github.com/mblumtritt/host-os
+  bug_tracker_uri: https://github.com/mblumtritt/host-os/issues
+  documentation_uri: https://rubydoc.info/gems/host-os
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: This module offers details on the host OS, the present Ruby interpreter and
+  environment.
+test_files: []