sys-uname 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e90d844e2dcaa233bb0464270e1c9ec992fa09e595d2d51967cea35725a9773
-  data.tar.gz: 9b2ed6851cacc61e08bf114dbd85b151ac84ae503d70a65e64ecaf913bb88418
+  metadata.gz: da53561b44caf45c227aad7130b9b120e9bbdd3cd35b665ecf527b8a7ad51996
+  data.tar.gz: ce041695020d00b6eeacb5861fc39268a84a6bc4f586f3c2576f2b4e599816d7
 SHA512:
-  metadata.gz: 2c68f40198f8dc919dd61e95fc5fea4eea5ab7992370500647c0b1a3464b0982153d60b987c92cd6d9e613d799158c2ec690fd8c3160770190b8ebf2b3ff47ce
-  data.tar.gz: b10dd58d9cc5b2544e061de1e4f95a8878c21a64d6558f4578ddaef67ed9546de7628ec314cd0017cd742f3345e10005e7f520bc10cc2b18be1b6f109edd5b99
+  metadata.gz: dd826360df12898bb135c2a442c475cbf209c1dae207b290214af3ae8130eaaed41800c2744942908ac11469c4ec9c7d2bebbd25bf112041148c629b502431d3
+  data.tar.gz: bd9cdeff9d5459e7c66e86b280c6f19f046812bfdb3abb05b8c874cfd535df3895f8ad3198026df3ac2f845690bc85dd0b9ab939212b6563c95071215e011453

data/{CHANGES.rdoc → CHANGES.md}

@@ -1,34 +1,47 @@
-== 1.2.1 - 17-Mar-2020
+## 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.
+* Added rake as a development dependency (which it really always was).
+* Switched from rdoc to markdown because github wouldn't render it properly.
+
+## 1.2.1 - 17-Mar-2020
 * Properly include a LICENSE file as per the Apache-2.0 license.
 
-== 1.2.0 - 5-Jan-2020
+## 1.2.0 - 5-Jan-2020
 * Changed test suite from test-unit to rspec, which was also added as a
   development dependency.
 * Several new fields were added to the returned object on Windows. The fields
   are encryption_level, product_type, suite_mask and system_drive.
 
-== 1.1.1 - 10-Dec-2019
+## 1.1.1 - 10-Dec-2019
 * Renamed various text files to include explicit .rdoc extension so that
   they show up more nicely on github.
 
-== 1.1.0 - 29-Aug-2019
+## 1.1.0 - 29-Aug-2019
 * Changed license to Apache-2.0.
 * Updated the doc/uname.txt file.
 * Minor test updates.
 
-== 1.0.4 - 4-Nov-2018
+## 1.0.4 - 4-Nov-2018
 * Added metadata to the gemspec.
 * Updated the cert, which will expire in about 10 years.
 
-== 1.0.3 - 31-Oct-2016
+## 1.0.3 - 31-Oct-2016
 * Updated the gem cert. It will expire on 31-Oct-2019.
 * Minor updates to the Rakefile and gemspec.
 
-== 1.0.2 - 3-Sep-2015
+## 1.0.2 - 3-Sep-2015
 * The gem is now signed.
 * Modified gemspec and Rakefile to support signing.
 
-== 1.0.1 - 19-Aug-2015
+## 1.0.1 - 19-Aug-2015
 * Modified Platform::IMPL so that it does not include "32" as part of the
   symbol name. This isn't useful since it's the same on 32 or 64-bit Windows.
 * Reorganized code a bit so that the VERSION constant is in a single place.
@@ -36,7 +49,7 @@
   as Uname::VERSION.
 * Added a test for Sys::Platform::IMPL on Windows.
 
-== 1.0.0 - 19-Aug-2015
+## 1.0.0 - 19-Aug-2015
 * Added a sys-uname.rb shim so that you can require this library with
   "sys-uname" or "sys/uname".
 * Added the architecture method for MS Windows.
@@ -46,32 +59,32 @@
 * There is now just a single gem, instead of a separate gem for Windows
   and Unix, so you shouldn't need to worry about platform checking.
 
-== 0.9.2 - 1-May-2013
+## 0.9.2 - 1-May-2013
 * Added a workaround for a win32ole thread bug. Thanks go to Tianlong Wu
   for the spot.
 * Altered platform handling slightly for Windows in the Rakefile.
 
-== 0.9.1 - 3-Jan-2013
+## 0.9.1 - 3-Jan-2013
 * Made FFI functions private.
 * Properly alias uname FFI function.
 * Fixed the QuantumLength and QuantumType bug again (see 0.8.4), which I
   somehow accidentally reintroduced.
 
-== 0.9.0 - 8-Dec-2011
+## 0.9.0 - 8-Dec-2011
 * Conversion to FFI.
 * Added some additional methods and information for Solaris.
 * Minor tweaks for 1.9 to silence warnings.
 
-== 0.8.6 - 2-Sep-2011
+## 0.8.6 - 2-Sep-2011
 * Fixed a failing test for Ruby 1.9.x.
 * The gemspec for Windows is now 'universal'.
 * Some minor doc updates.
 
-== 0.8.5 - 11-Dec-2010
+## 0.8.5 - 11-Dec-2010
 * Removed some non-ascii characters that somehow made it into the source.
 * Some updates to the Rakefile, including a default task.
 
-== 0.8.4 - 29-Jan-2010
+## 0.8.4 - 29-Jan-2010
 * Bug fix for Windows 7, which appears to have removed the QuantumLength and
   QuantumType members of the Win32_OperatingSystem class. Thanks go to Mark
   Seymour for the spot. RubyForge bug # 27645.
@@ -80,23 +93,23 @@
   now all inlined within the Rakefile build task itself.
 * Minor doc updates and some code reformatting.
 
-== 0.8.3 - 26-Apr-2008
+## 0.8.3 - 26-Apr-2008
 * Added an explicit "require 'time'" in the Windows version because recent
   versions of Ruby now need it.
 * Changed the way I do platform checks in the Rakefile.
 
-== 0.8.2 - 22-Nov-2007
+## 0.8.2 - 22-Nov-2007
 * Fixed an issue where Ruby no longer parsed a certain type of date that
   MS Windows uses. See RubyForge Bug #10646 for more information.
 
-== 0.8.1 - 29-Aug-2007
+## 0.8.1 - 29-Aug-2007
 * Made a minor modification to the build script for Linux. It turns out Linux
   has sysctl, but not the necessary mibs for the Uname.model method. Thanks go
   to Mickey Knox (?) for the spot.
 * Removed the install.rb file. The code from that program was integrated
   directly into the Rakefile.
 
-== 0.8.0 - 10-Apr-2007
+## 0.8.0 - 10-Apr-2007
 * The Uname.model method should now work on most BSD platforms, not just OS X,
   since it uses the sysctl() function behind the scenes.
 * The 'id' method was changed to 'id_number' on HP-UX to avoid confusion with
@@ -107,22 +120,22 @@
 * Removed some pre-setup code from the test suite that was no longer necessary
   as a result of the Rake test task.
 
-== 0.7.4 - 19-Nov-2006
+## 0.7.4 - 19-Nov-2006
 * Internal layout changes, doc updates and gemspec improvements.
 * No code changes.
 
-== 0.7.3 - 30-Jul-2006
+## 0.7.3 - 30-Jul-2006
 * Bug fix for 64 bit platforms.
 * Minor modification of the extconf.rb file.
 
-== 0.7.2 - 5-Jul-2006
+## 0.7.2 - 5-Jul-2006
 * Removed '?' from the struct member names on MS Windows since these are no
   longer legal.
 * Removed duplicate definition of Uname.version on MS Windows (oops).
 * Added a gemspec.
 * Added inline rdoc documentation to the source files.
 
-== 0.7.1 - 5-May-2005
+## 0.7.1 - 5-May-2005
 * Removed the uname.rd file.  The uname.txt file is rdoc friendly, so you
   can autogenerate html from that file if you wish.
 * Removed the version.h file - no longer needed now that the Windows version
@@ -131,7 +144,7 @@
 * Minor setup modifications to the test suite.
 * This package is now hosted on RubyForge.
 
-== 0.7.0 - 11-Jan-2004
+## 0.7.0 - 11-Jan-2004
 * Scrapped the C version for Windows in favor of a pure Ruby version that uses
   WMI + OLE.  I highly recommend using Ruby 1.8.2 or later on Win32 systems.
   Earlier versions may cause segfaults.
@@ -143,18 +156,18 @@
 * Removed the INSTALL file.  That information is now included in the README.
 * Documentation updates.
 
-== 0.6.1 - 25-Apr-2004
+## 0.6.1 - 25-Apr-2004
 * Simplified extconf.rb script and installation instructions.
 * Combined three test scripts into a single test script.
 * Warranty information added.
 
-== 0.6.0 - 25-Jun-2003
+## 0.6.0 - 25-Jun-2003
 * Added HP-UX support, including the id() class method (HP-UX only)
 * Fixed minor bug in extconf.rb (forgot 'require ftools' at top)
 * Added HP-UX specific tests and support
 * Made test.rb friendlier for folks without TestUnit installed
 
-== 0.5.0 - 16-Jun-2003
+## 0.5.0 - 16-Jun-2003
 * Added OS X support, including the "model" method.  Thanks to Mike Hall
   for the patch
 * Removed VERSION() class method.  Use the constant instead
@@ -167,17 +180,17 @@
 * Fixed up test suite.  Added OS X specific tests and support.  Should now
   work with TestUnit 0.1.6 or later
     
-== 0.4.1 - 7-Feb-2003
+## 0.4.1 - 7-Feb-2003
 * Fixed C89 issue (again) - thanks go to Daniel Zepeda for the spot
 * Fixed bugs in extconf.rb file (rescue clause, ftools)
 
-== 0.4.0 - 6-Feb-2003
+## 0.4.0 - 6-Feb-2003
 * MS Windows support!
 * Added a test suite and automatic test.rb creation
 * Documentation additions/fixes
 * Internal directory layout and filename changes (Changelog -> CHANGES)
 
-== 0.3.3 - 6-Jan-2003
+## 0.3.3 - 6-Jan-2003
 * Made the code C89 compliant for older compilers.  Thanks to Paul Brannan
   for teaching me how to fix this in general.
 * Moved README to doc/uname.txt
@@ -187,14 +200,14 @@
 * Changed tarball name to reflect RAA package name
 * Minor doc changes
 
-== 0.3.2 - 8-Aug-2002
+## 0.3.2 - 8-Aug-2002
 * Changed the struct name returned by the 'uname()' method from
   "Uname::UnameStruct" to just "UnameStruct".  This was to make it
   compliant with future versions of Ruby.  The extra namespace was
   redundant anyway.
 * I include the documentation now, instead of making you install rd2 :)
 
-== 0.3.1 - 22-Jul-2002
+## 0.3.1 - 22-Jul-2002
 * Added the 'uname' class method, which returns a struct that contains all
   of the uname information
 * Added a test script.  Do 'ruby test.rb' to run it.
@@ -204,7 +217,7 @@
 * Changed version number style to be consistent with other 'Sys' modules
 * Now installs into 'Sys-Uname-x.x.x' directory (instead of just 'Uname')
 
-== 0.03 - 6-June-2002
+## 0.03 - 6-June-2002
 * rd style documentation now inline
 * README.html is now uname.html - created via rdtool
 * The 'platform()' and 'architecture()' methods have been added for Solaris
@@ -212,7 +225,7 @@
 * The whole 'Sys' class has been removed.  Delete your sys.so file if you
   installed a previous version of Sys-Uname
 
-== 0.02 - 3-June-2002
+## 0.02 - 3-June-2002
 * Potentially fatal memory problems corrected.
 * Should now build with C++ as well
 * Thanks to Mike Hall for both the spot and the fix
@@ -220,5 +233,5 @@
 * Added a README.html file
 * Added a Manifest file
 
-== 0.01 - 31-May-2002
+## 0.01 - 31-May-2002
 * Initial release (unannounced)

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/{MANIFEST.rdoc → MANIFEST.md}

@@ -1,10 +1,11 @@
 * CHANGES.rdoc
 * MANIFEST.rdoc
 * README.rdoc
+* Gemfile
 * Rakefile
 * sys-uname.gemspec
 * certs/djberg96_pub.pem
-* doc/uname.txt
+* doc/uname.rdoc
 * examples/uname_test.rb
 * lib/sys/uname.rb
 * spec/sys_uname_spec.rb

data/README.md

@@ -0,0 +1,68 @@
+[![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.
+
+## Prerequisites
+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.
+ 
+# Get full information about your system
+p Sys::Uname.uname
+
+# Check individual platform details about your system
+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
+* dhcp_cache
+
+Note that Solaris is essentially a dead OS at this point, so it will not be
+supported going forward, and will likely be dropped in the next major release.
+
+## BSD flavors, including OS X
+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
+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
+UnameStruct members mean.
+
+## The Platform Class
+This was added both as a nicer way to check simple information about your
+system, and as a replacement for the old 'Platform' gem which is no longer
+maintained.
+
+## Future Plans
+I may dump the "Uname" portion of this library, and rename the project
+to just sys-platform.
+
+## Documentation
+For more details, see the 'uname.rdoc' file under the 'doc' directory. 

data/Rakefile

@@ -1,10 +1,10 @@
 require 'rake'
-require 'rake/testtask'
 require 'rake/clean'
 require 'rbconfig'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-CLEAN.include("**/*.rbc", "**/*.rbx", "**/*.gem")
+CLEAN.include("**/*.rbc", "**/*.rbx", "**/*.gem", "**/*.lock")
 
 desc "Run the example program"
 task :example do
@@ -19,9 +19,9 @@ 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, true)
+    Gem::Package.build(spec)
   end
 
   desc "Install the sys-uname gem"
@@ -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

@@ -112,7 +112,7 @@ Add additional info for Linux, Solaris, BSD.
 Apache-2.0
 
 == Copyright
-(C) 2002-2019 Daniel J. Berger
+(C) 2002-2023 Daniel J. Berger
 All Rights Reserved
 
 == Warranty

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,18 @@ 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 /sunos|solaris/i
+               :solaris
+             when /bsd/i
+               :bsd
+           end
 
     # Returns whether or not you're on a Windows OS
     def self.windows?
@@ -28,7 +32,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

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.1'.freeze
+    VERSION = '1.2.3'
   end
 
   class Platform

data/lib/sys/unix/uname.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ffi'
 require 'rbconfig'
 require 'ostruct'
@@ -30,7 +32,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 +42,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 +61,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 +71,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,13 +85,8 @@ 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
+    fields.push('domainname') if RbConfig::CONFIG['host_os'] =~ /linux/i
+    fields.push('id_number') if RbConfig::CONFIG['host_os'] =~ /hpux/i
 
     if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
       fields.push(
@@ -107,13 +100,13 @@ module Sys
       )
     end
 
-    if RbConfig::CONFIG['host_os'] =~ /darwin|bsd/i
-      fields.push('model')
-    end
+    fields.push('model') if RbConfig::CONFIG['host_os'] =~ /darwin|bsd/i
+
+    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.
@@ -133,9 +126,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,9 +135,7 @@ 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
+      struct[:model] = get_model() if RbConfig::CONFIG['host_os'] =~ /darwin|bsd/i
 
       if RbConfig::CONFIG['host_os'] =~ /sunos|solaris/i
         struct[:architecture] = get_si(SI_ARCHITECTURE)
@@ -165,21 +154,17 @@ module Sys
         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
+      struct[:id_number] = utsname[:__id_number].to_s if RbConfig::CONFIG['host_os'] =~ /hpux/i
 
-      if RbConfig::CONFIG['host_os'] =~ /linux/i
-        struct[:domainname] = utsname[:domainname].to_s
-      end
+      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