sys-admin 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72d00ed279d1871b324cf2819ba90432093b8063a30e0bbdc9fa66111b588538
-  data.tar.gz: 31bc4f2515a391ba43c1bc9ce0b3bdeffacd6d758b7e98a29a111ced2ab14e85
+  metadata.gz: d20b0abf74cb8d4769f69346ac22ade3d1336bd10d3b6f83eeca2865ab9b85fe
+  data.tar.gz: 7c56cb4dec18928e3ea4fb1371e9c3f4e660fb5ec94519b0385a1448c07e0d84
 SHA512:
-  metadata.gz: 36c4dc086a9929e998695ed02ce9cb89b5bd487cc4cb42aacccc26aab8a3fa3f62fde29a2bbb0792fd6657278fbe874e3366e3dc08a29c2ebc99e087bb1ea939
-  data.tar.gz: 3f9c593cd1b2008966524683d511c1c5e7e6ada91298516adc46afe948dd39cad7da069b426f268376493e6eb28934f020d55be60c73fca2bb756cf885d1e245
+  metadata.gz: 55d12a7b5d4999eec9801b60a06d1da16bfb2879a4270b0d5188b7d20a397a170619fb0dc75f9fd394952c02e3228d686ff9c908f15a38750220bea7eb2a2e9d
+  data.tar.gz: 3ec5f6ac0690458751f5dd5e2ccaf764b977f1aa46fc6f2acf0c506417c39a4baf704338c712614728fe8d89c289bd76c20dcd62b41f6b28ab5205404ef338e3

data/CHANGES.md

@@ -1,9 +1,15 @@
+## 1.8.1 - 25-Sep-2021
+* The users and get_user methods on Darwin now take an optional :lastlog key
+  that you can set to false in order to significantly speed up those methods
+  at the expense of taking away lastlog information.
+* Some internal rspec refactoring.
+
 ## 1.8.0 - 26-Aug-2021
 * Switched from test-unit to rspec, with some tests refactored. The Rakefile
   and gemspec files were updated accordingly.
 * The User and Group classes for the Windows implementation are now properly
   scoped under Sys::Admin instead of just Sys.
-* Fixed a bug in the get_user and get_group methods on Winodws where the WQL
+* Fixed a bug in the get_user and get_group methods on Windows where the WQL
   it generates internally might not be correct.
 
 ## 1.7.6 - 24-Mar-2021

data/README.md

@@ -1,3 +1,5 @@
+[![Ruby](https://github.com/djberg96/sys-admin/actions/workflows/ruby.yml/badge.svg)](https://github.com/djberg96/sys-admin/actions/workflows/ruby.yml)
+
 ## Description
 The sys-admin library is a unified, cross platform replacement for the Etc module.
    

data/Rakefile

@@ -23,7 +23,6 @@ end
 
 desc "Run the specs for the sys-admin library"
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = 'spec/sys_admin_unix_spec.rb'
   case RbConfig::CONFIG['host_os']
   when /darwin|osx/i
     t.rspec_opts = '-Ilib/darwin'
@@ -35,7 +34,6 @@ RSpec::Core::RakeTask.new(:spec) do |t|
     t.rspec_opts = '-Ilib/bsd'
   when /windows|win32|mingw|cygwin|dos/i
     t.rspec_opts = '-Ilib/windows'
-    t.pattern = 'spec/sys_admin_windows_spec.rb'
   else
     t.rspec_opts = '-Ilib/unix'
   end

data/lib/darwin/sys/admin.rb

@@ -80,8 +80,12 @@ module Sys
     #
     #    Sys::Admin.get_user('joe')
     #    Sys::Admin.get_user(501)
+    #    Sys::Admin.get_user('joe', :lastlog => false) # Less info but faster
     #
-    def self.get_user(uid)
+    # Set the :lastlog option to false if you want to ignore lastlog
+    # information and speed this method up considerably.
+    #
+    def self.get_user(uid, options = {})
       buf  = FFI::MemoryPointer.new(:char, 1024)
       pbuf = FFI::MemoryPointer.new(PasswdStruct)
       temp = PasswdStruct.new
@@ -103,7 +107,7 @@ module Sys
       end
 
       pwd = PasswdStruct.new(ptr)
-      get_user_from_struct(pwd)
+      get_user_from_struct(pwd, options)
     end
 
     # Returns a Group object for the given name or uid. Raises an error
@@ -148,11 +152,19 @@ module Sys
 
     # Returns an array of User objects for each user on the system.
     #
+    # Examples:
+    #
+    #   Sys::Admin.users
+    #   Sys::Admin.users(:lastlog => false) # Less info but faster
+    #
+    # Note that on Darwin this method can be very slow. If you want to
+    # speed it up considerably by ignoring lastlog information then set
+    # the :lastlog option to false as part of the +options+ hash.
     #--
     # This method is somewhat slow on OSX because of the call to get
     # lastlog information. I'm not sure why.
     #
-    def self.users
+    def self.users(options = {})
       users = []
 
       begin
@@ -160,7 +172,7 @@ module Sys
 
         until (ptr = getpwent()).null?
           pwd = PasswdStruct.new(ptr)
-          users << get_user_from_struct(pwd)
+          users << get_user_from_struct(pwd, options)
         end
       ensure
         endpwent()
@@ -201,7 +213,7 @@ module Sys
     private_class_method :get_group_from_struct
 
     # Takes a UserStruct and converts it to a User object.
-    def self.get_user_from_struct(pwd)
+    def self.get_user_from_struct(pwd, options)
       user = User.new do |u|
         u.name         = pwd[:pw_name]
         u.passwd       = pwd[:pw_passwd]
@@ -215,12 +227,14 @@ module Sys
         u.expire       = Time.at(pwd[:pw_expire])
       end
 
-      log = get_lastlog_info(user.uid)
+      unless options[:lastlog] == false
+        log = get_lastlog_info(user.uid)
 
-      if log
-        user.login_time = Time.at(log[:tv_sec])
-        user.login_device = log[:ll_line].to_s
-        user.login_host = log[:ll_host].to_s
+        if log
+          user.login_time = Time.at(log[:tv_sec])
+          user.login_device = log[:ll_line].to_s
+          user.login_host = log[:ll_host].to_s
+        end
       end
 
       user

data/lib/sys/admin.rb

@@ -1,7 +1,7 @@
 module Sys
   class Admin
     # The version of the sys-admin library.
-    VERSION = '1.8.0'.freeze
+    VERSION = '1.8.1'.freeze
   end
 end
 

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require 'sys-admin'
+
+RSpec.configure do |config|
+  config.filter_run_excluding(:darwin) if Gem::Platform.local.os != 'darwin'
+  config.filter_run_excluding(:windows) unless Gem.win_platform?
+
+  if Gem.win_platform?
+    config.filter_run_excluding(:unix)
+    require 'win32-security'
+    require 'socket'
+  end
+end

data/spec/sys_admin_unix_spec.rb

@@ -4,8 +4,7 @@
 # Test suite for the Unix version of sys-admin. This test should be run
 # via the 'rake spec' task.
 ###############################################################################
-require 'rspec'
-require 'sys/admin'
+require 'spec_helper'
 
 RSpec.describe Sys::Admin, :unix do
   let(:user)     { 'nobody' }
@@ -41,9 +40,8 @@ RSpec.describe Sys::Admin, :unix do
         expect(described_class.get_user(user_id)).to be_kind_of(Sys::Admin::User)
       end
 
-      example "get_user requires one argument only" do
+      example "get_user requires at least one argument" do
         expect{ described_class.get_user }.to raise_error(ArgumentError)
-        expect{ described_class.get_user(user, user) }.to raise_error(ArgumentError)
       end
 
       example "get_user requires a string or integer argument" do
@@ -67,8 +65,11 @@ RSpec.describe Sys::Admin, :unix do
         expect(users).to all(be_kind_of(Sys::Admin::User))
       end
 
-      example "users does not accept any arguments" do
-        expect{ described_class.users(user_id) }.to raise_error(ArgumentError)
+      example "users accepts an optional lastlog argument on darwin", :darwin => true do
+        users = described_class.users(:lastlog => false)
+        expect(users).to be_kind_of(Array)
+        expect(users).to all(be_kind_of(Sys::Admin::User))
+        expect(users.first.login_time).to be_nil
       end
     end
 

data/spec/sys_admin_version_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+RSpec.describe Sys::Admin do
+  example "version is set to expected value" do
+    expect(described_class::VERSION).to eq('1.8.1')
+  end
+
+  example "version constant is frozen" do
+    expect(described_class::VERSION).to be_frozen
+  end
+end

data/spec/sys_admin_windows_spec.rb

@@ -7,10 +7,7 @@
 #
 # It is assumed that these specs will be run via the 'rake spec' task.
 ###############################################################################
-require 'rspec'
-require 'sys/admin'
-require 'win32/security'
-require 'socket'
+require 'spec_helper'
 
 RSpec.describe Sys::Admin, :windows do
   let(:host) { Socket.gethostname }

data/sys-admin.gemspec

@@ -3,7 +3,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-admin'
-  spec.version    = '1.8.0'
+  spec.version    = '1.8.1'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-admin
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2021-08-26 00:00:00.000000000 Z
+date: 2021-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -111,7 +111,9 @@ files:
 - lib/sys/admin/custom.rb
 - lib/unix/sys/admin.rb
 - lib/windows/sys/admin.rb
+- spec/spec_helper.rb
 - spec/sys_admin_unix_spec.rb
+- spec/sys_admin_version_spec.rb
 - spec/sys_admin_windows_spec.rb
 - sys-admin.gemspec
 homepage: http://www.github.com/djberg96/sys-admin
@@ -139,10 +141,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: A unified, cross platform replacement for the "etc" library.
 test_files:
+- spec/spec_helper.rb
 - spec/sys_admin_unix_spec.rb
+- spec/sys_admin_version_spec.rb
 - spec/sys_admin_windows_spec.rb