tebako 0.9.2 → 0.10.0

data/lib/tebako/scenario_manager.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+# Copyright (c) 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 "pathname"
+
+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)
+      initialize_root(fs_root)
+      initialize_entry_point(fs_entrance)
+    end
+
+    attr_reader :fs_entry_point, :fs_mount_point, :fs_entrance
+
+    def configure_scenario
+      @fs_mount_point = if msys?
+                          "A:/__tebako_memfs__"
+                        else
+                          "/__tebako_memfs__"
+                        end
+
+      lookup_files
+      configure_scenario_inner
+    end
+
+    def exe_suffix
+      @exe_suffix ||= msys? ? ".exe" : ""
+    end
+
+    def macos?
+      @macos ||= RUBY_PLATFORM =~ /darwin/ ? true : false
+    end
+
+    def msys?
+      @msys ||= RUBY_PLATFORM =~ /msys|mingw|cygwin/ ? true : false
+    end
+
+    private
+
+    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 configure_scenario_inner
+      case @gs_length
+      when 0
+        configure_scenario_no_gemspec
+      when 1
+        @scenario = @gf_length.positive? ? :gemspec_and_gemfile : :gemspec
+      else
+        raise Tebako::Error, "Multiple Ruby gemspecs found in #{@fs_root}"
+      end
+    end
+
+    def configure_scenario_no_gemspec
+      @fs_entry_point = "/local/#{@fs_entrance}" if @gf_length.positive? || @g_length.zero?
+
+      @scenario = if @gf_length.positive?
+                    :gemfile
+                  elsif @g_length.positive?
+                    :gem
+                  else
+                    :simple_script
+                  end
+    end
+
+    def lookup_files
+      @gs_length = Dir.glob(File.join(@fs_root, "*.gemspec")).length
+      @gf_length = Dir.glob(File.join(@fs_root, "Gemfile")).length
+      @g_length = Dir.glob(File.join(@fs_root, "*.gem")).length
+    end
+  end
+end

data/lib/tebako/stripper.rb

@@ -46,11 +46,11 @@ module Tebako
       # Removes build artefacts, strip shared objects
       # [TODO] We probably need debug option/flag to say whether we shall delete ruby binaries
       #        from memfs or not. For debugging purposes it is very handy to have it here
-      def strip(ostype, src_dir)
+      def strip(scm, src_dir)
         puts "   ... stripping the output"
         strip_bs(src_dir)
-        strip_fi(ostype, src_dir)
-        strip_li(ostype, src_dir)
+        strip_fi(scm, src_dir)
+        strip_li(scm, src_dir)
       end
 
       def strip_file(file_in, file_out = nil)
@@ -69,8 +69,8 @@ module Tebako
 
       private
 
-      def get_files(ostype)
-        exe_suffix = Packager::PatchHelpers.exe_suffix(ostype)
+      def get_files(scm)
+        exe_suffix = scm.exe_suffix
         files = BIN_FILES.flat_map do |f|
           [f, "#{f}#{CMD_SUFFIX}", "#{f}#{BAT_SUFFIX}"]
         end
@@ -87,29 +87,29 @@ module Tebako
                         ])
       end
 
-      def strip_fi(ostype, src_dir)
-        files = get_files(ostype).map { |f| "#{src_dir}/bin/#{f}" }
+      def strip_fi(scm, src_dir)
+        files = get_files(scm).map { |f| "#{src_dir}/bin/#{f}" }
         FileUtils.rm(files, force: true)
       end
 
-      def strip_li(ostype, src_dir)
-        sext = strip_extensions(ostype)
+      def strip_li(scm, src_dir)
+        sext = strip_extensions(scm)
         Find.find(src_dir) do |file|
           next if File.directory?(file)
 
           extension = File.extname(file).delete_prefix(".").downcase
           if DELETE_EXTENSIONS.include?(extension)
             FileUtils.rm(file)
-          elsif sext.include?(extension) # && !Packager::PatchHelpers.msys?(ostype)
+          elsif sext.include?(extension)
             strip_file(file)
           end
         end
       end
 
-      def strip_extensions(ostype)
+      def strip_extensions(scm)
         sext = ["so"]
-        sext << "dll" if Packager::PatchHelpers.msys?(ostype)
-        sext << "dylib" << "bundle" if Packager::PatchHelpers.macos?(ostype)
+        sext << "dll" if scm.msys?
+        sext << "dylib" << "bundle" if scm.macos?
         sext
       end
     end

data/lib/tebako/version.rb

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

data/src/tebako-main.cpp

@@ -34,6 +34,7 @@
 #include <memory.h>
 #include <sys/stat.h>
 #include <fcntl.h>
+#include <stdint.h>
 
 #include <string>
 #include <cstdint>
@@ -70,9 +71,7 @@ extern "C" int tebako_main(int* argc, char*** argv)
   }
   else {
     try {
-      fsret = load_fs(&gfsData[0], gfsSize, tebako::fs_log_level, nullptr /* cachesize*/, nullptr /* workers */,
-                      nullptr /* mlock */, nullptr /* decompress_ratio*/, nullptr /* image_offset */
-      );
+      fsret = mount_root_memfs(&gfsData[0], gfsSize, tebako::fs_log_level, nullptr, nullptr, nullptr, nullptr, nullptr);
 
       if (fsret == 0) {
         if ((*argc > 1) && strcmp((*argv)[1], "--tebako-extract") == 0) {
@@ -88,7 +87,7 @@ extern "C" int tebako_main(int* argc, char*** argv)
           ret = 0;
         }
       }
-      atexit(drop_fs);
+      atexit(unmount_root_memfs);
     }
 
     catch (std::exception e) {
@@ -100,7 +99,7 @@ extern "C" int tebako_main(int* argc, char*** argv)
       ret = -1;
     }
 
-    if (tebako::needs_cwd) {
+    if (tebako::package_cwd != nullptr) {
       if (tebako_chdir(tebako::package_cwd) != 0) {
         printf("Failed to chdir to '%s' : %s\n", tebako::package_cwd, strerror(errno));
         ret = -1;
@@ -120,7 +119,7 @@ extern "C" int tebako_main(int* argc, char*** argv)
         argv_memory = nullptr;
       }
       if (fsret == 0) {
-        drop_fs();
+        unmount_root_memfs();
       }
     }
     catch (...) {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tebako
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -164,11 +164,13 @@ files:
 - include/tebako/tebako-main.h
 - lib/tebako.rb
 - lib/tebako/build_helpers.rb
+- lib/tebako/cache_manager.rb
 - lib/tebako/cli.rb
 - lib/tebako/cli_helpers.rb
-- lib/tebako/cli_rubies.rb
+- lib/tebako/codegen.rb
 - lib/tebako/deploy_helper.rb
 - lib/tebako/error.rb
+- lib/tebako/options_manager.rb
 - lib/tebako/packager.rb
 - lib/tebako/packager/pass1.rb
 - lib/tebako/packager/pass1a.rb
@@ -179,10 +181,10 @@ files:
 - lib/tebako/packager/patch_literals.rb
 - lib/tebako/packager/patch_main.rb
 - lib/tebako/ruby_builder.rb
+- lib/tebako/ruby_version.rb
+- lib/tebako/scenario_manager.rb
 - lib/tebako/stripper.rb
 - lib/tebako/version.rb
-- resources/tebako-fs.cpp.in
-- resources/tebako-version.h.in
 - src/tebako-main.cpp
 - tebako.gemspec
 - tools/.gitattributes
@@ -217,7 +219,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/tamatebako/tebako
   source_code_uri: https://github.com/tamatebako/tebako
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - cmake
@@ -242,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.19
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Packager for Ruby executables
 test_files: []

data/resources/tebako-fs.cpp.in

@@ -1,40 +0,0 @@
-/**
- *
- * 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.
- *
- */
-
-#include <incbin/incbin.h>
-
-namespace tebako {
-	const  char * fs_log_level   = "@LOG_LEVEL@";
-	const  char * fs_mount_point = "@FS_MOUNT_POINT@";
-	const  char * fs_entry_point = "@FS_ENTRY_POINT@";
-		   bool   needs_cwd	    = @NEEDS_CWD@;
-	const  char * package_cwd 	= "@PACKAGE_CWD_FULL@";
-	       char   original_cwd[PATH_MAX];
-	INCBIN(fs, "@DATA_BIN_FILE@");
-}

data/resources/tebako-version.h.in

@@ -1,37 +0,0 @@
-/**
- *
- * Copyright (c) 2021, [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.
- *
- */
-
-
-#pragma once
-
-const unsigned int tebako_version_major = @PROJECT_VERSION_MAJOR@;
-const unsigned int tebako_version_minor = @PROJECT_VERSION_MINOR@;
-const unsigned int tebako_version_teeny = @PROJECT_VERSION_PATCH@;
-
-