gnav 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70f934204fa83c3be087521f7b7911601f3af3f5434c481b0fc8c4d4701125ba
+  data.tar.gz: 5f7a6e7f0301681dba18cb37f76540b0a2510cb437a51edaca27d587cc96483f
+SHA512:
+  metadata.gz: f12e75d7607bfd17f881e60bf7442e6821defcc60acfc678bc711de1ae14fcdf32fa1bbac5aa9f40f2612befe8d46287fc78f1dfe69045f5be2f7efc9a5d6c8b
+  data.tar.gz: c0c84af7849a2030097421735d1f11e5a6c515fad2ca070748b0e77fde1bc3a126c22cd92505912a459771eafa2040c76d2f68823911a5200b93429c7eed3ecd

data/.github/workflows/rspec.yml

@@ -0,0 +1,22 @@
+name: RSpec
+
+on: [push]
+
+jobs:
+  spec:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.2', '3.1', '3.0', '2.7']
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependent ruby gems
+        run: bundle install
+      - name: Run RSpec
+        run: bundle exec rspec

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/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.6
+before_install: gem install bundler -v 2.1.4

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 tatsuya.suzuki@sage.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,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'pry', require: true
+  gem 'pry-byebug'
+  gem 'pry-stack_explorer'
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    gnav (0.3.0)
+      git
+      tty-prompt (>= 0.22.0, < 0.24)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    binding_of_caller (1.0.0)
+      debug_inspector (>= 0.0.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    debug_inspector (1.1.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    git (1.18.0)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    method_source (1.0.0)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    pry-stack_explorer (0.6.1)
+      binding_of_caller (~> 1.0)
+      pry (~> 0.13)
+    public_suffix (5.0.3)
+    rchardet (1.8.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      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
+  gnav!
+  pry
+  pry-byebug
+  pry-stack_explorer
+  rspec
+  simplecov
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Tatsuya Suzuki
+
+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,44 @@
+# GNav
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gnav`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gnav'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gnav
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/gnav. 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]/gnav/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 GNav project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gnav/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 "gnav"
+
+# 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/release/gnav

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../../lib/gnav.rb'
+
+GNav.run

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/gnav.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/gnav/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gnav"
+  spec.version       = GNav::VERSION
+  spec.authors       = ["Tatsuya Suzuki"]
+  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.homepage    = 'https://github.com/suzukimilanpaak/gnav'
+
+  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/suzukimilanpaak/gnav'
+  spec.metadata["changelog_uri"] = 'https://github.com/suzukimilanpaak/blob/master/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        = 'bin/release'
+  # spec.executables   = spec.files.grep(%r{^bin/release}) { |f| File.basename(f) }
+  spec.executables   = ['gnav']
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'git'
+  # see monkey_patches/tty/prompt.rb for more details
+  spec.add_dependency 'tty-prompt', '>= 0.22.0', '< 0.24'
+  spec.add_development_dependency 'rspec'
+end

data/lib/git_prompt.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'git'
+require 'tty-prompt'
+require 'logger'
+require_relative './treeish_extractor'
+require_relative './monkey_patches/tty/prompt.rb'
+
+class GitPrompt
+  SELECT_OPTIONS_PER_PAGE = 10
+
+  attr_reader :git, :extractor, :prompt, :logger
+
+  def initialize(git: nil)
+    @git = git || Git.open(Dir.pwd)
+    @extractor = TreeishExtractor.new(git: git)
+
+    create_prompt
+    define_key_events
+    display_select(:branch, extractor.recent_branch_names)
+  end
+
+  private
+
+  def define_key_events
+    prompt.on(:keypress) do |event|
+      if event.value == 'q'
+        exit
+      end
+
+      # move up/down in the list
+
+      if event.value == 'j'
+        prompt.trigger(:keydown)
+      end
+
+      if event.value == 'k'
+        prompt.trigger(:keyup)
+      end
+
+      # Select a mode
+
+      if event.value == 'b'
+        prompt.clear!
+        display_select(:branch, extractor.recent_branch_names)
+      end
+
+      if event.value == 't'
+        prompt.clear!
+        display_select(:tag, extractor.recent_tag_names)
+      end
+    end
+  end
+
+  def create_prompt
+    @prompt = TTY::Prompt.new(quiet: false)
+  end
+
+  def display_select(treeish_type, treeishes)
+    message = prompt.decorate("Select #{treeish_type.to_s.capitalize} > ", :green)
+    message += <<~MSG.chomp
+      [b] branch view [t] tag view
+      j: down, k: up, q: quit, Enter: choose tag
+    MSG
+
+    if treeishes.size > 0
+      prompt.select(message, filter: false, per_page: SELECT_OPTIONS_PER_PAGE) do |menu|
+        treeishes.each do |treeish|
+          menu.choice(treeish[:name], -> { checkout(treeish[:value]) })
+        end
+      end
+    else
+      prompt.ok 'No tags were found'
+    end
+  rescue TTY::Reader::InputInterrupt => e
+    # exit automatically
+  end
+
+  def checkout(treeish_name)
+    git.checkout(treeish_name)
+    exit
+  rescue Git::GitExecuteError => e
+    prompt.error(e.message)
+  end
+end

data/lib/gnav/version.rb

@@ -0,0 +1,3 @@
+module GNav
+  VERSION = "0.3.0"
+end

data/lib/gnav.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require_relative './gnav/version'
+require_relative '../lib/git_prompt'
+
+# Load bundled gems
+Bundler.require(:default)
+
+module GNav
+  def self.run
+    GitPrompt.new
+  end
+end

data/lib/monkey_patches/tty/prompt.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../../git_prompt.rb'
+
+module TTY
+  # original - https://github.com/piotrmurach/tty-prompt/blob/master/lib/tty/prompt.rb
+  class Prompt
+    # :nocov:
+    def clear!
+      # 2 is for the prompt message
+      print(TTY::Cursor.clear_lines(GitPrompt::SELECT_OPTIONS_PER_PAGE + 2, :up))
+    end
+    # :nocov:
+  end
+end

data/lib/treeish_extractor.rb

@@ -0,0 +1,60 @@
+# 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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: gnav
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Tatsuya Suzuki
+autorequire:
+bindir: bin/release
+cert_chain: []
+date: 2023-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !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'
+description: A CLI to let you interactive select tag and branch
+email:
+- ttsysuzuki@googlemail.com
+executables:
+- gnav
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rspec.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/release/gnav
+- bin/setup
+- gnav.gemspec
+- lib/git_prompt.rb
+- lib/gnav.rb
+- lib/gnav/version.rb
+- lib/monkey_patches/tty/prompt.rb
+- lib/treeish_extractor.rb
+homepage: https://github.com/suzukimilanpaak/gnav
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/suzukimilanpaak/gnav
+  source_code_uri: https://github.com/suzukimilanpaak/gnav
+  changelog_uri: https://github.com/suzukimilanpaak/blob/master/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.4.10
+signing_key:
+specification_version: 4
+summary: Interactive git tag and branch selector
+test_files: []