OS Gem 技术文档

1. 安装指南

安装步骤

要安装 OS gem，您可以使用以下命令：

bundle add os

此命令会自动将 OS gem 添加到您的 Gemfile 中，并执行安装。

2. 项目的使用说明

基本使用

首先，您需要在 Ruby 脚本中引入 OS gem：

require 'os'

示例代码

以下是一些常见的使用示例：

# 检查当前操作系统是否为 Windows
>> OS.windows?
=> true   # 或者使用 OS.doze?

# 获取操作系统的位数
>> OS.bits
=> 32

# 检查是否运行在 JRuby 环境中
>> OS.java?
=> true # 如果运行在 JRuby 环境中。也可以使用 OS.jruby?

# 获取 Ruby 可执行文件的路径
>> OS.ruby_bin
=> "c:\ruby18\bin\ruby.exe" # 或者 "/usr/local/bin/ruby" 等

# 检查是否为 POSIX 兼容系统
>> OS.posix?
=> false # 对于 Linux、OS X、Cygwin 返回 true

# 检查是否为 Mac 系统
>> OS.mac? # 或者 OS.osx? 或 OS.x?
=> false

# 获取操作系统特定的空设备路径
>> OS.dev_null
=> "NUL" # 或者 "/dev/null" 取决于操作系统

# 获取当前进程的内存使用情况（RSS 字节数）
>> OS.rss_bytes
=> 12300033 # 表示当前进程使用的内存总量（不包括交换文件中的内存）

# 获取主机 CPU 架构
>> OS.host_cpu
=> "x86_64"

# 打印操作系统报告
>> puts OS.report
==> # 输出一个包含有用值的 YAML 报告
--- 
arch: x86_64-darwin10.6.0
target_os: darwin10.6.0
target_vendor: apple
target_cpu: x86_64
target: x86_64-apple-darwin10.6.0
host_os: darwin10.6.0
host_vendor: apple
host_cpu: i386
host: i386-apple-darwin10.6.0
RUBY_PLATFORM: x86_64-darwin10.6.0

# 获取 CPU 核心数（不包括超线程核心）
>> OS.cpu_count  
=> 2

# 获取打开文件的命令
>> OS.open_file_command
=> "start" # 或者在 Mac 上为 "open"，在 Linux 上为 "xdg-open"

# 检查底层操作系统是否为 Windows（包括 Cygwin 和 MRI）
>> OS::Underlying.windows?
=> true # 对于 Cygwin 或 MRI 返回 true，而 OS.windows? 对 Cygwin 返回 false

# 检查底层操作系统是否为 BSD（包括 OS X）
>> OS::Underlying.bsd?
=> true

# 检查是否运行在 Docker 容器中
>> OS::Underlying.docker?
=> false

# 解析当前 Linux 发行版的详细信息（如果不是 Linux 则抛出异常）
>> pp OS.parse_os_release
==> # 返回一个包含当前 Linux 发行版详细信息的哈希
{:NAME=>"Ubuntu",
 :VERSION=>"18.04.4 LTS (Bionic Beaver)",
 :ID=>"ubuntu",
 :ID_LIKE=>"debian",
 :PRETTY_NAME=>"Ubuntu 18.04.4 LTS",
 :VERSION_ID=>"18.04",
 :HOME_URL=>"https://www.ubuntu.com/",
 :SUPPORT_URL=>"https://help.ubuntu.com/",
 :BUG_REPORT_URL=>"https://bugs.launchpad.net/ubuntu/",
 :PRIVACY_POLICY_URL=>
  "https://www.ubuntu.com/legal/terms-and-policies/privacy-policy",
 :VERSION_CODENAME=>"bionic",
 :UBUNTU_CODENAME=>"bionic"}

3. 项目 API 使用文档

主要 API 方法

• OS.windows?：检查当前操作系统是否为 Windows。
• OS.doze?：同 OS.windows?。
• OS.bits：返回操作系统的位数（32 或 64）。
• OS.java?：检查是否运行在 JRuby 环境中。
• OS.jruby?：同 OS.java?。
• OS.ruby_bin：返回 Ruby 可执行文件的路径。
• OS.posix?：检查是否为 POSIX 兼容系统（如 Linux、OS X、Cygwin）。
• OS.mac?：检查是否为 Mac 系统。
• OS.osx?：同 OS.mac?。
• OS.x?：同 OS.mac?。
• OS.dev_null：返回操作系统特定的空设备路径。
• OS.rss_bytes：返回当前进程的内存使用情况（RSS 字节数）。
• OS.host_cpu：返回主机 CPU 架构。
• OS.report：返回一个包含有用值的 YAML 报告。
• OS.cpu_count：返回 CPU 核心数（不包括超线程核心）。
• OS.open_file_command：返回打开文件的命令。
• OS::Underlying.windows?：检查底层操作系统是否为 Windows（包括 Cygwin 和 MRI）。
• OS::Underlying.bsd?：检查底层操作系统是否为 BSD（包括 OS X）。
• OS::Underlying.docker?：检查是否运行在 Docker 容器中。
• OS.parse_os_release：解析当前 Linux 发行版的详细信息（如果不是 Linux 则抛出异常）。

4. 项目安装方式

使用 Bundler 安装

最简单的安装方式是使用 Bundler：

bundle add os

此命令会自动将 OS gem 添加到您的 Gemfile 中，并执行安装。

手动安装

如果您不使用 Bundler，也可以手动安装 OS gem：

gem install os

安装完成后，您可以在 Ruby 脚本中引入并使用 OS gem。

5. 贡献指南

如果您想为项目贡献代码，可以按照以下步骤进行本地开发：

bundle install
bundle exec guard

6. 许可证

该项目使用 MIT 许可证，详细信息请参阅 LICENSE 文件。