jlauncher 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2053dc8be4fa27e96da72d166e91aadca5b844411379f6a02b405e8460c549f
-  data.tar.gz: 875802232d73a9f8cd00e4e04dc9b84bf20b363cc72b3cf1283539ce019db958
+  metadata.gz: 2f5d6f1b0fc056dde808d74d238cdbf91ca0f335341d884b2cad35f0925747a6
+  data.tar.gz: 5e221c1acf04898b192dbb5b94b92ee30e59913d1a273c5c95bdf702b66d6bde
 SHA512:
-  metadata.gz: 9fbe5c05c3d98f56cf965efed5bc4a539f9f6cf9e125f2df6dcb0cbc3fc0c7d0d5cab7089c88923550c7d1f710ea7779e3d8cdcf6a4c36060f977c0b3660c16d
-  data.tar.gz: a5caa48508b6d1d4ec7f8a8602bcb841401de95f4acec288c52b68c8efdd6f2791148be268131652a2f365b9bb71bb8eb93c281ae09ceb49f7cbe0030860cd75
+  metadata.gz: 160b96d74861c7cda6dbc325d0961157b413e51377659f529c7f677d7ec81f2873014f52f9d71d04f2925a95f62f880c86ae3a3872e2426009bb3a186dba92a5
+  data.tar.gz: 43ecb79b1872658b6f0201de4132085ec7c244fe4aa8f44220b4d35784fd78b5ba789f861851de41baec6e2000488eadd65f8540f35906d55612800eaa284d0b

data/Gemfile.lock

@@ -18,7 +18,7 @@ GEM
     minitest (5.10.3)
     multi_xml (0.6.0)
     optimist (3.0.1)
-    rake (10.5.0)
+    rake (13.0.1)
     rubyzip (2.3.0)
 
 PLATFORMS
@@ -28,7 +28,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   jlauncher!
   minitest (~> 5.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
 
 BUNDLED WITH
    1.16.1

data/exe/{j → jlauncher}

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
-require 'j'
+require 'jlauncher'
 
 JLauncher.do_it(ARGV)

data/jlauncher.gemspec

@@ -1,7 +1,6 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "j/version"
+require "jlauncher/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "jlauncher"
@@ -11,7 +10,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Launches jvm software from central repos}
   spec.description   = %q{Uses fully resolved dependencies to get and start software from central repos}
-  spec.homepage      = "https://wuetender-junger-mann.de"
+  spec.homepage      = "https://github.com/softwaretechnik-berlin/jlauncher"
   spec.license       = "MIT"
 
   
@@ -23,10 +22,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 
   spec.add_dependency('optimist')
+  spec.add_dependency('colorize')
   spec.add_dependency('rubyzip')
   spec.add_dependency('httparty')
 end

data/lib/jlauncher.rb

@@ -0,0 +1,204 @@
+require "jlauncher/version"
+require 'zip'
+require 'json'
+require 'jlauncher/repos'
+require 'jlauncher/common.rb'
+require 'optimist'
+require 'fileutils'
+require 'colorize'
+
+module JLauncher
+
+  def JLauncher.do_it(argv)
+    parser = Optimist::Parser.new
+    parser.stop_on_unknown
+    parser.stop_on %w(run install)
+    parser.version VERSION
+    parser.banner <<-EOS
+Starts a jar with a j-manifest.json description fetching (and caching) all dependencies.
+
+Usage:
+.. j [options] <run|install> <jarfile|manifestfile|mavencoordinates> args...
+where [options] are:
+    EOS
+    parser.opt :verbose, "Print debugging info to stderr"
+
+    begin
+      opts = parser.parse(argv)
+    rescue Optimist::CommandlineError => e
+      parser.die(e.message, nil, e.error_code)
+    rescue Optimist::HelpNeeded
+      parser.educate
+      exit
+    rescue Optimist::VersionNeeded
+      puts parser.version
+      exit
+    end
+
+    verbose = opts[:verbose]
+
+    remaining_args = parser.leftovers
+
+    subcommand = remaining_args.shift
+
+    start_coordinates = remaining_args.shift
+
+    program_args = remaining_args[0..-1]
+
+    resolver = Resolver.new(
+        MavenRepo.new(File.join(Dir.home, ".m2", "repository")),
+        IvyRepo.new(File.join(Dir.home, ".ivy2")),
+        MavenRemote.new("https://repo1.maven.org/maven2"),
+        verbose
+    )
+
+    full_config = if File.exist?(start_coordinates)
+                    if (start_coordinates.end_with?(".jar"))
+                      STDERR.puts("Starting local jar") if verbose
+
+                      start_coordinates = File.expand_path(start_coordinates)
+
+                      extra_class_path = "file:" + File.expand_path(start_coordinates)
+
+
+                      manifest = read_manifest(start_coordinates)
+                      FullConfig.new(manifest, extra_class_path)
+                    else
+                      STDERR.puts("Starting local manifest") if verbose
+
+                      manifest = Manifest.new(JSON.parse(File.read(start_coordinates)))
+
+                      extra_class_path = NIL
+                      FullConfig.new(manifest, extra_class_path)
+                    end
+                  else
+                    STDERR.puts("Starting from repo jar") if verbose
+
+                    components = start_coordinates.split(":")
+                    if components.length != 3
+                      raise "'#{start_coordinates}' is not a valid coordinate use <groupId>:<artifactId>:<version>"
+                    end
+
+                    main_jar = resolver.get(Coordinates.new(start_coordinates))
+
+                    manifest = read_manifest(main_jar)
+                    extra_class_path = "maven:" + start_coordinates
+                    FullConfig.new(manifest, extra_class_path)
+                  end
+
+    if subcommand == "run"
+      launch_config = full_config.launch_config(resolver)
+
+      launch_config.run(program_args)
+    else
+      if subcommand == "install"
+        bin_dir = File.expand_path("~/.config/jlauncher/bin")
+        executable_path = bin_dir + "/" + (manifest.executable_name || "testme")
+        FileUtils.mkdir_p(bin_dir)
+        File.write(executable_path, <<~HEREDOC
+        #!/usr/bin/env bash        
+        
+        set -e
+        set -u
+        set -o pipefail
+
+        jlauncher run #{start_coordinates} "$@"
+        HEREDOC
+        )
+
+        File.chmod(0755, executable_path)
+        check_path(bin_dir)
+
+        STDERR.puts("'#{start_coordinates}' has been installed as #{manifest.executable_name.bold}.")
+      else
+        raise "'#{subcommand}' is not a valid subcommand."
+      end
+    end
+  end
+
+  def self.check_path(bin_dir)
+    path_entries = ENV['PATH'].split(":").map{|path| File.expand_path(path)}
+    if (!path_entries.include?(bin_dir))
+      STDERR.puts("Warning: The jlauncher binary path is not on the system path. You can add it to your .bashrc like so:".yellow)
+      STDERR.puts("export PATH=$PATH:#{bin_dir}\n\n")
+    end
+  end
+
+  def self.read_manifest(jarfile)
+    Zip::File.open(jarfile) do |zip_file|
+      entry = zip_file.glob('j-manifest.json').first
+      Manifest.new(JSON.parse(entry.get_input_stream.read))
+    end
+  end
+
+
+  # All the info that is needed to launch
+  class JvmLaunchConfig
+    def initialize(classpath_elements, main_class)
+
+      @main_class = main_class
+      @classpath_elements = classpath_elements
+    end
+
+    def run(args)
+      classpath = @classpath_elements.join(File::PATH_SEPARATOR)
+      exec("java", "-cp", "#{classpath}", "#{@main_class}", *args)
+    end
+  end
+
+
+  # The full configuration needed to start a program has a manifest
+  # plus an optional extra_class_path element, which contains either
+  # maven coordinates or a local file containing a jar
+  class FullConfig
+    def initialize(manifest, extra_class_path)
+      @manifest = manifest
+      @extra_class_path = extra_class_path
+
+    end
+
+    def launch_config(resolver)
+      class_path_from_manifest = @manifest.dependencies.map {
+          |c| resolver.get(c)
+      }
+
+      if @extra_class_path
+        split_index = @extra_class_path.index(":")
+        protocol = @extra_class_path[0..split_index - 1]
+        value = @extra_class_path[split_index + 1..-1]
+        extra_element = case protocol
+                        when "file"
+                          value
+                        when "maven"
+                          resolver.get(Coordinates.new(value))
+                        end
+        class_path_from_manifest = class_path_from_manifest << extra_element
+      end
+
+      JvmLaunchConfig.new(
+          class_path_from_manifest,
+          @manifest.main_class
+      )
+    end
+  end
+
+
+  # A wrapper around the manifest file
+  class Manifest
+    def initialize(json_map)
+      @json_map = json_map
+    end
+
+    def dependencies
+      @json_map['dependencies'].map { |dep| Coordinates.new(dep) }
+    end
+
+    def main_class
+      @json_map['mainClass']
+    end
+
+    def executable_name
+      @json_map['executableName']
+    end
+  end
+end

data/lib/{j → jlauncher}/version.rb

@@ -1,3 +1,3 @@
 module JLauncher
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jlauncher
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Felix Leipold
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +113,7 @@ description: Uses fully resolved dependencies to get and start software from cen
 email:
 - felix.leipold@gmail.com
 executables:
-- j
+- jlauncher
 extensions: []
 extra_rdoc_files: []
 files:
@@ -109,14 +123,14 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- exe/j
+- exe/jlauncher
 - jlauncher.gemspec
-- lib/j.rb
-- lib/j/common.rb
-- lib/j/repos.rb
-- lib/j/version.rb
+- lib/jlauncher.rb
+- lib/jlauncher/common.rb
+- lib/jlauncher/repos.rb
+- lib/jlauncher/version.rb
 - test.rb
-homepage: https://wuetender-junger-mann.de
+homepage: https://github.com/softwaretechnik-berlin/jlauncher
 licenses:
 - MIT
 metadata: {}
@@ -135,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Launches jvm software from central repos

data/lib/j.rb

@@ -1,125 +0,0 @@
-require "j/version"
-require 'zip'
-require 'json'
-require 'j/repos'
-require 'j/common.rb'
-require 'optimist'
-
-module JLauncher
-
-    def JLauncher.do_it(argv)
-        parser = Optimist::Parser.new
-        parser.stop_on_unknown
-        parser.version VERSION
-        parser.banner <<-EOS
-Starts a jar with a j-manifest.json description fetching (and caching) all dependencies.
-
-Usage:
-.. j [options] <jarfile|manifestfile|mavencoordinates> args...
-where [options] are:
-        EOS
-        parser.opt :verbose, "Print debugging info to stderr"
-
-        begin
-            opts = parser.parse(argv)
-        rescue Optimist::CommandlineError => e
-            parser.die(e.message, nil, e.error_code)
-        rescue Optimist::HelpNeeded
-            parser.educate
-            exit
-        rescue Optimist::VersionNeeded
-            puts parser.version
-            exit
-        end
-
-        verbose = opts[:verbose]
-        remaining_args = parser.leftovers
-        start_param = remaining_args[0]
-        program_args = remaining_args[1..-1]
-
-        resolver = Resolver.new(
-            MavenRepo.new(File.join(Dir.home, ".m2", "repository")),
-            IvyRepo.new(File.join(Dir.home, ".ivy2")),
-            MavenRemote.new("https://repo1.maven.org/maven2"),
-            verbose
-        )
-
-        start_info = if File.file?(start_param)
-                       if (start_param.end_with?(".jar"))
-                        STDERR.puts("Starting local jar") if verbose
-
-                        manifest = read_manifest(start_param)
-
-                        StartInfo.new(manifest.dependencies.map {|c| resolver.get(c)} << start_param, manifest.main_class)
-                       else
-                         STDERR.puts("Starting local manifest") if verbose
-
-                         manifest = Manifest.new(JSON.parse(File.read(start_param)))
-
-                         StartInfo.new(manifest.dependencies.map {|c| resolver.get(c)} << start_param, manifest.main_class)
-                       end
-                     else
-                         STDERR.puts("Starting from repo jar") if verbose
-
-                         components = start_param.split(":")
-                         if components.length != 3
-                             raise "'#{start_param}' is not a valid coordinate use <groupId>:<artifactId>:<version>"
-                         end
-
-                         main_jar = resolver.get(Coordinates.new({
-                             'groupId' => components[0],
-                             'artifactId' => components[1],
-                             'version' => components[2]
-                         }))
-
-                         manifest = read_manifest(main_jar)
-
-                         StartInfo.new(manifest.dependencies.map {|c| resolver.get(c)} << main_jar, manifest.main_class)
-                    end
-
-        start_info.run(program_args)
-        
-        classpath = classpath_elements.join(File::PATH_SEPARATOR)
-        exec("java", "-cp", "#{classpath}", "#{manifest.main_class}")
-    end
-
-    def self.read_manifest(jarfile)
-        Zip::File.open(jarfile) do |zip_file|
-            entry = zip_file.glob('j-manifest.json').first 
-            Manifest.new(JSON.parse(entry.get_input_stream.read))
-        end
-    end
-
-
-    # All the info that is needed to launch
-    class StartInfo
-        def initialize(classpath_elements, main_class)
-
-            @main_class = main_class
-            @classpath_elements = classpath_elements
-        end
-
-        def run(args)
-            classpath = @classpath_elements.join(File::PATH_SEPARATOR)
-            exec("java", "-cp", "#{classpath}", "#{@main_class}",  *args)
-        end
-
-    end
-
-    
-    # A wrapper around the manifest file
-    class Manifest
-        def initialize(json_map)
-            @json_map = json_map
-        end
-
-        def dependencies
-            @json_map['dependencies'].map {|dep| Coordinates.new(dep)}
-        end
-
-        def main_class
-            @json_map['mainClass']
-        end
-    end
-
-end