standalone-ruby 1.2.1 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edb5aea8b9903ab013d5706145157921a3906c2eca9c571aa9ef081c2d5ea56c
-  data.tar.gz: 5733ba52e4bb4e0f5a6f5c28ccb39f4d52b973cc33f176169b4136eabfe26e5a
+  metadata.gz: 4a7320c98d6c1987f62672c69a0d3925e6da1dd7dc2234ccaddbf754e26fb41e
+  data.tar.gz: e7ee6f01a88ff81457934a2a2c0d2855c59be3f32a38725c82846c002faf0453
 SHA512:
-  metadata.gz: d03fac50073991f0f060a2a895320968b22877b8095ac34a1f72266fc60a83882b6a3313390a2252f16952e90d488c17e4bb90340fe22ef67fbbff4bd4b9762d
-  data.tar.gz: f92cfe6f52350dbac3796f0a1765733f92ef761dbb1161b6007a574a29dd17088c067fb3192ee704d25aeab3c02ea5a97d42120f7a20ff05c286df28ffb2e4b2
+  metadata.gz: 6a754e64422834d615d8e14109487217b1c4ae4a6e6f63ce8bb81eb58fc79a4f07aba7a238f118c9e4e70ea5985c77dfbbc317c155f2ba287fe6bde994cc3b32
+  data.tar.gz: 9a9fcf18c7bd5966e3feab9537281d67f61b44d7ad71452d6c4fb6f9d3e30bd12f28021c365b26c2f4c95ae11157d632d20700b7e7fefcdefc2096658812da60

data/CHANGELOG.md

@@ -10,4 +10,14 @@
 - Added .cmd file extension support.
 - Added options for new supports
 - Project text outputs corrected
-- Added launcher to lib folder
+- Added launcher to lib folder
+
+## [1.2.1] - 2025-04-03
+- Project text outputs corrected again
+
+## [1.3] - 2025-04-04
+- Logger support has been added for testing purposes and will be adjusted later.
+
+## [1.3.1] - 2025-04-04
+- Added platform analysis function
+- Logger support fixed

data/lib/utils/displayer.rb

@@ -1,12 +1,16 @@
+require_relative 'logger_helper'
+
 class Displayer
   def initialize(params)
     @params = params
+    @logger = LoggerHelper.instance
   end
 
   def display_params
     begin
       display_text = []
 
+      display_text << "Platform: #{@params[:platform]}" if @params[:platform]
       display_text << "Project Path: #{@params[:project_path]}" if @params[:project_path]
       display_text << "Ruby Path: #{@params[:ruby_path]}" if @params[:ruby_path]
       display_text << "Ruby Folder: #{File.basename(@params[:ruby_path])}" if @params[:ruby_path]
@@ -15,22 +19,21 @@ class Displayer
       display_text << "Launcher Type: #{@params[:launcher_type]}" if @params[:launcher_type]
       display_text << "Template: #{@params[:template]}" if @params[:template]
       display_text << "Template: Default Template" unless @params[:template]
+      display_text << "Log Path: Users Documents Directory"
 
       puts display_text.join("\n") unless display_text.empty?
 
     rescue Exception => e
       print("Display Error: ".red); puts("#{e.message}".red)
+      @logger.error("Display Error: #{e.message}")
     end
   end
 
   def banner
     banner = -<<'BANNER'
-
-┌─┐┌┬┐┌─┐┌┐┌┌┬┐┌─┐┬  ┌─┐┌┐┌┌─┐  ┬─┐┬ ┬┌┐ ┬ ┬
-└─┐ │ ├─┤│││ ││├─┤│  │ ││││├┤   ├┬┘│ │├┴┐└┬┘
-└─┘ ┴ ┴ ┴┘└┘─┴┘┴ ┴┴─┘└─┘┘└┘└─┘  ┴└─└─┘└─┘ ┴ 
-
+Standalone-Ruby v1.3.1
   # Github: https://github.com/ardatetikbey/Standalone-Ruby
+  # RubyGems: https://rubygems.org/gems/standalone-ruby
 
 BANNER
 

data/lib/utils/launcher.rb

@@ -1,36 +1,78 @@
 require 'optparse'
 
 class Launcher
-  
   require_relative 'displayer'
   require_relative 'parameter_parser'
   require_relative 'ruby_copy'
   require_relative 'launcher_handler'
-  # require_relative 'logger_helper'
+  require_relative 'logger_helper'
 
   def initialize
     @parser = ParameterParser.new
     @parser.parse
-
     @params = @parser.params
+
     @displayer = Displayer.new(@params)
     @ruby_copy = RubyCopy.new(@params)
     @launcher_handler = LauncherHandler.new(@params)
+    @logger = LoggerHelper.instance
   end
 
-  def run
-    Signal.trap("INT") do
-      puts "\nProgram interrupted. Shutting down..."
-      exit(0)
+  def platform_analysis
+    case RUBY_PLATFORM
+    when /win32|mingw|cygwin/
+      @params[:platform] = 'Windows'
+      @logger.info("Working on windows platform.")
+    when /darwin/
+      print("Error: ".red); puts("Mac OS platform is not supported at the moment! Exiting...")
+      @logger.error("Mac OS platform is not supported at the moment! Exiting...")
+      exit!
+    when /linux/
+      print("Error: ".red); puts("Linux platform is not supported at the moment! Exiting...")
+      @logger.error("Linux platform is not supported at the moment! Exiting...")
+      exit!
+    else
+      "#{RUBY_PLATFORM}"
     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
 
-    @displayer.banner
-    @displayer.display_params
+      platform_analysis
 
-    @launcher_handler.handle
-    @ruby_copy.robocopy_interpreter
+      @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.")
+      @logger.info("The initiator file creator function has started processing.")
+      @launcher_handler.handle
+      @logger.info("The launcher file creator has finished its function.")
+      @ruby_copy.robocopy_interpreter
+      @logger.info("Ruby interpreter copy function completed.")
+
+      puts "Program Output Path: #{@params[:project_path]}"
+      puts "Thanks for using Standalone-Ruby!"
+      @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
 
-    puts "Program Output Path: #{@params[:project_path]}"
-    puts "Thanks for using Standalone-Ruby!"
+  def yellow
+    "\e[33m#{self}\e[0m"
   end
-end
+end

data/lib/utils/launcher_handler.rb

@@ -1,8 +1,11 @@
 require 'fileutils'
 
+require_relative 'logger_helper'
+
 class LauncherHandler
   def initialize(params)
     @params = params
+    @logger = LoggerHelper.instance
   end
 
   def handle
@@ -18,15 +21,20 @@ class LauncherHandler
 
         user_template = @params[:template].to_s
         content = File.read(user_template)
+        @logger.info("The content of the user 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
         if @params[:launcher_type] == "vbs"
           if @params[:gui] == true
@@ -41,17 +49,23 @@ class LauncherHandler
 
           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("Template file not found!")
+            print("Handler Error: ".red); puts("The template file could not be found.")
+            @logger.error("Template file not found!")
             exit!
           end
         else
@@ -66,23 +80,30 @@ class LauncherHandler
 
           if File.exist?(bat_template)
             content = File.read(bat_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("Handler Error: Template file not found!")
             exit!
           end
         end
       end
     rescue Exception => e
       print("Handler Error: ".red); puts("#{e.message}")
+      @logger.error("Handler Error: #{e.message}")
     end
   end
 end

data/lib/utils/logger_helper.rb

@@ -4,19 +4,21 @@ require 'fileutils'
 
 class LoggerHelper
   def self.instance
-    log_directory = 'program_logs'
-    FileUtils.mkdir_p(log_directory) unless Dir.exist?(log_directory)
+    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 = "#{log_directory}/application_#{timestamp}.log"
+    log_file = File.join(documents_path, "standalone-ruby_#{timestamp}.log")
 
-    @logger ||= Logger.new(log_file)
-    @logger.level = Logger::INFO
+    logger = Logger.new(log_file)
+    logger.level = Logger::INFO
 
-    @logger.formatter = proc do |severity, datetime, msg|
+    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
+    return logger
   end
 end

data/lib/utils/parameter_parser.rb

@@ -1,11 +1,15 @@
 require 'fileutils'
 require 'optparse'
 
+require_relative 'logger_helper'
+
 class ParameterParser
   def initialize
     @params = {
       threads: 5
     }
+
+    @logger = LoggerHelper.instance
   end
 
   def normalize_paths!
@@ -16,52 +20,51 @@ class ParameterParser
 
   def display_help
     help_text = <<~EOT
-    Standalone-Ruby - Make your projects installation independent!
+      Standalone-Ruby - Make your projects installation independent!
 
-    Usage: standalone-ruby [subcommand] [options]
+      Usage: standalone-ruby [subcommand] [options]
 
-    Subcommands:
-      archive   - archived default output
-      exe       - Compressed output to exe file (will be added soon)
-      setup     - Output converted to setup file (will be added soon)
-      zip       - Reduced size archive output (will be added soon)
+      Subcommands:
+        archive   - archived default output
+        exe       - Compressed output to exe file (will be added soon)
+        setup     - Output converted to setup file (will be added soon)
+        zip       - Reduced size archive output (will be added soon)
 
-    Options:
-      -p, --project PROJECT_PATH  Target Ruby project path.
-          Ensures that the given project path exists. If not, an error is displayed.
+      Options:
+        -p, --project PROJECT_PATH  Target Ruby project path.
+            Ensures that the given project path exists. If not, an error is displayed.
 
-      -r, --ruby RUBY_PATH        Path to the Ruby interpreter.
-          Ensures that the given Ruby path exists and contains a 'bin' directory.
+        -r, --ruby RUBY_PATH        Path to the Ruby interpreter.
+            Ensures that the given Ruby path exists and contains a 'bin' directory.
 
-      -m, --main MAIN_FILE        Path to the main Ruby file of the project.
-          Ensures that the specified Ruby file exists.
+        -m, --main MAIN_FILE        Path to the main Ruby file of the project.
+            Ensures that the specified Ruby file exists.
 
-      -l, --launcher LAUNCHER     Launcher file name (either .vbs or .bat-cmd).
-          Ensure the launcher file exists and is of the correct type (either .vbs or .bat-cmd).
+        -l, --launcher LAUNCHER     Launcher file name (either .vbs or .bat-cmd).
+            Ensure the launcher file exists and is of the correct type (either .vbs or .bat-cmd).
 
-      -t, --template TEMPLATE     Template file for launcher.
-          Ensures that the specified template file exists.
+        -t, --template TEMPLATE     Template file for launcher.
+            Ensures that the specified template file exists.
 
-      -c, --threads THREADS       Number of threads to use (default is 5).
-          Determines the number of threads used during the Ruby interpreter copy process and for Rubocopy operations.
-          A higher number of threads can speed up the process, but requires more system resources.
-      
-      -g, --gui                   This option allows the rubyw.exe file in the bin folder to be used.
-          You can choose it for projects that include GUI.
+        -c, --threads THREADS       Number of threads to use (default is 5).
+            Determines the number of threads used during the Ruby interpreter copy process and for Rubocopy operations.
+            A higher number of threads can speed up the process, but requires more system resources.
+        
+        -g, --gui                   This option allows the rubyw.exe file in the bin folder to be used.
+            You can choose it for projects that include GUI.
 
-      -h, --help                  Show this help message.
+        -h, --help                  Show this help message.
 
-      --version                   Show program version.
+        --version                   Show program version.
 
-    For more details, please visit the documentation at:
-      https://github.com/ardatetikbey/Standalone-Ruby
+      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|
@@ -74,6 +77,7 @@ class ParameterParser
             @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
@@ -86,6 +90,7 @@ class ParameterParser
             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
@@ -96,6 +101,7 @@ class ParameterParser
             @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
@@ -105,6 +111,7 @@ class ParameterParser
             @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
@@ -125,6 +132,7 @@ class ParameterParser
             @params[:launcher_name] = File.basename(launcher)
           else
             print("Parser Error: ".red); puts("The supported launcher #{launcher} could not be found!")
+            @logger.error("Parser Error: The supported launcher path #{launcher} could not be found!")
             exit!
           end
         end
@@ -135,6 +143,7 @@ class ParameterParser
             @params[:template] = template
           else
             print("Parser Error: ".red); puts("The specified template file #{template} could not be found!")
+            @logger.error("Parser Error: The specified template file #{template} could not be found!")
             exit!
           end
         end
@@ -144,7 +153,7 @@ class ParameterParser
         end
 
         opts.on("--version") do
-          puts "Standalone Ruby Gem Version 1.2"
+          puts "Standalone Ruby Gem Version 1.3.1"
           exit!
         end
 
@@ -156,12 +165,15 @@ class ParameterParser
 
       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
 
       normalize_paths!
     rescue Exception => e
       print("Parser Error: ".red); puts("#{e.message}".red)
+      @logger.error("Parser Error: #{e.message}")
+      exit!
     end
   end
 

data/lib/utils/ruby_copy.rb

@@ -1,6 +1,9 @@
+require_relative 'logger_helper'
+
 class RubyCopy
   def initialize(params)
     @params = params
+    @logger = LoggerHelper.instance
   end
 
   def robocopy_interpreter
@@ -8,14 +11,17 @@ class RubyCopy
       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"
 
       puts copy_output
+      @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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: standalone-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.1
 platform: ruby
 authors:
 - Arda Tetik
 bindir: bin
 cert_chain: []
-date: 2025-04-02 00:00:00.000000000 Z
+date: 2025-04-04 00:00:00.000000000 Z
 dependencies: []
 description: Make your projects installation independent!
 email: