sys-cpu 0.8.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cb6cd9291a34891912b829319c1bfe83076fab74de62c4ed66f0282ac1e511c
-  data.tar.gz: 070bfb80aa72fa8d18733d986d2695bb89f82c91d1f1c65bce6dc20a23997039
+  metadata.gz: 3d1988f097f8efd9447e33fd135d373fccc9cbfa699a2c67257361e50367a661
+  data.tar.gz: e2abfb34d4afe062b47cac1bc1a73fb79a609dc55c5070d03bee09f7c841f9d9
 SHA512:
-  metadata.gz: '0095267433095258cc36bc7eef165589c7d8022c24687c926b16f0a8f8a50ff1ad8a4f40ad99ab248b3c9829e16dadb5d9c55675d7b936f108ce42dd34f3f352'
-  data.tar.gz: db3d73bf53eb38c1dba4f24b60b3bc3643d1f0e1bc2ca5d53bff5a70126ac955db0b9298d921871203795fc6c41ec1261e8fd48510235bd7b70101899eeb0b9a
+  metadata.gz: 9fd5d3cabaf78df0ea92dae46081325dcd9569cfd10af7c071cf2532d87b09ec191d15377fe1ce5aa2acf34db49d09ccfee0c6c4bdb7dec914ba4be61e57565d
+  data.tar.gz: c11064f1318983072179f78c2fb3b2eb4ac23b8bbe0b266c0e0ba7174e3f77b4b9ccb27184b4ffdb70c07bcef771ec36ee55b8cb3a8c0a85c2c2ee3374dfd97f

data/{CHANGES → CHANGES.md}

@@ -1,27 +1,50 @@
-== 0.8.1 - 4-Nov-2018
+## 1.0.1 - 20-Dec-2020
+* Switched from rdoc to markdown.
+
+## 1.0.0 - 23-Oct-2020
+* Fixed a bug in the Windows version where the attempt to convert the ConfigManagerErrorCode
+  to a string was busted. Coincidentally, this also exposed a core bug in JRuby (see PR #6443).
+  Thanks go to G. Gibson for reporting the issue.
+* Switched the tests from test-unit to rspec.
+
+## 0.9.0 - 12-May-2020
+* Added explicit freq, architecture, num_cpu and model methods to the Linux
+  version in an effort to create a common interface across platforms.
+* Modified the Linux version so that method_missing will raise a NoMethodError
+  if you try to call access an attribute that doesn't exist.
+* Some updates to the Linux tests.
+
+## 0.8.3 - 18-Mar-2020
+* Properly include a LICENSE file as per the Apache-2.0 license.
+
+## 0.8.2 - 14-Jan-2020
+* Added explicit .rdoc extension to README, CHANGES and MANIFEST files.
+* Fixed license name in README.
+
+## 0.8.1 - 4-Nov-2018
 * Added metadata to the gemspec.
 * Fixed missing hyphen in license name.
 
-== 0.8.0 - 17-Oct-2018
+## 0.8.0 - 17-Oct-2018
 * Switched license to Apache 2.0.
 * Updated documentation for the cpu_stats method on Linux.
 * The VERSION constant is now frozen.
 * Now uses require_relative internally where needed.
 
-== 0.7.2 - 5-Sep-2015
+## 0.7.2 - 5-Sep-2015
 * Replaced a global array with a constant in the Linux version. Thanks go
   to Yorick Peterse for the patch.
 * Added method comments back to the Unix version.
 * Added a sys-cpu.rb stub file for your convenience.
 * This gem is now signed.
 
-== 0.7.1 - 2-May-2013
+## 0.7.1 - 2-May-2013
 * Added a workaround for a win32ole bug in the Windows version.
 * Reorganized code so that there is now a single gem rather than three
   separate platform gems.
 * Updated test-unit dependency which let me simplify the test files a bit.
 
-== 0.7.0 - 14-Dec-2011
+## 0.7.0 - 14-Dec-2011
 * Code base now uses FFI. However, HP-UX is not currently supported.
   HP-UX users should continue to use the 0.6.x version. Note that
   the code base remains unchanged on Linux and Windows.
@@ -30,7 +53,7 @@
 * The type method has been changed to cpu_type on Windows.
 * Some Rakefile and test suite updates.
 
-== 0.6.4 - 27-Sep-2011
+## 0.6.4 - 27-Sep-2011
 * The CPU.freq method now works on OSX.
 * The CPU.model method on OSX has been altered. Previously it
   returned the machine model. However, the information is limited.
@@ -38,7 +61,7 @@
 * The Linux and Windows gems now have a 'universal' architecture.
 * Refactored the clean task in the Rakefile.
 
-== 0.6.3 - 9-Oct-2010
+## 0.6.3 - 9-Oct-2010
 * Fixed a bug in the install.rb file and refactored it a bit. Thanks go
   to Di-an Jan for the spot. Note, however, that this file will eventually
   be removed and/or integrated into the Linux source file.
@@ -46,7 +69,7 @@
 * Fixed and updated the CPU.architecture method on MS Windows to handle IA64
   and x64 architectures.
 
-== 0.6.2 - 1-Jan-2010
+## 0.6.2 - 1-Jan-2010
 * Fixed a bug in the cpu_freq function (which would only be noticed on
   certain platforms in cases where the CPU.freq method failed). Thanks
   go to Edho P Arief for the spot.
@@ -59,13 +82,13 @@
 * Test files renamed.
 * Added test-unit 2.x as a development dependency.
 
-== 0.6.1 - 4-Jan-2009
+## 0.6.1 - 4-Jan-2009
 * Fix for OS X 10.5.x. Thanks go to Victor Costan for the spot and the patch.
 * Updated the gemspec and some other minor changes.
 * On MS Windows the impersonation level is now explicitly set to 'impersonate'
   to avoid issues where systems might be using an older version of WMI.
 
-== 0.6.0 - 26-Apr-2007
+## 0.6.0 - 26-Apr-2007
 * Added support for most BSD flavors, including OS X. The freebsd.c file is
   now just bsd.c.
 * The CPU.type method for Solaris has been changed to CPU.cpu_type to avoid
@@ -77,7 +100,7 @@
 * Improved RDoc comments in the C source files.
 * Changed CPUError to CPU::Error.
 
-== 0.5.5 - 17-Nov-2006
+## 0.5.5 - 17-Nov-2006
 * Fixed a bug in the Linux version where there could be a key but no
    associated value, causing a String#strip! call to fail.  Now the value is
    simply left at nil.
@@ -87,14 +110,14 @@
 * Modified the gemspec so that it sets the platform properly for Linux
   and Windows.
 
-== 0.5.4 - 12-Jul-2006
+## 0.5.4 - 12-Jul-2006
 * Added a gemspec (and a gem on RubyForge).
 * The CPU.architecture method on HP-UX now returns nil if it cannot be
   determined instead of "Unknown" for consistency with the other
   platforms.
 * Inlined the RDoc and made some minor cosmetic source code changes.
 
-== 0.5.3 - 4-May-2006
+## 0.5.3 - 4-May-2006
 * Fixed in a bug in the Solaris version where CPU.load_avg returned bad values
   when compiled in 64 bit mode.  Thanks go to James Hranicky for the spot and
   both James Hranicky and Peter Tribble (via comp.unix.solaris) for patches.
@@ -102,7 +125,7 @@
   which test suite to run.  All platforms now use 'ts_all.rb', which will run
   the appropriate test case behind the scenes.
 
-== 0.5.2 - 24-Jun-2005
+## 0.5.2 - 24-Jun-2005
 * Bug fixed on Linux where empty lines could cause problems.  This affected
   both the install.rb and linux.rb files, though it only seems to have been
   an issue on the 2.6+ kernel.
@@ -111,7 +134,7 @@
   is the only entry.
 * Added a sample program for Linux under the 'examples' directory.
 
-== 0.5.1 - 5-May-2005
+## 0.5.1 - 5-May-2005
 * Fixed a potential bug in the FreeBSD version of CPU.model.
 * Eliminated some warnings in the FreeBSD version.
 * Moved examples directory to the toplevel package directory.
@@ -124,7 +147,7 @@
   doc/linux.txt.
 * Some $LOAD_PATH setup changes in the unit tests.
 
-== 0.5.0 - 26-Jun-2004
+## 0.5.0 - 26-Jun-2004
 * Now requires Ruby 1.8.0 or later.
 * FreeBSD support added.
 * Replaced 'CPUException' with 'CPUError'
@@ -138,7 +161,7 @@
 * The .html files have been removed.  You can generate the html on your own
   if you like.
 
-== 0.4.0 - 18-Sep-2003
+## 0.4.0 - 18-Sep-2003
 * Added MS Windows support
 * Changed some method names.  The "cpu" has been dropped from most method
   names.  See documentation for details.
@@ -150,14 +173,14 @@
 * Minor API change for the load_avg() method on HP-UX.  It now accepts a
   CPU number as an argument.
 
-== 0.3.1 - 16-Jul-2003
+## 0.3.1 - 16-Jul-2003
 * Fixed a bug in the Solaris version that was using up and not
   freeing file descriptors.
 * Added html doc for Solaris under doc directory.
 * Minor changes to test_hpux.rb and test_sunos.rb
 * Minor README changes.
 
-== 0.3.0 - 30-Jun-2003
+## 0.3.0 - 30-Jun-2003
 * Added HP-UX support
 * Removed the VERSION class method.  Use the constant instead
 * Changed license to "Artistic"
@@ -166,7 +189,7 @@
 * Modified extconf.rb, moving some of the dynamic test generation
   into separate files
 
-== 0.2.2 - 25-Mar-2003
+## 0.2.2 - 25-Mar-2003
 * fpu_type and cpu_type now return nil if not found (Solaris)
 * CPUException is now a direct subclass of StandardError
 * Modified extconf.rb script
@@ -174,19 +197,19 @@
 * Added another test to the solaris test suite
 * Important note added to INSTALL file
 
-== 0.2.1 - 12-Mar-2003
+## 0.2.1 - 12-Mar-2003
 * Added the cpu_stats() class method for Linux, which contains the
   data from the 'cpu' lines of /proc/stat
 * Minor fix for extconf.rb (thanks Michael Granger)
 * Some tests added to Linux test suite
 * MANIFEST correction
 
-== 0.2.0 - 13-Feb-2003
+## 0.2.0 - 13-Feb-2003
 * Linux support added (pure Ruby only)
 * Many changes to extconf.rb to support Linux version
 * sys-uname prerequisite dropped
 * rd2 documentation now kept separate from source
 
-== 0.1.0 - 3-Feb-2003
+## 0.1.0 - 3-Feb-2003
 * Initial release
 * Currently supports Solaris (only)

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/{MANIFEST → MANIFEST.md}

@@ -1,8 +1,9 @@
 * install.rb
-* MANIFEST
-* CHANGES
+* LICENSE
+* MANIFEST.md
+* CHANGES.md
 * Rakefile
-* README
+* README.md
 * sys-cpu.gemspec
 * certs/djberg96_pub.pem
 * doc/bsd.txt
@@ -19,9 +20,10 @@
 * lib/sys/linux/sys/cpu.rb
 * lib/sys/unix/sys/cpu.rb
 * lib/sys/windows/sys/cpu.rb
-* test/test_sys_cpu.rb
-* test/test_sys_cpu_bsd.rb
-* test/test_sys_cpu_hpux.rb
-* test/test_sys_cpu_sunos.rb
-* test/test_sys_cpu_linux.rb
-* test/test_sys_cpu_windows.rb
+* spec/spec_helper.rb
+* spec/sys_cpu_spec.rb
+* 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

@@ -0,0 +1,75 @@
+## Description
+A Ruby interface for getting cpu information.
+
+## Installation
+`gem install sys-cpu`
+
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/sys-cpu/ffi/certs/djberg96_pub.pem)`
+
+## Notes
+### Solaris
+Currently there is no +processors+ iterative method for multi-cpu systems.
+I plan to add it this in a future release.
+   
+### OS X
+The CPU.model method returns very limited information. I do not yet know
+how to get more detailed information.
+
+### Linux
+This is pure Ruby. This version reads information out of /proc/cpuinfo and
+/proc/loadavg, so if /proc isn't mounted it won't work.
+
+The key-value information in /proc/cpuinfo is stored internally (i.e. in
+memory) as an array of hashes when you first +require+ this package. This
+overhead is exceptionally minimal, given that your average cpuinfo file
+contains less than 1k of text (and I don't store whitespace or newlines).
+
+The text documentation for Linux is dynamically generated during the
+build process because the fields vary depending on your setup. So, don't
+look at it until *after* you've installed it.  You will see a doc/linux.txt
+file after you run +rake install+ (via install.rb).
+
+### HP-UX
+Unlike other platforms, you can get load averages for an individual cpu in
+multi-cpu systems. See documentation for more details.
+
+Note that version 0.7.x and later will not work on HP-UX because of the
+switch to FFI and the lack of a testing platform. However, version 0.6.x
+will work just fine.
+
+### MS Windows
+This is a pure Ruby implementation using the win32ole package + WMI. The C
+version has been scrapped. 
+
+As of version 0.5.0, the CPU.usage method has been removed in favor of the
+CPU.load_avg method. This does not (currently) use a perf counter, so there
+is no longer any delay. Also, the +processors+ method has been added and the
++supported+ method has been dropped. See the documentation for other changes.
+   
+## Acknowledgements
+Thanks go to the MPlayer team for some source code that helped me on
+certain versions of FreeBSD in the original C version.
+
+## Known Bugs
+None that I'm aware of. Please report bugs on the project page at:
+
+https://github.com/djberg96/sys-cpu
+
+## Future Plans
+* Add iterative CPU.processors method.
+* Add more information in general, such as what +prtdiag+ shows.
+
+## License
+Apache-2.0
+
+## Copyright
+(C) 2003-2020 Daniel J. Berger, All Rights Reserved
+
+## Warranty
+This package is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+
+## Author
+Daniel J. Berger