Class: Jars::Installer

Inherits:
Object
  • Object
show all
Defined in:
lib/jars/installer.rb

Defined Under Namespace

Classes: Dependency

Constant Summary collapse

COMMENT = 
'# this is a generated file, to avoid over-writing it just delete this comment'

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(spec = nil) ⇒ Installer

Returns a new instance of Installer.



134
135
136
 
# File 'lib/jars/installer.rb', line 134

def initialize(spec = nil)
  @mvn = MavenExec.new(spec)
end

Class Method Details

.install_jars(write_require_file: false) ⇒ Object 



65
66
67
 
# File 'lib/jars/installer.rb', line 65

def self.install_jars(write_require_file: false)
  new.install_jars(write_require_file: write_require_file)
end

.load_from_maven(file) ⇒ Object 



69
70
71
72
73
74
75
76
 
# File 'lib/jars/installer.rb', line 69

def self.load_from_maven(file)
  result = []
  File.read(file).each_line do |line|
    dep = Dependency.new(line)
    result << dep if dep && dep.scope == :runtime
  end
  result
end

.needs_to_write?(require_filename) ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/jars/installer.rb', line 101

def self.needs_to_write?(require_filename)
  require_filename && (!File.exist?(require_filename) || File.read(require_filename).match(COMMENT))
end

.print_require_jar(file, dep, fallback: false) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/jars/installer.rb', line 86

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}'")
  elsif dep.scope == :runtime
    if fallback
      file&.puts("  require '#{dep.path}'")
    else
      file&.puts("  require_jar '#{dep.gav.gsub(':', "', '")}'")
    end
  end
end

.vendor_file(dir, dep) ⇒ Object 



78
79
80
81
82
83
84
 
# File 'lib/jars/installer.rb', line 78

def self.vendor_file(dir, dep)
  return unless !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

.vendor_jars(deps, dir) ⇒ Object 



128
129
130
131
132
 
# File 'lib/jars/installer.rb', line 128

def self.vendor_jars(deps, dir)
  deps.each do |dep|
    vendor_file(dir, dep)
  end
end

.vendor_jars!(vendor_dir = nil) ⇒ Object 



153
154
155
 
# File 'lib/jars/installer.rb', line 153

def self.vendor_jars!(vendor_dir = nil)
  new.vendor_jars!(vendor_dir)
end

.write_require_jars(deps, require_filename) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/jars/installer.rb', line 105

def self.write_require_jars(deps, require_filename)
  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

Instance Method Details

#install_jars(write_require_file: true) ⇒ Object 



162
163
164
165
166
 
# File 'lib/jars/installer.rb', line 162

def install_jars(write_require_file: true)
  return unless jars?

  do_install(nil, write_require_file)
end

#jars? ⇒ Boolean

Returns:

  • (Boolean) 


172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/jars/installer.rb', line 172

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 }
  if result && spec.platform.to_s != 'java'
    Jars.warn "\njar dependencies found on non-java platform gem - do not install jars\n"
    false
  else
    result
  end
end

#ruby_maven_install_options=(options) ⇒ Object 



168
169
170
 
# File 'lib/jars/installer.rb', line 168

def ruby_maven_install_options=(options)
  @mvn.ruby_maven_install_options = options
end

#spec ⇒ Object 



138
139
140
 
# File 'lib/jars/installer.rb', line 138

def spec
  @mvn.spec
end

#vendor_jars(vendor_dir = nil, write_require_file: true) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/jars/installer.rb', line 142

def vendor_jars(vendor_dir = nil, write_require_file: true)
  return unless jars?

  if Jars.to_prop(Jars::VENDOR) == 'false'
    vendor_dir = nil
  else
    vendor_dir ||= spec.require_path
  end
  do_install(vendor_dir, write_require_file)
end

#vendor_jars!(vendor_dir = nil, write_require_file: true) ⇒ Object 



157
158
159
160
 
# File 'lib/jars/installer.rb', line 157

def vendor_jars!(vendor_dir = nil, write_require_file: true)
  vendor_dir ||= spec.require_path
  do_install(vendor_dir, write_require_file)
end