lita-locker 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eb9acdca54c6107ab5176d27da3a5b3175953c7
-  data.tar.gz: 4d2930c496c7a4edee32a9993d601f40a7546318
+  metadata.gz: 6486024efd68e3b338f738adb2dad218b8d1b23f
+  data.tar.gz: 70ca546c520752096d4c0130de5f7907a98be117
 SHA512:
-  metadata.gz: 2e88fa9204ee2728b77bdb45dc8267c32cd7928069d5b978416d2cbde46552b68e6e3858e65deccc057ef44ae8705e872ee66697d8ec0f3906a095232db3fdb7
-  data.tar.gz: a53f48d546856dd8ae6289823f9e555246a95d24300a3756d190179616bb0db9b7a7969874a9a542b581b73c1ac2da78c1828f622f10097704164d503441ee30
+  metadata.gz: 8adf1447143a90c49860d5bed23255b71420483db7d328619c6ccdb17e1ccb8c401e6eb77e95f52d3daaf6b34f0a9113c91d062a452956e29c6cba1b7976d37d
+  data.tar.gz: 1122f9f8241f56561ea73244f2547b2f3ed3deada9fd0983345f4aa03ebac7d8e415253902ec1163803104f8e332b34acd1e0c1fd61818fa292794b3391f4936

data/lib/lita/handlers/locker.rb

@@ -73,7 +73,7 @@ module Lita
         return response.reply(failed(t('label.does_not_exist', name: name))) unless Label.exists?(name)
         l = Label.new(name)
         return response.reply(failed(t('label.no_resources', name: name))) unless l.membership.count > 0
-        return response.reply(t('label.self_lock', name: name)) if l.owner == response.user
+        return response.reply(t('label.self_lock', name: name, user: response.user.name)) if l.owner == response.user
         return response.reply(success(t('label.lock', name: name))) if l.lock!(response.user.id)
 
         response.reply(label_ownership(name))
@@ -90,7 +90,7 @@ module Lita
 
         return if l.locked?
         mention_names = l.observers
-                        .map { |observer| observer.mention_name ? "(@#{observer.mention_name})" : '' }
+                        .map { |observer| render_template('mention', name: observer.mention_name, id: observer.id) }
                         .reject { |mention| mention == '' }
                         .sort
                         .join(' ')
@@ -99,20 +99,22 @@ module Lita
 
       def observe(response)
         name = response.match_data['label']
+        user = response.user
         return response.reply(failed(t('label.does_not_exist', name: name))) unless Label.exists?(name)
         l = Label.new(name)
-        return response.reply(t('observe.already_observing', name: name)) if l.observer?(response.user.id)
-        l.add_observer!(response.user.id)
-        response.reply(t('observe.now_observing', name: name))
+        return response.reply(t('observe.already_observing', name: name, user: user.name)) if l.observer?(user.id)
+        l.add_observer!(user.id)
+        response.reply(t('observe.now_observing', name: name, user: user.name))
       end
 
       def unobserve(response)
         name = response.match_data['label']
+        user = response.user
         return response.reply(failed(t('label.does_not_exist', name: name))) unless Label.exists?(name)
         l = Label.new(name)
-        return response.reply(t('observe.were_not_observing', name: name)) unless l.observer?(response.user.id)
-        l.remove_observer!(response.user.id)
-        response.reply(t('observe.stopped_observing', name: name))
+        return response.reply(t('observe.were_not_observing', name: name, user: user.name)) unless l.observer?(user.id)
+        l.remove_observer!(user.id)
+        response.reply(t('observe.stopped_observing', name: name, user: user.name))
       end
 
       def steal(response)
@@ -130,13 +132,14 @@ module Lita
 
         return response.reply(failed(t('subject.does_not_exist', name: name))) unless Label.exists?(name)
         l = Label.new(name)
-        owner_mention = l.owner.mention_name ? "(@#{l.owner.mention_name})" : ''
+        owner_mention = render_template('mention', name: l.owner.mention_name, id: l.owner.id)
         return response.reply(t('give.not_owner',
                                 label: name,
                                 owner: l.owner.name,
                                 mention: owner_mention)) unless l.owner == response.user
-        recipient = Lita::User.fuzzy_find(response.match_data['username'].rstrip)
-        return response.reply(t('user.unknown')) unless recipient
+        recipient_name = response.match_data['username'].rstrip
+        recipient = Lita::User.fuzzy_find(recipient_name)
+        return response.reply(t('user.unknown', user: recipient_name)) unless recipient
 
         response.reply(attempt_give(name, response.user, recipient))
       end
@@ -145,20 +148,20 @@ module Lita
 
       def attempt_give(name, giver, recipient)
         label = Label.new(name)
-        return t('give.self') if recipient == giver
+        return t('give.self', user: giver.name) if recipient == giver
         old_owner = label.owner
         label.give!(recipient.id)
-        mention = recipient.mention_name ? "(@#{recipient.mention_name})" : ''
+        mention = render_template('mention', name: recipient.mention_name, id: recipient.id)
         success(t('give.given', label: name, giver: old_owner.name, recipient: recipient.name, mention: mention))
       end
 
       def attempt_steal(name, user)
         label = Label.new(name)
-        return t('steal.self') if label.owner == user
+        return t('steal.self', user: user.name) if label.owner == user
         old_owner = label.owner
         label.steal!(user.id)
-        mention = old_owner.mention_name ? "(@#{old_owner.mention_name})" : ''
-        success(t('steal.stolen', label: name, old_owner: old_owner.name, mention: mention))
+        mention = render_template('mention', name: old_owner.mention_name, id: old_owner.id)
+        success(t('steal.stolen', label: name, thief: user.name, victim: old_owner.name, mention: mention))
       end
 
       def attempt_unlock(name, user)
@@ -166,13 +169,13 @@ module Lita
         if label.owner == user
           label.unlock!
           if label.locked?
-            mention = label.owner.mention_name ? "(@#{label.owner.mention_name})" : ''
+            mention = render_template('mention', name: label.owner.mention_name, id: label.owner.id)
             failed(t('label.now_locked_by', name: name, owner: label.owner.name, mention: mention))
           else
             success(t('label.unlock', name: name))
           end
         else
-          mention = label.owner.mention_name ? "(@#{label.owner.mention_name})" : ''
+          mention = render_template('mention', name: label.owner.mention_name, id: label.owner.id)
           failed(t('label.owned_unlock', name: name, owner_name: label.owner.name, mention: mention, time: label.held_for))
         end
       end

data/lib/lita/handlers/locker_misc.rb

@@ -65,19 +65,21 @@ module Lita
 
       def dequeue(response)
         name = response.match_data['label']
+        user = response.user
         return response.reply(t('subject.does_not_exist', name: name)) unless Label.exists?(name)
         l = Label.new(name)
-        l.wait_queue.delete(response.user.id)
+        return response.reply(t('label.unknown_in_queue', name: name, user: user.name)) unless l.wait_queue.include?(user.id)
+        l.wait_queue.delete(user.id)
         l.dedupe!
-        response.reply(t('label.removed_from_queue', name: name))
+        response.reply(t('label.removed_from_queue', name: name, user: user.name))
       end
 
       def list(response)
         username = response.match_data['username']
         user = Lita::User.fuzzy_find(username)
-        return response.reply(t('user.unknown')) unless user
+        return response.reply(t('user.unknown', user: username)) unless user
         l = user_locks(user)
-        return response.reply(t('user.no_active_locks')) unless l.size > 0
+        return response.reply(t('user.no_active_locks', user: user.name)) unless l.size > 0
         composed = ''
         l.each do |label_name|
           composed += "Label: #{label_name}\n"

data/lib/locker/label.rb

@@ -193,7 +193,7 @@ module Locker
         usr = Lita::User.find_by_id(u)
         queue.push(usr.name)
       end
-      mention = l.owner.mention_name ? "(@#{l.owner.mention_name})" : ''
+      mention = render_template('mention', name: l.owner.mention_name, id: l.owner.id)
       failed(t('label.owned_lock', name: name,
                                    owner_name: l.owner.name,
                                    mention: mention,

data/lita-locker.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-locker'
-  spec.version       = '1.0.7'
+  spec.version       = '1.0.8'
   spec.authors       = ['Eric Sigler']
   spec.email         = ['me@esigler.com']
   spec.description   = '"lock" and "unlock" arbitrary subjects'

data/locales/en.yml

@@ -3,18 +3,18 @@ en:
     handlers:
       locker:
         steal:
-          stolen: "%{label} stolen from %{old_owner} %{mention}"
+          stolen: "%{thief} stole %{label} from %{victim} %{mention}"
           already_unlocked: "%{label} was already unlocked"
-          self: Why are you stealing the lock from yourself?
+          self: "%{user}, why are you stealing the lock from yourself?"
         give:
           not_owner: "The lock on %{label} can only be given by its current owner: %{owner} %{mention}"
           given: "%{giver} gave %{label} to %{recipient} %{mention}"
-          self: Why are you giving the lock to yourself?
+          self: "%{user}, why are you giving the lock to yourself?"
         observe:
-          now_observing: "Now observing %{name}"
-          already_observing: "You are already observing %{name}"
-          stopped_observing: "You have stopped observing %{name}"
-          were_not_observing: "You were not observing %{name} originally"
+          now_observing: "%{user} is now observing %{name}"
+          already_observing: "%{user}, you are already observing %{name}"
+          stopped_observing: "%{user}, you have stopped observing %{name}"
+          were_not_observing: "%{user}, you were not observing %{name}"
         help:
           log:
             syntax: locker log <label>
@@ -91,12 +91,12 @@ en:
           owned: "%{name} is locked by %{owner_name}"
           owned_mention: "%{name} is locked by %{owner_name} (@%{owner_mention})"
         status:
-          does_not_exist: "Sorry, that does not exist. Use * for wildcard search"
+          does_not_exist: "%{name} does not exist. Use * for wildcard search"
         subject:
-          does_not_exist: "Sorry, that does not exist"
+          does_not_exist: "%{name} does not exist"
         label:
           log_entry: "%{entry}"
-          self_lock: "You already have the lock on %{name}"
+          self_lock: "%{user}, you already have the lock on %{name}"
           unlock: "%{name} unlocked"
           owned_lock: "%{name} is locked by %{owner_name} %{mention} (taken %{time}), you have been added to the queue (currently: %{queue}), type 'locker dequeue %{name}' to be removed"
           owned_unlock: "%{name} is locked by %{owner_name} %{mention} (taken %{time})"
@@ -110,7 +110,7 @@ en:
           created: "Label %{name} created"
           exists: "%{name} already exists"
           deleted: "Label %{name} deleted"
-          does_not_exist: "Label %{name} does not exist.  To create it: \"!locker label create %{name}\""
+          does_not_exist: "Label %{name} does not exist. To create it: \"!locker label create %{name}\""
           has_no_resources: "Label %{name} has no resources"
           resource_added: "Resource %{resource} has been added to %{label}"
           resource_removed: "Resource %{resource} has been removed from %{label}"
@@ -119,8 +119,8 @@ en:
           no_resources: "%{name} has no resources, so it cannot be locked"
           dependency: 'Label unable to be locked, blocked on:'
           now_locked_by: "%{name} now locked by %{owner} %{mention}"
-          removed_from_queue: "You have been removed from the queue for %{name}"
-          unknown_in_queue: "You weren't in the queue for %{name}"
+          removed_from_queue: "%{user} has been removed from the queue for %{name}"
+          unknown_in_queue: "%{user}, you weren't in the queue for %{name}"
         user:
-          unknown: Unknown user
-          no_active_locks: That user has no active locks
+          unknown: "Unknown user '%{user}'"
+          no_active_locks: "%{user} has no active locks"

data/spec/lita/handlers/locker_labels_spec.rb

@@ -81,7 +81,7 @@ describe Lita::Handlers::LockerLabels, lita_handler: true do
 
     it 'shows a warning when <name> does not exist' do
       send_command('locker label delete foobar')
-      expect(replies.last).to eq('Label foobar does not exist.  To create it: "!locker label create foobar"')
+      expect(replies.last).to eq('Label foobar does not exist. To create it: "!locker label create foobar"')
     end
 
     it 'accepts a comma-separated list of labels' do
@@ -108,7 +108,7 @@ describe Lita::Handlers::LockerLabels, lita_handler: true do
 
     it 'shows an error if the label does not exist' do
       send_command('locker label show foobar')
-      expect(replies.last).to eq('Label foobar does not exist.  To create it: "!locker label create foobar"')
+      expect(replies.last).to eq('Label foobar does not exist. To create it: "!locker label create foobar"')
     end
   end
 
@@ -144,7 +144,7 @@ describe Lita::Handlers::LockerLabels, lita_handler: true do
 
     it 'shows an error if the label does not exist' do
       send_command('locker label add foo to bar')
-      expect(replies.last).to eq('Label bar does not exist.  To create it: "!locker label create bar"')
+      expect(replies.last).to eq('Label bar does not exist. To create it: "!locker label create bar"')
     end
 
     it 'shows an error if the resource does not exist' do
@@ -182,12 +182,12 @@ describe Lita::Handlers::LockerLabels, lita_handler: true do
 
     it 'shows an error if the label does not exist' do
       send_command('locker label add foo to bar')
-      expect(replies.last).to eq('Label bar does not exist.  To create it: "!locker label create bar"')
+      expect(replies.last).to eq('Label bar does not exist. To create it: "!locker label create bar"')
     end
 
     it 'shows an error if the label does not exist when given a list of resources' do
       send_command('locker label add foo, baz to bar')
-      expect(replies.last).to eq('Label bar does not exist.  To create it: "!locker label create bar"')
+      expect(replies.last).to eq('Label bar does not exist. To create it: "!locker label create bar"')
     end
 
     it 'shows an error if the resource does not exist' do

data/spec/lita/handlers/locker_misc_spec.rb

@@ -57,25 +57,25 @@ describe Lita::Handlers::LockerMisc, lita_handler: true do
 
     it 'shows a warning if the label does not exist' do
       send_command('locker log something')
-      expect(replies.last).to eq('Sorry, that does not exist')
+      expect(replies.last).to eq('something does not exist')
     end
   end
 
   describe '#dequeue' do
-    it 'shows a successful dequeue' do
+    before(:each) do
       send_command('locker resource create bar')
       send_command('locker label create foo')
       send_command('locker label add bar to foo')
+    end
+
+    it 'shows a successful dequeue' do
       send_command('lock foo', as: alice)
       send_command('lock foo', as: bob)
       send_command('locker dequeue foo', as: bob)
-      expect(replies.last).to eq('You have been removed from the queue for foo')
+      expect(replies.last).to eq('Bob has been removed from the queue for foo')
     end
 
     it 'avoids adjacent duplicates in the queue when a sandwiched dequeue occurs' do
-      send_command('locker resource create bar')
-      send_command('locker label create foo')
-      send_command('locker label add bar to foo')
       send_command('lock foo', as: alice)
       send_command('lock foo', as: bob)
       send_command('lock foo', as: doris)
@@ -84,6 +84,14 @@ describe Lita::Handlers::LockerMisc, lita_handler: true do
       send_command('locker status foo')
       expect(replies.last).to match(/^foo is locked by Alice \(taken \d seconds? ago\)\. Next up: Bob$/)
     end
+
+    it 'does not allow a user who is not in the queue to dequeue' do
+      send_command('lock foo', as: alice)
+      send_command('lock foo', as: bob)
+      send_command('unlock foo', as: alice)
+      send_command('locker dq foo', as: bob)
+      expect(replies.last).to match(/^Bob, you weren't in the queue for foo$/)
+    end
   end
 
   describe '#status' do
@@ -142,7 +150,7 @@ describe Lita::Handlers::LockerMisc, lita_handler: true do
       send_command('locker label create bazbar')
       send_command('locker label add bazbarluhrmann to bazbar')
       send_command('locker status foo')
-      expect(replies.last).to eq('Sorry, that does not exist. Use * for wildcard search')
+      expect(replies.last).to eq('foo does not exist. Use * for wildcard search')
     end
   end
 
@@ -179,16 +187,16 @@ describe Lita::Handlers::LockerMisc, lita_handler: true do
       send_command('locker label create bazbat')
       send_command('locker label add foobar to bazbat')
       send_command('locker list Alice', as: alice)
-      expect(replies.last).to eq('That user has no active locks')
+      expect(replies.last).to eq('Alice has no active locks')
       send_command('lock bazbat', as: alice)
       send_command('unlock bazbat', as: alice)
       send_command('locker list Alice', as: alice)
-      expect(replies.last).to eq('That user has no active locks')
+      expect(replies.last).to eq('Alice has no active locks')
     end
 
     it 'shows a warning when the user does not exist' do
       send_command('locker list foobar')
-      expect(replies.last).to eq('Unknown user')
+      expect(replies.last).to eq("Unknown user 'foobar'")
     end
   end
 end

data/spec/lita/handlers/locker_spec.rb

@@ -74,9 +74,9 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker resource create foobar')
       send_command('locker label create bazbat')
       send_command('locker label add foobar to bazbat')
-      send_command('lock bazbat')
-      send_command('lock bazbat')
-      expect(replies.last).to eq('You already have the lock on bazbat')
+      send_command('lock bazbat', as: alice)
+      send_command('lock bazbat', as: alice)
+      expect(replies.last).to eq('Alice, you already have the lock on bazbat')
     end
 
     it 'does not add a user multiple times to the end of a queue' do
@@ -134,7 +134,37 @@ describe Lita::Handlers::Locker, lita_handler: true do
 
     it 'shows an error when a label does not exist' do
       send_command('lock foobar')
-      expect(replies.last).to eq('Label foobar does not exist.  To create it: "!locker label create foobar"')
+      expect(replies.last).to eq('Label foobar does not exist. To create it: "!locker label create foobar"')
+    end
+
+    context 'when mentioning a user' do
+      before(:each) do
+        send_command('locker resource create foobar')
+        send_command('locker label create bazbat')
+        send_command('locker label add foobar to bazbat')
+      end
+
+      it 'only uses a full name when the user has no mention name' do
+        david = Lita::User.create('123', name: 'David', mention_name: nil)
+        send_command('lock bazbat', as: david)
+        send_command('lock bazbat', as: bob)
+        expect(replies.last).to match(/^bazbat is locked by David  \(taken/)
+      end
+
+      it "includes the user's mention name in Hipchat" do
+        allow(robot.config.robot).to receive(:adapter).and_return('hipchat')
+        send_command('lock bazbat', as: alice)
+        send_command('lock bazbat', as: bob)
+        expect(replies.last).to match(/^\(failed\) bazbat is locked by Alice \(@alice\) \(taken/)
+      end
+
+      it 'uses the correct mention formatting in Slack' do
+        allow(robot.config.robot).to receive(:adapter).and_return('slack')
+        emily = Lita::User.create('U12345678', name: 'Emily', mention_name: 'emily')
+        send_command('lock bazbat', as: emily)
+        send_command('lock bazbat', as: bob)
+        expect(replies.last).to match(/^:failed: bazbat is locked by Emily \(<@U12345678\|emily>\) \(taken/)
+      end
     end
   end
 
@@ -225,7 +255,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
 
     it 'shows an error when a <subject> does not exist' do
       send_command('unlock foobar')
-      expect(replies.last).to eq('Sorry, that does not exist')
+      expect(replies.last).to eq('foobar does not exist')
     end
   end
 
@@ -236,7 +266,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker label add foobar to bazbat')
       send_command('lock bazbat', as: alice)
       send_command('steal bazbat # with a comment', as: bob)
-      expect(replies.last).to eq('bazbat stolen from Alice (@alice)')
+      expect(replies.last).to eq('Bob stole bazbat from Alice (@alice)')
     end
 
     it 'preserves the state of the queue when there is one' do
@@ -264,12 +294,12 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker label add foobar to bazbat')
       send_command('lock bazbat', as: alice)
       send_command('steal bazbat # with a comment', as: alice)
-      expect(replies.last).to eq('Why are you stealing the lock from yourself?')
+      expect(replies.last).to eq('Alice, why are you stealing the lock from yourself?')
     end
 
     it 'shows an error when a <subject> does not exist' do
       send_command('steal foobar')
-      expect(replies.last).to eq('Sorry, that does not exist')
+      expect(replies.last).to eq('foobar does not exist')
     end
   end
 
@@ -301,7 +331,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker label add foobar to bazbat')
       send_command('lock bazbat', as: alice)
       send_command('locker give bazbat to @alice # with a comment', as: alice)
-      expect(replies.last).to eq('Why are you giving the lock to yourself?')
+      expect(replies.last).to eq('Alice, why are you giving the lock to yourself?')
     end
 
     it 'shows an error when the attempted giver is not the owner' do
@@ -315,7 +345,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
 
     it 'shows an error when the label does not exist' do
       send_command('locker give foobar to @bob', as: alice)
-      expect(replies.last).to eq('Sorry, that does not exist')
+      expect(replies.last).to eq('foobar does not exist')
     end
 
     it 'shows an error when the recipient does not exist' do
@@ -324,7 +354,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker label add foobar to bazbat')
       send_command('lock bazbat', as: alice)
       send_command('locker give bazbat to @doris', as: alice)
-      expect(replies.last).to eq('Unknown user')
+      expect(replies.last).to eq("Unknown user 'doris'")
     end
   end
 
@@ -334,7 +364,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker label create bazbat')
       send_command('locker label add foobar to bazbat')
       send_command('locker observe bazbat', as: alice)
-      expect(replies.last).to eq('Now observing bazbat')
+      expect(replies.last).to eq('Alice is now observing bazbat')
     end
 
     it 'warns user if already observing label' do
@@ -343,7 +373,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker label add foobar to bazbat')
       send_command('locker observe bazbat', as: alice)
       send_command('locker observe bazbat', as: alice)
-      expect(replies.last).to eq('You are already observing bazbat')
+      expect(replies.last).to eq('Alice, you are already observing bazbat')
     end
   end
 
@@ -354,7 +384,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker label add foobar to bazbat')
       send_command('locker observe bazbat', as: alice)
       send_command('locker unobserve bazbat', as: alice)
-      expect(replies.last).to eq('You have stopped observing bazbat')
+      expect(replies.last).to eq('Alice, you have stopped observing bazbat')
     end
 
     it 'warns user if already not observing label' do
@@ -364,7 +394,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker observe bazbat', as: alice)
       send_command('locker unobserve bazbat', as: alice)
       send_command('locker unobserve bazbat', as: alice)
-      expect(replies.last).to eq('You were not observing bazbat originally')
+      expect(replies.last).to eq('Alice, you were not observing bazbat')
     end
   end
 end

data/templates/mention.erb

@@ -0,0 +1 @@
+<% unless @name.empty? %>(@<%= @name %>)<% end %>

data/templates/mention.hipchat.erb

@@ -0,0 +1 @@
+(@<%= @name %>)

data/templates/mention.slack.erb

@@ -0,0 +1 @@
+(<@<%= @id %>|<%= @name %>>)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-locker
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Eric Sigler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -178,6 +178,9 @@ files:
 - templates/lock.erb
 - templates/lock.hipchat.erb
 - templates/lock.slack.erb
+- templates/mention.erb
+- templates/mention.hipchat.erb
+- templates/mention.slack.erb
 - templates/success.erb
 - templates/success.hipchat.erb
 - templates/success.slack.erb