lita-locker 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51d68722a9a837146295120ccd13ec48d9135bbe
-  data.tar.gz: a821ec80a688f3b6ff13cae131d6fddb3c2233a5
+  metadata.gz: f96bd48a3cc828d528cce0186e9f06b17eb00447
+  data.tar.gz: 1f7497cce3183e0e76c330a75515da10871b13d5
 SHA512:
-  metadata.gz: 793ac5553e20c774572bc4f558c9badc5086b03689c5bcb8f5f48e2e5acc0d9633940a3f0bb1e3d509450fbfb47a93682477f20166e970b383e3c177b0acbef1
-  data.tar.gz: f7c7b6596d3b5d1a5b7eadedcdd9c0fad27cc929cfd4a650da06890cfb43227cf01b4d259542cc050466e95583c8955b0e79de14e790d6bce647db69a5ff427e
+  metadata.gz: a24977fe218e05da74fc7c153fb3f01034a57286f38c2440bb1c9be16952d306e4fb4dcb910d066c12bca99c39d02740b5984524db841e94244d8c305708eb53
+  data.tar.gz: f815885ce041b6fafd846bc052a458c920fc3765093de89ec8d26c31e144793e637ae8e43ab620af979bc7d313bf639dec81720faece20822f72c88940f7b2b6

data/lib/lita/handlers/locker.rb

@@ -41,6 +41,13 @@ module Lita
         help: { t('help.steal.syntax') => t('help.steal.desc') }
       )
 
+      route(
+        /^locker\sgive\s#{LABEL_REGEX}\sto\s#{USER_REGEX}#{COMMENT_REGEX}$/,
+        :give,
+        command: true,
+        help: { t('help.give.syntax') => t('help.give.desc') }
+      )
+
       route(
         /^locker\sobserve\s#{LABEL_REGEX}#{COMMENT_REGEX}$/,
         :observe,
@@ -118,8 +125,33 @@ module Lita
         response.reply(attempt_steal(name, response.user))
       end
 
+      def give(response)
+        name = response.match_data['label'].rstrip
+
+        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})" : ''
+        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
+
+        response.reply(attempt_give(name, response.user, recipient))
+      end
+
       private
 
+      def attempt_give(name, giver, recipient)
+        label = Label.new(name)
+        return t('give.self') if recipient == giver
+        old_owner = label.owner
+        label.give!(recipient.id)
+        mention = recipient.mention_name ? "(@#{recipient.mention_name})" : ''
+        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

data/lib/lita/handlers/locker_misc.rb

@@ -58,11 +58,7 @@ module Lita
         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)
-        queued = l.wait_queue.to_a
-        l.wait_queue.clear
-        queued.chunk { |x| x }.map(&:first).each do |user|
-          l.wait_queue << user
-        end
+        l.dedupe!
         response.reply(t('label.removed_from_queue', name: name))
       end
 

data/lib/locker/label.rb

@@ -103,9 +103,25 @@ module Locker
       def steal!(owner_id)
         log("Stolen from #{owner.id} to #{owner_id}")
         wait_queue.unshift(owner_id)
+        self.dedupe!
         self.unlock!
       end
 
+      def give!(recipient_id)
+        log("Given from #{owner.id} to #{recipient_id}")
+        wait_queue.unshift(recipient_id)
+        self.dedupe!
+        self.unlock!
+      end
+
+      def dedupe!
+        queued = wait_queue.to_a
+        wait_queue.clear
+        queued.chunk { |x| x }.map(&:first).each do |user|
+          wait_queue << user
+        end
+      end
+
       def add_observer!(observer_id)
         observer_ids.add(observer_id)
       end

data/lita-locker.gemspec

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

data/locales/en.yml

@@ -6,6 +6,10 @@ en:
           stolen: "%{label} stolen from %{old_owner} %{mention}"
           already_unlocked: "%{label} was already unlocked"
           self: 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?
         observe:
           now_observing: "Now observing %{name}"
           already_observing: "You are already observing %{name}"
@@ -33,6 +37,9 @@ en:
           steal:
             syntax: steal <subject>
             desc: Force removal of a reservation. Can have # comments afterwards.
+          give:
+            syntax: give <subject> to <username>
+            desc: Transfer ownership of a lock to another user. Can have # comments afterwards.
           status:
             syntax: locker status <label or resource>
             desc: Show the current state of <label or resource>

data/spec/lita/handlers/locker_misc_spec.rb

@@ -80,7 +80,7 @@ describe Lita::Handlers::LockerMisc, lita_handler: true do
       send_command('lock foo', as: bob)
       send_command('locker dequeue foo', as: doris)
       send_command('locker status foo')
-      expect(replies.last).to eq('foo is locked by Alice (taken 1 second ago). Next up: Bob')
+      expect(replies.last).to match(/^foo is locked by Alice \(taken \d seconds? ago\)\. Next up: Bob$/)
     end
   end
 
@@ -93,13 +93,13 @@ describe Lita::Handlers::LockerMisc, lita_handler: true do
       expect(replies.last).to eq('foo is unlocked')
       send_command('lock foo')
       send_command('locker status foo')
-      expect(replies.last).to eq('foo is locked by Test User (taken 1 second ago)')
+      expect(replies.last).to match(/^foo is locked by Test User \(taken \d seconds? ago\)$/)
       send_command('lock foo', as: alice)
       send_command('locker status foo')
-      expect(replies.last).to eq('foo is locked by Test User (taken 1 second ago). Next up: Alice')
+      expect(replies.last).to match(/^foo is locked by Test User \(taken \d seconds? ago\)\. Next up: Alice$/)
       send_command('lock foo', as: bob)
       send_command('locker status foo')
-      expect(replies.last).to eq('foo is locked by Test User (taken 1 second ago). Next up: Alice, Bob')
+      expect(replies.last).to match(/^foo is locked by Test User \(taken \d seconds? ago\)\. Next up: Alice, Bob$/)
     end
 
     it 'shows the status of a resource' do

data/spec/lita/handlers/locker_spec.rb

@@ -30,6 +30,8 @@ describe Lita::Handlers::Locker, lita_handler: true do
       is_expected.to route_command("steal #{l}").to(:steal)
       is_expected.to route_command("steal #{l} ").to(:steal)
       is_expected.to route_command("steal #{l} #this is a comment").to(:steal)
+      is_expected.to route_command("locker give #{l} to alice").to(:give)
+      is_expected.to route_command("locker give #{l} to alice #this is a comment").to(:give)
       is_expected.to route_command("locker observe #{l}").to(:observe)
       is_expected.to route_command("locker observe #{l} #this is a comment").to(:observe)
       is_expected.to route_command("locker unobserve #{l}").to(:unobserve)
@@ -37,15 +39,15 @@ describe Lita::Handlers::Locker, lita_handler: true do
     end
   end
 
-  let(:alice) do
+  let!(:alice) do
     Lita::User.create('9001@hipchat', name: 'Alice', mention_name: 'alice')
   end
 
-  let(:bob) do
+  let!(:bob) do
     Lita::User.create('9002@hipchat', name: 'Bob', mention_name: 'bob')
   end
 
-  let(:charlie) do
+  let!(:charlie) do
     Lita::User.create('9003@hipchat', name: 'Charlie', mention_name: 'charlie')
   end
 
@@ -85,7 +87,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('lock bazbat', as: bob)
       send_command('lock bazbat', as: bob)
       send_command('locker status bazbat')
-      expect(replies.last).to eq('bazbat is locked by Alice (taken 1 second ago). Next up: Bob')
+      expect(replies.last).to match(/^bazbat is locked by Alice \(taken \d seconds? ago\)\. Next up: Bob$/)
     end
 
     it 'shows a warning when a label has no resources' do
@@ -125,8 +127,9 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('locker label add foobar to bazbat')
       send_command('lock bazbat', as: alice)
       send_command('lock bazbat', as: bob)
-      expect(replies.last).to eq('bazbat is locked by Alice (@alice) (taken 1 second ago), you have been ' \
-                                 'added to the queue (currently: Bob), type \'locker dequeue bazbat\' to be removed')
+      # rubocop:disable Metrics/LineLength
+      expect(replies.last).to match(/^bazbat is locked by Alice \(@alice\) \(taken \d seconds? ago\), you have been added to the queue \(currently: Bob\), type 'locker dequeue bazbat' to be removed$/)
+      # rubocop:enable Metrics/LineLength
     end
 
     it 'shows an error when a label does not exist' do
@@ -208,7 +211,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('unlock bazbat', as: bob)
-      expect(replies.last).to eq('bazbat is locked by Alice (@alice) (taken 1 second ago)')
+      expect(replies.last).to match(/^bazbat is locked by Alice \(@alice\) \(taken \d seconds? ago\)$/)
     end
 
     it 'shows a warning when a label is already unlocked' do
@@ -244,7 +247,7 @@ describe Lita::Handlers::Locker, lita_handler: true do
       send_command('lock bazbat', as: bob)
       send_command('steal bazbat', as: charlie)
       send_command('locker status bazbat')
-      expect(replies.last).to eq('bazbat is locked by Charlie (taken 1 second ago). Next up: Bob')
+      expect(replies.last).to match(/^bazbat is locked by Charlie \(taken \d seconds? ago\)\. Next up: Bob$/)
     end
 
     it 'shows a warning when the label is already unlocked' do
@@ -270,6 +273,61 @@ describe Lita::Handlers::Locker, lita_handler: true do
     end
   end
 
+  describe '#give' do
+    it 'transfers a lock from the owner to a recipient' 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', as: alice)
+      send_command('locker give bazbat to @bob # with a comment', as: alice)
+      expect(replies.last).to eq('Alice gave bazbat to Bob (@bob)')
+    end
+
+    it 'preserves the state of the queue when there is one' 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', as: alice)
+      send_command('lock bazbat', as: bob)
+      send_command('lock bazbat', as: charlie)
+      send_command('locker give bazbat to @charlie # with a comment', as: alice)
+      send_command('locker status bazbat')
+      expect(replies.last).to match(/^bazbat is locked by Charlie \(taken \d seconds? ago\)\. Next up: Bob, Charlie$/)
+    end
+
+    it 'shows a warning when the owner attempts to give the label to herself' 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', 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?')
+    end
+
+    it 'shows an error when the attempted giver is not the owner' 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', as: alice)
+      send_command('locker give bazbat to @charlie # with a comment', as: bob)
+      expect(replies.last).to eq('The lock on bazbat can only be given by its current owner: Alice (@alice)')
+    end
+
+    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')
+    end
+
+    it 'shows an error when the recipient does not exist' 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', as: alice)
+      send_command('locker give bazbat to @doris', as: alice)
+      expect(replies.last).to eq('Unknown user')
+    end
+  end
+
   describe '#observe' do
     it 'adds a user as observer of a label' do
       send_command('locker resource create foobar')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-locker
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Eric Sigler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita