getargv 0.2.0-universal-darwin → 0.3.0-universal-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa9f9e33b353a325306f9a0e9043e2a5ef348009400f35a7fdef753c5def98f2
-  data.tar.gz: d9bbd3910bc582adbc2e51d0b0f69e3af4455ae40608ca5f8ba42f277544cc29
+  metadata.gz: 2322eb1493c8417628f9bbad0992e5cf3e832a34288f696f3e0bdc3e89f013e9
+  data.tar.gz: 2cd45cb20c6f866e02870e5d2a31e5f47f66eb661a48943b304d2972d44d86bc
 SHA512:
-  metadata.gz: e1725bda93c4a1164efaae25abb777ebb280516199e5a818a3b09aed577b839e325c1db482be76e56b5fc5b860f04bab28faf0b1970e5a85ea3d174931044a81
-  data.tar.gz: 9cd95a25e29d1a05b7ef5affdf5c430a1aeb195a7521e8bcea7793007bf5a92305f3a8ee93bc08513299df97cccb3ccd1b0c9da08d72cae20382a2012ce167a0
+  metadata.gz: 9c25871ce6640727c3a65fc4ee1b4169cccf78561f663d4e8f89a119d5458e9e517fd400acbf8b82390c6820d1cd7b157be85f2ffe61a2802ea6faae38b6a62d
+  data.tar.gz: d569a6f6d9445c6b1612f9040b78c4e67d84bec93478f118cbf86897882693332b1ff11160c526a0ed2efd78218e7c1bdefc2eb00dafc49295bd241e71ada5a3

data/Gemfile

@@ -4,16 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in getargv_ruby.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rake-compiler"
-
-gem "minitest", "~> 5.0"
-
-gem "standard", "~> 1.3"
-
-group :development do
-  gem "solargraph"
-  gem "sdoc"
-end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    getargv (0.2.0-universal-darwin)
+    getargv (0.3.0-universal-darwin)
 
 GEM
   remote: https://rubygems.org/
@@ -19,9 +19,9 @@ GEM
       kramdown (~> 2.0)
     language_server-protocol (3.17.0.2)
     minitest (5.17.0)
-    nokogiri (1.13.10-arm64-darwin)
+    nokogiri (1.14.0-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.13.10-x86_64-darwin)
+    nokogiri (1.14.0-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.2.0.0)
@@ -33,6 +33,7 @@ GEM
     rake (13.0.6)
     rake-compiler (1.2.1)
       rake
+    rbs (2.8.3)
     rdoc (6.5.0)
       psych (>= 4.0.0)
     regexp_parser (2.6.1)
@@ -55,7 +56,7 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    sdoc (2.5.0)
+    sdoc (2.6.0)
       rdoc (>= 5.0)
     solargraph (0.48.0)
       backport (~> 1.2)
@@ -99,6 +100,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   rake (~> 13.0)
   rake-compiler
+  rbs
   sdoc
   solargraph
   standard (~> 1.3)

data/README.md

@@ -1,6 +1,7 @@
 <h1><img src="logo.svg" width="200" alt="getargv"></h1>
 
 [![Ruby](https://github.com/getargv/getargv_ruby/actions/workflows/main.yml/badge.svg)](https://github.com/getargv/getargv_ruby/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/getargv.svg)](https://badge.fury.io/rb/getargv)
 
 This gem allows you to query the arguments of other processes on macOS.
 
@@ -23,11 +24,11 @@ Getargv.get_argv_of_pid_as_array(some_process_id) #=> ["arg0","arg1"]
 
 ## Development
 
-In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/getargv_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
-
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Ruby code goes in the dir `lib/getargv_ruby`, C code goes in the dir `ext/getargv_ruby`.  To experiment with that code, run `bin/console` for an interactive prompt.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release[origin]`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/checksums/getargv-0.2.0-universal-darwin.gem.sha512

@@ -0,0 +1 @@
+d7dcae33d1dfb95fd4d27f42ee8b6cadafc4f33ccd3d4e35141e7f76f8c5e93bf9aa4180221646f39b802ab23ed4e979aeb6b23b67ca9e0be6813568de828838

data/ext/getargv_ruby/getargv_ruby.c

@@ -1,41 +1,44 @@
 #include "getargv_ruby.h"
 
+// https://ruby-doc.org/3.2.0/extension_rdoc.html
+
 VALUE rb_mGetargv;
 
 /*
- *  call-seq:
- *     Getargv.get_argv_of_pid(pid)                       -> String
- *     Getargv.get_argv_of_pid_as_string(pid)             -> String
- *     Getargv.get_argv_of_pid(pid, nuls)                 -> String
- *     Getargv.get_argv_of_pid_as_string(pid, nuls)       -> String
- *     Getargv.get_argv_of_pid(pid, nuls, skip)           -> String
- *     Getargv.get_argv_of_pid_as_string(pid, nuls, skip) -> String
+ * call-seq:
+ *     Getargv.get_argv_of_pid(pid, enc)                       -> String
+ *     Getargv.get_argv_of_pid_as_string(pid, enc)             -> String
+ *     Getargv.get_argv_of_pid(pid, enc, nuls)                 -> String
+ *     Getargv.get_argv_of_pid_as_string(pid, enc, nuls)       -> String
+ *     Getargv.get_argv_of_pid(pid, enc, nuls, skip)           -> String
+ *     Getargv.get_argv_of_pid_as_string(pid, enc, nuls, skip) -> String
  *
- *  Returns the arguments for the given process id as a string. If the second
- *  arg is true: replace nul separators with spaces for human consumption. If
- *  the third arg is provided, skip ahead the returned string by the given
- *  number of leading arguments.
+ * Returns the arguments for the given process id as a string with the
+ * specified encoding. If the third arg is +true+: replace +nul+ separators with
+ * +space+ for human consumption. If the fourth arg is provided, skip ahead the
+ * returned string by the given number of leading arguments.
  *
- *  Getargv::get_argv_of_pid_as_string is an alias for Getargv::get_argv_of_pid.
+ * Getargv::get_argv_of_pid_as_string is an alias for Getargv::get_argv_of_pid.
  *
- *  Examples
+ * === Examples:
  *
- *    Getargv.get_argv_of_pid(Process.pid)           #=> "ruby\x00-e..."
- *    Getargv.get_argv_of_pid(Process.pid(),true)    #=> "ruby -e..."
- *    Getargv.get_argv_of_pid(Process.pid(),false,1) #=> "-e..."
+ *    Getargv.get_argv_of_pid(Process.pid, Encoding.default_external)           #=> "ruby\x00-e..."
+ *    Getargv.get_argv_of_pid(Process.pid, Encoding.default_external, true)     #=> "ruby -e..."
+ *    Getargv.get_argv_of_pid(Process.pid, Encoding.default_external, false, 1) #=> "-e..."
  */
 static VALUE ruby_get_argv_of_pid(int argc, VALUE *argv, VALUE self) {
-  rb_check_arity(argc, 1, 3);
+  rb_check_arity(argc, 2, 4);
   Check_Type(argv[0], T_FIXNUM);
   rb_pid_t pid = NUM2PIDT(argv[0]);
   bool nuls = false;
   uint skip = 0;
+  rb_encoding *encoding = rb_to_encoding(argv[1]);
 
-  if (argc > 1)
-    nuls = RB_TEST(argv[1]);
-  if (argc > 2 && !NIL_P(argv[2])) {
-    Check_Type(argv[2], T_FIXNUM);
-    skip = NUM2UINT(argv[2]);
+  if (argc > 2)
+    nuls = RB_TEST(argv[2]);
+  if (argc > 3 && !NIL_P(argv[3])) {
+    Check_Type(argv[3], T_FIXNUM);
+    skip = NUM2UINT(argv[3]);
   }
 
   struct GetArgvOptions options = {.pid = pid, .skip = skip, .nuls = nuls};
@@ -45,30 +48,33 @@ static VALUE ruby_get_argv_of_pid(int argc, VALUE *argv, VALUE self) {
   }
 
   // assemble result ruby string, this copies :(
-  VALUE retVal = rb_str_new(result.start_pointer,
-                            1 + result.end_pointer - result.start_pointer);
-  free(result.buffer); // ruby copied data, can free buffer now
+  VALUE retVal =
+      rb_enc_str_new(result.start_pointer,
+                     1 + result.end_pointer - result.start_pointer, encoding);
+  free_ArgvResult(&result); // ruby copied data, can free buffer now
 
   return retVal;
 }
 
 /*
- *  call-seq:
- *     Getargv.get_argv_and_argc_of_pid(pid)             -> [String]
- *     Getargv.get_argv_of_pid_as_array(pid)             -> [String]
+ * call-seq:
+ *     Getargv.get_argv_and_argc_of_pid(pid, enc) -> [String]
+ *     Getargv.get_argv_of_pid_as_array(pid, enc) -> [String]
  *
- *  Returns the arguments for the given process id as an array of strings.
+ * Returns the arguments for the given process id as an array of strings with the specified encoding.
  *
- *  Getargv::get_argv_of_pid_as_array is an alias for Getargv::get_argv_and_argc_of_pid.
+ * Getargv::get_argv_of_pid_as_array is an alias for Getargv::get_argv_and_argc_of_pid.
  *
- *  Examples
+ * === Examples:
  *
- *    Getargv.get_argv_and_argc_of_pid(Process.pid)      #=> ["ruby,"-e",...]
+ *    Getargv.get_argv_and_argc_of_pid(Process.pid, Encoding.default_external) #=> ["ruby,"-e",...]
  */
-static VALUE ruby_get_argv_and_argc_of_pid(VALUE self, VALUE rPid) {
+static VALUE ruby_get_argv_and_argc_of_pid(VALUE self, VALUE rPid, VALUE enc) {
   Check_Type(rPid, T_FIXNUM);
   rb_pid_t pid = NUM2PIDT(rPid);
 
+  rb_encoding *encoding = rb_to_encoding(enc);
+
   struct ArgvArgcResult result;
   if (!get_argv_and_argc_of_pid(pid, &result)) {
     rb_sys_fail(0); // uses errno
@@ -77,11 +83,10 @@ static VALUE ruby_get_argv_and_argc_of_pid(VALUE self, VALUE rPid) {
   VALUE ary = rb_ary_new_capa(result.argc);
   for (size_t i = 0; i < result.argc; i++) {
     // assemble result ruby string, this copies :(
-    rb_ary_push(ary, rb_str_new_cstr(result.argv[i]));
+    rb_ary_push(ary, rb_enc_str_new_cstr(result.argv[i], encoding));
   }
   // ruby copied data, can free buffers now
-  free(result.argv);
-  free(result.buffer);
+  free_ArgvArgcResult(&result);
 
   return ary;
 }
@@ -90,10 +95,12 @@ void Init_getargv_ruby(void) {
   rb_mGetargv = rb_define_module("Getargv");
 
   rb_define_module_function(rb_mGetargv, "get_argv_of_pid", ruby_get_argv_of_pid, -1);
+
   // Getargv::get_argv_of_pid_as_string is an alias for Getargv::get_argv_of_pid.
-  rb_define_alias(rb_singleton_class(rb_mGetargv),  "get_argv_of_pid_as_string", "get_argv_of_pid");
+  rb_define_alias(rb_singleton_class(rb_mGetargv), "get_argv_of_pid_as_string", "get_argv_of_pid");
+
+  rb_define_module_function(rb_mGetargv, "get_argv_and_argc_of_pid", ruby_get_argv_and_argc_of_pid, 2);
 
-  rb_define_module_function(rb_mGetargv, "get_argv_and_argc_of_pid", ruby_get_argv_and_argc_of_pid, 1);
   // Getargv::get_argv_of_pid_as_array is an alias for Getargv::get_argv_and_argc_of_pid.
-  rb_define_alias(rb_singleton_class(rb_mGetargv),  "get_argv_of_pid_as_array", "get_argv_and_argc_of_pid");
+  rb_define_alias(rb_singleton_class(rb_mGetargv), "get_argv_of_pid_as_array", "get_argv_and_argc_of_pid");
 }

data/ext/getargv_ruby/getargv_ruby.h

@@ -2,7 +2,7 @@
 #define GETARGV_RUBY_H 1
 
 #include "ruby.h"
-#include "ruby/intern.h"
+#include "ruby/encoding.h"
 #include <libgetargv.h>
 #include <stddef.h>
 #include <sys/errno.h>

data/getargv_ruby.gemspec

@@ -12,15 +12,21 @@ Gem::Specification.new do |spec|
 
   spec.summary = "This gem allows you to query the arguments of other processes on macOS."
   spec.description = <<-EOF
-  Getargv is a gem that allows you to query the arguments of other processes as
-  an array or string. This gem only supports macOS because the KERN_PROCARGS2
-  sysctl only exists in xnu kernels, BSD or Linux users should just read
-  /proc/$PID/cmdline which is much easier and faster, Solaris users should use
-  pargs.
+  Getargv is a gem that allows you to query the arguments of other processes as an array or string.
+
+  This gem only supports macOS because the KERN_PROCARGS2 sysctl only exists in xnu kernels, BSD or Linux users should just read /proc/$PID/cmdline which is much easier and faster, Solaris users should use pargs.
+
+  This gem requires you have [libgetargv](https://getargv.narzt.cam/) installed.
+
+  To limit the getargv gem to Apple OSs add it to your Gemfile like so:
+
+  gem "getargv", "~> #{Getargv::VERSION}", platforms: :ruby, install_if: RbConfig::CONFIG["host_os"].include?("darwin")
   EOF
   spec.homepage = "https://getargv.narzt.cam/"
   spec.license = "BSD-3-Clause"
   spec.required_ruby_version = ">= #{ruby_version}.0"
+  spec.requirements << "macOS"
+  spec.requirements << "libgetargv installed"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/getargv/getargv_ruby"
@@ -43,11 +49,20 @@ Gem::Specification.new do |spec|
   spec.platform = "universal-darwin"
 
   spec.extra_rdoc_files = Dir["README.md", "ext/*/*.c", "lib/*/*.rb", "lib/*.rb"]
-  spec.rdoc_options << "-o" << "doc"
-  spec.rdoc_options << "-T" << "rails"
-  # spec.rdoc_options << "-T" << "direct"
-  # spec.rdoc_options << "-T" << "shtml"
+  spec.rdoc_options << "--output" << "doc"
   spec.rdoc_options << "--format=sdoc"
+  spec.rdoc_options << "--template=rails"
+  spec.rdoc_options << "--line-numbers"
+  spec.rdoc_options << "--inline-source"
+  spec.rdoc_options << "--exclude=ext/*/extconf.rb"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "standard", "~> 1.3"
+  spec.add_development_dependency "solargraph"
+  spec.add_development_dependency "sdoc"
+  spec.add_development_dependency "rbs"
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"

data/lib/getargv_ruby/version.rb

@@ -3,5 +3,5 @@
 module Getargv
   ##
   # The version of the gem
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/sig/getargv_ruby.rbs

@@ -1,4 +1,8 @@
+# See the writing guide of rbs: https://github.com/ruby/rbs#guides
 module Getargv
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  public def get_argv_and_argc_of_pid: (Integer pid) -> Array[String]
+  alias get_argv_of_pid_as_array get_argv_and_argc_of_pid
+  public def get_argv_of_pid: (Integer pid, ?boolish nuls, ?Integer skip) -> String
+  alias get_argv_of_pid_as_string get_argv_of_pid
 end

metadata

@@ -1,21 +1,123 @@
 --- !ruby/object:Gem::Specification
 name: getargv
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: universal-darwin
 authors:
 - Camden Narzt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-05 00:00:00.000000000 Z
-dependencies: []
+date: 2023-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  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: sdoc
+  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: rbs
+  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'
 description: |2
-    Getargv is a gem that allows you to query the arguments of other processes as
-    an array or string. This gem only supports macOS because the KERN_PROCARGS2
-    sysctl only exists in xnu kernels, BSD or Linux users should just read
-    /proc/$PID/cmdline which is much easier and faster, Solaris users should use
-    pargs.
+    Getargv is a gem that allows you to query the arguments of other processes as an array or string.
+
+    This gem only supports macOS because the KERN_PROCARGS2 sysctl only exists in xnu kernels, BSD or Linux users should just read /proc/$PID/cmdline which is much easier and faster, Solaris users should use pargs.
+
+    This gem requires you have [libgetargv](https://getargv.narzt.cam/) installed.
+
+    To limit the getargv gem to Apple OSs add it to your Gemfile like so:
+
+    gem "getargv", "~> 0.3.0", platforms: :ruby, install_if: RbConfig::CONFIG["host_os"].include?("darwin")
 email:
 - getargv@narzt.cam
 executables: []
@@ -35,6 +137,7 @@ files:
 - README.md
 - Rakefile
 - checksums/getargv-0.1.0-x86_64-darwin-21.gem.sha512
+- checksums/getargv-0.2.0-universal-darwin.gem.sha512
 - ext/getargv_ruby/extconf.rb
 - ext/getargv_ruby/getargv_ruby.c
 - ext/getargv_ruby/getargv_ruby.h
@@ -55,11 +158,13 @@ metadata:
   documentation_uri: https://rubydoc.info/gems/getargv/Getargv
 post_install_message:
 rdoc_options:
-- "-o"
+- "--output"
 - doc
-- "-T"
-- rails
 - "--format=sdoc"
+- "--template=rails"
+- "--line-numbers"
+- "--inline-source"
+- "--exclude=ext/*/extconf.rb"
 require_paths:
 - lib
 - ext
@@ -73,7 +178,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
+requirements:
+- macOS
+- libgetargv installed
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4