cz_system_info 0.1.0

data/lib/cz_system_info/memory.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# The CzSystemInfo module serves as a namespace only.
+module CzSystemInfo
+  # The Memory module provides various functions that return information
+  # regarding the memory on your system.
+  module Memory
+    MEMORY_FILE = '/proc/meminfo'
+    MEMINFO_REGEX = /(.*)?:\s+?(\d+)/.freeze
+
+    private_constant :MEMORY_FILE
+    private_constant :MEMINFO_REGEX
+
+    # Obtain detailed memory information about your host in the form of a hash.
+    # Note that the exact nature of this hash is largely dependent on your
+    # operating system.
+    #
+    def memory
+      hash = {}
+
+      File.foreach(MEMORY_FILE) do |line|
+        key, value = MEMINFO_REGEX.match(line.chomp).captures
+        hash[key] = value.to_i
+      end
+
+      hash
+    end
+
+    # Total memory in bytes. By default this is only physical memory, but
+    # if the +extended+ option is set to true, then swap memory is included
+    # as part of the total.
+    #
+    def total(extended: false)
+      hash = memory
+      extended ? (hash['MemTotal'] + hash['SwapTotal']) * 1024 : hash['MemTotal'] * 1024
+    end
+
+    # The memory currently available, in bytes. By default this is only
+    # physical memory, but if the +extended+ option is set to true, then free
+    # swap memory is also included.
+    #
+    def free(extended: false)
+      hash = memory
+      extended ? (hash['MemFree'] + hash['SwapFree']) * 1024 : hash['MemFree'] * 1024
+    end
+
+    # The memory, in bytes, currently in use. By default this is only
+    # physical memory, but if the +extended+ option is set to true then
+    # swap is included in the calculation.
+    #
+    def used(extended: false)
+      hash = memory
+      (total(extended: extended) - free(extended: extended) - hash['Buffers'] - hash['Cached'] - hash['Slab']) * 1024
+    end
+
+    # A number between 0 and 100 that specifies the approximate percentage of
+    # memory that is in use. If the +extended+ option is set to true then
+    # swap memory is included in the calculation.
+    #
+    def load(extended: false)
+      (used(extended: extended) / total(extended: extended).to_f).round(2) * 100
+    end
+
+    module_function :memory, :total, :free, :used, :load
+  end # Memory
+end # CzSystemInfo

data/lib/cz_system_info/uptime.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+# The CzSystemInfo module serves as a namespace only.
+module CzSystemInfo
+  # The Uptime class encapsulates various bits of information regarding your
+  # system's uptime, including boot time.
+  class Uptime
+    extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+
+    # Error typically raised in one of the Uptime methods should fail.
+    class Error < StandardError; end
+
+    # Hit this issue on Linux, not sure why
+    begin
+      find_type(:clock_t)
+    rescue TypeError
+      typedef(:long, :clock_t)
+    end
+
+    attach_function :strerror, [:int],     :string
+    attach_function :sysconf,  [:int],     :long
+    attach_function :time,     [:pointer], :time_t
+    attach_function :times,    [:pointer], :clock_t
+
+    private_class_method :strerror, :sysconf, :time, :times, :new
+
+    begin
+      attach_function :sysctl, %i[pointer uint pointer pointer pointer size_t], :int
+      private_class_method :sysctl
+    rescue FFI::NotFoundError
+      attach_function :setutxent, [], :void
+      attach_function :getutxent, [], :pointer
+      attach_function :endutxent, [], :void
+      private_class_method :setutxent, :getutxent, :endutxent
+    end
+
+    CTL_KERN      = 1   # Kernel
+    KERN_BOOTTIME = 21  # Time kernel was booted
+    TICKS         = 100 # Ticks per second (TODO: use sysconf)
+    BOOT_TIME     = 2   # Boot time
+
+    private_constant :CTL_KERN
+    private_constant :KERN_BOOTTIME
+    private_constant :TICKS
+    private_constant :BOOT_TIME
+
+    class Tms < FFI::Struct
+      layout(
+        :tms_utime, :clock_t,
+        :tms_stime, :clock_t,
+        :tms_cutime, :clock_t,
+        :tms_cstime, :clock_t
+      )
+    end
+
+    private_constant :Tms
+
+    class Timeval < FFI::Struct
+      layout(
+        :tv_sec,  :long,
+        :tv_usec, :long
+      )
+    end
+
+    private_constant :Timeval
+
+    class ExitStatus < FFI::Struct
+      layout(
+        :e_termination, :short,
+        :e_exit, :short
+      )
+    end
+
+    private_constant :ExitStatus
+
+    class Utmpx < FFI::Struct
+      layout(
+        :ut_user, [:char, 32],
+        :ut_id,   [:char, 4],
+        :ut_line, [:char, 32],
+        :ut_pid,  :pid_t,
+        :ut_type, :short,
+        :ut_exit, ExitStatus,
+        :ut_tv,   Timeval,
+        :ut_session, :int,
+        :padding, [:int, 5],
+        :ut_host, [:char, 257]
+      )
+    end
+
+    private_constant :Utmpx
+
+    # Returns a Time object indicating the time the system was last booted.
+    #
+    # Example:
+    #
+    #    CzSystemInfo::Uptime.boot_time # => Mon Jul 13 06:08:25 -0600 2009
+    #
+    def self.boot_time
+      if RbConfig::CONFIG['host_os'] =~ /linux/i
+        Time.now - seconds
+      elsif respond_to?(:sysctl, true)
+        tv = Timeval.new
+        mib  = FFI::MemoryPointer.new(:int, 2).write_array_of_int([CTL_KERN, KERN_BOOTTIME])
+        size = FFI::MemoryPointer.new(:long, 1).write_int(tv.size)
+
+        if sysctl(mib, 2, tv, size, nil, 0) != 0
+          raise SystemCallError, "sysctl function failed: #{strerror(FFI.errno)}"
+        end
+
+        Time.at(tv[:tv_sec], tv[:tv_usec])
+      else
+        begin
+          setutxent()
+          while ent = Utmpx.new(getutxent())
+            if ent[:ut_type] == BOOT_TIME
+              time = Time.at(ent[:ut_tv][:tv_sec], ent[:ut_tv][:tv_usec])
+              break
+            end
+          end
+        ensure
+          endutxent()
+        end
+        time
+      end
+    end
+
+    # Returns the total number of seconds of uptime.
+    #
+    # Example:
+    #
+    #    CzSystemInfo::Uptime.seconds => 118800
+    #
+    def self.seconds
+      if RbConfig::CONFIG['host_os'] =~ /linux/i
+        # rubocop:disable Lint/RescueException
+        begin
+          File.read('/proc/uptime').split.first.to_i
+        rescue Exception => err
+          raise Error, err
+        end
+        # rubocop:enable Lint/RescueException
+      elsif respond_to?(:sysctl, true)
+        tv   = Timeval.new
+        mib  = FFI::MemoryPointer.new(:int, 2).write_array_of_int([CTL_KERN, KERN_BOOTTIME])
+        size = FFI::MemoryPointer.new(:long, 1).write_int(tv.size)
+
+        if sysctl(mib, 2, tv, size, nil, 0) != 0
+          raise SystemCallError, "sysctl function failed: #{strerror(FFI.errno)}"
+        end
+
+        time(nil) - tv[:tv_sec]
+      else
+        tms = Tms.new
+        times(tms) / TICKS
+      end
+    end
+
+    # Returns the total number of minutes of uptime.
+    #
+    # Example:
+    #
+    #    CzSystemInfo::Uptime.minutes # => 678
+    #
+    def self.minutes
+      seconds / 60
+    end
+
+    # Returns the total number of hours of uptime.
+    #
+    # Example:
+    #
+    #    CzSystemInfo::Uptime.hours # => 31
+    #
+    def self.hours
+      seconds / 3600
+    end
+
+    # Returns the total number of days of uptime.
+    #
+    # Example:
+    #
+    #    CzSystemInfo::Uptime.days # => 2
+    #
+    def self.days
+      seconds / 86400
+    end
+
+    # Returns the uptime as a colon separated string, including days,
+    # hours, minutes and seconds.
+    #
+    # Example:
+    #
+    #    CzSystemInfo::Uptime.uptime # => "1:9:24:57"
+    #
+    def self.uptime
+      secs  = seconds
+      days  = secs / 86400
+      secs -= days * 86400
+      hours = secs / 3600
+      secs -= hours * 3600
+      mins = secs / 60
+      secs -= mins * 60
+
+      "#{days}:#{hours}:#{mins}:#{secs}"
+    end
+
+    # Returns the uptime as a four element array, including days, hours,
+    # minutes and seconds.
+    #
+    # Example:
+    #
+    #    CzSystemInfo::Uptime.dhms # => [1,9,24,57]
+    #
+    def self.dhms
+      uptime.split(':')
+    end
+  end
+end

data/lib/cz_system_info/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CzSystemInfo
+  VERSION = "0.1.0"
+end

data/lib/cz_system_info.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "cz_system_info/version"
+require_relative "cz_system_info/cpu"
+require_relative "cz_system_info/filesystem"
+require_relative "cz_system_info/memory"
+require_relative "cz_system_info/uptime"
+
+module CzSystemInfo
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: cz_system_info
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hayate
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Move Daniel Berger's sys code into one.
+email:
+- holdstock@yeah.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cz_system_info.gemspec
+- lib/cz_system_info.rb
+- lib/cz_system_info/cpu.rb
+- lib/cz_system_info/filesystem.rb
+- lib/cz_system_info/filesystem/constants.rb
+- lib/cz_system_info/filesystem/functions.rb
+- lib/cz_system_info/filesystem/structs.rb
+- lib/cz_system_info/memory.rb
+- lib/cz_system_info/uptime.rb
+- lib/cz_system_info/version.rb
+homepage: https://github.com/hinagiku/cz_system_info
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hinagiku/cz_system_info
+  source_code_uri: https://github.com/hinagiku/cz_system_info
+  changelog_uri: https://github.com/hinagiku/cz_system_info
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Move Daniel Berger's sys code into one.
+test_files: []