direct-bind 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50ced79cb992ea76c0be6b1935d914d985a2026c3066846f238a8b75102fe021
-  data.tar.gz: fa785de50c2b7d4fda46dfd5b6cbfded13a480eafd15d5dd3ad81c6d90a060fc
+  metadata.gz: ee80345a659c00cc5dc666e40baf81c76c0c42a08b7bc337ed75087ab0d1514f
+  data.tar.gz: ce718f097ba34a0858f1765bf475eeda66296af4f1fe12f5441ffdf4e1557177
 SHA512:
-  metadata.gz: 45f73729515bcd061b2d363dbbe14944238abfe1098b8d5eb16da8ecb81594a4937b75da89308d6598f08565318ac68238401a7f4f02891b36fdd592bcfe24d2
-  data.tar.gz: 39fd3358e2be05a370ec0e30e9dca8a75b8635e46fa372afb1dbe721c1ddc98c747002404060f20245a642a3d658db0d673a535ebc57bc8610d03773569a8359
+  metadata.gz: 0357cc24a731f4a3ec624211deaa743009a432e996339bd4bb0d8a2322ee1d4feca27a728f1f08e16a416c50180dbaa869c0a6a53c0661f1c6ff83fc597a3bb1
+  data.tar.gz: 3527f022c312154c455ca4220a694531427dbf08f0bd436c63005f1823e7c60c0bb300d531dd4f71d0e808f52e23e0c71dbf698141ed9038ecb4885f15084a9e

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/direct-bind.gemspec

@@ -42,10 +42,9 @@ Gem::Specification.new do |spec|
   # 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|examples)/|\.(?:git|travis|circleci)|appveyor)}) ||
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|examples|ext)/|\.(?:git|travis|circleci)|appveyor)}) ||
         [".editorconfig", ".ruby-version", ".standard.yml", "gems.rb", "Rakefile"].include?(f)
     end
   end
-  spec.require_paths = ["lib", "ext"]
-  spec.extensions = ["ext/direct_bind_native_extension/extconf.rb"]
+  spec.require_paths = ["lib"]
 end

data/{ext/direct_bind_native_extension/direct_bind.c → dist/direct-bind.c}

@@ -23,7 +23,23 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-#include "direct_bind.h"
+// See direct-bind.h for details on using direct-bind and why you may be finding this file vendored inside another gem.
+
+#include "direct-bind.h"
+
+static bool direct_bind_self_test(bool raise_on_failure);
+
+// # Initialization and version management
+
+bool direct_bind_initialize(VALUE publish_version_under, bool raise_on_failure) {
+  if (!direct_bind_self_test(raise_on_failure)) return false;
+
+  if (publish_version_under != Qnil) {
+    rb_define_const(rb_define_module_under(publish_version_under, "DirectBind"), "VERSION", rb_str_new_lit(DIRECT_BIND_VERSION));
+  }
+
+  return true;
+}
 
 // # Self-test implementation
 
@@ -38,16 +54,14 @@ static VALUE self_test_target_func(
   return Qnil;
 }
 
-bool direct_bind_self_test(bool raise_on_failure) {
+static bool direct_bind_self_test(bool raise_on_failure) {
   VALUE anonymous_module = rb_module_new();
   rb_define_method(anonymous_module, "direct_bind_self_test_target", self_test_target_func, SELF_TEST_ARITY);
 
   ID self_test_id = rb_intern("direct_bind_self_test_target");
-  direct_bind_cfunc_result test_target = direct_bind_get_cfunc(anonymous_module, self_test_id, raise_on_failure);
+  direct_bind_cfunc_result test_target = direct_bind_get_cfunc_with_arity(anonymous_module, self_test_id, SELF_TEST_ARITY, raise_on_failure);
 
-  if (!test_target.ok) return false;
-
-  return test_target.arity == SELF_TEST_ARITY && test_target.func == self_test_target_func;
+  return test_target.ok && test_target.func == self_test_target_func;
 }
 
 // # Structure layouts and exported symbol definitions from Ruby
@@ -101,6 +115,19 @@ direct_bind_cfunc_result direct_bind_get_cfunc(VALUE klass, ID method_name, bool
   return find_data.result;
 }
 
+direct_bind_cfunc_result direct_bind_get_cfunc_with_arity(VALUE klass, ID method_name, int arity, bool raise_on_failure) {
+  direct_bind_cfunc_result result = direct_bind_get_cfunc(klass, method_name, raise_on_failure);
+
+  if (result.ok && result.arity != arity) {
+    VALUE unexpected_arity = rb_sprintf("method %"PRIsVALUE".%"PRIsVALUE" unexpected arity %d, expected %d", klass, ID2SYM(method_name), result.arity, arity);
+
+    if (raise_on_failure) rb_raise(rb_eRuntimeError, "direct_bind_get_cfunc_with_arity failed: %"PRIsVALUE, unexpected_arity);
+    else result = (direct_bind_cfunc_result) {.ok = false, .failure_reason = unexpected_arity};
+  }
+
+  return result;
+}
+
 // TODO: Maybe change this to use safe memory reads that can never segv (e.g. if structure layouts are off?)
 static int find_cfunc(void *start, void *end, size_t stride, void *data) {
   const int stop_iteration = 1;

data/{ext/direct_bind_native_extension/direct_bind.h → dist/direct-bind.h}

@@ -23,11 +23,22 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
+// The recommended way to consume the direct-bind gem is to always vendor it.
+// That is, use its rake task to automatically copy direct-bind.h and direct-bind.c into another gem's native extension
+// sources folder. (P.s.: There's also a test helper to make sure copying is working fine and the gem is up-to-date.)
+//
+// This makes the actual Ruby direct-bind gem only a development dependency, simplifying distribution for the gem
+// that uses it.
+//
+// For more details, check the direct-bind gem's documentation.
+
 #pragma once
 
 #include <stdbool.h>
 #include <ruby.h>
 
+#define DIRECT_BIND_VERSION "1.0.0"
+
 typedef struct {
   bool ok;
   VALUE failure_reason;
@@ -35,8 +46,9 @@ typedef struct {
   VALUE (*func)(ANYARGS);
 } direct_bind_cfunc_result;
 
-// Recommended to call once during your gem's initialization, to validate that direct-bind's Ruby hacking is in good shape.
-bool direct_bind_self_test(bool raise_on_failure);
+// Recommended to call once during your gem's initialization, to validate that direct-bind's Ruby hacking is in good shape and
+// to make it easy to (optionally) validate what version you're using
+bool direct_bind_initialize(VALUE publish_version_under, bool raise_on_failure);
 
 // Provides the reverse of `rb_define_method`: Given a class and a method_name, retrieves the arity and func previously
 // passed to `rb_define_method`.
@@ -44,3 +56,6 @@ bool direct_bind_self_test(bool raise_on_failure);
 // Performance note: As of this writing, this method scans objspace to find the definition of the method, so you
 // most probably want to cache its result, rather than calling it very often.
 direct_bind_cfunc_result direct_bind_get_cfunc(VALUE klass, ID method_name, bool raise_on_failure);
+
+// Same as above, but automatically fails if arity isn't the expected value
+direct_bind_cfunc_result direct_bind_get_cfunc_with_arity(VALUE klass, ID method_name, int arity, bool raise_on_failure);

data/lib/direct-bind.rb

@@ -27,7 +27,5 @@
 
 require_relative "direct_bind/version"
 
-require "direct_bind_native_extension"
-
 module DirectBind
 end

data/lib/direct_bind/rake.rb

@@ -0,0 +1,58 @@
+# direct-bind: Ruby gem for getting direct access to function pointers
+# Copyright (c) 2025 Ivo Anjo <ivo@ivoanjo.me>
+#
+# This file is part of direct-bind.
+#
+# MIT License
+#
+# 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.
+
+# frozen_string_literal: true
+
+require "rake"
+require "rake/tasklib"
+
+module DirectBind
+  module Rake
+    class InstallTask < ::Rake::TaskLib
+      DIRECT_BIND_SOURCES = ["direct-bind.h", "direct-bind.c"]
+      DIRECT_BIND_SOURCES_PATH = File.join(Gem.loaded_specs["direct-bind"].full_gem_path, "dist")
+
+      def initialize(extension_name)
+        target_extension_path = File.join(Dir.pwd, "ext", extension_name)
+
+        desc "Install direct_bind files into extension"
+        task(:"direct-bind:install") do
+          DIRECT_BIND_SOURCES.each do |file_name|
+            from_path = File.join(DIRECT_BIND_SOURCES_PATH, file_name)
+            to_path = File.join(target_extension_path, file_name)
+
+            FileUtils.cp(from_path, to_path) unless already_up_to_date?(from_path, to_path)
+          end
+        end
+      end
+
+      private
+
+      def already_up_to_date?(file1, file2) # Order doesn't really matter here
+        File.exist?(file1) && File.exist?(file2) && FileUtils.compare_file(file1, file2)
+      end
+    end
+  end
+end

data/{ext/direct_bind_native_extension/extconf.rb → lib/direct_bind/rspec_helper.rb}

@@ -23,24 +23,17 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-if ["jruby", "truffleruby"].include?(RUBY_ENGINE)
-  raise \
-    "\n#{"-" * 80}\nSorry! This gem is unsupported on #{RUBY_ENGINE}. Since it relies on a lot of guts of MRI Ruby, " \
-    "it's impossible to make a direct port.\n" \
-    "Perhaps a #{RUBY_ENGINE} equivalent could be created -- help is welcome! :)\n#{"-" * 80}"
-end
+# frozen_string_literal: true
 
-require "mkmf"
+require "direct-bind"
+require "rspec/expectations"
 
-append_cflags("-std=gnu99")
-append_cflags("-Wno-declaration-after-statement")
-append_cflags("-Wno-compound-token-split-by-macro")
-append_cflags("-Werror-implicit-function-declaration")
-append_cflags("-Wunused-parameter")
-append_cflags("-Wold-style-definition")
-append_cflags("-Wall")
-append_cflags("-Wextra")
-append_cflags("-Werror") if ENV["ENABLE_WERROR"] == "true"
+module DirectBind
+  module RSpecHelper
+    self.class.include RSpec::Matchers
 
-create_header
-create_makefile "direct_bind_native_extension"
+    def self.expect_direct_bind_version_to_be_up_to_date_in(native_extension_module)
+      expect(native_extension_module::DirectBind::VERSION).to eq ::DirectBind::VERSION
+    end
+  end
+end

data/lib/direct_bind/version.rb

@@ -26,5 +26,6 @@
 # frozen_string_literal: true
 
 module DirectBind
-  VERSION = "0.1.1"
+  # Must be kept in sync with the VERSION in `dist/direct-bind.h` (and there's a test for it)
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: direct-bind
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ivo Anjo
@@ -12,19 +12,19 @@ dependencies: []
 email:
 - ivo@ivoanjo.me
 executables: []
-extensions:
-- ext/direct_bind_native_extension/extconf.rb
+extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - CODE_OF_CONDUCT.adoc
 - LICENSE
 - README.adoc
 - direct-bind.gemspec
-- ext/direct_bind_native_extension/direct_bind.c
-- ext/direct_bind_native_extension/direct_bind.h
-- ext/direct_bind_native_extension/direct_bind_native_extension.c
-- ext/direct_bind_native_extension/extconf.rb
+- dist/direct-bind.c
+- dist/direct-bind.h
 - lib/direct-bind.rb
+- lib/direct_bind/rake.rb
+- lib/direct_bind/rspec_helper.rb
 - lib/direct_bind/version.rb
 homepage: https://github.com/ivoanjo/direct-bind
 licenses:
@@ -33,7 +33,6 @@ metadata: {}
 rdoc_options: []
 require_paths:
 - lib
-- ext
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/ext/direct_bind_native_extension/direct_bind_native_extension.c

@@ -1,41 +0,0 @@
-// direct-bind: Ruby gem for getting direct access to function pointers
-// Copyright (c) 2025 Ivo Anjo <ivo@ivoanjo.me>
-//
-// This file is part of direct-bind.
-//
-// MIT License
-//
-// 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.
-
-#include "direct_bind.h"
-
-VALUE direct_bind_call(VALUE _self, VALUE klass, VALUE method, VALUE instance);
-
-void Init_direct_bind_native_extension(void) {
-  direct_bind_self_test(true);
-
-  VALUE direct_bind_module = rb_define_module("DirectBind");
-  rb_define_singleton_method(direct_bind_module, "call", direct_bind_call, 3);
-}
-
-VALUE direct_bind_call(__attribute__((unused)) VALUE _self, VALUE klass, VALUE method, VALUE instance) {
-  direct_bind_cfunc_result result = direct_bind_get_cfunc(klass, SYM2ID(method), true);
-  if (result.arity != 0) rb_raise(rb_eArgError, "Unexpected arity on cfunc: %d", result.arity);
-  return ((VALUE (*)(VALUE)) result.func)(instance);
-}