getargv 0.2.0-universal-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa9f9e33b353a325306f9a0e9043e2a5ef348009400f35a7fdef753c5def98f2
+  data.tar.gz: d9bbd3910bc582adbc2e51d0b0f69e3af4455ae40608ca5f8ba42f277544cc29
+SHA512:
+  metadata.gz: e1725bda93c4a1164efaae25abb777ebb280516199e5a818a3b09aed577b839e325c1db482be76e56b5fc5b860f04bab28faf0b1970e5a85ea3d174931044a81
+  data.tar.gz: 9cd95a25e29d1a05b7ef5affdf5c430a1aeb195a7521e8bcea7793007bf5a92305f3a8ee93bc08513299df97cccb3ccd1b0c9da08d72cae20382a2012ce167a0

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+- Adjust platform in gemspec to allow any darwin plaftorm
+
+
+## [0.1.0] - 2022-12-31
+
+- Initial release
+- Very experimental at this point, API and gem spec not finalized

data/Gemfile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    getargv (0.2.0-universal-darwin)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.1)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.2)
+    minitest (5.17.0)
+    nokogiri (1.13.10-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.10-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    psych (5.0.1)
+      stringio
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rake-compiler (1.2.1)
+      rake
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.6.1)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    sdoc (2.5.0)
+      rdoc (>= 5.0)
+    solargraph (0.48.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    standard (1.21.1)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.42.0)
+      rubocop-performance (= 1.15.2)
+    stringio (3.0.4)
+    thor (1.2.1)
+    tilt (2.0.11)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-19
+  arm64-darwin-20
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-darwin-21
+  x86_64-darwin-22
+
+DEPENDENCIES
+  getargv!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rake-compiler
+  sdoc
+  solargraph
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, 2023
+Camden Narzt <getargv@narzt.cam>. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,38 @@
+<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)
+
+This gem allows you to query the arguments of other processes on macOS.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add getargv
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install getargv
+
+## Usage
+
+```ruby
+Getargv.get_argv_of_pid_as_string(some_process_id) #=> "arg0\x00arg1"
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/getargv/getargv_ruby.
+
+## License
+
+The gem is available as open source under the terms of the [BSD 3-clause License](https://opensource.org/licenses/BSD-3-Clause).

data/Rakefile

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+require "rake/extensiontask"
+
+task build: :compile
+
+Rake::ExtensionTask.new("getargv_ruby") do |ext|
+  ext.lib_dir = "lib/getargv_ruby"
+end
+
+task default: %i[clobber compile test standard]
+
+require "sdoc"
+require "rdoc/task"
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_dir = "doc"
+  rdoc.options << "--format=sdoc"
+  rdoc.template = "rails"
+  rdoc.rdoc_files.include("ext/*/*.c", "lib/*/*.rb", "lib/*.rb")
+end
+
+namespace :dev do
+  desc "generate a Makefile"
+  task :makefile do
+    ruby "ext/getargv_ruby/extconf.rb"
+  end
+  CLOBBER << "Makefile"
+
+  compilation_db_path = "ext/getargv_ruby/compile_commands.json"
+  desc "generate compilation database for language server"
+  task database: :makefile do
+    system "bear", "--output", compilation_db_path, "--", "make", "getargv_ruby.o"
+  end
+  CLOBBER << compilation_db_path
+end
+
+CLEAN.concat ["ext/getargv_ruby/.cache",
+  "getargv_ruby.o",
+  "mkmf.log"]

data/checksums/getargv-0.1.0-x86_64-darwin-21.gem.sha512

@@ -0,0 +1 @@
+a30f97e66431fa309d3f47e1d2241368de0a59332018c03e7c466120a96d1066dda83d322e01e0728fd3441290e3a3b34b32773d28c07297dd434cc8439004b8

data/ext/getargv_ruby/extconf.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+temporary_hack = "delete this line when https://github.com/testdouble/standard/pull/498 lands in a release" # rubocop:disable Lint/UselessAssignment
+
+def darwin_check
+  require "pathname"
+  src = $srcdir || __dir__ # standard:disable Style/GlobalVars
+  require_relative Pathname.new("#{src}/../../lib/getargv_ruby/version.rb").realpath.to_s
+  abort <<EOF unless RUBY_PLATFORM.include?("darwin")
+
+   getargv can only work on macOS, fix your Gemfile like this:
+
+   gem "getargv", "~> #{Getargv::VERSION}", platforms: :ruby, install_if: RbConfig::CONFIG["host_os"].include?("darwin")
+
+EOF
+end
+
+darwin_check
+arch_dir = RbConfig::CONFIG["rubyarchhdrdir"]
+# `xcode-select --print-path`/SDKs/MacOSX.sdk/System/Library/Frameworks/Ruby.framework/Versions/Current/Headers/ruby.h
+unless File.exist?(arch_dir)
+  arch_dir.sub!(RUBY_PLATFORM.split("-").last, Dir.entries(File.dirname(arch_dir)).reject { |d| d.start_with?(".", "ruby") }.first.split("-").last)
+end
+
+require "mkmf"
+
+unless have_library("getargv", "get_argv_of_pid", "libgetargv.h")
+  abort "libgetargv is missing, please install libgetargv."
+end
+
+create_makefile("getargv_ruby/getargv_ruby")

data/ext/getargv_ruby/getargv_ruby.c

@@ -0,0 +1,99 @@
+#include "getargv_ruby.h"
+
+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
+ *
+ *  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.
+ *
+ *  Getargv::get_argv_of_pid_as_string is an alias for Getargv::get_argv_of_pid.
+ *
+ *  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..."
+ */
+static VALUE ruby_get_argv_of_pid(int argc, VALUE *argv, VALUE self) {
+  rb_check_arity(argc, 1, 3);
+  Check_Type(argv[0], T_FIXNUM);
+  rb_pid_t pid = NUM2PIDT(argv[0]);
+  bool nuls = false;
+  uint skip = 0;
+
+  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]);
+  }
+
+  struct GetArgvOptions options = {.pid = pid, .skip = skip, .nuls = nuls};
+  struct ArgvResult result;
+  if (!get_argv_of_pid(&options, &result)) {
+    rb_sys_fail(0); // uses errno
+  }
+
+  // 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
+
+  return retVal;
+}
+
+/*
+ *  call-seq:
+ *     Getargv.get_argv_and_argc_of_pid(pid)             -> [String]
+ *     Getargv.get_argv_of_pid_as_array(pid)             -> [String]
+ *
+ *  Returns the arguments for the given process id as an array of strings.
+ *
+ *  Getargv::get_argv_of_pid_as_array is an alias for Getargv::get_argv_and_argc_of_pid.
+ *
+ *  Examples
+ *
+ *    Getargv.get_argv_and_argc_of_pid(Process.pid)      #=> ["ruby,"-e",...]
+ */
+static VALUE ruby_get_argv_and_argc_of_pid(VALUE self, VALUE rPid) {
+  Check_Type(rPid, T_FIXNUM);
+  rb_pid_t pid = NUM2PIDT(rPid);
+
+  struct ArgvArgcResult result;
+  if (!get_argv_and_argc_of_pid(pid, &result)) {
+    rb_sys_fail(0); // uses errno
+  }
+
+  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]));
+  }
+  // ruby copied data, can free buffers now
+  free(result.argv);
+  free(result.buffer);
+
+  return ary;
+}
+
+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_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");
+}

data/ext/getargv_ruby/getargv_ruby.h

@@ -0,0 +1,10 @@
+#ifndef GETARGV_RUBY_H
+#define GETARGV_RUBY_H 1
+
+#include "ruby.h"
+#include "ruby/intern.h"
+#include <libgetargv.h>
+#include <stddef.h>
+#include <sys/errno.h>
+
+#endif /* GETARGV_RUBY_H */

data/getargv_ruby.gemspec

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "yaml"
+require_relative "lib/getargv_ruby/version"
+ruby_version = YAML.load_file(".standard.yml")["ruby_version"]
+
+Gem::Specification.new do |spec|
+  spec.name = "getargv"
+  spec.version = Getargv::VERSION
+  spec.authors = ["Camden Narzt"]
+  spec.email = ["getargv@narzt.cam"]
+
+  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.
+  EOF
+  spec.homepage = "https://getargv.narzt.cam/"
+  spec.license = "BSD-3-Clause"
+  spec.required_ruby_version = ">= #{ruby_version}.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/getargv/getargv_ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/getargv/getargv_ruby/blob/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/getargv/getargv_ruby/issues"
+  spec.metadata["funding_uri"] = "https://github.com/sponsors/CamJN"
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/getargv/Getargv"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "ext"]
+  spec.extensions = ["ext/getargv_ruby/extconf.rb"]
+  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 << "--format=sdoc"
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/getargv_ruby/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Getargv
+  ##
+  # The version of the gem
+  VERSION = "0.2.0"
+end

data/lib/getargv_ruby.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "getargv_ruby/version"
+require_relative "getargv_ruby/getargv_ruby"
+
+##
+# This gem allows you to get the arguments of another process on macOS using a correct parsing algorithm.
+module Getargv
+end