prism 0.17.1 → 0.18.0

data/ext/prism/extconf.rb

@@ -1,136 +1,100 @@
 # frozen_string_literal: true
 
-require "rbconfig"
+if ARGV.delete("--help")
+  print(<<~TEXT)
+    USAGE: ruby #{$PROGRAM_NAME} [options]
+
+      Flags that are always valid:
+
+          --enable-debug-mode-build
+              Enable debug mode build.
+              You may also use set PRISM_DEBUG_MODE_BUILD environment variable.
+
+          --help
+              Display this message.
+
+      Environment variables used:
 
-module Prism
-  module ExtConf
-    class << self
-      def configure
-        unless RUBY_ENGINE == "ruby"
-          # On non-CRuby we only need the shared library, so build only that and not the C extension.
-          # We also avoid `require "mkmf"` as that prepends the LLVM toolchain to PATH on TruffleRuby,
-          # but we want to use the native toolchain here since librubyparser is run natively.
-          build_shared_rubyparser
-          File.write("Makefile", "all install clean:\n\t@#{RbConfig::CONFIG["NULLCMD"]}\n")
-          return
-        end
-
-        require "mkmf"
-        configure_c_extension
-        configure_rubyparser
-
-        create_makefile("prism/prism")
-
-        if static_link?
-          File.open('Makefile', 'a') do |mf|
-            mf.puts
-            mf.puts '# Automatically rebuild the extension if librubyparser.a changed'
-            mf.puts '$(TARGET_SO): $(LOCAL_LIBS)'
-          end
-        end
-      end
-
-      def configure_c_extension
-        append_cflags("-DPRISM_DEBUG_MODE_BUILD") if debug_mode_build?
-        append_cflags("-fvisibility=hidden")
-      end
-
-      def configure_rubyparser
-        if static_link?
-          static_archive_path = File.join(build_dir, "librubyparser.a")
-          unless File.exist?(static_archive_path)
-            build_static_rubyparser
-          end
-          $LOCAL_LIBS << " #{static_archive_path}"
-        else
-          shared_library_path = File.join(build_dir, "librubyparser.#{RbConfig::CONFIG["SOEXT"]}")
-          unless File.exist?(shared_library_path)
-            build_shared_rubyparser
-          end
-          unless find_library("rubyparser", "pm_parser_init", build_dir)
-            raise "could not link against #{File.basename(shared_library_path)}"
-          end
-        end
-
-        find_header("prism.h", include_dir) or raise "prism.h is required"
-
-        # Explicitly look for the extension header in the parent directory
-        # because we want to consistently look for prism/extension.h in our
-        # source files to line up with our mirroring in CRuby.
-        find_header("prism/extension.h", File.join(__dir__, "..")) or raise "prism/extension.h is required"
-      end
-
-      def build_shared_rubyparser
-        build_target_rubyparser "build/librubyparser.#{RbConfig::CONFIG["SOEXT"]}"
-      end
-
-      def build_static_rubyparser
-        build_target_rubyparser "build/librubyparser.a"
-      end
-
-      def build_target_rubyparser(target)
-        Dir.chdir(root_dir) do
-          if !File.exist?("include/prism/ast.h") && Dir.exist?(".git")
-            # this block only exists to support building the gem from a "git" source,
-            # normally we package up the configure and other files in the gem itself
-            system("templates/template.rb", exception: true)
-          end
-          system("make", target, exception: true)
-        end
-      end
-
-      def root_dir
-        File.expand_path("../..", __dir__)
-      end
-
-      def include_dir
-        File.join(root_dir, "include")
-      end
-
-      def build_dir
-        File.join(root_dir, "build")
-      end
-
-      def print_help
-        print(<<~TEXT)
-          USAGE: ruby #{$PROGRAM_NAME} [options]
-
-            Flags that are always valid:
-
-                --enable-static
-                --disable-static
-                    Enable or disable static linking against librubyparser.
-                    The default is to statically link.
-
-                --enable-debug-mode-build
-                    Enable debug mode build.
-                    You may also use set PRISM_DEBUG_MODE_BUILD environment variable.
-
-                --help
-                    Display this message.
-
-            Environment variables used:
-
-                PRISM_DEBUG_MODE_BUILD
-                    Equivalent to `--enable-debug-mode-build` when set, even if nil or blank.
-
-        TEXT
-      end
-
-      def static_link?
-        enable_config("static", true)
-      end
-
-      def debug_mode_build?
-        enable_config("debug-mode-build", ENV["PRISM_DEBUG_MODE_BUILD"] || false)
-      end
+          PRISM_DEBUG_MODE_BUILD
+              Equivalent to `--enable-debug-mode-build` when set, even if nil or blank.
+
+  TEXT
+  exit!(0)
+end
+
+# Runs `make` in the root directory of the project. Note that this is the
+# `Makefile` for the overall project, not the `Makefile` that is being generated
+# by this script.`
+def make(target)
+  Dir.chdir(File.expand_path("../..", __dir__)) do
+    # If this gem is being build from a git source, then we need to run
+    # templating if it hasn't been run yet. In normal packaging, we would have
+    # shipped the templated files with the gem, so this wouldn't be necessary.
+    if !File.exist?("include/prism/ast.h") && Dir.exist?(".git")
+      system("templates/template.rb", exception: true)
     end
+
+    system("make", target, exception: true)
   end
 end
 
-if ARGV.delete("--help")
-  Prism::ExtConf.print_help
-  exit!(0)
+require "rbconfig"
+
+# On non-CRuby we only need the shared library since we'll interface with it
+# through FFI, so we'll build only that and not the C extension. We also avoid
+# `require "mkmf"` as that prepends the LLVM toolchain to PATH on TruffleRuby,
+# but we want to use the native toolchain here since libprism is run natively.
+if RUBY_ENGINE != "ruby"
+  make("build/libprism.#{RbConfig::CONFIG["SOEXT"]}")
+  File.write("Makefile", "all install clean:\n\t@#{RbConfig::CONFIG["NULLCMD"]}\n")
+  return
+end
+
+require "mkmf"
+
+# First, ensure that we can find the header for the prism library.
+unless find_header("prism.h", File.expand_path("../../include", __dir__))
+  raise "prism.h is required"
 end
 
-Prism::ExtConf.configure
+# Next, ensure we can find the header for the C extension. Explicitly look for
+# the extension header in the parent directory because we want to consistently
+# look for `prism/extension.h` in our source files to line up with our mirroring
+# in CRuby.
+unless find_header("prism/extension.h", File.expand_path("..", __dir__))
+  raise "prism/extension.h is required"
+end
+
+# If `--enable-debug-mode-build` is passed to this script or the
+# `PRISM_DEBUG_MODE_BUILD` environment variable is defined, we'll build with the
+# `PRISM_DEBUG_MODE_BUILD` macro defined. This causes parse functions to
+# duplicate their input so that they have clearly set bounds, which is useful
+# for finding bugs that cause the parser to read off the end of the input.
+if enable_config("debug-mode-build", ENV["PRISM_DEBUG_MODE_BUILD"] || false)
+  append_cflags("-DPRISM_DEBUG_MODE_BUILD")
+end
+
+# By default, all symbols are hidden in the shared library.
+append_cflags("-fvisibility=hidden")
+
+# We need to link against the libprism.a archive, which is built by the
+# project's `Makefile`. We'll build it if it doesn't exist yet, and then add it
+# to `mkmf`'s list of local libraries.
+archive_target = "build/libprism.a"
+archive_path = File.expand_path("../../#{archive_target}", __dir__)
+
+make(archive_target) unless File.exist?(archive_path)
+$LOCAL_LIBS << " #{archive_path}"
+
+# Finally, we'll create the `Makefile` that is going to be used to configure and
+# build the C extension.
+create_makefile("prism/prism")
+
+# Now that the `Makefile` for the C extension is built, we'll append on an extra
+# rule that dictates that the extension should be rebuilt if the archive is
+# updated.
+File.open("Makefile", "a") do |mf|
+  mf.puts
+  mf.puts("# Automatically rebuild the extension if libprism.a changed")
+  mf.puts("$(TARGET_SO): $(LOCAL_LIBS)")
+end

data/ext/prism/extension.c

@@ -1,7 +1,7 @@
 #include "prism/extension.h"
 
 // NOTE: this file should contain only bindings. All non-trivial logic should be
-// in librubyparser so it can be shared its the various callers.
+// in libprism so it can be shared its the various callers.
 
 VALUE rb_cPrism;
 VALUE rb_cPrismNode;

data/ext/prism/extension.h

@@ -1,7 +1,7 @@
 #ifndef PRISM_EXT_NODE_H
 #define PRISM_EXT_NODE_H
 
-#define EXPECTED_PRISM_VERSION "0.17.1"
+#define EXPECTED_PRISM_VERSION "0.18.0"
 
 #include <ruby.h>
 #include <ruby/encoding.h>