Class: Jets::Builders::RubyPackager

Inherits:
Object
  • Object
show all
Includes:
Util
Defined in:
lib/jets/builders/ruby_packager.rb

Direct Known Subclasses

RackPackager

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Util

#code_area, #full, #headline, #sh, #stage_area

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 = full(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.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/jets/builders/ruby_packager.rb', line 50

def bundle_install
  full_project_path = @full_app_root
  headline "Bundling: running bundle install in cache area: #{cache_area}."

  copy_gemfiles(full_project_path)

  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/bundle --without development test"
    )
  end

  # Copy the Gemfile.lock back to the project in case it was updated.
  # For example we add the jets-rails to the Gemfile.
  copy_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.



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
 
# File 'lib/jets/builders/ruby_packager.rb', line 100

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)

  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/bundle/ruby/2.5.0/bundler/gems/webpacker-a8c46614c675
  Dir.glob("#{cache_area}/vendor/bundle/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_cache_gems ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/jets/builders/ruby_packager.rb', line 179

def copy_cache_gems
  vendor_bundle = "#{@full_app_root}/vendor/bundle"
  if File.exist?(vendor_bundle)
    puts "Removing current vendor_bundle from project"
    FileUtils.rm_rf(vendor_bundle)
  end
  # Leave #{Jets.build_root}/vendor_bundle behind to act as cache
  if File.exist?("#{cache_area}/vendor/bundle")
    FileUtils.mkdir_p(File.dirname(vendor_bundle))
    FileUtils.cp_r("#{cache_area}/vendor/bundle", vendor_bundle)
  end
end

#copy_gemfile_lock ⇒ Object 



71
72
73
74
75
 
# File 'lib/jets/builders/ruby_packager.rb', line 71

def copy_gemfile_lock
  src = "#{cache_area}/Gemfile.lock"
  dest = "#{@full_app_root}/Gemfile.lock"
  FileUtils.cp_r(src, dest)
end

#copy_gemfiles(full_project_path) ⇒ Object 



131
132
133
134
135
 
# File 'lib/jets/builders/ruby_packager.rb', line 131

def copy_gemfiles(full_project_path)
  FileUtils.mkdir_p(cache_area)
  FileUtils.cp("#{full_project_path}/Gemfile", "#{cache_area}/Gemfile")
  FileUtils.cp("#{full_project_path}/Gemfile.lock", "#{cache_area}/Gemfile.lock")
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.



154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/jets/builders/ruby_packager.rb', line 154

def ensure_build_cache_bundle_config_exists!
  text =<<-EOL
---
BUNDLE_FROZEN: "true"
BUNDLE_PATH: "vendor/bundle"
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/bundle/ruby/2.5.0 (done in install phase) replace_compiled_gems:

remove binary gems in vendor/bundle/ruby/2.5.0
extract binary gems in opt/ruby/gems/2.5.0
move binary gems from opt/ruby/gems/2.5.0 to vendor/bundle/ruby/2.5.0



26
27
28
29
30
31
32
 
# File 'lib/jets/builders/ruby_packager.rb', line 26

def finish
  return unless gemfile_exist?

  copy_cache_gems
  replace_compiled_gems
  tidy
end

#gemfile_exist? ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
37
 
# File 'lib/jets/builders/ruby_packager.rb', line 34

def gemfile_exist?
  gemfile_path = "#{@full_app_root}/Gemfile"
  File.exist?(gemfile_path)
end

#gems_options ⇒ Object 



166
167
168
169
170
171
172
 
# File 'lib/jets/builders/ruby_packager.rb', line 166

def gems_options
  {
    s3: "lambdagems",
    build_root: cache_area, # used in lambdagem
    project_root: @full_app_root, # used in gem_replacer and lambdagem
  }
end

#install ⇒ Object 



12
13
14
15
16
17
18
19
 
# 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
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.



93
94
95
96
 
# File 'lib/jets/builders/ruby_packager.rb', line 93

def reconfigure_ruby_version
  ruby_version = "#{@full_app_root}/.ruby-version"
  IO.write(ruby_version, Jets::RUBY_VERSION)
end

#replace_compiled_gems ⇒ Object 



174
175
176
177
 
# File 'lib/jets/builders/ruby_packager.rb', line 174

def replace_compiled_gems
  headline "Replacing compiled gems with AWS Lambda Linux compiled versions."
  GemReplacer.new(Jets::RUBY_VERSION, gems_options).run
end

#setup_bundle_config ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/jets/builders/ruby_packager.rb', line 137

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/bundle/.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.



79
80
81
82
83
84
 
# File 'lib/jets/builders/ruby_packager.rb', line 79

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

#tidy_project(path) ⇒ Object 



86
87
88
 
# File 'lib/jets/builders/ruby_packager.rb', line 86

def tidy_project(path)
  Tidy.new(path).cleanup!
end