gitsu 0.0.1

data/lib/gitsu/user.rb

@@ -0,0 +1,55 @@
+module GitSu
+    class User
+        NONE = User.new
+        def NONE.to_s
+            "(none)"
+        end
+        def NONE.to_ansi_s(name_color, email_color, reset_color)
+            "#{name_color}(none)#{reset_color}"
+        end
+
+        class ParseError < RuntimeError
+        end
+
+        attr_accessor :name, :email
+
+        def User.parse(string)
+            fully_qualified_user_regex = /^[^<]+<[^>]+>$/ 
+            if string =~ fully_qualified_user_regex
+                name = string[/^[^<]+/].strip
+                email = string[/<.*>/].delete "[<>]" 
+                User.new(name, email)
+            else
+                raise ParseError, "Couldn't parse '#{string}' as user (expected user in format: 'John Smith <jsmith@example.com>')"
+            end
+        end
+
+        def initialize(name, email)
+            @name, @email = name, email
+        end
+
+        def none?
+            self === NONE
+        end
+
+        def ==(other)
+            eql? other
+        end
+
+        def eql?(other)
+            @name == other.name && @email == other.email
+        end
+
+        def hash
+            to_s.hash
+        end
+
+        def to_ansi_s(name_color, email_color, reset_color)
+            "#{name_color}#{@name}#{reset_color} #{email_color}<#{@email}>#{reset_color}"
+        end
+
+        def to_s
+            to_ansi_s("", "", "")
+        end
+    end
+end

data/lib/gitsu/user_file.rb

@@ -0,0 +1,32 @@
+require 'fileutils'
+require 'yaml'
+
+module GitSu
+    class UserFile
+        def initialize(file_name)
+            @file = file_name
+            unless File.exist? file_name
+                FileUtils.touch file_name
+            end
+            if File.size(file_name) == 0
+                File.open(file_name, "w") do |file|
+                    file << "\n"
+                end
+            end
+        end
+
+        def write(user)
+            File.open(@file, "a") do |file|
+                file.write "\n#{user.email} : #{user.name}"
+            end
+        end
+
+        def read
+            yaml_list = YAML.load_file(@file) or return []
+            yaml_list.map do |email, name|
+                User.new(name, email)
+            end
+        end
+    end
+end
+

data/lib/gitsu/user_list.rb

@@ -0,0 +1,47 @@
+module GitSu
+    class UserList
+        def initialize(file_name)
+            @user_file = UserFile.new(file_name) 
+        end
+
+        def add(user)
+            @user_file.write(user)
+        end
+
+        def list
+            @user_file.read
+        end
+
+        def find(search_term)
+            users = @user_file.read
+            matching_users = []
+            match_strategies.each do |strategy|
+                matching_users += users.select { |user| strategy.call(search_term, user) }
+            end
+            matching_users.first || User::NONE
+        end
+
+        def match_strategies
+            [
+            # Whole word of name
+            lambda { |search_term, user| user.name =~ /\b#{search_term}\b/i },
+
+            # Beginning of word in name
+            lambda { |search_term, user| user.name =~ /\b#{search_term}/i },
+
+            # Initials
+            lambda do |search_term, user|
+                initials = user.name.downcase.split(" ").map { |word| word.chars.first }.join
+                initials.include? search_term.downcase
+            end,
+
+            # Segment anywhere in name or email
+            lambda do |search_term, user|
+                name_and_email = "#{user.name} #{user.email}".downcase
+                name_and_email.include? search_term.downcase
+            end
+            ]
+        end
+    end
+end
+

data/lib/gitsu/version.rb

@@ -0,0 +1,3 @@
+module GitSu
+    VERSION = "0.0.1"
+end

data/man/git-su.1.ronn

@@ -0,0 +1,120 @@
+git-su(1) -- Manage your Git Users
+========================================================
+
+## SYNOPSIS
+
+git su [OPTIONS] [user]
+
+## DESCRIPTION
+
+Gitsu helps you to manage your projects' Git users.
+
+* quickly see which user Git will use to commit
+* quickly switch between Git users
+* configure a list of Git users to switch between
+
+## OPTIONS
+
+-a, --add USER
+    Add a user to the Gitsu users. Should be in the format "John Galt <jgalt@example.com>". You can quickly switch to one of these users by supplying a user argument to git-su.
+
+-c, --clear
+    Clear all Git users. If a scope (--local, --global, or --system) is specified, only clear that scope's user.
+
+-e, --edit
+    Open the Gitsu config in an editor. This is the same editor that Git is configured to use for config files.
+
+-h, --help
+    Show help.
+
+-l, --local, -g, --global, -s, --system 
+    Specify the scope for printing, switching, or clearing selected users.
+
+-t, --list
+    List the Gitsu users.
+
+## CONFIGURATION
+
+Gitsu supports the following configuration options, specified either in Git config files, or by executing `git config`:
+
+git-su.defaultSelectScope
+    One of "local", "global", or "system" (without quotes). Specifies the default scope that the user is switched in when `git su` is run.
+
+color.ui
+    Gitsu respects the value of color.ui in the same way Git does. That is, output is colored only if color.ui is set to true, and stdout is a tty.
+
+## HOMEPAGE
+
+http://drrb.github.com/gitsu
+
+## EXAMPLES
+
+Show current Git users in all scopes
+
+`$ git su`
+
+Show the current Git users in specified scopes
+
+`$ git su --local --global`
+
+Show the current Git user that Git would use to commit
+
+`$ git whoami`
+
+### Adding users
+
+To add a user to Gitsu (the user will be saved in ~/.gitsu)
+
+`$ git su --add 'Raphe Rackstraw <rrack@example.com>'`
+
+You can also add users manually to ~/.gitsu in the following format:
+
+    jporter@example.com: Sir Joseph Porter KCB 
+
+    rrack@example.com: Raphe Rackstraw
+
+### Switching users
+
+Switch to configured users by initials
+
+`$ git su jp`
+
+`Switched to Joseph Porter KCB <jporter@example.com>`
+
+or by part of their name
+
+`$ git su straw`
+
+`Switched to Raphe Rackstraw <rrack@example.com>`
+
+To clear all Git users
+
+`$ git su --clear`
+
+`Clearing all users from Git config`
+
+### Scopes
+
+Gitsu supports Git's configuration scopes: local (current repository), global (current OS user), and system (everyone on the system). As in Git, if you don't specify a scope, local scope is assumed.
+
+To change the user for a specific scope
+
+`$ git su joe --system`
+
+`Switched system user to Joseph Porter KCB <jporter@example.com>`
+
+
+To clear the user for a specific scope
+
+`$ git su --clear --global`
+
+`Clearing global user`
+
+
+## AUTHOR
+
+drrb at the git hub
+
+## SEE ALSO
+
+git(1), git-config(1).

data/spec/gitsu/git_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+
+module GitSu
+    describe Git do
+        let(:shell) { double('shell') }
+        let(:git) { CachingGit.new(shell) }
+
+        describe '#select_user' do
+            it 'switches to the specified user' do
+                shell.should_receive(:execute).with("git config --global user.name 'John Galt'").and_return true
+                shell.should_receive(:execute).with("git config --global user.email 'jgalt@example.com'").and_return true
+                git.select_user User.new("John Galt", "jgalt@example.com"), :global
+            end
+            it 'escapes apostrophes' do
+                shell.should_receive(:execute).with("git config --global user.name 'John O'\\''Grady'").and_return true
+                shell.should_receive(:execute).with("git config --global user.email 'jo@example.com'").and_return true
+                git.select_user User.new("John O'Grady", "jo@example.com"), :global
+            end
+            it "raises an exception when can't set the name" do
+                shell.should_receive(:execute).with("git config --global user.name 'John O'\\''Grady'").and_return(false)
+                expect {git.select_user User.new("John O'Grady", "jo@example.com"), :global}.to raise_error(Git::ConfigSettingError)
+            end
+        end
+
+        describe '#selected_user' do
+            context 'when a scope is specified' do
+                context 'when a user is selected' do
+                    it 'returns the current user' do
+                        shell.should_receive(:capture).with("git config --global user.name").and_return("John Galt")
+                        shell.should_receive(:capture).with("git config --global user.email").and_return("jgalt@example.com")
+                        git.selected_user(:global).should == User.new("John Galt", "jgalt@example.com")
+                    end
+                end
+
+                context 'when no user is selected' do
+                    it 'returns the null user' do
+                        shell.should_receive(:capture).with("git config --global user.name").and_return("")
+                        git.selected_user(:global).should be User::NONE
+                    end
+                end
+            end
+
+            context 'when "derived" scope is specified' do
+                it 'returns the current user derived by git' do
+                    shell.should_receive(:capture).with("git config user.name").and_return("John Galt")
+                    shell.should_receive(:capture).with("git config user.email").and_return("jgalt@example.com")
+                    git.selected_user(:derived).should == User.new("John Galt", "jgalt@example.com")
+                end
+            end
+
+            it "caches the result" do
+                shell.should_receive(:capture).with("git config user.name").and_return("John Galt")
+                shell.should_receive(:capture).with("git config user.email").and_return("jgalt@example.com")
+                git.selected_user(:derived).should == User.new("John Galt", "jgalt@example.com")
+                git.selected_user(:derived).should == User.new("John Galt", "jgalt@example.com")
+            end
+        end
+
+        describe '#edit_gitsu_config' do
+            it 'opens the Gitsu config in an editor' do
+                shell.should_receive(:execute).with("git config --edit --file #{File.expand_path '~/.gitsu'}")
+                git.edit_gitsu_config
+            end
+        end
+
+        describe '#color_output?' do
+            context 'when Git says to use colorize output' do
+                it 'returns true' do
+                    shell.should_receive(:execute).with("git config --get-colorbool color.ui").and_return true
+                    git.color_output?.should be true
+                end
+            end
+
+            context 'when git says not to colorize output' do
+                it 'returns true' do
+                    shell.should_receive(:execute).with("git config --get-colorbool color.ui").and_return false
+                    git.color_output?.should be false
+                end
+            end
+
+            it "caches the result" do
+                shell.should_receive(:execute).with("git config --get-colorbool color.ui").and_return false
+                git.color_output?.should be false
+                git.color_output?.should be false
+            end
+        end
+
+        describe '#clear_user' do
+            context "when there's other user config" do
+                it 'clears the current user in the specified scope' do
+                    shell.should_receive(:capture).with("git config --local user.name").and_return("John Smith")
+                    shell.should_receive(:capture).with("git config --local user.email").and_return("js@example.com")
+                    shell.should_receive(:capture).with("git config --local --unset user.name").and_return("")
+                    shell.should_receive(:capture).with("git config --local --unset user.email").and_return("")
+                    shell.should_receive(:capture).with("git config --local --list").and_return("ui.color=true\nuser.signingkey = something\nsomething.else")
+                    git.clear_user(:local)
+                end
+            end
+            context "when there's no other user config" do
+                it 'quietly attempts to remove the user section of the config in the specified scope' do
+                    shell.should_receive(:capture).with("git config --system user.name").and_return("John Smith")
+                    shell.should_receive(:capture).with("git config --system user.email").and_return("js@example.com")
+                    shell.should_receive(:capture).with("git config --system --unset user.name").and_return("")
+                    shell.should_receive(:capture).with("git config --system --unset user.email").and_return("")
+                    shell.should_receive(:capture).with("git config --system --list").and_return("")
+                    shell.should_receive(:capture).with("git config --system --remove-section user 2>/dev/null").and_return("")
+                    git.clear_user(:system)
+                end
+            end
+            context "when no user is selected" do
+                it "doesn't attempt to clear the user" do
+                    shell.should_receive(:capture).with("git config --system user.name").and_return("")
+                    git.clear_user :system
+                end
+            end
+        end
+
+        describe '#get_color' do
+            it 'gets an ANSI escape code from Git for the specified color' do
+                shell.should_receive(:capture).with("git config --get-color '' 'on blue'").and_return("xxx")
+                color = git.get_color("on blue")
+                color.should == "xxx"
+            end
+            it 'caches colors' do
+                shell.should_receive(:capture).with("git config --get-color '' 'on green'").and_return("xxx")
+                git.get_color("on green").should == "xxx"
+                git.get_color("on green").should == "xxx"
+            end
+        end
+
+        describe '#render' do
+            context "when Git says to color output" do
+                it "colors the user output" do
+                    user = User.new('John Galt', 'jgalt@example.com')
+
+                    git.should_receive(:color_output?).and_return true
+                    git.should_receive(:get_color).with("blue").and_return "__blue__"
+                    git.should_receive(:get_color).with("green").and_return "__green__"
+                    git.should_receive(:get_color).with("reset").and_return "__reset__"
+
+                    git.render(user).should == "__blue__John Galt__reset__ __green__<jgalt@example.com>__reset__"
+                end
+            end
+
+            context "when Git says not to color output" do
+                it "calls to_s() on the user" do
+                    user = User.new('John Galt', 'jgalt@example.com')
+
+                    git.should_receive(:color_output?).and_return false
+
+                    git.render(user).should == user.to_s
+                end
+            end
+        end
+        
+        describe "#render_user" do
+            it "is equivalent to calling #render(#selected_user(scope))" do
+                shell.should_receive(:capture).with("git config --local user.name").and_return("John Smith")
+                shell.should_receive(:capture).with("git config --local user.email").and_return("js@example.com")
+                shell.should_receive(:execute).with("git config --get-colorbool color.ui").and_return true
+                shell.should_receive(:capture).with("git config --get-color '' 'blue'").and_return("*")
+                shell.should_receive(:capture).with("git config --get-color '' 'green'").and_return("?")
+                shell.should_receive(:capture).with("git config --get-color '' 'reset'").and_return("!")
+                git.render_user(:local).should == "*John Smith! ?<js@example.com>!"
+            end
+        end
+
+        describe "#default_select_scope" do
+            context "when a default selecton scope is configured" do
+                it "returns the configured default scope" do
+                    shell.should_receive(:capture).with("git config git-su.defaultSelectScope").and_return("global")
+                    git.default_select_scope.should == :global
+                end
+            end
+            context "when no default selection scope is configured" do
+                it "returns the conventional default scope (local)" do
+                    shell.should_receive(:capture).with("git config git-su.defaultSelectScope").and_return("")
+                    git.default_select_scope.should == :local
+                end
+            end
+            context "when an invalid default selection scope is configured" do
+                it "dies noisily" do
+                    shell.should_receive(:capture).with("git config git-su.defaultSelectScope").and_return("xxxxxx")
+                    expect {git.default_select_scope}.to raise_error(Git::InvalidConfigError)
+                end
+            end
+        end
+    end
+end