etc 1.4.2 → 1.4.4

data/ext/etc/etc.c

@@ -54,9 +54,9 @@ static VALUE sGroup;
 #  include <stdlib.h>
 # endif
 #endif
-char *getlogin();
+RUBY_EXTERN char *getlogin(void);
 
-#define RUBY_ETC_VERSION "1.4.2"
+#define RUBY_ETC_VERSION "1.4.4"
 
 #ifdef HAVE_RB_DEPRECATE_CONSTANT
 void rb_deprecate_constant(VALUE mod, const char *name);
@@ -66,6 +66,17 @@ void rb_deprecate_constant(VALUE mod, const char *name);
 
 #include "constdefs.h"
 
+#ifndef HAVE_RB_IO_DESCRIPTOR
+static int
+io_descriptor_fallback(VALUE io)
+{
+    rb_io_t *fptr;
+    GetOpenFile(io, fptr);
+    return fptr->fd;
+}
+#define rb_io_descriptor io_descriptor_fallback
+#endif
+
 #ifdef HAVE_RUBY_ATOMIC_H
 # include "ruby/atomic.h"
 #else
@@ -192,7 +203,7 @@ setup_passwd(struct passwd *pwd)
 #endif
 
 /* call-seq:
- *	getpwuid(uid)	->  Passwd
+ *	getpwuid(uid)	->  Etc::Passwd
  *
  * Returns the <tt>/etc/passwd</tt> information for the user with the given
  * integer +uid+.
@@ -204,7 +215,7 @@ setup_passwd(struct passwd *pwd)
  *
  * See the unix manpage for <code>getpwuid(3)</code> for more detail.
  *
- * === Example:
+ * *Example:*
  *
  *	Etc.getpwuid(0)
  *	#=> #<struct Etc::Passwd name="root", passwd="x", uid=0, gid=0, gecos="root",dir="/root", shell="/bin/bash">
@@ -232,7 +243,7 @@ etc_getpwuid(int argc, VALUE *argv, VALUE obj)
 }
 
 /* call-seq:
- *	getpwnam(name)	->  Passwd
+ *	getpwnam(name)	->  Etc::Passwd
  *
  * Returns the <tt>/etc/passwd</tt> information for the user with specified
  * login +name+.
@@ -241,7 +252,7 @@ etc_getpwuid(int argc, VALUE *argv, VALUE obj)
  *
  * See the unix manpage for <code>getpwnam(3)</code> for more detail.
  *
- * === Example:
+ * *Example:*
  *
  *	Etc.getpwnam('root')
  *	#=> #<struct Etc::Passwd name="root", passwd="x", uid=0, gid=0, gecos="root",dir="/root", shell="/bin/bash">
@@ -296,8 +307,8 @@ each_passwd(void)
 #endif
 
 /* call-seq:
- *	Etc.passwd { |struct| block }	->  Passwd
- *	Etc.passwd			->  Passwd
+ *	passwd { |struct| block }
+ *	passwd				->  Etc::Passwd
  *
  * Provides a convenient Ruby iterator which executes a block for each entry
  * in the <tt>/etc/passwd</tt> file.
@@ -306,7 +317,7 @@ each_passwd(void)
  *
  * See ::getpwent above for details.
  *
- * Example:
+ * *Example:*
  *
  *     require 'etc'
  *
@@ -332,7 +343,7 @@ etc_passwd(VALUE obj)
 }
 
 /* call-seq:
- *	Etc::Passwd.each { |struct| block }	->  Passwd
+ *	Etc::Passwd.each { |struct| block }	->  Etc::Passwd
  *	Etc::Passwd.each			->  Enumerator
  *
  * Iterates for each entry in the <tt>/etc/passwd</tt> file if a block is
@@ -344,7 +355,7 @@ etc_passwd(VALUE obj)
  *
  * See Etc.getpwent above for details.
  *
- * Example:
+ * *Example:*
  *
  *     require 'etc'
  *
@@ -366,7 +377,10 @@ etc_each_passwd(VALUE obj)
     return obj;
 }
 
-/* Resets the process of reading the <tt>/etc/passwd</tt> file, so that the
+/* call-seq:
+ *	setpwent
+ *
+ * Resets the process of reading the <tt>/etc/passwd</tt> file, so that the
  * next call to ::getpwent will return the first entry again.
  */
 static VALUE
@@ -378,7 +392,10 @@ etc_setpwent(VALUE obj)
     return Qnil;
 }
 
-/* Ends the process of scanning through the <tt>/etc/passwd</tt> file begun
+/* call-seq:
+ *	endpwent
+ *
+ * Ends the process of scanning through the <tt>/etc/passwd</tt> file begun
  * with ::getpwent, and closes the file.
  */
 static VALUE
@@ -390,7 +407,10 @@ etc_endpwent(VALUE obj)
     return Qnil;
 }
 
-/* Returns an entry from the <tt>/etc/passwd</tt> file.
+/* call-seq:
+ *	getpwent	->  Etc::Passwd
+ *
+ * Returns an entry from the <tt>/etc/passwd</tt> file.
  *
  * The first time it is called it opens the file and returns the first entry;
  * each successive call returns the next entry, or +nil+ if the end of the file
@@ -438,7 +458,7 @@ setup_group(struct group *grp)
 #endif
 
 /* call-seq:
- *	getgrgid(group_id)  ->	Group
+ *	getgrgid(group_id)  ->	Etc::Group
  *
  * Returns information about the group with specified integer +group_id+,
  * as found in <tt>/etc/group</tt>.
@@ -447,7 +467,7 @@ setup_group(struct group *grp)
  *
  * See the unix manpage for <code>getgrgid(3)</code> for more detail.
  *
- * === Example:
+ * *Example:*
  *
  *	Etc.getgrgid(100)
  *	#=> #<struct Etc::Group name="users", passwd="x", gid=100, mem=["meta", "root"]>
@@ -476,7 +496,7 @@ etc_getgrgid(int argc, VALUE *argv, VALUE obj)
 }
 
 /* call-seq:
- *	getgrnam(name)	->  Group
+ *	getgrnam(name)	->  Etc::Group
  *
  * Returns information about the group with specified +name+, as found in
  * <tt>/etc/group</tt>.
@@ -485,7 +505,7 @@ etc_getgrgid(int argc, VALUE *argv, VALUE obj)
  *
  * See the unix manpage for <code>getgrnam(3)</code> for more detail.
  *
- * === Example:
+ * *Example:*
  *
  *	Etc.getgrnam('users')
  *	#=> #<struct Etc::Group name="users", passwd="x", gid=100, mem=["meta", "root"]>
@@ -518,7 +538,6 @@ group_ensure(VALUE _)
     return Qnil;
 }
 
-
 static VALUE
 group_iterate(VALUE _)
 {
@@ -541,14 +560,18 @@ each_group(void)
 }
 #endif
 
-/* Provides a convenient Ruby iterator which executes a block for each entry
+/* call-seq:
+ *	group { |struct| block }
+ *	group				->  Etc::Group
+ *
+ * Provides a convenient Ruby iterator which executes a block for each entry
  * in the <tt>/etc/group</tt> file.
  *
  * The code block is passed an Group struct.
  *
  * See ::getgrent above for details.
  *
- * Example:
+ * *Example:*
  *
  *     require 'etc'
  *
@@ -575,7 +598,7 @@ etc_group(VALUE obj)
 
 #ifdef HAVE_GETGRENT
 /* call-seq:
- *	Etc::Group.each { |group| block }   ->	obj
+ *	Etc::Group.each { |group| block }   ->	Etc::Group
  *	Etc::Group.each			    ->	Enumerator
  *
  * Iterates for each entry in the <tt>/etc/group</tt> file if a block is
@@ -585,7 +608,7 @@ etc_group(VALUE obj)
  *
  * The code block is passed a Group struct.
  *
- * Example:
+ * *Example:*
  *
  *     require 'etc'
  *
@@ -606,7 +629,10 @@ etc_each_group(VALUE obj)
 }
 #endif
 
-/* Resets the process of reading the <tt>/etc/group</tt> file, so that the
+/* call-seq:
+ *	setgrent
+ *
+ * Resets the process of reading the <tt>/etc/group</tt> file, so that the
  * next call to ::getgrent will return the first entry again.
  */
 static VALUE
@@ -618,7 +644,10 @@ etc_setgrent(VALUE obj)
     return Qnil;
 }
 
-/* Ends the process of scanning through the <tt>/etc/group</tt> file begun
+/* call-seq:
+ *	endgrent
+ *
+ * Ends the process of scanning through the <tt>/etc/group</tt> file begun
  * by ::getgrent, and closes the file.
  */
 static VALUE
@@ -630,7 +659,10 @@ etc_endgrent(VALUE obj)
     return Qnil;
 }
 
-/* Returns an entry from the <tt>/etc/group</tt> file.
+/* call-seq:
+ *	getgrent	->  Etc::Group
+ *
+ * Returns an entry from the <tt>/etc/group</tt> file.
  *
  * The first time it is called it opens the file and returns the first entry;
  * each successive call returns the next entry, or +nil+ if the end of the file
@@ -659,9 +691,21 @@ etc_getgrent(VALUE obj)
 VALUE rb_w32_special_folder(int type);
 UINT rb_w32_system_tmpdir(WCHAR *path, UINT len);
 VALUE rb_w32_conv_from_wchar(const WCHAR *wstr, rb_encoding *enc);
+#elif defined(LOAD_RELATIVE)
+static inline VALUE
+rbconfig(void)
+{
+    VALUE config;
+    rb_require("rbconfig");
+    config = rb_const_get(rb_path2class("RbConfig"), rb_intern("CONFIG"));
+    Check_Type(config, T_HASH);
+    return config;
+}
 #endif
 
-/*
+/* call-seq:
+ *	sysconfdir	->  String
+ *
  * Returns system configuration directory.
  *
  * This is typically <code>"/etc"</code>, but is modified by the prefix used
@@ -676,12 +720,16 @@ etc_sysconfdir(VALUE obj)
 {
 #ifdef _WIN32
     return rb_w32_special_folder(CSIDL_COMMON_APPDATA);
+#elif defined(LOAD_RELATIVE)
+    return rb_hash_aref(rbconfig(), rb_str_new_lit("sysconfdir"));
 #else
     return rb_filesystem_str_new_cstr(SYSCONFDIR);
 #endif
 }
 
-/*
+/* call-seq:
+ *	systmpdir	->  String
+ *
  * Returns system temporary directory; typically "/tmp".
  */
 static VALUE
@@ -725,13 +773,15 @@ etc_systmpdir(VALUE _)
 }
 
 #ifdef HAVE_UNAME
-/*
+/* call-seq:
+ *	uname	-> hash
+ *
  * Returns the system information obtained by uname system call.
  *
  * The return value is a hash which has 5 keys at least:
  *   :sysname, :nodename, :release, :version, :machine
  *
- * Example:
+ * *Example:*
  *
  *   require 'etc'
  *   require 'pp'
@@ -841,7 +891,9 @@ etc_uname(VALUE obj)
 #endif
 
 #ifdef HAVE_SYSCONF
-/*
+/* call-seq:
+ *	sysconf(name)	->  Integer
+ *
  * Returns system configuration variable using sysconf().
  *
  * _name_ should be a constant under <code>Etc</code> which begins with <code>SC_</code>.
@@ -875,7 +927,9 @@ etc_sysconf(VALUE obj, VALUE arg)
 #endif
 
 #ifdef HAVE_CONFSTR
-/*
+/* call-seq:
+ *	confstr(name)	->  String
+ *
  * Returns system configuration variable using confstr().
  *
  * _name_ should be a constant under <code>Etc</code> which begins with <code>CS_</code>.
@@ -922,7 +976,9 @@ etc_confstr(VALUE obj, VALUE arg)
 #endif
 
 #ifdef HAVE_FPATHCONF
-/*
+/* call-seq:
+ *	pathconf(name)	->  Integer
+ *
  * Returns pathname configuration variable using fpathconf().
  *
  * _name_ should be a constant under <code>Etc</code> which begins with <code>PC_</code>.
@@ -941,14 +997,11 @@ io_pathconf(VALUE io, VALUE arg)
 {
     int name;
     long ret;
-    rb_io_t *fptr;
 
     name = NUM2INT(arg);
 
-    GetOpenFile(io, fptr);
-
     errno = 0;
-    ret = fpathconf(fptr->fd, name);
+    ret = fpathconf(rb_io_descriptor(io), name);
     if (ret == -1) {
         if (errno == 0) /* no limit */
             return Qnil;
@@ -1017,7 +1070,9 @@ etc_nprocessors_affin(void)
 }
 #endif
 
-/*
+/* call-seq:
+ *	nprocessors	->  Integer
+ *
  * Returns the number of online processors.
  *
  * The result is intended as the number of processes to
@@ -1027,7 +1082,7 @@ etc_nprocessors_affin(void)
  * - sched_getaffinity(): Linux
  * - sysconf(_SC_NPROCESSORS_ONLN): GNU/Linux, NetBSD, FreeBSD, OpenBSD, DragonFly BSD, OpenIndiana, Mac OS X, AIX
  *
- * Example:
+ * *Example:*
  *
  *   require 'etc'
  *   p Etc.nprocessors #=> 4
@@ -1036,7 +1091,7 @@ etc_nprocessors_affin(void)
  * process is bound to specific cpus. This is intended for getting better
  * parallel processing.
  *
- * Example: (Linux)
+ * *Example:* (Linux)
  *
  *   linux$ taskset 0x3 ./ruby -retc -e "p Etc.nprocessors"  #=> 2
  *
@@ -1086,7 +1141,7 @@ etc_nprocessors(VALUE obj)
  * The Etc module provides a more reliable way to access information about
  * the logged in user than environment variables such as +$USER+.
  *
- * == Example:
+ * *Example:*
  *
  *     require 'etc'
  *
@@ -1110,6 +1165,7 @@ Init_etc(void)
     RB_EXT_RACTOR_SAFE(true);
 #endif
     mEtc = rb_define_module("Etc");
+    /* The version */
     rb_define_const(mEtc, "VERSION", rb_str_new_cstr(RUBY_ETC_VERSION));
     init_constants(mEtc);
 

data/ext/etc/extconf.rb

@@ -43,13 +43,23 @@ have_struct_member('struct group', 'gr_passwd', 'grp.h')
 
 # for https://github.com/ruby/etc
 srcdir = File.expand_path("..", __FILE__)
-if !File.exist?("#{srcdir}/depend")
-  %x[#{RbConfig.ruby} #{srcdir}/mkconstants.rb -o #{srcdir}/constdefs.h]
+constdefs = "#{srcdir}/constdefs.h"
+if !File.exist?(constdefs)
+  ruby = RbConfig.ruby
+  if File.file?(ruby)
+    ruby = [ruby]
+  else
+    require "shellwords"
+    ruby = Shellwords.split(ruby)
+  end
+  system(*ruby, "#{srcdir}/mkconstants.rb", "-o", constdefs)
 end
 
 # TODO: remove when dropping 2.7 support, as exported since 3.0
 have_func('rb_deprecate_constant(Qnil, "None")')
 
+have_func("rb_io_descriptor")
+
 $distcleanfiles << "constdefs.h"
 
 create_makefile("etc")

data/ext/etc/mkconstants.rb

@@ -35,6 +35,12 @@ opt.def_option('-H FILE', 'specify output header file') {|filename|
 
 opt.parse!
 
+CONST_PREFIXES = {
+  'SC' => 'for Etc.sysconf; See <tt>man sysconf</tt>',
+  'CS' => 'for Etc.confstr; See <tt>man constr</tt>',
+  'PC' => 'for IO#pathconf; See <tt>man fpathconf</tt>',
+}
+
 h = {}
 COMMENTS = {}
 
@@ -49,6 +55,13 @@ DATA.each_line {|s|
     next
   end
   h[name] = default_value
+  if additional = CONST_PREFIXES[name[/\A_([A-Z]+)_/, 1]]
+    if comment&.match(/\w\z/)
+      comment << " " << additional
+    else
+      (comment ||= String.new) << " " << additional.sub(/\A\w/) {$&.upcase}
+    end
+  end
   COMMENTS[name] = comment if comment
 }
 DEFS = h.to_a
@@ -66,15 +79,11 @@ def each_name(pat)
   }
 end
 
-erb_new = lambda do |src, safe, trim|
-  if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
-    ERB.new(src, trim_mode: trim)
-  else
-    ERB.new(src, safe, trim)
-  end
+erb_new = lambda do |src, trim|
+  ERB.new(src, trim_mode: trim)
 end
 
-erb_new.call(<<'EOS', nil, '%').def_method(Object, "gen_const_decls")
+erb_new.call(<<'EOS', '%').def_method(Object, "gen_const_decls")
 % each_const {|name, default_value|
 #if !defined(<%=name%>)
 # if defined(HAVE_CONST_<%=name.upcase%>)
@@ -88,7 +97,7 @@ erb_new.call(<<'EOS', nil, '%').def_method(Object, "gen_const_decls")
 % }
 EOS
 
-erb_new.call(<<'EOS', nil, '%').def_method(Object, "gen_const_defs")
+erb_new.call(<<'EOS', '%').def_method(Object, "gen_const_defs")
 % each_const {|name, default_value|
 #if defined(<%=name%>)
 %   if comment = COMMENTS[name]
@@ -99,13 +108,13 @@ erb_new.call(<<'EOS', nil, '%').def_method(Object, "gen_const_defs")
 % }
 EOS
 
-header_result = erb_new.call(<<'EOS', nil, '%').result(binding)
+header_result = erb_new.call(<<'EOS', '%').result(binding)
 /* autogenerated file */
 
 <%= gen_const_decls %>
 EOS
 
-result = erb_new.call(<<'EOS', nil, '%').result(binding)
+result = erb_new.call(<<'EOS', '%').result(binding)
 /* autogenerated file */
 
 #ifdef HAVE_LONG_LONG
@@ -123,6 +132,9 @@ result = erb_new.call(<<'EOS', nil, '%').result(binding)
 static void
 init_constants(VALUE mod)
 {
+#if 0
+    mod = rb_define_module("Etc");
+#endif
 <%= gen_const_defs %>
 }
 EOS

data/test/etc/test_etc.rb

@@ -169,6 +169,10 @@ class TestEtc < Test::Unit::TestCase
     assert_operator(1, :<=, n)
   end
 
+  def test_sysconfdir
+    assert_operator(File, :absolute_path?, Etc.sysconfdir)
+  end if File.method_defined?(:absolute_path?)
+
   def test_ractor
     return unless Etc.passwd # => skip test if no platform support
     Etc.endpwent

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etc
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.4
 platform: ruby
 authors:
 - Yukihiro Matsumoto
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2024-11-01 00:00:00.000000000 Z
 dependencies: []
 description: Provides access to information typically stored in UNIX /etc directory.
 email:
@@ -24,14 +24,6 @@ extra_rdoc_files:
 - ext/etc/etc.c
 - ext/etc/extconf.rb
 - ext/etc/mkconstants.rb
-- logs/ChangeLog-1.0.0
-- logs/ChangeLog-1.0.1
-- logs/ChangeLog-1.1.0
-- logs/ChangeLog-1.2.0
-- logs/ChangeLog-1.3.0
-- logs/ChangeLog-1.3.1
-- logs/ChangeLog-1.4.0
-- logs/ChangeLog-1.4.1
 - test/etc/test_etc.rb
 files:
 - ChangeLog
@@ -41,21 +33,13 @@ files:
 - ext/etc/etc.c
 - ext/etc/extconf.rb
 - ext/etc/mkconstants.rb
-- logs/ChangeLog-1.0.0
-- logs/ChangeLog-1.0.1
-- logs/ChangeLog-1.1.0
-- logs/ChangeLog-1.2.0
-- logs/ChangeLog-1.3.0
-- logs/ChangeLog-1.3.1
-- logs/ChangeLog-1.4.0
-- logs/ChangeLog-1.4.1
 - test/etc/test_etc.rb
 homepage: https://github.com/ruby/etc
 licenses:
 - Ruby
 - BSD-2-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options:
 - "--main"
 - README.md
@@ -72,8 +56,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
-signing_key:
+rubygems_version: 3.5.11
+signing_key: 
 specification_version: 4
 summary: Provides access to information typically stored in UNIX /etc directory.
 test_files: []

data/logs/ChangeLog-1.0.0

@@ -1,65 +0,0 @@
--*- coding: utf-8 -*-
-
-commit 3402a9366fba4d2bf2f4ea20df16c95121876bc4
-  Author:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  AuthorDate: 2017-12-13 14:31:00 +0900
-  Commit:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  CommitDate: 2017-12-13 14:31:00 +0900
-
-    Bump release date
-
-commit be7fadb654340282ff71a500a47f88a0b4c47a1d
-  Author:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  AuthorDate: 2017-12-13 14:30:42 +0900
-  Commit:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  CommitDate: 2017-12-13 14:30:42 +0900
-
-    Added badge of Travis
-
-commit 97aca32b82f6cd8c309ae515e36d86c4d4822e4c
-  Author:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  AuthorDate: 2017-12-13 14:23:26 +0900
-  Commit:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  CommitDate: 2017-12-13 14:23:26 +0900
-
-    prepare to release 1.0.0
-
-commit 744646073bcd4e7c5b65ae5921cf4c1d5697e35e
-  Author:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  AuthorDate: 2017-11-28 12:17:10 +0900
-  Commit:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  CommitDate: 2017-11-28 12:20:44 +0900
-
-    Pick commits from ruby core repository.
-
-      * https://github.com/ruby/ruby/commit/0f7fed9253
-      * https://github.com/ruby/ruby/commit/8fc8587e05
-      * https://github.com/ruby/ruby/commit/1333c0f0df
-      * https://github.com/ruby/ruby/commit/e4ff51b05a
-      * https://github.com/ruby/ruby/commit/1852b4a866
-      * https://github.com/ruby/ruby/commit/b5b2bd86f1
-      * https://github.com/ruby/ruby/commit/253fd5fe6b
-
-commit 0e8f8547412d33a35752ef4272d78fc18cf3a5ed
-  Author:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  AuthorDate: 2017-10-20 16:51:22 +0900
-  Commit:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  CommitDate: 2017-10-20 16:51:22 +0900
-
-    Update README with rdoc of Etc module
-
-commit 86a04b45feed2bc88d44399e127ed675d5d0f41c
-  Author:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  AuthorDate: 2017-09-13 14:32:17 +0900
-  Commit:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  CommitDate: 2017-09-13 14:32:17 +0900
-
-    make frozen
-
-commit 91ce5d0039fe10d86b35a3c114fabb9a7ae86344
-  Author:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  AuthorDate: 2017-07-18 14:38:26 +0900
-  Commit:     SHIBATA Hiroshi <hsbt@ruby-lang.org>
-  CommitDate: 2017-07-18 14:38:26 +0900
-
-    fixed wrong license name