bootboot 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0ffd98be99f6485f9c7480c1af03185884bc7a3
+  data.tar.gz: 9c2f985c296d6c1ea93c06a49437b9fd670a1ad8
+SHA512:
+  metadata.gz: 8992b0f398e049de5dc730d49f39ce35e908828168939583ff5d84362b6bc84d3193548c92f83117473a7887a6e5c22bb7d76c59aca0a52b3b9609b3dc518135
+  data.tar.gz: c4a6e8932482b1e5dd96f8e3e26e08de41e71f8cc38a0872d696a3702381073ad324440b3e95dde8709910907dfe0fa03937530e9a95287584ae82d6e43c33a3

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+cache: bundler
+language: ruby
+before_install:
+  - gem update bundler
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :deployment do
+  gem 'package_cloud'
+  gem 'rake'
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    bootboot (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    highline (1.6.20)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json_pure (1.8.1)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    minitest (5.11.3)
+    netrc (0.11.0)
+    package_cloud (0.3.05)
+      highline (= 1.6.20)
+      json_pure (= 1.8.1)
+      rainbow (= 2.2.2)
+      rest-client (~> 2.0)
+      thor (~> 0.18)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    thor (0.20.3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bootboot!
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  package_cloud
+  rake
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Shopify
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+## 👢👢 Bootboot
+
+Introduction
+------------
+Bootboot is a [Bundler plugin](https://bundler.io/v1.17/guides/bundler_plugins.html#what-is-a-plugin) meant to help dual boot your ruby application.
+
+#### What is "Dual booting"?
+In this context, dual boot is the process of booting your application with a different set of dependencies. This technique has become very popular in the Ruby community to help applications safely upgrade dependencies. If you want to learn more about it, have a look at this [conference talk](https://www.youtube.com/watch?v=I-2Xy3RS1ns&t=368s) by @rafaelfranca.
+
+There are two schools on how to dual boot your app, each having advantages and disadvantages.
+1) Use three Gemfiles. One with current production dependencies, a second with an alternate "next" set of dependencies, and a third containing the dependencies that both Gemfiles have in common.
+```ruby
+# Gemfile.common
+gem "some_gem"
+
+# Gemfile
+gem "rails", "~> 5.1.0"
+eval_gemfile "Gemfile.common"
+
+# Gemfile.next
+gem "rails", "~> 5.2.0"
+eval_gemfile "Gemfile.common"
+```
+
+2) Have a single Gemfile containing dependencies separated by environment sensitive `if` statements.
+```ruby
+# Gemfile
+
+if ENV['DEPENDENCIES_NEXT']
+  gem "rails", "~> 5.2.0"
+else
+  gem "rails", "~> 5.1.0"
+end
+```
+-----------------------------
+The former doesn't require any Bundler workaround but you need to deal with three Gemfiles and the [confusion](https://github.com/bundler/bundler/issues/6777#issuecomment-436771340) that comes with it.
+The latter is the approach we decided to take at Shopify and it worked very well for us for multiple years.
+
+No matter what approach you decide to take, you'll need to create tooling to ensure that all the lockfiles are in sync whenever a developer updates a dependency.
+
+Bootboot is only useful if you decide to follow the second approach. It creates the required tooling as well as the Bundler workaround needed to enable dual booting.
+
+
+
+Installation
+------------
+1) In your Gemfile, add this
+```ruby
+plugin 'bootboot', '~> 0.1.1`
+```
+2) Run `bundle install && bundle bootboot`
+3) You're done. Commit the Gemfile and the Gemfile_next.lock
+
+Dual boot it!
+------------
+If you want to boot using the dependencies from the `Gemfile_next.lock`, run any bundler command prefixed with the `DEPENDENCIES_NEXT=1` ENV variable. I.e. `DEPENDENCIES_NEXT=1 bundle exec irb`.
+
+
+Keep` the Gemfile_next.lock` in sync
+------------
+When a developer bumps or adds a dependency, Bootboot will ensure that the `Gemfile_next.lock` snapshot gets updated.
+
+**However, this feature is only available if you are on Bundler `>= 1.17`**
+Other versions will trigger a warning message telling them that Bootboot can't automatically keep the `Gemfile_next.lock` in sync.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bootboot"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bootboot.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bootboot/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bootboot"
+  spec.version       = Bootboot::VERSION
+  spec.authors       = ["Shopify"]
+  spec.email         = ["rails@shopify.com"]
+
+  spec.summary       = "Dualbooting your ruby app made easy."
+  spec.description   = <<-EOM.gsub(/\W+/, ' ')
+    This gems removes you the overhead of monkeypatching your Gemfile in order to
+    dualboot your app using the Gemfile_next.lock strategy.
+    It also ensure that dependencies in the Gemfile.lock and Gemfile_next.lock are
+    in sync whenever someone updates a gem.
+  EOM
+  spec.homepage      = "https://github.com/shopify/bootboot"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/shopify/bootboot"
+  spec.metadata["changelog_uri"] = "https://github.com/Shopify/bootboot/blob/master/CHANGELOG.md"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/bootboot.rb

@@ -0,0 +1,16 @@
+require "bootboot/version"
+require "bootboot/bundler_patch"
+
+module Bootboot
+  GEMFILE = Bundler.default_gemfile
+  GEMFILE_LOCK = Pathname("#{GEMFILE}.lock")
+  GEMFILE_NEXT_LOCK = Pathname("#{GEMFILE}_next.lock")
+  DUALBOOT_NEXT = 'DEPENDENCIES_NEXT'
+  DUALBOOT_PREVIOUS = 'DEPENDENCIES_PREVIOUS'
+
+  autoload :GemfileNextAutoSync, 'bootboot/gemfile_next_auto_sync'
+  autoload :Command,             'bootboot/command'
+end
+
+Bootboot::GemfileNextAutoSync.new.setup
+Bootboot::Command.new.setup

data/lib/bootboot/bundler_patch.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DefinitionPatch
+  def initialize(wrong_lock, *args)
+    lockfile = if ENV['SKIP_BUNDLER_PATCH']
+      wrong_lock
+    else
+      Bootboot::GEMFILE_NEXT_LOCK
+    end
+
+    super(lockfile, *args)
+  end
+end
+
+module SharedHelpersPatch
+  def default_lockfile
+    Bootboot::GEMFILE_NEXT_LOCK
+  end
+end
+
+Bundler::Dsl.class_eval do
+  def enable_dual_booting
+    Bundler::Definition.prepend(DefinitionPatch)
+    Bundler::SharedHelpers.singleton_class.prepend(SharedHelpersPatch)
+  end
+end

data/lib/bootboot/command.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module Bootboot
+  class Command < Bundler::Plugin::API
+    def setup
+      self.class.command('bootboot')
+    end
+
+    def exec(_cmd, _args)
+      FileUtils.cp(GEMFILE_LOCK, GEMFILE_NEXT_LOCK)
+
+      File.open(GEMFILE, 'a+') do |f|
+        f.write(<<-EOM)
+Plugin.send(:load_plugin, 'bootboot') if Plugin.installed?('bootboot')
+
+if ENV['DEPENDENCIES_NEXT']
+  enable_dual_booting if Plugin.installed?('bootboot')
+
+  # Add any gem you want here, they will be loaded only when running
+  # bundler command prefixed with `#{DUALBOOT_NEXT}=1`.
+end
+EOM
+      end
+    end
+  end
+end

data/lib/bootboot/gemfile_next_auto_sync.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Bootboot
+  class GemfileNextAutoSync < Bundler::Plugin::API
+    def setup
+      check_bundler_version
+      opt_in
+    end
+
+    private
+
+    def check_bundler_version
+      self.class.hook("before-install-all") do
+        next if Bundler::VERSION >= "1.17.0" || !GEMFILE_NEXT_LOCK.exist?
+
+        Bundler.ui.warn(<<-EOM.gsub(/\s+/, " "))
+          Bootboot can't automatically update the Gemfile_next.lock because you are running
+          an older version of Bundler.
+
+          Update Bundler to 1.17.0 to discard this warning.
+        EOM
+      end
+    end
+
+    def opt_in
+      self.class.hook('before-install-all') do
+        @previous_lock = Bundler.default_lockfile.read
+      end
+
+      self.class.hook("after-install-all") do
+        current_definition = Bundler.definition
+
+        next if !GEMFILE_NEXT_LOCK.exist? ||
+                nothing_changed?(current_definition) ||
+                ENV[DUALBOOT_NEXT] ||
+                ENV[DUALBOOT_PREVIOUS]
+
+        update!(current_definition)
+      end
+    end
+
+    def nothing_changed?(current_definition)
+      current_definition.to_lock == @previous_lock
+    end
+
+    def update!(current_definition)
+      env = which_env
+      lock = which_lock
+
+      Bundler.ui.confirm("Updating the #{lock}")
+      ENV[env] = '1'
+      ENV['SKIP_BUNDLER_PATCH'] = '1'
+
+      unlock = current_definition.instance_variable_get(:@unlock)
+      definition = Bundler::Definition.build(GEMFILE, lock, unlock)
+      definition.resolve_remotely!
+      definition.lock(lock)
+    ensure
+      ENV.delete(env)
+      ENV.delete('SKIP_BUNDLER_PATCH')
+    end
+
+    def which_env
+      if Bundler.default_lockfile.to_s =~ /_next\.lock/
+        DUALBOOT_PREVIOUS
+      else
+        DUALBOOT_NEXT
+      end
+    end
+
+    def which_lock
+      if Bundler.default_lockfile.to_s =~ /_next\.lock/
+        GEMFILE_LOCK
+      else
+        GEMFILE_NEXT_LOCK
+      end
+    end
+  end
+end

data/lib/bootboot/version.rb

@@ -0,0 +1,3 @@
+module Bootboot
+  VERSION = "0.1.1"
+end

data/plugins.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "lib/bootboot"

data/shipit.rubygems.yml

@@ -0,0 +1 @@
+# Default config

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: bootboot
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Shopify
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: " This gems removes you the overhead of monkeypatching your Gemfile in
+  order to dualboot your app using the Gemfile_next lock strategy It also ensure that
+  dependencies in the Gemfile lock and Gemfile_next lock are in sync whenever someone
+  updates a gem "
+email:
+- rails@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bootboot.gemspec
+- lib/bootboot.rb
+- lib/bootboot/bundler_patch.rb
+- lib/bootboot/command.rb
+- lib/bootboot/gemfile_next_auto_sync.rb
+- lib/bootboot/version.rb
+- plugins.rb
+- shipit.rubygems.yml
+homepage: https://github.com/shopify/bootboot
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shopify/bootboot
+  source_code_uri: https://github.com/shopify/bootboot
+  changelog_uri: https://github.com/Shopify/bootboot/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Dualbooting your ruby app made easy.
+test_files: []