gitsu 1.0.0 → 2.0.0

data/lib/gitsu/version.rb

@@ -1,5 +1,21 @@
+# Gitsu
+# Copyright (C) 2013 drrb
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 module GitSu
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
 
     class Version
         class ParseError < StandardError

data/man/git-su.1.ronn

@@ -3,7 +3,7 @@ git-su(1) -- Manage your Git Users
 
 ## SYNOPSIS
 
-git su [OPTIONS] [user]
+git su [OPTIONS] [user...]
 
 ## DESCRIPTION
 
@@ -12,6 +12,7 @@ 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
+* switch to multiple users at once for pairing
 
 ## OPTIONS
 
@@ -37,15 +38,18 @@ Gitsu helps you to manage your projects' Git users.
 
 Gitsu supports the following configuration options, specified either in Git config files, or by executing `git config`:
 
-git-su.defaultSelectScope
+gitsu.defaultSelectScope
     One of "local", "global", or "system" (without quotes). Specifies the default scope that the user is switched in when `git su` is run.
 
+gitsu.groupEmailAddress
+    The group email address to use when switching to multiple users. E.g., if you specify "developers@company.org", pairing email addresses will look like "me+you+developers@example.org". Defaults to "dev@example.com".
+
 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
+http://drrb.github.io/gitsu
 
 ## EXAMPLES
 
@@ -110,10 +114,38 @@ To clear the user for a specific scope
 
 `Clearing global user`
 
+### Pairing
+
+Gitsu supports switching to multiple users at once. When pairing, this lets you switch
+to attribute both users in each commit.
+
+E.g., to switch to two configured users:
+
+`$ git su joe rack`
+
+`Switched local user to Joseph Porter KCB and Raphe Rackstraw <jporter+rrack+dev@example.com>`
 
 ## AUTHOR
 
-drrb at the git hub
+drrrrrrrrrrrb at g mail
+
+## LICENSE
+
+Gitsu
+Copyright (C) 2013 drrb
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 ## SEE ALSO
 

data/spec/gitsu/array_spec.rb

@@ -0,0 +1,71 @@
+# Gitsu
+# Copyright (C) 2013 drrb
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe Array do
+    describe "#to_sentence" do
+        context "when array is empty" do
+            let(:array) { [] }
+
+            it "returns an empty string" do
+                array.to_sentence.should == ""
+            end
+        end
+
+        context "when array has one element" do
+            let(:array) { [:apple] }
+
+            it "returns the element as a string" do
+                array.to_sentence.should == "apple"
+            end
+        end
+
+        context "when array has two elements" do
+            let(:array) { %w[apples oranges] }
+
+            it "returns the elements with an 'and' in between" do
+                array.to_sentence.should == "apples and oranges"
+            end
+        end
+
+        context "when array has multiple elements" do
+            let(:array) { %w[apples oranges bananas] }
+
+            it "returns the elements as a sentence" do
+                array.to_sentence.should == "apples, oranges and bananas"
+            end
+        end
+    end
+
+    describe "#pluralize" do
+        context "when the array has one element" do
+            let(:array) { [:apple] }
+
+            it "returns the word unchanged" do
+                array.pluralize("fruit").should == "fruit"
+            end
+        end
+
+        context "when the array has more than one element" do
+            let(:array) { [:apple, :orange] }
+
+            it "returns the word with an 's' on the end" do
+                array.pluralize("fruit").should == "fruits"
+            end
+        end
+    end
+end

data/spec/gitsu/bin_spec.rb

@@ -1,3 +1,19 @@
+# Gitsu
+# Copyright (C) 2013 drrb
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 require 'spec_helper'
 
 describe "git-su executable" do

data/spec/gitsu/config_repository_spec.rb

@@ -0,0 +1,67 @@
+# Gitsu
+# Copyright (C) 2013 drrb
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+module GitSu
+    describe ConfigRepository do
+        let(:git) { double('git') }
+        let(:repository) { ConfigRepository.new(git) }
+
+        describe "#get" do
+            it "looks up the specified config in Git" do
+                git.should_receive(:get_config).with(:derived, "config.key").and_return "value"
+                repository.get("config.key").should == "value"
+            end
+        end
+
+        describe "#group_email_address" do
+            context "when a group email address is configured" do
+                it "returns the configured group email address" do
+                    git.should_receive(:get_config).with(:derived, "gitsu.groupEmailAddress").and_return("pairs@example.org")
+                    repository.group_email_address.should == "pairs@example.org"
+                end
+            end
+            context "when no group email address is configured" do
+                it "returns the placeholder group email address" do
+                    git.should_receive(:get_config).with(:derived, "gitsu.groupEmailAddress").and_return("")
+                    repository.group_email_address.should == "dev@example.com"
+                end
+            end
+        end
+
+        describe "#default_select_scope" do
+            context "when a default selecton scope is configured" do
+                it "returns the configured default scope" do
+                    git.should_receive(:get_config).with(:derived, "gitsu.defaultSelectScope").and_return("global")
+                    repository.default_select_scope.should == :global
+                end
+            end
+            context "when no default selection scope is configured" do
+                it "returns the conventional default scope (local)" do
+                    git.should_receive(:get_config).with(:derived, "gitsu.defaultSelectScope").and_return("")
+                    repository.default_select_scope.should == :local
+                end
+            end
+            context "when an invalid default selection scope is configured" do
+                it "dies noisily" do
+                    git.should_receive(:get_config).with(:derived, "gitsu.defaultSelectScope").and_return("xxxxxx")
+                    expect {repository.default_select_scope}.to raise_error(ConfigRepository::InvalidConfigError)
+                end
+            end
+        end
+    end
+end

data/spec/gitsu/git_spec.rb

@@ -1,3 +1,19 @@
+# Gitsu
+# Copyright (C) 2013 drrb
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 require 'spec_helper'
 
 module GitSu
@@ -165,23 +181,21 @@ module GitSu
             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
+        describe "#get_config" do
+            it "looks up config in Git in the specified scope" do
+                shell.should_receive(:capture).with("git config --global config.key").and_return "value"
+                git.get_config(:global, "config.key").should == "value"
             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
+            it "caches the result" do
+                shell.should_receive(:capture).with("git config --global config.key").and_return "value"
+                git.get_config(:global, "config.key").should == "value"
+                git.get_config(:global, "config.key").should == "value"
             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)
+
+            context "when :derived scope is specified" do
+                it "looks up config in Git without specifying the scope" do
+                    shell.should_receive(:capture).with("git config config.key").and_return "value"
+                    git.get_config(:derived, "config.key").should == "value"
                 end
             end
         end
@@ -192,5 +206,12 @@ module GitSu
                 git.commit("file.dat", "Committing changes")
             end
         end
+
+        describe "#list_files" do
+            it "calls 'git ls-files' with the specified flags" do
+                shell.should_receive(:capture).with("git ls-files --modified --cached").and_return "file1\nfile2\n"
+                git.list_files(:modified, :cached).should == [ "file1", "file2" ]
+            end
+        end
     end
 end

data/spec/gitsu/gitsu_spec.rb

@@ -1,3 +1,19 @@
+# Gitsu
+# Copyright (C) 2013 drrb
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 require 'spec_helper'
 
 module GitSu
@@ -10,22 +26,29 @@ module GitSu
             context 'when query string provided' do
                 context 'when no scope specified' do
                     it 'switches to the specified user in the default scope' do
-                        switcher.should_receive(:request).with('Joe Bloggs', :default)
-                        gitsu.go ['Joe', 'Bloggs']
+                        switcher.should_receive(:request).with(:default, 'Joe Bloggs')
+                        gitsu.go ['Joe Bloggs']
+                    end
+                end
+
+                context 'when multiple users specified' do
+                    it 'switches to all users' do
+                        switcher.should_receive(:request).with(:default, 'Jimmy Baggs', 'Joe Bloggs')
+                        gitsu.go ['Jimmy Baggs', 'Joe Bloggs']
                     end
                 end
 
                 context 'when local scope specified' do
                     context 'as short option (-l)' do
                         it 'switches to the specified user in the default scope' do
-                            switcher.should_receive(:request).with('Joe Bloggs', :local)
-                            gitsu.go ['Joe', 'Bloggs', "-l"]
+                            switcher.should_receive(:request).with(:local, 'Joe Bloggs')
+                            gitsu.go ['Joe Bloggs', "-l"]
                         end
                     end
                     context 'as long option (--local)' do
                         it 'switches to the specified user in the default scope' do
-                            switcher.should_receive(:request).with('Joe Bloggs', :local)
-                            gitsu.go ['Joe', 'Bloggs', "--local"]
+                            switcher.should_receive(:request).with(:local, 'Joe Bloggs')
+                            gitsu.go ['Joe Bloggs', "--local"]
                         end
                     end
                 end
@@ -33,14 +56,14 @@ module GitSu
                 context 'when global scope specified' do
                     context 'as short option (-g)' do
                         it 'switches to the specified user in the global scope' do
-                            switcher.should_receive(:request).with('Joe Bloggs', :global)
-                            gitsu.go ['Joe', 'Bloggs', "-g"]
+                            switcher.should_receive(:request).with(:global, 'Joe Bloggs')
+                            gitsu.go ['Joe Bloggs', "-g"]
                         end
                     end
                     context 'as long option (--global)' do
                         it 'switches to the specified user in the global scope' do
-                            switcher.should_receive(:request).with('Joe Bloggs', :global)
-                            gitsu.go ['Joe', 'Bloggs', "--global"]
+                            switcher.should_receive(:request).with(:global, 'Joe Bloggs')
+                            gitsu.go ['Joe Bloggs', "--global"]
                         end
                     end
                 end
@@ -48,24 +71,24 @@ module GitSu
                 context 'when system scope specified' do
                     context 'as short option (-s)' do
                         it 'switches to the specified user in the system scope' do
-                            switcher.should_receive(:request).with('Joe Bloggs', :system)
-                            gitsu.go ['Joe', 'Bloggs', "-s"]
+                            switcher.should_receive(:request).with(:system, 'Joe Bloggs')
+                            gitsu.go ['Joe Bloggs', "-s"]
                         end
                     end
                     context 'as long option (--system)' do
                         it 'switches to the specified user in the system scope' do
-                            switcher.should_receive(:request).with('Joe Bloggs', :system)
-                            gitsu.go ['Joe', 'Bloggs', "--system"]
+                            switcher.should_receive(:request).with(:system, 'Joe Bloggs')
+                            gitsu.go ['Joe Bloggs', "--system"]
                         end
                     end
                 end
 
                 context 'when multiple scopes specified' do
                     it 'switches to the specified user in the specified scopes' do
-                        switcher.should_receive(:request).with('Joe Bloggs', :local)
-                        switcher.should_receive(:request).with('Joe Bloggs', :global)
-                        switcher.should_receive(:request).with('Joe Bloggs', :system)
-                        gitsu.go ['Joe', 'Bloggs', "--local", "--global", "--system"]
+                        switcher.should_receive(:request).with(:local, 'Joe Bloggs')
+                        switcher.should_receive(:request).with(:global, 'Joe Bloggs')
+                        switcher.should_receive(:request).with(:system, 'Joe Bloggs')
+                        gitsu.go ['Joe Bloggs', "--local", "--global", "--system"]
                     end
                 end
             end

data/spec/gitsu/runner_spec.rb

@@ -1,3 +1,19 @@
+# Gitsu
+# Copyright (C) 2013 drrb
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 require 'spec_helper'
 
 module GitSu