socialcast-git-extensions 3.1.2 → 3.1.3

data/README.rdoc

@@ -21,6 +21,19 @@ integrate the current feature branch into an aggregate branch (ex: prototype, st
 
 create a pull request on github for peer review of the current branch.
 
+=== Optional:
+Specify a Review Buddy mapping that will reference the local Github username and @mention a pre-assigned review buddy in the Socialcast Review Request message.  Specify the mapping by creating a Configuration YML file relative to the Repo Root: config/scgitx.yml with the following format:
+
+    review_buddies:
+        emilyjames: # Github Username "emilyjames"
+          socialcast_username: "EmilyJames" # Socialcast UserName
+          buddy: bobdavis # Buddy's Github username
+        bobdavis:
+          socialcast_username: "BobDavis"
+          buddy: emilyjames
+
+In this example, when Emily runs `git reviewrequest` from her local machine, @BobDavis will receive an @mention in Socialcast notifying him to review her branch.  If Bob runs the command, Emily will receive a notice in Socialcast.
+
 == git release
 
 release the current feature branch to master

data/config/scgitx.yml

@@ -0,0 +1,8 @@
+# Map github usernames to Socialcast usernames and assign review buddies
+review_buddies:
+  vanm:
+    socialcast_username: VanMiranda
+    buddy: wireframe
+  wireframe:
+    socialcast_username: RyanSonnek 
+    buddy: vanm

data/lib/socialcast-git-extensions/cli.rb

@@ -32,6 +32,10 @@ module Socialcast
 
         update
 
+        review_mention = if buddy = socialcast_review_buddy(current_user)
+          "Assigned to @#{buddy}"
+        end
+
         description = options[:description] || editor_input(PULL_REQUEST_DESCRIPTION)
         branch = current_branch
         repo = current_repo
@@ -39,7 +43,7 @@ module Socialcast
         say "Pull request created: #{url}"
 
         short_description = description.split("\n").first(5).join("\n")
-        review_message = ["#reviewrequest for #{branch} #scgitx", "/cc @SocialcastDevelopers", short_description, changelog_summary(branch)].join("\n\n")
+        review_message = ["#reviewrequest for #{branch} #scgitx", "/cc @SocialcastDevelopers", review_mention, short_description, changelog_summary(branch)].compact.join("\n\n")
         post review_message, :url => url, :message_type => 'review_request'
       end
 

data/lib/socialcast-git-extensions/git.rb

@@ -24,6 +24,12 @@ module Socialcast
         repo.gsub(/\.git$/,'').split(/[:\/]/).last(2).join('/')
       end
 
+      # @returns [String] github username (ex: 'wireframe') of the current github.user
+      # @returns empty [String] when no github.user is set on the system
+      def current_user
+        `git config -z --global --get github.user`.strip
+      end
+
       # retrieve a list of branches
       def branches(options = {})
         branches = []
@@ -138,6 +144,30 @@ module Socialcast
           description.gsub(/^\#.*/, '').chomp.strip
         end
       end
+
+      # load SC Git Extensions Config YAML
+      # @returns [Hash] of configuration options from YAML file (if it exists)
+      def config
+        @config ||= begin
+          if config_file.exist?
+            YAML.load_file(config_file)
+          else
+            {}
+          end
+        end
+      end
+      
+      # @returns a [Pathname] for the scgitx.yml Config File
+      # from either ENV['SCGITX_CONFIG_PATH'] or default $PWD/config/scgitx.yml
+      def config_file
+        Pathname((ENV['SCGITX_CONFIG_PATH'] || ([Dir.pwd, '/config/scgitx.yml']).join))
+      end
+
+      # load Review buddies from the SCGITX Configuration YML
+      # @returns [Hash] of review buddy mapping from Config YML (ex: {'wireframe' => {'socialcast_username' => 'RyanSonnek', 'buddy' => 'vanm'}})
+      def review_buddies
+        config['review_buddies'] || {}
+      end
     end
   end
 end

data/lib/socialcast-git-extensions/github.rb

@@ -13,7 +13,7 @@ module Socialcast
         credentials = Socialcast.credentials
         return credentials[:scgitx_token] if credentials[:scgitx_token]
 
-        username = `git config -z --global --get github.user`.strip
+        username = current_user
         raise "Github user not configured.  Run: `git config --global github.user 'me@email.com'`" if username.empty?
         password = ask("Github password for #{username}: ") { |q| q.echo = false }
 
@@ -51,6 +51,16 @@ module Socialcast
         data = JSON.parse e.http_body
         say "Failed to create pull request: #{data['message']}", :red
       end
+      
+      # @returns [String] socialcast username to assign the review to
+      # @returns [nil] when no buddy system configured or user not found
+      def socialcast_review_buddy(current_user)
+        review_requestor = review_buddies[current_user]
+        
+        if review_requestor && review_buddies[review_requestor['buddy']]
+          review_buddies[review_requestor['buddy']]['socialcast_username']
+        end
+      end
     end
   end
 end

data/lib/socialcast-git-extensions/version.rb

@@ -1,5 +1,5 @@
 module Socialcast
   module Gitx
-    VERSION = "3.1.2"
+    VERSION = "3.1.3"
   end
 end

data/spec/cli_spec.rb

@@ -16,6 +16,7 @@ describe Socialcast::Gitx::CLI do
   before do
     Socialcast::Gitx::CLI.stubbed_executed_commands = []
     Socialcast::Gitx::CLI.any_instance.stub(:current_branch).and_return('FOO')
+    Socialcast::Gitx::CLI.any_instance.stub(:current_user).and_return('wireframe')
     Socialcast::Gitx::CLI.any_instance.stub(:post)
   end
 
@@ -268,12 +269,37 @@ describe Socialcast::Gitx::CLI do
   end
 
   describe '#reviewrequest' do
-    context 'when description != null' do
+    context 'when there are no review_buddies specified' do
+      before do
+        Socialcast::Gitx::CLI.any_instance.stub(:config_file).and_return(Pathname(''))
+      end
+      context 'when description != null' do
+        before do
+          stub_request(:post, "https://api.github.com/repos/socialcast/socialcast-git-extensions/pulls").
+            to_return(:status => 200, :body => %q({"html_url": "http://github.com/repo/project/pulls/1"}), :headers => {})
+
+          Socialcast::Gitx::CLI.any_instance.should_receive(:post).with("#reviewrequest for FOO #scgitx\n\n/cc @SocialcastDevelopers\n\ntesting\n\n", :url => 'http://github.com/repo/project/pulls/1', :message_type => 'review_request')
+          Socialcast::Gitx::CLI.start ['reviewrequest', '--description', 'testing']
+        end
+        it 'should create github pull request' do end # see expectations
+        it 'should post socialcast message' do end # see expectations
+        it 'should run expected commands' do
+          Socialcast::Gitx::CLI.stubbed_executed_commands.should == [
+            "git pull origin FOO",
+            "git pull origin master",
+            "git push origin HEAD"
+          ]
+        end
+      end
+    end
+
+    context 'when review_buddies are specified via a /config YML file' do
       before do
         stub_request(:post, "https://api.github.com/repos/socialcast/socialcast-git-extensions/pulls").
           to_return(:status => 200, :body => %q({"html_url": "http://github.com/repo/project/pulls/1"}), :headers => {})
 
-        Socialcast::Gitx::CLI.any_instance.should_receive(:post).with("#reviewrequest for FOO #scgitx\n\n/cc @SocialcastDevelopers\n\ntesting\n\n", :url => 'http://github.com/repo/project/pulls/1', :message_type => 'review_request')
+        # The Review Buddy should be @mentioned in the message
+        Socialcast::Gitx::CLI.any_instance.should_receive(:post).with("#reviewrequest for FOO #scgitx\n\n/cc @SocialcastDevelopers\n\nAssigned to @VanMiranda\n\ntesting\n\n", :url => 'http://github.com/repo/project/pulls/1', :message_type => 'review_request')
         Socialcast::Gitx::CLI.start ['reviewrequest', '--description', 'testing']
       end
       it 'should create github pull request' do end # see expectations

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: socialcast-git-extensions
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
@@ -191,6 +191,7 @@ files:
 - bin/git-track
 - bin/git-update
 - bin/git-wtf
+- config/scgitx.yml
 - lib/socialcast-git-extensions.rb
 - lib/socialcast-git-extensions/cli.rb
 - lib/socialcast-git-extensions/git.rb
@@ -214,7 +215,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3432850963659879185
+      hash: 735880262416414370
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -223,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3432850963659879185
+      hash: 735880262416414370
 requirements: []
 rubyforge_project: socialcast-git-extensions
 rubygems_version: 1.8.24