sys-cpu 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 240d4766057d3b5e6099092e037a858a527598955f303a6b1e958e78dd55f10e
-  data.tar.gz: 9a1041ac81a63a1205d28d94c59373a5868f17eb9e46b1cf4226f3488f7dafd9
+  metadata.gz: c2c9b0550fea7a97f78cb37062e8f347d1b945e53a2a885f2c4fa8cdd02e0dc5
+  data.tar.gz: 6b4c3525653fd1a186078a533826795e3d2b168c2649d48fe549de33ca021edb
 SHA512:
-  metadata.gz: 9bb252c92d2460f38fdf65656c2d3875c55b6d3d2ec73863be3fcdd878d3d66a49a33f9a9d1d49ae65aa4c8d3d5a405bac2aa3bdaaa4edbc5d6854e12e6a29af
-  data.tar.gz: 993afd63ee978e9bd24682309221f9f4fbddb177f8ed748b9cf512317bf72ea5243b529d114e9407fbf198f00c685fc1a6a0afc4646e2230acce9a5dce8d0d08
+  metadata.gz: c3efb6d399e22fff8380ec6d581c3997707bab5f99a7bbe001a86a058427e348066fce271348c9451f567bf6ffa7a9f2cf247de94ae82cd258d5ea6fa3d4bb9c
+  data.tar.gz: 337fe45c0fe0463320c910aee118cf3496f71b9b4be7965d79204a109b12d273746f47afa50deb96519ec4118a3058e2aba00d912810bf065abee5e5fc8e0678

data/CHANGES.md

@@ -1,6 +1,15 @@
+## 1.1.0 - 9-Jun-2024
+* Removed Solaris support.
+* Added DragonflyBSD support.
+* Fixed example task.
+* Made some constants private in the generic Unix code that should
+  have been private.
+* The architecture method on Linux will now interpret values 4, 5
+  and 15. If it's not any of those values it will return 'Unknown'.
+
 ## 1.0.6 - 12-Aug-2022
 * The Sys::CPU.model method will now return "ARM" for machines using an
-  ARM-based processor instead of "Uknown".
+  ARM-based processor instead of "Unknown".
 
 ## 1.0.5 - 10-Aug-2022
 * Updated the cpu detection handling for Mac M1 systems. Thanks go to

data/MANIFEST.md

@@ -9,12 +9,10 @@
 * doc/bsd.txt
 * doc/hpux.txt
 * doc/linux.txt
-* doc/sunos.txt
 * doc/windows.txt
 * examples/example_sys_cpu_freebsd.rb
 * examples/example_sys_cpu_hpux.rb
 * examples/example_sys_cpu_linux.rb
-* examples/example_sys_cpu_sunos.rb
 * examples/example_sys_cpu_windows.rb
 * lib/sys/cpu.rb
 * lib/sys/darwin/sys/cpu.rb
@@ -26,5 +24,4 @@
 * spec/sys_cpu_bsd_spec.rb
 * spec/sys_cpu_hpux_spec.rb
 * spec/sys_cpu_linux_spec.rb
-* spec/sys_cpu_sunos_spec.rb
 * spec/sys_cpu_windows_spec.rb

data/README.md

@@ -3,6 +3,7 @@
 * Linux
 * Windows
 * OSX
+* DragonflyBSD
 
 ## Description
 A Ruby interface for getting cpu information.
@@ -71,7 +72,7 @@ https://github.com/djberg96/sys-cpu
 Apache-2.0
 
 ## Copyright
-(C) 2003-2022 Daniel J. Berger, All Rights Reserved
+(C) 2003-2024 Daniel J. Berger, All Rights Reserved
 
 ## Warranty
 This package is provided "as is" and without any express or

data/Rakefile

@@ -26,23 +26,19 @@ end
 desc "Run the example program"
 task :example => [:clean] do
   case CONFIG['host_os']
-  when /bsd|darwin|osx/i
+  when /bsd|darwin|osx|dragonfly/i
     file = "examples/example_sys_cpu_bsd.rb"
-    sh "ruby -Ilib/unix #{file}"
+    sh "ruby -Ilib #{file}"
   when /hpux/i
     file = "examples/example_sys_cpu_hpux.rb"
-    sh "ruby -Ilib/unix #{file}"
+    sh "ruby -Ilib #{file}"
   when /linux/i
     file = "examples/example_sys_cpu_linux.rb"
-    sh "ruby -Ilib/linux #{file}"
+    sh "ruby -Ilib #{file}"
   when /windows|win32|cygwin|mingw|dos/i
     file = "examples/example_sys_cpu_windows.rb"
-    sh "ruby -Ilib/windows #{file}"
-  when /sunos|solaris/i
-    file = "examples/example_sys_cpu_sunos.rb"
-    sh "ruby -Ilib/unix #{file}"
+    sh "ruby -Ilib #{file}"
   end
-
 end
 
 RuboCop::RakeTask.new

data/install.rb

@@ -16,7 +16,7 @@ case CONFIG['host_os']
     file = "lib/windows/sys/cpu.rb"
   when /linux/i
     file = "lib/linux/sys/cpu.rb"
-  when /sunos|solaris|hpux|freebsd/i
+  when /hpux|freebsd|dragonfly/i
     STDERR.puts "Use 'extconf.rb/make/make site-install' for this platform"
     exit
   else

data/lib/sys/cpu.rb

@@ -10,7 +10,7 @@ module Sys
   # This class is reopened for each of the supported platforms/operating systems.
   class CPU
     # The version of the sys-cpu gem.
-    VERSION = '1.0.6'
+    VERSION = '1.1.0'
 
     private_class_method :new
   end

data/lib/sys/darwin/sys/cpu.rb

@@ -69,11 +69,9 @@ module Sys
     private_class_method :sysctlbyname
 
     attach_function :getloadavg, %i[pointer int], :int
-    attach_function :processor_info, %i[int int string pointer pointer], :int
     attach_function :sysconf, [:int], :long
 
     private_class_method :getloadavg
-    private_class_method :processor_info
     private_class_method :sysconf
 
     class ClockInfo < FFI::Struct

data/lib/sys/linux/sys/cpu.rb

@@ -82,8 +82,16 @@ module Sys
       case CPU_ARRAY.first['cpu_family']
         when '3'
           'x86'
+        when '4'
+          'i486'
+        when '5'
+          'Pentium'
         when '6'
           'x86_64'
+        when '15'
+          'Netburst'
+        else
+          'Unknown'
       end
     end
 

data/lib/sys/unix/sys/cpu.rb

@@ -20,16 +20,22 @@ module Sys
     HW_NCPU         = 3  # Number of CPU's
     HW_CPU_FREQ     = 15 # CPU frequency
 
-    if RbConfig::CONFIG['host_os'] =~ /bsd/
+    private_constant :CTL_HW, :HW_MACHINE, :HW_MODEL, :HW_NCPU, :HW_CPU_FREQ
+
+    if RbConfig::CONFIG['host_os'] =~ /bsd|dragonfly/
       HW_MACHINE_ARCH = 11 # Machine architecture
     else
       HW_MACHINE_ARCH = 12 # Machine architecture
     end
 
+    private_constant :HW_MACHINE_ARCH
+
     SI_MACHINE          = 5
     SI_ARCHITECTURE     = 6
     SC_NPROCESSORS_ONLN = 15
 
+    private_constant :SI_MACHINE, :SI_ARCHITECTURE, :SC_NPROCESSORS_ONLN
+
     P_OFFLINE  = 1
     P_ONLINE   = 2
     P_FAULTED  = 4
@@ -37,6 +43,8 @@ module Sys
     P_NOINTR   = 6
     P_SPARE    = 7
 
+    private_constant :P_OFFLINE, :P_ONLINE, :P_FAULTED, :P_POWEROFF, :P_NOINTR, :P_SPARE
+
     CPU_ARCH_ABI64     = 0x01000000
     CPU_TYPE_X86       = 7
     CPU_TYPE_X86_64    = (CPU_TYPE_X86 | CPU_ARCH_ABI64)
@@ -44,6 +52,9 @@ module Sys
     CPU_TYPE_POWERPC   = 18
     CPU_TYPE_POWERPC64 = CPU_TYPE_POWERPC | CPU_ARCH_ABI64
 
+    private_constant :CPU_ARCH_ABI64, :CPU_TYPE_X86, :CPU_TYPE_X86_64
+    private_constant :CPU_TYPE_SPARC, :CPU_TYPE_POWERPC, :CPU_TYPE_POWERPC64
+
     begin
       attach_function(
         :sysctl,
@@ -234,7 +245,7 @@ module Sys
 
         size.write_long(optr.size)
 
-        if RbConfig::CONFIG['host_os'] =~ /bsd/i
+        if RbConfig::CONFIG['host_os'] =~ /bsd|dragonfly/i
           name = 'hw.clockrate'
         else
           name = 'hw.cpufrequency'

data/spec/spec_helper.rb

@@ -5,8 +5,7 @@ require 'sys_cpu_shared'
 
 RSpec.configure do |config|
   config.include_context(Sys::CPU)
-  config.filter_run_excluding(:bsd) if RbConfig::CONFIG['host_os'] !~ /bsd|darwin|mach|osx/i
-  config.filter_run_excluding(:sunos) if RbConfig::CONFIG['host_os'] !~ /sunos|solaris/i
+  config.filter_run_excluding(:bsd) if RbConfig::CONFIG['host_os'] !~ /bsd|darwin|mach|osx|dragonfly/i
   config.filter_run_excluding(:windows) if RbConfig::CONFIG['host_os'] !~ /mswin|win32|dos|mingw|cygwin/i
   config.filter_run_excluding(:hpux) if RbConfig::CONFIG['host_os'] !~ /hpux/i
   config.filter_run_excluding(:linux) if RbConfig::CONFIG['host_os'] !~ /linux/i

data/spec/sys_cpu_bsd_spec.rb

@@ -104,7 +104,13 @@ RSpec.describe Sys::CPU, :bsd => true do
       expect(constants).not_to include(:ClockInfo)
     end
 
-    example "ffi methods are private" do
+    example "ffi core methods are private" do
+      methods = described_class.methods(false)
+      expect(methods).not_to include(:attach_function)
+      expect(methods).not_to include(:bitmask)
+    end
+
+    example "ffi attached methods are private" do
       methods = described_class.methods(false)
       expect(methods).not_to include(:sysctl)
       expect(methods).not_to include(:sysctlbyname)

data/spec/sys_cpu_shared.rb

@@ -11,7 +11,7 @@ require 'rspec'
 
 RSpec.shared_examples Sys::CPU do
   example 'version number is set to the expected value' do
-    expect(Sys::CPU::VERSION).to eq('1.0.6')
+    expect(Sys::CPU::VERSION).to eq('1.1.0')
   end
 
   example 'version number is frozen' do

data/sys-cpu.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-cpu'
-  spec.version    = '1.0.6'
+  spec.version    = '1.1.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'
@@ -29,7 +29,8 @@ Gem::Specification.new do |spec|
     'documentation_uri'     => 'https://github.com/djberg96/sys-cpu/wiki',
     'source_code_uri'       => 'https://github.com/djberg96/sys-cpu',
     'wiki_uri'              => 'https://github.com/djberg96/sys-cpu/wiki',
-    'rubygems_mfa_required' => 'true'
+    'rubygems_mfa_required' => 'true',
+    'github_repo'           => 'https://github.com/djberg96/sys-cpu'
   }
 
   spec.description = <<-EOF

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: sys-cpu
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -126,12 +126,10 @@ files:
 - doc/bsd.md
 - doc/hpux.txt
 - doc/linux.md
-- doc/sunos.txt
 - doc/windows.txt
 - examples/example_sys_cpu_bsd.rb
 - examples/example_sys_cpu_hpux.rb
 - examples/example_sys_cpu_linux.rb
-- examples/example_sys_cpu_sunos.rb
 - examples/example_sys_cpu_windows.rb
 - install.rb
 - lib/sys-cpu.rb
@@ -145,7 +143,6 @@ files:
 - spec/sys_cpu_hpux_spec.rb
 - spec/sys_cpu_linux_spec.rb
 - spec/sys_cpu_shared.rb
-- spec/sys_cpu_sunos_spec.rb
 - spec/sys_cpu_windows_spec.rb
 - sys-cpu.gemspec
 homepage: https://github.com/djberg96/sys-cpu
@@ -159,7 +156,8 @@ metadata:
   source_code_uri: https://github.com/djberg96/sys-cpu
   wiki_uri: https://github.com/djberg96/sys-cpu/wiki
   rubygems_mfa_required: 'true'
-post_install_message: 
+  github_repo: https://github.com/djberg96/sys-cpu
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,15 +172,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: A Ruby interface for providing CPU information
 test_files:
 - spec/spec_helper.rb
 - spec/sys_cpu_bsd_spec.rb
-- spec/sys_cpu_shared.rb
-- spec/sys_cpu_sunos_spec.rb
 - spec/sys_cpu_hpux_spec.rb
 - spec/sys_cpu_linux_spec.rb
+- spec/sys_cpu_shared.rb
 - spec/sys_cpu_windows_spec.rb

data/doc/sunos.txt

@@ -1,56 +0,0 @@
-== Description
-   Sys::CPU - An interface for various cpu statistics
-   
-== Synopsis
-   require "sys/cpu"
-   include Sys
-
-   # Solaris
-   puts "Mhz: " + CPU.cpu_freq(0).to_s
-   puts "State: " + CPU.state(0)
-   puts "Number of cpu's on this system: " + CPU.num_cpu.to_s
-   puts "CPU type: " + CPU.architecture
-   puts "FPU type: " + CPU.fpu_type
-   puts "CPU model: " + CPU.model
-   puts "Load averages: " + CPU.load_avg.join(", ")
-   
-== Constants
-VERSION
-   Returns the current version number for this package.
-    
-== Class Methods
-CPU.freq(cpu_num=0)
-   Returns an integer indicating the speed (i.e. frequency in Mhz) of
-   'cpu_num', or CPU 0 if no number is provided.
-    
-CPU.architecture
-   Returns a string indicating the type of processor.  This is the
-   architecture (e.g. sparcv9), not the exact model (e.g. Ultra-IIe).
-   Returns nil if not found.
-    
-CPU.fpu_type
-   Returns a string indicating the type of floating point unit, or nil if
-   not found.
-    
-CPU.load_avg
-   Returns an array of three floats indicating the 1, 5 and 15 minute load
-   average.
-    
-CPU.model
-   Returns a string indicating the cpu model.  For now, this is the
-   architecture type, rather than the exact model.  However, see the
-   'Future Plans' section below.
-    
-CPU.num_cpu
-   Returns an integer indicating the number of cpu's on the system.
-    
-CPU.state(cpu_num)
-   Returns a string indicating the cpu state of 'cpu_num'.
-    
-== Error Classes
-CPU::Error < StandardError
-   Raised is response to internal function errors, usually relating to an
-   invalid cpu number.
-    
-== More Information
-See the README file for more information.

data/examples/example_sys_cpu_sunos.rb

@@ -1,21 +0,0 @@
-#######################################################################
-# example_sys_cpu_sunos.rb
-#
-# Sample cript for general futzing. You can run this code via the
-# 'rake example' task.
-#
-# Modify as you see fit.
-#######################################################################
-require "sys/cpu"
-include Sys
-
-puts "VERSION: " + CPU::VERSION
-puts "========"
-
-puts "Load Average: " + CPU.load_avg.join(", ")
-puts "CPU Freq (speed): " + CPU.freq.to_s
-puts "CPU State: " + CPU.state(0)
-puts "Num CPU: " + CPU.num_cpu.to_s
-puts "Type: " + CPU.cpu_type
-puts "FPU Type: " + CPU.fpu_type
-puts "Model: " + CPU.model

data/spec/sys_cpu_sunos_spec.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-
-###########################################################
-# sys_cpu_sunos_spec.rb
-#
-# Test suite for sys-cpu on Solaris. This should be run
-# via the 'rake spec' task.
-###########################################################
-require 'sys/cpu'
-require 'spec_helper'
-
-RSpec.describe Sys::CPU, :sunos => true do
-  example 'freq method basic functionality' do
-    expect(described_class).to respond_to(:freq)
-    expect{ described_class.freq }.not_to raise_error
-  end
-
-  example 'freq method does not accept any arguments' do
-    expect{ described_class.freq(0) }.to raise_error(ArgumentError)
-  end
-
-  example 'freq method returns a sane value' do
-    expect(described_class.freq).to be_kind_of(Integer)
-    expect(described_class.freq).to be > 100
-  end
-
-  example 'fpu_type basic functionality' do
-    expect(described_class).to respond_to(:fpu_type)
-    expect{ described_class.fpu_type }.not_to raise_error
-  end
-
-  example 'fpu_type returns a sane value' do
-    expect(described_class.fpu_type).to be_kind_of(String)
-    expect(described_class.fpu_type).not_to be_empty
-  end
-
-  example 'load_avg basic functionality' do
-    expect(described_class).to respond_to(:load_avg)
-    expect{ described_class.load_avg }.not_to raise_error
-  end
-
-  example 'load_avg method returns the expected values' do
-    expect(described_class.load_avg).to be_kind_of(Array)
-    expect(described_class.load_avg.length).to eq(3)
-    expect(described_class.load_avg.first).to be_kind_of(Float)
-  end
-
-  example 'model method basic functionality' do
-    expect(described_class).to respond_to(:model)
-    expect{ described_class.model }.not_to raise_error
-  end
-
-  example 'model method returns a sane value' do
-    expect(described_class.model).to be_kind_of(String)
-    expect(described_class.model).not_to be_empty
-  end
-
-  example 'num_cpu method basic functionalty' do
-    expect(described_class).to respond_to(:num_cpu)
-    expect{ described_class.num_cpu }.not_to raise_error
-  end
-
-  example 'num_cpu method returns a sane value' do
-    expect(described_class.num_cpu).to be_kind_of(Integer)
-    expect(described_class.num_cpu).to be > 0
-  end
-
-  example 'state basic functionality' do
-    expect(described_class).to respond_to(:state)
-    expect{ described_class.state }.not_to raise_error
-  end
-
-  example 'state method accepts one optional argument' do
-    expect{ described_class.state(0) }.not_to raise_error
-    expect{ described_class.state(0, 0) }.to raise_error(ArgumentError)
-  end
-
-  example 'state method returns a sane value' do
-    expect(described_class.state(0)).to be_kind_of(String)
-    expect(described_class.state.empty?).to be false
-  end
-end