git_auto_checkout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc2d259e57441831e2508602620f44fe6389a579
+  data.tar.gz: 7110b85ae44612489fc2af228965d4e792771756
+SHA512:
+  metadata.gz: 0b6df09b625bbf784fde84e8ef6eedd9505dcd1d92a19840f2309f9a2ebb714e1ce93c48dc0dda573f7746ff224641423e73151901ce69da890b2945472779d1
+  data.tar.gz: 251532dd6b62f0ad2b28535149ec21eab3d4e04334e026dbdcd3170bc8e0944dcc85bc43058e3b58cfedf35182881e71f82753d88180efec619f0881a714e164

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.sh

data/LICENSE.md

@@ -0,0 +1,27 @@
+Copyright (c) 2014, Sam Rossi
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of git_auto_checkout nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,25 @@
+# Installation
+
+The repostory is a typical Ruby gem, so it can be installed by cloning and
+locally building the .gem file. As of right now, the gem is *not* published on
+rubygems.org, so `gem install git_auto_checkout` won't work. I expect to publish
+it there sometime soon, but for now, folllow these steps to install:
+
+## Prerequisites
+
+You must have git installed on your system, as well as the "gem" command
+available.
+
+## Then run the following commands in your terminal
+
+1. `git clone https://github.com/saghmrossi/git_auto_checkout/`
+2. `cd git_auto_checkout`
+3. `gem build git_auto_checkout.gemspec`
+4. `gem install --local git_auto_checkout*.gem`
+
+# Usage
+
+Assuming your gem paths are set up properly, the gem installation makes the
+"git_auto_checkout" executable available to you from anywhere. Run it in a
+directory that is a git repository and follow the prompts to checkout branches
+or past commits.

data/bin/git_auto_checkout

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'git_auto_checkout'
+rescue LoadError
+  require 'rubygems'
+  require 'git_auto_checkout'
+end
+
+GitAutoCheckout.run

data/git_auto_checkout.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path('../lib, __FILE__')
+
+Gem::Specification.new do |s|
+  s.name        = 'git_auto_checkout'
+  s.version     = '0.1.0'
+  s.license     = 'BSD 3-Clause'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Saghm Rossi']
+  s.email       = ['saghmrossi@gmail.com']
+  s.homepage    = ''
+  s.summary     = %q{Helper to checkout out old commits.}
+  s.description = %q{
+                      Gives a console-based prompt of all of the past commits,
+                      and allows the user to select one to checkout.
+                    }
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+                       File.basename(f)
+                     end
+  s.require_paths = ['lib']
+end

data/lib/git_auto_checkout/git_checkout_helper.rb

@@ -0,0 +1,220 @@
+require 'git_auto_checkout/git_commit'
+
+module GitAutoCheckout
+  class GitCheckoutHelper
+    # Internal: Gets the Array of GitCommits.
+    attr_reader :commits
+
+    # Internal: Intialize a CheckoutHelper.
+    def initialize(page_size = 8)
+      @page_size = page_size
+      log        = `git log`.split("\n")
+      
+      parse_all_commits(log)
+      get_git_branches
+    end
+
+    # Internal: Prompt the user to select a past commit or quit, and checkout
+    # the past commit if one was selected.
+    #
+    # Returns nothing.
+    def make_commit
+      commit_or_branch = prompt_user_until_quit_or_commit_selection
+      return unless commit_or_branch
+
+      git_checkout(commit_or_branch)
+    end
+
+    private
+
+    # Internal: Go through all the commits and parses out the hash strings and
+    # messages.
+    #
+    # log - String output of `git log`.
+    #
+    # Returns nothing (adds commits directly to instance variable.
+    def parse_all_commits(log)
+      @commits  = []
+      @commits << parse_one_commit(log) until log.empty?
+
+      # Show commits newest to oldest.
+      @commits.reverse
+    end
+
+    # Internal: Prompts user for selection of a past commit.
+    #
+    # idx   - Which commit index to start listing from.
+    # error - Incorrect input String previously given, or nil if there was none.
+    #
+    # Returns hash String of selected commit, or false if none was chosen.
+    # Raises error (through #parse_one_commit if the log String is malformed
+    # (e.g. each commit message is not preceded and succeeded by an empty line).
+    # Raises error (through #parse_commit_hash) if no commit was found.
+    def prompt_user_until_quit_or_commit_selection(idx = 0, error=false)
+      print_commit_prompt(idx, error)
+
+      selection = gets.chomp!
+      number    = selection.to_i
+      selection = number if selection == '0' || number != 0
+
+      return case selection
+             when 'b'
+               prompt_user_until_quit_or_branch_selection
+             when 'q'
+               false
+             when 'p'
+               idx = [idx - @page_size, 0].max
+               prompt_user_until_quit_or_commit_selection(idx, false)
+             when 'n'
+               idx = [idx + @page_size, commits.size - @page_size].min
+               idx = [idx, 0].max
+               prompt_user_until_quit_or_commit_selection(idx, false)
+             when idx...idx + @page_size
+               @commits[selection.to_i].hash_string
+             else
+               selection = invalid_entry(selection)
+               prompt_user_until_quit_or_commit_selection(idx, selection)
+             end
+    end
+
+    # Internal: Report error if there is one, and prompts user for input.
+    #
+    # idx   - Which commit index to start listing from.
+    # error - Incorrect input String previously given, or nil if there was none.
+    #
+    # Returns nothing.
+    def print_commit_prompt(idx, error)
+      system 'clear'
+
+      puts error if error
+      puts 'Enter a number to checkout that commit'
+      puts 'Enter "b" to see a list of branches to checkout'
+      puts 'Enter "p" to scroll to the previous set of commits'
+      puts 'Enter "n" to scroll to the next set of commits'
+      puts 'Enter "q" to quit without checking out anything'
+      puts '----------------------------------------------'
+
+      @commits[idx...idx + @page_size].each_with_index do |commit, i|
+        puts "#{idx + i}: #{commit.message}"
+      end
+    end
+
+    # Internal: Remove and parse the first commit from the log and returns it
+    # serialized into a GitCommit.
+    #
+    # log - String output of `git log`.
+    #
+    # Returns the GitCommit parsed from the log.
+    # Raises error if the log String is malformed (e.g. each commit message is
+    # not preceded and succeeded by an empty line).
+    # Raises error (through #parse_commit_hash) if no commit was found.
+    def parse_one_commit(log)
+      commit, idx = parse_commit_hash(log)
+      log.slice!(0, idx)
+
+      log.each_with_index do |line, i|
+        next unless line.empty?
+
+        commit.message = log[i + 1].strip
+        raise 'weird message ending' if log[i + 2] && !log[i + 2].empty?
+
+        log.slice!(0, i + 2)
+
+        return commit
+      end
+
+      raise 'no message found'
+    end
+
+    # Internal: Parse the hash string of the first commt in the log.
+    #
+    # log - String output of `git log`.
+    #
+    # Returns the newly created GitCommit and the index of the first line after
+    # the hash String found.
+    # Raises error if no commit was found.
+    def parse_commit_hash(log)
+      commit = GitCommit.new
+
+      log.each_with_index do |line, i|
+        line = line.split
+        next unless line.first == 'commit'
+
+        commit.hash_string = line.last
+        return commit, i + 1
+      end
+
+      raise 'no commit found'
+    end
+
+    # Internal: Checkouts out a past commit specified by the hash string.
+    #
+    # commit_hash_string - String of past git commit to checkout.
+    #
+    # Returns nothing.
+    def git_checkout(commit_or_branch)
+      system 'clear'
+      `git checkout #{commit_or_branch}`
+    end
+
+    def get_git_branches
+      @branches = `git branch`.split("\n").reject { |branch| branch.chr == "*" }
+      @branches.map!(&:strip)
+    end
+
+    def prompt_user_until_quit_or_branch_selection(idx = 0, error=false)
+      if @branches.empty?
+        return prompt_user_until_quit_or_commit_selection(
+                 0,
+                 'No other branches exist'
+               )
+      end
+
+      print_branch_prompt(idx, error)
+
+      selection = gets.chomp!
+      number    = selection.to_i
+      selection = number if selection == '0' || number != 0
+
+      return case selection
+             when 'c'
+               prompt_user_until_quit_or_commit_selection
+             when 'q'
+               false
+             when 'p'
+               idx = [idx - @page_size, 0].max
+               prompt_user_until_quit_or_branch_selection(idx, false)
+             when 'n'
+               idx = [idx + @page_size, commits.size - @page_size].min
+               prompt_user_until_quit_or_branch_selection(idx, false)
+             when idx...idx + @page_size
+               @branches[selection.to_i]
+             else
+               selection = invalid_entry(selection)
+               prompt_user_until_quit_or_branch_selection(idx, selection)
+             end
+    end
+
+
+    def print_branch_prompt(idx, error)
+      system 'clear'
+
+      puts error if error
+      puts 'Enter a number to checkout that branch'
+      puts 'Enter "c" to see a list of commits to checkout'
+      puts 'Enter "p" to scroll to the previous set of commits'
+      puts 'Enter "n" to scroll to the next set of commits'
+      puts 'Enter "q" to quit without checking out anything'
+      puts '----------------------------------------------'
+
+      @branches[idx...idx + @page_size].each_with_index do |branch, i|
+        puts "#{idx + i}: #{branch}"
+      end
+    end
+
+    def invalid_entry(error)
+      "Invalid entry \"#{error}\"; try again"
+    end
+  end # End class
+end # End module
+1

data/lib/git_auto_checkout/git_commit.rb

@@ -0,0 +1,9 @@
+module GitAutoCheckout
+  class GitCommit
+    # Internal: Gets/Sets the hash String of this GitCommit.
+    attr_accessor :hash_string
+
+    # Internal: Gets/Sets the message String of this GitCommit.
+    attr_accessor :message
+  end
+end

data/lib/git_auto_checkout.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'git_auto_checkout/git_checkout_helper'
+
+module GitAutoCheckout
+  module_function
+
+  def run
+    if `git rev-parse --is-inside-work-tree 2>&1`.split.first == "fatal:"
+      $stderr.puts "Error: current directory is not a git repository"
+      exit 1
+    end
+
+    git_checkout_helper = GitCheckoutHelper.new
+    git_checkout_helper.make_commit
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: git_auto_checkout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Saghm Rossi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-01 00:00:00.000000000 Z
+dependencies: []
+description: "\n                      Gives a console-based prompt of all of the past
+  commits,\n                      and allows the user to select one to checkout.\n
+  \                   "
+email:
+- saghmrossi@gmail.com
+executables:
+- git_auto_checkout
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.md
+- README.md
+- bin/git_auto_checkout
+- git_auto_checkout.gemspec
+- lib/git_auto_checkout.rb
+- lib/git_auto_checkout/git_checkout_helper.rb
+- lib/git_auto_checkout/git_commit.rb
+homepage: ''
+licenses:
+- BSD 3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Helper to checkout out old commits.
+test_files: []