git-smart 0.1.5 → 0.1.6

data/README.md

@@ -7,15 +7,14 @@ Adds some additional git commands to add some smarts to your workflow. These com
 0. It should do the 'right thing' in all situations - an inexperienced git user should be guided away from making simple mistakes.
 0. It should make every attempt to explain to the user what decisions it has made, and why.
 0. All git commands that modify the repository should be shown to the user - hopefully this helps the user eventually learn the underlying git commands, and when they're relevant.
-0. All git commands, destructive or not, and their output should be shown to the user with the -v/--verbose flag. (not implemented yet)
 
-# Installing
+## Installing
 
 All you need to do is grab the gem:
 
     gem install git-smart
 
-That'll put an executable file for each command as a gem executable. They can be removed by uninstalling the gem.
+This will add an executable for each command, e.g. `git-smart-pull`. You call them using git's simple syntax for [custom commands](http://www.nullstyle.com/2007/06/22/create-custom-commands-in-git/), e.g. `git smart-pull`. They'll be removed when you uninstall the gem.
 
 You almost certainly want to run this as well, to allow git commands to be output with colour:
 
@@ -23,21 +22,37 @@ You almost certainly want to run this as well, to allow git commands to be outpu
 
 Git normally only colours output when being run from the terminal, not from within scripts like these. This sorts that right out.
   
-# Using
+## Get smart!
 
-Git allows custom commands with a simple convention - `git xyz` tries to find an executable `git-xyz` on the path. So, to run the commands, simply type
+There's only three commands at this point, but there'll be more!
 
-    git smart-pull
-    git smart-merge <branchname>
+### smart-pull
 
-# Documentation
+Run `git smart-pull` whenever you would have run `git pull`. It doesn't take any arguments, it'll use the tracking branch configuration or assume 'origin/same-branch-name'.
 
-The code for each of these commands has been annotated with comments and rendered with [Rocco](https://github.com/rtomayko/rocco):
+In brief, it'll detect the best way to grab the changes from the server and update your local branch, using a `git rebase -p` if there's no easier way. It'll also stash/pop local changes if need be.
 
-- [smart-pull](http://github-displayer.heroku.com/geelen/git-smart/raw/master/docs/smart-pull.html)
-- [smart-merge](http://github-displayer.heroku.com/geelen/git-smart/raw/master/docs/smart-merge.html)
+Read what it does in detail: [smart-pull](http://github-displayer.heroku.com/geelen/git-smart/raw/master/docs/smart-pull.html)
 
-# Contributing to git-smart
+Recommended alias to use: `gup`
+
+### smart-merge
+
+Run `git smart-merge` when you would have run `git merge`. This is basically a wrapper around `git merge --no-ff`, which should have been the default anyway. It also does a stash/pop if required, and reports a bit of helpful output.
+
+Details here: [smart-merge](http://github-displayer.heroku.com/geelen/git-smart/raw/master/docs/smart-merge.html)
+
+Recommended alias to use: `gm`
+
+### smart-log
+
+Big hat tip to [@ben\_h](http://twitter.com/ben_h) for this one - it's an alias to a completely badass git log format that not many people know about.
+
+Details here: [smart-log](http://github-displayer.heroku.com/geelen/git-smart/raw/master/docs/smart-log.html)
+
+Recommended alias to use: `gl`
+
+## Contributing to git-smart
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
@@ -47,7 +62,7 @@ The code for each of these commands has been annotated with comments and rendere
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-# Copyright
+## Copyright
 
 Copyright (c) 2011 Glen Maddern. See LICENSE.txt for
 further details.

data/Rakefile

@@ -47,7 +47,9 @@ end
 
 desc "Generate the rocco docs"
 task :rocco do
-  %x[cd lib/commands && rocco *.rb -o ../../docs]
+  base_dir = File.dirname(__FILE__)
+  %x[cd #{base_dir}/lib/commands && rocco *.rb -o ../../docs]
+  %x[cd #{base_dir} && git add docs]
 end
 
 task :release => :rocco
@@ -72,6 +74,7 @@ GitSmart.run('#{cmd}', ARGV)
 }
     }
     `chmod a+x #{filename}`
+    `cd #{base_dir} && git add #{filename}`
     puts "Wrote #{filename}"
   }
 end

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/bin/git-smart-log

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.join(File.expand_path(File.dirname(__FILE__)), '..', 'lib'))
+
+require 'git-smart'
+
+GitSmart.run('smart-log', ARGV)

data/docs/smart-pull.html

@@ -161,6 +161,20 @@ uses internally.</p>
         <div class="octowrap">
           <a class="octothorpe" href="#section-11">#</a>
         </div>
+        <p>Report how many commits are new locally, since that&rsquo;s useful information.</p>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre>    <span class="n">new_commits_locally</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">rev_list</span><span class="p">(</span><span class="n">merge_base</span><span class="p">,</span> <span class="n">head</span><span class="p">)</span>
+    <span class="k">if</span> <span class="o">!</span><span class="n">new_commits_locally</span><span class="o">.</span><span class="n">empty?</span>
+      <span class="n">note</span> <span class="s2">&quot;You have </span><span class="si">#{</span><span class="n">new_commits_locally</span><span class="o">.</span><span class="n">length</span><span class="si">}</span><span class="s2"> new commit</span><span class="si">#{</span><span class="s1">&#39;s&#39;</span> <span class="k">if</span> <span class="n">new_commits_locally</span><span class="o">.</span><span class="n">length</span> <span class="o">!=</span> <span class="mi">1</span><span class="si">}</span><span class="s2"> on &#39;</span><span class="si">#{</span><span class="n">branch</span><span class="si">}</span><span class="s2">&#39;.&quot;</span>
+    <span class="k">end</span></pre></div>
+      </td>
+    </tr>
+    <tr id='section-12'>
+      <td class=docs>
+        <div class="octowrap">
+          <a class="octothorpe" href="#section-12">#</a>
+        </div>
         <p>By comparing the merge_base to both HEAD and the remote, we can
 determine whether both or only one have moved on.
 If the remote hasn&rsquo;t changed, we&rsquo;re already up to date, so there&rsquo;s nothing
@@ -173,14 +187,14 @@ to pull.</p>
     <span class="k">else</span></pre></div>
       </td>
     </tr>
-    <tr id='section-12'>
+    <tr id='section-13'>
       <td class=docs>
         <div class="octowrap">
-          <a class="octothorpe" href="#section-12">#</a>
+          <a class="octothorpe" href="#section-13">#</a>
         </div>
         <p>If the remote <em>has</em> moved on, we actually have some work to do:</p>
 
-<p>First, report how many commits are new on remote. Because that&rsquo;s useful information.</p>
+<p>First, report how many commits are new on remote. Because that&rsquo;s useful information, too.</p>
       </td>
       <td class=code>
         <div class='highlight'><pre>      <span class="n">new_commits_on_remote</span> <span class="o">=</span> <span class="n">repo</span><span class="o">.</span><span class="n">rev_list</span><span class="p">(</span><span class="n">merge_base</span><span class="p">,</span> <span class="n">remote</span><span class="p">)</span>
@@ -188,10 +202,10 @@ to pull.</p>
       <span class="n">note</span> <span class="s2">&quot;There </span><span class="si">#{</span><span class="n">is_are</span><span class="si">}</span><span class="s2"> </span><span class="si">#{</span><span class="n">new_commits_on_remote</span><span class="o">.</span><span class="n">length</span><span class="si">}</span><span class="s2"> new commit</span><span class="si">#{</span><span class="n">s_or_not</span><span class="si">}</span><span class="s2"> on &#39;</span><span class="si">#{</span><span class="n">upstream_branch</span><span class="si">}</span><span class="s2">&#39;.&quot;</span></pre></div>
       </td>
     </tr>
-    <tr id='section-13'>
+    <tr id='section-14'>
       <td class=docs>
         <div class="octowrap">
-          <a class="octothorpe" href="#section-13">#</a>
+          <a class="octothorpe" href="#section-14">#</a>
         </div>
         <p>Next, detect if there are local changes and stash them.</p>
       </td>
@@ -205,10 +219,10 @@ to pull.</p>
       <span class="n">success_messages</span> <span class="o">=</span> <span class="o">[]</span></pre></div>
       </td>
     </tr>
-    <tr id='section-14'>
+    <tr id='section-15'>
       <td class=docs>
         <div class="octowrap">
-          <a class="octothorpe" href="#section-14">#</a>
+          <a class="octothorpe" href="#section-15">#</a>
         </div>
         <p>Then, bring the local branch up to date.</p>
 
@@ -222,10 +236,10 @@ to pull.</p>
       <span class="k">else</span></pre></div>
       </td>
     </tr>
-    <tr id='section-15'>
+    <tr id='section-16'>
       <td class=docs>
         <div class="octowrap">
-          <a class="octothorpe" href="#section-15">#</a>
+          <a class="octothorpe" href="#section-16">#</a>
         </div>
         <p>If our local branch has new commits, we need to rebase them on top of master.</p>
 
@@ -239,10 +253,10 @@ instead of ignoring them. For a description as to why, see my <a href="(https://
       <span class="k">end</span></pre></div>
       </td>
     </tr>
-    <tr id='section-16'>
+    <tr id='section-17'>
       <td class=docs>
         <div class="octowrap">
-          <a class="octothorpe" href="#section-16">#</a>
+          <a class="octothorpe" href="#section-17">#</a>
         </div>
         <p>If we stashed before, pop now.</p>
       </td>
@@ -253,19 +267,34 @@ instead of ignoring them. For a description as to why, see my <a href="(https://
       <span class="k">end</span></pre></div>
       </td>
     </tr>
-    <tr id='section-17'>
+    <tr id='section-18'>
       <td class=docs>
         <div class="octowrap">
-          <a class="octothorpe" href="#section-17">#</a>
+          <a class="octothorpe" href="#section-18">#</a>
         </div>
         <p>Display a nice completion message in large, friendly letters.</p>
-
       </td>
       <td class=code>
         <div class='highlight'><pre>      <span class="n">success</span> <span class="o">[</span><span class="s2">&quot;All good.&quot;</span><span class="p">,</span> <span class="o">*</span><span class="n">success_messages</span><span class="o">].</span><span class="n">join</span><span class="p">(</span><span class="s2">&quot; &quot;</span><span class="p">)</span>
-    <span class="k">end</span>
+    <span class="k">end</span></pre></div>
+      </td>
+    </tr>
+    <tr id='section-19'>
+      <td class=docs>
+        <div class="octowrap">
+          <a class="octothorpe" href="#section-19">#</a>
+        </div>
+        <p>Still to do:</p>
+
+<ul>
+<li>Ensure ORIG_HEAD is correctly set at the end of each run.</li>
+<li>If the rebase fails, and you&rsquo;ve done a stash, remind the user to unstash</li>
+</ul>
+
 
-  <span class="k">end</span>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre>  <span class="k">end</span>
 <span class="k">end</span></pre></div>
       </td>
     </tr>

data/git-smart.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = %q{git-smart}
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Glen Maddern"]
-  s.date = %q{2011-01-05}
+  s.date = %q{2011-01-06}
   s.description = %q{Installs some additional 'smart' git commands, like `git smart-pull`.}
   s.email = %q{glenmaddern@gmail.com}
-  s.executables = ["git-smart-pull", "git-smart-merge"]
+  s.executables = ["git-smart-log", "git-smart-pull", "git-smart-merge"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -24,12 +24,14 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "bin/git-smart-log",
     "bin/git-smart-merge",
     "bin/git-smart-pull",
     "docs/images/git-smart.png",
     "docs/smart-merge.html",
     "docs/smart-pull.html",
     "git-smart.gemspec",
+    "lib/commands/smart-log.rb",
     "lib/commands/smart-merge.rb",
     "lib/commands/smart-pull.rb",
     "lib/core_ext/array.rb",

data/lib/commands/smart-log.rb

@@ -0,0 +1,9 @@
+#This is a super simple alias for the most badass of log outputs that git
+#offers. Uses git log --graph under the hood.
+#
+#Thanks to [@ben_h](http://twitter.com/ben_h) for this one!
+GitSmart.register 'smart-log' do |repo, args|
+  #Super simple, passes the args through to git log, but
+  #ratchets up the badassness quotient.
+  repo.log_to_shell('--pretty=format:%Cblue%h%d%Creset %ar %Cgreen%an%Creset %s', '--graph', *args)
+end

data/lib/commands/smart-pull.rb

@@ -105,5 +105,10 @@ GitSmart.register 'smart-pull' do |repo, args|
       success ["All good.", *success_messages].join(" ")
     end
 
+    #Still to do:
+    #
+    #* Ensure ORIG_HEAD is correctly set at the end of each run.
+    #* If the rebase fails, and you've done a stash, remind the user to unstash
+
   end
 end

data/lib/git-smart/git_repo.rb

@@ -89,12 +89,16 @@ class GitRepo
     git!('rebase', '-p', upstream)
   end
 
-  def log(nr)
+  def read_log(nr)
     git('log', '--oneline', '-n', nr.to_s).split("\n").map { |l| l.split(" ",2) }
   end
 
-  def log_commit_messages(nr)
-    log(nr).map(&:last)
+  def last_commit_messages(nr)
+    read_log(nr).map(&:last)
+  end
+
+  def log_to_shell(*args)
+    git_shell('log', *args)
   end
 
   def merge_no_ff!(target)
@@ -116,6 +120,13 @@ class GitRepo
     output
   end
 
+  def git_shell(*args)
+    puts "Executing: #{['git', *args].join(" ")}"
+    Dir.chdir(@dir) {
+      system('git', *args)
+    }
+  end
+
   def config(name)
     remote = git('config', name).chomp
     remote.empty? ? nil : remote

data/spec/spec_helper.rb

@@ -53,12 +53,12 @@ end
 
 RSpec::Matchers.define :have_last_few_commits do |expected|
   failure_message_for_should do |dir|
-    "expected '#{dir}' to have last few commits of #{expected.inspect}, got #{GitRepo.new(dir).log_commit_messages(expected.length).inspect}"
+    "expected '#{dir}' to have last few commits of #{expected.inspect}, got #{GitRepo.new(dir).last_commit_messages(expected.length).inspect}"
   end
   failure_message_for_should_not do |actual|
-    "expected '#{dir}' to not have git status of #{expected.inspect}, got #{GitRepo.new(dir).log_commit_messages(expected.length).inspect}"
+    "expected '#{dir}' to not have git status of #{expected.inspect}, got #{GitRepo.new(dir).last_commit_messages(expected.length).inspect}"
   end
   match do |dir|
-    GitRepo.new(dir).log_commit_messages(expected.length) == expected
+    GitRepo.new(dir).last_commit_messages(expected.length) == expected
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: git-smart
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Glen Maddern
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-05 00:00:00 +11:00
+date: 2011-01-06 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -111,6 +111,7 @@ dependencies:
 description: Installs some additional 'smart' git commands, like `git smart-pull`.
 email: glenmaddern@gmail.com
 executables: 
+- git-smart-log
 - git-smart-pull
 - git-smart-merge
 extensions: []
@@ -125,12 +126,14 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- bin/git-smart-log
 - bin/git-smart-merge
 - bin/git-smart-pull
 - docs/images/git-smart.png
 - docs/smart-merge.html
 - docs/smart-pull.html
 - git-smart.gemspec
+- lib/commands/smart-log.rb
 - lib/commands/smart-merge.rb
 - lib/commands/smart-pull.rb
 - lib/core_ext/array.rb