discharger 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d85acb3df98a5ced5599847e46e71ae447a884099366570e194aed83207b1667
-  data.tar.gz: 4d65fedb9d04a8dae89e2e13cbbc779720098052a0f6c7f5a59583992f498b88
+  metadata.gz: 124d11a54d0e01902289ad669c58ffff0a0f2d3440cd92ac2775ee7958b04b92
+  data.tar.gz: 43016830306332f19aada077073497b8dd8227e9ebcc5de69d3bf53cd86dae8c
 SHA512:
-  metadata.gz: 946a7e62f479869ca557183920392bc843fca20236a2e43ed85c1f37541dc0fb2fb5d2bd3cf19c246f3259503a87e0982d8cbe6bd6ffe4d091efb74139c861e3
-  data.tar.gz: fb8c3ffa1d3d69da351e5564fe0e14f32290aa2676238b062cab6dc689786fccbcbb9fefddb5384a9931f532dadd853967ae3378680b14d53bd1eb32851f850b
+  metadata.gz: d64755635d36299678b677de387c2a367a31776cd6d81fd9002e8fc3eb84826ace926d60b9d59ef2516034478737cd0105aa3d177f1083bc875031ea610b82b5
+  data.tar.gz: c4011249e3c1ae3763479b0a8bc267ef1a7ec709315f2c0866a1c4511cc9d5697d5b59cbad7ce74adae5e5b6974b6646898f36d677347d2b91adbcec27bb5ed6

data/README.md

@@ -43,6 +43,11 @@ And then execute:
 $ bundle
 ```
 
+Then run the install generator:
+```bash
+$ rails generate discharger:install
+```
+
 Or install it yourself as:
 ```bash
 $ gem install discharger

data/Rakefile

@@ -1,8 +1,7 @@
 require "bundler/setup"
 
 require "bundler/gem_tasks"
-
-task default: :test
+require "rake/testtask"
 
 require "reissue/gem"
 
@@ -10,3 +9,11 @@ Reissue::Task.create :reissue do |task|
   task.version_file = "lib/discharger/version.rb"
   task.commit = true
 end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/discharger/railtie.rb

@@ -1,8 +1,8 @@
 module Discharger
   class Railtie < ::Rails::Railtie
-    config.before_configuration do
-      if ENV["SLACK_API_TOKEN_RELEASES"].nil?
-        raise "SLACK_API_TOKEN_RELEASES must be set in the environment"
+    config.after_initialize do |app|
+      if Rails.env.development? && Discharger.slack_token.nil?
+        warn "Your application Discharger.slack_token must be set."
       end
     end
   end

data/lib/discharger/task.rb

@@ -5,8 +5,8 @@ using Rainbow
 
 module Discharger
   class Task < Rake::TaskLib
-    def self.create(name = :release, &block)
-      task = new(name)
+    def self.create(name = :release, tasker: Rake::Task, &block)
+      task = new(name, tasker:)
       task.instance_eval(&block) if block
       Reissue::Task.create do |reissue|
         reissue.version_file = task.version_file
@@ -46,13 +46,15 @@ module Discharger
     attr_accessor :commit
     attr_accessor :commit_finalize
 
-    def initialize(name = :release)
+    def initialize(name = :release, tasker: Rake::Task)
       @name = name
+      @tasker = tasker
       @working_branch = "develop"
       @staging_branch = "stage"
       @production_branch = "main"
       @description = "Release the current version to #{staging_branch}"
     end
+    private attr_reader :tasker
 
     # Run a multiple system commands and return true if all commands succeed
     # If any command fails, the method will return false and stop executing
@@ -71,18 +73,19 @@ module Discharger
     #     ["echo", "Hello, World!"],
     #     ["ls", "-l"]
     #   )
-    def syscall(*steps)
+    def syscall(*steps, output: $stdout, error: $stderr)
       success = false
       stdout, stderr, status = nil
-      steps.each do |*cmd|
+      steps.each do |cmd|
         puts cmd.join(" ").bg(:green).black
         stdout, stderr, status = Open3.capture3(*cmd)
         if status.success?
-          puts stdout
+          output.puts stdout
+          success = true
         else
-          puts stderr
+          error.puts stderr
           success = false
-          abort(stderr)
+          exit(status.exitstatus)
         end
       end
       if block_given?
@@ -100,8 +103,8 @@ module Discharger
     #
     # @param message [String] the message to echo
     # return [TrueClass]
-    def sysecho(message)
-      system "echo", message
+    def sysecho(message, output: $stdout)
+      output.puts message
       true
     end
 
@@ -134,17 +137,18 @@ module Discharger
         exit if input.chomp.match?(/^x/i)
 
         continue = syscall(
-          "git checkout #{working_branch}",
-          "git branch -D #{staging_branch} 2> /dev/null || true",
-          "git branch -D #{production_branch} 2> /dev/null || true",
-          "git fetch origin #{staging_branch}:#{staging_branch} #{production_branch}:#{production_branch}",
-          "git checkout #{production_branch}",
-          "git rebase #{staging_branch}",
-          "git tag -a v#{current_version} -m 'Release #{current_version}'",
-          "git push origin #{production_branch}; git push origin v#{current_version}"
+          ["git", "checkout", working_branch],
+          ["git", "branch", "-D #{staging_branch}", "2>/dev/null || true"],
+          ["git", "branch", "-D #{production_branch}", "2>/dev/null || true"],
+          ["git", "fetch", "origin", "#{staging_branch}:#{staging_branch}", "#{production_branch}:#{production_branch}"],
+          ["git", "checkout", production_branch],
+          ["git", "rebase", staging_branch],
+          ["git", "tag", "-a v#{current_version}", "-m 'Release #{current_version}'"],
+          ["git", "push", "origin", "#{production_branch}:#{production_branch}", "v#{current_version}:v#{current_version}"],
+          ["git", "push", "origin", "v#{current_version}"]
         ) do
-          Rake::Task["#{name}:slack"].invoke("Released #{Qualify.name} #{current_version} to production.", release_message_channel, ":chipmunk:")
-          syscall "git checkout #{working_branch}"
+          tasker["#{name}:slack"].invoke("Released #{Qualify.name} #{current_version} to production.", release_message_channel, ":chipmunk:")
+          syscall ["git", "checkout", working_branch]
         end
 
         abort "Release failed." unless continue
@@ -156,17 +160,16 @@ module Discharger
 
         MSG
 
-        new_version_branch = "bump/begin-#{current_version.tr(".", "-")}"
-
-        continue = syscall("git checkout -b #{new_version_branch}") do
-          Rake::Task["reissue"].invoke
-        end
+        tasker["reissue"].invoke
+        new_version = Object.const_get(version_constant)
+        new_version_branch = "bump/begin-#{new_version.tr(".", "-")}"
+        continue = syscall(["git", "checkout", "-b #{new_version_branch}"])
 
         abort "Bump failed." unless continue
 
         pr_url = "#{pull_request_url}/compare/#{working_branch}...#{new_version_branch}?expand=1&title=Begin%20#{current_version}"
 
-        syscall("git push origin #{new_version_branch} --force") do
+        syscall(["git", "push", "origin", new_version_branch, "--force"]) do
           sysecho <<~MSG
             Branch #{new_version_branch} created.
 
@@ -176,7 +179,7 @@ module Discharger
             Opening PR: #{pr_url}
           MSG
         end.then do |success|
-          syscall "open #{pr_url}" if success
+          syscall ["open", pr_url] if success
         end
       end
 
@@ -184,14 +187,14 @@ module Discharger
         desc description
         task build: :environment do
           syscall(
-            "git fetch origin #{working_branch}",
-            "git checkout #{working_branch}",
-            "git branch -D #{staging_branch} 2> /dev/null || true",
-            "git checkout -b #{staging_branch}",
-            "git push origin #{staging_branch} --force"
+            ["git", "fetch", "origin", working_branch],
+            ["git", "checkout", working_branch],
+            ["git", "branch", "-D #{staging_branch}", "2> /dev/null || true"],
+            ["git", "checkout", "-b #{staging_branch}"],
+            ["git", "push", "origin", staging_branch, "--force"]
           ) do
-            Rake::Task["#{name}:slack"].invoke("Building #{app_name} #{commit_identifier.call} on #{staging_branch}.", release_message_channel)
-            syscall "git checkout #{working_branch}"
+            tasker["#{name}:slack"].invoke("Building #{app_name} #{commit_identifier.call} on #{staging_branch}.", release_message_channel)
+            syscall ["git", "checkout", working_branch]
           end
         end
 
@@ -225,9 +228,9 @@ module Discharger
           current_version = Object.const_get(version_constant)
           finish_branch = "bump/finish-#{current_version.tr(".", "-")}"
 
-          syscall "git fetch origin #{working_branch}",
-            "git checkout #{working_branch}",
-            "git checkout -b #{finish_branch}"
+          syscall ["git", "fetch origin #{working_branch}"],
+            ["git", "checkout", working_branch],
+            ["git", "checkout", "-b #{finish_branch}"]
 
           sysecho <<~MSG
             Branch #{finish_branch} created.
@@ -241,7 +244,7 @@ module Discharger
           input = $stdin.gets
           exit if input.chomp.match?(/^x/i)
 
-          Rake::Task["reissue:finalize"].invoke
+          tasker["reissue:finalize"].invoke
 
           params = {
             expand: 1,
@@ -253,7 +256,7 @@ module Discharger
 
           pr_url = "#{pull_request_url}/compare/#{finish_branch}?#{params.to_query}"
 
-          continue = syscall "git push origin #{finish_branch} --force" do
+          continue = syscall ["git", "push", "origin", finish_branch, "--force"] do
             sysecho <<~MSG
               Branch #{finish_branch} created.
               Open a PR to #{working_branch} to finalize the release.
@@ -266,8 +269,8 @@ module Discharger
             MSG
           end
           if continue
-            syscall "git checkout #{working_branch}",
-              "open #{pr_url}"
+            syscall ["git", "checkout", working_branch],
+              ["open", pr_url]
           end
         end
 
@@ -282,7 +285,7 @@ module Discharger
               bin/rails #{name}:build
         DESC
         task stage: [:environment] do
-          Rake::Task["build"].invoke
+          tasker["build"].invoke
           current_version = Object.const_get(version_constant)
 
           params = {
@@ -303,7 +306,7 @@ module Discharger
 
             Once the PR is **approved**, run 'rake release' to release the version.
           MSG
-          syscall "open #{pr_url}"
+          syscall ["open", pr_url]
         end
       end
     end

data/lib/discharger/version.rb

@@ -1,3 +1,3 @@
 module Discharger
-  VERSION = "0.1.4"
+  VERSION = "0.2.1"
 end

data/lib/discharger.rb

@@ -2,4 +2,11 @@ require "discharger/version"
 require "discharger/railtie"
 
 module Discharger
+  class << self
+    attr_accessor :slack_token
+
+    def configure
+      yield self
+    end
+  end
 end

data/lib/generators/discharger/install/install_generator.rb

@@ -0,0 +1,11 @@
+module Discharger
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "discharger_initializer.rb", "config/initializers/discharger.rb"
+      end
+    end
+  end
+end

data/lib/generators/discharger/install/templates/discharger_initializer.rb

@@ -0,0 +1,6 @@
+if defined?(Discharger)
+  Discharger.configure do |config|
+    # Configure your Discharger settings here
+    # config.slack_token = 'your_slack_token'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discharger
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.1
 platform: ruby
 authors:
 - Jim Gay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open3
@@ -94,6 +94,8 @@ files:
 - lib/discharger/railtie.rb
 - lib/discharger/task.rb
 - lib/discharger/version.rb
+- lib/generators/discharger/install/install_generator.rb
+- lib/generators/discharger/install/templates/discharger_initializer.rb
 homepage: https://github.com/SOFware/discharger
 licenses: []
 metadata: