tebako 0.12.8 → 0.12.10

data/lib/tebako/scenario_manager.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2024 [Ribose Inc](https://www.ribose.com).
+# Copyright (c) 2024-2025 [Ribose Inc](https://www.ribose.com).
 # All rights reserved.
 # This file is a part of tebako
 #
@@ -32,64 +32,99 @@ require_relative "error"
 
 # Tebako - an executable packager
 module Tebako
-  # Manages packaging scenario based on input files (gemfile, gemspec, etc)
-  class ScenarioManager
-    def initialize(fs_root, fs_entrance)
-      @with_gemfile = false
-      initialize_root(fs_root)
-      initialize_entry_point(fs_entrance || "stub.rb")
+  # Magic version numbers used to ensure compatibility for Ruby 2.7.x, 3.0.x
+  # These are the minimal versions required to provide linux-gnu / linux-musl differentiation by bundler
+  # Ruby 3.1+ default rubygems versions work correctly out of the box
+  BUNDLER_VERSION = "2.4.22"
+  RUBYGEMS_VERSION = "3.4.22"
+
+  # A couple of static Scenario definitions
+  class ScenarioManagerBase
+    def initialize(ostype = RUBY_PLATFORM)
+      @ostype = ostype
+      @linux = @ostype =~ /linux/ ? true : false
+      @musl = @ostype =~ /linux-musl/ ? true : false
+      @macos = @ostype =~ /darwin/ ? true : false
+      @msys  = @ostype =~ /msys|mingw|cygwin/ ? true : false
+
+      @fs_mount_point = @msys ? "A:/__tebako_memfs__" : "/__tebako_memfs__"
+      @exe_suffix = @msys ? ".exe" : ""
     end
 
-    attr_reader :fs_entry_point, :fs_mount_point, :fs_entrance, :gemfile_path, :with_gemfile
+    attr_reader :fs_mount_point, :exe_suffix
 
-    def configure_scenario
-      @fs_mount_point = if msys?
-                          "A:/__tebako_memfs__"
-                        else
-                          "/__tebako_memfs__"
-                        end
+    def b_env
+      u_flags = if @macos
+                  "-DTARGET_OS_SIMULATOR=0 -DTARGET_OS_IPHONE=0  #{ENV.fetch("CXXFLAGS", nil)}"
+                else
+                  ENV.fetch("CXXFLAGS", nil)
+                end
+      @b_env ||= { "CXXFLAGS" => u_flags }
+    end
 
-      lookup_files
-      configure_scenario_inner
+    def linux?
+      @linux
     end
 
-    def exe_suffix
-      @exe_suffix ||= msys? ? ".exe" : ""
+    def m_files
+      # [TODO]
+      # Ninja generates incorrect script for tebako press target -- gets lost in a chain custom targets
+      # Using makefiles has negative performance impact so it needs to be fixed
+
+      @m_files ||= if @linux || @macos
+                     "Unix Makefiles"
+                   elsif @msys
+                     "MinGW Makefiles"
+                   else
+                     raise Tebako::Error.new("#{RUBY_PLATFORM} is not supported.", 112)
+                   end
     end
 
     def macos?
-      @macos ||= RUBY_PLATFORM =~ /darwin/ ? true : false
+      @macos
     end
 
     def msys?
-      @msys ||= RUBY_PLATFORM =~ /msys|mingw|cygwin/ ? true : false
+      @msys
     end
 
-    private
-
-    def initialize_entry_point(fs_entrance)
-      @fs_entrance = Pathname.new(fs_entrance).cleanpath.to_s
+    def musl?
+      @musl
+    end
 
-      if Pathname.new(@fs_entrance).absolute?
-        Tebako.packaging_error 114 unless @fs_entrance.start_with?(@fs_root)
+    def ncores
+      if @ncores.nil?
+        if @macos
+          out, st = Open3.capture2e("sysctl", "-n", "hw.ncpu")
+        else
+          out, st = Open3.capture2e("nproc", "--all")
+        end
 
-        fetmp = @fs_entrance
-        @fs_entrance = Pathname.new(@fs_entrance).relative_path_from(Pathname.new(@fs_root)).to_s
-        puts "-- Absolute path to entry point '#{fetmp}' will be reduced to '#{@fs_entrance}' relative to '#{@fs_root}'"
+        @ncores = !st.signaled? && st.exitstatus.zero? ? out.strip.to_i : 4
       end
-      # Can check after deploy, because entry point can be generated during bundle install or gem install
-      # Tebako.packaging_error 106 unless File.file?(File.join(@fs_root, @fs_entrance))
-      @fs_entry_point = "/bin/#{@fs_entrance}"
+      @ncores
     end
+  end
 
-    def initialize_root(fs_root)
-      Tebako.packaging_error 107 unless Dir.exist?(fs_root)
-      p_root = Pathname.new(fs_root).cleanpath
-      Tebako.packaging_error 113 unless p_root.absolute?
-      @fs_root = p_root.realpath.to_s
+  # Manages packaging scenario based on input files (gemfile, gemspec, etc)
+  class ScenarioManager < ScenarioManagerBase
+    def initialize(fs_root, fs_entrance)
+      super()
+      @with_gemfile = @with_lockfile = @needs_bundler = false
+      @bundler_version = BUNDLER_VERSION
+      initialize_root(fs_root)
+      initialize_entry_point(fs_entrance || "stub.rb")
+    end
+
+    attr_reader :fs_entry_point, :fs_entrance, :gemfile_path, :needs_bundler, :with_gemfile
+
+    def bundler_reference
+      @needs_bundler ? "_#{@bundler_version}_" : nil
     end
 
-    def configure_scenario_inner
+    def configure_scenario
+      lookup_files
+
       case @gs_length
       when 0
         configure_scenario_no_gemspec
@@ -100,6 +135,8 @@ module Tebako
       end
     end
 
+    private
+
     def configure_scenario_no_gemspec
       @fs_entry_point = "/local/#{@fs_entrance}" if @with_gemfile || @g_length.zero?
 
@@ -112,11 +149,93 @@ module Tebako
                   end
     end
 
+    def initialize_entry_point(fs_entrance)
+      @fs_entrance = Pathname.new(fs_entrance).cleanpath.to_s
+
+      if Pathname.new(@fs_entrance).absolute?
+        Tebako.packaging_error 114 unless @fs_entrance.start_with?(@fs_root)
+
+        fetmp = @fs_entrance
+        @fs_entrance = Pathname.new(@fs_entrance).relative_path_from(Pathname.new(@fs_root)).to_s
+        puts "-- Absolute path to entry point '#{fetmp}' will be reduced to '#{@fs_entrance}' relative to '#{@fs_root}'"
+      end
+      # Can check after deploy, because entry point can be generated during bundle install or gem install
+      # Tebako.packaging_error 106 unless File.file?(File.join(@fs_root, @fs_entrance))
+      @fs_entry_point = "/bin/#{@fs_entrance}"
+    end
+
+    def initialize_root(fs_root)
+      Tebako.packaging_error 107 unless Dir.exist?(fs_root)
+      p_root = Pathname.new(fs_root).cleanpath
+      Tebako.packaging_error 113 unless p_root.absolute?
+      @fs_root = p_root.realpath.to_s
+    end
+
     def lookup_files
-      @gemfile_path = File.join(@fs_root, "Gemfile")
       @gs_length = Dir.glob(File.join(@fs_root, "*.gemspec")).length
-      @with_gemfile = File.exist?(@gemfile_path)
       @g_length = Dir.glob(File.join(@fs_root, "*.gem")).length
+      @with_gemfile = File.exist?(@gemfile_path = File.join(@fs_root, "Gemfile"))
+      @with_lockfile = File.exist?(@lockfile_path = File.join(@fs_root, "Gemfile.lock"))
+    end
+  end
+
+  # Configure scenraio and do bundler resolution
+  class ScenarioManagerWithBundler < ScenarioManager
+    protected
+
+    def lookup_files
+      super
+      if @with_lockfile
+        update_bundler_version_from_lockfile(@lockfile_path)
+      elsif @with_gemfile
+        update_bundler_version_from_gemfile(@gemfile_path)
+      end
+    end
+
+    private
+
+    def store_compatible_bundler_version(requirement)
+      fetcher = Gem::SpecFetcher.fetcher
+      tuples = fetcher.detect(:released) do |name_tuple|
+        name_tuple.name == "bundler" && requirement.satisfied_by?(name_tuple.version)
+      end
+
+      Tebako.packaging_error 119 if tuples.empty?
+
+      # Get latest compatible version
+      @bundler_version = tuples.map { |tuple, _| tuple.version }.max.to_s
+    end
+
+    def update_bundler_version_from_gemfile(gemfile_path)
+      # Build definition without lockfile
+      definition = Bundler::Definition.build(gemfile_path, nil, nil)
+
+      # Get bundler dependency from Gemfile
+      bundler_dep = definition.dependencies.find { |d| d.name == "bundler" }
+
+      return unless bundler_dep
+
+      @needs_bundler = true
+      min_requirement = Gem::Requirement.create(">= #{Tebako::BUNDLER_VERSION}")
+      requirement = Gem::Requirement.create(bundler_dep.requirement, min_requirement)
+
+      store_compatible_bundler_version(requirement)
+    end
+
+    def update_bundler_version_from_lockfile(lockfile_path)
+      puts "   ... using lockfile at #{@lockfile_path}"
+      Tebako.packaging_error 117 unless File.exist?(lockfile_path)
+
+      lockfile_content = File.read(lockfile_path)
+      Tebako.packaging_error 117 unless lockfile_content =~ /BUNDLED WITH\n\s+(#{Gem::Version::VERSION_PATTERN})\n/
+
+      @bundler_version = ::Regexp.last_match(1)
+      @needs_bundler = true
+
+      bundler_requirement = Gem::Requirement.new(">= #{BUNDLER_VERSION}")
+      return if bundler_requirement.satisfied_by?(Gem::Version.new(@bundler_version))
+
+      Tebako.packaging_error 118, " : #{@bundler_version} requested, #{BUNDLER_VERSION} minimum required"
     end
   end
 end

data/lib/tebako/version.rb

@@ -26,5 +26,5 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 module Tebako
-  VERSION = "0.12.8"
+  VERSION = "0.12.10"
 end

data/tebako.gemspec

@@ -63,8 +63,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thor", "~> 1.2"
   spec.add_dependency "yaml", "~> 0.2.1"
 
+  spec.add_development_dependency "debug"
   spec.add_development_dependency "hoe"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rdbg"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "rubocop", "~> 1.52"
   spec.add_development_dependency "rubocop-rubycw"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tebako
 version: !ruby/object:Gem::Version
-  version: 0.12.8
+  version: 0.12.10
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-25 00:00:00.000000000 Z
+date: 2025-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdbg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -190,13 +218,14 @@ files:
 - lib/tebako/packager.rb
 - lib/tebako/packager/pass1_patch.rb
 - lib/tebako/packager/pass1a_patch.rb
-- lib/tebako/packager/pass2.rb
+- lib/tebako/packager/pass2_patch.rb
 - lib/tebako/packager/patch.rb
 - lib/tebako/packager/patch_buildsystem.rb
 - lib/tebako/packager/patch_helpers.rb
 - lib/tebako/packager/patch_libraries.rb
 - lib/tebako/packager/patch_literals.rb
 - lib/tebako/packager/patch_main.rb
+- lib/tebako/packager/rubygems_patch.rb
 - lib/tebako/packager_lite.rb
 - lib/tebako/ruby_builder.rb
 - lib/tebako/ruby_version.rb

data/lib/tebako/packager/pass2.rb

@@ -1,149 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright (c) 2021-2024 [Ribose Inc](https://www.ribose.com).
-# All rights reserved.
-# This file is a part of tebako
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions
-# are met:
-# 1. Redistributions of source code must retain the above copyright
-#    notice, this list of conditions and the following disclaimer.
-# 2. Redistributions in binary form must reproduce the above copyright
-#    notice, this list of conditions and the following disclaimer in the
-#    documentation and/or other materials provided with the distribution.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
-# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS
-# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-# POSSIBILITY OF SUCH DAMAGE.
-
-require_relative "patch_literals"
-require_relative "patch_main"
-require_relative "patch_libraries"
-require_relative "patch_helpers"
-require_relative "patch_buildsystem"
-
-# Tebako - an executable packager
-module Tebako
-  module Packager
-    # Ruby patching definitions (pass2)
-    module Pass2
-      class << self
-        def get_patch_map(ostype, deps_lib_dir, ruby_ver)
-          patch_map = get_patch_map_base(ostype, deps_lib_dir, ruby_ver)
-          patch_map.store("thread_pthread.c", LINUX_MUSL_THREAD_PTHREAD_PATCH) if ostype =~ /linux-musl/
-          if PatchHelpers.msys?(ostype)
-            patch_map.merge!(get_msys_patches(ruby_ver))
-          elsif ruby_ver.ruby3x?
-            patch_map.store("common.mk", COMMON_MK_PATCH)
-          end
-          extend_patch_map_r33(patch_map, ostype, deps_lib_dir, ruby_ver)
-          patch_map.store("prism_compile.c", PRISM_PATCHES) if ruby_ver.ruby34?
-          patch_map
-        end
-
-        private
-
-        include Tebako::Packager::PatchBuildsystem
-        include Tebako::Packager::PatchLiterals
-        def extend_patch_map_r33(patch_map, ostype, deps_lib_dir, ruby_ver)
-          if ruby_ver.ruby33? || PatchHelpers.msys?(ostype)
-            patch_map.store("config.status",
-                            get_config_status_patch(ostype, deps_lib_dir, ruby_ver))
-          end
-          patch_map
-        end
-
-        def get_dir_c_patch(ostype)
-          pattern = PatchHelpers.msys?(ostype) ? "/* define system APIs */" : "#ifdef HAVE_GETATTRLIST"
-          dir_c_patch = PatchHelpers.patch_c_file_pre(pattern)
-          dir_c_patch.merge!(DIR_C_BASE_PATCH)
-          dir_c_patch
-        end
-
-        def get_dln_c_patch(ostype, ruby_ver)
-          pattern = "#ifndef dln_loaderror"
-          # Not using substitutions of dlxxx functions on Windows
-          dln_c_patch = {
-            pattern => "#{PatchHelpers.msys?(ostype) ? C_FILE_SUBST_LESS : C_FILE_SUBST}\n#{pattern}\n"
-          }
-
-          if PatchHelpers.msys?(ostype)
-            patch = ruby_ver.ruby32? ? DLN_C_MSYS_PATCH : DLN_C_MSYS_PATCH_PRE32
-            dln_c_patch.merge!(patch)
-          end
-
-          dln_c_patch
-        end
-
-        def get_io_c_msys_patch(ruby_ver)
-          io_c_msys_patch = ruby_ver.ruby32? ? IO_C_MSYS_PATCH : IO_C_MSYS_PATCH_PRE_32
-          io_c_msys_patch.merge(IO_C_MSYS_BASE_PATCH)
-        end
-
-        def get_io_c_patch(ostype, ruby_ver)
-          io_c_patch = PatchHelpers.patch_c_file_pre("/* define system APIs */")
-          io_c_patch.merge!(get_io_c_msys_patch(ruby_ver)) if PatchHelpers.msys?(ostype)
-          io_c_patch
-        end
-
-        def get_util_c_patch(ruby_ver)
-          if ruby_ver.ruby31?
-            PatchHelpers.patch_c_file_post("#endif /* !HAVE_GNU_QSORT_R */")
-          else
-            PatchHelpers.patch_c_file_pre("#ifndef S_ISDIR")
-          end
-        end
-
-        def get_tool_mkconfig_rb_patch(ostype)
-          subst = PatchHelpers.msys?(ostype) ? TOOL_MKCONFIG_RB_SUBST_MSYS : TOOL_MKCONFIG_RB_SUBST
-          {
-            "    if fast[name]" => subst
-          }
-        end
-
-        def get_msys_patches(ruby_ver)
-          {
-            "cygwin/GNUmakefile.in" => get_gnumakefile_in_patch_p2(ruby_ver),
-            "ruby.c" => RUBY_C_MSYS_PATCHES,
-            "win32/file.c" => WIN32_FILE_C_MSYS_PATCHES,
-            "win32/win32.c" => WIN32_WIN32_C_MSYS_PATCHES
-          }
-        end
-
-        def get_patch_map_base(ostype, deps_lib_dir, ruby_ver)
-          {
-            "template/Makefile.in" => template_makefile_in_patch(ostype, deps_lib_dir, ruby_ver),
-            "tool/mkconfig.rb" => get_tool_mkconfig_rb_patch(ostype),
-            "dir.c" => get_dir_c_patch(ostype),            "dln.c" => get_dln_c_patch(ostype, ruby_ver),
-            "io.c" => get_io_c_patch(ostype, ruby_ver),    "main.c" => PatchMain.get_main_c_patch(ruby_ver),
-            "file.c" => PatchHelpers.patch_c_file_pre("/* define system APIs */"),
-            "util.c" => get_util_c_patch(ruby_ver)
-          }
-        end
-
-        def mlibs_subst(ostype, deps_lib_dir, ruby_ver)
-          yjit_libs = ruby_ver.ruby32only? ? "$(YJIT_LIBS) " : ""
-          {
-            "MAINLIBS = #{yjit_libs}@MAINLIBS@" =>
-              "# -- Start of tebako patch -- \n" \
-              "MAINLIBS = #{yjit_libs}#{PatchLibraries.mlibs(ostype, deps_lib_dir, ruby_ver, true)}\n" \
-              "# -- End of tebako patch -- \n"
-          }
-        end
-
-        def template_makefile_in_patch(ostype, deps_lib_dir, ruby_ver)
-          template_makefile_in_patch_two(ostype, ruby_ver).merge(mlibs_subst(ostype, deps_lib_dir, ruby_ver))
-        end
-      end
-    end
-  end
-end