thicket 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed32e78f45dbc2f887839f2210edb89e4c0a7385c457c1b6f4a13a19ab1c384e
+  data.tar.gz: cede744f06f5ec921aad06af06f3ea7efd55e68a749b0290da4ac16752431bcd
+SHA512:
+  metadata.gz: 1275727f176525c11c885ee985d1df0009a9005708f509d0107a5b3f6c4a8378a854dc0e748961dc8ef7cf3544cb9c002dac04646e8bdc7ac9e8b78fbb3804ac
+  data.tar.gz: 5191534f823312b3a1f30d9392aaf92980e964cd0787a5aded3940b7073fc72c1fed5b47b239b3b17918eaf4b8feef2c4f48f358f1e333f7139bcf8b7002c5ca

data/bin/thicket

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "thicket"
+
+parser = Thicket::OptionParser.new
+Thicket::Log.new(parser.options).print

data/lib/thicket/log.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "time"
+
+module Thicket
+  class Log
+    LOG_PARSE_REGEX = /[a-f0-9]{7}.+?m(.+?) .+?m\{([\w ]+)\}.+?m (?:\((.+?)\))?.+?m(.+$)/.freeze
+
+    def initialize(options)
+      @options = options
+    end
+
+    # Gets a printable version of the log for purposes of printing to a
+    # terminal. This effectively builds the final printable log to display to
+    # the user.
+    def print
+      FileUtils.cd(git_working_directory)
+      `#{git_log_command}`.split("\n").each { |l| puts process_git_log_line(l) }
+    rescue Errno::EPIPE, SystemExit, Interrupt
+      exit
+    end
+
+    private
+
+    # Takes a single line of raw, colored git log output and manipulates it
+    # into the desired format.
+    def process_git_log_line(line)
+      @padding_char = @padding_char == " " ? "-" : " "
+
+      line.match(LOG_PARSE_REGEX) do |matcher|
+        process_date_time(matcher[1], line, matcher[3])
+        process_message_prefix(matcher[4], line) if @options[:color_prefixes]
+        process_author_name(matcher[2], line)
+      end
+
+      line
+    end
+
+    # Takes an input log string and a commit date/time and replaces it in the
+    # log string with a formatted version.
+    def process_date_time(time_string, line, have_refs)
+      seconds_ago = Time.now - Time.iso8601(time_string)
+      measure = TimeMeasure.measures.find { |m| m.threshold < seconds_ago }
+      quantity = (seconds_ago / measure.length).floor
+      to_sub = +"#{quantity}#{measure.abbreviation}".rjust(3)
+      to_sub << "\e[31m" if have_refs # add color if we have refs in this line
+      line.sub!(time_string, to_sub)
+    end
+
+    # Takes an input log string and commit message, finds commit messages
+    # prefixes, and darkens them.
+    def process_message_prefix(message, line)
+      prefix_regex = %r{^(?=.*[0-9])([A-Z\d-]+?[: \/])}
+      message.match(prefix_regex) do |matcher|
+        prefix = matcher[1]
+        line.sub!(/([^\/])#{prefix}/, "\\1\e[1;30m#{prefix}\e[m")
+      end
+    end
+
+    # Takes an input log string and commit author, and moves it from the normal
+    # position in the string to a right-justified location.
+    def process_author_name(author, line)
+      line.sub!("\e[34m{#{author}}\e[31m ", "")
+      total_length = strip_color(line).length
+      over = (total_length + author.length + 1) - terminal_width
+      line = line[0...-over] if over > 0
+
+      total_length = strip_color(line).length
+      spaces_needed = terminal_width - total_length - author.length - 2
+      if spaces_needed < 0
+        line = +"#{line[0...-spaces_needed - 5]}... "
+      else
+        line << " \e[30m"
+        line << @padding_char * spaces_needed
+        line << " \e[m"
+      end
+
+      line << "\e[34m#{author}\e[m"
+    end
+
+    # Strips ANSI color escape codes from a string. Colorize's
+    # String#uncolorize would be used, but it seems to only remove escape codes
+    # which match a strict pattern, which git log's colored output doesn't
+    # follow.
+    def strip_color(string)
+      color_escape_regex = /\e\[([;\d]+)?m/
+      string.gsub(color_escape_regex, "").chomp
+    end
+
+    # Gets the width of the terminal window in columns. Memoizes the result to
+    # avoid more shell calls, and because the terminal size won't be changing
+    # during the execution of this script.
+    def terminal_width
+      @terminal_width ||= `tput cols`.to_i
+    rescue Errno::ENOENT
+      puts "Failed to determine terminal column width."
+      exit
+    end
+
+    # The command string which gets the raw git log input straight from git.
+    # Includes all formatting and color escape codes.
+    def git_log_command
+      format = "%C(yellow)%h %Cgreen%aI %Cblue{%an}%Cred%d %Creset%s"
+      cmd = "#{git_executable} log --oneline --decorate --color " \
+      "--graph --pretty=format:'#{format}'"
+      cmd << " --all" if @options[:all]
+
+      cmd
+    end
+
+    # The path to the git executable. Honors the passed in command line option,
+    # and falls back to just "git".
+    def git_executable
+      @options[:git_binary] || "git"
+    end
+
+    # The directory which represents the git project that we want to retreive
+    # logs for. Uses the command line option if it was provided, and falls back
+    # to the current working directory otherwise.
+    def git_working_directory
+      @options[:project_directory] || Dir.pwd
+    end
+  end
+end

data/lib/thicket/option_parser.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Thicket
+  Options = Struct.new(:name)
+
+  class OptionParser
+    attr_reader :options
+
+    def initialize
+      @options = {}
+      parse ARGV
+    end
+
+    private
+
+    def parse(options)
+      args = Options.new("world")
+
+      opt_parser = ::OptionParser.new do |opts|
+        opts.banner = "Usage: thicket [options] <command>"
+
+        opts.on("-v", "--version", "Print the version number") do |v|
+          args.name = v
+          puts Thicket::VERSION
+          exit
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+
+        opts.on("-d", "--directory DIRECTORY", String, "Path to the project directory") do |project_directory|
+          args.name = project_directory
+          @options[:project_directory] = File.expand_path(project_directory)
+        end
+
+        opts.on("-a", "--all", TrueClass, "Displays all branches on all remotes.") do |all|
+          args.name = all
+          @options[:all] = all
+        end
+
+        opts.on("-p", "--color-prefixes", TrueClass, "Adds coloring to commit message prefixes.") do |prefixes|
+          args.name = prefixes
+          @options[:color_prefixes] = prefixes
+        end
+
+        opts.on("--git-binary BINARY", String, "Path to a git executable") do |git_binary|
+          args.name = git_binary
+          @options[:git_binary] = File.expand_path(git_binary)
+        end
+      end
+
+      opt_parser.parse!(options)
+    rescue ::OptionParser::ParseError => e
+      puts e.message
+      exit
+    end
+  end
+end

data/lib/thicket/time_measure.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Thicket
+  module TimeMeasure
+    class Measure
+      attr_reader :length, :abbreviation, :threshold
+
+      def initialize(length_in_seconds, abbreviation, threshold_in_seconds)
+        @length = length_in_seconds
+        @abbreviation = abbreviation
+        @threshold = threshold_in_seconds
+      end
+    end
+
+    YEAR = Measure.new(31_104_000, "Y", 155_520_000)
+    MONTH = Measure.new(2_592_000, "M", 15_552_000)
+    WEEK = Measure.new(604_800, "w", 2_419_200)
+    DAY = Measure.new(86_400, "d", 172_800)
+    HOUR = Measure.new(3_600, "h", 3_600)
+    MINUTE = Measure.new(60, "m", 60)
+    SECOND = Measure.new(1, "s", 0)
+
+    def self.measures
+      [YEAR, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND]
+    end
+  end
+end

data/lib/thicket/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Thicket
+  #:nodoc:
+  VERSION ||= "0.1.0"
+end

data/lib/thicket.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "thicket/version"
+require "thicket/log"
+require "thicket/option_parser"
+require "thicket/time_measure"
+
+module Thicket
+  def self.root
+    File.expand_path("..", __dir__)
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: thicket
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taylor Thurlow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  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: pry-byebug
+  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: rspec
+  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: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: solargraph
+  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: |
+  Git's default log command gets the job done, but its formatting capabilities
+  sometimes leave something to be desired. Thicket is an opinionated replacement for
+  "git log".
+email: taylorthurlow8@gmail.com
+executables:
+- thicket
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/thicket
+- lib/thicket.rb
+- lib/thicket/log.rb
+- lib/thicket/option_parser.rb
+- lib/thicket/time_measure.rb
+- lib/thicket/version.rb
+homepage: https://github.com/taylorthurlow/thicket
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An opinionated replacement for git's log command.
+test_files: []