sys-proctable 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb96b1cfb746706244c26f2ce85f54740163cb9f9174237fd06767849ca62cb8
-  data.tar.gz: f8b0b6d47efb86e64a630331a3408deb5baf2a6c8b1256bf55a0bad76f9c17c7
+  metadata.gz: 47da35e089de6a039ea5ae43c965d1ec207644aaf33dc4294f19a02927f42c0b
+  data.tar.gz: 68a6ba2f88db4b7e20f4762f3728e3841c30bf5ee857c2885fe698ea6a6c8d32
 SHA512:
-  metadata.gz: 72bf0ffb98c4362deeb9506c6d2f50147c327fe0862575b06f5de1d342e6c9b3a7d5a0fd9a51d69e15cd2f1f68f8d8a9d67ceba12b8a8350f123498b759c4ac0
-  data.tar.gz: 9acdc748cffeee40be36cff671b9f8057ec7fd9f416609f326882c28dfa5b9dd4fddba07a56ed9d64fe9d27b2743c242a3a9b04f902a2f9c3b442ab4ca38a2e1
+  metadata.gz: c5407d746f15c8eabb88c0b7dfea3a426aeb9f46b48af48b58718d955c692a0ef71324049e1e71ada918fe3eafa7955e20f912270e3b7478042d91d6e22a86e8
+  data.tar.gz: ddf616512c79a4a3980972f5bd661873ab97da2ee7d9be21f1193097f0dd0710d581bd2dfbb8c5c4ff6ff98a4fbfb5ad032aa4d1df92a17c6791de1de1fc7247

data/CHANGES

@@ -1,3 +1,16 @@
+== 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.

data/MANIFEST

@@ -3,16 +3,9 @@
 * 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 +19,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

@@ -150,7 +150,7 @@ Apache 2.0
 
 ## Copyright
 
-(C) 2003-2018 Daniel J. Berger
+(C) 2003-2019 Daniel J. Berger
 All Rights Reserved.
 
 ## Author

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

data/lib/darwin/sys/proctable.rb

@@ -26,6 +26,11 @@ module Sys
     MAXTHREADNAMESIZE = 64
     PROC_PIDPATHINFO_MAXSIZE = MAXPATHLEN * 4
 
+    # JRuby on Mac
+    unless defined? FFI::StructLayout::CharArray
+      FFI::StructLayout::CharArray = FFI::StructLayout::CharArrayProxy
+    end
+
     class ProcBsdInfo < FFI::Struct
       layout(
         :pbi_flags, :uint32_t,
@@ -285,7 +290,13 @@ module Sys
 
       0.upto(max-1) do |index|
         tinfo = ProcThreadInfo.new
-        nb = proc_pidinfo(pid, PROC_PIDTHREADINFO, buf[index].read_uint64, tinfo, tinfo.size)
+
+        # Use read_array_of_uint64 for compatibility with JRuby if necessary.
+        if buf[index].respond_to?(:read_uint64)
+          nb = proc_pidinfo(pid, PROC_PIDTHREADINFO, buf[index].read_uint64, tinfo, tinfo.size)
+        else
+          nb = proc_pidinfo(pid, PROC_PIDTHREADINFO, buf[index].read_array_of_uint64(1).first, tinfo, tinfo.size)
+        end
 
         if nb <= 0
           if [Errno::EPERM::Errno, Errno::ESRCH::Errno].include?(FFI.errno)

data/lib/sys/proctable/version.rb

@@ -1,6 +1,6 @@
 module Sys
   class ProcTable
     # The version of the sys-proctable library
-    VERSION = '1.2.1'.freeze
+    VERSION = '1.2.2'.freeze
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+RSpec.configure do |config|
+  config.filter_run_excluding :skip_jruby if RUBY_PLATFORM == 'java'
+end
+
+if RUBY_PLATFORM == 'java'
+  require 'ffi'
+  module Exec
+    extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+    attach_function :fork, [], :int
+  end
+
+  def fork
+    pid = Exec.fork
+    if pid == 0
+      yield if block_given?
+      return nil
+    else
+      return pid
+    end
+  end
+end

data/spec/sys_proctable_all_spec.rb

@@ -16,7 +16,7 @@ describe Sys::ProcTable do
   end
 
   it "has a VERSION constant set to the expected value" do
-    expect(Sys::ProcTable::VERSION).to eql('1.2.1')
+    expect(Sys::ProcTable::VERSION).to eql('1.2.2')
   end
 
   it "defines a custom error class" do

data/spec/sys_proctable_darwin_spec.rb

@@ -87,30 +87,30 @@ describe Sys::ProcTable do
       expect(subject.svgid).to eql(Process.gid)
     end
 
-    it "contains a comm member and returns the expected value" do
+    it "contains a comm member and returns the expected value", :skip_jruby do
       expect(subject).to respond_to(:comm)
       expect(subject.comm).to be_kind_of(String)
       expect(subject.comm).to eql('sleep')
     end
 
-    it "contains a cmdline member and returns the expected value" do
+    it "contains a cmdline member and returns the expected value", :skip_jruby do
       expect(subject).to respond_to(:cmdline)
       expect(subject.cmdline).to be_kind_of(String)
       expect(subject.cmdline).to eql('sleep 60')
     end
 
-    it "returns a string with the expected arguments for the cmdline member" do
+    it "returns a string with the expected arguments for the cmdline member", :skip_jruby do
       ptable = Sys::ProcTable.ps(pid: @pid2)
       expect(ptable.cmdline).to eql('ruby -Ilib -e sleep \'120\'.to_i -- foo bar')
     end
 
-    it "contains an exe member and returns the expected value" do
+    it "contains an exe member and returns the expected value", :skip_jruby do
       expect(subject).to respond_to(:exe)
       expect(subject.exe).to be_kind_of(String)
       expect(subject.exe).to eql(`which sleep`.chomp)
     end
 
-    it "contains an environ member and returns the expected value" do
+    it "contains an environ member and returns the expected value", :skip_jruby do
       expect(subject).to respond_to(:environ)
       expect(subject.environ).to be_kind_of(Hash)
       expect(subject.environ['A']).to eql('B')

data/sys-proctable.gemspec

@@ -2,9 +2,9 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-proctable'
-  spec.version    = '1.2.1'
+  spec.version    = '1.2.2'
   spec.author     = 'Daniel J. Berger'
-  spec.license    = 'Apache 2.0'
+  spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'http://github.com/djberg96/sys-proctable'
   spec.summary    = 'An interface for providing process table information'
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
     'sys-proctable.gemspec'
   ]
 
-  spec.extra_rdoc_files  = ['CHANGES', 'README.md', 'MANIFEST', 'doc/top.txt']
+  spec.extra_rdoc_files = ['CHANGES', 'README.md', 'MANIFEST']
 
   spec.add_dependency('ffi')
   spec.add_development_dependency('rspec')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-proctable
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2018-06-08 00:00:00.000000000 Z
+date: 2019-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -92,8 +92,8 @@ extra_rdoc_files:
 - CHANGES
 - README.md
 - MANIFEST
-- doc/top.txt
 files:
+- benchmarks/bench_ips_ps.rb
 - benchmarks/bench_ps.rb
 - examples/example_ps.rb
 - lib/aix/sys/proctable.rb
@@ -116,7 +116,7 @@ files:
 - sys-proctable.gemspec
 homepage: http://github.com/djberg96/sys-proctable
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata:
   homepage_uri: https://github.com/djberg96/sys-proctable
   bug_tracker_uri: https://github.com/djberg96/sys-proctable/issues
@@ -140,11 +140,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: An interface for providing process table information
 test_files:
+- spec/spec_helper.rb
 - spec/sys_proctable_aix_spec.rb
 - spec/sys_proctable_all_spec.rb
 - spec/sys_proctable_darwin_spec.rb

data/doc/top.txt

@@ -1,47 +0,0 @@
-= Description
-   A simple 'top' interface for Ruby
-
-= Prerequisites
-   Requires the "sys/proctable" package (which should be installed along
-   with this package).
-
-= Synopsis
-   require "sys/top"
-
-   Sys::Top.top(5).each{ |ps|
-      p ps
-   }
-	
-= Constants
-VERSION
-   Returns the version number of this package as a String.
-	
-= Class Methods
-Sys::Top.top(number=10, field="pctcpu")
-   Returns an array of ProcTableStruct's.  The size of the array (i.e. the
-   number of processes) that it returns is based on +number+, and sorted by
-   +pctcpu+.  By default, the size and field values are 10 and "pctcpu",
-   respectively.
-
-= Notes
-   Not all fields are available on all platforms.  Please check your
-   platform specific documentation for which fields are available.
-	
-= Bugs
-   None that I'm aware of.  Please log bug reports on the project page at
-   http://www.rubyforge.org/projects/sysutils
-	
-= License
-   Artistic 2.0
-	
-= Copyright
-   (C) 2004-2009 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