jarbler 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b29152eb922ef6ae438fb5facfd9c3a7cc8df920ad350254729aca4ad1cccff2
-  data.tar.gz: 632b9ca7b2663a563e5cecdad71c789b3c40f205ff8365c36f37d7b0abe284a6
+  metadata.gz: 2c6eb4bd62cd4f241608b950e6cc12818efba108f75c79650a6ddcfa558315f6
+  data.tar.gz: 13574e8c87bcb8d8a3a3ed2a6263046559982d8de8572aaaa31a24ff81717c62
 SHA512:
-  metadata.gz: 3e560cd914882b62e45ebe20f10b2d7cd9eb7170be0412008afb970dbc1c571fa776d26aa8bf11d49aa205fdd5e05def9d121c876ce897a79b6ddbb8e6df92a4
-  data.tar.gz: 8275b73c22ea2c91cf1db36649a0510b8fbe41d85be39a1ba093f84c4b78adec0cb74ce5345ebe5c4a925f4393ddefa173aebed27b2decbf2eea57f7e4ec3ce0
+  metadata.gz: e87be06e969d43ec0584c96708456404d54011362a681a7f99617f72c3a7108a8e203e7a26279e5106f0f535b75cde0a2f1e3df10874b354816d519893d37161
+  data.tar.gz: 2bffe72a8c78ba10605de7da93002f10eb08018ca17c88f932d1da49abefbfa6b68898f6d3ab22a338435dc57564118c1cf525272c45e277e099182952f0ceb9

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.2.2] - 2024-06-13
+
+- Exclude certain dirs or files from compilation with 'excludes_from_compile' option in config file
+
+## [0.2.1] - 2024-06-13
+
+- Ruby files remain originally in jar if compile fails for a single file. 
+- Gems are compiled only if include_gems_to_compile=true
+
 ## [0.2.0] - 2024-06-12
 
 - Add ahead of time compilation support for JRuby

data/README.md

@@ -53,15 +53,17 @@ To create a template config file with information about all the supported config
 The default configuration is focused on Ruby on Rails applications.<br>
 
 ### Configuration options
-| Option            | Default value                                                                  | Description                                                                                                                                             |
-|-------------------|--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
-| compile_ruby_files| false                                                                          | Ahead of time compilation of all .rb files of application and Gem dependencies to .class files. Only store .class files in jar. Requires JRuby runtime. |
-| executable        | "bin/rails"                                                                    | The ruby start file to run at execution of jar file. File extension .class is used automatically if start file is .rb and AOT compilation is used.      |
-| executable_params | ["server", "-e", "production", "-p", "8080"]                                   | Command line parameters to be used for the ruby executable                                                                                              |
-| excludes          | ["tmp/cache", "tmp/pids", ...] (see generated template file for whole content) | The files and dirs of the project to exlude from the include option                                                                                     |
-| includes          | ["app", "bin", "config", ...] (see generated template file for whole content)  | The files and dirs of the project to include in the jar file                                                                                            |
-| jar_name          | &lt; Name of project dir &gt;.jar                                              | The name of the generated jar file                                                                                                                      |
-| jruby_version     | The current most recent JRuby version                                          | The version of the JRuby runtime to use                                                                                                                 |
+| Option                  | Default value                                                                  | Description                                                                                                                                             |
+|-------------------------|--------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
+| compile_ruby_files      | false                                                                          | Ahead of time compilation of all .rb files of application and Gem dependencies to .class files. Only store .class files in jar. Requires JRuby runtime. |
+| executable              | "bin/rails"                                                                    | The ruby start file to run at execution of jar file. File extension .class is used automatically if start file is .rb and AOT compilation is used.      |
+| executable_params       | ["server", "-e", "production", "-p", "8080"]                                   | Command line parameters to be used for the ruby executable                                                                                              |
+| excludes_from_compile   | ["config"]                                                                     | The files and dirs of the project to exclude from the compilation of .rb files                                                                          |
+| excludes                | ["tmp/cache", "tmp/pids", ...] (see generated template file for whole content) | The files and dirs of the project to exclude from the include option                                                                                    |
+| include_gems_to_compile | false                                                                          | Should .rb files of the project gems also be compiled if compile_ruby_files = true                                                                      |
+| includes                | ["app", "bin", "config", ...] (see generated template file for whole content)  | The files and dirs of the project to include in the jar file                                                                                            |
+| jar_name                | &lt; Name of project dir &gt;.jar                                              | The name of the generated jar file                                                                                                                      |
+| jruby_version           | The current most recent JRuby version                                          | The version of the JRuby runtime to use                                                                                                                 |
 
 
 ## Troubleshooting

data/lib/jarbler/builder.rb

@@ -269,13 +269,31 @@ module Jarbler
         puts "Compiling .rb files to .class is done with JRuby version #{JRUBY_VERSION}, but intended runtime JRuby version for jar file  is #{config.jruby_version}"
       end
 
-      ruby_files = Find.find('.').select { |f| f =~ /\.rb$/ }
+      ruby_files = Find.find('.').select { |f| f =~ /\.rb$/ }                   # find all Ruby files in the current directory
+
+      if !config.include_gems_to_compile
+        ruby_files = ruby_files.select { |f| !(f =~ /\.#{File::SEPARATOR}gems#{File::SEPARATOR}/) } # Exclude ./gems/* directories from compiling
+      end
+
+      # Exclude named files or directories from compiling
+      config.excludes_from_compile.each do |exclude|
+        ruby_files = ruby_files.select { |f| !(f =~ /\.#{File::SEPARATOR}app_root#{File::SEPARATOR}#{exclude}/) }
+      end
+
       ruby_files.each do |ruby_file|
         debug "Compile Ruby file #{ruby_file}"
         full_file_name = File.join(Dir.pwd, ruby_file)                          # full name including path is required by the JRuby compiler
-        status = JRuby::Compiler::compile_argv([full_file_name])                # compile the Ruby file
-        raise "Error compiling Ruby file #{ruby_file}" if status != 0
-        File.delete(full_file_name)                                             # remove the original Ruby file to ensure that the compiled class file is used
+        begin
+          status = JRuby::Compiler::compile_argv([full_file_name])              # compile the Ruby file
+          if status == 0
+            File.delete(full_file_name)                                         # remove the original Ruby file to ensure that the compiled class file is used
+          else
+            raise "Return status != 0"
+          end
+        rescue Exception => e
+          puts "Error compiling Ruby file '#{ruby_file}': #{e.class}:#{e.message}"
+          puts "'#{ruby_file}' is not compiled and will be included in the jar file as original Ruby file"
+        end
       end
     end
   end

data/lib/jarbler/config.rb

@@ -3,7 +3,7 @@ require 'json'
 
 module Jarbler
   class Config
-    attr_accessor :jar_name, :includes, :excludes, :jruby_version, :executable, :executable_params, :compile_ruby_files
+    attr_accessor :jar_name, :includes, :excludes, :jruby_version, :executable, :executable_params, :compile_ruby_files, :include_gems_to_compile, :excludes_from_compile
 
     CONFIG_FILE = 'config/jarble.rb'
     # create instance of Config class with defaults or from config file
@@ -28,12 +28,14 @@ module Jarbler
 
     def initialize
       @compile_ruby_files = false
-      @jar_name = File.basename(Dir.pwd) + '.jar'
-      @includes = %w(app bin config config.ru db Gemfile Gemfile.lock lib log public Rakefile script vendor tmp)
       @excludes = %w(tmp/cache tmp/pids tmp/sockets vendor/bundle vendor/cache vendor/ruby)
-      @jruby_version = nil  # determined automatically at runtime
+      @excludes_from_compile = %w(config)
       @executable = 'bin/rails'
       @executable_params = %w(server -e production -p 8080)
+      @include_gems_to_compile = false
+      @includes = %w(app bin config config.ru db Gemfile Gemfile.lock lib log public Rakefile script vendor tmp)
+      @jar_name = File.basename(Dir.pwd) + '.jar'
+      @jruby_version = nil  # determined automatically at runtime
       # execute additional block if given
       yield self if block_given?
     end
@@ -41,10 +43,6 @@ module Jarbler
     # Generate the template config file based on default values
     def create_config_file
       write_config_file("\
-# Compile the ruby files of the project to Java .class files with JRuby's ahead-of-time compiler
-# the original ruby files are not included in the jar file, so source code is not visible
-# config.compile_ruby_files = #{compile_ruby_files}
-
 # Name of the generated jar file
 # config.jar_name = '#{jar_name}'
 
@@ -67,6 +65,17 @@ module Jarbler
 
 # Additional command line parameters for the Ruby executable
 # config.executable_params = #{executable_params}
+
+# Compile the ruby files of the project to Java .class files with JRuby's ahead-of-time compiler?
+# the original ruby files are not included in the jar file, so source code is not visible
+# config.compile_ruby_files = #{compile_ruby_files}
+
+# Compile also the .rb files of the gems of the project to Java .class files?
+# config.include_gems_to_compile = #{include_gems_to_compile}
+
+# Directories or files to exclude from the compilation if compile_ruby_files = true
+# config.excludes_from_compile = #{excludes_from_compile}
+
       ".split("\n"))
     end
 
@@ -131,6 +140,8 @@ module Jarbler
       raise "Invalid config value for excludes: #{excludes}" unless excludes.is_a?(Array)
       raise "Invalid config value for compile_ruby_files: #{compile_ruby_files}" unless [true, false].include?(compile_ruby_files)
       raise "compile_ruby_files = true is supported only with JRuby! Current runtime is '#{RUBY_ENGINE}'" if compile_ruby_files && (defined?(RUBY_ENGINE) && RUBY_ENGINE != 'jruby')
+      raise "include_gems_to_compile = true is supported only if compile_ruby_files = true!" if include_gems_to_compile && !compile_ruby_files
+      raise "Invalid config value for excludes_from_compile: #{excludes_from_compile}" unless excludes_from_compile.is_a?(Array)
     end
   end
 end

data/lib/jarbler/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Jarbler
-  VERSION = "0.2.0"
-  VERSION_DATE = "2024-06-12"
+  VERSION = "0.2.2"
+  VERSION_DATE = "2024-06-13"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jarbler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Peter Ramm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies: []
 description: Pack a Ruby app combined with JRuby runtime and all its Gem dependencies
   into a jar file to simply run the app on any Java platform by '> java -jar file.jar'