sys-uptime 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72e69131ad6cd87126c07f6ee1b86f96bcb94fad06481b31e0af63b9e2e3d1f2
-  data.tar.gz: 04d76a92b4c30697055281729d04123e3c90bf382f3a75a6b1490f297593c026
+  metadata.gz: b60e5a8e0c80b7bc4596d476f5a65f14012eae7727e157871c67c20db8b9e7e5
+  data.tar.gz: 8f47059f06522c513b7ae2c139c1f536dc7d0e836531e51b6e19494cee4171af
 SHA512:
-  metadata.gz: d68dc7da76c7e4c9968175b3ac7cb5355004345c087483d914096fa4e06232397adca500c2512c7136cc497cff944ffa0704a3737b080d53a1ec8528f97e3173
-  data.tar.gz: 86eb66468d20d99647a647e856e3a29364e08fcdd41ac8425bc9ec3f61f4525fde6054cbb83f96fbed99280a184da58b8f644caf1bf3bc15b91cad4baabc16c7
+  metadata.gz: 1821026a7dd878dad5b3d6bfd4c9be6cc8eec3535e527dbda2a7f5539a5d5c8b8e1bbac7a17c2289c8598835062e8b250f2b660037cc85e7f715724656ec70ef
+  data.tar.gz: 2b05cc363f44cbb5ffd4cd8172073981484f72d1c0b11cad3f28a78fb935499b99f8568a939e51adb1aa6da768829ad2ab8cd6a28e8fc5719d12f7b4adeed21c

data/{CHANGES → CHANGES.rdoc}

@@ -1,3 +1,12 @@
+== 0.7.3 - 31-Dec-2019
+* Attempting to call Sys::Uptime.new will now raise an error. I thought
+  this was already the case, but apparently one of the tests was bad.
+* Added explicit .rdoc extensions to various text files so that github
+  will display them nicely.
+* Switched from test-unit to rspec as the testing framework of choice.
+* Updated the gemspec to reflect the filename updates, as well as the
+  added development dependency.
+
 == 0.7.2 - 4-Nov-2018
 * Added metadata to the gemspec.
 * The VERSION constant is now frozen.

data/{MANIFEST → MANIFEST.rdoc}

@@ -1,11 +1,11 @@
-* CHANGES
-* MANIFEST
+* CHANGES.rdoc
+* MANIFEST.rdoc
 * Rakefile
-* README
+* README.rdoc
 * sys-uptime.gemspec
 * certs/djberg96_pub.pem
 * examples/test.rb
 * lib/sys-uptime.rb
 * lib/unix/sys/uptime.rb
 * lib/windows/sys/uptime.rb
-* test/test_sys_uptime.rb
+* spec/sys_uptime_spec.rb

data/README.rdoc

@@ -0,0 +1,67 @@
+== Description
+A Ruby interface for getting system uptime information.
+
+== Prerequisites
+ffi 0.1.0 or later on Unixy platforms.
+
+== Installation
+
+gem install sys-uptime
+
+== Synopsis
+  require 'sys-uptime'
+  include Sys
+
+  # Get everything
+  p Uptime.uptime
+  p Uptime.dhms.join(', ')
+
+  # Get individual units
+  p Uptime.days
+  p Uptime.hours
+  p Uptime.minutes
+  p Uptime.seconds
+
+  # Get the boot time
+  p Uptime.boot_time
+
+== Notes
+On MS Windows the +Uptime.uptime+ and +Uptime.boot_time+ methods optionally
+takes a host name as a single argument. The default is localhost.
+
+The current time, users and load average are not included in this library
+module, even though you may be used to seeing them with the command
+line version of +uptime+.
+
+== Known Bugs
+None that I am aware of. Please log any bugs you find on the project
+website at https://github.com/djberg96/sys-uptime.
+
+== Questions
+"Doesn't Struct::Tms do this?" - No.
+    
+== License
+Apache-2.0
+    
+== Copyright
+Copyright 2002-2019, Daniel J. Berger
+
+All Rights Reserved. This module is free software. It may be used,
+redistributed and/or modified under the same terms as Ruby itself.
+    
+== Warranty
+This library 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.
+
+== Acknowledgements
+Andrea Fazzi for help with the FFI version.
+
+Mike Hall for help with the BSD side of things for the original C code.
+
+Ola Eriksson, whose source code I shamelessly plagiarized to get a better
+implementation for systems that have the utmpx.h header file for the
+original C code.
+
+== Author
+Daniel J. Berger

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rake'
 require 'rake/clean'
 require 'rake/testtask'
+require 'rspec/core/rake_task'
 
 CLEAN.include("**/*.gem", "**/*.rbx", "**/*.rbc")
 
@@ -28,15 +29,6 @@ namespace 'gem' do
 end
 
 desc "Run the test suite"
-Rake::TestTask.new do |t|
-  if File::ALT_SEPARATOR
-    t.libs << 'lib/windows'
-  else
-    t.libs << 'lib/unix'
-  end
-
-  t.warning = true
-  t.verbose = true
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

data/lib/sys/unix/sys/uptime.rb

@@ -26,7 +26,7 @@ module Sys
     attach_function :time,     [:pointer], :time_t
     attach_function :times,    [:pointer], :clock_t
 
-    private_class_method :strerror, :sysconf, :time, :times
+    private_class_method :strerror, :sysconf, :time, :times, :new
 
     begin
       attach_function :sysctl, [:pointer, :uint, :pointer, :pointer, :pointer, :size_t], :int

data/lib/sys/uptime.rb

@@ -7,6 +7,6 @@ end
 module Sys
   class Uptime
     # The version of the sys-uptime library
-    VERSION = '0.7.2'.freeze
+    VERSION = '0.7.3'.freeze
   end
 end

data/lib/sys/windows/sys/uptime.rb

@@ -13,6 +13,9 @@ module Sys
     # Error typically raised in one of the Uptime methods should fail.
     class Error < StandardError; end
 
+    # You cannot instantiate an instance of Sys::Uptime.
+    private_class_method :new
+
     # Returns the boot time as a Time object.
     #
     # Example:

data/spec/sys_uptime_spec.rb

@@ -0,0 +1,103 @@
+#####################################################################
+# sys_uptime_spec.rb
+#
+# Test suite for sys-uptime. This should generally be run via the
+# 'rake test' task, since it handles the pre-setup code for you.
+#####################################################################
+require 'sys/uptime'
+require 'test-unit'
+require 'socket'
+
+describe Sys::Uptime do
+  example "version is set to expected value" do
+    expect(Sys::Uptime::VERSION).to eql('0.7.3')
+    expect(Sys::Uptime::VERSION.frozen?).to be(true)
+  end
+
+  example "seconds method basic functionality" do
+    expect(Sys::Uptime).to respond_to(:seconds)
+    expect{ Sys::Uptime.seconds }.not_to raise_error
+  end
+
+  example "seconds method returns a plausible value" do
+    expect(Sys::Uptime.seconds).to be_kind_of(Integer)
+    expect(Sys::Uptime.seconds).to be > 300
+  end
+
+  example "minutes method basic functionality" do
+    expect(Sys::Uptime).to respond_to(:minutes)
+    expect{ Sys::Uptime.minutes }.not_to raise_error
+  end
+
+  example "minutes method returns a plausible value" do
+    expect(Sys::Uptime.minutes).to be_kind_of(Integer)
+    expect(Sys::Uptime.minutes).to be > 5
+  end
+
+  example "hours method basic functionality" do
+    expect(Sys::Uptime).to respond_to(:hours)
+    expect{ Sys::Uptime.hours }.not_to raise_error
+  end
+
+  example "hours method returns a plausible value" do
+    expect(Sys::Uptime.hours).to be_kind_of(Integer)
+    expect(Sys::Uptime.hours).to be > 0
+  end
+
+  example "days method basic functionality" do
+    expect(Sys::Uptime).to respond_to(:days)
+    expect{ Sys::Uptime.days }.not_to raise_error
+  end
+
+  example "days method returns a plausible value" do
+    expect(Sys::Uptime.days).to be_kind_of(Integer)
+    expect(Sys::Uptime.days).to be >= 0
+  end
+
+  example "uptime method basic functionality" do
+    expect(Sys::Uptime).to respond_to(:uptime)
+    expect{ Sys::Uptime.uptime }.not_to raise_error
+  end
+
+  example "uptime method returns a non-empty string" do
+    expect(Sys::Uptime.uptime).to be_kind_of(String)
+    expect(Sys::Uptime.uptime.empty?).to be(false)
+  end
+
+  example "uptime method does not accept any arguments", :unless => File::ALT_SEPARATOR do
+    expect{ Sys::Uptime.uptime(1) }.to raise_error(ArgumentError)
+  end
+
+  example "uptime accepts a host name on Windows", :if => File::ALT_SEPARATOR do
+    expect{ Sys::Uptime.uptime(Socket.gethostname) }.not_to raise_error
+  end
+
+  example "dhms method basic functionality" do
+    expect(Sys::Uptime).to respond_to(:dhms)
+    expect{ Sys::Uptime.dhms }.not_to raise_error
+    expect(Sys::Uptime.dhms).to be_kind_of(Array)
+  end
+
+  example "dhms method returns an array of four elements" do
+    expect(Sys::Uptime.dhms).not_to be_empty
+    expect(Sys::Uptime.dhms.length).to eql(4)
+  end
+
+  example "boot_time method basic functionality" do
+    expect(Sys::Uptime).to respond_to(:boot_time)
+    expect{ Sys::Uptime.boot_time }.not_to raise_error
+  end
+
+  example "boot_time method returns a Time object" do
+    expect(Sys::Uptime.boot_time).to be_kind_of(Time)
+  end
+
+  example "Uptime class cannot be instantiated" do
+    expect{ Sys::Uptime.new }.to raise_error(StandardError)
+  end
+
+  example "Ensure that ffi functions are private" do
+    methods = Sys::Uptime.methods(false).map{ |e| e.to_s }
+    expect(methods).not_to include('time', 'times')
+  end
+end

data/sys-uptime.gemspec

@@ -2,17 +2,18 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-uptime'
-  spec.version    = '0.7.2'
+  spec.version    = '0.7.3'
   spec.author     = 'Daniel J. Berger'
-  spec.license    = 'Apache 2.0'
+  spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'https://github.com/djberg96/sys-uptime'
   spec.summary    = 'A Ruby interface for getting system uptime information.'
-  spec.test_file  = 'test/test_sys_uptime.rb'
+  spec.test_file  = 'spec/sys_uptime_spec.rb'
   spec.files      = Dir["**/*"].reject{ |f| f.include?('git') }
   spec.cert_chain = ['certs/djberg96_pub.pem']
 
-  spec.extra_rdoc_files  = ['CHANGES', 'README', 'MANIFEST']
+  spec.extra_rdoc_files = Dir["*.rdoc"]
+  spec.add_development_dependency 'rspec', '~> 3'
 
   spec.metadata = {
     'homepage_uri'      => 'https://github.com/djberg96/sys-uptime',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-uptime
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,8 +35,22 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2018-11-04 00:00:00.000000000 Z
+date: 
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
@@ -59,16 +73,13 @@ email: djberg96@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- CHANGES
-- README
-- MANIFEST
+- CHANGES.rdoc
+- MANIFEST.rdoc
+- README.rdoc
 files:
-- test
-- test/test_sys_uptime.rb
 - sys-uptime.gemspec
-- CHANGES
-- MANIFEST
-- README
+- spec
+- spec/sys_uptime_spec.rb
 - Rakefile
 - certs
 - certs/djberg96_pub.pem
@@ -84,9 +95,12 @@ files:
 - lib/sys/windows
 - lib/sys/windows/sys
 - lib/sys/windows/sys/uptime.rb
+- CHANGES.rdoc
+- MANIFEST.rdoc
+- README.rdoc
 homepage: https://github.com/djberg96/sys-uptime
 licenses:
-- Apache 2.0
+- Apache-2.0
 metadata:
   homepage_uri: https://github.com/djberg96/sys-uptime
   bug_tracker_uri: https://github.com/djberg96/sys-uptime/issues
@@ -109,10 +123,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A Ruby interface for getting system uptime information.
 test_files:
-- test/test_sys_uptime.rb
+- spec/sys_uptime_spec.rb

data/README

@@ -1,66 +0,0 @@
-= Description
-  A Ruby interface for getting system uptime information.
-
-= Prerequisites
-  ffi 0.1.0 or later on Unixy platforms.
-
-= Installation
-  gem install sys-uptime
-
-= Synopsis
-  require 'sys-uptime'
-  include Sys
-
-  # Get everything
-  p Uptime.uptime
-  p Uptime.dhms.join(', ')
-
-  # Get individual units
-  p Uptime.days
-  p Uptime.hours
-  p Uptime.minutes
-  p Uptime.seconds
-
-  # Get the boot time
-  p Uptime.boot_time
-
-= Notes
-  On MS Windows the Uptime.uptime and Uptime_boot_time methods optionally
-  takes a host name as a single argument. The default is localhost.
-
-  The current time, users and load average are not included in this library
-  module, even though you may be used to seeing them with the command
-  line version of 'uptime'.
-
-== Known Bugs
-  None that I am aware of.  Please log any bugs you find on the project
-  website at https://github.com/djberg96/sys-uptime.
-
-== Questions
-  "Doesn't Struct::Tms do this?" - No.
-    
-== License
-  Apache 2.0
-    
-== Copyright
-  Copyright 2002-2018, Daniel J. Berger
-
-  All Rights Reserved. This module is free software. It may be used,
-  redistributed and/or modified under the same terms as Ruby itself.
-    
-== Warranty
-  This library 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.
-
-== Acknowledgements
-  Andrea Fazzi for help with the FFI version.
-
-  Mike Hall for help with the BSD side of things for the original C code.
-
-  Ola Eriksson, whose source code I shamelessly plagiarized to get a better
-  implementation for systems that have the utmpx.h header file for the
-  original C code.
-
-== Author
-  Daniel J. Berger

data/test/test_sys_uptime.rb

@@ -1,107 +0,0 @@
-#####################################################################
-# test_sys_uptime.rb
-#
-# Test suite for sys-uptime. This should generally be run via the
-# 'rake test' task, since it handles the pre-setup code for you.
-#####################################################################
-require 'sys/uptime'
-require 'test-unit'
-require 'socket'
-include Sys
-
-class TC_Sys_Uptime < Test::Unit::TestCase
-  test "version is set to expected value" do
-    assert_equal('0.7.2', Uptime::VERSION)
-    assert_true(Uptime::VERSION.frozen?)
-  end
-
-  test "seconds method basic functionality" do
-    assert_respond_to(Uptime, :seconds)
-    assert_nothing_raised{ Uptime.seconds }
-  end
-
-  test "seconds method returns a plausible value" do
-    assert_kind_of(Integer, Uptime.seconds)
-    assert_true(Uptime.seconds > 300)
-  end
-
-  test "minutes method basic functionality" do
-    assert_respond_to(Uptime, :minutes)
-    assert_nothing_raised{ Uptime.minutes }
-  end
-
-  test "minutes method returns a plausible value" do
-    assert_kind_of(Integer, Uptime.minutes)
-    assert_true(Uptime.minutes > 5)
-  end
-
-  test "hours method basic functionality" do
-    assert_respond_to(Uptime, :hours)
-    assert_nothing_raised{ Uptime.hours }
-  end
-
-  test "hours method returns a plausible value" do
-    assert_kind_of(Integer, Uptime.hours)
-    assert_true(Uptime.hours > 0)
-  end
-
-  test "days method basic functionality" do
-    assert_respond_to(Uptime, :days)
-    assert_nothing_raised{ Uptime.days }
-  end
-
-  test "days method returns a plausible value" do
-    assert_kind_of(Integer, Uptime.days)
-    assert_true(Uptime.days >= 0)
-  end
-
-  test "uptime method basic functionality" do
-    assert_respond_to(Uptime, :uptime)
-    assert_nothing_raised{ Uptime.uptime }
-  end
-
-  test "uptime method returns a non-empty string" do
-    assert_kind_of(String, Uptime.uptime)
-    assert_false(Uptime.uptime.empty?)
-  end
-
-  test "uptime method does not accept any arguments" do
-    omit_if(File::ALT_SEPARATOR)
-    assert_raise(ArgumentError){ Uptime.uptime(1) }
-  end
-
-  test "uptime accepts a host name on Windows" do
-    omit_unless(File::ALT_SEPARATOR, "MS Windows only")
-    assert_nothing_raised{ Uptime.uptime(Socket.gethostname) }
-  end
-
-  test "dhms method basic functionality" do
-    assert_respond_to(Uptime, :dhms)
-    assert_nothing_raised{ Uptime.dhms }
-    assert_kind_of(Array, Uptime.dhms)
-  end
-
-  test "dhms method returns an array of four elements" do
-    assert_false(Uptime.dhms.empty?)
-    assert_equal(4, Uptime.dhms.length)
-  end
-
-  test "boot_time method basic functionality" do
-    assert_respond_to(Uptime, :boot_time)
-    assert_nothing_raised{ Uptime.boot_time }
-  end
-
-  test "boot_time method returns a Time object" do
-    assert_kind_of(Time, Uptime.boot_time)
-  end
-
-  test "Uptime class cannot be instantiated" do
-    assert_kind_of(StandardError, Uptime::Error.new)
-  end
-
-  test "Ensure that ffi functions are private" do
-    methods = Uptime.methods(false).map{ |e| e.to_s }
-    assert_false(methods.include?('time'))
-    assert_false(methods.include?('times'))
-  end
-end