sys-uname 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5cbd8721570c3681f05f66562a956b366d7839da185a309acc136fceab2f9b8
-  data.tar.gz: 315ba4bc84cbfb0e1201a78062858218f6652148a37d9e62f90a7200c70d3d50
+  metadata.gz: 19e018e416bcea0fd03d4d34554d8ac3f904d7a9c71461966925e5b3d5919cd4
+  data.tar.gz: fc9c7883ee6f7a4f17b129c132fa20b1c3ada2b68cb78dbecc2e16687007c93b
 SHA512:
-  metadata.gz: 5c22800edea9dfd5b9057fb3fae10a76e88ecbead21e02b8d66ce7b1105294f01efe661d9ae9e9fe9653293acd8966aabd667296c40d1891225fd54289422845
-  data.tar.gz: 10cad4749fee0e1e6fcd5f531e046ba8f9ce9af354401d065b8d786365aa7e87d6691745e84f164cf3ef87f1a5849b52f815d7c9a517ec839005963c5ca75d7b
+  metadata.gz: 516fc8b3658b538eed4a81b28756af79b8d6aadf718d03a4e995b5a2d44c7dcada9b123a19206a4c91da126faed8e3f93d5c8dbdec16fc6afa72aa94240819b4
+  data.tar.gz: 9978cc8d5929f4167314ea05c873a05e357008812df1480b8f59a24a8ebddf5c6568a7618a7db83437e02914f3008fc2890c2b9fdfe1b2a1ef04cd4c34c5f6e0

data/CHANGES.md

@@ -1,3 +1,14 @@
+## 1.3.0 - 10-Jun-2024
+* Added DragonflyBSD support.
+* Removed Solaris support, it's dead.
+
+## 1.2.3 - 9-Apr-2023
+* Added rubygems_mfa_required and github_repo to metadata.
+* Miscellaneous rubocop related updates.
+* Fixed one test for Windows.
+* The rubocop and rubocop-rspec gems are now development dependencies.
+* Now assumes Ruby 2.0 or later.
+
 ## 1.2.2 - 30-Oct-2020
 * Added a Gemfile.
 * The ffi dependency is now slightly more restrictive.

data/Gemfile

@@ -1,7 +1,2 @@
-source 'https://rubygems.org' do
-  gem 'ffi', '~> 1.1'
-  group 'test' do
-    gem 'rake'
-    gem 'rspec', '~> 3.9'
-  end
-end
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -1,3 +1,5 @@
+[![Ruby](https://github.com/djberg96/sys-uname/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/sys-uname/actions/workflows/ruby.yml)
+
 ## Description
 A cross-platform Ruby interface for getting operating system information. The name
 comes from the Unix 'uname' command, but this library works on MS Windows as well.
@@ -8,8 +10,11 @@ ffi 1.0 or later
 ## Installation
 `gem install sys-uname`
 
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/sys-uname/main/certs/djberg96_pub.pem)`
+
 ## Synopsis
-```
+```ruby
 require 'sys/uname' # require 'sys-uname' works, too
 
 # You now have Sys::Uname and Sys::Platform classes available.
@@ -22,22 +27,18 @@ p Sys::Platform.linux? # => true
 p Sys::Platform::ARCH  # => :x86_64
 ```
    
-## Solaris Notes
-Users on SunOS get several extra methods: architecture, platform,
-hw_serial, hw_provider, srpc_domain, isa_list, and dhcp_cache.
-
 ## BSD flavors, including OS X
-Users on BSD platforms get the extra Uname.model method.
+Users on BSD platforms get the extra `Uname.model` method.
 
 ## HP-UX Notes
-HP-UX users get the extra Uname.id_number method. This is actually a
+HP-UX users get the extra `Uname.id_number` method. This is actually a
 String, not a Fixnum, because that's how it's defined in the utsname
 struct.
 
 ## MS Windows Notes
 The C version for Windows has been completely scrapped in favor of an OLE
 plus WMI approach. It is pure Ruby. Please see the MSDN documentation for
-the Win32_OperatingSystem class for a complete list of what each of the
+the `Win32_OperatingSystem` class for a complete list of what each of the
 UnameStruct members mean.
 
 ## The Platform Class

data/Rakefile

@@ -1,8 +1,8 @@
 require 'rake'
-require 'rake/testtask'
 require 'rake/clean'
 require 'rbconfig'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 CLEAN.include("**/*.rbc", "**/*.rbx", "**/*.gem", "**/*.lock")
 
@@ -19,7 +19,7 @@ namespace :gem do
   desc "Create the sys-uname gem"
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('sys-uname.gemspec'))
+    spec = Gem::Specification.load('sys-uname.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
     Gem::Package.build(spec)
   end
@@ -31,6 +31,8 @@ namespace :gem do
   end
 end
 
+RuboCop::RakeTask.new
+
 desc "Run the test suite"
 RSpec::Core::RakeTask.new(:spec)
 

data/doc/uname.rdoc

@@ -26,7 +26,7 @@ VERSION
 
 == Class Methods
 Uname.sysname
-  Returns the operating system name, e.g. "SunOS"
+  Returns the operating system name, e.g. "Darwin".
     
 Uname.nodename
   Returns the nodename. This is usually, but not necessarily, the 
@@ -48,41 +48,12 @@ Uname.release
     
 Uname.uname
   Returns a struct of type UnameStruct that contains sysname, nodename,
-  machine, version, and release. On Solaris, it will also include 
-  architecture and platform. On HP-UX, it will also include id_number.
+  machine, version, and release. On HP-UX, it will also include id_number.
     
   MS Windows - there are many more, and different, fields in the struct.
   Please see the MSDN documenation on the Win32_OperatingSystem WMI class
   for a complete explanation of what each of these members mean.
     
-== Solaris Only
-Uname.architecture
-  Returns the instruction set architecture, e.g. "sparc"
-    
-Uname.platform
-  Returns the platform identifier, e.g. "SUNW,Sun-Blade-100"
-    
-Uname.isa_list
-  Returns a space separated string containing a list of all variant
-  instruction set architectures executable on the current system.
- 
-  They are listed in order of performance, from best to worst.
-
-Uname.hw_provider
-  Returns the name of the hardware manufacturer.
-
-Uname.hw_serial_number
-  Returns the ASCII representation of the hardware-specific serial number
-  of the machine that executes the function.
-
-Uname.srpc_domain
-  Returns the name of the Secure Remote Procedure Call domain, if any.
-
-Uname.dhcp_cache
-  Returns a hexidecimal encoding, in String form, of the name of the
-  interface configured by boot(1M) followed by the DHCPACK reply from
-  the server.
-    
 == BSD Platforms Only (including OS X)
 Uname.model
   Returns the model type, e.g. "PowerBook5,1"
@@ -105,14 +76,11 @@ UnameStruct members mean.
 None that I'm aware of. Please log any bugs on the project page at
 https://github.com/djberg96/sys-uname 
 	
-== Future Plans
-Add additional info for Linux, Solaris, BSD.
-
 == License
 Apache-2.0
 
 == Copyright
-(C) 2002-2020 Daniel J. Berger
+(C) 2002-2024 Daniel J. Berger
 All Rights Reserved
 
 == Warranty

data/examples/uname_test.rb

@@ -15,19 +15,7 @@ puts 'Version: ' + Uname.version
 puts 'Release: ' + Uname.release
 puts 'Machine: ' + Uname.machine # May be "unknown" on Win32
 
-if RbConfig::CONFIG['host_os'] =~ /sun|solaris/i
-  print "\nSolaris specific tests\n"
-  puts "==========================="
-  puts 'Architecture: ' + Uname.architecture
-  puts 'Platform: ' + Uname.platform
-  puts 'Instruction Set List: ' + Uname.isa_list.split.join(", ")
-  puts 'Hardware Provider: ' + Uname.hw_provider
-  puts 'Serial Number: ' + Uname.hw_serial_number.to_s
-  puts 'SRPC Domain: ' + Uname.srpc_domain # might be empty
-  puts 'DHCP Cache: ' + Uname.dhcp_cache # might be empty
-end
-
-if RbConfig::CONFIG['host_os'] =~ /powerpc|darwin|bsd|mach/i
+if RbConfig::CONFIG['host_os'] =~ /powerpc|darwin|bsd|dragonfly|mach/i
   print "\nBSD/OS X specific tests\n"
   puts "======================="
   puts 'Model: ' + Uname.model

data/lib/sys/platform.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
+# The Sys module is a namespace only.
 module Sys
+  # The Platform class provides singleton methods to tell you what OS you're on.
   class Platform
     # The CPU architecture
     ARCH = File::ALT_SEPARATOR ? Uname.architecture.to_sym : Uname.machine.to_sym
@@ -8,18 +12,16 @@ module Sys
 
     # Returns the OS type, :macosx, :linux, :mingw32, etc
     IMPL = case Uname.sysname
-      when /darwin|mac/i
-        :macosx
-      when /mingw|windows/i
-        require 'rbconfig'
-        RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase.to_sym
-      when /linux/i
-        :linux
-      when /sunos|solaris/i
-        :solaris
-      when /bsd/i
-        :bsd
-    end
+             when /darwin|mac/i
+               :macosx
+             when /mingw|windows/i
+               require 'rbconfig'
+               RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase.to_sym
+             when /linux/i
+               :linux
+             when /bsd|dragonfly/i
+               :bsd
+           end
 
     # Returns whether or not you're on a Windows OS
     def self.windows?
@@ -28,7 +30,7 @@ module Sys
 
     # Returns whether or not you're on a Unixy (non-Windows) OS
     def self.unix?
-      Uname.sysname !~ /microsoft/i ? true : false
+      Uname.sysname =~ /microsoft/i ? false : true
     end
 
     # Returns whether or not you're on a mac, i.e. OSX
@@ -41,11 +43,6 @@ module Sys
       Uname.sysname =~ /linux/i ? true : false
     end
 
-    # Returns whether or not you're on Solaris
-    def self.solaris?
-      Uname.sysname =~ /sunos|solaris/i ? true : false
-    end
-
     # Returns whether or not you're on any BSD platform
     def self.bsd?
       Uname.sysname =~ /bsd/i ? true : false

data/lib/sys/uname.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Sys
   class Uname
     # The version of the sys-uname gem.
-    VERSION = '1.2.2'.freeze
+    VERSION = '1.3.0'
   end
 
   class Platform

data/lib/sys/unix/uname.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ffi'
 require 'rbconfig'
 require 'ostruct'
@@ -18,10 +20,8 @@ module Sys
     case RbConfig::CONFIG['host_os']
       when /linux/i
         BUFSIZE = 65
-      when /bsd/i
-        BUFSIZE = 32 # TODO: version method chopped
-      when /sunos|solaris/i
-        BUFSIZE = 257
+      when /bsd|dragonfly/i
+        BUFSIZE = 32
       else
         BUFSIZE = 256
     end
@@ -30,7 +30,7 @@ module Sys
     private_class_method :uname_c
 
     begin
-      attach_function :sysctl, [:pointer, :uint, :pointer, :pointer, :pointer, :size_t], :int
+      attach_function :sysctl, %i[pointer uint pointer pointer pointer size_t], :int
       private_class_method :sysctl
 
       CTL_HW   = 6   # Generic hardware/cpu
@@ -40,7 +40,7 @@ module Sys
     end
 
     begin
-      attach_function :sysinfo, [:int, :pointer, :long], :long
+      attach_function :sysinfo, %i[int pointer long], :long
       private_class_method :sysinfo
 
       SI_SYSNAME      = 1   # OS name
@@ -59,6 +59,7 @@ module Sys
       # Ignore. Not suppored.
     end
 
+    # FFI class passed to the underlying C uname function.
     class UnameFFIStruct < FFI::Struct
       members = [
         :sysname,  [:char, BUFSIZE],
@@ -68,13 +69,8 @@ module Sys
         :machine,  [:char, BUFSIZE]
       ]
 
-      if RbConfig::CONFIG['host_os'] =~ /linux/i
-        members.push(:domainname, [:char, BUFSIZE])
-      end
-
-      if RbConfig::CONFIG['host_os'] =~ /hpux/i
-        members.push(:__id_number, [:char, BUFSIZE])
-      end
+      members.push(:domainname, [:char, BUFSIZE]) if RbConfig::CONFIG['host_os'] =~ /linux/i
+      members.push(:__id_number, [:char, BUFSIZE]) if RbConfig::CONFIG['host_os'] =~ /hpux/i
 
       layout(*members)
     end
@@ -87,40 +83,20 @@ module Sys
       machine
     ]
 
-    if RbConfig::CONFIG['host_os'] =~ /linux/i
-      fields.push('domainname')
-    end
-
-    if RbConfig::CONFIG['host_os'] =~ /hpux/i
-      fields.push('id_number')
-    end
-
-    if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
-      fields.push(
-        'architecture',
-        'dhcp_cache',
-        'hw_provider',
-        'hw_serial',
-        'isa_list',
-        'platform',
-        'srpc_domain'
-      )
-    end
+    fields.push('domainname') if RbConfig::CONFIG['host_os'] =~ /linux/i
+    fields.push('id_number') if RbConfig::CONFIG['host_os'] =~ /hpux/i
+    fields.push('model') if RbConfig::CONFIG['host_os'] =~ /darwin|bsd|dragonfly/i
 
-    if RbConfig::CONFIG['host_os'] =~ /darwin|bsd/i
-      fields.push('model')
-    end
+    private_constant :UnameFFIStruct
 
     # :startdoc:
 
-    UnameStruct = Struct.new("UnameStruct", *fields)
+    UnameStruct = Struct.new('UnameStruct', *fields)
 
     # Returns a struct that contains the sysname, nodename, machine, version
     # and release of your system.
     #
-    # On OS X it will also include the model.
-    #
-    # On Solaris, it will also include the architecture and platform.
+    # On OS X and BSD platforms it will also include the model.
     #
     # On HP-UX, it will also include the id_number.
     #
@@ -133,9 +109,7 @@ module Sys
     def self.uname
       utsname = UnameFFIStruct.new
 
-      if uname_c(utsname) < 0
-        raise Error, "uname() function call failed"
-      end
+      raise Error, 'uname() function call failed' if uname_c(utsname) < 0
 
       struct = UnameStruct.new
       struct[:sysname]  = utsname[:sysname].to_s
@@ -144,42 +118,17 @@ module Sys
       struct[:version]  = utsname[:version].to_s
       struct[:machine]  = utsname[:machine].to_s
 
-      if RbConfig::CONFIG['host_os'] =~ /darwin|bsd/i
-        struct[:model] = get_model()
-      end
-
-      if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
-        struct[:architecture] = get_si(SI_ARCHITECTURE)
-        struct[:platform]     = get_si(SI_PLATFORM)
-        struct[:hw_serial]    = get_si(SI_HW_SERIAL)
-        struct[:hw_provider]  = get_si(SI_HW_PROVIDER)
-        struct[:srpc_domain]  = get_si(SI_SRPC_DOMAIN)
-        struct[:isa_list]     = get_si(SI_ISALIST)
-        struct[:dhcp_cache]   = get_si(SI_DHCP_CACHE)
-
-        # FFI and Solaris don't get along so well, so we try again
-        struct[:sysname]  = get_si(SI_SYSNAME) if struct.sysname.empty?
-        struct[:nodename] = get_si(SI_HOSTNAME) if struct.nodename.empty?
-        struct[:release]  = get_si(SI_RELEASE) if struct.release.empty?
-        struct[:version]  = get_si(SI_VERSION) if struct.version.empty?
-        struct[:machine]  = get_si(SI_MACHINE) if struct.machine.empty?
-      end
-
-      if RbConfig::CONFIG['host_os'] =~ /hpux/i
-        struct[:id_number] = utsname[:__id_number].to_s
-      end
-
-      if RbConfig::CONFIG['host_os'] =~ /linux/i
-        struct[:domainname] = utsname[:domainname].to_s
-      end
+      struct[:model] = get_model() if RbConfig::CONFIG['host_os'] =~ /darwin|bsd|dragonfly/i
+      struct[:id_number] = utsname[:__id_number].to_s if RbConfig::CONFIG['host_os'] =~ /hpux/i
+      struct[:domainname] = utsname[:domainname].to_s if RbConfig::CONFIG['host_os'] =~ /linux/i
 
       # Let's add a members method that works for testing and compatibility
       if struct.members.nil?
-        struct.instance_eval(%Q{
+        struct.instance_eval <<-RUBY, __FILE__, __LINE__ + 1
           def members
-            @table.keys.map{ |k| k.to_s }
+            @table.keys.map(&:to_s)
           end
-        })
+        RUBY
       end
 
       struct.freeze
@@ -189,7 +138,7 @@ module Sys
     #
     # Example:
     #
-    #  Uname.sysname # => 'SunOS'
+    #  Uname.sysname # => 'Darwin'
     #
     def self.sysname
       uname.sysname
@@ -313,15 +262,5 @@ module Sys
     end
 
     private_class_method :get_model
-
-    # Returns the various sysinfo information based on +flag+.
-    #
-    def self.get_si(flag)
-      buf = 0.chr * BUFSIZE
-      sysinfo(flag, buf, BUFSIZE)
-      buf.strip
-    end
-
-    private_class_method :get_si
   end
 end