Add katapult update script

Author: codener

Gemfile

@@ -2,3 +2,12 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in katapult.gemspec
 gemspec
+
+gem 'bundler', '~> 1.5'
+gem 'rake'
+gem 'pry'
+
+# Test
+gem 'aruba', '~> 0.10'
+gem 'guard-cucumber'
+gem 'rspec', '~> 3.4'

README.md

@@ -207,19 +207,17 @@ account. Create a dedicated account on your local PostgreSQL server:
     postgres=# CREATE ROLE katapult WITH createdb LOGIN;
 
 ### Continuing development
-When you continue development on `katapult`, remove its `tmp/` directory first.
-It contains cached data that might lead to confusion.
+When you continue development on `katapult`, you first need to update a couple
+of things. `script/update` will guide you through the process.
 
 ### Debugging
 Add the `@announce-output` tag to `katapult` features in order to have any output
 logged to your terminal.
 
-To precisely debug errors occurring _inside_ the generated application, you may
-cd to `tmp/aruba/katapult_test_app`. Run the failing command manually.
-
-Note that after running a katapult feature, you need to call
-`cd ../../aruba/katapult_test_app` inside the generated app terminal. This is
-required because the `tmp/aruba` directory is being wiped before each scenario.
+To precisely debug errors occurring _inside_ the generated application, use
+`script/kta`. You could also just cd to the test app directory, but since it is
+destroyed between test runs, you'd need to `cd ../../aruba/katapult_test_app`
+after each test.
 
 ### Typical errors
 - Timeout error because of a script waiting for user input

bin/katapult

@@ -2,7 +2,11 @@
 
 # This script simplifies the usage of `katapult` by grouping relevant actions
 # that the user else had to perform manually.
-# See bottom for USAGE.
+
+usage = <<-USAGE
+Usage: katapult [new APP_NAME | fire [path/to/model] ]
+Suppress database credentials prompt with `--non-interactive`
+USAGE
 
 require_relative '../lib/katapult/binary_util'
 util = Katapult::BinaryUtil
@@ -14,35 +18,35 @@ when 'new'
   basics_command = 'bundle exec rails generate katapult:basics'
 
   if interactive
-    util.puts 'Please enter your database user: '
+    util.pink 'Please enter your database user: '
     basics_command << ' --db-user ' << gets.chomp
 
-    util.puts 'Please enter your database password: '
+    util.pink 'Please enter your database password: '
     basics_command << ' --db-password ' << gets.chomp
   end
 
-  util.puts 'Creating new Rails application ...'
+  util.pink 'Creating new Rails application ...'
   util.create_rails_app app_name
 
   Dir.chdir app_name
 
-  util.puts 'Initializing git repository ...'
+  util.pink 'Initializing git repository ...'
   util.run 'git init --quiet'
   util.git_commit "rails new #{ app_name }", '--quiet'
 
-  util.puts 'Installing katapult ...'
+  util.pink 'Installing katapult ...'
   File.open('Gemfile', 'a') do |file|
     file.puts "gem 'katapult'#{ ENV['KATAPULT_GEMFILE_OPTIONS'] }, group: :development"
   end
   util.run 'bundle install --quiet'
   util.run 'bundle exec rails generate katapult:install'
   util.git_commit 'rails generate katapult:install', '--quiet'
 
-  util.puts 'Generating katapult basics ...'
+  util.pink 'Generating katapult basics ...'
   util.run basics_command
   util.git_commit 'rails generate katapult:basics', '--quiet'
 
-  util.puts <<-INSTRUCTIONS
+  util.pink <<-INSTRUCTIONS
 Application initialization done.
 
 Next step: Model your application in lib/katapult/application_model.rb and
@@ -53,20 +57,17 @@ when 'fire'
   app_model_path = ARGV.shift || 'lib/katapult/application_model.rb'
   transform_command = 'bin/rails generate katapult:transform ' + app_model_path
 
-  util.puts 'Loading katapult ...'
+  util.pink 'Loading katapult ...'
   util.run transform_command
   util.git_commit transform_command
 
-  util.puts <<-INSTRUCTIONS
+  util.pink <<-INSTRUCTIONS
 Model transformation done.
 
 Now boot up your development server (e.g. with `rails server`) and try your
 kickstarted application in the browser!
   INSTRUCTIONS
 
 else
-  puts <<-USAGE
-Usage: katapult [new APP_NAME | fire [path/to/model] ]
-Suppress database credentials prompt with `--non-interactive`
-  USAGE
+  puts usage
 end

katapult.gemspec

@@ -18,18 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.0'
+  # spec.required_ruby_version = Katapult::RUBY_VERSION
 
-  spec.add_runtime_dependency 'rails'
+  spec.add_runtime_dependency 'rails', Katapult::RAILS_VERSION
   spec.add_runtime_dependency 'spring' # speed-up
-
-  # Development
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'pry'
-
-  # Testing
-  spec.add_development_dependency 'aruba', '~> 0.10.2'
-  spec.add_development_dependency 'guard-cucumber'
-  spec.add_development_dependency 'rspec', '~> 3.4.0'
 end

lib/katapult.rb

@@ -1,7 +1,2 @@
 require 'active_support'
 require 'active_support/core_ext/hash/slice'
-
-module Katapult
-  RAILS_VERSION = '4.2.7.1'
-  RUBY_VERSION = '2.3.0'
-end

lib/katapult/binary_util.rb

@@ -1,8 +1,8 @@
 # Utility methods.
 
-# The Katapult::Util module is used inside the `katapult` script. It should not
-# require any gems in order to prevent version conflicts.
-require_relative '../katapult'
+# This module is used inside the `katapult` binary and thus should not
+# require any gems in order to prevent version conflicts
+require_relative '../katapult/version'
 require 'bundler'
 
 module Katapult
@@ -18,20 +18,33 @@ def create_rails_app(name)
       run "rails _#{ Katapult::RAILS_VERSION }_ new #{ name } --skip-test-unit --skip-bundle --database postgresql"
     end
 
-    def puts(*args)
+    def pink(*args)
       message = "\n> #{ args.join ' ' }"
       Kernel.puts "\e[35m#{ message }\e[0m" # pink
     end
 
     # With clean Bundler env
     def run(command)
       success = Bundler.with_clean_env { system command }
+      success or fail 'Something went wrong'
+    end
+
+    def job(do_something, done = 'Done.', &job)
+      pink "About to #{do_something}. [C]ontinue, [s]kip or [e]xit?"
 
-      if !success
-        puts 'x Something went wrong'
-        exit(1)
+      case $stdin.getch
+      when 's' then puts('Skipped.')
+      when 'e' then fail('Cancelled.')
+      else
+        job.call
+        puts done
       end
     end
 
+    def fail(message)
+      puts "x #{message}"
+      exit(1)
+    end
+
   end
 end

lib/katapult/version.rb

@@ -1,3 +1,5 @@
 module Katapult
   VERSION = '0.2.0'
+  RUBY_VERSION = File.read('.ruby-version').strip
+  RAILS_VERSION = '5.1.2'
 end

script/kta

@@ -0,0 +1,7 @@
+#!/usr/bin/env sh
+
+# kta = katapult_test_app
+# This script performs any given command in the katapult test app directory
+
+cd tmp/aruba/katapult_test_app
+eval $@

script/update

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/katapult/version'
+require_relative '../lib/katapult/binary_util'
+
+u = Katapult::BinaryUtil
+version_path = 'lib/katapult/version.rb'
+
+
+# Intro ########################################################################
+
+at_project_root = File.exists?('lib/katapult.rb')
+at_project_root or fail 'Run this script from the Katapult project root.'
+
+puts <<INTRO
+Katapult #{Katapult::VERSION}
+
+This script will help you continue development on Katapult: updating the
+versions of Ruby and Rails, wiping tmp/ and more.
+
+It will always ask before doing anything.
+
+The script is intended as a one-time updater, but it wont' do harm if run
+repeatedly.
+
+INTRO
+
+u.pink "The Ruby version is #{`ruby -v`.chomp}."
+puts 'Should katapult use that version? [yN]'
+case $stdin.getch
+when 'y' then puts 'Ok.'
+else
+  u.pink 'Please configure the Ruby version in .ruby-version, then re-run this script.'
+  exit
+end
+
+# Jobs #########################################################################
+
+u.job 'update Bundler' do
+  system 'gem install bundler'
+end
+
+u.job 'update Rails version', "#{version_path} updated." do
+  print "Please enter the desired Rails version (current: #{Katapult::RAILS_VERSION}): "
+  rails_v = gets.strip
+
+  version_rb = File.read version_path
+  version_rb.gsub! /^(  RAILS_VERSION =).*$/, "\\1 '#{rails_v}'"
+  File.open version_path, 'w' do |f|
+    f.write version_rb
+  end
+end
+
+u.job 'update installed gems' do
+  system 'bundle update'
+end
+
+u.job 'wipe tmp directory' do
+  FileUtils.rm_rf 'tmp'
+end
+
+puts <<-DEBUG
+
+All things automatic have been done. Now to the manual part: You need to fix
+whatever was broken by the updates.
+
+The suggested way is to run `cucumber features/basics.feature` and fix issues
+until it is green.
+DEBUG