Class: Jets::Builders::RubyPackager
- Inherits:
-
Object
- Object
- Jets::Builders::RubyPackager
- Includes:
- Util
- Defined in:
- lib/jets/builders/ruby_packager.rb
Direct Known Subclasses
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_cache_gems ⇒ Object
- #copy_gemfiles(full_project_path) ⇒ Object
-
#ensure_build_cache_bundle_config_exists! ⇒ 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
-
#reconfigure_ruby_version ⇒ Object
This is in case the user has a 2.5.x variant.
-
#remove_bundled_with(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’.
- #setup_bundle_config ⇒ Object
-
#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.
8 9 10 |
# File 'lib/jets/builders/ruby_packager.rb', line 8 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.
7 8 9 |
# File 'lib/jets/builders/ruby_packager.rb', line 7 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.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/jets/builders/ruby_packager.rb', line 44 def bundle_install full_project_path = @full_app_root headline "Bundling: running bundle install in cache area: #{cache_area}." copy_gemfiles(full_project_path) # Uncomment out to always remove the cache/vendor/gems to debug # FileUtils.rm_rf("#{cache_area}/vendor/gems") require "bundler" # dynamically require bundler so user can use any bundler Bundler.with_clean_env do sh( "cd #{cache_area} && " \ "env BUNDLE_IGNORE_CONFIG=1 bundle install --path #{cache_area}/vendor/gems --without development test" ) end remove_bundled_with("#{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.
99 100 101 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 |
# File 'lib/jets/builders/ruby_packager.rb', line 99 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
70 71 72 73 74 |
# File 'lib/jets/builders/ruby_packager.rb', line 70 def copy_back_gemfile_lock src = "#{cache_area}/Gemfile.lock" dest = "#{@full_app_root}/Gemfile.lock" FileUtils.cp(src, dest) end |
#copy_cache_gems ⇒ Object
194 195 196 197 198 199 200 201 202 203 204 205 |
# File 'lib/jets/builders/ruby_packager.rb', line 194 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
132 133 134 135 136 137 138 139 140 141 |
# File 'lib/jets/builders/ruby_packager.rb', line 132 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 |
#ensure_build_cache_bundle_config_exists! ⇒ 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.
182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/jets/builders/ruby_packager.rb', line 182 def ensure_build_cache_bundle_config_exists! text =<<-EOL --- BUNDLE_FROZEN: "true" 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)
23 24 25 26 |
# File 'lib/jets/builders/ruby_packager.rb', line 23 def finish return unless gemfile_exist? tidy end |
#gemfile_exist? ⇒ Boolean
28 29 30 31 |
# File 'lib/jets/builders/ruby_packager.rb', line 28 def gemfile_exist? gemfile_path = "#{@full_app_root}/Gemfile" File.exist?(gemfile_path) end |
#install ⇒ Object
12 13 14 15 16 17 18 19 20 |
# File 'lib/jets/builders/ruby_packager.rb', line 12 def install return unless gemfile_exist? reconfigure_ruby_version clean_old_submodules bundle_install setup_bundle_config copy_cache_gems end |
#reconfigure_ruby_version ⇒ Object
This is in case the user has a 2.5.x variant. Force usage of ruby version that jets supports The lambda server only has ruby 2.5.0 installed.
92 93 94 95 |
# File 'lib/jets/builders/ruby_packager.rb', line 92 def reconfigure_ruby_version ruby_version = "#{@full_app_root}/.ruby-version" IO.write(ruby_version, Jets::RUBY_VERSION) end |
#remove_bundled_with(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’
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/jets/builders/ruby_packager.rb', line 145 def remove_bundled_with(gemfile_lock) lines = IO.readlines(gemfile_lock) # 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 content = new_lines.join('') IO.write(gemfile_lock, content) end |
#setup_bundle_config ⇒ Object
165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/jets/builders/ruby_packager.rb', line 165 def setup_bundle_config ensure_build_cache_bundle_config_exists! # 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 |
#tidy ⇒ Object
Clean up extra unneeded files to reduce package size Because we’re removing files (something dangerous) use full paths.
78 79 80 81 82 83 |
# File 'lib/jets/builders/ruby_packager.rb', line 78 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 |