geordi 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6987f48d4bce3bf0e72d2395052b1147cd0b1f1dc4e3beea5d928e2a187a84e2
-  data.tar.gz: b72fa01a11225dc875a4c124f1d39d111a2bc5d4e4ef6f5a882adc34504335cf
+  metadata.gz: 8209de927d9f973919406bcc485f908774db958aa66301baed5f7680ba6b0c42
+  data.tar.gz: 19450383000e1ac02325f071a18e47b5e2c9dc59f10f2bc14cdde7283ffafa8e
 SHA512:
-  metadata.gz: f04fd539fe8c3d286c28bfdfad3297cf9dcda5edf93eb4719a8bc25a383a04873c4fd2f3a716e65e806546685d8e6af3771d060926a2144fc60c1b68f912a34f
-  data.tar.gz: e3791d7d0d41c610a3b7a6c95a002e354235835948e3b55974dba99254594378f47114f9ffe8c4065ac575f91d6b0acc440c2579dcab0632efc3132037c4c585
+  metadata.gz: 6c57254616496d86a8b6930ef56a985e209311ce42e9152bc25e37e96df89161dd04801f95310a2c565116307fe18b6e5dd5623bd35aa1cbbb26ae4415513d3f
+  data.tar.gz: e6f62e4853962f109eba4e60758577fe7517ab4e04d1ee271f08e9a5f2e8666762770e5481de20b463377744dec9067e39886eeb2858b3ddb74f3e3a32a6ef40

data/CHANGELOG.md

@@ -10,17 +10,34 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ### Breaking changes
 
+
+## 2.5.0 2019-10-25
+
+### Compatible changes
+- Added [#69](https://github.com/makandra/geordi/issues/69): If bin/setup exists, prefer it over Geordi's standard setup routine.
+- Fixed [#48](https://github.com/makandra/geordi/issues/48): Bundle right before deploying
+- Improved [#56](https://github.com/makandra/geordi/issues/56): Print instructions how to set up `DEPLOY_BRANCH` when deploying the current branch.
+
+
+## 2.4.0 2019-10-21
+
+### Compatible changes
+- [#56](https://github.com/makandra/geordi/issues/56): Add current branch option to "deploy" command. This actually sets the `DEPLOY_BRANCH` variable to the current branch during deployment. The deployed application needs to pick up this variable in the respective Capistrano stage file. Example: `set :branch, ENV['DEPLOY_BRANCH'] || 'master'`
+
+
 ## 2.3.0 2019-08-27
 
 ### Compatible changes
 - Fixes [#70]: Make "console" and "server" commands ready for Rails 6
 - Added: CI testing with Travis
 
+
 ## 2.2.0 2019-02-28
 
 ### Compatible changes
 - Fixes [#67]: Don't run yarn install unless needed
 
+
 ## 2.1.0 2019-02-25
 
 ### Compatible changes

data/Gemfile

@@ -8,4 +8,4 @@ gem 'rspec-mocks'
 gem 'highline'
 gem 'parallel_tests'
 gem 'launchy'
-gem 'pry'
+# gem 'pry' # Not supported for 1.8.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geordi (2.3.0)
+    geordi (2.5.0)
       thor (>= 0.18.0)
 
 GEM
@@ -15,7 +15,6 @@ GEM
     builder (3.2.3)
     childprocess (1.0.1)
       rake (< 13.0)
-    coderay (1.1.2)
     cucumber (1.3.20)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.3)
@@ -28,15 +27,11 @@ GEM
     highline (1.6.21)
     launchy (2.4.3)
       addressable (~> 2.3)
-    method_source (0.9.2)
     multi_json (1.13.1)
     multi_test (0.1.2)
     parallel (0.5.16)
     parallel_tests (0.6.18)
       parallel
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
     rake (10.5.0)
     rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -45,7 +40,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    thor (0.19.1)
+    thor (0.20.3)
 
 PLATFORMS
   ruby
@@ -56,7 +51,6 @@ DEPENDENCIES
   highline
   launchy
   parallel_tests
-  pry
   rspec-mocks
 
 BUNDLED WITH

data/README.md

@@ -96,10 +96,10 @@ Geordi will ask for confirmation before actually deleting files.
 
 Guided deployment across branches.
 
-Example: `geordi deploy` or `geordi deploy p[roduction]`
+Example: `geordi deploy` or `geordi deploy p[roduction]` or `geordi deploy --current-branch`
 
-Merge, push and deploy with a single command! There are several scenarios where
-this command comes in handy:
+Merge, push and deploy with a single command! **It always tells what it will do
+before it does it.** There are different scenarios where this command is handy:
 
 1) *Production deploy:* From the master branch, run `geordi deploy production`.
    This will merge `master` to `production`, push and deploy to production.
@@ -107,6 +107,10 @@ this command comes in handy:
 2) *Feature branch deploy:* From a feature branch, run `geordi deploy staging`.
    This will merge the feature branch to `master`, push and deploy to staging.
 
+   To deploy a feature branch directly without merging, run
+   `geordi deploy --current-branch`. This feature depends on the environment
+   variable `DEPLOY_BRANCH` to be picked up in the respective deploy file.
+
 3) *Simple deploy:* If the source branch matches the target branch, merging will
    be skipped.
 
@@ -259,12 +263,15 @@ Setup a project for the first time.
 
 Example: `geordi setup`
 
-Check out a repository, cd into its directory. Now let `setup` do the tiring
+Check out a repository and cd into its directory. Then let `setup` do the tiring
 work: run `bundle install`, create `database.yml`, create databases, migrate
 (all if applicable).
 
-After setting up, loads a dump into the development db when called with the
-`--dump` option:
+If a local bin/setup file is found, Geordi skips these steps runs bin/setup
+for setup instead.
+
+After setting up, loads a remote database dump into the development db when
+called with the `--dump` option:
 
     geordi setup -d staging
 
@@ -272,8 +279,6 @@ After setting up, runs all tests when called with the `--test` option:
 
     geordi setup -t
 
-See `geordi help setup` for details.
-
 
 ### `geordi shell TARGET`
 

data/features/deploy.feature

@@ -15,6 +15,7 @@ Feature: The deploy command
     Then the output should contain:
       """
       # Checking whether your master branch is ready
+      Util.system! git checkout master
       > All good.
 
       # You are about to:
@@ -35,9 +36,31 @@ Feature: The deploy command
     Deploying the current branch requires support by the deployed application:
     its deploy config needs to pick up the DEPLOY_BRANCH environment variable.
 
+    When I run `geordi deploy --current-branch` interactively
+      # Answer deployment stage prompt
+      And I type "staging"
+    Then the output should contain "configure config/deploy/staging.rb"
+      And the output should contain "ENV['DEPLOY_BRANCH']"
+
+    Given a file named "config/deploy/staging.rb" with:
+      """
+      set :branch, ENV['DEPLOY_BRANCH'] || 'master'
+      """
     When I run `geordi deploy --current-branch` interactively
       # Answer deployment stage prompt
       And I type "staging"
       # Confirm deployment
       And I type "yes"
-    Then the output should contain "DEPLOY_BRANCH=master cap staging deploy:migrations"
+    # Current branch is always "master" during tests
+    Then the output should contain "From current branch master"
+      And the output should contain "DEPLOY_BRANCH=master cap staging deploy:migrations"
+
+
+  Scenario: Deploying with a given stage
+    Given a file named "config/deploy/staging.rb" with "staging.rb exists"
+
+    When I run `geordi deploy staging` interactively
+      And I type "master"
+      And I type ""
+      And I type "no"
+    Then the output should not contain "Deployment stage: [staging]"

data/features/setup.feature

@@ -0,0 +1,11 @@
+Feature: Project setup
+
+  Scenario: A local bin/setup is preferred
+    Given a file named "bin/setup" with "custom project setup"
+
+    When I run `geordi setup`
+    Then the output should contain "Running bin/setup"
+      And the output should contain "Geordi's own setup routine is skipped"
+      And the output should contain "Util.system! bin/setup"
+      And the output should not contain "Creating databases"
+    But the output should contain "Successfully set up the project"

data/features/support/env.rb

@@ -1,5 +1,5 @@
 require 'aruba/cucumber'
-require 'pry'
+# require 'pry'
 
 # Disables execution of Util.system! calls
 ENV['GEORDI_TESTING'] = 'true'

data/lib/geordi/commands/deploy.rb

@@ -1,9 +1,9 @@
 desc 'deploy [STAGE]', 'Guided deployment across branches'
 long_desc <<-LONGDESC
-Example: `geordi deploy` or `geordi deploy p[roduction]`
+Example: `geordi deploy` or `geordi deploy p[roduction]` or `geordi deploy --current-branch`
 
-Merge, push and deploy with a single command! There are several scenarios where
-this command comes in handy:
+Merge, push and deploy with a single command! **It always tells what it will do
+before it does it.** There are different scenarios where this command is handy:
 
 1) *Production deploy:* From the master branch, run `geordi deploy production`.
    This will merge `master` to `production`, push and deploy to production.
@@ -11,6 +11,10 @@ this command comes in handy:
 2) *Feature branch deploy:* From a feature branch, run `geordi deploy staging`.
    This will merge the feature branch to `master`, push and deploy to staging.
 
+   To deploy a feature branch directly without merging, run
+   `geordi deploy --current-branch`. This feature depends on the environment
+   variable `DEPLOY_BRANCH` to be picked up in the respective deploy file.
+
 3) *Simple deploy:* If the source branch matches the target branch, merging will
    be skipped.
 
@@ -28,7 +32,7 @@ LONGDESC
 
 option :no_migrations, :aliases => '-M', :type => :boolean,
   :desc => 'Run cap deploy instead of cap deploy:migrations'
-option :current_branch, :aliases => '-b', :type => :boolean,
+option :current_branch, :aliases => '-c', :type => :boolean,
   :desc => 'Set DEPLOY_BRANCH to the current branch during deploy'
 
 def deploy(target_stage = nil)
@@ -37,12 +41,20 @@ def deploy(target_stage = nil)
   if target_stage and not Util.deploy_targets.include? target_stage
     # Target stage autocompletion from available stages
     target_stage = Util.deploy_targets.find { |t| t.start_with? target_stage }
+    target_stage || warn('Given deployment stage not found')
   end
-  proposed_stage = target_stage || branch_stage_map.fetch(Util.current_branch, 'staging')
 
   # Ask for required information
-  target_stage = prompt 'Deployment stage:', proposed_stage
+  target_stage ||= prompt 'Deployment stage:', branch_stage_map.fetch(Util.current_branch, 'staging')
   if options.current_branch
+    stage_file = "config/deploy/#{target_stage}.rb"
+    Util.file_containing? stage_file, 'DEPLOY_BRANCH' or fail <<-ERROR
+To deploy from the current branch, configure #{stage_file} to respect the
+environment variable DEPLOY_BRANCH. Example:
+
+set :branch, ENV['DEPLOY_BRANCH'] || 'master'
+    ERROR
+
     source_branch = target_branch = Util.current_branch
   else
     source_branch = prompt 'Source branch:', Util.current_branch
@@ -53,7 +65,8 @@ def deploy(target_stage = nil)
   push_needed = merge_needed || `git cherry -v | wc -l`.strip.to_i > 0
   push_needed = false if Util.testing? # Hard to test
 
-  announce "Checking whether your #{source_branch} branch is ready"
+  announce "Checking whether your #{source_branch} branch is ready" ############
+  Util.system! "git checkout #{source_branch}"
   if `git status -s | wc -l`.strip != '0' and not Util.testing?
     warn "Your #{source_branch} branch holds uncommitted changes."
     prompt('Continue anyway?', 'n', /y|yes/) or fail 'Cancelled.'
@@ -73,25 +86,30 @@ def deploy(target_stage = nil)
     Util.system! "git --no-pager log origin/#{target_branch}..#{source_branch} --oneline"
   end
   note "Deploy to #{target_stage}"
+  note "From current branch #{source_branch}" if options.current_branch
 
   if prompt('Go ahead with the deployment?', 'n', /y|yes/)
+    puts
+    git_call = []
+    git_call << "git merge #{source_branch}" if merge_needed
+    git_call << 'git push' if push_needed
+
     capistrano_call = "cap #{target_stage} deploy"
     capistrano_call << ':migrations' unless Util.gem_major_version('capistrano') == 3 || options.no_migrations
     capistrano_call = "bundle exec #{capistrano_call}" if Util.file_containing?('Gemfile', /capistrano/)
     capistrano_call = "DEPLOY_BRANCH=#{source_branch} #{capistrano_call}" if options.current_branch
 
+    if git_call.any?
+      Util.system! git_call.join(' && '), :show_cmd => true
+    end
+
     invoke_cmd 'bundle_install'
-    invoke_cmd 'yarn_install'
 
-    puts
-    commands = []
-    commands << "git merge #{source_branch}" if merge_needed
-    commands << 'git push' if push_needed
-    commands << capistrano_call
-    Util.system! commands.join(' && '), :show_cmd => true
+    Util.system! capistrano_call, :show_cmd => true
 
     success 'Deployment complete.'
   else
+    Util.system! "git checkout #{source_branch}"
     fail 'Deployment cancelled.'
   end
 

data/lib/geordi/commands/setup.rb

@@ -2,20 +2,21 @@ desc 'setup', 'Setup a project for the first time'
 long_desc <<-LONGDESC
 Example: `geordi setup`
 
-Check out a repository, cd into its directory. Now let `setup` do the tiring
+Check out a repository and cd into its directory. Then let `setup` do the tiring
 work: run `bundle install`, create `database.yml`, create databases, migrate
 (all if applicable).
 
-After setting up, loads a dump into the development db when called with the
-`--dump` option:
+If a local bin/setup file is found, Geordi skips these steps runs bin/setup
+for setup instead.
+
+After setting up, loads a remote database dump into the development db when
+called with the `--dump` option:
 
     geordi setup -d staging
 
 After setting up, runs all tests when called with the `--test` option:
 
     geordi setup -t
-
-See `geordi help setup` for details.
 LONGDESC
 
 option :dump, :type => :string, :aliases => '-d', :banner => 'TARGET',
@@ -23,8 +24,15 @@ option :dump, :type => :string, :aliases => '-d', :banner => 'TARGET',
 option :test, :type => :boolean, :aliases => '-t', :desc => 'After setup, run tests'
 
 def setup
-  invoke_cmd 'create_databases'
-  invoke_cmd 'migrate'
+  if File.exists? 'bin/setup'
+    announce 'Running bin/setup'
+    note "Geordi's own setup routine is skipped"
+
+    Util.system! 'bin/setup'
+  else
+    invoke_cmd 'create_databases'
+    invoke_cmd 'migrate'
+  end
 
   success 'Successfully set up the project.'
 

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '2.4.0'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2019-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -83,6 +83,7 @@ files:
 - features/dump.feature
 - features/firefox.feature
 - features/server.feature
+- features/setup.feature
 - features/shell.feature
 - features/support/env.rb
 - features/support/step_definitions/aruba_backport_steps.rb