sys-cpu 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de4fef13495a9b0d229eea6796851de82b4ccadc4a8e45dcea91b42d9f6ec074
-  data.tar.gz: 6da5868da52f3237d14d42a9a8823292711687957da05bda73136e7936f6946d
+  metadata.gz: ff79a5d15ea499890892863713cf8b78d1e827f8d78e9baa3e637cea4aa1e732
+  data.tar.gz: e6d43e161f5f990cf6b5e7a3270ee3037eb052496b8712d1bbe4fc3e06a19f38
 SHA512:
-  metadata.gz: 07ec871287015c0bb7ab832e7c679156e83d26a48eb78d27258799c301c3e33626496eb6519efe487f206bb3e2239845ba1a405b4050847f2b7099f9d9f79eec
-  data.tar.gz: dfaa9832d07510d6bea73c8a775404362fa09c3fe945e88331d0486e7be707db0bd756c128350fac4d9fcbf668b3f0e54fca3f295df2f940d93e974684bf530a
+  metadata.gz: f23ba676b4100b4c8f2c01413965d9ffb67ed19746cf017dab2ece8cc5fb31b460fc04d75180dc4c5da647ee8e48934777d05720023e03e2aeb93213543458fe
+  data.tar.gz: 5c0b800fb4a1097f775378120775987c7b86a05728d68882b08432cd1b443ffc36b717360f6486797c091959c0b9102316f3967ab62fd297db1af679d3b83e08

data.tar.gz.sig

@@ -1,5 +1 @@
-�g�ն³}�2s�6G���X*y�����Ӷ���1�a�fN/f��ѦV��ʐ���f=2����wбk��-.|.L���u��
-��1u�.����&7�*��o.�#������3#}�6��ۊ�T�8�=�f9r�|o�aS��7��'�ԍ��uy�1a��G�]�a�MB��B[=�Z�y#�'�m��|��<�{}�x<&c�9na�T�u��r��,����(���c:�
-{c��S����Q��A�j"q�.B^6�na	�����(�^+2��!^��/j���*���.�
-�>8��c�
-I&�rY����[i�����pOSOS�s1��y����}cQ-��+6�?��5u�@i��%��C6��ZA�&[
++:s�u��vu�HA;&�4�K�ж��xԭ�H��j8����g7u�z�,����C�+Q7&C\r��QW�\��i��FrR�uL=�N� \Hړ^��1���S�G���6���Ô�/AafG����>Ìe�Jg�S^9�=�4��N�a��݈�	��4!�U�xh�22��N

data/{CHANGES → CHANGES.rdoc}

@@ -1,3 +1,27 @@
+== 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
 * Switched license to Apache 2.0.
 * Updated documentation for the cpu_stats method on Linux.

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.rdoc}

@@ -1,8 +1,9 @@
 * install.rb
-* MANIFEST
-* CHANGES
+* LICENSE
+* MANIFEST.rdoc
+* CHANGES.rdoc
 * Rakefile
-* README
+* README.rdoc
 * 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.rdoc

@@ -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

data/Rakefile

@@ -1,10 +1,10 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
 require 'rbconfig'
+require 'rspec/core/rake_task'
 include RbConfig
 
-CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx')
+CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx', '**/*.lock')
 
 namespace 'gem' do
   desc "Create the sys-cpu gem"
@@ -44,9 +44,7 @@ task :example => [:clean] do
 
 end
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/test_sys_cpu.rb']
-end
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

data/lib/sys/cpu.rb

@@ -5,7 +5,7 @@ require 'rbconfig'
 module Sys
   class CPU
     # The version of the sys-cpu gem.
-    VERSION = '0.8.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end
 

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

@@ -70,11 +70,43 @@ module Sys
       array unless block_given?
     end
 
+    # Return the total number of logical CPU on the system.
+    #
+    def self.num_cpu
+      CPU_ARRAY.size
+    end
+
+    # Return the architecture of the CPU.
+    #
+    def self.architecture
+      case CPU_ARRAY.first['cpu_family']
+      when '3'
+        "x86"
+      when '6'
+        "x86_64"
+      else
+        nil
+      end
+    end
+
+    # Returns a string indicating the CPU model.
+    #
+    def self.model
+      CPU_ARRAY.first['model_name']
+    end
+
+    # Returns an integer indicating the speed of the CPU.
+    #
+    def self.freq
+      CPU_ARRAY.first['cpu_mhz'].to_f.round
+    end
+
     private
 
     # Create singleton methods for each of the attributes.
     #
     def self.method_missing(id, arg=0)
+      raise NoMethodError, "'#{id}'" unless CPU_ARRAY[arg].has_key?(id.to_s)
       rv = CPU_ARRAY[arg][id.to_s]
       if rv.nil?
         id = id.to_s + "?"

data/lib/sys/windows/sys/cpu.rb

@@ -278,7 +278,7 @@ module Sys
     # Note that this value returns nil on my system.
     #
     def self.get_cmec(num)
-      case
+      case num
         when 0
           str = "The device is working properly."
           return str

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  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(: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
+end

data/spec/sys_cpu_bsd_spec.rb

@@ -0,0 +1,94 @@
+#############################################################
+# test_sys_cpu_bsd.rb
+#
+# The test case for sys-cpu on BSD flavors, including OS X.
+#############################################################
+require 'sys/cpu'
+require 'spec_helper'
+
+RSpec.describe Sys::CPU, :bsd => true do
+  example "architecture method basic functionality" do
+    expect(Sys::CPU).to respond_to(:architecture)
+    expect{ Sys::CPU.architecture }.not_to raise_error
+  end
+
+  example "architecture method returns a sane value" do
+    expect(Sys::CPU.architecture).to be_kind_of(String)
+    expect(Sys::CPU.architecture.size).to be > 0
+  end
+
+  example "architecture method does not accept any arguments" do
+    expect{ Sys::CPU.architecture(0) }.to raise_error(ArgumentError)
+  end
+
+  example "freq method basic functionality" do
+    expect(Sys::CPU).to respond_to(:freq)
+    expect{ Sys::CPU.freq }.not_to raise_error
+  end
+
+  example "freq method returns expected value" do
+    expect(Sys::CPU.freq).to be_kind_of(Integer)
+    expect(Sys::CPU.freq).to be > 0
+  end
+
+  example "freq method does not accept any arguments" do
+    expect{ Sys::CPU.freq(0) }.to raise_error(ArgumentError)
+  end
+
+  example "load_avg method basic functionality" do
+    expect(Sys::CPU).to respond_to(:load_avg)
+    expect{ Sys::CPU.load_avg }.not_to raise_error
+  end
+
+  example "load_avg returns the expected results" do
+    expect(Sys::CPU.load_avg).to be_kind_of(Array)
+    expect(Sys::CPU.load_avg.length).to eq(3)
+    expect(Sys::CPU.load_avg[0]).to be_kind_of(Float)
+  end
+
+  example "load_avg does not accept any arguments" do
+    expect{ Sys::CPU.load_avg(0) }.to raise_error(ArgumentError)
+  end
+
+  example "machine method basic functionality" do
+    expect(Sys::CPU).to respond_to(:machine)
+    expect{ Sys::CPU.machine }.not_to raise_error
+  end
+
+  example "machine method returns sane value" do
+    expect(Sys::CPU.machine).to be_kind_of(String)
+    expect(Sys::CPU.machine.size).to be > 0
+  end
+
+  example "machine method does not accept any arguments" do
+    expect{ Sys::CPU.machine(0) }.to raise_error(ArgumentError)
+  end
+
+  example "model method basic functionality" do
+    expect(Sys::CPU).to respond_to(:model)
+    expect{ Sys::CPU.model }.not_to raise_error
+  end
+
+  example "model method returns sane value" do
+    expect(Sys::CPU.model).to be_kind_of(String)
+    expect(Sys::CPU.model.length).to be > 0
+  end
+
+  example "model method does not accept any arguments" do
+    expect{ Sys::CPU.model(0) }.to raise_error(ArgumentError)
+  end
+
+  example "num_cpu method basic functionality" do
+    expect(Sys::CPU).to respond_to(:num_cpu)
+    expect{ Sys::CPU.num_cpu }.not_to raise_error
+  end
+
+  example "num_cpu method returns expected value" do
+    expect(Sys::CPU.num_cpu).to be_kind_of(Integer)
+    expect(Sys::CPU.num_cpu).to be > 0
+  end
+
+  example "num_cpu method does not accept any arguments" do
+    expect{ Sys::CPU.num_cpu(0) }.to raise_error(ArgumentError)
+  end
+end