sys-proctable 1.0.0-universal-freebsd → 1.1.0-universal-freebsd

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19484b00fdbeae38729849da7f6fc206ce053bdd
-  data.tar.gz: d9ac63b964d37dabda3d2f38f7f9f073c03c5795
+  metadata.gz: 571d09ed4098395e9a6768e4ade6a50e579e7108
+  data.tar.gz: 33581e29bdc3d3b943e75721470c3a6db751364d
 SHA512:
-  metadata.gz: 0e678e938c946af7794c3ff3d22a52b57324debd47b2819acfc576ae03dc44beee45e266b177961035688863684afe44520d1adf2f62e7d609a4fba89d831807
-  data.tar.gz: ced5e30cf7977f8afd25c76b6e253e399880d98cd0d4162dbd473787816e59d2ad7b2b17421bd9daaa6814650c832d4672e18862595f96b1f5350f3cfe94a577
+  metadata.gz: 977fa5f793be4b8db241e4560aa00c350a1ebe0c694f17b981244e6347e150a42fbbff5c35d43426b410c385eec08d9f7bf2f0da21c34a202aa0c61430cf5bff
+  data.tar.gz: 1ffedea1dfc31a88918447dd9ae1fb2f80f0ccffaea06b09dd9cdd4d4acb56bc37858db00aa3d0f3c63954d632fff650cf9b306bc488a082bbcf959fccac34cf

data/CHANGES

@@ -1,6 +1,16 @@
+== 1.1.0 - 27-Jun-2016
+* License was changed to Apache 2.0.
+* The OS X version now requires OS X 10.7 or later.
+* Scrapped the C implementation for OS X, and replaced it with a libproc wrapper
+  using FFI, so it is now pure Ruby. Note that some new struct members have been
+  added, while others have been dropped. This includes pctcpu, so Sys::Top does
+  not work at the moment.
+* Rakefile updates to accomodate the changes for OS X.
+* Some test suite updates and refactoring.
+
 == 1.0.0 - 11-Jan-2016
 * Added smaps information for Linux. Thanks go to Joe Rafaniello for the patch.
-* This is not really a major release. I just ran out of version numbers.
+* This really should not have been a major release, sorry.
 
 == 0.9.9 - 8-Nov-2015
 * Added support for cgroups on Linux. Thanks go to Dennis Günnewig for the patch.

data/MANIFEST

@@ -11,14 +11,13 @@
 * doc/top.txt
 * doc/windows.txt
 * example/example_ps.rb
-* ext/darwin/extconf.rb
-* ext/darwin/sys/proctable.c
 * ext/hpux/extconf.rb
 * ext/hpux/sys/proctable.c
 * lib/sys-proctable.rb
 * lib/sys/top.rb
 * lib/sys/proctable/version.rb
 * lib/aix/sys/proctable.rb
+* lib/darwin/sys/proctable.rb
 * lib/freebsd/sys/proctable.rb
 * lib/linux/sys/proctable.rb
 * lib/sunos/sys/proctable.rb

data/README

@@ -10,7 +10,7 @@
 * FreeBSD
 * Solaris 8+
 * HP-UX 10+
-* OS X 10.4+
+* OS X 10.7+
 * AIX 5.3+
 
 == Installation
@@ -22,6 +22,7 @@
   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
   require 'sys/proctable'
@@ -60,16 +61,13 @@
   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.
 
-=== Thread Safety
-  I am not currently using a thread-safe version of readdir() for versions
-  of this library that use C. I am not especially concerned about it either.
-  If you are trying to read information out of /proc from different threads
-  at the same time there is something seriously wrong with your code logic.
-  Using readdir_r() still won't solve all potential thread safety issues anyway.
+=== 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
   Add support for NetBSD and OpenBSD.
-  Convert existing C code to FFI.
+  Convert remaining C code (just HP-UX at this point) to FFI.
 
 == Acknowledgements
   This library was originally based on the Perl module Proc::ProcessTable
@@ -87,7 +85,7 @@
   debugging help.
    
   Thanks go to David Felstead for the original OS X code. Thanks also go
-  to Matthias Zirnstein for adding cmdline support for OS X.
+  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.
@@ -102,17 +100,11 @@
   including platform specific notes and issues.
 
 == License
-  Artistic 2.0
+  Apache 2.0
     
 == Copyright
   (C) 2003-2016 Daniel J. Berger
   All Rights Reserved.
 
-== Contributions
-  Although this library is free, please consider having your company
-  setup a gittip if used by your company professionally.
-
-  http://www.gittip.com/djberg96/
-
 == Author
   Daniel J. Berger

data/Rakefile

@@ -27,15 +27,12 @@ task :build => [:clean] do
   end
 
   case CONFIG['host_os']
-    when /darwin/i
-      dir = 'ext/darwin'
-      ext = '.bundle'
     when /hpux/i
       dir = 'ext/hpux'
       ext = '.sl'
   end
 
-  if CONFIG['host_os'] =~ /darwin|hpux/i
+  if CONFIG['host_os'] =~ /hpux/i
     Dir.chdir(dir) do
       ruby 'extconf.rb'
       sh 'make'
@@ -63,7 +60,7 @@ task :install => [:build] do
     when /freebsd/i
       file = 'lib/freebsd/sys/proctable.rb'
     when /darwin/i
-      Dir.chdir('ext/darwin'){ sh 'make install' }
+      file = 'lib/darwin/sys/proctable.rb'
     when /hpux/i
       Dir.chdir('ext/hpux'){ sh 'make install' }
   end
@@ -74,7 +71,7 @@ end
 desc 'Uninstall the sys-proctable library'
 task :uninstall do
   case CONFIG['host_os']
-    when /darwin|hpux/i
+    when /hpux/i
       dir  = File.join(CONFIG['sitearchdir'], 'sys')
       file = File.join(dir, 'proctable.' + CONFIG['DLEXT'])
     else
@@ -117,7 +114,7 @@ Rake::TestTask.new do |t|
       t.test_files = FileList['test/test_sys_proctable_freebsd.rb']  
       t.libs << 'lib/freebsd'
     when /darwin/i
-      t.libs << 'ext/darwin'
+      t.libs << 'lib/darwin'
       t.test_files = FileList['test/test_sys_proctable_darwin.rb']
     when /hpux/i
       t.libs << 'ext/hpux'
@@ -153,10 +150,10 @@ namespace :gem do
          spec.add_dependency('ffi')
       when /darwin/i
          spec.platform = Gem::Platform.new(['universal', 'darwin'])
-         spec.files << 'ext/darwin/sys/proctable.c'
-         spec.extra_rdoc_files << 'ext/darwin/sys/proctable.c'
+         spec.require_paths = ['lib', 'lib/darwin']
+         spec.files += ['lib/darwin/sys/proctable.rb']
          spec.test_files << 'test/test_sys_proctable_darwin.rb'
-         spec.extensions = ['ext/darwin/extconf.rb']
+         spec.add_dependency('ffi')
       when /hpux/i
          spec.platform = Gem::Platform.new(['universal', 'hpux'])
          spec.files << 'ext/hpux/sys/proctable.c'

data/lib/sys/proctable/version.rb

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

data/sys-proctable.gemspec

@@ -2,9 +2,9 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-proctable'
-  spec.version    = '1.0.0'
+  spec.version    = '1.1.0'
   spec.author     = 'Daniel J. Berger'
-  spec.license    = 'Artistic 2.0' 
+  spec.license    = 'Apache 2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'http://github.com/djberg96/sys-proctable'
   spec.platform   = Gem::Platform::CURRENT # Probably altered by Rake task

data/test/test_sys_proctable_all.rb

@@ -15,66 +15,77 @@ class TC_ProcTable_All < Test::Unit::TestCase
   end
 
   def setup
-    @pid = @@windows ? 0 : 1
+    @pid = Process.pid
   end
 
-  def test_version
-    assert_equal('1.0.0', ProcTable::VERSION)
+  test "version is set to expected value" do
+    assert_equal('1.1.0', ProcTable::VERSION)
   end
 
-  def test_fields
+  test "fields basic functionality" do
     assert_respond_to(ProcTable, :fields)
     assert_nothing_raised{ ProcTable.fields }
+  end
+
+  test "fields returns expected type" do
     assert_kind_of(Array, ProcTable.fields)
     assert_kind_of(String, ProcTable.fields.first)
   end
 
-  def test_ps
+  test "ps basic functionality" do
     assert_respond_to(ProcTable, :ps)
     assert_nothing_raised{ ProcTable.ps }
     assert_nothing_raised{ ProcTable.ps{} }
   end
 
-  def test_ps_with_pid
+  test "ps accepts an optional pid" do
     assert_nothing_raised{ ProcTable.ps(0) }
   end
 
-  def test_ps_with_explicit_nil
+  test "ps with explicit nil works as expected" do
     assert_nothing_raised{ ProcTable.ps(nil) }
     assert_kind_of(Array, ProcTable.ps(nil))
   end
 
-  def test_ps_return_value
+  test "ps returns expected results" do
     assert_kind_of(Array, ProcTable.ps)
     assert_kind_of(Struct::ProcTableStruct, ProcTable.ps(@pid))
-    assert_equal(nil, ProcTable.ps(999999999))
-    assert_equal(nil, ProcTable.ps(999999999){})
-    assert_equal(nil, ProcTable.ps{})
   end
 
-  def test_ps_returned_struct_is_frozen
+  test "ps returns nil if process does not exist" do
+    assert_nil(ProcTable.ps(999999999))
+    assert_nil(ProcTable.ps(999999999){})
+    assert_nil(ProcTable.ps{})
+  end
+
+  test "structs returned by ps are frozen" do
     assert_true(ProcTable.ps.first.frozen?)
   end
 
-  def test_ps_expected_errors
+  test "ps accepts numeric arguments only" do
     assert_raises(TypeError){ ProcTable.ps('vim') }
+  end
+
+  test "ps accepts a maximum of one argument on Unix platforms" do
     omit_if(@@windows, 'ArgumentError check skipped on MS Windows')
     assert_raises(ArgumentError){ ProcTable.ps(0, 'localhost') }
   end
 
-  def test_new_not_allowed
+  test "traditional constructor is disabled" do
     assert_raise(NoMethodError){ Sys::ProcTable.new }
   end
 
-  def test_error_class_defined
+  test "custom error class is defined" do
     assert_not_nil(Sys::ProcTable::Error)
     assert_kind_of(StandardError, Sys::ProcTable::Error.new)
   end
 
-  def test_from_thread
-    Thread.new do
-      Sys::ProcTable.ps
-    end.value
+  test "ps works within a thread" do
+    assert_nothing_raised{
+      Thread.new do
+        Sys::ProcTable.ps
+      end.value
+    }
   end
 
   def teardown

data/test/test_sys_top.rb

@@ -2,45 +2,64 @@
 # test_sys_top.rb
 #
 # Test suite for the sys-top library that is included with this distribution.
+#
+# Tests omitted on OSX until I figure out how to get pctcpu information.
 ##############################################################################
-require 'rubygems'
-gem 'test-unit'
-
-require 'test/unit'
+require 'test-unit'
 require 'sys/top'
 
 class TC_Top < Test::Unit::TestCase
   include Sys
 
-  def test_version
+  def setup
+    @osx = RbConfig::CONFIG['host_os'] =~ /darwin/i
+  end
+
+  test "top version" do
     assert_equal('1.0.4', Top::VERSION)
   end
 
-  def test_top_basic
+  test "top basic functionality" do
     assert_respond_to(Top, :top)
+  end
+
+  test "top works with no arguments" do
+    omit_if(@osx)
     assert_nothing_raised{ Top.top }
+  end
+
+  test "top accepts optional arguments" do
+    omit_if(@osx)
     assert_nothing_raised{ Top.top(5) }
     assert_nothing_raised{ Top.top(5, 'cmdline') }
   end
 
-  def test_top
+  test "top with no arguments returns expected results" do
+    omit_if(@osx)
     assert_equal(10, Top.top.length)
     assert_kind_of(Struct::ProcTableStruct, Top.top.first)
   end
 
-  def test_top_with_size
+  test "top with size argument returns expected result" do
+    omit_if(@osx)
     assert_equal(5, Top.top(5).length)
   end
 
-  def test_top_with_size_and_sort_by_field
+  test "top with size and sort_by argument returns expected result" do
+    omit_if(@osx)
     assert_equal(5, Top.top(5, :cmdline).length)
   end
 
-  def test_top_return_type
+  test "top returns an array" do
+    omit_if(@osx)
     assert_kind_of(Array, Top.top)
   end
 
-  def test_top_expected_errors
+  test "top accepts a maximum of two arguments" do
     assert_raises(ArgumentError){ Top.top(1, 'foo', 2) }
   end
+
+  def teardown
+    @osx = nil
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-proctable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: universal-freebsd
 authors:
 - Daniel J. Berger
@@ -30,48 +30,48 @@ cert_chain:
   EJYzxdPOrx2n6NYR3Hk+vHP0U7UBSveI6+qx+ndQYaeyCn+GRX2PKS9h66YF/Q1V
   tGSHgAmcLlkdGgan182qsE/4kKM=
   -----END CERTIFICATE-----
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
@@ -104,7 +104,7 @@ files:
 - lib/freebsd/sys/proctable.rb
 homepage: http://github.com/djberg96/sys-proctable
 licenses:
-- Artistic 2.0
+- Apache 2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -113,17 +113,17 @@ require_paths:
 - lib/freebsd
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: An interface for providing process table information