heroku_tool 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 366d3213e1b652d45f89a3cdc8cd76ccfdf48c5727c13cbdcf215cef666c1a2e
-  data.tar.gz: 315e1c68673b6f3af2d944633b19d3f75d3856a9e8d81d028ada208834cd9759
+  metadata.gz: 54667e338f64d0555965c42828d5e5363bded258cb60e55af76e5a2339bb9c03
+  data.tar.gz: c1d86d98c1ade53354d5e7f1d54d3bac19d6749e57bdd24cd17400d2172cd6d4
 SHA512:
-  metadata.gz: ee39dd422b621fe18873394e5ae60e68f6294137de76dc0bfa67e084e4763791edc4d2bb74f1e7f0ccd2e4e05e0113b0ad9b38f92c0e825445d4095064cceb80
-  data.tar.gz: b9b3254bb923175c97f69ead7cb9658063a94ed499bb41b0da30075e406cd1c0b31a41127e924593a0f9f27df542e81940529d0bb0514c385c22888cc6fa21cb
+  metadata.gz: bfcd540d5d6072385d293792819d519a5bf717a7eeca4bde76eac45975e9e967ef2fca9a85b38c173d7a5088f5e76d0e9e76c39dd6adff810f869ea6a60167e8
+  data.tar.gz: 15dde81dbe811594f2abdc88ed79b9d60c5b5e76b0c920b1ecf97de93c92d493a72776b0f3e2e9b3f456ec5f2d25eb5bc232edb4ec29b19ac845407d19853d21

data/.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.2', '3.3', '3.4', '4.0']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+    - name: Run rubocop
+      run: bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,49 @@
+require:
+  - standard
+plugins:
+  - rubocop-rspec
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  Exclude:
+    - node_modules/**/*
+    - public/**/*
+    - vendor/**/*
+
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/ExampleWording:
+  Enabled: false
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.9.0
+
+- BREAKING CHANGE: Heroku::Configuration has been renamed to HerokuTool::Configuration and is now must be an instance not a class method
+- BREAKING CHANGE: drop set_message for simplicity - you can do that as part of Configuration.before_deploying and Configuration.after_deploying
+- don't continue if git push fails (output AND return status and don't do migration, deployment tracking etc)
+
 ## v0.8.0
 
 - allow for multiple databases in configuration

data/README.md

@@ -107,11 +107,10 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 To install this gem onto your local machine, run `bundle exec rake install`.
 
 
-Ensure standards before PR:
+Ensure standards (and other rubocop) before PR:
 
-    bundle exec standardrb --fix
+    bundle exec rubocop -a
 
-(TODO: enforce this or rubocop)
 
 ## Release
 

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/heroku_tool.gemspec

@@ -27,5 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "standard", "~> 0.4.1"
+  spec.add_development_dependency "standard", "~> 1.52.0"
+  spec.add_development_dependency "rubocop", "~> 1.81.7"
+  spec.add_development_dependency "rubocop-rspec", "~> 3.8.0"
 end

data/lib/heroku_tool/commander.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module HerokuTool
+  class Commander
+    # @return [HerokuTool::HerokuTargets::HerokuTarget]
+    attr_reader :target
+    attr_reader :configuration
+
+    def initialize(target, configuration:, **options)
+      @target = target
+      @migrate_outside_of_release_phase = target&.migrate_in_release_phase ? false : options[:migrate]
+      @configuration = configuration
+    end
+
+    def deploy(deploy_ref, with_maintenance:)
+      deploy_ref_description = deploy_ref_describe(deploy_ref)
+      puts "Deploy #{deploy_ref_description} to #{target} with migrate=#{target.migrate_in_release_phase ? "(during release phase)" : migrate_outside_of_release_phase?} with_maintenance=#{with_maintenance} "
+
+      output_to_be_deployed(deploy_ref)
+      configuration.before_deploying(self, target, deploy_ref_description)
+      successful_push = puts_and_system "git push -f #{target.git_remote} #{deploy_ref || target}^{}:#{target.heroku_target_ref}"
+
+      return false unless successful_push
+
+      maintenance_on if with_maintenance
+      if migrate_outside_of_release_phase?
+        puts_and_system "heroku run rake db:migrate -a #{target.heroku_app}"
+      end
+
+      app_revision_env_var = configuration.app_revision_env_var
+      if app_revision_env_var && app_revision_env_var != "HEROKU_SLUG_COMMIT"
+        # HEROKU_SLUG_COMMIT is automatically set by https://devcenter.heroku.com/articles/dyno-metadata
+        puts_and_system %{heroku config:set #{app_revision_env_var}=$(git describe --always #{deploy_ref}) -a #{target.heroku_app}}
+      end
+
+      maintenance_off if with_maintenance
+      configuration.after_deploying(self, target, deploy_ref_description)
+      true
+    end
+
+    def maintenance_on
+      puts_and_system "heroku maintenance:on -a #{target.heroku_app}"
+      puts_and_system "heroku config:set #{configuration.maintenance_mode_env_var}=true -a #{target.heroku_app}"
+    end
+
+    def maintenance_off
+      puts_and_system "heroku maintenance:off -a #{target.heroku_app}"
+      puts_and_system "heroku config:unset #{configuration.maintenance_mode_env_var} -a #{target.heroku_app}"
+    end
+
+    def migrate_outside_of_release_phase?
+      @migrate_outside_of_release_phase
+    end
+
+    def deploy_ref_describe(deploy_ref = nil)
+      `git describe #{deploy_ref || target.deploy_ref}`.strip
+    end
+
+    def output_to_be_deployed(since_deploy_ref = nil)
+      puts "------------------------------"
+      puts " Deploy to #{target}:"
+      puts "------------------------------"
+      system_with_clean_env "git --no-pager log $(heroku config:get #{configuration.app_revision_env_var} -a #{target.heroku_app})..#{since_deploy_ref || target.deploy_ref}"
+      puts "------------------------------"
+    end
+
+    # @return [Boolean] true if the command was successful
+    def puts_and_system(cmd)
+      puts cmd
+      puts "-------------"
+      system_with_clean_env(cmd).tap do |result|
+        if result
+          puts "-------------"
+        else
+          puts "❌❌❌❌❌❌❌❌❌❌"
+        end
+      end
+    end
+
+    def puts_and_exec(cmd)
+      puts cmd
+      exec_with_clean_env(cmd)
+    end
+
+    def exec_with_clean_env(cmd)
+      if defined?(Bundler) && Bundler.respond_to?(:with_unbundled_env)
+        Bundler.with_unbundled_env { `#{cmd}` }
+      elsif defined?(Bundler)
+        Bundler.with_clean_env { `#{cmd}` }
+      else
+        `#{cmd}`
+      end
+    end
+
+    protected
+
+    def system_with_clean_env(cmd)
+      if defined?(Bundler) && Bundler.respond_to?(:with_unbundled_env)
+        Bundler.with_unbundled_env { system cmd }
+      elsif defined?(Bundler)
+        Bundler.with_clean_env { system cmd }
+      else
+        system cmd
+      end
+    end
+  end
+end

data/lib/heroku_tool/configuration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module HerokuTool
+  class Configuration
+    def platform_maintenance_urls(asset_host)
+      time = Time.now.strftime("%Y%m%d-%H%M-%S")
+      {
+        ERROR_PAGE_URL: "https://#{asset_host}/platform_error/#{time}",
+        MAINTENANCE_PAGE_URL: "https://#{asset_host}/platform_maintenance/#{time}"
+      }
+    end
+
+    def maintenance_mode_env_var
+      "X_HEROKU_TOOL_MAINTENANCE_MODE"
+    end
+
+    def app_revision_env_var
+      # alternatively if you want you can set this as APP_REVISION (for app-signal) or HEROKU_SLUG_COMMIT (see https://devcenter.heroku.com/articles/dyno-metadata)
+    end
+
+    def before_deploying(_instance, target, version, description: nil)
+      puts "about to deploy #{version} to #{target.name}"
+      puts "         #{description}" if description
+    end
+
+    def after_deploying(_instance, target, version, description: nil)
+      puts "deployed #{version} to #{target.name}"
+      puts "         #{description}" if description
+    end
+
+    def notify_of_deploy_tracking(instance, deploy_ref:, revision:)
+      if ENV["BUGSNAG_API_KEY"].present?
+        instance.notify_bugsnag_of_deploy_tracking(deploy_ref:, revision:)
+      else
+        puts "can't notify of deploy tracking: env var not present: BUGSNAG_API_KEY"
+      end
+    end
+
+    def after_sync_down(instance)
+      # could add source ?
+      instance.puts_and_system "rails db:migrate"
+      instance.puts_and_system "rails db:test:prepare"
+    end
+
+    def after_sync_to(instance, target)
+      # could add source ?
+      instance.puts_and_system %(heroku run rails db:migrate -a #{target.heroku_app})
+    end
+  end
+end

data/lib/heroku_tool/db_configuration.rb

@@ -8,12 +8,12 @@ module HerokuTool
       @config_all = YAML.safe_load(db_config_from_file, permitted_classes: [], permitted_symbols: [], aliases: true)
       config_env = @config_all[rails_env]
       @config_env = if config_env["database"].is_a?(String)
-                      config_env
-                    elsif config_env.key?("primary")
-                      config_env["primary"]
-                    else
-                      config_env.values.first
-                    end
+        config_env
+      elsif config_env.key?("primary")
+        config_env["primary"]
+      else
+        config_env.values.first
+      end
     end
 
     def generate_drop_tables_sql
@@ -29,6 +29,5 @@ module HerokuTool
     def database
       config_env["database"]
     end
-
   end
 end

data/lib/heroku_tool/heroku_targets.rb

@@ -11,7 +11,7 @@ module HerokuTool
       end
 
       def from_file(yaml_file)
-        new(YAML.safe_load(File.read(yaml_file)))
+        new(YAML.safe_load_file(yaml_file))
       end
     end
 

data/lib/heroku_tool/tasks/heroku.thor

@@ -3,65 +3,35 @@
 require "thor"
 require_relative "../db_configuration"
 require_relative "../heroku_targets"
-require_relative "../thor_utils"
+require_relative "../commander"
+require_relative "../configuration"
 
 class Heroku < Thor
-  module Configuration
-    class << self
-      def platform_maintenance_urls(asset_host)
-        time = Time.now.strftime("%Y%m%d-%H%M-%S")
-        {
-          ERROR_PAGE_URL: "https://#{asset_host}/platform_error/#{time}",
-          MAINTENANCE_PAGE_URL: "https://#{asset_host}/platform_maintenance/#{time}"
-        }
-      end
-
-      def maintenance_mode_env_var
-        "X_HEROKU_TOOL_MAINTENANCE_MODE"
-      end
-
-      def app_revision_env_var
-        # alternatively if you want you can set this as APP_REVISION (for app-signal) or HEROKU_SLUG_COMMIT (see https://devcenter.heroku.com/articles/dyno-metadata)
-      end
-
-      def before_deploying(_instance, target, version, description: nil)
-        puts "about to deploy #{version} to #{target.name}"
-        puts "         #{description}" if description
-      end
-
-      def after_deploying(_instance, target, version, description: nil)
-        puts "deployed #{version} to #{target.name}"
-        puts "         #{description}" if description
-      end
-
-      def notify_of_deploy_tracking(running_thor_task, release_stage:, revision:, revision_describe:, repository:, target:, target_name:, deploy_ref:)
-        if ENV["BUGSNAG_API_KEY"].present?
-          running_thor_task.notify_bugsnag_of_deploy_tracking(deploy_ref, release_stage, repository, revision, revision_describe, target_name)
-        else
-          puts "can't notify of deploy tracking: env var not present: BUGSNAG_API_KEY"
-        end
-      end
-
-      def after_sync_down(instance)
-        # could add source ?
-        instance.puts_and_system "rake db:migrate"
-        instance.puts_and_system "rake db:test:prepare"
-      end
+  namespace "heroku"
+  module Shared
+    attr_accessor :implied_source
+    # @return [HerokuTool::HerokuTarget]
+    attr_reader :target
 
-      def after_sync_to(instance, target)
-        # could add source ?
-        instance.puts_and_system %(heroku run rake db:migrate -a #{target.heroku_app})
-      end
+    # @return [HerokuTool::Commander] commander for target
+    def commander
+      @commander ||= ::HerokuTool::Commander.new(target, configuration: configuration, **options.symbolize_keys)
     end
-  end
 
-  module Shared
-    attr_accessor :implied_source, :implied_target
+    def configuration
+      ::HerokuTool::Configuration.new
+    end
 
-    include HerokuTool::ThorUtils
+    def self.included(base)
+      #:nodoc:
+      super
+      base.extend ClassMethods
+    end
 
-    def self.exit_on_failure?
-      true
+    module ClassMethods
+      def exit_on_failure?
+        true
+      end
     end
 
     def lookup_heroku_staging(staging_target_name)
@@ -72,7 +42,7 @@ class Heroku < Thor
       heroku_targets.targets[target_name] || raise_missing_target(target_name, false)
     end
 
-    def check_deploy_ref(deploy_ref, target = implied_target)
+    def check_deploy_ref(deploy_ref)
       if deploy_ref && deploy_ref[0] == "-"
         raise Thor::Error, "Invalid deploy ref '#{deploy_ref}'"
       end
@@ -93,33 +63,13 @@ class Heroku < Thor
     end
 
     def heroku_targets
-      @heroku_targets ||= HerokuTool::HerokuTargets.from_file(File.expand_path("config/heroku_targets.yml"))
+      @heroku_targets ||= ::HerokuTool::HerokuTargets.from_file(File.expand_path("config/heroku_targets.yml"))
     end
 
     protected
 
-    def deploy_message(deploy_ref_describe, target = implied_target)
-      downtime = migrate_outside_of_release_phase?(target) ? "👷 There will be a very short maintenance downtime" : ""
-      message = <<-DEPLOY_MESSAGE
-     Deploying #{target.display_name} #{deploy_ref_describe}.
-     #{downtime} (in less than a minute from now).
-      DEPLOY_MESSAGE
-      message.gsub(/(\s|\n)+/, " ")
-    end
-
-    def migrate_outside_of_release_phase?(target = implied_target)
-      target.migrate_in_release_phase ? false : options[:migrate]
-    end
-
-    def maintenance_on(target = implied_target)
-      puts_and_system "heroku maintenance:on -a #{target.heroku_app}"
-      puts_and_system "heroku config:set #{Heroku::Configuration.maintenance_mode_env_var}=true -a #{target.heroku_app}"
-    end
-
-    def maintenance_off(target = implied_target)
-      puts_and_system "heroku maintenance:off -a #{target.heroku_app}"
-      puts_and_system "heroku config:unset #{Heroku::Configuration.maintenance_mode_env_var} -a #{target.heroku_app}"
-    end
+    delegate :deploy_ref_describe, :exec_with_clean_env, :maintenance_off, :maintenance_on, :output_to_be_deployed, :migrate_outside_of_release_phase?, :puts_and_exec, :puts_and_system,
+      to: :commander
   end
 
   include Shared
@@ -181,41 +131,23 @@ class Heroku < Thor
   method_option :maintenance, default: nil, desc: "Maintenance step", type: :boolean
 
   def deploy(target_name, deploy_ref = nil)
-    self.implied_target = lookup_heroku(target_name)
-    deploy_ref = check_deploy_ref(deploy_ref, implied_target)
-    deploy_ref_description = deploy_ref_describe(deploy_ref)
-    maintenance = options[:maintenance].nil? && migrate_outside_of_release_phase?(implied_target) || options[:maintenance] || false
-    puts "Deploy #{deploy_ref_description} to #{implied_target} with migrate=#{implied_target.migrate_in_release_phase ? "(during release phase)" : migrate_outside_of_release_phase?(implied_target)} maintenance=#{maintenance} "
-
-    invoke :list_deployed, [target_name, deploy_ref], {}
-    message = deploy_message(deploy_ref_description)
-    Configuration.before_deploying(self, implied_target, deploy_ref_description)
-    set_message(target_name, message)
-    puts_and_system "git push -f #{implied_target.git_remote} #{deploy_ref}^{}:#{implied_target.heroku_target_ref}"
-
-    maintenance_on if maintenance
-    if migrate_outside_of_release_phase?
-      puts_and_system "heroku run rake db:migrate -a #{implied_target.heroku_app}"
-    end
-
-
-    app_revision_env_var = Heroku::Configuration.app_revision_env_var
-    if app_revision_env_var && app_revision_env_var != "HEROKU_SLUG_COMMIT"
-      # HEROKU_SLUG_COMMIT is automatically set by https://devcenter.heroku.com/articles/dyno-metadata
-      puts_and_system %{heroku config:set #{app_revision_env_var}=$(git describe --always #{deploy_ref}) -a #{implied_target.heroku_app}}
+    @target = lookup_heroku(target_name)
+    check_deploy_ref(deploy_ref)
+    with_maintenance = options[:maintenance].nil? && migrate_outside_of_release_phase? || options[:maintenance] || false
+    deploy_ref ||= target.deploy_ref
+    success = commander.deploy(deploy_ref, with_maintenance: with_maintenance)
+    if success
+      deploy_tracking(target_name, deploy_ref)
+    else
+      exit(-1)
     end
-
-    maintenance_off if maintenance
-    set_message(target_name, nil)
-    Configuration.after_deploying(self, implied_target, deploy_ref_description)
-    deploy_tracking(target_name, deploy_ref)
   end
 
   desc "maintenance ON|OFF", "turn maintenance mode on or off"
   method_option :target_name, aliases: "a", desc: "Target (app or remote)"
 
   def maintenance(on_or_off)
-    self.implied_target = lookup_heroku(options[:target_name])
+    @target = lookup_heroku(options[:target_name])
     case on_or_off.upcase
     when "ON"
       maintenance_on
@@ -229,45 +161,46 @@ class Heroku < Thor
   desc "set_urls TARGET", "set and cache the error and maintenance page urls for TARGET"
 
   def set_urls(target_name)
-    self.implied_target = lookup_heroku(target_name)
+    @target = lookup_heroku(target_name)
     unless asset_host.presence
-      puts "asset host (ASSET_HOST) not found on #{implied_target.heroku_app}"
+      puts "asset host (ASSET_HOST) not found on #{target.heroku_app}"
       return
     end
-    url_hash = Configuration.platform_maintenance_urls(asset_host)
+    url_hash = configuration.platform_maintenance_urls(asset_host)
     url_hash.each do |_env, url|
       puts_and_system "open #{url}"
     end
     puts_and_system(
-      "heroku config:set #{url_hash.map { |e, u| "#{e}=#{u}" }.join(" ")} -a #{implied_target.heroku_app}"
+      "heroku config:set #{url_hash.map { |e, u| "#{e}=#{u}" }.join(" ")} -a #{target.heroku_app}"
     )
   end
 
   no_commands do
-    def asset_host(target = implied_target)
-      if target == implied_target
-        @asset_host ||= fetch_asset_host(target)
-      else
-        fetch_asset_host(target)
-      end
+    def asset_host
+      @asset_host ||= fetch_asset_host
     end
 
     def get_config_env(target, env_var)
       puts_and_exec("heroku config:get #{env_var} -a #{target.heroku_app}").strip.presence
     end
 
-    def deploy_ref_describe(deploy_ref)
-      `git describe #{deploy_ref}`.strip
+    def notify_of_deploy_tracking(deploy_ref)
+      revision = `git log -1 #{deploy_ref || target.deploy_ref} --pretty=format:%H`
+      configuration.notify_of_deploy_tracking(
+        self,
+        deploy_ref: deploy_ref,
+        revision: revision
+      )
     end
 
-    def notify_bugsnag_of_deploy_tracking(deploy_ref, release_stage, repository, revision, revision_describe, target_name)
+    def notify_bugsnag_of_deploy_tracking(deploy_ref:, revision:)
       api_key = ENV["BUGSNAG_API_KEY"]
       data = %W[
         apiKey=#{api_key}
-        releaseStage=#{release_stage}
-        repository=#{repository}
+        releaseStage=#{target.trackable_release_stage}
+        repository=#{target.repository}
         revision=#{revision}
-        appVersion=#{revision_describe}
+        appVersion=#{deploy_ref_describe(deploy_ref)}
       ].join("&")
       if api_key.blank?
         puts "\n" + ("*" * 80) + "\n"
@@ -275,7 +208,7 @@ class Heroku < Thor
         puts command
         puts "\n" + ("*" * 80) + "\n"
         puts "NB: can't notify unless you specify BUGSNAG_API_KEY and rerun"
-        puts "  thor heroku:deploy_tracking #{target_name} #{deploy_ref}"
+        puts "  thor heroku:deploy_tracking #{target.name} #{deploy_ref}"
       else
         puts_and_system "curl -d \"#{data}\" http://notify.bugsnag.com/deploy"
       end
@@ -285,42 +218,27 @@ class Heroku < Thor
   desc "deploy_tracking TARGET (REF)", "set deploy tracking for TARGET and REF (used by deploy)"
 
   def deploy_tracking(target_name, deploy_ref = nil)
-    self.implied_target = lookup_heroku(target_name)
-    deploy_ref = check_deploy_ref(deploy_ref)
-    revision = `git log -1 #{deploy_ref} --pretty=format:%H`
-    Heroku::Configuration.notify_of_deploy_tracking(
-      self,
-      deploy_ref: deploy_ref,
-      release_stage: implied_target.trackable_release_stage,
-      revision: revision,
-      target: implied_target,
-      target_name: target_name,
-      revision_describe: deploy_ref_describe(deploy_ref),
-      repository: implied_target.repository
-    )
+    @target = lookup_heroku(target_name)
+    check_deploy_ref(deploy_ref)
+    notify_of_deploy_tracking(deploy_ref)
   end
 
-  include HerokuTool::ThorUtils
   desc "set_message TARGET (MESSAGE)", "set message (no-op by default)"
 
   def set_message(target_name, message = nil)
     # no-op -- define as override
   end
 
-  desc "list_deployed TARGET (DEPLOY_REF)", "list what would be deployed to TARGET (optionally specify deploy_ref)"
+  desc "to_be_deployed TARGET (SINCE_DEPLOY_REF)", "list what would be deployed to TARGET (optionally specify SINCE_DEPLOY_REF)"
 
-  def list_deployed(target_name, deploy_ref = nil)
-    if Heroku::Configuration.app_revision_env_var.nil?
-      puts "Can't list deployed as Heroku::Configuration.app_revision_env_var is not set"
+  def to_be_deployed(target_name, since_deploy_ref = nil)
+    if configuration.app_revision_env_var.nil?
+      puts "Can't list deployed as Configuration.app_revision_env_var is not set"
       return
     end
-    self.implied_target = lookup_heroku(target_name)
-    deploy_ref = check_deploy_ref(deploy_ref)
-    puts "------------------------------"
-    puts " Deploy to #{implied_target}:"
-    puts "------------------------------"
-    system_with_clean_env "git --no-pager log $(heroku config:get #{Heroku::Configuration.app_revision_env_var} -a #{implied_target.heroku_app})..#{deploy_ref}"
-    puts "------------------------------"
+    @target = lookup_heroku(target_name)
+    check_deploy_ref(since_deploy_ref)
+    output_to_be_deployed(since_deploy_ref)
   end
 
   desc "about (TARGET)", "Describe available targets or one specific target"
@@ -332,19 +250,21 @@ class Heroku < Thor
         puts " * #{key} (#{target})"
       end
     else
-      self.implied_target = lookup_heroku(target_name)
+      @target = lookup_heroku(target_name)
       puts "Target #{target_name}:"
-      puts " * display_name: #{implied_target.display_name}"
-      puts " * heroku_app:   #{implied_target.heroku_app}"
-      puts " * git_remote:   #{implied_target.git_remote}"
-      puts " * deploy_ref:   #{implied_target.deploy_ref}"
+      puts " * display_name: #{target.display_name}"
+      puts " * heroku_app:   #{target.heroku_app}"
+      puts " * git_remote:   #{target.git_remote}"
+      puts " * deploy_ref:   #{target.deploy_ref}"
     end
     puts
     puts "(defined in config/heroku_targets.yml)"
   end
 
   class Sync < Thor
+    namespace "heroku:db"
     include Shared
+
     class_option :from, type: :string, desc: "source target (production, staging...)", required: true, aliases: "f"
 
     desc "down --from SOURCE_TARGET", "syncs db down from SOURCE_TARGET | thor heroku:sync -f production"
@@ -391,9 +311,9 @@ class Heroku < Thor
     def from_dump
       invoke "warn", [], from: options[:from]
       source = lookup_heroku(options[:from])
-      db_config = HerokuTool::DbConfiguration.new
+      db_config = ::HerokuTool::DbConfiguration.new
       puts_and_system "pg_restore --verbose --clean --no-acl --no-owner -h localhost #{db_config.user_arg} -d #{db_config.database} #{source.dump_filename}"
-      Configuration.after_sync_down(self) unless options[:just_restore]
+      configuration.after_sync_down(self) unless options[:just_restore]
     end
 
     desc "dump_to_tmp", "dump to tmp directory"
@@ -407,15 +327,15 @@ class Heroku < Thor
     desc "to STAGING_TARGET --from=SOURCE_TARGET", "push db onto STAGING_TARGET from SOURCE_TARGET"
 
     def to(to_target_name)
-      self.implied_target = lookup_heroku_staging(to_target_name)
+      @target = lookup_heroku_staging(to_target_name)
       self.implied_source = lookup_heroku(options[:from])
 
-      maintenance_on # target, not source
+      maintenance_on
 
       puts_and_system %(
-        heroku pg:copy #{implied_source.heroku_app}::#{implied_source.db_color} #{implied_target.db_color} -a #{implied_target.heroku_app} --confirm #{implied_target.heroku_app}
+        heroku pg:copy #{implied_source.heroku_app}::#{implied_source.db_color} #{target.db_color} -a #{target.heroku_app} --confirm #{target.heroku_app}
       )
-      Configuration.after_sync_to(self, implied_target) unless options[:just_copy]
+      configuration.after_sync_to(self, target) unless options[:just_copy]
       maintenance_off
     end
 
@@ -424,7 +344,7 @@ class Heroku < Thor
     def dump_local(dumpfilepath)
       puts "dumping postgres to #{dumpfilepath}"
       rails_env = ENV["RAILS_ENV"] || "development"
-      db_config = HerokuTool::DbConfiguration.new.config[rails_env]
+      db_config = ::HerokuTool::DbConfiguration.new.config[rails_env]
       db_username = db_config["username"]
       db = db_config["database"]
       system_with_clean_env "pg_dump --verbose --clean --no-acl --no-owner -h localhost -U #{db_username} --format=c #{db} > #{dumpfilepath}"
@@ -432,36 +352,37 @@ class Heroku < Thor
   end
 
   class Db < Thor
+    namespace "heroku:db"
     include Shared
 
     desc "drop_all_tables on STAGING_TARGET", "drop all tables on STAGING_TARGET"
 
     def drop_all_tables(staging_target_name)
-      self.implied_target = lookup_heroku_staging(staging_target_name)
-      generate_drop_tables_sql = `#{HerokuTool::DbConfiguration.new.generate_drop_tables_sql}`
-      cmd_string = %(heroku pg:psql -a #{implied_target.heroku_app} -c "#{generate_drop_tables_sql}")
+      @target = lookup_heroku_staging(staging_target_name)
+      generate_drop_tables_sql = `#{::HerokuTool::DbConfiguration.new.generate_drop_tables_sql}`
+      cmd_string = %(heroku pg:psql -a #{target.heroku_app} -c "#{generate_drop_tables_sql}")
       puts_and_system(cmd_string)
     end
 
     desc "anonymize STAGING_TARGET", "run anonymization scripts on STAGING_TARGET"
 
     def anonymize(staging_target_name)
-      self.implied_target = lookup_heroku_staging(staging_target_name)
+      @target = lookup_heroku_staging(staging_target_name)
       puts_and_system %(
-        heroku run rake data:anonymize -a #{implied_target.heroku_app}
+        heroku run rake data:anonymize -a #{target.heroku_app}
       )
     end
   end
 
   private
 
-  def fetch_asset_host(target)
+  def fetch_asset_host
     get_config_env(target, "ASSET_HOST")
   end
 
   def print_output_progress(remote_targets, index = nil)
     index ||= remote_targets.length
     remainder = remote_targets.length - index
-    print "\routputting configs to tmp/config.*.txt: #{index}/#{remote_targets.count} ▕#{'██' * index}#{"  " * remainder}▏\r"
+    print "\routputting configs to tmp/config.*.txt: #{index}/#{remote_targets.count} ▕#{"██" * index}#{"  " * remainder}▏\r"
   end
 end

data/lib/heroku_tool/version.rb

@@ -1,3 +1,3 @@
 module HerokuTool
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/templates/heroku.thor

@@ -49,6 +49,14 @@ class Heroku
     # def after_deploying(instance, target, version)
     #   # override
     # end
+    #
+    # def before_deploying(instance, target, version)
+    #   # override
+    # end
+    #
+    # def after_deploying(instance, target, version)
+    #   # override
+    # end
   end
 
   module Configuration

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: heroku_tool
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Tim Diggins
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -86,24 +85,52 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 1.52.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
-description:
+        version: 1.52.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.81.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.81.7
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 email:
 - tim@fieldnotescommunities.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -111,14 +138,17 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/rspec
+- bin/rubocop
 - bin/setup
 - heroku_tool.gemspec
 - lib/heroku_tool.rb
+- lib/heroku_tool/commander.rb
+- lib/heroku_tool/configuration.rb
 - lib/heroku_tool/db_configuration.rb
 - lib/heroku_tool/heroku_targets.rb
 - lib/heroku_tool/tasks/db_drop_all_tables.rake
 - lib/heroku_tool/tasks/heroku.thor
-- lib/heroku_tool/thor_utils.rb
 - lib/heroku_tool/version.rb
 - templates/Rakefile
 - templates/heroku.thor
@@ -127,7 +157,6 @@ homepage: https://github.com/fieldnotescommunities/heroku_tool
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Tool for configurable one-shot deployment and db managment with heroku and
   rails

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.7
-before_install: gem install bundler -v 1.17.3

data/lib/heroku_tool/thor_utils.rb

@@ -1,37 +0,0 @@
-module HerokuTool
-  module ThorUtils
-    def puts_and_system(cmd)
-      puts cmd
-      puts "-------------"
-      system_with_clean_env cmd
-      puts "-------------"
-    end
-
-    protected
-
-    def puts_and_exec(cmd)
-      puts cmd
-      exec_with_clean_env(cmd)
-    end
-
-    def system_with_clean_env(cmd)
-      if defined?(Bundler) && Bundler.respond_to?(:with_unbundled_env)
-        Bundler.with_unbundled_env { system cmd }
-      elsif defined?(Bundler)
-        Bundler.with_clean_env { system cmd }
-      else
-        system cmd
-      end
-    end
-
-    def exec_with_clean_env(cmd)
-      if defined?(Bundler) && Bundler.respond_to?(:with_unbundled_env)
-        Bundler.with_unbundled_env { `#{cmd}` }
-      elsif defined?(Bundler)
-        Bundler.with_clean_env { `#{cmd}` }
-      else
-        `#{cmd}`
-      end
-    end
-  end
-end