Merge pull request jruby#8532 from enebo/define_class_dep

Deprecate defineOrGetClassUnder

Author: enebo

core/src/main/java/org/jruby/RubyModule.java

@@ -2438,49 +2438,60 @@ private void checkAliasFrameAccesses(ThreadContext context, String id, String ne
         }
     }
 
-    /** this method should be used only by interpreter or compiler
-     *
-     */
+    @Deprecated(since = "10.0")
     public RubyClass defineOrGetClassUnder(String name, RubyClass superClazz) {
-        return defineOrGetClassUnder(name, superClazz, null);
+        return defineClassUnder(getCurrentContext(), name, superClazz, null, null, -1);
     }
 
+    @Deprecated(since = "10.0")
     public RubyClass defineOrGetClassUnder(String name, RubyClass superClazz, String file, int line) {
-        return defineOrGetClassUnder(name, superClazz, null, file, line);
+        return defineClassUnder(getCurrentContext(), name, superClazz, null, file, line);
     }
 
+    @Deprecated(since = "10.0")
     public RubyClass defineOrGetClassUnder(String name, RubyClass superClazz, ObjectAllocator allocator) {
-        return defineOrGetClassUnder(name, superClazz, allocator, null, -1);
+        return defineClassUnder(getCurrentContext(), name, superClazz, allocator, null, -1);
     }
 
-    public RubyClass defineOrGetClassUnder(String name, RubyClass superClazz, ObjectAllocator allocator,
-                                           String file, int line) {
+    /**
+     * Internal API only used by our IR runtime helpers in setting up Ruby-defined classes or re-accessing them
+     * if they already exist.  Look at
+     * {@link RubyModule#defineClassUnder(ThreadContext, String, RubyClass, ObjectAllocator)} for native
+     * extensions.
+     *
+     * @param name
+     * @param superClazz
+     * @param allocator
+     * @param file
+     * @param line
+     * @return
+     */
+    public RubyClass defineClassUnder(ThreadContext context, String name, RubyClass superClazz,
+                                      ObjectAllocator allocator, String file, int line) {
         // This method is intended only for defining new classes in Ruby code,
         // so it uses the allocator of the specified superclass or default to
         // the Object allocator. It should NOT be used to define classes that require a native allocator.
 
-        Ruby runtime = getRuntime();
-        var context = runtime.getCurrentContext();
         IRubyObject classObj = getConstantAtSpecial(name);
         RubyClass clazz;
 
         if (classObj != null) {
-            if (!(classObj instanceof RubyClass)) throw typeError(context, name + " is not a class");
-            clazz = (RubyClass)classObj;
+            if (!(classObj instanceof RubyClass clazzy)) throw typeError(context, name + " is not a class");
+            clazz = clazzy;
 
             if (superClazz != null) {
                 RubyClass tmp = clazz.getSuperClass();
                 while (tmp != null && tmp.isIncluded()) tmp = tmp.getSuperClass(); // need to skip IncludedModuleWrappers
                 if (tmp != null) tmp = tmp.getRealClass();
-                if (tmp != superClazz) throw typeError(context, "superclass mismatch for class " + ids(runtime, name));
+                if (tmp != superClazz) throw typeError(context, "superclass mismatch for class " + ids(context.runtime, name));
             }
         } else if ((clazz = searchProvidersForClass(name, superClazz)) != null) {
             // reopen a java class
         } else {
-            if (superClazz == null) superClazz = runtime.getObject();
+            if (superClazz == null) superClazz = objectClass(context);
 
             if (allocator == null) {
-                if (isReifiable(runtime, superClazz)) {
+                if (isReifiable(objectClass(context), superClazz)) {
                     if (Options.REIFY_CLASSES.load()) {
                         allocator = REIFYING_OBJECT_ALLOCATOR;
                     } else if (Options.REIFY_VARIABLES.load()) {
@@ -2493,7 +2504,7 @@ public RubyClass defineOrGetClassUnder(String name, RubyClass superClazz, Object
                 }
             }
 
-            clazz = RubyClass.newClass(runtime, superClazz, name, allocator, this, true, file, line);
+            clazz = RubyClass.newClass(context.runtime, superClazz, name, allocator, this, true, file, line);
         }
 
         return clazz;
@@ -2502,12 +2513,8 @@ public RubyClass defineOrGetClassUnder(String name, RubyClass superClazz, Object
     /**
      * Determine if a new child of the given class can have its variables reified.
      */
-    private boolean isReifiable(Ruby runtime, RubyClass superClass) {
-        if (superClass == runtime.getObject()) return true;
-
-        if (superClass.getAllocator() == IVAR_INSPECTING_OBJECT_ALLOCATOR) return true;
-
-        return false;
+    private boolean isReifiable(RubyClass Object, RubyClass superClass) {
+        return superClass == Object || superClass.getAllocator() == IVAR_INSPECTING_OBJECT_ALLOCATOR;
     }
 
     /** this method should be used only by interpreter or compiler

core/src/main/java/org/jruby/ext/zlib/RubyZlib.java

@@ -100,9 +100,9 @@ public static RubyModule createZlibModule(ThreadContext context) {
         var GZipFileError = GzipFile.defineClassUnder(context, "Error", ZlibError, errorAllocator);
         var fileErrorAllocator = ZlibError.getAllocator();
         GZipFileError.addReadAttribute(context, "input");
-        GzipFile.defineOrGetClassUnder("CRCError", GZipFileError, fileErrorAllocator);
-        GzipFile.defineOrGetClassUnder("NoFooter", GZipFileError, fileErrorAllocator);
-        GzipFile.defineOrGetClassUnder("LengthError", GZipFileError, fileErrorAllocator);
+        GzipFile.defineClassUnder("CRCError", GZipFileError, fileErrorAllocator);
+        GzipFile.defineClassUnder("NoFooter", GZipFileError, fileErrorAllocator);
+        GzipFile.defineClassUnder("LengthError", GZipFileError, fileErrorAllocator);
 
         Zlib.defineClassUnder(context, "GzipReader", GzipFile, JZlibRubyGzipReader::new).
                 include(context, enumerableModule(context)).

core/src/main/java/org/jruby/ir/runtime/IRRuntimeHelpers.java

@@ -29,7 +29,6 @@
 import org.jruby.RubyString;
 import org.jruby.RubySymbol;
 import org.jruby.api.Create;
-import org.jruby.common.IRubyWarnings;
 import org.jruby.exceptions.RaiseException;
 import org.jruby.exceptions.Unrescuable;
 import org.jruby.ext.coverage.CoverageData;
@@ -1780,7 +1779,7 @@ public static RubyModule newRubyClassFromIR(ThreadContext context, String id, St
             sc = (RubyClass) superClass;
         }
 
-        RubyModule newRubyClass = ((RubyModule)container).defineOrGetClassUnder(id, sc, scope.getFile(), context.getLine() + 1);
+        RubyModule newRubyClass = ((RubyModule)container).defineClassUnder(context, id, sc, null, scope.getFile(), context.getLine() + 1);
 
         scope.setModule(newRubyClass);