sugarjar 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fefe2bc9c94d95d3c869f8636bbabf433ec6196ae8d68b7ac131b4a955a882b
-  data.tar.gz: 5237f94836f686a0e82a8a18543b54179e7190ce874d481e59ae5fe685aa26d9
+  metadata.gz: 56cbf17ade9b12f891a658d7224a4571890da6517d9ea77a6f3688b4ff593261
+  data.tar.gz: c0c51ce8312f592cc8fd0fe273c563c2c7d3b2e033776ba64d267767755bd720
 SHA512:
-  metadata.gz: d8ade9a12c3ba79a5ba591123179a80aeff6db7cbd4ab48c42cc27ecd5f5f4c3bcd713b99a04654b7c28e4fca715c3f6535f9938a97f3c55fc41169791f8d6a6
-  data.tar.gz: cbe9733235652a2ee5d777e53eed4a0f7deb9ffdcb69b0825b89c7831c52e5317e1e854b61e038d1a27fd92c85326e560c287e9e162d3068abcd246bc0e9ee48
+  metadata.gz: 3d49efb6124a04112ab8bd80b145a2459bdeb56f79c468524e0c89bbc9ef183dfce001fe199b8274562083b338aa2d81073e818676cd6fb9a43250c7be80c736
+  data.tar.gz: 0acc7fb90fed326a8976a1f029e3f5a9720259c855df686e8fb52aa70f8dc009f500f1bb36ef1c5957b7291b5d36cd3e4e59e902582fc23ed66409a58f73869a

data/README.md

@@ -1,6 +1,7 @@
 # SugarJar
 
 [![Lint](https://github.com/jaymzh/sugarjar/workflows/Lint/badge.svg)](https://github.com/jaymzh/sugarjar/actions?query=workflow%3ALint)
+[![Unittest](https://github.com/jaymzh/sugarjar/workflows/Unittests/badge.svg)](https://github.com/jaymzh/sugarjar/actions?query=workflow%3AUnittests)
 [![DCO](https://github.com/jaymzh/sugarjar/workflows/DCO%20Check/badge.svg)](https://github.com/jaymzh/sugarjar/actions?query=workflow%3A%22DCO+Check%22)
 [![Gem Version](https://badge.fury.io/rb/sugarjar.svg)](https://badge.fury.io/rb/sugarjar)
 
@@ -8,7 +9,7 @@ Welcome to SugarJar - a git/github helper. It leverages the amazing GitHub cli,
 [hub](https://hub.github.com/), so you'll need that installed.
 
 SugarJar is inspired by [arcanist](https://github.com/phacility/arcanist), and
-it's replacement at Facebook, JellyFish. Many of the features they provide for
+its replacement at Facebook, JellyFish. Many of the features they provide for
 the Phabricator workflow this aims to bring to the GitHub workflow.
 
 In particular there are a lot of helpers for using a squash-merge workflow that
@@ -27,7 +28,7 @@ doesn't work. Git will tell you the branch isn't fully merged. You can, of
 course `git branch -D <branch>`, but that does no safety checks at all, it
 forces the deletion.
 
-Enter `sj bclean` - it determines of the contents of your branch has been merge
+Enter `sj bclean` - it determines if the contents of your branch has been merge
 and safely deletes if so.
 
 ``` shell
@@ -119,7 +120,7 @@ small lint issue? Not anymore! SJ can be configured to run things before
 pushing. For example,in the SugarJar repo, we have it run Rubocop (ruby lint)
 and Markdownlint "on_push". If those fail, it lets you know and doesn't push.
 
-You can configure SugarJar to tell how how to run both lints and unittests for
+You can configure SugarJar to tell it how to run both lints and unittests for
 a given repo and if one or both should be run prior to pushing.
 
 The details on the config file format is below, but we provide three commands:

data/bin/sj

@@ -13,7 +13,7 @@ SugarJar::Log.level = Logger::INFO
 
 # Don't put defaults here, put them in SugarJar::Config - otherwise
 # these defaults overwrite whatever is in config files.
-options = {}
+options = { 'color' => true }
 # If ENV['SUGARJAR_DEBUG'] is set, it overrides the config file,
 # but not the command line options, so set that one here. Also
 # start the logger at that level, in case we are debugging option loading
@@ -53,14 +53,6 @@ parser = OptionParser.new do |opts|
     exit
   end
 
-  opts.on(
-    '--log-level LEVEL',
-    'Set logging level (fatal, error, warning, info, debug, trace). Default: ' +
-    'info',
-  ) do |level|
-    options['log_level'] = level
-  end
-
   opts.on(
     '--ignore-dirty',
     'Tell command that check for a dirty repo to carry on anyway.',
@@ -75,6 +67,18 @@ parser = OptionParser.new do |opts|
     options['ignore_prerun_failure'] = true
   end
 
+  opts.on(
+    '--log-level LEVEL',
+    'Set logging level (fatal, error, warning, info, debug, trace). Default: ' +
+    'info',
+  ) do |level|
+    options['log_level'] = level
+  end
+
+  opts.on('--[no-]use-color', 'Enable color. [default: true]') do |color|
+    options['color'] = color
+  end
+
   opts.on('--version') do
     puts SugarJar::VERSION
     exit
@@ -133,6 +137,11 @@ COMMANDS:
               your account (if not already done) and then setup your remotes
               so that "origin" is your fork and "upstream" is the upstream.
 
+  smartlog, sl
+              Inspired by Facebook's "sl" extension to Mercurial, this command
+              will show you a tree of all your local branches relative to your
+              upstream.
+
   smartpullrequest, smartpr, spr
               A smart wrapper to "hub pull-request" that checks if your repo
               is dirty before creating the pull request.

data/lib/sugarjar/commands.rb

@@ -19,6 +19,7 @@ class SugarJar
       @ignore_dirty = options['ignore_dirty']
       @ignore_prerun_failure = options['ignore_prerun_failure']
       @repo_config = SugarJar::RepoConfig.config
+      @color = options['color']
       return if options['no_change']
 
       set_hub_host if @ghhost
@@ -33,36 +34,43 @@ class SugarJar
       base_pieces = base.split('/')
       hub('fetch', base_pieces[0]) if base_pieces.length > 1
       hub('checkout', '-b', name, base)
-      SugarJar::Log.info("Created feature branch #{name} based on #{base}")
+      SugarJar::Log.info(
+        "Created feature branch #{color(name, :green)} based on " +
+        color(base, :green),
+      )
     end
 
     def bclean(name = nil)
       assert_in_repo
       name ||= current_branch
-      # rubocop:disable Style/GuardClause
-      unless clean_branch(name)
+      if clean_branch(name)
+        SugarJar::Log.info("#{name}: #{color('reaped', :green)}")
+      else
         die(
-          "Cannot clean #{name} - there are unmerged commits; use " +
-          "'git branch -D #{name}' to forcefully delete it.",
+          "#{color("Cannot clean #{name}", :red)}! there are unmerged " +
+          "commits; use 'git branch -D #{name}' to forcefully delete it.",
         )
       end
-      # rubocop:enable Style/GuardClause
     end
 
     def bcleanall
       assert_in_repo
       curr = current_branch
       all_branches.each do |branch|
-        next if branch == 'master'
+        if branch == 'master'
+          SugarJar::Log.debug('Skipping master')
+          next
+        end
 
-        # rubocop:disable Style/Next
-        unless clean_branch(branch)
-          SugarJar::Log.info(
-            "Skipping branch #{branch} - there are unmerged commits; use " +
-            "'git branch -D #{branch}' to forcefully delete it.",
+        if clean_branch(branch)
+          SugarJar::Log.info("#{branch}: #{color('reaped', :green)}")
+        else
+          SugarJar::Log.info("#{branch}: skipped")
+          SugarJar::Log.debug(
+            "There are unmerged commits; use 'git branch -D #{branch}' to " +
+            'forcefully delete it)',
           )
         end
-        # rubocop:enable Style/Next
       end
 
       # Return to the branch we were on, or master
@@ -75,12 +83,13 @@ class SugarJar
 
     def co(*args)
       assert_in_repo
-      hub('checkout', *args)
+      s = hub('checkout', *args)
+      SugarJar::Log.info(s.stderr + s.stdout.chomp)
     end
 
     def br
       assert_in_repo
-      puts hub('branch', '-v').stdout
+      SugarJar::Log.info(hub('branch', '-v').stdout.chomp)
     end
 
     def binfo
@@ -88,16 +97,29 @@ class SugarJar
       SugarJar::Log.info(hub(
         'log', '--graph', '--oneline', '--decorate', '--boundary',
         "#{tracked_branch}.."
-      ).stdout)
+      ).stdout.chomp)
     end
 
+    # binfo for all branches
+    def smartlog
+      assert_in_repo
+      SugarJar::Log.info(hub(
+        'log', '--graph', '--oneline', '--decorate', '--boundary',
+        '--branches', "#{most_master}.."
+      ).stdout.chomp)
+    end
+
+    alias sl smartlog
+
     def up
       assert_in_repo
       result = gitup
       if result
-        SugarJar::Log.info("Rebased branch on #{result}")
+        SugarJar::Log.info(
+          "#{color(current_branch, :green)} rebased on #{result}",
+        )
       else
-        die('Failed to rebase current branch')
+        die("#{color(current_branch, :red)}: Failed to rebase")
       end
     end
 
@@ -122,11 +144,13 @@ class SugarJar
         hub('checkout', branch)
         result = gitup
         if result
-          SugarJar::Log.info("Rebased #{branch} on #{result}")
+          SugarJar::Log.info(
+            "#{color(branch, :green)} rebased on #{color(result, :green)}",
+          )
         else
           SugarJar::Log.error(
-            "Failed to rebase #{branch}, aborting that and moving to next " +
-            'branch',
+            "#{color(branch, :red)} failed rebase. Reverting attempt and " +
+            'moving to next branch',
           )
           hub('rebase', '--abort')
         end
@@ -352,18 +376,23 @@ class SugarJar
       end
       Dir.chdir repo_root do
         @repo_config[type].each do |check|
-          SugarJar::Log.info("Running #{type} #{check}")
+          SugarJar::Log.debug("Running #{type} #{check}")
 
-          unless File.exist?(check)
+          unless File.exist?(check.split.first)
             SugarJar::Log.error("Configured #{type} #{check} does not exist!")
             return false
           end
           s = Mixlib::ShellOut.new(check).run_command
-          next unless s.error?
+          unless s.error?
+            SugarJar::Log.info(
+              "[#{type}] #{check}: #{color('OK', :green)}",
+            )
+            next
+          end
 
           SugarJar::Log.info(
-            "#{type} #{check} failed, output follows (use debug for more)\n" +
-            s.stdout.to_s,
+            "[#{type}] #{check} #{color('failed', :red)}, output follows " +
+            "(see debug for more)\n#{s.stdout}",
           )
           SugarJar::Log.debug(s.format_for_exception)
           return false
@@ -375,7 +404,7 @@ class SugarJar
       @repo_config['on_push']&.each do |item|
         SugarJar::Log.debug("Running on_push check type #{item}")
         unless send(:run_check, item)
-          SugarJar::Log.info("Push check #{item} failed.")
+          SugarJar::Log.info("[prepush]: #{item} #{color('failed', :red)}.")
           return false
         end
       end
@@ -401,7 +430,6 @@ class SugarJar
       hub('checkout', 'master')
       hub('branch', '-D', name)
       gitup
-      SugarJar::Log.info("Reaped branch #{name}")
       true
     end
 
@@ -442,7 +470,7 @@ class SugarJar
       s = hub_nofail('merge', '--squash', branch)
       if s.error?
         cleanup_tmp_branch(tmpbranch, branch)
-        SugarJar::Log.error(
+        SugarJar::Log.debug(
           'Failed to merge changes into current master. This means we could ' +
           'not figure out if this is merged or not. Check manually and use ' +
           "'git branch -D #{branch}' if it is safe to do so.",
@@ -541,5 +569,20 @@ class SugarJar
       end
       @remote
     end
+
+    def color(string, *colors)
+      if @color
+        pastel.decorate(string, *colors)
+      else
+        string
+      end
+    end
+
+    def pastel
+      @pastel ||= begin
+        require 'pastel'
+        Pastel.new
+      end
+    end
   end
 end

data/lib/sugarjar/util.rb

@@ -27,6 +27,10 @@ class SugarJar
     end
 
     def hub_nofail(*args)
+      if %w{diff log grep branch}.include?(args[0]) &&
+         args.none? { |x| x.include?('color') }
+        args << (@color ? '--color' : '--no-color')
+      end
       SugarJar::Log.trace("Running: hub #{args.join(' ')}")
       s = Mixlib::ShellOut.new([which('hub')] + args).run_command
       if s.error?

data/lib/sugarjar/version.rb

@@ -1,3 +1,3 @@
 class SugarJar
-  VERSION = '0.0.7'.freeze
+  VERSION = '0.0.8'.freeze
 end

data/sugarjar.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'mixlib-log'
   spec.add_dependency 'mixlib-shellout'
+  spec.add_dependency 'pastel'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - phil@ipom.com