jarbler 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c6eb4bd62cd4f241608b950e6cc12818efba108f75c79650a6ddcfa558315f6
-  data.tar.gz: 13574e8c87bcb8d8a3a3ed2a6263046559982d8de8572aaaa31a24ff81717c62
+  metadata.gz: e5bf0d9d2f693809471939cb344e2eda75ac6c9c270aaa310bd94753b7cf07c9
+  data.tar.gz: e367da474f36bb879d7f443caddffc9daac481979e7275d7eb9ec0f8e39394f0
 SHA512:
-  metadata.gz: e87be06e969d43ec0584c96708456404d54011362a681a7f99617f72c3a7108a8e203e7a26279e5106f0f535b75cde0a2f1e3df10874b354816d519893d37161
-  data.tar.gz: 2bffe72a8c78ba10605de7da93002f10eb08018ca17c88f932d1da49abefbfa6b68898f6d3ab22a338435dc57564118c1cf525272c45e277e099182952f0ceb9
+  metadata.gz: 643e64f9d2752d3be1041fd4607f8e809114dd97ca5a4f5d4cf4caae8dae15919a823f4e42cae5dd764fe9cbaf448e82fc738d09165afca9b042c23cac2e51eb
+  data.tar.gz: f67e8fea36cab2c072cc3c5aaeeb5695d6bda3b2e1e1d134f4a900afaf7d61bfc2b53988059b33c9dd4cc5698d368bbc9fbc43fa99569926a694ead10f638cc9

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.3.0] - 2024-06-18
+
+- excludes_from_compile specifies paths as the location in the jar file
+- Desupport of configuration attribute include_gems_to_compile
+
+## [0.2.3] - 2024-06-13
+
+- Show used configuration values in log output
+
 ## [0.2.2] - 2024-06-13
 
 - Exclude certain dirs or files from compilation with 'excludes_from_compile' option in config file

data/README.md

@@ -53,17 +53,16 @@ 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_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                                                                                                                 |
+| 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   | []                                                                     | The files and dirs of the project to exclude from the compilation of .rb files. Paths specifies the location in the jar file (e.g. ["app_root/file.rb"] ) |
+| 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                                                                                      |
+| 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

@@ -271,13 +271,9 @@ module Jarbler
 
       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}/) }
+        ruby_files = ruby_files.select { |f| !(f =~ /\.#{File::SEPARATOR}#{exclude}/) }
       end
 
       ruby_files.each do |ruby_file|

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, :include_gems_to_compile, :excludes_from_compile
+    attr_accessor :jar_name, :includes, :excludes, :jruby_version, :executable, :executable_params, :compile_ruby_files, :excludes_from_compile
 
     CONFIG_FILE = 'config/jarble.rb'
     # create instance of Config class with defaults or from config file
@@ -23,16 +23,32 @@ module Jarbler
       config.executable = config.executable.sub(/\.rb$/, '.class') if config.compile_ruby_files
 
       config.validate_values
+
+      puts ""
+      if File.exist?(CONFIG_FILE)
+        puts "Configuration loaded from file #{File.join(Dir.pwd, CONFIG_FILE)}"
+      else
+        puts "No configuration file found at #{File.join(Dir.pwd, CONFIG_FILE)}. Using default values."
+      end
+      puts "Used configuration values are:"
+      puts "  compile_ruby_files:       #{config.compile_ruby_files}" if config.compile_ruby_files
+      puts "  excludes:                 #{config.excludes}" unless config.excludes.empty?
+      puts "  excludes_from_compile:    #{config.excludes_from_compile}" unless config.excludes_from_compile.empty?
+      puts "  executable:               #{config.executable}"
+      puts "  executable_params:        #{config.executable_params}" unless config.executable_params.empty?
+      puts "  includes:                 #{config.includes}" unless config.includes.empty?
+      puts "  jar_name:                 #{config.jar_name}"
+      puts "  jruby_version:            #{config.jruby_version}"
+      puts ""
       config
     end
 
     def initialize
       @compile_ruby_files = false
       @excludes = %w(tmp/cache tmp/pids tmp/sockets vendor/bundle vendor/cache vendor/ruby)
-      @excludes_from_compile = %w(config)
+      @excludes_from_compile = []
       @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
@@ -70,10 +86,8 @@ module Jarbler
 # 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
+# The paths map to the final location of files or dirs in the jar file, e.g. config.excludes_from_compile = ['gems', 'app_root/app/models']
 # config.excludes_from_compile = #{excludes_from_compile}
 
       ".split("\n"))
@@ -132,6 +146,11 @@ module Jarbler
       puts msg if ENV['DEBUG']
     end
 
+    # Avoid exception if using depprecated config attribute include_gems_to_compile
+    def include_gems_to_compile=(_value)
+      puts "Configuration attribute 'include_gems_to_compile' is deprecated. Use 'excludes_from_compile = [\”gems\”]' instead."
+    end
+
     def validate_values
       raise "Invalid config value for jar name: #{jar_name}" unless jar_name =~ /\w+/
       raise "Invalid config value for executable: #{executable}" unless executable =~ /\w+/
@@ -140,7 +159,6 @@ 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

data/lib/jarbler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jarbler
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Peter Ramm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-13 00:00:00.000000000 Z
+date: 2024-06-16 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'