branchtree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 983ddedd92a152d2f1e8d0e155b0f561fbcb3fb80e07be7f70770c28dbf6261e
+  data.tar.gz: c06bf9c9da1ccf20979d685fe628f309f73a3153516cd4c95ad11ad97ccd20ed
+SHA512:
+  metadata.gz: 84e2dfe9e7ff0a3fe2b235b71212e4101185a2f8131d11331d6c2c320e9d852ce123317817a439cad5c424ed7439e9fb5865c21adcf24a6c2b2b30e5ef63b651
+  data.tar.gz: '069544c6e2f98eda7c998fe7fc622725f13dcc5e172f1c375182327005fae4851c2f598a6078023bcb7da20d30a9ba6bf9b70e5ab2cea874ca02de458f989ba7'

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at smashwilson@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in branchtree.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    branchtree (0.1.0)
+      tty-command (~> 0.10.0)
+      tty-logger (~> 0.6.0)
+      tty-option (~> 0.1.0)
+      tty-prompt (~> 0.23.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    tty-color (0.6.0)
+    tty-command (0.10.1)
+      pastel (~> 0.8)
+    tty-cursor (0.7.1)
+    tty-logger (0.6.0)
+      pastel (~> 0.8)
+    tty-option (0.1.0)
+    tty-prompt (0.23.0)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  branchtree!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ash Wilson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Branchtree
+
+Command-line tool to interactively manage chains or trees of dependent branches in a git repository.
+
+## Installation
+
+Install the gem from Rubygems:
+
+    $ gem install branchtree
+
+## Usage
+
+Configure your desired branch topology by creating a file called `branchtree-map.yml` in your home directory.
+
+```yml
+---
+- branch: first-branch
+  children:
+  - branch: second-branch-v1
+    children:
+    - branch: third-branch-v1
+      rebase: true
+  - branch: second-branch-v2
+```
+
+View your current place in the branch tree by running:
+
+```
+$ branchtree show
+
+# Or:
+
+$ branchtree
+```
+
+Interactively check out a different branch in the tree with:
+
+```
+$ branchtree checkout
+```
+
+If you've made commits to a non-leaf branch, run this to propagate changes forward through the tree with merges and rebases:
+
+```
+$ branchtree update
+```
+
+To see the full usage, run:
+
+```
+$ branchtree help
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/branchtree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/branchtree/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Branchtree project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/branchtree/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "branchtree"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/branchtree.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/branchtree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "branchtree"
+  spec.version       = Branchtree::VERSION
+  spec.authors       = ["Ash Wilson"]
+  spec.email         = ["smashwilson@gmail.com"]
+
+  spec.summary       = %q{CLI to manage chains of dependent git branches}
+  spec.description   = <<~EOS
+    Interactively manage chains or trees of dependent git branches. Merge or rebase to iteratively incorporate new
+    changes from upstream or intermediate modifications. View your current place within the tree.
+  EOS
+  spec.homepage      = "https://github.com/smashwilson/branchtree"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/smashwilson/branchtree"
+  spec.metadata["changelog_uri"] = "https://github.com/smashwilson/branchtree/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "tty-command", "~> 0.10.0"
+  spec.add_runtime_dependency "tty-logger", "~> 0.6.0"
+  spec.add_runtime_dependency "tty-prompt", "~> 0.23.0"
+  spec.add_runtime_dependency "tty-option", "~> 0.1.0"
+end

data/exe/branchtree

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "branchtree"
+
+Branchtree.execute(ARGV.dup)

data/lib/branchtree.rb

@@ -0,0 +1,69 @@
+require "tty-command"
+require "tty-prompt"
+require "tty-logger"
+
+module Branchtree
+  def self.execute(argv)
+    command_classes = {
+      "show" => Branchtree::Commands::Show,
+      "checkout" => Branchtree::Commands::Checkout,
+      "update" => Branchtree::Commands::Update,
+      "parent" => Branchtree::Commands::Parent,
+      "edit" => Branchtree::Commands::Edit,
+      "help" => Branchtree::Commands::Help,
+      "-h" => Branchtree::Commands::Help,
+      "--help" => Branchtree::Commands::Help,
+    }
+
+    command_name = argv.shift || "show"
+    command_class = command_classes[command_name]
+    unless command_class
+      $stderr.puts "Unrecognized command: #{command_name}"
+      $stderr.puts "Available commands: #{command_classes.keys.join(", ")}"
+      exit 1
+    end
+    command = command_class.new
+    command.parse(argv)
+    command.execute
+  end
+
+  module Context
+    class << self
+      attr_writer :cmd, :qcmd, :prompt
+
+      def cmd
+        @cmd ||= TTY::Command.new(printer: :null)
+      end
+
+      def qcmd
+        @qcmd ||= TTY::Command.new(printer: :quiet)
+      end
+
+      def prompt
+        @prompt ||= TTY::Prompt.new
+      end
+
+      def logger
+        @logger ||= TTY::Logger.new
+      end
+    end
+
+    %i[cmd qcmd prompt logger].each do |methodname|
+      define_method(methodname) do
+        Branchtree::Context.public_send(methodname)
+      end
+    end
+  end
+end
+
+require "branchtree/version"
+require "branchtree/branch"
+require "branchtree/tree"
+require "branchtree/situation"
+require "branchtree/commands/common"
+require "branchtree/commands/show"
+require "branchtree/commands/checkout"
+require "branchtree/commands/update"
+require "branchtree/commands/parent"
+require "branchtree/commands/edit"
+require "branchtree/commands/help"

data/lib/branchtree/branch.rb

@@ -0,0 +1,197 @@
+
+module Branchtree
+
+  # Represents a git branch in the current repository.
+  class Branch
+    include Branchtree::Context
+
+    # Recursively load a Branch instance and its children, if any, from deserialized YAML.
+    def self.load(node, parent)
+      new(node.fetch("branch"), parent, node.fetch("rebase", false)).tap do |branch|
+        node.fetch("children", []).each do |child_node|
+          branch.children << load(child_node, branch)
+        end
+        branch.children.freeze
+      end
+    end
+
+    attr_reader :name, :parent, :children
+    attr_accessor :info
+
+    def initialize(name, parent, rebase)
+      @name = name
+      @parent = parent
+      @rebase = rebase
+      @children = []
+      @info = NullInfo.new(self)
+    end
+
+    def root?
+      @parent.nil?
+    end
+
+    def rebase?
+      @rebase
+    end
+
+    # Return the String name of the ref that this branch is based on. New changes to this parent ref will
+    # be merged in on "apply".
+    def parent_branch_name
+      return @parent.name if @parent
+
+      if cmd.run!("git", "rev-parse", "--verify", "--quiet", "refs/heads/main").success?
+        "main"
+      else
+        "master"
+      end
+    end
+
+    # Return the full git ref name of this branch.
+    def full_ref
+      "refs/heads/#{name}"
+    end
+
+    # Checkout this branch with git
+    def checkout
+      qcmd.run("git", "checkout", name)
+    end
+
+    def merge_parent
+      qcmd.run!("git", "merge", parent_branch_name)
+    end
+
+    def rebase_parent
+      qcmd.run!("git", "rebase", parent_branch_name)
+    end
+
+    class NullInfo
+      def initialize(branch)
+        @branch = branch
+      end
+
+      def empty?
+        true
+      end
+
+      def valid?
+        true
+      end
+
+      def ahead_of_parent
+        0
+      end
+
+      def behind_parent
+        0
+      end
+
+      def has_upstream?
+        false
+      end
+
+      def ahead_of_upstream
+        0
+      end
+
+      def behind_upstream
+        0
+      end
+
+      def populate
+        # Are we valid?
+        valid_result = @branch.cmd.run!("git", "rev-parse", "--verify", "--quiet", @branch.full_ref)
+        unless valid_result.success?
+          return @branch.info = InvalidInfo.new(@branch)
+        end
+
+        parent_behind, parent_ahead = 0, 0
+        if @branch.parent.info.valid?
+          # Count ahead-behind from parent
+          ahead_behind_parent = @branch.cmd.run(
+            "git", "rev-list", "--left-right", "--count", "refs/heads/#{@branch.parent_branch_name}...#{@branch.full_ref}",
+          ).out.chomp
+          parent_behind, parent_ahead = ahead_behind_parent.split(/\t/, 2).map(&:to_i)
+        end
+
+        # Idenfity if we have an upstream
+        upstream_ref, upstream_behind, upstream_ahead = "", 0, 0
+        upstream_result = @branch.cmd.run!(
+          "git", "rev-parse", "--symbolic-full-name", "#{@branch.name}@{u}",
+        )
+        if upstream_result.success?
+          upstream_ref = upstream_result.out.chomp
+
+          ahead_behind_upstream = @branch.cmd.run(
+            "git", "rev-list", "--left-right", "--count", "#{upstream_ref}...#{@branch.full_ref}",
+          ).out.chomp
+          upstream_behind, upstream_ahead = ahead_behind_upstream.split(/\t/, 2).map(&:to_i)
+        end
+
+        @branch.info = Info.new(
+          branch: @branch,
+          ahead_of_parent: parent_ahead,
+          behind_parent: parent_behind,
+          upstream: upstream_ref,
+          ahead_of_upstream: upstream_ahead,
+          behind_upstream: upstream_behind,
+        )
+      end
+
+      def repopulate
+        populate
+      end
+    end
+
+    class InvalidInfo < NullInfo
+      def empty?
+        false
+      end
+
+      def valid?
+        false
+      end
+
+      def populate
+        self
+      end
+
+      def repopulate
+        self
+      end
+    end
+
+    class Info
+      def initialize(branch:, ahead_of_parent:, behind_parent:, upstream:, ahead_of_upstream:, behind_upstream:)
+        @branch = branch
+        @ahead_of_parent = ahead_of_parent
+        @behind_parent = behind_parent
+        @upstream = upstream
+        @ahead_of_upstream = ahead_of_upstream
+        @behind_upstream = behind_upstream
+      end
+
+      attr_reader :ahead_of_parent, :behind_parent, :upstream, :ahead_of_upstream, :behind_upstream
+
+      def empty?
+        false
+      end
+
+      def valid?
+        true
+      end
+
+      def has_upstream?
+        @upstream != ""
+      end
+
+      def populate
+        self
+      end
+
+      def repopulate
+        NullInfo.new(@branch).populate
+      end
+    end
+  end
+
+end

data/lib/branchtree/commands/checkout.rb

@@ -0,0 +1,42 @@
+require "branchtree/commands/common"
+
+module Branchtree
+  module Commands
+    class Checkout < Common
+      usage do
+        program "branchtree"
+        desc "Navigate the branch structure"
+      end
+
+      def execute
+        super
+
+        situation = load_situation
+        tree = load_tree
+        current_branch = tree.find_branch(situation.current_branch_name)
+
+        choice = prompt.select("Choose a branch to check out:") do |menu|
+          current_index = nil
+          index = 1
+          tree.depth_first do |level, branch|
+            menu.choice "#{'  ' * level}#{branch.name}", branch
+
+            current_index = index if branch == current_branch
+            index += 1
+          end
+          menu.choice "Cancel", :cancel
+          menu.default(current_index) unless current_index.nil?
+        end
+
+        if choice == :cancel
+          logger.info "Goodbye!"
+          exit 0
+        end
+
+        logger.debug "Checking out branch #{choice.name}."
+        choice.checkout
+        logger.success "Checkout successful."
+      end
+    end
+  end
+end

data/lib/branchtree/commands/common.rb

@@ -0,0 +1,64 @@
+require "tty-option"
+
+module Branchtree
+  module Commands
+    class Common
+      include TTY::Option
+      include Branchtree::Context
+    
+      usage do
+        program "branchtree"
+      end
+    
+      option :mapfile do
+        short "-m"
+        long "--mapfile PATH"
+        desc "Path to the YAML file describing desired branch topography"
+        default ENV.fetch("BRANCHTREE_MAPFILE", File.join(ENV["HOME"], "branchtree-map.yml"))
+      end
+
+      option :loglevel do
+        short "-l"
+        long "--log-level LEVEL"
+        desc "Choose the logging level for command output"
+        default "info"
+        permit TTY::Logger::LEVEL_NAMES.keys
+      end
+
+      option :help do
+        short "-h"
+        long "--help"
+        desc "Display this message"
+      end
+
+      def execute
+        if params[:help]
+          puts help
+          exit 0
+        end
+
+        if params[:loglevel]
+          logger.log_at(params[:loglevel].to_sym)
+          logger.debug "Logging at level #{params[:loglevel]}."
+        end
+      end
+
+      def load_situation
+        Situation.new.tap(&:read)
+      end
+
+      def load_tree
+        logger.debug "Loading mapfile from #{params[:mapfile]}."
+        Tree.load(params[:mapfile])
+      end
+
+      def pluralize(quantity, word, plural: "#{word}s")
+        if quantity == 1
+          "1 #{word}"
+        else
+          "#{quantity} #{plural}"
+        end
+      end
+    end
+  end
+end

data/lib/branchtree/commands/edit.rb

@@ -0,0 +1,19 @@
+require "branchtree/commands/common"
+
+module Branchtree
+  module Commands
+    class Edit < Common
+      usage do
+        program "branchtree"
+        desc "Open your branchtree configuration in your default ${EDITOR}."
+      end
+
+      def execute
+        super
+
+        editor = ENV["BRANCHTREE_EDITOR"] || ENV["EDITOR"]
+        system "#{editor} #{params[:mapfile]}"
+      end
+    end
+  end
+end

data/lib/branchtree/commands/help.rb

@@ -0,0 +1,46 @@
+require "branchtree/commands/common"
+require "branchtree/version"
+
+module Branchtree
+  module Commands
+    class Help < Common
+      usage do
+        program "branchtree"
+        desc "Show a help message."
+      end
+
+      def execute
+        super
+
+        puts <<~HELP
+          Branchtree version #{Branchtree::VERSION}.
+
+          Command-line tool to interactively manage chains or trees of dependent branches in a git repository.
+
+          Specify your desired branch topography in a YAML file at the path:
+            #{params[:mapfile]}
+          Override this by specifying the BRANCHTREE_MAPFILE environment variables or specifying the -m/--mapfile
+          argument. Format:
+
+          ```
+          ---
+          - branch: branch-name
+            rebase: true  # Update this branch by rebasing onto its parent, or merging? Default: false (merging).
+            children:
+            - branch: child-branch-0
+            - branch: child-branch-1
+          ```
+
+          Run branchtree commands within a git repository containing these branches. Available commands include:
+
+          branchtree [show] - Display the current tree, including status of each branch.
+          branchtree checkout - Interactively navigate to a branch within the tree.
+          branchtree update - Propagate new commits from parent branches recursively through their children.
+          branchtree parent - Display the parent branch of the current HEAD.
+
+          Use -h/--help flags to see options for each specific subcommand.
+        HELP
+      end
+    end
+  end
+end

data/lib/branchtree/commands/parent.rb

@@ -0,0 +1,26 @@
+require "branchtree/commands/common"
+
+module Branchtree
+  module Commands
+    class Parent < Common
+      usage do
+        program "branchtree"
+        desc "Display the parent branch of the current branch."
+      end
+
+      def execute
+        super
+
+        situation = load_situation
+        tree = load_tree
+        current_branch = tree.find_branch(situation.current_branch_name)
+        unless current_branch
+          $stderr.puts "The current branch #{situation.current_branch_name} is not within the tree."
+          exit 1
+        end
+
+        puts current_branch.parent_branch_name
+      end
+    end
+  end
+end

data/lib/branchtree/commands/show.rb

@@ -0,0 +1,57 @@
+require "branchtree/commands/common"
+
+module Branchtree
+  module Commands
+    class Show < Common
+      usage do
+        program "branchtree"
+        desc "Display the current branch tree and your place within it."
+      end
+
+      def execute
+        super
+
+        situation = load_situation
+        tree = load_tree
+        current_branch = tree.find_branch(situation.current_branch_name)
+
+        tree.depth_first do |level, branch|
+          logger.debug "Loading branch #{branch.name}."
+          branch.info.populate
+        end
+
+        tree.depth_first do |level, branch|
+          line = ""
+
+          if branch == current_branch
+            line << "==> "
+          else
+            line << "    "
+          end
+
+          line << "  " * level
+          line << branch.name
+
+          if !branch.info.valid?
+            line << " (branch missing)"
+          else
+            if branch.info.behind_parent > 0
+              line << " - #{pluralize(branch.info.behind_parent, "commit")} behind parent"
+            end
+            if branch.info.ahead_of_upstream > 0
+              if branch.info.behind_upstream > 0
+                line << " - diverged from upstream (#{branch.info.ahead_of_upstream}/#{branch.info.behind_upstream})"
+              else
+                line << " - #{pluralize(branch.info.ahead_of_upstream, "unpushed commit")}"
+              end
+            elsif branch.info.behind_upstream > 0
+              line << " - #{pluralize(branch.info.behind_upstream, "commit")} behind upstream"
+            end
+          end
+
+          puts line
+        end
+      end
+    end
+  end
+end

data/lib/branchtree/commands/update.rb

@@ -0,0 +1,100 @@
+require "branchtree/commands/common"
+
+module Branchtree
+  module Commands
+    class Update < Common
+      usage do
+        program "branchtree"
+        desc "Propagate unmerged changes forward through the tree"
+      end
+
+      option :root do
+        short "-r"
+        long "--root"
+        desc "Include unmerged commits from the default branch"
+      end
+
+      option :push do
+        short "-p"
+        long "--push ENABLED"
+        desc "Prompt to push or force-push any modified branches"
+        convert :bool
+        default "true"
+      end
+
+      def execute
+        super
+
+        situation = load_situation
+        tree = load_tree
+
+        to_push = []
+
+        tree.breadth_first do |level, branch|
+          next if branch.root? && !params[:root]
+          branch.info.populate
+          next if branch.info.behind_parent.zero?
+
+          if branch.info.behind_upstream > 0 && branch.info.ahead_upstream > 0
+            logger.error "#{branch.name} has diverged from its upstream."
+            logger.error "Please resolve this with a force push or reset --hard, then run again."
+            exit 1
+          end
+
+          before = branch.info.behind_upstream
+
+          logger.info "#{branch.name} is #{pluralize(branch.info.behind_parent, "commit")} behind its parent branch."
+          logger.info "Checking out #{branch.name}."
+          branch.checkout
+
+          success = false
+          if branch.rebase?
+            logger.info "Rebasing #{branch.name} on #{branch.parent_branch_name}."
+            success = branch.rebase_parent.success?
+          else
+            logger.info "Merging #{branch.parent_branch_name} into #{branch.name}."
+            success = branch.merge_parent.success?
+          end
+
+          unless success
+            logger.error "Please resolve these problems and run again."
+            exit 1
+          end
+
+          logger.success "#{branch.name} is now up to date."
+
+          branch.info.repopulate
+
+          after = branch.info.behind_upstream
+          to_push << branch if before != after
+        end
+
+        logger.success "All branches are now up to date."
+
+        if params[:push] && to_push.size > 0
+          chosen = prompt.multi_select("Push changed branches?") do |menu|
+            to_push.each do |branch|
+              option_name = branch.name.dup
+              option_name << " (force)" if branch.rebase?
+
+              menu.choice option_name, branch
+            end
+
+            menu.default *(1..to_push.size)
+          end
+
+          forced, unforced = chosen.partition(&:rebase?)
+          unless forced.empty?
+            logger.info "Force pushing #{pluralize(forced.size, "branch", plural: "branches")}."
+            qcmd.run("git", "push", "--force-with-lease", "origin", *forced.map(&:name))
+          end
+          unless unforced.empty?
+            logger.info "Pushing #{pluralize(unforced.size, "branch", plural: "branches")}."
+            qcmd.run("git", "push", "origin", *unforced.map(&:name))
+          end
+          logger.success "Goodbye."
+        end
+      end
+    end
+  end
+end

data/lib/branchtree/situation.rb

@@ -0,0 +1,19 @@
+module Branchtree
+
+  class Situation
+    include Branchtree::Context
+
+    attr_reader :current_branch_name
+
+    def initialize
+      @current_branch_name = nil
+    end
+
+    def read
+      @current_branch_name = cmd.run(
+        "git", "rev-parse", "--abbrev-ref", "HEAD"
+      ).out.chomp
+    end
+  end
+  
+end

data/lib/branchtree/tree.rb

@@ -0,0 +1,56 @@
+require "yaml"
+require "branchtree/branch"
+
+module Branchtree
+  
+  # Represent the branch topology described by a user's YAML file.
+  class Branchtree::Tree
+    # Load a tree from the topology described in a YAML file.
+    def self.load(source)
+      doc = YAML.safe_load(File.read(source))
+      new(doc.map { |node| Branchtree::Branch.load(node, nil) })
+    end
+
+    attr_reader :roots
+
+    def initialize(roots)
+      @roots = roots
+    end
+
+    # Locate a known branch in the tree by abbreviated ref name, or return nil if none are found.
+    def find_branch(name)
+      breadth_first do |level, branch|
+        return branch if branch.name == name
+      end
+      nil
+    end
+
+    def depth_first(&block)
+      depth_first_from(level: 0, branches: roots, &block)
+    end
+
+    def breadth_first(&block)
+      level = 0
+      frontier = roots.dup
+
+      until frontier.empty?
+        frontier.each do |branch|
+          block.call(level, branch)
+        end
+
+        level += 1
+        frontier = frontier.flat_map(&:children)
+      end
+    end
+
+    private
+
+    def depth_first_from(level:, branches:, &block)
+      branches.each do |branch|
+        block.call(level, branch)
+        depth_first_from(level: level + 1, branches: branch.children, &block)
+      end
+    end
+  end
+
+end

data/lib/branchtree/version.rb

@@ -0,0 +1,3 @@
+module Branchtree
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: branchtree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ash Wilson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: tty-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.0
+- !ruby/object:Gem::Dependency
+  name: tty-option
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: |
+  Interactively manage chains or trees of dependent git branches. Merge or rebase to iteratively incorporate new
+  changes from upstream or intermediate modifications. View your current place within the tree.
+email:
+- smashwilson@gmail.com
+executables:
+- branchtree
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- branchtree.gemspec
+- exe/branchtree
+- lib/branchtree.rb
+- lib/branchtree/branch.rb
+- lib/branchtree/commands/checkout.rb
+- lib/branchtree/commands/common.rb
+- lib/branchtree/commands/edit.rb
+- lib/branchtree/commands/help.rb
+- lib/branchtree/commands/parent.rb
+- lib/branchtree/commands/show.rb
+- lib/branchtree/commands/update.rb
+- lib/branchtree/situation.rb
+- lib/branchtree/tree.rb
+- lib/branchtree/version.rb
+homepage: https://github.com/smashwilson/branchtree
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/smashwilson/branchtree
+  source_code_uri: https://github.com/smashwilson/branchtree
+  changelog_uri: https://github.com/smashwilson/branchtree/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: CLI to manage chains of dependent git branches
+test_files: []