bashisms 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ce103809b00b1eadaa9abe09774a096b5ed73afdb4bddbe348708dc66452ac3
+  data.tar.gz: 6784e05d427faa209c6bf986e4fd9e59f11744b0edf1dda12c484e8b519cb702
+SHA512:
+  metadata.gz: 79ebedd71a25a369256d683411d289bc1e12a90135736a2b831fc977492f2eeae82d5584f669db88eb250413101a58c8532e76cd83fa99b7bf6eca69d6b8d870
+  data.tar.gz: b068f5f2e5913016c94b6ab8b6adca4350bd6447177e386f6973ab0a44957e6d02c5ed3004a43770de95e7098a861486c4c43628b7b4bd31f4ddf945844016c0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"bashisms" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["john@hawthorn.email"](mailto:"john@hawthorn.email").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 John Hawthorn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# Bashisms
+
+Bash-style global variables and builtins for Ruby.
+
+```ruby
+gem "bashisms"
+```
+
+## safe_sleep
+
+Finally we're able to implement the venerable [`safe_sleep.sh`](https://github.com/actions/runner/blob/af6c8e6eddef233fdef862c1287d9b013c8aabff/src/Misc/layoutroot/safe_sleep.sh) in Ruby:
+
+```bash
+#!/bin/bash
+SECONDS=0
+while [[ $SECONDS != $1 ]]; do
+    :
+done
+```
+
+Now in Ruby, thanks to bashisms:
+
+```ruby
+require "bashisms"
+
+def safe_sleep n
+  $SECONDS = 0
+  while $SECONDS != n
+  end
+end
+```
+
+## Variables
+
+```ruby
+require "bashisms"
+
+$RANDOM    # => 16838
+$RANDOM    # => 4592
+
+$SECONDS   # => 0
+sleep 2
+$SECONDS   # => 2
+$SECONDS = 100
+$SECONDS   # => 100
+
+$EPOCHSECONDS  # => 1739404800
+$EPOCHREALTIME  # => 1739404800.123456
+
+$LINENO    # => 14
+
+$HOSTNAME  # => "myhost"
+$OSTYPE    # => "Linux"
+$MACHTYPE  # => "x86_64"
+$PPID      # => 1234
+$UID       # => 1000
+$EUID      # => 1000
+
+$BASH_VERSION  # => "4.1.2026(4.1.0)-release (ruby)"
+
+$IFS = ","
+"a,b,c".split  # => ["a", "b", "c"]
+
+$COLUMNS   # => 120
+$LINES     # => 40
+```
+
+## Builtins
+
+```ruby
+echo "hello world"
+
+source "./config.rb"
+
+export "FOO=bar"
+ENV["FOO"]  # => "bar"
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rake/extensiontask"
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("bashisms.gemspec")
+
+Rake::ExtensionTask.new("bashisms", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/bashisms"
+end
+
+task default: %i[clobber compile test]

data/ext/bashisms/bashisms.c

@@ -0,0 +1,174 @@
+#include "bashisms.h"
+#include <ruby/version.h>
+#include <time.h>
+#include <unistd.h>
+#include <sys/types.h>
+#include <sys/ioctl.h>
+#include <sys/utsname.h>
+
+VALUE rb_mBashisms;
+
+static struct timespec bashisms_start_time;
+
+/* $RANDOM: 0-32767, just like bash */
+static VALUE
+bashisms_random_getter(ID id, VALUE *data)
+{
+    return rb_funcall(rb_mKernel, rb_intern("rand"), 1, INT2FIX(32768));
+}
+
+static void
+bashisms_random_setter(VALUE val, ID id, VALUE *data)
+{
+    rb_funcall(rb_mKernel, rb_intern("srand"), 1, val);
+}
+
+/* $SECONDS: seconds since require "bashisms" */
+static VALUE
+bashisms_seconds_getter(ID id, VALUE *data)
+{
+    struct timespec now;
+    clock_gettime(CLOCK_MONOTONIC, &now);
+    long elapsed = now.tv_sec - bashisms_start_time.tv_sec;
+    return LONG2FIX(elapsed);
+}
+
+static void
+bashisms_seconds_setter(VALUE val, ID id, VALUE *data)
+{
+    long offset = NUM2LONG(val);
+    struct timespec now;
+    clock_gettime(CLOCK_MONOTONIC, &now);
+    bashisms_start_time.tv_sec = now.tv_sec - offset;
+    bashisms_start_time.tv_nsec = 0;
+}
+
+/* $EPOCHSECONDS: Unix timestamp as integer */
+static VALUE
+bashisms_epochseconds_getter(ID id, VALUE *data)
+{
+    struct timespec now;
+    clock_gettime(CLOCK_REALTIME, &now);
+    return LONG2FIX(now.tv_sec);
+}
+
+/* $EPOCHREALTIME: Unix timestamp with microseconds as float */
+static VALUE
+bashisms_epochrealtime_getter(ID id, VALUE *data)
+{
+    struct timespec now;
+    clock_gettime(CLOCK_REALTIME, &now);
+    double t = (double)now.tv_sec + (double)now.tv_nsec / 1000000000.0;
+    return DBL2NUM(t);
+}
+
+/* $HOSTNAME */
+static VALUE
+bashisms_hostname_getter(ID id, VALUE *data)
+{
+    char buf[256];
+    if (gethostname(buf, sizeof(buf)) == 0) {
+        buf[sizeof(buf) - 1] = '\0';
+        return rb_str_new_cstr(buf);
+    }
+    return rb_str_new_cstr("unknown");
+}
+
+/* $PPID: parent process ID */
+static VALUE
+bashisms_ppid_getter(ID id, VALUE *data)
+{
+    return PIDT2NUM(getppid());
+}
+
+/* $UID: real user ID */
+static VALUE
+bashisms_uid_getter(ID id, VALUE *data)
+{
+    return UIDT2NUM(getuid());
+}
+
+/* $EUID: effective user ID */
+static VALUE
+bashisms_euid_getter(ID id, VALUE *data)
+{
+    return UIDT2NUM(geteuid());
+}
+
+static VALUE
+bashisms_bash_version_getter(ID id, VALUE *data)
+{
+    char buf[256];
+    snprintf(buf, sizeof(buf), "4.1.2026(%s)-release (ruby)", ruby_version);
+    return rb_str_new_cstr(buf);
+}
+
+static VALUE
+bashisms_lineno_getter(ID id, VALUE *data)
+{
+    return INT2FIX(rb_sourceline());
+}
+
+static VALUE
+bashisms_ostype_getter(ID id, VALUE *data)
+{
+    struct utsname buf;
+    if (uname(&buf) == 0) {
+        return rb_str_new_cstr(buf.sysname);
+    }
+    return rb_str_new_cstr("unknown");
+}
+
+static VALUE
+bashisms_machtype_getter(ID id, VALUE *data)
+{
+    struct utsname buf;
+    if (uname(&buf) == 0) {
+        return rb_str_new_cstr(buf.machine);
+    }
+    return rb_str_new_cstr("unknown");
+}
+
+static VALUE
+bashisms_columns_getter(ID id, VALUE *data)
+{
+    struct winsize w;
+    if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &w) == 0 && w.ws_col > 0) {
+        return INT2FIX(w.ws_col);
+    }
+    return INT2FIX(80);
+}
+
+static VALUE
+bashisms_lines_getter(ID id, VALUE *data)
+{
+    struct winsize w;
+    if (ioctl(STDOUT_FILENO, TIOCGWINSZ, &w) == 0 && w.ws_row > 0) {
+        return INT2FIX(w.ws_row);
+    }
+    return INT2FIX(24);
+}
+
+RUBY_FUNC_EXPORTED void
+Init_bashisms(void)
+{
+    rb_mBashisms = rb_define_module("Bashisms");
+
+    clock_gettime(CLOCK_MONOTONIC, &bashisms_start_time);
+
+    rb_define_virtual_variable("$RANDOM", bashisms_random_getter, bashisms_random_setter);
+    rb_define_virtual_variable("$SECONDS", bashisms_seconds_getter, bashisms_seconds_setter);
+    rb_define_virtual_variable("$EPOCHSECONDS", bashisms_epochseconds_getter, NULL);
+    rb_define_virtual_variable("$EPOCHREALTIME", bashisms_epochrealtime_getter, NULL);
+    rb_define_virtual_variable("$HOSTNAME", bashisms_hostname_getter, NULL);
+    rb_define_virtual_variable("$PPID", bashisms_ppid_getter, NULL);
+    rb_define_virtual_variable("$UID", bashisms_uid_getter, NULL);
+    rb_define_virtual_variable("$EUID", bashisms_euid_getter, NULL);
+    rb_define_virtual_variable("$BASH_VERSION", bashisms_bash_version_getter, NULL);
+    rb_define_virtual_variable("$LINENO", bashisms_lineno_getter, NULL);
+    rb_alias_variable(rb_intern("$IFS"), rb_intern("$;"));
+    rb_define_virtual_variable("$OSTYPE", bashisms_ostype_getter, NULL);
+    rb_define_virtual_variable("$MACHTYPE", bashisms_machtype_getter, NULL);
+    rb_define_virtual_variable("$COLUMNS", bashisms_columns_getter, NULL);
+    rb_define_virtual_variable("$LINES", bashisms_lines_getter, NULL);
+}

data/ext/bashisms/bashisms.h

@@ -0,0 +1,6 @@
+#ifndef BASHISMS_H
+#define BASHISMS_H 1
+
+#include "ruby.h"
+
+#endif /* BASHISMS_H */

data/ext/bashisms/extconf.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+# Makes all symbols private by default to avoid unintended conflict
+# with other gems. To explicitly export symbols you can use RUBY_FUNC_EXPORTED
+# selectively, or entirely remove this flag.
+append_cflags("-fvisibility=hidden")
+
+create_makefile("bashisms/bashisms")

data/lib/bashisms/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Bashisms
+  VERSION = "0.1.0"
+end

data/lib/bashisms.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "bashisms/version"
+require "bashisms/bashisms"
+
+module Bashisms
+  class Error < StandardError; end
+end
+
+module Kernel
+  def echo(*args)
+    puts(*args)
+  end
+
+  def source(file)
+    load(file)
+  end
+
+  def export(pair)
+    key, value = pair.to_s.split("=", 2)
+    ENV[key] = value
+  end
+
+  private :echo, :source, :export
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: bashisms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Hawthorn
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Bash-style global variables and builtins for Ruby.
+email:
+- john@hawthorn.email
+executables: []
+extensions:
+- ext/bashisms/extconf.rb
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/bashisms/bashisms.c
+- ext/bashisms/bashisms.h
+- ext/bashisms/extconf.rb
+- lib/bashisms.rb
+- lib/bashisms/version.rb
+homepage: https://github.com/jhawthorn/bashisms
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/jhawthorn/bashisms
+  source_code_uri: https://github.com/jhawthorn/bashisms
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Bashisms for Ruby
+test_files: []