gnav 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b7e79cbdf5cf836f06a23a8b09e190bc356d2530409fb4cd8716ea6298f60d7
-  data.tar.gz: efd61790bae168e306b07910741d3c00aee7baebbd2aa1ce197e123dd391de78
+  metadata.gz: 96e88832c57a359eadeeb4857fe254cc13719604a88e1d332eb65ff1b0ee2b57
+  data.tar.gz: 23b13378d16d4dd3cff401a321510556c1c75f32bb87f49cf45d019213260e06
 SHA512:
-  metadata.gz: b093501f3dab75937f63cd620396de323d9321c50953fd2876d251856603d1dc60d035c0bdd051c319da24118eaa2e94f222450f9dece50314461e0c58138715
-  data.tar.gz: e5cc017bd44a23bd93da97774b97c77e553f5aaec8d8ec9afa000d902f0f509597b65808982e611cd24dcb7d573a88ae06a2b4486b34cb772028067687bcff3e
+  metadata.gz: ab48798911feef5a952fa42bb29c3fb761c80b74d7012ce52a2efc486dcecd91704cca3d57d155973fe37ce26260c936fe0a519eebe298f28920a9100f99297e
+  data.tar.gz: f50ccd8dba699f35aad897e5dcd67098488662b5243437cbe1caa5d39fdb57619c0995a1f19a0e865cb37e33fa9fb6a4d8a1e25e2d9ddd8b69f4395ba2bec042

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    gnav (0.3.1)
+    gnav (0.5.0)
+      cli
       git
       tty-prompt (>= 0.22.0, < 0.24)
 
@@ -13,6 +14,7 @@ GEM
     binding_of_caller (1.0.0)
       debug_inspector (>= 0.0.1)
     byebug (11.1.3)
+    cli (1.4.0)
     coderay (1.1.3)
     debug_inspector (1.1.0)
     diff-lcs (1.5.0)
@@ -79,4 +81,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -1,6 +1,8 @@
 # GNav
 
-`gnav` is a simple command line tool to choose git tag and branch interactively.
+`gnav` is an simple command line tool for interactively checking out a git tag or branch.
+
+<img src='assets/gnav_theme.jpeg' width="260" alt='Gnav theme' />
 
 
 ## Installation
@@ -8,7 +10,7 @@
 Simply, install it with gem.
 
 ```shell
-$ gem 'gnav'
+$ gem install gnav
 ```
 
 

data/bin/release/gnav

@@ -1,5 +1,14 @@
 #!/usr/bin/env ruby -W0
 
+require 'cli'
+require "rubygems"
 require_relative '../../lib/gnav.rb'
 
+gemspec = Gem::Specification::load('gnav.gemspec')
+
+CLI.new do
+  description gemspec.description
+  version gemspec.version
+end.parse!
+
 GNav.run

data/gnav.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["ttsysuzuki@googlemail.com"]
 
   spec.summary     = 'Interactive git tag and branch selector'
-  spec.description = 'A CLI to let you interactive select tag and branch'
+  spec.description = '`gnav` is an simple command line tool for interactively checking out a git tag or branch.'
   spec.homepage    = 'https://github.com/suzukimilanpaak/gnav'
 
   spec.license       = "MIT"
@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'git'
+  spec.add_dependency 'cli'
   # see monkey_patches/tty/prompt.rb for more details
   spec.add_dependency 'tty-prompt', '>= 0.22.0', '< 0.24'
   spec.add_development_dependency 'rspec'

data/lib/git_prompt.rb

@@ -3,21 +3,22 @@
 require 'git'
 require 'tty-prompt'
 require 'logger'
-require_relative './treeish_extractor'
-require_relative './monkey_patches/tty/prompt.rb'
+require_relative './treeish'
+require_relative './monkey_patches/tty/prompt'
 
 class GitPrompt
   SELECT_OPTIONS_PER_PAGE = 10
 
-  attr_reader :git, :extractor, :prompt, :logger
+  attr_reader :git, :branch, :tag, :prompt, :logger
 
   def initialize(git: nil)
     @git = git || Git.open(Dir.pwd)
-    @extractor = TreeishExtractor.new(git: git)
+    @branch = Treeish::Branch.new(git: git)
+    @tag = Treeish::Tag.new(git: git)
 
     create_prompt
     define_key_events
-    display_select(:branch, extractor.recent_branch_names)
+    display_select(:branch, branch.recents)
   end
 
   private
@@ -42,12 +43,12 @@ class GitPrompt
 
       if event.value == 'b'
         prompt.clear!
-        display_select(:branch, extractor.recent_branch_names)
+        display_select(:branch, branch.recents)
       end
 
       if event.value == 't'
         prompt.clear!
-        display_select(:tag, extractor.recent_tag_names)
+        display_select(:tag, tag.recents)
       end
     end
   end

data/lib/gnav/version.rb

@@ -1,3 +1,3 @@
 module GNav
-  VERSION = "0.3.2"
+  VERSION = "0.5.0"
 end

data/lib/treeish/base.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'git'
+require 'open3'
+
+module Treeish
+  class Base
+    attr_reader :git
+
+    def initialize(git: nil)
+      @git = git || Git.open(Dir.pwd)
+    end
+
+    def recents
+      get_treeishes(recents_command) do |line, names|
+        next if reject_strategy(line, names)
+        names << {
+          value: value_strategy(line, names),
+          name: name_strategy(line, names)
+        }
+      end
+    end
+
+    private
+
+    def recents_command; end
+    def reject_strategy(line, names); end
+    def value_strategy(line, names); end
+    def name_strategy(line, names); end
+
+    def get_treeishes(cmd)
+      names = []
+      _stdin, stdout, _stderr, _wait_thr = Open3.popen3(cmd)
+      stdout.each(sep="\n") do |line|
+        yield(line, names)
+      end
+      names
+    end
+  end
+end

data/lib/treeish/branch.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Treeish
+  class Branch < Base
+    private
+
+    def recents_command
+      'git branch --sort=-committerdate'
+    end
+
+    def reject_strategy(line, _)
+      # 'HEAD detached' means the last commit is detached from its HEAD.
+      # We don't need this information and remove it.
+      line =~ /HEAD detached/
+    end
+
+    def value_strategy(line, _)
+      line.sub('*', '').strip
+    end
+
+    def name_strategy(line, _)
+      if line.match(/\*\s/)
+        line.strip
+      else
+        "  #{line.strip}"
+      end
+    end
+  end
+end

data/lib/treeish/tag.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative './base'
+
+module Treeish
+  class Tag < Base
+    private
+
+    def recents_command
+      'git tag --sort=-committerdate'
+    end
+
+    def reject_strategy(line, _)
+      false
+    end
+
+    def value_strategy(line, _)
+      line.strip
+    end
+
+    def name_strategy(line, _)
+      if line.match(/#{current}/)
+        "* #{line.strip}"
+      else
+        "  #{line.strip}"
+      end
+    end
+
+    def current
+      # git describe --exact-match --tags $(git log -n1 --pretty='%h')
+      cmd = "git log -n1 --pretty='%h'"
+      _stdin, stdout, _stderr, _wait_thr = Open3.popen3(cmd)
+      last_commit = stdout.read.strip
+
+      cmd = "git describe --exact-match --tags #{last_commit}"
+      _stdin, stdout, _stderr, _wait_thr = Open3.popen3(cmd)
+      stdout.read.strip
+    end
+  end
+end

data/lib/treeish.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative './treeish/branch'
+require_relative './treeish/tag'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnav
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Tatsuya Suzuki
 autorequire:
 bindir: bin/release
 cert_chain: []
-date: 2023-11-09 00:00:00.000000000 Z
+date: 2023-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
@@ -58,7 +72,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A CLI to let you interactive select tag and branch
+description: "`gnav` is an simple command line tool for interactively checking out
+  a git tag or branch."
 email:
 - ttsysuzuki@googlemail.com
 executables:
@@ -76,6 +91,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/gnav_theme.jpeg
 - bin/console
 - bin/release/gnav
 - bin/setup
@@ -84,7 +100,10 @@ files:
 - lib/gnav.rb
 - lib/gnav/version.rb
 - lib/monkey_patches/tty/prompt.rb
-- lib/treeish_extractor.rb
+- lib/treeish.rb
+- lib/treeish/base.rb
+- lib/treeish/branch.rb
+- lib/treeish/tag.rb
 homepage: https://github.com/suzukimilanpaak/gnav
 licenses:
 - MIT
@@ -107,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Interactive git tag and branch selector

data/lib/treeish_extractor.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require 'git'
-require 'open3'
-
-class TreeishExtractor
-  attr_reader :git
-
-  def initialize(git: nil)
-    @git = git || Git.open(Dir.pwd)
-  end
-
-  def recent_tag_names
-    cmd = 'git tag --sort=-committerdate'
-    get_treeishes(cmd) do |line, names|
-      names << {
-        value: line.strip,
-        name: line.strip
-      }
-    end
-  end
-
-  def recent_branch_names
-    cmd = 'git branch --sort=-committerdate'
-    get_treeishes(cmd) do |line, names|
-      next if REJECT_STRATEGY.call(line, names).nil?
-      names << {
-        value: VALUE_STRATEGY.call(line, names),
-        name: NAME_STRATEGY.call(line, names)
-      }
-    end
-  end
-
-  private
-
-  REJECT_STRATEGY = lambda do |line, _|
-    # 'HEAD detached' means the last commit is detached from its HEAD.
-    # We don't need this information and remove it.
-    line unless line =~ /HEAD detached/
-  end
-  VALUE_STRATEGY = lambda do |line, _|
-    line.sub('*', '').strip
-  end
-  NAME_STRATEGY = lambda do |line, _|
-    if line.match(/\*\s/)
-      line.strip
-    else
-      "  #{line.sub('*', '').strip}"
-    end
-  end
-
-  def get_treeishes(cmd)
-    names = []
-    _stdin, stdout, _stderr, _wait_thr = Open3.popen3(cmd)
-    stdout.each(sep="\n") do |line|
-      yield(line, names)
-    end
-    names
-  end
-end