Class: Jets::Builders::RubyPackager
- Inherits:
-
Object
- Object
- Jets::Builders::RubyPackager
- Includes:
- Util
- Defined in:
- lib/jets/builders/ruby_packager.rb
Direct Known Subclasses
Constant Summary collapse
- GEM_REGEXP =
/-(arm|x)\d+.*-(darwin|linux)/
Instance Attribute Summary collapse
-
#full_app_root ⇒ Object
readonly
Returns the value of attribute full_app_root.
Instance Method Summary collapse
-
#bundle_install ⇒ Object
Installs gems on the current target system: both compiled and non-compiled.
-
#clean_old_submodules ⇒ Object
When using submodules, bundler leaves old submodules behind.
- #copy_back_gemfile_lock ⇒ Object
- #copy_bundle_config ⇒ Object
- #copy_bundled_gems(full_project_path) ⇒ Object
- #copy_cache_gems ⇒ Object
- #copy_gemfiles(full_project_path) ⇒ Object
-
#create_bundle_config(frozen: false) ⇒ Object
On circleci the “#Jets.build_root/.bundle/config” doesnt exist this only happens with ssh debugging, not when the ci.sh script gets ran.
-
#finish ⇒ Object
build gems in vendor/gems/ruby/2.5.0 (done in install phase).
- #gemfile_exist? ⇒ Boolean
-
#initialize(relative_app_root) ⇒ RubyPackager
constructor
A new instance of RubyPackager.
- #install ⇒ Object
-
#rewrite_gemfile_lock(gemfile_lock) ⇒ Object
Remove the BUNDLED WITH line since we don’t control the bundler gem version on AWS Lambda And this can cause issues with require ‘bundler/setup’.
-
#tidy ⇒ Object
Clean up extra unneeded files to reduce package size Because we’re removing files (something dangerous) use full paths.
- #tidy_project(path) ⇒ Object
Constructor Details
#initialize(relative_app_root) ⇒ RubyPackager
Returns a new instance of RubyPackager.
10 11 12 |
# File 'lib/jets/builders/ruby_packager.rb', line 10 def initialize(relative_app_root) @full_app_root = "#{build_area}/#{relative_app_root}" end |
Instance Attribute Details
#full_app_root ⇒ Object (readonly)
Returns the value of attribute full_app_root.
9 10 11 |
# File 'lib/jets/builders/ruby_packager.rb', line 9 def full_app_root @full_app_root end |
Instance Method Details
#bundle_install ⇒ Object
Installs gems on the current target system: both compiled and non-compiled. If user is on a macosx machine, macosx gems will be installed. If user is on a linux machine, linux gems will be installed.
Copies Gemfile* to /tmp/jets/demo/cache folder and installs gems with bundle install from there.
We take the time to copy Gemfile and bundle into a separate directory because it gets left around to act as a ‘cache’. So, when the builds the project gets built again not all the gems from get installed from the beginning.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/jets/builders/ruby_packager.rb', line 45 def bundle_install full_project_path = @full_app_root headline "Bundling: running bundle install in cache area: #{cache_area}." copy_gemfiles(full_project_path) copy_bundled_gems(full_project_path) # Uncomment out to always remove the cache/vendor/gems to debug # FileUtils.rm_rf("#{cache_area}/vendor/gems") # Remove .bundle folder so .bundle/config doesnt affect how Jets packages gems. # Not using BUNDLE_IGNORE_CONFIG=1 to allow home ~/.bundle/config to affect bundling though. # This is useful if you have private gems sources that require authentication. Example: # # bundle config gems.myprivatesource.com user:pass # create_bundle_config require "bundler" # dynamically require bundler so user can use any bundler Bundler.with_unbundled_env do sh( "cd #{cache_area} && " \ "env bundle install" ) end create_bundle_config(frozen: true) rewrite_gemfile_lock("#{cache_area}/Gemfile.lock") # Copy the Gemfile.lock back to the project in case it was updated. # For example we add the jets-rails to the Gemfile. copy_back_gemfile_lock puts 'Bundle install success.' end |
#clean_old_submodules ⇒ Object
When using submodules, bundler leaves old submodules behind. Over time this inflates the size of the the cache gems. So we’ll clean it up.
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/jets/builders/ruby_packager.rb', line 102 def clean_old_submodules # https://stackoverflow.com/questions/38800129/parsing-a-gemfile-lock-with-bundler lockfile = "#{cache_area}/Gemfile.lock" return unless File.exist?(lockfile) return if Bundler.bundler_major_version <= 1 # LockfileParser only works for Bundler version 2+ parser = Bundler::LockfileParser.new(Bundler.read_file(lockfile)) specs = parser.specs # specs = Bundler.load.specs # IE: spec.source.to_s: "https://github.com/tongueroo/webpacker.git (at jets@a8c4661)" submoduled_specs = specs.select do |spec| spec.source.to_s =~ /@\w+\)/ end # find git shas to keep # IE: ["a8c4661", "abc4661"] git_shas = submoduled_specs.map do |spec| md = spec.source.to_s.match(/@(\w+)\)/) md[1] # git_sha end # IE: /tmp/jets/demo/cache/vendor/gems/ruby/2.5.0/bundler/gems/webpacker-a8c46614c675 Dir.glob("#{cache_area}/vendor/gems/ruby/2.5.0/bundler/gems/*").each do |path| sha = path.split('-').last[0..6] # only first 7 chars of the git sha unless git_shas.include?(sha) # puts "Removing old submoduled gem: #{path}" # uncomment to see and debug FileUtils.rm_rf(path) # REMOVE old submodule directory end end end |
#copy_back_gemfile_lock ⇒ Object
81 82 83 84 85 |
# File 'lib/jets/builders/ruby_packager.rb', line 81 def copy_back_gemfile_lock src = "#{cache_area}/Gemfile.lock" dest = "#{@full_app_root}/Gemfile.lock" FileUtils.cp(src, dest) end |
#copy_bundle_config ⇒ Object
203 204 205 206 207 208 209 210 211 212 |
# File 'lib/jets/builders/ruby_packager.rb', line 203 def copy_bundle_config # Override project's .bundle/config and ensure that .bundle/config matches # at these 2 spots: # app_root/.bundle/config # vendor/gems/.bundle/config cache_bundle_config = "#{cache_area}/.bundle/config" app_bundle_config = "#{@full_app_root}/.bundle/config" FileUtils.mkdir_p(File.dirname(app_bundle_config)) FileUtils.cp(cache_bundle_config, app_bundle_config) end |
#copy_bundled_gems(full_project_path) ⇒ Object
135 136 137 138 139 |
# File 'lib/jets/builders/ruby_packager.rb', line 135 def copy_bundled_gems(full_project_path) src = "#{full_project_path}/bundled_gems" return unless File.exist?(src) Jets::Util.cp_r(src, "#{cache_area}/bundled_gems") end |
#copy_cache_gems ⇒ Object
231 232 233 234 235 236 237 238 239 240 241 242 |
# File 'lib/jets/builders/ruby_packager.rb', line 231 def copy_cache_gems vendor_gems = "#{@full_app_root}/vendor/gems" if File.exist?(vendor_gems) puts "Removing current vendor_gems from project" FileUtils.rm_rf(vendor_gems) end # Leave #{Jets.build_root}/vendor_gems behind to act as cache if File.exist?("#{cache_area}/vendor/gems") FileUtils.mkdir_p(File.dirname(vendor_gems)) Jets::Util.cp_r("#{cache_area}/vendor/gems", vendor_gems) end end |
#copy_gemfiles(full_project_path) ⇒ Object
141 142 143 144 145 146 147 148 149 150 |
# File 'lib/jets/builders/ruby_packager.rb', line 141 def copy_gemfiles(full_project_path) FileUtils.mkdir_p(cache_area) FileUtils.cp("#{full_project_path}/Gemfile", "#{cache_area}/Gemfile") gemfile_lock = "#{full_project_path}/Gemfile.lock" dest = "#{cache_area}/Gemfile.lock" return unless File.exist?(gemfile_lock) FileUtils.cp(gemfile_lock, dest) end |
#create_bundle_config(frozen: false) ⇒ Object
On circleci the “#Jets.build_root/.bundle/config” doesnt exist this only happens with ssh debugging, not when the ci.sh script gets ran. But on macosx it exists. Dont know why this is the case.
218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/jets/builders/ruby_packager.rb', line 218 def create_bundle_config(frozen: false) FileUtils.rm_rf("#{cache_area}/.bundle") frozen_line = %Q|BUNDLE_FROZEN: "true"\n| if frozen text =<<-EOL --- #{frozen_line}BUNDLE_PATH: "vendor/gems" BUNDLE_WITHOUT: "development:test" EOL bundle_config = "#{cache_area}/.bundle/config" FileUtils.mkdir_p(File.dirname(bundle_config)) IO.write(bundle_config, text) end |
#finish ⇒ Object
build gems in vendor/gems/ruby/2.5.0 (done in install phase)
24 25 26 27 |
# File 'lib/jets/builders/ruby_packager.rb', line 24 def finish return unless gemfile_exist? tidy end |
#gemfile_exist? ⇒ Boolean
29 30 31 32 |
# File 'lib/jets/builders/ruby_packager.rb', line 29 def gemfile_exist? gemfile_path = "#{@full_app_root}/Gemfile" File.exist?(gemfile_path) end |
#install ⇒ Object
14 15 16 17 18 19 20 21 |
# File 'lib/jets/builders/ruby_packager.rb', line 14 def install return unless gemfile_exist? clean_old_submodules bundle_install copy_bundle_config copy_cache_gems end |
#rewrite_gemfile_lock(gemfile_lock) ⇒ Object
Remove the BUNDLED WITH line since we don’t control the bundler gem version on AWS Lambda And this can cause issues with require ‘bundler/setup’
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/jets/builders/ruby_packager.rb', line 154 def rewrite_gemfile_lock(gemfile_lock) lines = IO.readlines(gemfile_lock) # Remove BUNDLED WITH # amount is the number of lines to remove new_lines, capture, count, amount = [], true, 0, 2 lines.each do |l| capture = false if l.include?('BUNDLED WITH') if capture new_lines << l end if capture == false count += 1 capture = count > amount # renable capture end end # Replace things like nokogiri (1.11.1-x86_64-darwin) => nokogiri (1.11.1) lines, new_lines = new_lines, [] lines.each do |l| l.sub!(GEM_REGEXP, '') if l =~ GEM_REGEXP new_lines << l end # Make sure platform is ruby lines, new_lines, in_platforms_section, platforms_rewritten = new_lines, [], false, false lines.each do |l| if in_platforms_section && platforms_rewritten # once PLATFORMS has been found, skip all lines until the next section if l.present? next else in_platforms_section = false end end if in_platforms_section && !platforms_rewritten # specify ruby as the only platform new_lines << " ruby\n" platforms_rewritten = true next end in_platforms_section = l.include?('PLATFORMS') new_lines << l end content = new_lines.join('') IO.write(gemfile_lock, content) end |
#tidy ⇒ Object
Clean up extra unneeded files to reduce package size Because we’re removing files (something dangerous) use full paths.
89 90 91 92 93 94 |
# File 'lib/jets/builders/ruby_packager.rb', line 89 def tidy puts "Tidying project: removing ignored files to reduce package size." tidy_project(@full_app_root) # The rack sub project has it's own gitignore. tidy_project(@full_app_root+"/rack") end |