rubydex 0.1.0.beta11 → 0.1.0.beta13

data/ext/rubydex/document.c

@@ -1,98 +1,97 @@
-#include "document.h"
-#include "definition.h"
-#include "graph.h"
-#include "handle.h"
-#include "rustbindings.h"
-
-VALUE cDocument;
-
-// Document#uri -> String
-static VALUE rdxr_document_uri(VALUE self) {
-    HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
-    const char *uri = rdx_document_uri(graph, data->id);
-
-    if (uri == NULL) {
-        return Qnil;
-    }
-
-    VALUE str = rb_utf8_str_new_cstr(uri);
-    free_c_string(uri);
-
-    return str;
-}
-
-// Body function for rb_ensure in Document#definitions
-static VALUE document_definitions_yield(VALUE args) {
-    VALUE self = rb_ary_entry(args, 0);
-    void *iter = (void *)(uintptr_t)NUM2ULL(rb_ary_entry(args, 1));
-
-    HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    uint64_t id = 0;
-    DefinitionKind kind;
-    while (rdx_definitions_iter_next(iter, &id, &kind)) {
-        VALUE argv[] = {data->graph_obj, ULL2NUM(id)};
-        VALUE defn_class = rdxi_definition_class_for_kind(kind);
-        VALUE handle = rb_class_new_instance(2, argv, defn_class);
-        rb_yield(handle);
-    }
-
-    return Qnil;
-}
-
-// Ensure function for rb_ensure in Document#definitions to always free the iterator
-static VALUE document_definitions_ensure(VALUE args) {
-    void *iter = (void *)(uintptr_t)NUM2ULL(rb_ary_entry(args, 1));
-    rdx_definitions_iter_free(iter);
-
-    return Qnil;
-}
-
-// Size function for the Document#definitions enumerator
-static VALUE document_definitions_size(VALUE self, VALUE _args, VALUE _eobj) {
-    HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
-    struct DefinitionsIter *iter = rdx_document_definitions_iter_new(graph, data->id);
-    size_t len = rdx_definitions_iter_len(iter);
-    rdx_definitions_iter_free(iter);
-
-    return SIZET2NUM(len);
-}
-
-// Document#definitions: () -> Enumerator[Definition]
-// Returns an enumerator that yields all definitions for this document lazily
-static VALUE rdxr_document_definitions(VALUE self) {
-    if (!rb_block_given_p()) {
-        return rb_enumeratorize_with_size(self, rb_str_new2("definitions"), 0, NULL, document_definitions_size);
-    }
-
-    HandleData *data;
-    TypedData_Get_Struct(self, HandleData, &handle_type, data);
-
-    void *graph;
-    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
-    void *iter = rdx_document_definitions_iter_new(graph, data->id);
-    VALUE args = rb_ary_new_from_args(2, self, ULL2NUM((uintptr_t)iter));
-    rb_ensure(document_definitions_yield, args, document_definitions_ensure, args);
-
-    return self;
-}
-
-void rdxi_initialize_document(VALUE mRubydex) {
-    cDocument = rb_define_class_under(mRubydex, "Document", rb_cObject);
-
-    rb_define_alloc_func(cDocument, rdxr_handle_alloc);
-    rb_define_method(cDocument, "initialize", rdxr_handle_initialize, 2);
-    rb_define_method(cDocument, "uri", rdxr_document_uri, 0);
-    rb_define_method(cDocument, "definitions", rdxr_document_definitions, 0);
-
-    rb_funcall(rb_singleton_class(cDocument), rb_intern("private"), 1, ID2SYM(rb_intern("new")));
-}
+#include "document.h"
+#include "definition.h"
+#include "graph.h"
+#include "handle.h"
+#include "rustbindings.h"
+
+VALUE cDocument;
+
+// Document#uri -> String
+static VALUE rdxr_document_uri(VALUE self) {
+    HandleData *data;
+    TypedData_Get_Struct(self, HandleData, &handle_type, data);
+
+    void *graph;
+    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    const char *uri = rdx_document_uri(graph, data->id);
+
+    if (uri == NULL) {
+        return Qnil;
+    }
+
+    VALUE str = rb_utf8_str_new_cstr(uri);
+    free_c_string(uri);
+
+    return str;
+}
+
+// Body function for rb_ensure in Document#definitions
+static VALUE document_definitions_yield(VALUE args) {
+    VALUE self = rb_ary_entry(args, 0);
+    void *iter = (void *)(uintptr_t)NUM2ULL(rb_ary_entry(args, 1));
+
+    HandleData *data;
+    TypedData_Get_Struct(self, HandleData, &handle_type, data);
+
+    CDefinition defn;
+    while (rdx_definitions_iter_next(iter, &defn)) {
+        VALUE argv[] = {data->graph_obj, ULL2NUM(defn.id)};
+        VALUE defn_class = rdxi_definition_class_for_kind(defn.kind);
+        VALUE handle = rb_class_new_instance(2, argv, defn_class);
+        rb_yield(handle);
+    }
+
+    return Qnil;
+}
+
+// Ensure function for rb_ensure in Document#definitions to always free the iterator
+static VALUE document_definitions_ensure(VALUE args) {
+    void *iter = (void *)(uintptr_t)NUM2ULL(rb_ary_entry(args, 1));
+    rdx_definitions_iter_free(iter);
+
+    return Qnil;
+}
+
+// Size function for the Document#definitions enumerator
+static VALUE document_definitions_size(VALUE self, VALUE _args, VALUE _eobj) {
+    HandleData *data;
+    TypedData_Get_Struct(self, HandleData, &handle_type, data);
+
+    void *graph;
+    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    struct DefinitionsIter *iter = rdx_document_definitions_iter_new(graph, data->id);
+    size_t len = rdx_definitions_iter_len(iter);
+    rdx_definitions_iter_free(iter);
+
+    return SIZET2NUM(len);
+}
+
+// Document#definitions: () -> Enumerator[Definition]
+// Returns an enumerator that yields all definitions for this document lazily
+static VALUE rdxr_document_definitions(VALUE self) {
+    if (!rb_block_given_p()) {
+        return rb_enumeratorize_with_size(self, rb_str_new2("definitions"), 0, NULL, document_definitions_size);
+    }
+
+    HandleData *data;
+    TypedData_Get_Struct(self, HandleData, &handle_type, data);
+
+    void *graph;
+    TypedData_Get_Struct(data->graph_obj, void *, &graph_type, graph);
+    void *iter = rdx_document_definitions_iter_new(graph, data->id);
+    VALUE args = rb_ary_new_from_args(2, self, ULL2NUM((uintptr_t)iter));
+    rb_ensure(document_definitions_yield, args, document_definitions_ensure, args);
+
+    return self;
+}
+
+void rdxi_initialize_document(VALUE mRubydex) {
+    cDocument = rb_define_class_under(mRubydex, "Document", rb_cObject);
+
+    rb_define_alloc_func(cDocument, rdxr_handle_alloc);
+    rb_define_method(cDocument, "initialize", rdxr_handle_initialize, 2);
+    rb_define_method(cDocument, "uri", rdxr_document_uri, 0);
+    rb_define_method(cDocument, "definitions", rdxr_document_definitions, 0);
+
+    rb_funcall(rb_singleton_class(cDocument), rb_intern("private"), 1, ID2SYM(rb_intern("new")));
+}

data/ext/rubydex/document.h

@@ -1,10 +1,10 @@
-#ifndef RUBYDEX_DOCUMENT_H
-#define RUBYDEX_DOCUMENT_H
-
-#include "ruby.h"
-
-extern VALUE cDocument;
-
-void rdxi_initialize_document(VALUE mRubydex);
-
-#endif // RUBYDEX_DOCUMENT_H
+#ifndef RUBYDEX_DOCUMENT_H
+#define RUBYDEX_DOCUMENT_H
+
+#include "ruby.h"
+
+extern VALUE cDocument;
+
+void rdxi_initialize_document(VALUE mRubydex);
+
+#endif // RUBYDEX_DOCUMENT_H

data/ext/rubydex/extconf.rb

@@ -1,127 +1,146 @@
-# frozen_string_literal: true
-
-require "mkmf"
-require "pathname"
-
-unless system("cargo", "--version", out: File::NULL, err: File::NULL)
-  abort "Installing Rubydex requires Cargo, the Rust package manager for platforms that we do not precompile binaries."
-end
-
-gem_dir = Pathname.new("../..").expand_path(__dir__)
-release = ENV["RELEASE"] || !gem_dir.join(".git").exist?
-root_dir = gem_dir.join("rust")
-target_dir = root_dir.join("target")
-target_dir = target_dir.join("x86_64-pc-windows-gnu") if Gem.win_platform?
-target_dir = target_dir.join(release ? "release" : "debug")
-
-bindings_path = root_dir.join("rubydex-sys").join("rustbindings.h")
-
-cargo_args = ["--manifest-path #{root_dir.join("Cargo.toml")}"]
-cargo_args << "--release" if release
-
-if Gem.win_platform?
-  cargo_args << "--target x86_64-pc-windows-gnu"
-  ENV["RUSTFLAGS"] = "-C target-feature=+crt-static"
-end
-
-append_cflags("-Werror=unused-but-set-variable")
-append_cflags("-Werror=implicit-function-declaration")
-
-if Gem.win_platform?
-  $LDFLAGS << " #{target_dir.join("librubydex_sys.a")}"
-
-  # On Windows, statically link system libraries to avoid having to distribute and load DLLs
-  #
-  # These libraries are the ones informed by `cargo rustc -- --print native-static-libs`, which displays the
-  # libraries necessary for statically linking the Rust code on the current platform
-  ["kernel32", "ntdll", "userenv", "ws2_32", "dbghelp", "msvcrt"].each do |lib|
-    $LDFLAGS << " -l#{lib}"
-  end
-else
-  if RUBY_PLATFORM.include?("darwin")
-    # On the precompiled version of the gem, the `dylib` is one folder above the `.bundle/.so` file. For on machine
-    # compilation, they are at the same level
-    append_ldflags("-Wl,-rpath,@loader_path")
-    append_ldflags("-Wl,-rpath,@loader_path/..")
-  else
-    $LDFLAGS << " -Wl,-rpath,\\$$ORIGIN"
-    $LDFLAGS << " -Wl,-rpath,\\$$ORIGIN/.."
-  end
-
-  # We cannot use append_ldflags here because the Rust code is only compiled later. If it's not compiled yet, this will
-  # fail and the flag will not be added
-  $LDFLAGS << " -L#{target_dir} -lrubydex_sys"
-end
-
-create_makefile("rubydex/rubydex")
-
-cargo_command = if ENV["SANITIZER"]
-  ENV["RUSTFLAGS"] = "-Zsanitizer=#{ENV["SANITIZER"]}"
-  "cargo +nightly build -Zbuild-std #{cargo_args.join(" ")}".strip
-else
-  "cargo build #{cargo_args.join(" ")}".strip
-end
-
-lib_dir = gem_dir.join("lib").join("rubydex")
-
-copy_dylib_commands = if Gem.win_platform?
-  ""
-elsif RUBY_PLATFORM.include?("darwin")
-  src_dylib = target_dir.join("librubydex_sys.dylib")
-  "\t$(COPY) #{src_dylib} #{lib_dir}"
-else
-  # Linux
-  src_dylib = target_dir.join("librubydex_sys.so")
-  "\t$(COPY) #{src_dylib} #{lib_dir}"
-end
-
-rust_srcs = Dir.glob("#{root_dir}/**/*.rs").reject { |path| path.include?("rust/target") }
-makefile = File.read("Makefile")
-
-new_makefile = makefile.gsub("$(OBJS): $(HDRS) $(ruby_headers)", <<~MAKEFILE.chomp)
-  .PHONY: compile_rust
-  RUST_SRCS = #{File.expand_path("Cargo.toml", root_dir)} #{File.expand_path("Cargo.lock", root_dir)} #{rust_srcs.join(" ")}
-
-  .rust_built: $(RUST_SRCS)
-  \t#{cargo_command} || (echo "Compiling Rust failed" && exit 1)
-  \t$(COPY) #{bindings_path} #{__dir__}
-  \ttouch $@
-
-  compile_rust: .rust_built
-
-  $(OBJS): $(HDRS) $(ruby_headers) .rust_built
-MAKEFILE
-
-new_makefile.gsub!(/(\$\(Q\) \$\(LDSHARED\) .*)/, <<~MAKEFILE.chomp)
-  \\1
-  #{copy_dylib_commands}
-  \t$(Q)$(RM) .rust_built
-MAKEFILE
-
-# Bundle all dependency licenses when building a release version of the gem. This only has to happen on CI where we
-# precompile binaries. Oherwise, we're not redistributing the Rust dependencies as they are getting downloaded, compiled
-# and linked on the user's machine
-if release && system("cargo", "about", "--version", out: File::NULL, err: File::NULL)
-  licenses_file = root_dir.join("THIRD_PARTY_LICENSES.html")
-  about_config = root_dir.join("about.toml")
-  about_template = root_dir.join("about.hbs")
-
-  new_makefile.gsub!(".rust_built: $(RUST_SRCS)", <<~MAKEFILE.chomp)
-    #{licenses_file}: #{about_config} #{about_template}
-    \t$(Q)$(RM) #{licenses_file}
-    \tcargo about generate #{about_template} --manifest-path #{root_dir.join("Cargo.toml")} --workspace > #{licenses_file}
-    \t$(COPY) #{licenses_file} #{gem_dir}
-
-    .rust_built: $(RUST_SRCS) #{licenses_file}
-  MAKEFILE
-end
-
-File.write("Makefile", new_makefile)
-
-begin
-  require "extconf_compile_commands_json"
-
-  ExtconfCompileCommandsJson.generate!
-  ExtconfCompileCommandsJson.symlink!
-rescue LoadError # rubocop:disable Lint/SuppressedException
-end
+# frozen_string_literal: true
+
+require "mkmf"
+require "pathname"
+
+unless system("cargo", "--version", out: File::NULL, err: File::NULL)
+  abort "Installing Rubydex requires Cargo, the Rust package manager for platforms that we do not precompile binaries."
+end
+
+gem_dir = Pathname.new("../..").expand_path(__dir__)
+
+# Use release mode for the compilation if:
+# - The RELEASE environment variable is set
+# - We're not working on Rubydex (BUNDLE_GEMFILE doesn't point to Rubydex's own Gemfile)
+#
+# We only need debug builds when working on Rubydex itself and on CI. This approach also lets people install Rubydex
+# from the git source and get a release mode build
+
+bundle_gemfile = ENV["BUNDLE_GEMFILE"]
+developing_rubydex = bundle_gemfile && Pathname.new(bundle_gemfile).expand_path.dirname == gem_dir
+release = ENV["RELEASE"] || !developing_rubydex
+
+root_dir = gem_dir.join("rust")
+target_dir = root_dir.join("target")
+target_dir = target_dir.join("x86_64-pc-windows-gnu") if Gem.win_platform?
+target_dir = target_dir.join(release ? "release" : "debug")
+
+bindings_path = root_dir.join("rubydex-sys").join("rustbindings.h")
+
+cargo_args = ["--manifest-path #{root_dir.join("Cargo.toml")}"]
+cargo_args << "--release" if release
+
+if Gem.win_platform?
+  cargo_args << "--target x86_64-pc-windows-gnu"
+  ENV["RUSTFLAGS"] = "-C target-feature=+crt-static"
+end
+
+append_cflags("-Werror=unused-but-set-variable")
+append_cflags("-Werror=implicit-function-declaration")
+
+# There's an error on Windows with function pointer types not matching. This has been fixed and backported in Ruby, but
+# it seems that RubyInstaller sometimes picks an older patch version on CI and it breaks compilation. This isn't
+# actually a problem, so we're ignoring it temporarily only on Windows
+if Gem.win_platform? && RUBY_VERSION < "4.0"
+  append_cflags("-Wno-incompatible-pointer-types")
+end
+
+if Gem.win_platform?
+  $LDFLAGS << " #{target_dir.join("librubydex_sys.a")}"
+
+  # On Windows, statically link system libraries to avoid having to distribute and load DLLs
+  #
+  # These libraries are the ones informed by `cargo rustc -- --print native-static-libs`, which displays the
+  # libraries necessary for statically linking the Rust code on the current platform
+  ["kernel32", "ntdll", "userenv", "ws2_32", "dbghelp", "msvcrt"].each do |lib|
+    $LDFLAGS << " -l#{lib}"
+  end
+else
+  if RUBY_PLATFORM.include?("darwin")
+    # On the precompiled version of the gem, the `dylib` is one folder above the `.bundle/.so` file. For on machine
+    # compilation, they are at the same level
+    append_ldflags("-Wl,-rpath,@loader_path")
+    append_ldflags("-Wl,-rpath,@loader_path/..")
+  else
+    $LDFLAGS << " -Wl,-rpath,\\$$ORIGIN"
+    $LDFLAGS << " -Wl,-rpath,\\$$ORIGIN/.."
+  end
+
+  # We cannot use append_ldflags here because the Rust code is only compiled later. If it's not compiled yet, this will
+  # fail and the flag will not be added
+  $LDFLAGS << " -L#{target_dir} -lrubydex_sys"
+end
+
+create_makefile("rubydex/rubydex")
+
+cargo_command = if ENV["SANITIZER"]
+  ENV["RUSTFLAGS"] = "-Zsanitizer=#{ENV["SANITIZER"]}"
+  "cargo +nightly build -Zbuild-std #{cargo_args.join(" ")}".strip
+else
+  "cargo build #{cargo_args.join(" ")}".strip
+end
+
+lib_dir = gem_dir.join("lib").join("rubydex")
+
+copy_dylib_commands = if Gem.win_platform?
+  ""
+elsif RUBY_PLATFORM.include?("darwin")
+  src_dylib = target_dir.join("librubydex_sys.dylib")
+  "\t$(COPY) #{src_dylib} #{lib_dir}"
+else
+  # Linux
+  src_dylib = target_dir.join("librubydex_sys.so")
+  "\t$(COPY) #{src_dylib} #{lib_dir}"
+end
+
+rust_srcs = Dir.glob("#{root_dir}/**/*.rs").reject { |path| path.include?("rust/target") }
+makefile = File.read("Makefile")
+
+new_makefile = makefile.gsub("$(OBJS): $(HDRS) $(ruby_headers)", <<~MAKEFILE.chomp)
+  .PHONY: compile_rust
+  RUST_SRCS = #{File.expand_path("Cargo.toml", root_dir)} #{File.expand_path("Cargo.lock", root_dir)} #{rust_srcs.join(" ")}
+
+  .rust_built: $(RUST_SRCS)
+  \t#{cargo_command} || (echo "Compiling Rust failed" && exit 1)
+  \t$(COPY) #{bindings_path} #{__dir__}
+  \ttouch $@
+
+  compile_rust: .rust_built
+
+  $(OBJS): $(HDRS) $(ruby_headers) .rust_built
+MAKEFILE
+
+new_makefile.gsub!(/(\$\(Q\) \$\(LDSHARED\) .*)/, <<~MAKEFILE.chomp)
+  \\1
+  #{copy_dylib_commands}
+  \t$(Q)$(RM) .rust_built
+MAKEFILE
+
+# Bundle all dependency licenses when building a release version of the gem. This only has to happen on CI where we
+# precompile binaries. Oherwise, we're not redistributing the Rust dependencies as they are getting downloaded, compiled
+# and linked on the user's machine
+if release && system("cargo", "about", "--version", out: File::NULL, err: File::NULL)
+  licenses_file = root_dir.join("THIRD_PARTY_LICENSES.html")
+  about_config = root_dir.join("about.toml")
+  about_templates_dir = root_dir.join("about_templates")
+  template_deps = Dir.glob("#{about_templates_dir}/*.hbs").join(" ")
+
+  new_makefile.gsub!(".rust_built: $(RUST_SRCS)", <<~MAKEFILE.chomp)
+    #{licenses_file}: #{about_config} #{template_deps}
+    \t$(Q)$(RM) #{licenses_file}
+    \tcargo about generate #{about_templates_dir} --name about --manifest-path #{root_dir.join("Cargo.toml")} --workspace > #{licenses_file}
+    \t$(COPY) #{licenses_file} #{gem_dir}
+
+    .rust_built: $(RUST_SRCS) #{licenses_file}
+  MAKEFILE
+end
+
+File.write("Makefile", new_makefile)
+
+begin
+  require "extconf_compile_commands_json"
+
+  ExtconfCompileCommandsJson.generate!
+  ExtconfCompileCommandsJson.symlink!
+rescue LoadError # rubocop:disable Lint/SuppressedException
+end