git_curate 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86c5c32d0a3880b82437ad8aa22e6342f972ac313e05645c3b1d1def149351d2
-  data.tar.gz: 8c3f10c1fa4728c7136ea165dbd7afd3fc785e8663716163a5ba4c8c6905c31d
+  metadata.gz: 4e0dc2d94365f5f12a1edd47599205648467c18e110807e14a69ff08696e9093
+  data.tar.gz: 69bef635b1d5aae9064a03fff30ca6c81adbc3b0520d75287e96c46bf81f94b1
 SHA512:
-  metadata.gz: 5ed0fe98091032d3cf9cbd4e444d663a3ae8fa15730273e506d8e5f133df93a532f13b4328e0bf339b7a086fabf88c32bf1fd3bc490f3e5d1c7f437408a1280d
-  data.tar.gz: 04fb50b7df2fcd455ed99985bde668bd4b15b5d547c98c5d4913c139cab32fed9e44e389f59eb0f04937278706641614282984217aaca1ac721324548cde6778
+  metadata.gz: 457a389f43af2378997956bb2b54aa373449b02338feab8bd067248d39cfbff3ffd57c816cd9628b4d0746084d1b9cf469e5dfcf166722fc245701507f485b67
+  data.tar.gz: d16c4cf11e11f9c16dd68d253f23bd4cfda983c564125fd4ff18f5298cce4e23e2c38007f5065de6b849ca85f26cdb57165edee17732b3ec41167823c6701de5

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### v0.5.0
+
+* Add `-l` option to output branch information non-interactively
+* Add help output (`-h` option)
+
 ### v0.4.3
 
 * Upgrade dependency versions

data/Gemfile.lock

@@ -21,10 +21,10 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler
   git_curate!
   rake (~> 12.3)
   rake-version (~> 1.0)
 
 BUNDLED WITH
-   1.16.6
+   2.0.1

data/README.md

@@ -49,6 +49,9 @@ delete each branch in what should be a fairly self-explanatory fashion. Note the
 you are currently on will not be included in the list, as `git` does not allow you to delete
 the branch you're on.
 
+If you just want to view the information about your local branches without stepping through
+them interactively, enter `git branch --list` or `git branch -l`.
+
 (Note the space after `git`—we have effectively added a subcommand to `git` just by installing
 a gem. When `git_curate` is installed, an executable is created called `git-curate`.
 In general, for any executable of the form _git-xyz_ in your `PATH`, `git` will automatically

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.5.0

data/exe/git-curate

@@ -1,6 +1,17 @@
 #!/usr/bin/env ruby
 
 require "git_curate"
+require "optparse"
 
-runner = GitCurate::Runner.new
-runner.run
+def main
+  parser = GitCurate::CLIParser.new
+  parser.parse(ARGV)
+  runner = GitCurate::Runner.new(parser.parsed_options)
+  runner.run
+rescue OptionParser::InvalidOption
+  puts "Unrecognized option"
+  puts 'For help, enter `git curate -h`'
+  exit(1)
+end
+
+main

data/git_curate.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "tabulo", "1.3.0"
   spec.add_runtime_dependency "tty-screen", "0.6.5"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rake-version", "~> 1.0"
 end

data/lib/git_curate/cli_parser.rb

@@ -0,0 +1,51 @@
+require "optparse"
+
+module GitCurate
+
+  class CLIParser
+
+    attr_reader :parsed_options
+
+    def initialize
+      @parsed_options = {}
+    end
+
+    def parse(options)
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = <<-EOF
+  Usage: git curate [options]
+
+  Interactively step through the local branches of the current git repository, showing various
+  information and asking whether to keep or delete each branch.
+
+  In the default (interactive) mode, the current branch is excluded, as it cannot be deleted.
+
+  Note git-curate does not perform a "git fetch"; if you want to be sure the output reflects the current
+  state of any remotes, run "git fetch" first.
+
+  Options:
+  EOF
+
+        opts.on(
+          "-l",
+          "--list",
+          "Show summary of local branches, including current branch, without stepping through interactively"
+        ) do
+          self.parsed_options[:list] = true
+        end
+
+        opts.on("-h", "Print this help message") do
+          puts opts
+          exit
+        end
+
+        opts.on("-v", "--version", "Print the currently installed version of this program") do
+          puts "git curate v#{GitCurate::VERSION} #{GitCurate::COPYRIGHT}"
+          exit
+        end
+      end
+
+      opt_parser.parse!(options)
+    end
+  end
+end

data/lib/git_curate/copyright.rb

@@ -0,0 +1,3 @@
+module GitCurate
+  COPYRIGHT = "(c) 2019 Matthew Harvey"
+end

data/lib/git_curate/runner.rb

@@ -9,81 +9,117 @@ module GitCurate
   BRANCH_NAME_REGEX = /\s+/
   REMOTE_INFO_REGEX = /^[^\s]+\s+[^\s]+\s+\[(.+?)\]/
 
+  Branch = Struct.new("Branch", :raw, :proper, :displayable)
+
   class Runner
 
+    def initialize(opts)
+      @opts = opts
+    end
+
     def run
       if ARGV.length != 0
         puts "This script does not accept any arguments."
         exit
       end
 
-      branches = command_to_a("git branch").reject { |b| current_branch?(b) }
+      branches = command_to_a("git branch").reject { |raw_branch| excluded_branch?(raw_branch) }.map do |raw_branch|
+        Struct::Branch.new(raw_branch, proper_branch(raw_branch), displayable_branch(raw_branch))
+      end
+
       merged_branches = command_to_a("git branch --merged").to_set
       upstream_branches = get_upstream_branches
 
       table = Tabulo::Table.new(branches, vertical_rule_character: " ", intersection_character: " ",
         horizontal_rule_character: "-", column_padding: 0, align_header: :left) do |t|
 
-        t.add_column(:branch, header: "Branch") { |branch| branch }
+        t.add_column(:branch, header: "Branch") { |branch| branch.displayable }
 
         t.add_column("Last commit") do |branch|
-          `git log -n1 --date=short --format='format:%cd' #{branch}`
+          `git log -n1 --date=short --format='format:%cd' #{branch.proper}`
         end
 
         t.add_column("Last author") do |branch|
-          `git log -n1 --format='format:%an' #{branch}`
+          `git log -n1 --format='format:%an' #{branch.proper}`
         end
 
         t.add_column("Last subject") do |branch|
-          `git log -n1 --format='format:%s' #{branch}`
+          `git log -n1 --format='format:%s' #{branch.proper}`
         end
 
         t.add_column("Merged\ninto HEAD?") do |branch|
-          merged_branches.include?(branch) ? "Merged" : "Not merged"
+          merged_branches.include?(branch.proper) ? "Merged" : "Not merged"
         end
 
         t.add_column("Status vs\nupstream") do |branch|
-          upstream_branches.fetch(branch, "No upstream")
+          upstream_branches.fetch(branch.proper, "No upstream")
         end
       end
 
       prompt = " Delete? [y/n/done/abort/help] "
       longest_response = "abort"
-      prompt_and_response_width = prompt.length + longest_response.length + 1
+      prompt_and_response_width =
+        if interactive?
+          prompt.length + longest_response.length + 1
+        else
+          0
+        end
       table.pack(max_table_width: TTY::Screen.width - prompt_and_response_width)
 
       branches_to_delete = []
 
       table.each_with_index do |row, index|
-        case HighLine.ask("#{row}#{prompt}")
-        when "y"
-          branches_to_delete << row.to_h[:branch]
-        when "n"
-          ;  # do nothing
-        when "done"
-          puts table.horizontal_rule
-          finalize(branches_to_delete)
-          exit
-        when "abort"
-          puts table.horizontal_rule
-          puts "\nAborting. No branches deleted."
-          exit
+        if interactive?
+          case HighLine.ask("#{row}#{prompt}")
+          when "y"
+            branches_to_delete << proper_branch(row.to_h[:branch])
+          when "n"
+            ;  # do nothing
+          when "done"
+            puts table.horizontal_rule
+            finalize(branches_to_delete)
+            exit
+          when "abort"
+            puts table.horizontal_rule
+            puts "\nAborting. No branches deleted."
+            exit
+          else
+            puts table.horizontal_rule
+            print_help
+            puts table.horizontal_rule unless index == 0
+            redo
+          end
         else
-          puts table.horizontal_rule
-          print_help
-          puts table.horizontal_rule unless index == 0
-          redo
+          puts row
         end
       end
       puts table.horizontal_rule
 
-      finalize(branches_to_delete)
+      finalize(branches_to_delete) if interactive?
     end
 
     private
 
-    def current_branch?(branch)
-      branch =~ /^\s*\*/
+    def interactive?
+      !@opts[:list]
+    end
+
+    def proper_branch(raw_branch)
+      raw_branch.lstrip.gsub(/^\*\s*/, '')
+    end
+
+    def displayable_branch(raw_branch)
+      return raw_branch if interactive?
+
+      current_branch?(raw_branch) ? raw_branch : "  " + raw_branch
+    end
+
+    def excluded_branch?(raw_branch)
+      interactive? && current_branch?(raw_branch)
+    end
+
+    def current_branch?(raw_branch)
+      raw_branch =~ /^\s*\*/
     end
 
     # Returns a Hash containing, as keys, all local branches that have upstream branches,

data/lib/git_curate/version.rb

@@ -1,3 +1,3 @@
 module GitCurate
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/lib/git_curate.rb

@@ -1,2 +1,4 @@
+require "git_curate/cli_parser"
+require "git_curate/copyright"
 require "git_curate/runner"
 require "git_curate/version"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_curate
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Matthew Harvey
@@ -56,16 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,8 @@ files:
 - exe/git-curate
 - git_curate.gemspec
 - lib/git_curate.rb
+- lib/git_curate/cli_parser.rb
+- lib/git_curate/copyright.rb
 - lib/git_curate/runner.rb
 - lib/git_curate/version.rb
 homepage: https://github.com/matt-harvey/git_curate