sugarjar 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2abc9bd19f20ab7da08bb9617490eeeec7019367ecc869309122929005ddf40f
-  data.tar.gz: 010b62db181cf3b8e0c26cec49c0342107a2b0e18c151e66000a1c119332d7bd
+  metadata.gz: 2e9576a717ef65aa68a0a7f46e883245fc7e288a9884924658484f68e5d78470
+  data.tar.gz: 420299217d7e184c8129634351f5b9dc3ee336207d9c4a5ee3dd3d5ea64b0c31
 SHA512:
-  metadata.gz: b5ba7da0c8d3acacfe3f02dd479c77ab721fc3bc31cd70d0845ae3d0d9efe849de765d1d652ef3b70aa4f8643014837ab9d6361ad8231c7713e8ef10c07a3744
-  data.tar.gz: 6f34096847e760ab6cc346121bf3ee18b7b8490e458fefd9a68692b81e71ae0c8b3d2d84b39f2549efb18acbe033908f0dcf002b58ab2d6907455c9f102b125f
+  metadata.gz: 0d68dfb58e071f078ac63e3781db4dbea649a95ddbf0d9afce7b1361d74baa6ea0264df426260d3124f6a23a89cddeafc3efd83bc52670fb5210d388f2c28adb
+  data.tar.gz: c226c00b7332803a686d82cd2a916212f09c476c50afbe7ae7f0a95e510d59ba2ae2bd553fbaa0af3601f01e90ef5c63e6b56fde13b38ff180553a3c1f48e0a0

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'appbundler'
+gem 'sugarjar', :path => '.'
+
+group :test do
+  gem 'mdl'
+  gem 'rubocop'
+end

data/README.md

@@ -1,6 +1,7 @@
 # SugarJar
 
 ![CI](https://github.com/jaymzh/sugarjar/workflows/CI/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/sugarjar.svg)](https://badge.fury.io/rb/sugarjar)
 
 Welcome to SugarJar - a git/github helper. It leverages the amazing GitHub cli,
 [hub](https://hub.github.com/), so you'll need that installed.

data/bin/sj

@@ -0,0 +1,231 @@
+#!/usr/bin/env ruby
+# SugarJar
+
+require 'optparse'
+require 'mixlib/shellout'
+require_relative '../lib/sugarjar/commands'
+require_relative '../lib/sugarjar/config'
+require_relative '../lib/sugarjar/log'
+require_relative '../lib/sugarjar/util'
+require_relative '../lib/sugarjar/version'
+
+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 = {}
+# 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
+# itself
+if ENV['SUGARJAR_LOGLEVEL']
+  options['log_level'] = SugarJar::Log.level = ENV['SUGARJAR_LOGLEVEL'].to_sym
+end
+parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: sj <command> [<args>] [<options>]'
+
+  opts.separator ''
+  opts.separator 'Command, args, and options, can appear in any order.'
+  opts.separator ''
+  opts.separator 'OPTIONS:'
+
+  opts.on('--[no-]fallthru', 'Fall-thru to git') do |fallthru|
+    options['fallthru'] = fallthru
+  end
+
+  opts.on('--github-user USER', 'Github username') do |user|
+    options['github_user'] = user
+  end
+
+  opts.on(
+    '--github-host HOST',
+    'The host for "hub". Note that we will set this in the local repo ' +
+    'config so there is no need to have multiple config files for multiple ' +
+    'github servers. Put your default one in your config file, and simply ' +
+    'specify this option the first time you clone or touch a repo and it ' +
+    'will be part of that repo until changed.',
+  ) do |host|
+    options['github_host'] = host
+  end
+
+  opts.on('-h', '--help', 'Print this help message') do
+    puts 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('--version') do
+    puts SugarJar::VERSION
+    exit
+  end
+
+  # rubocop:disable Layout/HeredocIndentation
+  opts.separator <<COMMANDS
+
+COMMANDS:
+  amend
+              Amend the current commit. Alias for "git commit --amend".
+              Accepts other arguments such as "-a" or files.
+
+  amendq, qamend
+              Same as "amend" but without changing the message. Alias for
+              "git commit --amend --no-edit".
+
+  bclean
+              If safe, delete the current branch. Unlike "git branch -d",
+              bclean can handle squash-merged branches. Think of it as
+              a smarter "git branch -d".
+
+  bcleanall
+              Walk all branches, and try to delete them if it's safe. See
+              "bclean" for details.
+
+  binfo
+              Verbose information about the current branch.
+
+  br
+              Verbose branch list. An alias for "git branch -v".
+
+  feature
+              Create a "feature" branch. It's morally equivalent to
+              "git checkout -b" except it defaults to creating it based on
+              some form of 'master' instead of your current branch. In order
+              of preference it will be upstream/master, origin/master, master,
+              depending upon what remotes are available.
+
+  forcepush, fpush
+              The same as "smartpush", but uses "--force-with-lease". This is
+              a "safer" way of doing force-pushes and is the recommended way
+              to push after rebasing or amending. Never do this to shared
+              branches. Very convenient for keeping the branch behind a pull-
+              request clean.
+
+  lint
+              Run any linters configured in .sugarjar.yaml.
+
+  smartclone, sclone
+              A smart wrapper to "git clone" that handles forking and managing
+              remotes for you.
+              It will clone a git repository using hub-style short name
+              ("$org/$repo"). If the org of the repository is not the same
+              as your github-user then it will fork the repo for you to
+              your account (if not already done) and then setup your remotes
+              so that "origin" is your fork and "upstream" is the upstream.
+
+  smartpush, spush
+              A smart wrapper to "git push" that runs whatever is defined in
+              "on_push" in .sugarjar.yml, and only pushes if they succeed.
+
+  unit
+              Run any unitests configured in .sugarjar.yaml.
+
+  up
+              Rebase the current branch on upstream/master or origin/master.
+
+  upall
+              Same as "up", but for all branches.
+
+  verson
+              Print the version of sugarjar, and then run 'hub version'
+              to show the hub and git versions.
+COMMANDS
+
+  # rubocop:enable Layout/HeredocIndentation
+end
+
+# we make a copy of these because we will assign back to the ARGV
+# we parse later. We also need a pristine copy in case we want to
+# run git as we were called.
+argv_copy = ARGV.dup
+sj = SugarJar::Commands.new(options)
+extra_opts = []
+
+# as with above, this can't go into 'options', until after we parse
+# the command line args
+config = SugarJar::Config.config
+
+valid_commands = sj.public_methods - Object.public_methods
+
+is_valid_command = ARGV.any? { |arg| valid_commands.include?(arg.to_s.to_sym) }
+
+# if we're configured to fall thru and the subcommand isn't one
+# we recognize, don't parse the options as they may be different
+# than git's. For example `git config -l` - we error because we
+# require an arguement to `-l`.
+if config['fallthru'] && !is_valid_command
+  SugarJar::Log.debug(
+    'Skipping option parsing: fall-thru is set and we do not recognize ' +
+    'any subcommands',
+  )
+else
+  # We want to allow people to pass in extra args to be passed to
+  # git commands, but OptionParser doesn't easily allow this. So we
+  # loop over it, catching exceptions.
+  begin
+    # HOWEVER, anytime it throws an exception, for some reason, it clears
+    # out all of ARGV, or whatever you passed to as ARGV.
+    #
+    # This not only prevents further parsing, but also means we lose
+    # any non-option arguements (like the subcommand!)
+    #
+    # So we save a copy, and if we throw an exception, save the option that
+    # caused it, remove that option from our copy, and then re-populate argv
+    # with what's left.
+    #
+    # By doing this we not only get to parse all the options properly and
+    # save unknown ones, but non-option arguements, which OptionParser
+    # normally leaves in ARGV stay in ARGV.
+    saved_argv = argv_copy.dup
+    parser.parse!(argv_copy)
+  rescue OptionParser::InvalidOption => e
+    SugarJar::Log.debug("Saving unknown argument #{e.args}")
+    extra_opts += e.args
+
+    # e.args is an array, but it's only ever one arguement per exception
+    saved_argv.delete(e.args.first)
+    argv_copy = saved_argv.dup
+    SugarJar::Log.debug(
+      "Continuing option parsing with remaining ARGV: #{argv_copy}",
+    )
+    retry
+  end
+end
+
+if ARGV.empty?
+  puts parser
+  exit
+end
+
+options = config.merge(options)
+SugarJar::Log.level = options['log_level'].to_sym if options['log_level']
+
+subcommand = argv_copy.reject { |x| x.start_with?('-') }.first
+argv_copy.delete(subcommand)
+SugarJar::Log.debug("subcommand is #{subcommand}")
+
+# Extra options we got, plus any left over arguements are what we
+# pass to Commands so they can be passed to git as necessary
+extra_opts += argv_copy
+SugarJar::Log.debug("extra unknown options: #{extra_opts}")
+
+if subcommand == 'help'
+  puts parser
+  exit
+end
+
+if is_valid_command
+  SugarJar::Log.debug("running #{subcommand}, #{extra_opts.join(', ')}")
+  sj.send(subcommand.to_sym, *extra_opts)
+elsif options['fallthru']
+  SugarJar::Log.debug("Falling thru to: hub #{ARGV.join(' ')}")
+  exec('hub', *ARGV)
+else
+  SugarJar::Log.error("No such subcommand: #{subcommand}")
+end

data/lib/sugarjar/version.rb

@@ -1,3 +1,3 @@
 class SugarJar
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

data/sugarjar.gemspec

@@ -0,0 +1,21 @@
+require_relative 'lib/sugarjar/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sugarjar'
+  spec.version = SugarJar::VERSION
+  spec.summary = 'A git/github helper script'
+  spec.authors = ['Phil Dibowitz']
+  spec.email = ['phil@ipom.com']
+  spec.license = 'Apache-2.0'
+  spec.homepage = 'https://github.com/jaymzh/sugarjar'
+  docs = %w{README.md LICENSE Gemfile sugarjar.gemspec}
+  spec.extra_rdoc_files = docs
+  spec.executables << 'sj'
+  spec.files =
+    Dir.glob('lib/sugarjar/*.rb') +
+    Dir.glob('bin/*') +
+    docs
+
+  spec.add_dependency 'mixlib-log'
+  spec.add_dependency 'mixlib-shellout'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sugarjar
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-log
@@ -38,65 +38,29 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mdl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - phil@ipom.com
-executables: []
+executables:
+- sj
 extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE
+- Gemfile
+- sugarjar.gemspec
 files:
+- Gemfile
 - LICENSE
 - README.md
+- bin/sj
 - lib/sugarjar/commands.rb
 - lib/sugarjar/config.rb
 - lib/sugarjar/log.rb
 - lib/sugarjar/repoconfig.rb
 - lib/sugarjar/util.rb
 - lib/sugarjar/version.rb
+- sugarjar.gemspec
 homepage: https://github.com/jaymzh/sugarjar
 licenses:
 - Apache-2.0
@@ -116,8 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A git/github helper script