homebrew_automation 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7857fc3a55cf794b0138e422f94c7ca6d259ba9cca51df74c46a07c2986231bb
-  data.tar.gz: d2c5d3a431e0983dafbd8d3504bfea58b6e2c4673272260f18a69ffba8fe3d76
+  metadata.gz: a8f714b1824002b10ec76bb31f58b61e18a78c998d0464fef5a434516fbb3d2e
+  data.tar.gz: 221d5a56b7832045fc66b3eb173da08e62e18e94d55d83581e660b6e3a6cf18c
 SHA512:
-  metadata.gz: 8a6ee4421b0b4a460b6cd6fc818b1e72952fdd1e0d17522cb1ec0787d28e66b05dbfae92bd21638c68a7a1a2c305a4fe52c4ff2dec52a0e35883836311879371
-  data.tar.gz: e0c4ae780bc69a17951f9d248a0b29e99a03f06f2f2343332f11d5693d343ab182fd18549a3f8cf3dcfc3d99efb2a080efba81fb25ab10e0b0243874ccc3bac3
+  metadata.gz: 3dabc4291c10fd6810e6a36bcd1a8336e1e69ea10c8e6d2deb81f3c3afc353caa4e16d09f54fdbbeac6870c351093863190bdfbfc85aa6a4608e37abdecef0a9
+  data.tar.gz: da1f8b49b4b5d6e28acbfcbddc89aa10bf4223889378ab8158f73e4de653680d7f026622304577c98b0d63d43a7fd513132f04e63fbc9ac8afaab05864c1fbe3

data/lib/homebrew_automation/bottle.rb

@@ -9,6 +9,14 @@ module HomebrewAutomation
   class Bottle
 
     class Error < StandardError
+
+      attr_reader :original
+
+      def initialize(msg, original:)
+        @original = original
+        super(msg)
+      end
+
     end
 
     # @param tap_name [String] For use with +brew tap+
@@ -46,9 +54,8 @@ module HomebrewAutomation
     # @yieldparam contents [String] The data of the binary Bottle tarball, as if
     #   read via {File#read}
     # @return [NilClass]
-    # @raise [Error]
     def build!(&block)
-      raise Error, "Bottle#build! expects a block" unless block
+      raise StandardError, "Bottle#build! expects a block" unless block
       call_brew! do
         json_str = @bottle_finder.read_json!
         (minus_minus, filename) = parse_for_tarball_path(json_str)
@@ -91,21 +98,28 @@ module HomebrewAutomation
     # @return [Tuple<String, String>] +[minus_minus, filename]+
     def parse_for_tarball_path(json_str)
       begin
-        focus = JSON.parse(json_str)
+        json = JSON.parse(json_str)
+        focus = json
         [fully_qualified_formula_name, 'bottle', 'tags', @os_name].each do |key|
           focus = focus[key]
           if focus.nil?
-            raise BottleError.new "unexpected JSON structure, couldn't find key: #{key}"
+            raise Error.new(
+              "unexpected JSON structure, couldn't find key: #{key}",
+              original: json)
           end
         end
         # https://github.com/Homebrew/brew/pull/4612
         minus_minus, filename = focus['local_filename'], focus['filename']
         if minus_minus.nil? || filename.nil?
-          raise BottleError.new "unexpected JSON structure, couldn't find both `local_filename` and `filename` keys: #{minus_minus.inspect}, #{filename.inspect}"
+          raise Error.new(
+            "unexpected JSON structure, couldn't find both `local_filename` and `filename` keys: #{minus_minus.inspect}, #{filename.inspect}",
+            original: json)
         end
         [minus_minus, filename]
       rescue JSON::ParserError => e
-        raise BottleError.new "error parsing JSON: #{e}"
+        raise Error.new(
+          "error parsing JSON: #{e}",
+          original: json_str)
       end
     end
 

data/lib/homebrew_automation/brew.rb

@@ -7,6 +7,9 @@ module HomebrewAutomation
     class Error < StandardError
     end
 
+    class OlderVersionAlreadyInstalled < StandardError
+    end
+
     # +brew tap "$name" "$url"+
     #
     # @param name [String]
@@ -28,6 +31,8 @@ module HomebrewAutomation
     # @param fully_qualified_formula_name [String]
     def self.install!(opts, fully_qualified_formula_name)
       checked('brew', 'install', *opts, fully_qualified_formula_name)
+    rescue Error
+      raise OlderVersionAlreadyInstalled
     end
 
     # +brew bottle [opts] "$fully_qualified_formula_name"+
@@ -41,7 +46,7 @@ module HomebrewAutomation
     private_class_method def self.checked(*args)
       result = system(*args)
       unless result
-        raise BrewError.new("Command failed: #{args}")
+        raise Error.new(args.join(' '))
       end
       result
     end

data/lib/homebrew_automation/cli/workflow_commands.rb

@@ -35,6 +35,7 @@ class HomebrewAutomation::CLI::WorkflowCommands < Thor
       git,
       formula_name,
       bintray_version,
+      logger,
       keep_tap_repo: options[:keep_tap_repo],
       keep_homebrew_tmp: options[:keep_brew_tmp])
   end
@@ -71,7 +72,7 @@ class HomebrewAutomation::CLI::WorkflowCommands < Thor
   end
 
   def git
-    HomebrewAutomation::Git
+    HomebrewAutomation::Git.new
   end
 
   # DOC: default values here
@@ -98,4 +99,8 @@ class HomebrewAutomation::CLI::WorkflowCommands < Thor
     HomebrewAutomation::Workflow.new
   end
 
+  def logger
+    HomebrewAutomation::Logger.new
+  end
+
 end

data/lib/homebrew_automation/git.rb

@@ -9,106 +9,88 @@ module HomebrewAutomation
     class Error < StandardError
     end
 
-    class << self
-
-      # Set Git user's name and email
-      #
-      # Reads environment variables:
-      # - TRAVIS_GIT_USER_NAME
-      # - TRAVIS_GIT_USER_EMAIL
-      #
-      # If either env var is not set, do nothing.
-      #
-      # @return [NilClass]
-      def config!
-        name = ENV['TRAVIS_GIT_USER_NAME']
-        email = ENV['TRAVIS_GIT_USER_EMAIL']
-        if name && email
-          raise_unless 'git', 'config', '--global', 'user.name', name
-          raise_unless 'git', 'config', '--global', 'user.email', email
-        end
+    # Set Git user's name and email
+    #
+    # Reads environment variables:
+    # - TRAVIS_GIT_USER_NAME
+    # - TRAVIS_GIT_USER_EMAIL
+    #
+    # If either env var is not set, do nothing.
+    #
+    # @return [NilClass]
+    def config!
+      name = ENV['TRAVIS_GIT_USER_NAME']
+      email = ENV['TRAVIS_GIT_USER_EMAIL']
+      if name && email
+        raise_unless 'git', 'config', '--global', 'user.name', name
+        raise_unless 'git', 'config', '--global', 'user.email', email
       end
+    end
 
-      # Just +git clone+ the given URL
-      #
-      # @param url [String] git-friendly URL; could be filesystem path
-      # @param dir [String] optionally specify target dir name
-      # @return [NilClass]
-      def clone!(url, dir: nil)
-        if dir
-          raise_unless 'git', 'clone', url, dir
-        else
-          raise_unless 'git', 'clone', url
-        end
+    # Just +git clone+ the given URL
+    #
+    # @param url [String] git-friendly URL; could be filesystem path
+    # @param dir [String] optionally specify target dir name
+    # @return [NilClass]
+    def clone!(url, dir: nil)
+      if dir
+        raise_unless 'git', 'clone', url, dir
+      else
+        raise_unless 'git', 'clone', url
       end
+    end
 
-      # Like {#clone!} , but allows you to do something inside
-      # the newly cloned directory, pushd-style.
-      #
-      # @see clone!
-      # @param url [String]
-      # @param dir [String]
-      # @param keep_dir [Boolean]
-      # @yieldparam dir [String] name of freshly cloned dir
-      # @yieldreturn [a] anything
-      # @return [a]
-      def with_clone!(url, dir, keep_dir: false, &block)
-        begin
-          clone! url, dir: dir
-          if block
-            Dir.chdir dir do
-              block.call(File.realpath '.')
-            end
-          else
-            puts "Strange, you're calling Git#with_clone! without a block."
+    # Like {#clone!} , but allows you to do something inside
+    # the newly cloned directory, pushd-style.
+    #
+    # @see clone!
+    # @param url [String]
+    # @param dir [String]
+    # @param keep_dir [Boolean]
+    # @yieldparam dir [String] name of freshly cloned dir
+    # @yieldreturn [a] anything
+    # @return [a]
+    def with_clone!(url, dir, keep_dir: false, &block)
+      begin
+        clone! url, dir: dir
+        if block
+          Dir.chdir dir do
+            block.call(File.realpath '.')
           end
-          nil
-        ensure
-          FileUtils.remove_dir(dir) unless keep_dir
+        else
+          puts "Strange, you're calling Git#with_clone! without a block."
         end
+        nil
+      ensure
+        FileUtils.remove_dir(dir) unless keep_dir
       end
+    end
 
-      # +git commit --allow-empty -am "$msg"+
-      #
-      # @param msg [String] Git commit message
-      # @return [NilClass]
-      def commit_am!(msg)
-        raise_unless 'git', 'commit', '--allow-empty', '-am', msg
-      end
-
-      # Just +git push+
-      #
-      # @return [NilClass]
-      def push!
-        raise_unless 'git', 'push'
-      end
+    # +git commit --allow-empty -am "$msg"+
+    #
+    # @param msg [String] Git commit message
+    # @return [NilClass]
+    def commit_am!(msg)
+      raise_unless 'git', 'commit', '--allow-empty', '-am', msg
+    end
 
-      private
+    # Just +git push+
+    #
+    # @return [NilClass]
+    def push!
+      raise_unless 'git', 'push'
+    end
 
-      def raise_unless(*args)
-        begin
-          result = system(*args)
-          unless result
-            raise Error, "Git command failed: #{args}"
-          end
-          result
-        end
-      end
+    private
 
-      # Impure
-      def complain_unless(*args)
+    def raise_unless(*args)
+      begin
         result = system(*args)
         unless result
-          puts "Git command errored: #{args}"
-          puts caller
+          raise Error, args.join(' ')
         end
         result
       end
-
-      def silently(*args)
-        system(*args)
-      end
-
     end
 
   end

data/lib/homebrew_automation/logger.rb

@@ -0,0 +1,38 @@
+
+require 'time'
+
+module HomebrewAutomation
+
+  # Help you see which parts of STDOUT came from HomebrewAutomation
+  class Logger
+
+    def info!(msg)
+      puts(bold(green("homebrew_automation.rb [info] (#{DateTime.now}): ")) + msg)
+    end
+
+    def error!(msg)
+      puts(red("homebrew_automation.rb [error] (#{DateTime.now}): ") + msg)
+    end
+
+    private
+
+    # https://stackoverflow.com/questions/1489183/colorized-ruby-output
+    def coloured(colour, msg)
+      "\e[#{colour}m#{msg}\e[0m"
+    end
+
+    def green(x)
+      coloured(32, x)
+    end
+
+    def red(x)
+      coloured(31, x)
+    end
+
+    def bold(x)
+      "\e[1m#{x}\e[22m"
+    end
+
+  end
+
+end

data/lib/homebrew_automation/version.rb

@@ -2,6 +2,6 @@
 module HomebrewAutomation
 
   # Yep.
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 
 end

data/lib/homebrew_automation/workflow.rb

@@ -17,6 +17,7 @@ module HomebrewAutomation
     # @param tap [Tap]
     # @param formula_name [String] the name of the formula in the Tap
     # @param bversion [Bintray::Version]
+    # @param logger [HomebrewAutomation::Logger]
     #
     # @param mac_os [Class] the MacOS class
     # @param bottle [Class] the Bottle class
@@ -29,16 +30,25 @@ module HomebrewAutomation
         git,
         formula_name,
         bversion,
+        logger,
         mac_os: MacOS,
         bottle: Bottle,
         keep_tap_repo: false,
         keep_homebrew_tmp: false)
+      logger.info!(
+        "Hello, this is HomebrewAutomation! I will now build your Formula and upload the " \
+        "bottles to Bintray.")
       os_name = mac_os.identify_version!
+      logger.info!("First let's clone your Tap repo to see the Formula.")
       git.with_clone!(tap.url, tap.repo, keep_dir: keep_tap_repo) do |cloned_dir|
         tap.on_formula! formula_name do |formula|
           formula.put_sdist(sdist.url, sdist.sha256)
         end
         git.commit_am! "Throwaway commit; just for building bottles"
+        logger.info!(
+          "I've updated the Formula file in our local Tap clone, and we're ready "\
+          "to start building the Bottle. This could take a long time if your Formula "\
+          "is slow to compile.")
         bot = bottle.new(
           'homebrew-automation/tmp-tap',
           cloned_dir,
@@ -49,14 +59,40 @@ module HomebrewAutomation
           # Bintray auto-creates Versions on file-upload.
           # Re-creating an existing Version results in a 409.
           #bversion.create!
+          logger.info!("Bottle built! Let me now upload the Bottle tarball to Bintray.")
           begin
             bversion.upload_file!(filename, contents)
           rescue Bintray::Version::FileAlreadyExists
-            puts "A file with the same name as the one you're uploading already exits on Bintray"
+            logger.info!("A file with the same name as the one we're uploading already exits on Bintray.")
           end
         end
         bot
       end
+      logger.info!("All done!")
+    rescue HomebrewAutomation::Bottle::Error => e
+      logger.error!([
+        "Something went wrong in a Bottle: " + e.message,
+        "Original JSON:",
+        e.original,
+        "Backtrace:",
+        e.backtrace.join("\n")
+      ].join("\n"))
+    rescue HomebrewAutomation::Bottle::OlderVersionAlreadyInstalled => e
+      logger.error!([
+        "An older version of the Formula is already installed on your system. " \
+        "Please either manually uninstall or upgrade it, then try again.",
+        e.to_s,
+        "Caused by: #{e.cause}",
+        (e.cause ? e.cause.backtrace.join("\n") : '')
+      ].join("\n"))
+    rescue HomebrewAutomation::Brew::Error => e
+      logger.error!(
+        "Something went wrong in this Homebrew command: " +
+        e.message + "\n" + e.backtrace.join("\n"))
+    rescue HomebrewAutomation::Git::Error => e
+      logger.error!(
+        "Something went wrong in this Git command: " +
+        e.message + "\n" + e.backtrace.join("\n"))
     end
 
     # Gather and publish bottles.
@@ -70,10 +106,19 @@ module HomebrewAutomation
     # @param tap [Tap]
     # @param formula_name [String] the name of the formula in the Tap
     # @param bversion [Bintray::Version]
+    # @param logger [HomebrewAutomation::Logger]
     # @return [NilClass]
-    def gather_and_publish_bottles!(sdist, tap, formula_name, bversion)
+    def gather_and_publish_bottles!(sdist, tap, formula_name, bversion, logger)
+      logger.info!(
+        "Hello, this is HomebrewAutomation! I will browse through your Bintray to " \
+        "see if there may be Bottles built earlier for your Formula, and update your " \
+        "Tap to refer to them.")
+      logger.info!(
+        "I will also update the source tarball of your Formula in your Tap, " \
+        "effectively releasing a new version of your Formula.")
       git.with_clone!(tap.url, tap.repo) do
         tap.on_formula! formula_name do |formula|
+          logger.info!("Let's see if any files on your Bintray look like Bottles.")
           bottles = bversion.gather_bottles
           bottles.reduce(
             formula.
@@ -85,9 +130,10 @@ module HomebrewAutomation
         end
         git.config!
         git.commit_am! "Add bottles for #{formula_name}@#{bversion.version_name}"
+        logger.info!("I've refered to the Bottles I found in this new commit. Let's push to your Tap!")
         git.push!
       end
-      nil
+      logger.info!("All done!")
     end
 
   end

data/lib/homebrew_automation.rb

@@ -5,6 +5,7 @@ require_relative 'homebrew_automation/bintray.rb'
 require_relative 'homebrew_automation/bottle.rb'
 require_relative 'homebrew_automation/formula.rb'
 require_relative 'homebrew_automation/git.rb'
+require_relative 'homebrew_automation/logger.rb'
 require_relative 'homebrew_automation/mac_os.rb'
 require_relative 'homebrew_automation/source_dist.rb'
 require_relative 'homebrew_automation/tap.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: homebrew_automation
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - easoncxz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2019-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -156,6 +156,7 @@ files:
 - lib/homebrew_automation/cli/workflow_commands.rb
 - lib/homebrew_automation/formula.rb
 - lib/homebrew_automation/git.rb
+- lib/homebrew_automation/logger.rb
 - lib/homebrew_automation/mac_os.rb
 - lib/homebrew_automation/source_dist.rb
 - lib/homebrew_automation/tap.rb