sys-admin 1.6.4 → 1.7.0

data/lib/sys-admin.rb

@@ -1 +1 @@
-require_relative 'sys/admin'
+require_relative 'sys/admin'

data/lib/sys/admin.rb

@@ -1,24 +1,24 @@
-module Sys
-  class Admin
-    # The version of the sys-admin library.
-    VERSION = "1.6.4"
-  end
-end
-
-# Stub to require the correct based on platform
-require 'rbconfig'
-
-case RbConfig::CONFIG['host_os']
-  when /linux/i
-    require 'linux/sys/admin'
-  when /sunos|solaris/i
-    require 'sunos/sys/admin'
-  when /cygwin|mingw|mswin|windows|dos/i
-    require 'windows/sys/admin'
-  when /darwin|mach/i
-    require 'darwin/sys/admin'
-  when /bsd/i
-    require 'bsd/sys/admin'
-  else
-    require 'unix/sys/admin'
-end
+module Sys
+  class Admin
+    # The version of the sys-admin library.
+    VERSION = '1.7.0'.freeze
+  end
+end
+
+# Stub to require the correct based on platform
+require 'rbconfig'
+
+case RbConfig::CONFIG['host_os']
+  when /linux/i
+    require 'linux/sys/admin'
+  when /sunos|solaris/i
+    require 'sunos/sys/admin'
+  when /cygwin|mingw|mswin|windows|dos/i
+    require 'windows/sys/admin'
+  when /darwin|mach/i
+    require 'darwin/sys/admin'
+  when /bsd/i
+    require 'bsd/sys/admin'
+  else
+    require 'unix/sys/admin'
+end

data/lib/sys/admin/common.rb

@@ -1,137 +1,137 @@
-require 'ffi'
-
-# The Sys module serves as a namespace only.
-module Sys
-
-  # The Admin class provides a unified, cross platform replacement
-  # for the Etc module.
-  class Admin
-    extend FFI::Library
-    ffi_lib FFI::Library::LIBC
-
-    private
-
-    attach_function :strerror, [:int], :string
-
-    attach_function :getlogin, [], :string
-    attach_function :getuid, [], :long
-    attach_function :getpwnam, [:string], :pointer
-    attach_function :getpwuid, [:long], :pointer
-    attach_function :getpwent, [], :pointer
-    attach_function :setpwent, [], :void
-    attach_function :endpwent, [], :void
-
-    attach_function :getgrgid, [:long], :pointer
-    attach_function :getgrnam, [:string], :pointer
-    attach_function :getgrent, [], :pointer
-    attach_function :endgrent, [], :void
-    attach_function :setgrent, [], :void
-
-    private_class_method :getlogin, :getuid, :getpwnam, :getpwuid, :getpwent
-    private_class_method :setpwent, :endpwent, :getgrgid, :getgrnam
-    private_class_method :getgrent, :endgrent, :setgrent, :strerror
-
-    public
-
-    # Error typically raised if any of the Sys::Admin methods fail.
-    class Error < StandardError; end
-
-    # The User class encapsulates the information found in /etc/passwd.
-    class User
-      # The user name associated with the account.
-      attr_accessor :name
-
-      # The user's encrypted password. Deprecated by /etc/shadow.
-      attr_accessor :passwd
-
-      # The user's user ID.
-      attr_accessor :uid
-
-      # The user's group ID.
-      attr_accessor :gid
-
-      # Next date a password change will be needed.
-      attr_accessor :change
-
-      # A comment field. Rarely used now.
-      attr_accessor :gecos
-
-      # The user's alloted amount of disk space.
-      attr_accessor :quota
-
-      # The absolute path name of the user's home directory.
-      attr_accessor :dir
-
-      # The user's login shell.
-      attr_accessor :shell
-
-      # The account's expiration date
-      attr_accessor :expire
-
-      # TODO: Forgot what this is.
-      attr_accessor :fields
-
-      # The user's access class.
-      attr_accessor :access_class
-
-      # Another comment field.
-      attr_accessor :comment
-
-      # Used in the past for password aging. Deprecated by /etc/shadow.
-      attr_accessor :age
-
-      # The last time the user logged in.
-      attr_accessor :login_time
-
-      # The host name from which the user last logged in.
-      attr_accessor :login_host
-
-      # The name of the terminal device the user last logged on with.
-      attr_accessor :login_device
-
-      # Creates and returns a User object, which encapsulates the information
-      # typically found within an /etc/passwd entry, i.e. a struct passwd.
-      #
-      # If a block is provided, yields the object back to the block.
-      #
-      def initialize
-        yield self if block_given?
-      end
-
-      # An array of groups to which the user belongs.
-      def groups
-        array = []
-
-        Sys::Admin.groups.each{ |grp|
-          array << grp.name if grp.members.include?(self.name)
-        }
-
-        array
-      end
-    end
-
-    # The Group class encapsulates information found in /etc/group.
-    class Group
-      # The name of the group.
-      attr_accessor :name
-
-      # The group's group ID.
-      attr_accessor :gid
-
-      # An array of members associated with the group.
-      attr_accessor :members
-
-      # The group password, if any.
-      attr_accessor :passwd
-
-      # Creates and returns a Group object, which encapsulates the information
-      # typically found within an /etc/group entry, i.e. a struct group.
-      #
-      # If a block is provided, yields the object back to the block.
-      #
-      def initialize
-        yield self if block_given?
-      end
-    end
-  end
-end
+require 'ffi'
+
+# The Sys module serves as a namespace only.
+module Sys
+
+  # The Admin class provides a unified, cross platform replacement
+  # for the Etc module.
+  class Admin
+    extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+
+    private
+
+    attach_function :strerror, [:int], :string
+
+    attach_function :getlogin, [], :string
+    attach_function :getuid, [], :long
+    attach_function :getpwnam, [:string], :pointer
+    attach_function :getpwuid, [:long], :pointer
+    attach_function :getpwent, [], :pointer
+    attach_function :setpwent, [], :void
+    attach_function :endpwent, [], :void
+
+    attach_function :getgrgid, [:long], :pointer
+    attach_function :getgrnam, [:string], :pointer
+    attach_function :getgrent, [], :pointer
+    attach_function :endgrent, [], :void
+    attach_function :setgrent, [], :void
+
+    private_class_method :getlogin, :getuid, :getpwnam, :getpwuid, :getpwent
+    private_class_method :setpwent, :endpwent, :getgrgid, :getgrnam
+    private_class_method :getgrent, :endgrent, :setgrent, :strerror
+
+    public
+
+    # Error typically raised if any of the Sys::Admin methods fail.
+    class Error < StandardError; end
+
+    # The User class encapsulates the information found in /etc/passwd.
+    class User
+      # The user name associated with the account.
+      attr_accessor :name
+
+      # The user's encrypted password. Deprecated by /etc/shadow.
+      attr_accessor :passwd
+
+      # The user's user ID.
+      attr_accessor :uid
+
+      # The user's group ID.
+      attr_accessor :gid
+
+      # Next date a password change will be needed.
+      attr_accessor :change
+
+      # A comment field. Rarely used now.
+      attr_accessor :gecos
+
+      # The user's alloted amount of disk space.
+      attr_accessor :quota
+
+      # The absolute path name of the user's home directory.
+      attr_accessor :dir
+
+      # The user's login shell.
+      attr_accessor :shell
+
+      # The account's expiration date
+      attr_accessor :expire
+
+      # TODO: Forgot what this is.
+      attr_accessor :fields
+
+      # The user's access class.
+      attr_accessor :access_class
+
+      # Another comment field.
+      attr_accessor :comment
+
+      # Used in the past for password aging. Deprecated by /etc/shadow.
+      attr_accessor :age
+
+      # The last time the user logged in.
+      attr_accessor :login_time
+
+      # The host name from which the user last logged in.
+      attr_accessor :login_host
+
+      # The name of the terminal device the user last logged on with.
+      attr_accessor :login_device
+
+      # Creates and returns a User object, which encapsulates the information
+      # typically found within an /etc/passwd entry, i.e. a struct passwd.
+      #
+      # If a block is provided, yields the object back to the block.
+      #
+      def initialize
+        yield self if block_given?
+      end
+
+      # An array of groups to which the user belongs.
+      def groups
+        array = []
+
+        Sys::Admin.groups.each{ |grp|
+          array << grp.name if grp.members.include?(self.name)
+        }
+
+        array
+      end
+    end
+
+    # The Group class encapsulates information found in /etc/group.
+    class Group
+      # The name of the group.
+      attr_accessor :name
+
+      # The group's group ID.
+      attr_accessor :gid
+
+      # An array of members associated with the group.
+      attr_accessor :members
+
+      # The group password, if any.
+      attr_accessor :passwd
+
+      # Creates and returns a Group object, which encapsulates the information
+      # typically found within an /etc/group entry, i.e. a struct group.
+      #
+      # If a block is provided, yields the object back to the block.
+      #
+      def initialize
+        yield self if block_given?
+      end
+    end
+  end
+end

data/lib/sys/admin/custom.rb

@@ -1,16 +1,16 @@
-require 'ffi'
-
-class FFI::Pointer
-  def read_array_of_string
-    elements = []
-
-    loc = self
-
-    until ((element = loc.read_pointer).null?)
-     elements << element.read_string
-     loc += FFI::Type::POINTER.size
-    end
-
-    elements
-  end
-end
+require 'ffi'
+
+class FFI::Pointer
+  def read_array_of_string
+    elements = []
+
+    loc = self
+
+    until ((element = loc.read_pointer).null?)
+     elements << element.read_string
+     loc += FFI::Type::POINTER.size
+    end
+
+    elements
+  end
+end

data/lib/unix/sys/admin.rb

@@ -1,163 +1,163 @@
-require 'sys/admin/custom'
-require 'sys/admin/common'
-
-# Code used as a fallback for UNIX platforms.
-
-module Sys
-  class Admin
-    private
-
-    class PasswdStruct < FFI::Struct
-      layout(
-        :pw_name,   :string,
-        :pw_passwd, :string,
-        :pw_uid,    :uint,
-        :pw_gid,    :uint,
-        :pw_gecos,  :string,
-        :pw_dir,    :string,
-        :pw_shell,  :string
-      )
-    end
-
-    class GroupStruct < FFI::Struct
-      layout(
-        :gr_name,   :string,
-        :gr_passwd, :string,
-        :gr_gid,    :uint,
-        :gr_mem,    :pointer
-      )
-    end
-
-    public
-
-    # Returns the login for the current process.
-    #
-    def self.get_login
-      getlogin()
-    end
-
-    # Returns a User object for the given name or uid. Raises an error
-    # if a user cannot be found.
-    #
-    # Examples:
-    #
-    #    Sys::Admin.get_user('joe')
-    #    Sys::Admin.get_user(501)
-    #
-    def self.get_user(uid)
-      if uid.is_a?(String)
-        pwd = PasswdStruct.new(getpwnam(uid))
-      else
-        pwd = PasswdStruct.new(getpwuid(uid))
-      end
-
-      if pwd.null?
-        raise Error, "no user found for: #{uid}"
-      end
-
-      user = User.new do |u|
-        u.name   = pwd[:pw_name]
-        u.passwd = pwd[:pw_passwd]
-        u.uid    = pwd[:pw_uid]
-        u.gid    = pwd[:pw_gid]
-        u.gecos  = pwd[:pw_gecos]
-        u.dir    = pwd[:pw_dir]
-        u.shell  = pwd[:pw_shell]
-      end
-
-      user
-    end
-
-    # Returns a Group object for the given name or uid. Raises an error
-    # if a group cannot be found.
-    #
-    # Examples:
-    #
-    #    Sys::Admin.get_group('admin')
-    #    Sys::Admin.get_group(101)
-    #
-    def self.get_group(gid)
-      if gid.is_a?(String)
-        grp = GroupStruct.new(getgrnam(gid))
-      else
-        grp = GroupStruct.new(getgrgid(gid))
-      end
-
-      if grp.null?
-        raise Error, "no group found for: #{gid}"
-      end
-
-      Group.new do |g|
-        g.name    = grp[:gr_name]
-        g.passwd  = grp[:gr_passwd]
-        g.gid     = grp[:gr_gid]
-        g.members = grp[:gr_mem].read_array_of_string
-      end
-    end
-
-    # Returns an array of User objects for each user on the system.
-    #
-    def self.users
-      users = []
-
-      begin
-        setpwent()
-
-        until (ptr = getpwent()).null?
-          pwd = PasswdStruct.new(ptr)
-          users << get_user_from_struct(pwd)
-        end
-      ensure
-        endpwent()
-      end
-
-      users
-    end
-
-    # Returns an array of Group objects for each user on the system.
-    #
-    def self.groups
-      groups = []
-
-      begin
-        setgrent()
-
-        until (ptr = getgrent()).null?
-          grp = GroupStruct.new(ptr)
-          groups << get_group_from_struct(grp)
-        end
-      ensure
-        endgrent()
-      end
-
-      groups
-    end
-
-    private
-
-    # Takes a GroupStruct and converts it to a Group object.
-    def self.get_group_from_struct(grp)
-      Group.new do |g|
-        g.name    = grp[:gr_name]
-        g.passwd  = grp[:gr_passwd]
-        g.gid     = grp[:gr_gid]
-        g.members = grp[:gr_mem].read_array_of_string
-      end
-    end
-
-    # Takes a UserStruct and converts it to a User object.
-    def self.get_user_from_struct(pwd)
-      user = User.new do |u|
-        u.name         = pwd[:pw_name]
-        u.passwd       = pwd[:pw_passwd]
-        u.uid          = pwd[:pw_uid]
-        u.gid          = pwd[:pw_gid]
-        u.gecos        = pwd[:pw_gecos]
-        u.dir          = pwd[:pw_dir]
-        u.shell        = pwd[:pw_shell]
-      end
-
-      user
-    end
-  end
-end
+require 'sys/admin/custom'
+require 'sys/admin/common'
+
+# Code used as a fallback for UNIX platforms.
+
+module Sys
+  class Admin
+    private
+
+    class PasswdStruct < FFI::Struct
+      layout(
+        :pw_name,   :string,
+        :pw_passwd, :string,
+        :pw_uid,    :uint,
+        :pw_gid,    :uint,
+        :pw_gecos,  :string,
+        :pw_dir,    :string,
+        :pw_shell,  :string
+      )
+    end
+
+    class GroupStruct < FFI::Struct
+      layout(
+        :gr_name,   :string,
+        :gr_passwd, :string,
+        :gr_gid,    :uint,
+        :gr_mem,    :pointer
+      )
+    end
+
+    public
+
+    # Returns the login for the current process.
+    #
+    def self.get_login
+      getlogin()
+    end
+
+    # Returns a User object for the given name or uid. Raises an error
+    # if a user cannot be found.
+    #
+    # Examples:
+    #
+    #    Sys::Admin.get_user('joe')
+    #    Sys::Admin.get_user(501)
+    #
+    def self.get_user(uid)
+      if uid.is_a?(String)
+        pwd = PasswdStruct.new(getpwnam(uid))
+      else
+        pwd = PasswdStruct.new(getpwuid(uid))
+      end
+
+      if pwd.null?
+        raise Error, "no user found for: #{uid}"
+      end
+
+      user = User.new do |u|
+        u.name   = pwd[:pw_name]
+        u.passwd = pwd[:pw_passwd]
+        u.uid    = pwd[:pw_uid]
+        u.gid    = pwd[:pw_gid]
+        u.gecos  = pwd[:pw_gecos]
+        u.dir    = pwd[:pw_dir]
+        u.shell  = pwd[:pw_shell]
+      end
+
+      user
+    end
+
+    # Returns a Group object for the given name or uid. Raises an error
+    # if a group cannot be found.
+    #
+    # Examples:
+    #
+    #    Sys::Admin.get_group('admin')
+    #    Sys::Admin.get_group(101)
+    #
+    def self.get_group(gid)
+      if gid.is_a?(String)
+        grp = GroupStruct.new(getgrnam(gid))
+      else
+        grp = GroupStruct.new(getgrgid(gid))
+      end
+
+      if grp.null?
+        raise Error, "no group found for: #{gid}"
+      end
+
+      Group.new do |g|
+        g.name    = grp[:gr_name]
+        g.passwd  = grp[:gr_passwd]
+        g.gid     = grp[:gr_gid]
+        g.members = grp[:gr_mem].read_array_of_string
+      end
+    end
+
+    # Returns an array of User objects for each user on the system.
+    #
+    def self.users
+      users = []
+
+      begin
+        setpwent()
+
+        until (ptr = getpwent()).null?
+          pwd = PasswdStruct.new(ptr)
+          users << get_user_from_struct(pwd)
+        end
+      ensure
+        endpwent()
+      end
+
+      users
+    end
+
+    # Returns an array of Group objects for each user on the system.
+    #
+    def self.groups
+      groups = []
+
+      begin
+        setgrent()
+
+        until (ptr = getgrent()).null?
+          grp = GroupStruct.new(ptr)
+          groups << get_group_from_struct(grp)
+        end
+      ensure
+        endgrent()
+      end
+
+      groups
+    end
+
+    private
+
+    # Takes a GroupStruct and converts it to a Group object.
+    def self.get_group_from_struct(grp)
+      Group.new do |g|
+        g.name    = grp[:gr_name]
+        g.passwd  = grp[:gr_passwd]
+        g.gid     = grp[:gr_gid]
+        g.members = grp[:gr_mem].read_array_of_string
+      end
+    end
+
+    # Takes a UserStruct and converts it to a User object.
+    def self.get_user_from_struct(pwd)
+      user = User.new do |u|
+        u.name         = pwd[:pw_name]
+        u.passwd       = pwd[:pw_passwd]
+        u.uid          = pwd[:pw_uid]
+        u.gid          = pwd[:pw_gid]
+        u.gecos        = pwd[:pw_gecos]
+        u.dir          = pwd[:pw_dir]
+        u.shell        = pwd[:pw_shell]
+      end
+
+      user
+    end
+  end
+end