git-switcher 0.0.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 480d3361397c05f135cbdc8a6f2b2fad1b7b0938
+  data.tar.gz: 96a290408fd6ec990e78afb6e607732564a2227e
+SHA512:
+  metadata.gz: 4da53fa155489463e202bbf1b282ee0460666d79853a3f15e21bb24868bdef95331dff2042f904346e6ffac2953e5a4c74cff6ea61aca8b5e93739846796a46d
+  data.tar.gz: bf26043f75fcbe49e946ba15b30879f042c182d4d751aa5bedcb7a366d871241ede8e9dea75e1ee8bbe4896c2d141dcfc439eda3d14e01f792bc4a5feafac9c8

data/.gitignore

@@ -1,19 +1,8 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.sublime-*
-vcr_debug.log
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.pryrc

@@ -0,0 +1,8 @@
+# this loads all of 'git-multi'
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git/switcher'
+
+def repository
+  pry Rugged::Repository.new(Dir.pwd)
+end

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  Exclude:
+    - 'doc/*'
+    - 'tmp/*'
+    - 'pkg/*'
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/NestedTernaryOperator:
+  Enabled: false
+Style/RedundantBegin:
+  Enabled: false
+Style/SingleLineMethods:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.8

data/.travis.yml

@@ -1,6 +1,7 @@
+---
+sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - "1.9.2"
-  - "1.9.3"
-# uncomment this line if your project needs to run something other than `rake`:
-# script: bundle exec rspec spec
+  - 2.3.8
+before_install: gem install bundler -v 2.0.1

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 peter.vandenberk@simplybusiness.co.uk. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -2,10 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in git-switcher.gemspec
 gemspec
-
-# Explicitly add rake, for "Travis CI" purposes
-group :test do
-  gem 'rake'
-end
-
-# vim:syntax=ruby

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    git-switcher (1.0.0)
+      rainbow (~> 3.0)
+      rugged (~> 0.27)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    jaro_winkler (1.5.2)
+    method_source (0.9.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rubocop (0.65.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    rugged (0.27.7)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  git-switcher!
+  pry
+  rake
+  rubocop
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2012 Peter Vandenberk
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2012-2019 Peter Vandenberk (pvandenberk@mac.com)
 
-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:
+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 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.
+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

@@ -86,10 +86,12 @@ For example, if you previously selected `11` to switch to the local `master` bra
 
 To quickly switch to the `pvandenb` branch, just press `enter` *(without having to enter the corresponding shortcut key)*.
 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/pvdb/git-switcher.

data/Rakefile

@@ -1,32 +1,33 @@
-require "bundler/gem_tasks"
+# rubocop:disable Style/SymbolArray
+# rubocop:disable Style/HashSyntax
 
-task :default => [:test]
-task :test => [:spec, :features]
+require 'bundler/gem_tasks'
 
-task :gemspec do
-  @gemspec ||= eval(File.read(Dir["*.gemspec"].first))
+task :validate_gemspec do
+  Bundler.load_gemspec('git-switcher.gemspec').validate
 end
 
-desc "Validate the gemspec"
-task :validate => :gemspec do
-  @gemspec.validate
+task :version => :validate_gemspec do
+  puts Git::Switcher.version
 end
 
-require 'rspec'
-require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = "--format d --color"
-end
-
-task :rspec => [:spec]
+RuboCop::RakeTask.new(:rubocop)
 
-require 'cucumber'
-require 'cucumber/rake/task'
+require 'rake/testtask'
 
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format pretty --tags ~@wip"
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :cucumber => [:features]
+task :default => [:version, :rubocop, :test]
+
+task :documentation
+
+Rake::Task['build'].enhance([:default, :documentation])
 
+# rubocop:enable Style/HashSyntax
+# rubocop:enable Style/SymbolArray

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'git/switcher'
+
+require 'pry'
+Pry.start
+
+# That's all Folks!

data/bin/setup

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+[ -f Brewfile ] && brew bundle
+
+rbenv install -s
+gem install --conservative bundler
+bundle install
+
+set +vxeu
+echo
+
+# That's all Folks!

data/exe/git-switcher

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git/switcher'
+
+def putm(message, color = :to_s)
+  return if message.strip.empty?
+
+  puts '', Rainbow(message).send(color)
+  print Rainbow('Press ⏎ to continue ... ').italic
+  $stdin.gets
+end
+
+repo = Rugged::Repository.new(Dir.pwd)
+menu = Git::Switcher::Menu.for(repo)
+
+# (optional) script to run after every checkout
+switcher = File.join(repo.workdir, '.switcher')
+
+loop do
+  print "\e[H\e[2J", menu, "\n", "\n" # clear the screen first (^L)
+
+  if (default_menu_item = menu.default_menu_item)
+    default_shortcut = format('⏎ [%2s]', default_menu_item.shortcut)
+    print Rainbow(default_shortcut).bold.steelblue, ' '
+  end
+  print "\t", Rainbow('your selection =>').steelblue, ' '
+
+  response = begin
+               $stdin.gets&.strip
+             rescue Interrupt
+               nil
+             end
+
+  break unless response # ^C and ^D
+
+  menu_item = if response.empty?
+                default_menu_item
+              else
+                menu[response]
+              end
+
+  next unless menu_item
+
+  err_msg = `2>&1 git checkout --quiet #{menu_item.reference.name}`
+  if $CHILD_STATUS.success? && File.executable?(switcher)
+    cmd_msg = `2>&1 #{switcher}`
+    putm(cmd_msg, :green)
+  else
+    putm(err_msg, :red)
+  end
+end
+
+# That's all Folks!

data/git-switcher.gemspec

@@ -1,50 +1,32 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'git-switcher/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "git-switcher"
-  gem.version       = Git::Switcher::VERSION
-  gem.authors       = ["Peter Vandenberk"]
-  gem.email         = ["pvandenberk@mac.com"]
-  gem.description   = %q{Git command that implements a visual CLI and REPL for easily switching between git tags and branches}
-  gem.summary       = %q{Visual CLI and REPL for switching between git tags and branches}
-  gem.homepage      = "https://github.com/pvdb/git-switcher"
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_dependency('methadone')
-  gem.add_dependency('rugged')
-  gem.add_dependency('trollop')
-
-  # for developing
-  gem.add_development_dependency('rdoc')
-  gem.add_development_dependency('awesome_print')
-
-  # for debugging
-  gem.add_development_dependency('pry')
-  gem.add_development_dependency('pry-debugger')
-  gem.add_development_dependency('pry-stack_explorer')
-
-  # for testing
-  gem.add_development_dependency('rspec')
-  gem.add_development_dependency('cucumber')
-  gem.add_development_dependency('aruba')
-
-  # for monitoring
-  gem.add_development_dependency('guard')
-  gem.add_development_dependency('growl')
-  gem.add_development_dependency('rb-fsevent')
-  gem.add_development_dependency('rb-readline')
-
-  # for TDD/BDD/CI
-  gem.add_development_dependency('guard-rspec')
-  gem.add_development_dependency('guard-cucumber')
-  gem.add_development_dependency('rspec-pride')
-  gem.add_development_dependency('cucumber-pride')
-
+require 'git/switcher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = Git::Switcher::NAME
+  spec.version       = Git::Switcher::VERSION
+  spec.authors       = ['Peter Vandenberk']
+  spec.email         = ['pvandenberk@mac.com']
+
+  spec.summary       = 'The ultimate CLI git branch and tag switcher'
+  spec.description   = 'Easily switch between git tags and branches'
+  spec.homepage      = 'https://github.com/pvdb/git-switcher'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rainbow', '~> 3.0'
+  spec.add_dependency 'rugged', '~> 0.27'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
 end

data/lib/ext/rugged.rb

@@ -0,0 +1,15 @@
+module Rugged
+  class Reference
+    def local?
+      !remote?
+    end
+
+    def time
+      target.time
+    end
+
+    def targets?(reference)
+      target == reference.target
+    end
+  end
+end

data/lib/git/switcher/menu.rb

@@ -0,0 +1,102 @@
+module Git
+  module Switcher
+    class Menu
+
+      Submenu = Struct.new(:label, :menu_items) do
+        def to_s
+          header = Rainbow(label).steelblue
+          "\n\t#{header}\n\n" + menu_items.join("\n")
+        end
+      end
+
+      MenuItem = Struct.new(:repo, :shortcut, :reference, :next) do
+        HEAD = Rainbow(' <- HEAD ***').bold.aquamarine.freeze
+
+        def head?
+          reference.targets?(repo.head)
+        end
+
+        def to_s
+          name = reference.name
+          label = format('[%2s]', shortcut)
+          format(
+            "  %<label>s\t%<name>s%<head>s",
+            label: head? ? Rainbow(label).bold : label,
+            name: head? ? Rainbow(name).inverse : name,
+            head: head? ? HEAD : '',
+          )
+        end
+      end
+
+      def self.for(repo)
+        new(repo)
+      end
+
+      def initialize(repo)
+        @repo = repo
+
+        remote_branches = @repo.branches.find_all(&:remote?)
+        local_branches = @repo.branches.find_all(&:local?)
+
+        @submenus = [
+          submenu_for('REMOTE BRANCHES', remote_branches, shortcuts('a')),
+          submenu_for('LOCAL BRANCHES', local_branches, shortcuts(1)),
+          submenu_for('TAGS', @repo.tags, shortcuts(100)),
+        ].compact
+
+        @menu_items = @submenus.map(&:menu_items).flatten
+
+        @lookup = Hash[@menu_items.map(&:shortcut).zip(@menu_items)]
+      end
+
+      def [](shortcut)
+        @lookup[shortcut]
+      end
+
+      def head_menu_item
+        @menu_items.find(&:head?)
+      end
+
+      def default_menu_item
+        head_menu_item&.next
+      end
+
+      def to_s
+        @submenus.join("\n")
+      end
+
+      private
+
+      def shortcuts(initial)
+        shortcut = initial
+        Enumerator.new do |yielder|
+          loop do
+            yielder << shortcut
+            shortcut = case shortcut
+                       when Integer then shortcut + 1
+                       when String then (shortcut.ord + 1).chr
+                       end
+          end
+        end
+      end
+
+      def submenu_for(label, references, shortcuts)
+        return unless references.any?
+
+        Submenu.new(label, menu_items_for(references, shortcuts))
+      end
+
+      def menu_items_for(references, shortcuts)
+        previous_menu_item = nil
+        references.sort_by(&:time).map { |reference|
+          shortcut = shortcuts.next.to_s
+          next_menu_item = MenuItem.new(@repo, shortcut, reference, nil)
+          previous_menu_item&.next = next_menu_item
+          previous_menu_item = next_menu_item
+          next_menu_item
+        }
+      end
+
+    end
+  end
+end

data/lib/git/switcher/version.rb

@@ -0,0 +1,10 @@
+module Git
+  module Switcher
+    NAME = 'git-switcher'.freeze
+    VERSION = '1.0.0'.freeze
+
+    def self.version
+      "#{NAME} v#{VERSION}"
+    end
+  end
+end

data/lib/git/switcher.rb

@@ -0,0 +1,15 @@
+require 'English'
+
+require 'rainbow'
+require 'rugged'
+
+require 'ext/rugged'
+
+module Git
+  module Switcher
+    class Error < StandardError; end
+  end
+end
+
+require 'git/switcher/version'
+require 'git/switcher/menu'