git_curate 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6996bc4363bed00c0ed66d7ac49427a681f633e199e3b8f7b0e504bed64af52
-  data.tar.gz: 5a1766c37e6460a3b6081ba876443359b8fe01c44a898e234a4a96527ac13306
+  metadata.gz: 81714cf7534f51e20f211a41f3b93173c51fc066c8605e8fdd3c4b2887208309
+  data.tar.gz: 2325066c76763a77dcc7734120da18d0cc71083b5f8586d4d10d8ae7cf647abd
 SHA512:
-  metadata.gz: ed0bee6ea221fb9d3a50b8432151409604d0fee5ee63c7c423daf19fade386bc43a1c5d2645a178bdf9bc873d4318ec82d9f2468506f9b0643a59b9f48308f59
-  data.tar.gz: 909f9f0e1bc401c5e110a830b910192fd7fc959fc457ab8b1d19e5d7db0b1b0e6b1aa7a2d558f4d253b70a0ceb6dd8633d2152f7eaaf670c10355bee3255f321
+  metadata.gz: f2a73379b744efb995a7aef5727f9be1b77617b26395f649eea0d16cfda72da49d675bfd8f270873e3d478918180e93d45e10fa43078f08da0d0eab3b43ad38c
+  data.tar.gz: 822e799c402d44bd7bb7d7e32d12c88bf411385e628d3d2bfdfba9479b95c7d3b5e4457903f13df2fecabe9508cd439cfa5c753f15bbff43c6a0b94fd0d6d6bf

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### v0.7.2
+
+* Nicer error messages; for example, if `git curate` is run outside of a git repo, the user will now see
+  the same error message as they would see from running `git branch` (as opposed to seeing an unsightly stack trace)
+* Performance improvements: it now runs faster, as the number of system calls made by the
+  application is reduced
+* Improvements to code structure and internal documentation
+
 ### v0.7.1
 
 * Fix errors on -h, -v and --version options due to incorrect exit code handling

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.7.2

data/lib/git_curate.rb

@@ -2,6 +2,7 @@ require "git_curate/app"
 require "git_curate/branch"
 require "git_curate/cli_parser"
 require "git_curate/copyright"
+require "git_curate/exceptions"
 require "git_curate/runner"
 require "git_curate/util"
 require "git_curate/version"

data/lib/git_curate/app.rb

@@ -4,17 +4,23 @@ module GitCurate
 
   module App
 
+    # Runs the application and returns an exit status which should be passed to exit() by
+    # the caller of this function.
     def self.main
       parser = GitCurate::CLIParser.new
       continue = parser.parse(ARGV) # will throw on error
-      return 0 unless continue
+      return EXIT_SUCCESS unless continue
 
       runner = GitCurate::Runner.new(parser.parsed_options)
+      # Args not parsed by the CLIParser are passed to Runner.
       runner.run(ARGV)
+    rescue SystemCommandError => error
+      $stderr.puts(error.message)
+      error.exit_status
     rescue OptionParser::InvalidOption
       puts "Unrecognized option"
       puts "For help, enter `git curate -h`"
-      1
+      EXIT_FAILURE
     end
 
   end

data/lib/git_curate/branch.rb

@@ -10,21 +10,30 @@ module GitCurate
     LEADING_STAR_REGEX = /^\* /
     REMOTE_INFO_REGEX = /^[^\s]+\s+[^\s]+\s+\[(.+?)\]/
 
+    # Returns the branch name, with "* " prefixed if it's the current branch.
     attr_reader :raw_name
 
-    # raw_name should start in "* " if the current branch, but should otherwise have not whitespace.
-    def initialize(raw_name)
-      @raw_name = raw_name
-    end
+    # Returns a human-friendly string describing the status of the branch relative to the upstream branch
+    # it's tracking, if any.
+    attr_reader :upstream_info
 
+    # Returns simply the name of the branch, without any other "decoration".
     def proper_name
       @proper_name ||= @raw_name.lstrip.sub(CURRENT_BRANCH_REGEX, '')
     end
 
+    # Returns truthy if and only if this is the currently checked out branch.
     def current?
       @current ||= (@raw_name =~ CURRENT_BRANCH_REGEX)
     end
 
+    # Return truthy if and only if this branch has been merged into the current HEAD.
+    def merged?
+      @merged
+    end
+
+    # Returns the branch's name, with a prefix of "* " if it's the currently checked out branch, or else a prefix
+    # of "  ". Branch displayable names are designed to be aligned with each other for display in a vertical column.
     def displayable_name(pad:)
       if pad && !current?
         "  #{@raw_name}"
@@ -33,58 +42,74 @@ module GitCurate
       end
     end
 
-    def last_author
-      Util.command_output("git log -n1 --format=format:%an #{proper_name} --")
+    def last_commit_date
+      initialize_last_commit_data
+      @last_commit_date
     end
 
-    def last_commit_date
-      Util.command_output("git log -n1 --date=short --format=format:%cd #{proper_name} --")
+    def last_author
+      initialize_last_commit_data
+      @last_author
     end
 
     def last_subject
-      Util.command_output("git log -n1 --format=format:%s #{proper_name} --")
+      initialize_last_commit_data
+      @last_subject
     end
 
     # Returns the local branches
     def self.local
-      command_to_branches("git branch")
-    end
+      merged_branch_raw_names = Util.command_to_a("git branch --merged").to_set
 
-    # Returns local branches that are merged into current HEAD
-    def self.local_merged
-      command_to_branches("git branch --merged")
+      branch_info.map do |raw_name, info|
+        new(raw_name, merged: merged_branch_raw_names.include?(raw_name), upstream_info: info)
+      end
     end
 
-    # Returns a Hash containing, as keys, the proper names of all local branches that have upstream branches,
-    # and, as values, a brief description of each branch's status relative to its upstream
-    # branch (up to date, or ahead/behind)
-    def self.upstream_info
+    private
+
+    # Returns a Hash containing, as keys, the raw names of all local branches and, as values,
+    # a brief description of each branch's status relative to its upstream branch (up to
+    # date, or ahead/behind).
+    def self.branch_info
       Util.command_to_a("git branch -vv").map do |line|
-        line.gsub!(LEADING_STAR_REGEX, "")
-        branch_name = line.split(BRANCH_NAME_REGEX)[0]
-        remote_info = line[REMOTE_INFO_REGEX, 1]
-        if remote_info.nil?
-          nil
-        else
-          comparison_raw = remote_info.split(":")
-          comparison = if comparison_raw.length < 2
-                         "Up to date"
-                       else
-                         comparison_raw[1].strip.capitalize
-                       end
-          [branch_name, comparison]
-        end
-      end.compact.to_h
+        line_is_current_branch = (line =~ LEADING_STAR_REGEX)
+        tidied_line = (line_is_current_branch ? line.gsub(LEADING_STAR_REGEX, "") : line)
+        proper_branch_name = tidied_line.split(BRANCH_NAME_REGEX)[0]
+        raw_branch_name = (line_is_current_branch ? "* #{proper_branch_name}" : proper_branch_name)
+        remote_info = tidied_line[REMOTE_INFO_REGEX, 1]
+        upstream_info =
+          if remote_info.nil?
+            "No upstream"
+          else
+            comparison_raw = remote_info.split(":")
+            comparison_raw.length < 2 ? "Up to date" : comparison_raw[1].strip.capitalize
+          end
+        [raw_branch_name, upstream_info]
+      end.to_h
     end
 
     def self.delete_multi(*branches)
       Util.command_output("git branch -D #{branches.map(&:proper_name).join(" ")} --")
     end
 
-    private
+    # raw_name should start in "* " if the current branch, but should otherwise have not whitespace.
+    def initialize(raw_name, merged:, upstream_info:)
+      @raw_name = raw_name
+      @merged = merged
+      @upstream_info = upstream_info
+    end
+
+    # Returns an array with [date, author, subject], each as a string.
+    def initialize_last_commit_data
+      return if @last_commit_data
+
+      # For Windows compatibility we need double quotes around the format string, as well as spaces
+      # between the placeholders.
+      command = %Q(git log -n1 --date=short --format=format:"%cd %n %an %n %s" #{proper_name} --)
+      @last_commit_data = Util.command_to_a(command)
 
-    def self.command_to_branches(command)
-      Util.command_to_a(command).map { |raw_branch_name| self.new(raw_branch_name) }
+      @last_commit_date, @last_author, @last_subject = @last_commit_data
     end
 
   end

data/lib/git_curate/cli_parser.rb

@@ -10,8 +10,10 @@ module GitCurate
       @parsed_options = {}
     end
 
-    # Sets @parsed_options according to the options received, and return truthy
-    # if and only if the program should continue after the options are passed.
+    # Sets @parsed_options according to the options received, and return truthy if and only if the program should
+    # continue after the options are passed. Usually this method should be passed ARGV. Any elements of `options` that
+    # are not processed by this method, will remain in `options`; elements that are processed, will be destructively
+    # removed from `options`.
     def parse(options)
       opt_parser = OptionParser.new do |opts|
         opts.banner = <<-EOF

data/lib/git_curate/exceptions.rb

@@ -0,0 +1,16 @@
+module GitCurate
+
+  EXIT_SUCCESS = 0
+  EXIT_FAILURE = 1
+
+  # Error indicating that a system command has exited with a non-success exit status.
+  class SystemCommandError < StandardError
+
+    attr_reader :exit_status
+
+    def initialize(message, exit_status)
+      super(message)
+      @exit_status = exit_status
+    end
+  end
+end

data/lib/git_curate/runner.rb

@@ -5,15 +5,21 @@ require "tty-screen"
 
 module GitCurate
 
-  EXIT_SUCCESS = 0
-  EXIT_FAILURE = 1
-
+  # Contains the main logic of the application.
   class Runner
 
+    # Accepts a Hash of options passed from the parsed command line. Currently there is only one option, :list,
+    # which is treated as a boolean, and determines whether the branches will simply be listed non-interactively
+    # (list: true), or interactively with opportunities for the user to select branches for deletion (list: false).
     def initialize(opts)
       @opts = opts
     end
 
+    # Runs the application, listing branches either interactively or non-interactively. Returns an exit status,
+    # suitable for passing to `exit()`.
+    # `args` should be passed an array of non-option/non-flag arguments received from the command
+    # line. If this array is of inappropriate length, EXIT_FAILURE will be returned. (The
+    # appropriate length may be 0.)
     def run(args)
       if args.length != 0
         $stderr.puts "This script does not accept any arguments."
@@ -22,8 +28,6 @@ module GitCurate
 
       branches = Branch.local
       branches.reject!(&:current?) if interactive?
-      merged_branch_names = Branch.local_merged.map(&:proper_name).to_set
-      upstream_branches = Branch.upstream_info
 
       table = Tabulo::Table.new(branches, vertical_rule_character: " ", intersection_character: " ",
         horizontal_rule_character: "-", column_padding: 0, align_header: :left) do |t|
@@ -32,8 +36,8 @@ module GitCurate
         t.add_column("Last commit", &:last_commit_date)
         t.add_column("Last author", &:last_author)
         t.add_column("Last subject", &:last_subject)
-        t.add_column("Merged#{$/}into HEAD?") { |b| merged_branch_names.include?(b.proper_name) ? "Merged" : "Not merged" }
-        t.add_column("Status vs#{$/}upstream") { |b| upstream_branches.fetch(b.proper_name, "No upstream") }
+        t.add_column("Merged#{$/}into HEAD?") { |b| b.merged? ? "Merged" : "Not merged" }
+        t.add_column("Status vs#{$/}upstream", &:upstream_info)
       end
 
       prompt = " Delete? [y/N/done/abort/help] "

data/lib/git_curate/util.rb

@@ -15,9 +15,10 @@ module GitCurate
     # output as its message.
     def self.command_output(command)
       stdout_str, stderr_str, status = Open3.capture3(command)
+      exit_status = status.exitstatus
 
-      if status.exitstatus != 0
-        raise RuntimeError.new(stderr_str)
+      if exit_status != EXIT_SUCCESS
+        raise SystemCommandError.new(stderr_str, exit_status)
       end
 
       stdout_str

data/lib/git_curate/version.rb

@@ -1,3 +1,3 @@
 module GitCurate
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_curate
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Matthew Harvey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-03 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -163,6 +163,7 @@ files:
 - lib/git_curate/branch.rb
 - lib/git_curate/cli_parser.rb
 - lib/git_curate/copyright.rb
+- lib/git_curate/exceptions.rb
 - lib/git_curate/runner.rb
 - lib/git_curate/util.rb
 - lib/git_curate/version.rb