sys-proctable 1.2.0 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 00ee6aa318ca856d8b83e26685289b1c3eae3817
-  data.tar.gz: 4af42eeef3367f56b8c6ec9383393ba16900af3e
+SHA256:
+  metadata.gz: 01c653a363b9c37b67d34370e882e24aefc772c95677ee7420b9601f279c2e9b
+  data.tar.gz: c3dbf4252b810a0abd69bdc3d401a653ae8b8e24d31d8be15fea7d5ddd37f7a3
 SHA512:
-  metadata.gz: 7ce22a2caf51c2909024450fad56c15f3ca4d895524b70b6cc7584da8786055fb8a1b2c9b7fe80aadb88d18065d1470368c51d1b0dbb7ccbf34318ab2144d487
-  data.tar.gz: d81c7f01727cf1521374410b9c473c82b6d5b04d92315d5e4427346c91eead836f43f70b46979e1df6f3eaa858a1677e95e2141bfae737cb75691aee507b77b3
+  metadata.gz: 9f97e3368e08424eb1ac80dd50865f0803066de539fd93defebfb8dbd8591d44447a24a5621555b2b6e29f5f72ae33f03be2b973d3106ad87ecd1bcef67fb8eb
+  data.tar.gz: a17fd29c3cfc2aed02ab884467aa24f403258aa8bc9f4f9fa084892685d6898992808625e3dacc18d1616232f11ad8c2b7ac8ce21b80fdd3bd8faadb4e733791

data.tar.gz.sig

@@ -1 +1,2 @@
-�t����+�xe`��~kĂ��x�U�y��@�&��o�}��_�����z-FX�w��^���c#-vNP���k-9��cSQ��l"�)�{L���n�׌���!�R�9���r�����{�3��J��7�Y�ˆ8ٲ�<�5�e�tq  O�rۏ�y�A3j/��\�x����X`�m"�f�GZ���×�'w�ސ��|��{D�nw8R2���S�0S�7��Spؼ�p)��ɴn�/��hь�ݨ�����6�}�p_a�ͫ�s��кO��� �8���/��A��!����ι2��}�ޑA��=#X�=�A����v�Y�%?����2�ƥ�Z	H�,���*m'�sv4��Ģ��\�{(�(J�qC��ĥ��
+\�Yf�fw`X�9zSǟ������B��2�+���oJ��h�߳��l�_x��"�0SP��V��?\Z5��̽C^�w{���\&\r�q�l�=�K�)�<�8f�6�8s�?IB
+TVȆ.Z��6����H�?*8�䮕@�~0Ȉ�����'|��V̂fw��1�

data/{CHANGES → CHANGES.rdoc}

@@ -1,6 +1,43 @@
+== 1.2.5 - 19-Jun-2020
+* Added the delayacct_blkio_ticks, guest_time, and cguest_time fields on Linux.
+  These require 2.6.18 or later, but will simply be nil on earlier versions.
+* Added the rsslim synonym for the rlim field for Linux.
+
+== 1.2.4 - 18-Jun-2020
+* Added the num_threads field for Linux. This was originally a dead field in
+  older versions of Linux that was skipped, but as of Linux 2.6+ it actually
+  holds meaningful data.
+* Updated the specs for Linux.
+
+== 1.2.3 - 17-Mar-2020
+* Properly include a copy of Apache-2.0 in LICENSE file as part of library.
+* Add explicit .rdoc extensions to CHANGES and MANIFEST files.
+
+== 1.2.2 - 12-Aug-2019
+* Added compatibility for JRuby on Mac which apparently doesn't define a
+  read_uint64 method, nor a CharArray. Thanks go to Adithya Pentela for
+  the spot.
+* Refactored the specs a bit, adding a spec_helper.rb. This was mainly
+  for JRuby compatibility.
+* Updates to the travis.yml file for both Ruby and JRuby versions.
+* Removed the doc directory and all the files it contained. It was
+  redundant, and some of the information was wrong. All of the
+  documentation you need is on the wiki.
+* Cleaned up the MANIFEST file, updated the gemspec, and fixed the
+  license name, which was missing a hyphen.
+
+== 1.2.1 - 8-Jun-2018
+* The code for OSX is now more efficient when a pid argument is provided.
+  Thanks go to Nick LaMuro for his efforts.
+* Added metadata to the gemspec.
+* Switched the README (now README.md) to markdown format. Thanks go to
+  Tim Meusel for the update.
+* Updated the cert. Should be good for ten years now.
+
 == 1.2.0 - 20-Feb-2018
 * There has been an API change. The ProcTable.ps method now uses keyword
   arguments. The 'pid' option is universal, the rest depend on the platform.
+  As part of this change, support for Ruby < 2.0 has been dropped.
 * Support for HP-UX has been dropped, both because it was the last remaining
   platform that still used C code, and because it's basically a dead platform.
 * There are no more platform-specific gems. There is now a single gem that

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,18 +1,12 @@
 * CHANGES
+* LICENSE
 * MANIFEST
 * Rakefile
 * README
 * sys-proctable.gemspec
-* doc/aix.txt
-* doc/bsd.txt
-* doc/hpux.txt
-* doc/linux.txt
-* doc/solaris.txt
-* doc/top.txt
-* doc/windows.txt
+* benchmarks/bench_ps.rb
+* benchmarks/bench_ips_ps.rb
 * example/example_ps.rb
-* ext/hpux/extconf.rb
-* ext/hpux/sys/proctable.c
 * lib/sys-proctable.rb
 * lib/sys/top.rb
 * lib/sys/proctable/version.rb
@@ -26,7 +20,6 @@
 * test/test_sys_proctable_all.rb
 * test/test_sys_proctable_darwin.rb
 * test/test_sys_proctable_freebsd.rb
-* test/test_sys_proctable_hpux.rb
 * test/test_sys_proctable_linux.rb
 * test/test_sys_proctable_sunos.rb
 * test/test_sys_proctable_windows.rb

data/README.md

@@ -0,0 +1,158 @@
+# sys-proctable
+
+## Description
+
+  A Ruby interface for gathering process information.
+
+## Prerequisites
+
+* RSpec 3.x (development only)
+
+## Supported Platforms
+
+* Windows 2000 or later
+* Linux 2.6+
+* FreeBSD
+* Solaris 8+
+* OS X 10.7+
+* AIX 5.3+
+
+## Installation
+
+```sh
+gem install sys-proctable
+```
+
+For version 1.1.5 or earlier, you may need to specify a platform in some cases. For example:
+
+```sh
+gem install sys-proctable --platform mswin32 # Windows
+gem install sys-proctable --platform sunos   # Solaris
+gem install sys-proctable --platform linux   # Linux
+gem install sys-proctable --platform freebsd # FreeBSD
+gem install sys-proctable --platform darwin  # OS X
+```
+
+## Synopsis
+
+```ruby
+require 'sys/proctable'
+include Sys
+
+# Everything
+ProcTable.ps{ |p|
+  puts p.pid.to_s
+  puts p.comm
+  # ...
+}
+
+# Just one process
+s = ProcTable.ps(pid: 2123)
+puts s.pid.to_s
+puts s.comm
+# ...
+
+# Return the results as an array of ProcTableStructs
+a = ProcTable.ps
+a.each do |p|
+  puts p.pid
+  # ...
+end
+```
+
+## Notes
+
+Various platforms support different options. Mostly this is to let you
+skip the collection of certain bits of information in order to improve
+speed and/or reduce memory. For example on Linux you can do this to
+skip the collection of smaps information:
+
+```ruby
+Sys::ProcTable.ps(smaps: false)
+```
+
+Windows users may send a host name to get process information from a
+different host. This relies on the WMI service running.
+
+```ruby
+Sys::ProcTable.ps(host: some_host)
+```
+
+## Known Issues
+
+### FreeBSD
+
+A kvm interface is used. That means the owner of the process using the
+sys-proctable library needs to be a member of the kvm group (or root).
+
+### Bundler
+
+For version 1.1.5 or earlier, Bundler seems to have trouble installing the
+proper gem because of the platform specific gem names. To deal with that,
+run this command first:
+
+```sh
+bundle config specific_platform true
+```
+
+You should not have to do this for version 1.2.0 or later.
+
+### Solaris
+
+The cmdline member on Solaris is limited to 80 characters unless you (or
+your program) own the process. This is a Solaris design flaw/feature.
+
+### OS X
+
+The libproc interface is used. That means you will only get list of
+processes that you have access to. To get a full listing, run as root.
+
+## Future Plans
+
+Support for Solaris will probably be dropped in the next major release.
+
+## Acknowledgements
+
+This library was originally based on the Perl module Proc::ProcessTable
+by Dan Urist. Many ideas, as well as large chunks of code, were taken
+from his work. So, a big THANK YOU goes out to Dan Urist.
+
+A big thanks also goes out to Mike Hall who was very helpful with ideas,
+logic and testing.
+
+Thanks also go to Sean Chittenden for providing an account on one of his
+FreeBSD machines. This is how the FreeBSD support was (initially) added.
+
+Thanks go to James Hranicky for providing a patch that grabs name, eid,
+euid, gid and guid info in the Linux version, along with some general
+debugging help.
+
+Thanks go to David Felstead for the original OS X code. Thanks also go
+to Matthias Zirnstein for adding the original cmdline support for OS X.
+
+Finally I'd like to thank all the folks who have submitted bug reports
+and/or patches.
+
+## Help Wanted
+
+I do not have access to all platforms. If your platform is not supported
+then you will need to either submit a patch or give me a remote account
+on a box with a compiler so that I can write the code.
+
+## More documentation
+
+See the documentation under the 'doc' directory for more information,
+including platform specific notes and issues.
+
+## License
+
+Apache 2.0
+
+## Copyright
+
+(C) 2003-2019 Daniel J. Berger
+All Rights Reserved.
+
+## Author
+
+Daniel J. Berger

data/Rakefile

@@ -51,7 +51,7 @@ end
 
 desc 'Run the test suite for the sys-proctable library'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = ['spec/sys_proctable_all_spec.rb']
+  t.pattern = ['spec/spec_helper.rb', 'spec/sys_proctable_all_spec.rb']
 
   case CONFIG['host_os']
     when /aix/i

data/benchmarks/bench_ips_ps.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require 'optparse'
+require 'rbconfig'
+require 'benchmark/ips'
+
+@source, @gem = false
+
+OptionParser.new do |opt|
+  opt.banner = "Usage: #{File.basename $0} [--gem|--source]"
+
+  opt.separator ""
+  opt.separator "Benchmark IPS (iterations per second) changes between"
+  opt.separator "source version of sys-proctable and previous gem"
+  opt.separator "version."
+  opt.separator ""
+  opt.separator "Requires that the both the source version of the gem"
+  opt.separator "be installed (run `rake install` to do this after"
+  opt.separator "each of your changes) and version installed via"
+  opt.separator "rubygems."
+  opt.separator ""
+  opt.separator "To run, call with `--gem` two times, and then with "
+  opt.separator "`--source` two times again."
+  opt.separator ""
+
+  opt.on("--source") { @source = true }
+  opt.on("--gem")    { @gem = true }
+end.parse!
+
+if @source && !@gem
+  # Being paranoid here and making sure we get the version installed to
+  # sitelibdir
+  require File.join(RbConfig::CONFIG["sitelibdir"], "sys", "proctable")
+else
+  @gem = true
+  require 'sys-proctable'
+end
+
+Benchmark.ips do |bench|
+  bench.report("Block form - pre patch") do
+    (puts "ERR:  Please run with --gem"; exit 1) unless @gem
+    Sys::ProcTable.ps {}
+  end
+
+  bench.report("Non-block form - pre patch") do
+    (puts "ERR:  Please run with --gem"; exit 1) unless @gem
+    Sys::ProcTable.ps
+  end
+
+  bench.report("Block form - post patch") do
+    (puts "ERR:  Please run with --source"; exit 1) unless @source
+    Sys::ProcTable.ps {}
+  end
+
+  bench.report("Non-block form - post patch") do
+    (puts "ERR:  Please run with --source"; exit 1) unless @source
+    Sys::ProcTable.ps
+  end
+
+  bench.hold! "bench_ips_ps.results"
+  bench.compare!
+end