jar-dependencies 0.4.1 → 0.5.0

data/lib/jars/gemspec_artifacts.rb

@@ -1,58 +1,62 @@
+# frozen_string_literal: true
+
 module Jars
   class MavenVersion < String
-    def self.new(*args)
-      if args.empty? || (args.size == 1 && args[0].nil?)
-        nil
-      else
-        low, high = convert(args[0])
-        low, high = convert(args[1], low, high) if args[1] =~ /[=~><]/
-        if low == high
-          low
+    class << self
+      def new(*args)
+        if args.empty? || (args.size == 1 && args[0].nil?)
+          nil
         else
-          super "#{low || '[0'},#{high || ')'}"
+          low, high = convert(args[0])
+          low, high = convert(args[1], low, high) if /[=~><]/.match?(args[1])
+          if low == high
+            low
+          else
+            super "#{low || '[0'},#{high || ')'}"
+          end
         end
       end
-    end
 
-    private
-
-    def self.convert(arg, low = nil, high = nil)
-      if arg =~ /~>/
-        val = arg.sub(/~>\s*/, '')
-        last = val =~ /\./ ? val.sub(/\.[0-9]*[a-z]+.*$/, '').sub(/\.[^.]+$/, '.99999') : '99999'
-        ["[#{snapshot_version(val)}", "#{snapshot_version(last)}]"]
-      elsif arg =~ />=/
-        val = arg.sub(/>=\s*/, '')
-        ["[#{snapshot_version(val)}", (nil || high)]
-      elsif arg =~ /<=/
-        val = arg.sub(/<=\s*/, '')
-        [(nil || low), "#{snapshot_version(val)}]"]
-      # treat '!' the same way as '>' since maven can not describe such range
-      elsif arg =~ /[!>]/
-        val = arg.sub(/[!>]\s*/, '')
-        ["(#{snapshot_version(val)}", (nil || high)]
-      elsif arg =~ /</
-        val = arg.sub(/<\s*/, '')
-        [(nil || low), "#{snapshot_version(val)})"]
-      elsif arg =~ /\=/
-        val = arg.sub(/=\s*/, '')
-        # for prereleased version pick the maven version (no version range)
-        if val =~ /[a-z]|[A-Z]/
-          [val, val]
+      private
+
+      def convert(arg, low = nil, high = nil)
+        if arg.include?('~>')
+          val = arg.sub(/~>\s*/, '')
+          last = val.include?('.') ? val.sub(/\.[0-9]*[a-z]+.*$/, '').sub(/\.[^.]+$/, '.99999') : '99999'
+          ["[#{snapshot_version(val)}", "#{snapshot_version(last)}]"]
+        elsif arg.include?('>=')
+          val = arg.sub(/>=\s*/, '')
+          ["[#{snapshot_version(val)}", (nil || high)]
+        elsif arg.include?('<=')
+          val = arg.sub(/<=\s*/, '')
+          [(nil || low), "#{snapshot_version(val)}]"]
+        # treat '!' the same way as '>' since maven can not describe such range
+        elsif /[!>]/.match?(arg)
+          val = arg.sub(/[!>]\s*/, '')
+          ["(#{snapshot_version(val)}", (nil || high)]
+        elsif arg.include?('<')
+          val = arg.sub(/<\s*/, '')
+          [(nil || low), "#{snapshot_version(val)})"]
+        elsif arg.include?('=')
+          val = arg.sub(/=\s*/, '')
+          # for prereleased version pick the maven version (no version range)
+          if /[a-z]|[A-Z]/.match?(val)
+            [val, val]
+          else
+            ["[#{val}", "#{val}.0.0.0.0.1)"]
+          end
         else
-          ["[#{val}", "#{val}.0.0.0.0.1)"]
+          # no conversion here, i.e. assume maven version
+          [arg, arg]
         end
-      else
-        # no conversion here, i.e. assume maven version
-        [arg, arg]
       end
-    end
 
-    def self.snapshot_version(val)
-      if val.match(/[a-z]|[A-Z]/) && !val.match(/-SNAPSHOT|[${}]/)
-        val + '-SNAPSHOT'
-      else
-        val
+      def snapshot_version(val)
+        if val.match(/[a-z]|[A-Z]/) && !val.match(/-SNAPSHOT|[${}]/)
+          "#{val}-SNAPSHOT"
+        else
+          val
+        end
       end
     end
   end
@@ -79,7 +83,7 @@ module Jars
       def initialize(line)
         super()
         line.gsub(/'"|^\s*\[|\]\s*$/, '').split(/,\s*/).each do |exclusion|
-          self.<< Exclusion.new(exclusion)
+          self << Exclusion.new(exclusion)
         end
         freeze
       end
@@ -93,7 +97,7 @@ module Jars
       def initialize(options, *args)
         @type, @group_id, @artifact_id, @classifier, @version, @exclusions = *args
         options.each do |k, v|
-          instance_variable_set("@#{k}", v)
+          instance_variable_set(:"@#{k}", v)
         end
       end
 
@@ -101,9 +105,11 @@ module Jars
         line = line.strip
         index = line.index(/\s/)
         return nil if index.nil?
+
         type = line[0..index].strip
         return nil unless ALLOWED_TYPES.member?(type)
-        line = line[index..-1]
+
+        line = line[index..]
         line.gsub!(/['"]/, '')
         line.strip!
 
@@ -118,20 +124,20 @@ module Jars
         end
         exclusions = nil
         line.sub!(/[,:]\s*\[(.+:.+,?\s*)+\]$/) do |a|
-          exclusions = Exclusions.new(a[1..-1].strip)
+          exclusions = Exclusions.new(a[1..].strip)
           ''
         end
 
         line.strip!
         line.gsub!(/,\s*/, ':')
 
-        if line =~ /[\[\(\)\]]/
-          index = line.index(/[\[\(].+$/)
-          version = line[index..-1].sub(/:/, ', ')
+        if /[\[()\]]/.match?(line)
+          index = line.index(/[\[(].+$/)
+          version = line[index..].sub(/:/, ', ')
           line = line[0..index - 1].strip.sub(/:$/, '')
         else
-          index = line.index(/[:][^:]+$/)
-          version = line[index + 1..-1]
+          index = line.index(/:[^:]+$/)
+          version = line[index + 1..]
           line = line[0..index - 1].strip
         end
 
@@ -153,7 +159,7 @@ module Jars
         args << @classifier if @classifier
         args << @version
         args << @exclusions.to_s if @exclusions
-        "#{@type} #{group_id}:#{args[1..-1].join(', ')}"
+        "#{@type} #{group_id}:#{args[1..].join(', ')}"
       end
 
       def to_gacv
@@ -190,7 +196,7 @@ module Jars
     def initialize(spec)
       @artifacts = []
       spec.requirements.each do |req|
-        req.split(/\n/).each do |line|
+        req.split("\n").each do |line|
           if (a = Artifact.new(line))
             @artifacts << a
           end

data/lib/jars/gemspec_pom.rb

@@ -1,5 +1,11 @@
+# frozen_string_literal: true
+
 # this file is maven DSL and used by maven via jars/maven_exec.rb
 
-eval(File.read(File.join(File.dirname(__FILE__), 'attach_jars_pom.rb')))
+def eval_file(file)
+  file = File.join(__dir__, file)
+  eval(File.read(file), nil, file)  # rubocop:disable Security/Eval
+end
 
-eval(File.read(File.join(File.dirname(__FILE__), 'output_jars_pom.rb')))
+eval_file('attach_jars_pom.rb')
+eval_file('output_jars_pom.rb')

data/lib/jars/installer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jar_dependencies'
 require 'jars/maven_exec'
 
@@ -7,7 +9,7 @@ module Jars
       attr_reader :path, :file, :gav, :scope, :type, :coord
 
       def self.new(line)
-        super if line =~ /:jar:|:pom:/
+        super if /:jar:|:pom:/.match?(line)
       end
 
       def setup_type(line)
@@ -32,21 +34,21 @@ module Jars
       end
       private :setup_scope
 
-      REG = /:jar:|:pom:|:test:|:compile:|:runtime:|:provided:|:system:/
-      EMPTY = ''.freeze
+      REG = /:jar:|:pom:|:test:|:compile:|:runtime:|:provided:|:system:/.freeze
+      EMPTY = ''
       def initialize(line)
         setup_type(line)
 
         line.strip!
         @coord = line.sub(/:[^:]+:([A-Z]:\\)?[^:]+$/, EMPTY)
         first, second = @coord.split(/:#{type}:/)
-        group_id, artifact_id = first.split(/:/)
+        group_id, artifact_id = first.split(':')
         parts = group_id.split('.')
         parts << artifact_id
         parts << second.split(':')[-1]
         @file = line.slice(@coord.length, line.length).sub(REG, EMPTY).strip
-        last = @file.reverse.index(/\\|\//)
-        parts << line[-last..-1]
+        last = @file.reverse.index(%r{\\|/})
+        parts << line[-last..]
         @path = File.join(parts).strip
 
         setup_scope(line)
@@ -60,8 +62,8 @@ module Jars
       end
     end
 
-    def self.install_jars(write_require_file = false)
-      new.install_jars(write_require_file)
+    def self.install_jars(write_require_file: false)
+      new.install_jars(write_require_file: write_require_file)
     end
 
     def self.load_from_maven(file)
@@ -73,76 +75,53 @@ module Jars
       result
     end
 
-    def self.write_require_file(require_filename)
-      warn 'deprecated'
-      if needs_to_write?(require_filename)
-        FileUtils.mkdir_p(File.dirname(require_filename))
-        f = File.open(require_filename, 'w')
-        f.puts COMMENT
-        f.puts "require 'jar_dependencies'"
-        f.puts
-        f
-      end
-    end
-
     def self.vendor_file(dir, dep)
-      if !dep.system? && dep.type == :jar && dep.scope == :runtime
-        vendored = File.join(dir, dep.path)
-        FileUtils.mkdir_p(File.dirname(vendored))
-        FileUtils.cp(dep.file, vendored)
-      end
-    end
+      return unless !dep.system? && dep.type == :jar && dep.scope == :runtime
 
-    def self.write_dep(file, _dir, dep, _vendor)
-      warn 'deprecated'
-      print_require_jar(file, dep)
+      vendored = File.join(dir, dep.path)
+      FileUtils.mkdir_p(File.dirname(vendored))
+      FileUtils.cp(dep.file, vendored)
     end
 
-    def self.print_require_jar(file, dep, fallback = false)
+    def self.print_require_jar(file, dep, fallback: false)
       return if dep.type != :jar || dep.scope != :runtime
+
       if dep.system?
-        file.puts("require '#{dep.file}'") if file
+        file&.puts("require '#{dep.file}'")
       elsif dep.scope == :runtime
         if fallback
-          file.puts("  require '#{dep.path}'") if file
+          file&.puts("  require '#{dep.path}'")
         else
-          file.puts("  require_jar '#{dep.gav.gsub(':', "', '")}'") if file
+          file&.puts("  require_jar '#{dep.gav.gsub(':', "', '")}'")
         end
       end
     end
 
-    COMMENT = '# this is a generated file, to avoid over-writing it just delete this comment'.freeze
+    COMMENT = '# this is a generated file, to avoid over-writing it just delete this comment'
     def self.needs_to_write?(require_filename)
       require_filename && (!File.exist?(require_filename) || File.read(require_filename).match(COMMENT))
     end
 
-    def self.install_deps(deps, dir, require_filename, vendor)
-      warn 'deprecated'
-      write_require_jars(deps, require_filename)
-      vendor_jars(deps, dir) if dir && vendor
-    end
-
     def self.write_require_jars(deps, require_filename)
-      if needs_to_write?(require_filename)
-        FileUtils.mkdir_p(File.dirname(require_filename))
-        File.open(require_filename, 'w') do |f|
-          f.puts COMMENT
-          f.puts 'begin'
-          f.puts "  require 'jar_dependencies'"
-          f.puts 'rescue LoadError'
-          deps.each do |dep|
-            # do not use require_jar method
-            print_require_jar(f, dep, true)
-          end
-          f.puts 'end'
-          f.puts
-          f.puts 'if defined? Jars'
-          deps.each do |dep|
-            print_require_jar(f, dep)
-          end
-          f.puts 'end'
-          yield f if block_given?
+      return unless needs_to_write?(require_filename)
+
+      FileUtils.mkdir_p(File.dirname(require_filename))
+      File.open(require_filename, 'w') do |f|
+        f.puts COMMENT
+        f.puts 'begin'
+        f.puts "  require 'jar_dependencies'"
+        f.puts 'rescue LoadError'
+        deps.each do |dep|
+          # do not use require_jar method
+          print_require_jar(f, dep, fallback: true)
         end
+        f.puts 'end'
+        f.puts
+        f.puts 'if defined? Jars'
+        deps.each do |dep|
+          print_require_jar(f, dep)
+        end
+        f.puts 'end'
       end
     end
 
@@ -160,8 +139,9 @@ module Jars
       @mvn.spec
     end
 
-    def vendor_jars(write_require_file = true, vendor_dir = nil)
-      return unless has_jars?
+    def vendor_jars(vendor_dir = nil, write_require_file: true)
+      return unless jars?
+
       if Jars.to_prop(Jars::VENDOR) == 'false'
         vendor_dir = nil
       else
@@ -171,16 +151,17 @@ module Jars
     end
 
     def self.vendor_jars!(vendor_dir = nil)
-      new.vendor_jars!(true, vendor_dir)
+      new.vendor_jars!(vendor_dir)
     end
 
-    def vendor_jars!(write_require_file = true, vendor_dir = nil)
+    def vendor_jars!(vendor_dir = nil, write_require_file: true)
       vendor_dir ||= spec.require_path
       do_install(vendor_dir, write_require_file)
     end
 
-    def install_jars(write_require_file = true)
-      return unless has_jars?
+    def install_jars(write_require_file: true)
+      return unless jars?
+
       do_install(nil, write_require_file)
     end
 
@@ -188,12 +169,12 @@ module Jars
       @mvn.ruby_maven_install_options = options
     end
 
-    def has_jars?
+    def jars?
       # first look if there are any requirements in the spec
       # and then if gem depends on jar-dependencies for runtime.
       # only then install the jars declared in the requirements
       result = (spec = self.spec) && !spec.requirements.empty? &&
-               spec.dependencies.detect { |d| d.name == 'jar-dependencies' && d.type == :runtime } != nil
+               spec.dependencies.detect { |d| d.name == 'jar-dependencies' && d.type == :runtime }
       if result && spec.platform.to_s != 'java'
         Jars.warn "\njar dependencies found on non-java platform gem - do not install jars\n"
         false
@@ -201,7 +182,6 @@ module Jars
         result
       end
     end
-    alias jars? has_jars?
 
     private
 
@@ -209,6 +189,7 @@ module Jars
       if !spec.require_paths.include?(vendor_dir) && vendor_dir
         raise "vendor dir #{vendor_dir} not in require_paths of gemspec #{spec.require_paths}"
       end
+
       target_dir = File.join(@mvn.basedir, vendor_dir || spec.require_path)
       jars_file = File.join(target_dir, "#{spec.name}_jars.rb")
 
@@ -223,7 +204,7 @@ module Jars
       end
       deps = install_dependencies
       self.class.write_require_jars(deps, jars_file)
-      self.class.vendor_jars(deps, target_dir) if vendor_dir
+      self.class.vendor_jars(target_dir, write_require_file: deps) if vendor_dir
     end
 
     def install_dependencies
@@ -237,6 +218,4 @@ module Jars
       FileUtils.rm_f(deps) if deps
     end
   end
-  # to stay backward compatible
-  JarInstaller = Installer unless defined? JarInstaller
 end

data/lib/jars/lock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jars/maven_exec'
 
 module Jars
@@ -24,7 +26,9 @@ module Jars
     end
 
     def classifier
-      size == 5 ? nil : self[2]
+      return nil if size == 5
+
+      self[2]
     end
 
     def gacv
@@ -38,7 +42,7 @@ module Jars
           ENV_JAVA[a[2..-2]] || a
         end
       else
-        File.join(Jars.home, group_id.gsub(/[.]/, '/'), artifact_id, version, gacv[1..-1].join('-') + '.jar')
+        File.join(Jars.home, group_id.gsub(/[.]/, '/'), artifact_id, version, "#{gacv[1..].join('-')}.jar")
       end
     end
   end
@@ -51,10 +55,11 @@ module Jars
     def process(scope)
       scope ||= :runtime
       File.read(@file).each_line do |line|
-        next if line !~ /:.+:/
-        jar = JarDetails.new(line.strip.sub(/:jar:/, ':').sub(/:$/, ': ').split(/:/))
+        next unless /:.+:/.match?(line)
+
+        jar = JarDetails.new(line.strip.sub(/:jar:/, ':').sub(/:$/, ': ').split(':'))
         case scope
-        when :all
+        when :all, :test
           yield jar
         when :compile
           # jar.scope is maven scope
@@ -65,8 +70,6 @@ module Jars
         when :runtime
           # jar.scope is maven scope
           yield jar if (jar.scope != :test) && (jar.scope != :provided)
-        when :test
-          yield jar
         end
       end
     end

data/lib/jars/lock_down.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'jar_dependencies'
 require 'jars/version'
@@ -15,7 +17,7 @@ module Jars
 
     def maven_new
       factory = MavenFactory.new({}, @debug, @verbose)
-      pom = File.expand_path('../lock_down_pom.rb', __FILE__)
+      pom = File.expand_path('lock_down_pom.rb', __dir__)
       m = factory.maven_new(pom)
       m['jruby.plugins.version'] = Jars::JRUBY_PLUGINS_VERSION
       m['dependency.plugin.version'] = Jars::DEPENDENCY_PLUGIN_VERSION
@@ -41,50 +43,40 @@ module Jars
       # TODO: make this group a commandline option
       Bundler.setup('default')
       maven.property('jars.bundler', true)
-      done = []
-      index = 0
       cwd = File.expand_path('.')
       Gem.loaded_specs.each do |_name, spec|
         # if gemspec is local then include all dependencies
-        maven.attach_jars(spec, cwd == spec.full_gem_path)
+        maven.attach_jars(spec, all_dependencies: cwd == spec.full_gem_path)
       end
-    rescue Exception => e
-      case e.class.to_s
-      when 'LoadError'
-        if Jars.verbose?
-          warn e.message
-          warn 'no bundler found - ignore Gemfile if exists'
-        end
-      when 'Bundler::GemfileNotFound'
-        # do nothing then as we have bundler but no Gemfile
-      when 'Bundler::GemNotFound'
-        warn "can not setup bundler with #{Bundler.default_lockfile}"
-        raise e
-      else
-        # reraise exception so user sees it
-        raise e
+    rescue LoadError => e
+      if Jars.verbose?
+        warn e.message
+        warn 'no bundler found - ignore Gemfile if exists'
       end
+    rescue Bundler::GemfileNotFound
+    # do nothing then as we have bundler but no Gemfile
+    rescue Bundler::GemNotFound
+      warn "can not setup bundler with #{Bundler.default_lockfile}"
+      raise
     ensure
       $LOAD_PATH.replace(load_path)
     end
 
-    def lock_down(options = {})
-      vendor_dir = File.expand_path(options[:vendor_dir]) if options[:vendor_dir]
+    def lock_down(vendor_dir = nil, force: false, update: false, tree: nil)
       out = File.expand_path('.jars.output')
-      tree = File.expand_path('.jars.tree')
+      tree_provided = tree
+      tree ||= File.expand_path('.jars.tree')
       maven.property('jars.outputFile', out)
       maven.property('maven.repo.local', Jars.local_maven_repo)
-      maven.property('jars.home', vendor_dir) if vendor_dir
+      maven.property('jars.home', File.expand_path(vendor_dir)) if vendor_dir
       maven.property('jars.lock', File.expand_path(Jars.lock))
-      maven.property('jars.force', options[:force] == true)
-      maven.property('jars.update', options[:update]) if options[:update]
+      maven.property('jars.force', force)
+      maven.property('jars.update', update) if update
       # tell not to use Jars.lock as part of POM when running mvn
       maven.property('jars.skip.lock', true)
 
       args = ['gem:jars-lock']
-      if options[:tree]
-        args += ['dependency:tree', '-P -gemfile.lock', '-DoutputFile=' + tree]
-      end
+      args += ['dependency:tree', '-P -gemfile.lock', "-DoutputFile=#{tree}"] if tree_provided
 
       puts
       puts '-- jar root dependencies --'
@@ -99,7 +91,7 @@ module Jars
         puts
       end
       puts
-      puts File.read(out).gsub(/#{File.dirname(out)}\//, '')
+      puts File.read(out).gsub("#{File.dirname(out)}/", '')
       puts
     ensure
       FileUtils.rm_f out

data/lib/jars/lock_down_pom.rb

@@ -1,8 +1,15 @@
+# frozen_string_literal: true
+
 # this file is maven DSL and used by maven via jars/lock_down.rb
 
 basedir(ENV_JAVA['jars.basedir'])
 
-eval(File.read(File.join(File.dirname(__FILE__), 'attach_jars_pom.rb')))
+def eval_file(file)
+  file = File.join(__dir__, file)
+  eval(File.read(file), nil, file) # rubocop:disable Security/Eval
+end
+
+eval_file('attach_jars_pom.rb')
 
 jfile = ENV_JAVA['jars.jarfile']
 jarfile(jfile) if jfile
@@ -14,17 +21,15 @@ jruby_plugin :gem, ENV_JAVA['jruby.plugins.version']
 # from each gemspec file. otherwise we need to resolve
 # the gemspec artifact in the maven way
 unless ENV_JAVA['jars.bundler']
-
   begin
     gemspec
   rescue
     nil
   end
-
 end
 
 properties('project.build.sourceEncoding' => 'utf-8')
 
 plugin :dependency, ENV_JAVA['dependency.plugin.version']
 
-eval(File.read(File.join(File.dirname(__FILE__), 'output_jars_pom.rb')))
+eval_file('output_jars_pom.rb')

data/lib/jars/maven_exec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'jar_dependencies'
 require 'jars/maven_factory'
 
@@ -23,11 +25,11 @@ module Jars
       setup(spec)
     rescue StandardError, LoadError => e
       # If spec load fails, skip looking for jar-dependencies
-      warn 'jar-dependencies: ' + e.to_s
+      warn "jar-dependencies: #{e}"
       warn e.backtrace.join("\n") if Jars.verbose?
     end
 
-    def setup(spec = nil, allow_no_file = false)
+    def setup(spec = nil, allow_no_file: false)
       spec ||= find_spec(allow_no_file)
 
       case spec
@@ -35,7 +37,7 @@ module Jars
         @specfile = File.expand_path(spec)
         @basedir = File.dirname(@specfile)
         Dir.chdir(@basedir) do
-          spec = eval(File.read(@specfile), TOPLEVEL_BINDING, @specfile)
+          spec = eval(File.read(@specfile), TOPLEVEL_BINDING, @specfile) # rubocop:disable Security/Eval
         end
       when Gem::Specification
         if File.exist?(spec.loaded_from)
@@ -46,12 +48,13 @@ module Jars
           # there the spec_file is "not installed" but inside
           # the gem_dir directory
           Dir.chdir(spec.gem_dir) do
-            setup(nil, true)
+            setup(nil, allow_no_file: true)
           end
         end
-      when NilClass
+      when nil
+        # ignore
       else
-        Jars.debug('spec must be either String or Gem::Specification. ' +
+        Jars.debug('spec must be either String or Gem::Specification. ' \
                    'File an issue on github if you need it.')
       end
       @spec = spec
@@ -63,10 +66,10 @@ module Jars
 
     def resolve_dependencies_list(file)
       factory = MavenFactory.new(@options)
-      maven = factory.maven_new(File.expand_path('../gemspec_pom.rb', __FILE__))
+      maven = factory.maven_new(File.expand_path('gemspec_pom.rb', __dir__))
 
       is_local_file = File.expand_path(File.dirname(@specfile)) == File.expand_path(Dir.pwd)
-      maven.attach_jars(@spec, is_local_file)
+      maven.attach_jars(@spec, all_dependencies: is_local_file)
 
       maven['jars.specfile'] = @specfile.to_s
       maven['outputAbsoluteArtifactFilename'] = 'true'