standalone-ruby 1.4.2 → 1.5.0

data/lib/data/vbs/default_vbs.txt

@@ -1,7 +1,7 @@
-Set objShell = CreateObject("WScript.Shell")
-
-rubyPath = CreateObject("Scripting.FileSystemObject").GetParentFolderName(WScript.ScriptFullName) & "/STANDALONE_RUBY_PATH"
-scriptPath = CreateObject("Scripting.FileSystemObject").GetParentFolderName(WScript.ScriptFullName) & "/STANDALONE_MAIN_FILE"
-
-command = """" & rubyPath & """ """ & scriptPath & """"
-objShell.Run command, 1, False
+Set objShell = CreateObject("WScript.Shell")
+
+rubyPath = CreateObject("Scripting.FileSystemObject").GetParentFolderName(WScript.ScriptFullName) & "/STANDALONE_RUBY_PATH"
+scriptPath = CreateObject("Scripting.FileSystemObject").GetParentFolderName(WScript.ScriptFullName) & "/STANDALONE_MAIN_FILE"
+
+command = """" & rubyPath & """ """ & scriptPath & """"
+objShell.Run command, 1, False

data/lib/data/vbs/vbs_gui.txt

@@ -1,8 +1,8 @@
-Set objShell = CreateObject("WScript.Shell")
-
-rubyPath = CreateObject("Scripting.FileSystemObject").GetParentFolderName(WScript.ScriptFullName) & "\STANDALONE_RUBY_PATH"
-scriptPath = CreateObject("Scripting.FileSystemObject").GetParentFolderName(WScript.ScriptFullName) & "\STANDALONE_MAIN_FILE"
-
-command = """" & rubyPath & """ """ & scriptPath & """"
-
-objShell.Run command, 1, False
+Set objShell = CreateObject("WScript.Shell")
+
+rubyPath = CreateObject("Scripting.FileSystemObject").GetParentFolderName(WScript.ScriptFullName) & "\STANDALONE_RUBY_PATH"
+scriptPath = CreateObject("Scripting.FileSystemObject").GetParentFolderName(WScript.ScriptFullName) & "\STANDALONE_MAIN_FILE"
+
+command = """" & rubyPath & """ """ & scriptPath & """"
+
+objShell.Run command, 1, False

data/lib/displayer.rb

@@ -0,0 +1,66 @@
+require_relative 'logger_helper'
+require_relative 'version/version'
+
+class Displayer
+  def initialize(params)
+    @params = params
+    @logger = LoggerHelper.instance
+  end
+
+  def display_params
+    begin
+      puts("Working With:")
+
+      display_map = {
+        "Project Path"   => @params[:project_path],
+        "Resource File" => @params[:resource_file],
+        "Exe File"       => @params[:exe],
+        "Ruby Path"      => @params[:ruby_path],
+        "Ruby Folder"    => @params[:ruby_path] ? File.basename(@params[:ruby_path]) : nil,
+        "Main File"      => @params[:main_file],
+        "Launcher"       => @params[:launcher],
+        "Launcher Type"  => @params[:launcher_type],
+        "Template"       => @params[:template] || "Default Template",
+        "Log Path"       => "Users Documents Directory"
+      }
+
+      display_text = display_map.map { |key, value| "  - #{key}: #{value}" if value }.compact
+
+      puts display_text.join("\n") unless display_text.empty?
+
+    rescue => e
+      print("Display Error: ".red); puts(e.message.red)
+      @logger.error("Display Error: #{e.message}")
+    end
+  end
+
+
+  def banner
+    banner = -<<"BANNER"
+Standalone-Ruby v#{StandaloneRuby::VERSION} - Package your Ruby projects as exe!
+  # Github: https://github.com/ardatetikbey/Standalone-Ruby
+  # RubyGems: https://rubygems.org/gems/standalone-ruby
+
+BANNER
+
+    puts banner
+  end
+end
+
+class String
+  def red
+    "\e[31m#{self}\e[0m"
+  end
+
+  def green
+    "\e[32m#{self}\e[0m"
+  end
+
+  def magenta
+    "\e[35m#{self}\e[0m"
+  end
+
+  def yellow
+    "\e[33m#{self}\e[0m"
+  end
+end

data/lib/exe_packer.rb

@@ -0,0 +1,82 @@
+require_relative 'logger_helper'
+
+class ExePacker
+  def initialize(params)
+    @params = params
+    @logger = LoggerHelper.instance
+  end
+
+  def pack
+    begin
+      stub_path = File.join(File.expand_path("data/exe_templates", __dir__), "launcher_stub.c")
+      @logger.info("Reading stub template from: #{stub_path}")
+
+      stub_content = File.read(stub_path)
+
+      stub_output = "#{File.join(@params[:project_path].to_s, "launcher_stub.c")}"
+      exe_path = "#{File.join(@params[:project_path].to_s, @params[:exe].to_s)}"
+
+      File.open(stub_output, 'w') { |f| f.write(stub_content) }
+
+      if @params[:use_gcc]
+        puts "\nChecking GCC and Windres..."
+        output = `where gcc`
+        gcc_path = output.strip
+
+        output = `where windres`
+        windres_path = output.strip
+
+        if File.exist?(output.strip)
+          puts "GCC Path: #{gcc_path}"
+          puts "Windres Path: #{windres_path}"
+
+          windres_command = "#{windres_path} #{@params[:resource_file].to_s} -O coff -o #{File.join(@params[:project_path].to_s, "program.o")}"
+          @logger.info("Running command: #{windres_command}")
+          `#{windres_command}`
+
+          gcc_command = "#{gcc_path} -o #{exe_path} #{File.join(@params[:project_path].to_s, "program.o")} #{stub_output}"
+          @logger.info("Running command: #{gcc_command}")
+          `#{gcc_command}`
+
+          File.delete("#{File.join(@params[:project_path].to_s, 'program.o')}")
+          @logger.info("program.o file deleted")
+        else
+          print("Error: ".red); puts("GCC could not be found!")
+          exit!
+        end
+      else
+        puts "\nUsing Tiny C Compiler (TCC)..."
+
+        tcc_path = File.join(File.expand_path("data/c_compilers/tcc", __dir__), "tcc.exe")
+        @logger.info("TCC Path: #{tcc_path}")
+
+        command = "#{tcc_path} -o #{exe_path} #{stub_output} -lkernel32"
+        @logger.info("Running command: #{command}")
+        `#{command}`
+      end
+
+      File.delete(stub_output)
+      @logger.info("Stub file deleted successfully")
+
+      puts("\nExe file has been generated!".green_bold_dark)
+      @logger.info("Exe file generated at: #{exe_path}")
+    rescue Exception => err
+      @logger.error("Error occurred: #{err.message}")
+      print("Error: ".red); puts(err.message)
+    end
+  end
+end
+
+class String
+  def red
+    "\e[31m#{self}\e[0m"
+  end
+
+  def yellow
+    "\e[33m#{self}\e[0m"
+  end
+
+  def green_bold_dark
+    "\e[1m\e[38;5;28m#{self}\e[0m"
+  end
+end

data/lib/launcher.rb

@@ -0,0 +1,84 @@
+require 'optparse'
+
+require_relative 'displayer'
+require_relative 'parameter_parser'
+require_relative 'ruby_copy'
+require_relative 'logger_helper'
+require_relative 'exe_packer'
+require_relative 'launcher_handler'
+
+
+class Launcher
+  def initialize
+    @parser = ParameterParser.new
+    @parser.parse
+    @params = @parser.params
+
+    @displayer = Displayer.new(@params)
+    @ruby_copy = RubyCopy.new(@params)
+    @logger = LoggerHelper.instance
+    @exe_packer = ExePacker.new(@params)
+    @launcher_handler = LauncherHandler.new(@params)
+  end
+
+  def platform_analysis
+    case RUBY_PLATFORM
+    when /win32|mingw|cygwin/
+      @params[:platform] = 'Windows'
+      @logger.info("Working on windows platform.")
+    else
+      print("Error: ".red); puts("This platform is not supported! Exiting...")
+      @logger.error("This platform is not supported! Exiting...")
+      exit!
+    end
+  end
+
+  def run
+    begin
+      Signal.trap("INT") do
+        @logger.info("The program was closed because an interrupt command was detected.")
+        puts "\nProgram interrupted. Shutting down..."
+        exit(0)
+      end
+
+      platform_analysis
+
+      @logger.info("the executor function is started.")
+      @displayer.banner
+      @logger.info("Banner display was made.")
+      @displayer.display_params
+      @logger.info("The parameters entered by the user are reflected on the screen.")
+      @ruby_copy.robocopy_interpreter
+      @logger.info("Ruby interpreter copy function completed.")
+      @launcher_handler.handle
+      @logger.info("Launcher handler finished.")
+      @exe_packer.pack
+      @logger.info("Exe pack finished.")
+
+      if @params[:one_file_exe]
+        require_relative 'sfx_generator'
+        @sfx_generator = SFXGenerator.new(@params)
+        @sfx_generator.generate_sfx
+      end
+
+      print("\nWARNING: ".yellow); puts("Instead of changing the path of the created exe file, create a shortcut. The same applies here as in every application.")
+
+      puts("\nThis project is under development. If you encounter any errors, you can open an issue on Github.\nIf you want to make a suggestion, you can contact me.")
+      puts "Thanks for using Standalone-Ruby! Don't forget to star the project on Github."
+      @logger.info("Program finished.")
+    rescue Exception => e
+      @logger.error("Launcher Error: #{e.message}")
+      print("Launcher Error: "); puts("#{e.message}".red)
+    end
+  end
+end
+
+class String
+  def red
+    "\e[31m#{self}\e[0m"
+  end
+
+  def yellow
+    "\e[33m#{self}\e[0m"
+  end
+end

data/lib/launcher_handler.rb

@@ -0,0 +1,53 @@
+require 'fileutils'
+
+require_relative 'logger_helper'
+
+class LauncherHandler
+  def initialize(params)
+    @params = params
+    @logger = LoggerHelper.instance
+  end
+
+  def handle
+    begin
+      puts("\nThe template creation process has been started.")
+
+      ruby_file = @params[:gui] ? "rubyw.exe" : "ruby.exe"
+
+      if @params[:gui] == true
+        vbs_template = File.join(File.expand_path("data/launcher_templates/vbs", __dir__), "vbs_gui.txt")
+        ruby_file = "rubyw.exe"
+      else
+        vbs_template = File.join(File.expand_path("data/launcher_templates/vbs", __dir__), "default_vbs.txt")
+        ruby_file = "ruby.exe"
+      end
+
+      puts "Using: #{vbs_template}"
+
+      if File.exist?(vbs_template)
+        content = File.read(vbs_template)
+        @logger.info("The content of the template has been read.")
+
+        content.gsub!("STANDALONE_RUBY_PATH", "#{File.join(File.basename(@params[:ruby_path].to_s), "bin", "#{ruby_file}")}")
+        @logger.info("Placed the defined Ruby interpreter path in the template.")
+
+        content.gsub!("STANDALONE_MAIN_FILE", "#{File.basename(@params[:main_file].to_s)}")
+        @logger.info("The main project file path defined in the template is placed.")
+
+        new_launcher_path = File.join(@params[:project_path].to_s, @params[:launcher_name].to_s)
+        File.open(new_launcher_path, "w") do |f_man|
+          f_man.puts content
+        end
+
+        @logger.info("New launcher file directory created as #{new_launcher_path.to_s}")
+      else
+        print("Handler Error: ".red); puts("The template file could not be found.")
+        @logger.error("Template file not found!")
+        exit!
+      end
+    rescue Exception => e
+      print("Handler Error: ".red); puts("#{e.message}")
+      @logger.error("Handler Error: #{e.message}")
+    end
+  end
+end

data/lib/logger_helper.rb

@@ -0,0 +1,24 @@
+require 'logger'
+require 'time'
+require 'fileutils'
+
+class LoggerHelper
+  def self.instance
+    documents_path = File.join(ENV['USERPROFILE'], 'Documents', 'standalone-ruby-logs')
+
+    FileUtils.mkdir_p(documents_path) unless Dir.exist?(documents_path)
+
+    timestamp = Time.now.strftime("%Y-%m-%d_%H-%M-%S")
+    log_file = File.join(documents_path, "standalone-ruby_#{timestamp}.log")
+
+    logger = Logger.new(log_file)
+    logger.level = Logger::INFO
+
+    logger.formatter = proc do |severity, datetime, progname, msg|
+      msg = "(empty message)" if msg.nil? || msg.strip.empty?
+      "#{datetime.strftime('%Y-%m-%d %H:%M:%S')} [#{severity}] #{msg}\n"
+    end
+
+    return logger
+  end
+end

data/lib/parameter_parser.rb

@@ -0,0 +1,210 @@
+require 'fileutils'
+require 'tmpdir'
+require 'optparse'
+
+require_relative 'logger_helper'
+require_relative 'version/version'
+
+class ParameterParser
+  def initialize
+    @params = {
+      threads: 5,
+      sfx_path: Dir.tmpdir,
+      exe: "program.exe",
+      resource_file: File.join(File.expand_path("data/resource_files", __dir__), "default.rc"),
+      launcher: "launcher.vbs",
+      launcher_name: "launcher.vbs",
+      launcher_type: "vbs"
+    }
+
+    @logger = LoggerHelper.instance
+  end
+
+  def normalize_paths!
+    @params.each do |key, value|
+      @params[key] = value.gsub('\\', '/') if value.is_a?(String)
+    end
+  end
+
+  def display_help
+    help_text = <<~EOT
+      Standalone-Ruby v#{StandaloneRuby::VERSION} - Convert your Ruby projects to exe files!
+
+      Usage: standalone-ruby [--help] [--project-path PROJECT_PATH] [--ruby-path RUBY_PATH] [--main-file MAIN_FILE] [--launcher LAUNCHER] [--gui] 
+                             [--template TEMPLATE] [--exe-file EXE_FILE] [--threads THREADS] [--resource-file resource_file] [--gcc] [--version]
+
+      Required Options:
+        --project-path PROJECT_PATH
+            Target Ruby project path.
+      
+        --ruby RUBY_PATH
+            Path to the Ruby interpreter.
+      
+        --main-file MAIN_FILE
+            Path to the main Ruby file of the project.
+
+      Extra Options:
+        --exe-file EXE_FILE
+            Name of the exe file to be used for output (default is program.exe).
+      
+        --threads THREADS
+            Number of threads to use (default is 5). Determines the number of threads used during the Ruby interpreter
+            copy process and for Robocopy operations. A higher number of threads can speed up the process, but requires more system resources.
+      
+        --resource-file RESOURCE_FILE
+            Resource file (.rc) for the exe file to be created. Only possible with MinGW.
+      
+        --help
+            Show this help message and exit.
+      
+        --version
+            Show program version and exit.
+      
+        --gcc
+            Use GCC compiler for exe file.
+            
+        --gui
+            This option allows the rubyw.exe file in the bin folder to be used.
+            You can choose it for projects that include GUI.
+
+      Notes:
+        - Make sure that the Ruby interpreter you are using includes all the gems required for the target project.
+        - The Ruby interpreter uses Robocopy for copying, and the number of threads given affects the speed of this operation.
+
+      For more details, please visit the documentation at:
+        https://github.com/ardatetikbey/Standalone-Ruby
+
+    EOT
+
+    puts help_text
+  end
+
+  def parse
+    begin
+      OptionParser.new do |opts|
+        note = "Note: https://github.com/ardatetikbey/Standalone-Ruby Don't forget to review my github document to get the best results."
+        opts.banner = "Usage: ruby #{$0} [options]\n#{note}"
+
+        opts.on("--sfx-path SFX_PATH") do |sfx_path|
+          @params[:sfx_path] = sfx_path
+        end
+
+        opts.on("--resource-file RESOURCE_FILE") do |resource_file|
+          if File.exist?(resource_file)
+            @params[:resource_file] = resource_file
+          else
+            print("Parser Error: ".red); puts("The specified resource file #{resource_file} could not be found!")
+            @logger.error("Parser Error: The specified resource file #{resource_file} could not be found!")
+            exit!
+          end
+        end
+
+        opts.on("--one-file-exe") do
+          @params[:one_file_exe] = true
+        end
+
+        opts.on("--ruby-path RUBY_PATH") do |ruby_path|
+          ruby_path.strip!
+          if Dir.exist?("#{ruby_path}")
+            if Dir.exist?(File.join(ruby_path, "bin"))
+              @params[:ruby_path] = ruby_path
+            end
+          else
+            print("Parser Error: ".red); puts("The specified Ruby path #{ruby_path} could not be found!")
+            @logger.error("Parser Error: The specified Ruby path #{ruby_path} could not be found!")
+            exit!
+          end
+        end
+
+        opts.on("--project-path PROJECT_PATH", String) do |project_path|
+          project_path.strip!
+          if Dir.exist?("#{project_path}")
+            @params[:project_path] = project_path
+          else
+            print("Parser Error: ".red); puts("The specified project path #{project_path} could not be found!")
+            @logger.error("Parser Error: The project path #{project_path} could not be found!")
+            exit!
+          end
+        end
+
+        opts.on("--exe-file EXE_FILE") do |exe|
+          @params[:exe] = exe
+        end
+
+        opts.on("--gcc") do
+          @params[:use_gcc] = true
+        end
+
+        opts.on("--main-file MAIN_FILE", String) do |main_file|
+          main_file.strip!
+          if File.exist?(main_file)
+            @params[:main_file] = main_file
+          else
+            print("Parser Error: ".red); puts("The specified file #{main_file} could not be found!")
+            @logger.error("Parser Error: The specified file #{main_file} could not be found!")
+            exit!
+          end
+        end
+
+        opts.on("--threads THREADS", Integer) do |threads|
+          if threads.is_a?(Integer)
+            @params[:threads] = threads
+          else
+            print("Parser Error: ".red); puts("Invalid value for threads. Please provide an integer.")
+            @logger.error("Parser Error: Invalid value for threads.")
+            exit!
+          end
+        end
+
+        opts.on("--gui") do
+          @params[:gui] = true
+        end
+
+        opts.on("--version") do
+          puts "Standalone Ruby Gem Version #{StandaloneRuby::VERSION}"
+          exit!
+        end
+
+        opts.on("--help") do
+          display_help
+          exit!
+        end
+      end.parse!
+
+      normalize_paths!
+
+      if @params[:project_path].nil? || @params[:ruby_path].nil? || @params[:main_file].nil?
+        print("Error: ".red); puts("Missing required parameters. Please provide the necessary parameters:\n  -p, -r, -m.\nYou can use the -h parameter for the help menu.")
+        @logger.error("Parser Error: Missing required parameters.")
+        exit!
+      end
+
+    rescue Exception => e
+      print("Parser Error: ".red); puts("#{e.message}".red)
+      @logger.error("Parser Error: #{e.message}")
+      exit!
+    end
+  end
+
+  def params
+    @params
+  end
+end
+
+class String
+  def red
+    "\e[31m#{self}\e[0m"
+  end
+
+  def green
+    "\e[32m#{self}\e[0m"
+  end
+
+  def magenta
+    "\e[35m#{self}\e[0m"
+  end
+
+  def yellow
+    "\e[33m#{self}\e[0m"
+  end
+end

data/lib/ruby_copy.rb

@@ -0,0 +1,26 @@
+require_relative 'logger_helper'
+
+class RubyCopy
+  def initialize(params)
+    @params = params
+    @logger = LoggerHelper.instance
+  end
+
+  def robocopy_interpreter
+    begin
+      puts("\nThe Ruby interpreter copying process has been started.")
+      print("WARNING: ".yellow); puts("If you are using a development kit, the copying process may take a long time.")
+
+      @logger.info("Robocopy process started using backticks.")
+      copy_output = `robocopy "#{@params[:ruby_path]}" "#{File.join(@params[:project_path].to_s, File.basename(@params[:ruby_path].to_s))}" /E /MT:#{@params[:threads].to_i} /V /ETA /NFL /NDL /R:1000000 /W:30 /NP`
+      puts "Robocopy Command: robocopy \"#{@params[:ruby_path]}\" \"#{File.join(@params[:project_path], File.basename(@params[:ruby_path]))}\" /E /MT:#{@params[:threads].to_i} /V /ETA /NFL /NDL /R:1000000 /W:30 /NP"
+
+      @logger.info("Robocopy output printed to screen.")
+
+      puts("The Ruby interpreter copying process has been completed.")
+    rescue Exception => e
+      print("Copy Error: ".red); puts("#{e.message}".red)
+      @logger.error("Copy Error: #{e.message}")
+    end
+  end
+end

data/lib/sfx_generator.rb

@@ -0,0 +1,11 @@
+require_relative 'logger_helper'
+
+class SFXGenerator
+  def initialize(params)
+    @params = params
+  end
+
+  def generate_sfx
+
+  end
+end

data/lib/standalone_ruby.rb

@@ -1,4 +1,4 @@
-require_relative 'utils/launcher'
+require_relative 'launcher'
 
 class Program
   def run