wildland_dev_tools 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8de6d28a97cdb7086dfbd84528090eaf77c70b36
-  data.tar.gz: ee444d8de3cd5af3cdfaf18e9a93c40e0c4b5e00
+  metadata.gz: 5041629440879fa44f3c8f0aab7891fa580fd3d4
+  data.tar.gz: 4f2bfdcd71896ce4e3f005f76542c5b45ed6f9de
 SHA512:
-  metadata.gz: b1bff2a26651dc1771fc9a477c5ea81069c5105be4000e2bbfd550fd435fd9e2cece188fbb0b5ece4c7092b7177edb31c22a5441d8cb863c28fc4c4f16728549
-  data.tar.gz: 6100ac430ef9ffa4fb080359591c94d5b0fc2a895f3a8bca613aaa2a9497a9785c087ca9c278c7b1b4da69f4e6e7d64c747c079c2bd61061f235eaadde321da4
+  metadata.gz: 030424c622c3137d16135c8f3317f0ba65877977def3fd86260951da215888cc93759595b2cde721013be5cf7fe875fdda389a244b5a6f2301135ff49e4eefce
+  data.tar.gz: 421b71174dc8faa0878e08334abbb4570afa0100131f0495680a8eb29e6a52fbd170e52e3c3e1c0267dbc31c35b5bfb300e5569071d06de4cd581bb9ea98c21d

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+### Added *for new features*
+### Changed *for changes in existing functionality*
+### Deprecated *for soon-to-be removed features*
+### Removed *for now removed features*
+### Fixed *for any bug fixes*
+### Security *in case of vulnerabilities*
+
+## [1.1.0] - 2017-01-29
+### Added *for new features*
+- `copy_production_database_to_staging` added as a rake task
+- Now contains a `CHANGELOG.md`
+
+### Changed *for changes in existing functionality*
+- Most heroku commands will now ask if you want to continue running with a missing remove if run with verbose or force. This means that if you do a staging deploy with no `production` remove it would skip copying the production database.
+
+### Deprecated *for soon-to-be removed features*
+- None
+
+### Removed *for now removed features*
+- None
+
+### Fixed *for any bug fixes*
+- None
+
+### Security *in case of vulnerabilities*
+- None

data/README.md

@@ -2,6 +2,8 @@
 This is a gem that contains all of our dev rake tasks.
 These are most useful for projects created by [trailhead](https://github.com/wildland/trailhead) and are deployed on [heroku](https://www.heroku.com/home) using the [pipeline](https://devcenter.heroku.com/articles/pipelines) feature. This allows for separate `staging` and `production` enviroments as well as review apps.
 
+Checkout our [Changelog](CHANGELOG.md) for what has changed.
+
 ## Installation
 
 - Add the following to your `Gemfile`:

data/lib/tasks/heroku.rake

@@ -1,24 +1,36 @@
 require 'wildland_dev_tools/heroku'
+require 'highline'
 
 namespace :wildland do
   namespace :heroku do
     desc 'Imports the latest production database backup to local database.'
-    task :import_latest_production_database_backup, [:verbose] => [:check_remotes, :check_heroku] do |_t, args| # rubocop:disable Metrics/LineLength
+    task :import_latest_production_database_backup, [:verbose] => [:check_production_remote, :check_heroku] do |_t, args| # rubocop:disable Metrics/LineLength
       WildlandDevTools::Heroku.import_production_database(args[:verbose])
       Rake::Task['db:migrate'].invoke
     end
 
     desc 'Imports the latest staging database backup to local database.'
-    task :import_latest_staging_database_backup, [:verbose] => [:check_remotes, :check_heroku] do |_t, args| # rubocop:disable Metrics/LineLength
+    task :import_latest_staging_database_backup, [:verbose] => [:check_staging_remote, :check_heroku] do |_t, args| # rubocop:disable Metrics/LineLength
       WildlandDevTools::Heroku.import_staging_database(args[:verbose])
       Rake::Task['db:migrate'].invoke
     end
 
     desc 'Backups production database'
-    task :backup_production_database, [:verbose] => [:check_remotes, :check_heroku] do |_t, args| # rubocop:disable Metrics/LineLength
+    task :backup_production_database, [:verbose] => [:check_production_remote, :check_heroku] do |_t, args| # rubocop:disable Metrics/LineLength
       WildlandDevTools::Heroku.backup_production_database(args[:verbose])
     end
 
+    desc 'Copys the production database to staging'
+    task :copy_production_database_to_staging, [:verbose] => [:check_remotes, :check_heroku] do |_t, args| # rubocop:disable Metrics/LineLength
+      begin
+        Rake::Task['wildland:heroku:maintenance_mode_on'].execute
+        WildlandDevTools::Heroku.copy_production_data_to_staging(args[:verbose])
+        WildlandDevTools::Heroku.migrate_staging_database(args[:verbose])
+      ensure
+        Rake::Task['wildland:heroku:maintenance_mode_off'].execute
+      end
+    end
+
     desc 'Promotes staging to production. This automatically creates a production release tag.'
     task :promote_to_production, [:verbose] => [:check_remotes, :check_heroku] do |_t, args| # rubocop:disable Metrics/LineLength
       begin
@@ -31,17 +43,21 @@ namespace :wildland do
         puts e
         WildlandDevTools::Heroku.rollback_production_deploy(true)
         raise
+      ensure
+        Rake::Task['wildland:heroku:maintenance_mode_off'].execute
       end
     end
 
     desc 'Deploy master to staging. This automatically creates a release candidate tag.'
     task :deploy_to_staging, [:verbose, :force] => [:check_remotes, :check_heroku] do |_t, args| # rubocop:disable Metrics/LineLength
       begin
-        WildlandDevTools::Heroku.turn_on_staging_maintenance_mode(args[:verbose])
+        Rake::Task['wildland:heroku:maintenance_mode_on'].execute
         Rake::Task['wildland:releases:create_release_candidate_tag'].execute
         WildlandDevTools::Heroku.deploy_master_to_staging(args[:verbose], args[:force])
-        WildlandDevTools::Heroku.copy_production_data_to_staging(args[:verbose])
-        WildlandDevTools::Heroku.migrate_staging_database(args[:verbose])
+        if WildlandDevTools::Heroku.production_remote_available?
+          WildlandDevTools::Heroku.copy_production_data_to_staging(args[:verbose])
+          WildlandDevTools::Heroku.migrate_staging_database(args[:verbose])
+        end
       rescue WildlandDevTools::GitSyncException => e
         puts e
       rescue RuntimeError => e
@@ -49,17 +65,19 @@ namespace :wildland do
         WildlandDevTools::Heroku.rollback_staging_deploy(true)
         raise
       ensure
-        WildlandDevTools::Heroku.turn_off_staging_maintenance_mode(args[:verbose])
+        Rake::Task['wildland:heroku:maintenance_mode_off'].execute
       end
     end
 
     desc 'Deploy current branch to staging as master. This does not create a release canidate tag.'
     task :deploy_current_branch_to_staging, [:verbose, :force] => [:check_remotes, :check_heroku] do |_t, args| # rubocop:disable Metrics/LineLength
       begin
-        WildlandDevTools::Heroku.turn_on_staging_maintenance_mode(args[:verbose])
+        Rake::Task['wildland:heroku:maintenance_mode_on'].execute
         WildlandDevTools::Heroku.deploy_current_branch_to_staging(args[:verbose], args[:force])
-        WildlandDevTools::Heroku.copy_production_data_to_staging(args[:verbose])
-        WildlandDevTools::Heroku.migrate_staging_database(args[:verbose])
+        if WildlandDevTools::Heroku.production_remote_available?
+          WildlandDevTools::Heroku.copy_production_data_to_staging(args[:verbose])
+          WildlandDevTools::Heroku.migrate_staging_database(args[:verbose])
+        end
       rescue WildlandDevTools::GitSyncException => e
         puts e
       rescue RuntimeError => e
@@ -67,7 +85,7 @@ namespace :wildland do
         WildlandDevTools::Heroku.rollback_staging_deploy(true)
         raise
       ensure
-        WildlandDevTools::Heroku.turn_off_staging_maintenance_mode(args[:verbose])
+        Rake::Task['wildland:heroku:maintenance_mode_off'].execute
       end
     end
 
@@ -94,21 +112,54 @@ namespace :wildland do
     task :check_heroku do
       unless WildlandDevTools::Heroku.heroku_toolbelt_available?
         Kernel.abort(
-          'Missing heroku toolbelt. Run \'brew install heroku-toolbelt\'.'
+          'Missing heroku toolbelt. See \'https://devcenter.heroku.com/articles/heroku-cli\'.'
         )
       end
     end
 
-    task :check_remotes do
+    task :check_remotes => [:check_staging_remote, :check_production_remote]
+
+    task :check_staging_remote do |t, args|
+      ask = args[:force] || args[:verbose] || false
+      manual_override = false
       unless WildlandDevTools::Heroku.staging_remote_available?
+        if ask
+          cli = HighLine.new
+          cli.choose do |menu|
+            menu.prompt = "Staging remote not found. Try to continue anyways? "
+            menu.choice(:yes) do
+              cli.say("Trying to continue.")
+              manual_override = true
+            end
+            menu.choice(:no)
+            menu.default = :no
+          end
+        end
         Kernel.abort(
           'Missing staging git remote. Run \'heroku git:remote -a <app-name> -r staging\'' # rubocop:disable Metrics/LineLength
-        )
+        ) unless manual_override
       end
+    end
+
+    task :check_production_remote do |t, args|
+      ask = args[:force] || args[:verbose] || false
+      manual_override = false
       unless WildlandDevTools::Heroku.production_remote_available?
+        if ask
+          cli = HighLine.new
+          cli.choose do |menu|
+            menu.prompt = "Production remote not found. Try to continue anyways? "
+            menu.choice(:yes) do
+              cli.say("Trying to continue.")
+              manual_override = true
+            end
+            menu.choice(:no)
+            menu.default = :no
+          end
+        end
         Kernel.abort(
           'Missing production git remote. Run \'heroku git:remote -a <app-name> -r production\'' # rubocop:disable Metrics/LineLength
-        )
+        ) unless manual_override
       end
     end
   end

data/lib/wildland_dev_tools/heroku.rb

@@ -10,44 +10,34 @@ module WildlandDevTools
         rollback_production_database(verbose)
       end
 
-      def turn_on_staging_maintenance_mode(verbose = false)
-        remote = 'staging'
-        puts "Turning on maintenance mode for #{remote}" if verbose
-        system("heroku maintenance:on -r #{remote}")
-      end
-
-      def turn_off_staging_maintenance_mode(verbose = false)
-        remote = 'staging'
-        puts "Turning off maintenance mode for #{remote}" if verbose
-        system("heroku maintenance:off -r #{remote}")
-      end
-
       def turn_on_heroku_maintenance_mode(verbose = false)
         %w(staging production).each do |remote|
-          puts "Turning on maintenance mode for #{remote}" if verbose
-          system("heroku maintenance:on -r #{remote}")
+          if remote_available? remote
+            puts "Turning on maintenance mode for #{remote}" if verbose
+            system("heroku maintenance:on -r #{remote}")
+          end
         end
       end
 
       def turn_off_heroku_maintenance_mode(verbose = false)
         %w(staging production).each do |remote|
-          puts "Turning off maintenance mode for #{remote}" if verbose
-          system("heroku maintenance:off -r #{remote}")
+          if remote_available? remote
+            puts "Turning off maintenance mode for #{remote}" if verbose
+            system("heroku maintenance:off -r #{remote}")
+          end
         end
       end
 
       def deploy_master_to_staging(verbose = false, force = false)
         puts 'Detecting current branch name.' if verbose
-        branch = get_current_branch_name
-        raise GitSyncException, 'Please checkout master branch' unless branch == 'master'
-        deploy_to_staging(branch, verbose, force)
+        raise GitSyncException, 'Please checkout master branch' unless on_master_branch?
+        deploy_to_staging(get_current_branch_name, verbose, force)
       end
 
 
       def deploy_current_branch_to_staging(verbose = false, force = false)
         puts 'Detecting current branch name.' if verbose
-        branch = get_current_branch_name
-        deploy_to_staging(branch, verbose, force)
+        deploy_to_staging(get_current_branch_name, verbose, force)
       end
 
       def deploy_to_staging(branch, verbose = false, force = false)
@@ -127,11 +117,15 @@ module WildlandDevTools
       end
 
       def staging_remote_available?
-        Git.open('.').remotes.map(&:to_s).include?('staging')
+        remote_available? 'staging'
       end
 
       def production_remote_available?
-        Git.open('.').remotes.map(&:to_s).include?('production')
+        remote_available? 'production'
+      end
+
+      def remote_available?(remote_name)
+        Git.open('.').remotes.map(&:to_s).include?(remote_name)
       end
 
       def heroku_toolbelt_available?
@@ -160,12 +154,10 @@ module WildlandDevTools
         system("heroku rollback #{remote}")
       end
 
-      def rollback_database(remote, verbose = false)
+      def rollback_database(remote)
         ensure_valid_remote(remote)
-        if verbose
-          puts "Manually restore database for #{remote}"
-          puts 'Then run \"rake wildland:heroku:maintenance_mode_off\"'
-        end
+        puts "Manually restore database for #{remote}"
+        puts 'Then run \"rake wildland:heroku:maintenance_mode_off\"'
       end
 
       def migrate_database(remote, verbose = false)
@@ -191,7 +183,15 @@ module WildlandDevTools
       end
 
       def get_current_branch_name
-        `git rev-parse --abbrev-ref HEAD`.strip
+        `git rev-parse --abbrev-ref HEAD`.strip # TODO swap to ruby-git
+      end
+
+      def on_master_branch?
+        on_branch? 'master'
+      end
+
+      def on_branch?(branch_name)
+        get_current_branch_name == branch_name
       end
 
       def get_app_name(remote, verbose = false)

data/lib/wildland_dev_tools/version.rb

@@ -1,3 +1,3 @@
 module WildlandDevTools
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/wildland_dev_tools.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "wildland_dev_tools"
   spec.version       = WildlandDevTools::VERSION
   spec.authors       = ["Joe Weakley"]
-  spec.email         = ["joew@samjoe.com"]
+  spec.email         = ["joe@wild.land.com"]
 
   spec.summary       = 'Wildland Dev Tools'
   spec.description   = 'Wildland Dev Tools'
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'git', '~> 1.3', '>= 1.3.0'
   spec.add_runtime_dependency 'table_print', '~> 1.5', '>= 1.5.6'
   spec.add_runtime_dependency 'brakeman', '~> 4.1'
+  spec.add_runtime_dependency 'highline', '~> 1.7'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wildland_dev_tools
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Joe Weakley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -98,6 +98,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -142,7 +156,7 @@ dependencies:
         version: '0'
 description: Wildland Dev Tools
 email:
-- joew@samjoe.com
+- joe@wild.land.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -150,6 +164,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md