lita-locker 1.0.10 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40b2882a9408152241aaa1539bf1c7924e15bcf4
-  data.tar.gz: 58217f843456a9b13dc82230a79f8f5a99131b78
+  metadata.gz: 40e3c6cfb38098e4089ab667b84796cf38dddb98
+  data.tar.gz: 01c834e9d945c39cf53fa37c5984384505f557b8
 SHA512:
-  metadata.gz: 94cc269c2fcaf2f71a40ed8e2cebf134d9a3441abdcc4ef17b44f0ed3517b1c2f57fb67fa90e6ba76cef4ef20a64d12de2fc60a06e143bc80bf4bf922dbda8da
-  data.tar.gz: 6f752941bf65bd8452daa06a86ee04a77059aadff2768974e19e0b3928b752fc70d2b34b4c8abe8023a0578bf4ef6600ca88fb737b9a273672348e0d5ec508d7
+  metadata.gz: f9d7e3f1151c101a757688053d3d8f82f446db64e7bacabb72ee9baa064f1221f6489ec6d891201eba9c2284158ae6f59c2c31300918d84be75d10d6ad9cb674
+  data.tar.gz: bde7f3cf399c8e069ab48bdf7fc48b93f1aad29ef6d2fbbdb2dad7684291ab28f2bf9ad0cafc37d05227ed443e87c951992519636f640df26e746eef1d06fb66

data/.rubocop.yml

@@ -3,7 +3,7 @@ FileName:
     - lib/lita-locker.rb
 
 LineLength:
-  Max: 130
+  Max: 150
 
 AbcSize:
   Max: 34
@@ -12,4 +12,7 @@ MethodLength:
   Max: 20
 
 ClassLength:
-  Max: 150
+  Max: 151
+
+Metrics/BlockLength:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
-  - 2.1
-  - 2.2
+  - 2.4
 cache: bundler
 sudo: false
 services:

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -19,7 +19,16 @@ gem "lita-locker"
 
 ## Configuration
 
-None
+### Optional attributes
+
+* `per_page` - The number of items to show at once when listing labels or resources. Default: 10
+
+### Example
+
+``` ruby
+Lita.configure do |config|
+  config.handlers.locker.per_page = 3
+```
 
 ## Usage
 
@@ -61,7 +70,7 @@ locker dequeue <label> - Remove yourself from the queue for <label>
 
 ### Labels
 ```
-locker label list                          - List all labels
+locker label list [--page N]               - List all labels
 locker label create <name>                 - Create a label with <name>.
 locker label delete <name>                 - Delete the label with <name>.  Clears all locks associated.
 locker label add <resource> to <name>      - Adds <resource> to the list of things to lock/unlock for <name>
@@ -71,10 +80,10 @@ locker label show <name>                   - Show all resources for <name>
 
 ### Resources
 ```
-locker resource list          - List all resources
-locker resource create <name> - Create a resource with <name>.  (Restricted to locker_admins group)
-locker resource delete <name> - Delete the resource with <name>.  Clears all locks associated.  (Restricted to locker_admins group)
-locker resource show <name>   - Show the state of <name>
+locker resource list [--page N]   - List all resources
+locker resource create <name>     - Create a resource with <name>.  (Restricted to locker_admins group)
+locker resource delete <name>     - Delete the resource with <name>.  Clears all locks associated.  (Restricted to locker_admins group)
+locker resource show <name>       - Show the state of <name>
 ```
 
 ### HTTP access

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
@@ -5,4 +7,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]

data/lib/lita-locker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'lita'
 
 Lita.load_locales Dir[File.expand_path(
@@ -6,6 +8,7 @@ Lita.load_locales Dir[File.expand_path(
 
 require 'redis-objects'
 require 'time-lord'
+require 'lita-keyword-arguments'
 
 require 'locker/label'
 require 'locker/misc'

data/lib/lita/handlers/locker.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Lita
   # Handy, isn't it?
   module Handlers
     # Top-level class for Locker
     class Locker < Handler
+      config :per_page, type: Integer, default: 10
+
       on :loaded, :setup_redis
 
       include ::Locker::Label
@@ -72,7 +76,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(failed(t('label.no_resources', name: name))) unless l.membership.count.positive?
         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)
 
@@ -134,10 +138,12 @@ module Lita
         l = Label.new(name)
         return response.reply(failed(t('give.not_owned', label: name))) unless l.locked?
         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
+        unless l.owner == response.user
+          return response.reply(t('give.not_owner',
+                                  label: name,
+                                  owner: l.owner.name,
+                                  mention: owner_mention))
+        end
         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

data/lib/lita/handlers/locker_events.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lita
   module Handlers
     # Event-related handlers

data/lib/lita/handlers/locker_http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lita
   module Handlers
     # HTTP-related handlers

data/lib/lita/handlers/locker_labels.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'locker/list'
+
 module Lita
   module Handlers
     # Label-related handlers
@@ -10,64 +14,77 @@ module Lita
       include ::Locker::Resource
 
       route(
-        /^locker\slabel\slist$/,
+        /^locker\slabel\slist/,
         :list,
         command: true,
+        kwargs: { page: { default: 1 } },
         help: { t('help.label.list.syntax') => t('help.label.list.desc') }
       )
 
       route(
-        /^locker\slabel\screate\s#{LABELS_REGEX}$/,
+        /^locker\slabel\screate\s#{LABELS_REGEX}#{COMMENT_REGEX}$/,
         :create,
         command: true,
         help: { t('help.label.create.syntax') => t('help.label.create.desc') }
       )
 
       route(
-        /^locker\slabel\sdelete\s#{LABELS_REGEX}$/,
+        /^locker\slabel\sdelete\s#{LABELS_REGEX}#{COMMENT_REGEX}$/,
         :delete,
         command: true,
         help: { t('help.label.delete.syntax') => t('help.label.delete.desc') }
       )
 
       route(
-        /^locker\slabel\sshow\s#{LABEL_REGEX}$/,
+        /^locker\slabel\sshow\s#{LABEL_REGEX}#{COMMENT_REGEX}$/,
         :show,
         command: true,
         help: { t('help.label.show.syntax') => t('help.label.show.desc') }
       )
 
       route(
-        /^locker\slabel\sadd\s#{RESOURCES_REGEX}\sto\s#{LABEL_REGEX}$/,
+        /^locker\slabel\sadd\s#{RESOURCES_REGEX}\sto\s#{LABEL_REGEX}#{COMMENT_REGEX}$/,
         :add,
         command: true,
         help: { t('help.label.add.syntax') => t('help.label.add.desc') }
       )
 
       route(
-        /^locker\slabel\sremove\s#{RESOURCES_REGEX}\sfrom\s#{LABEL_REGEX}$/,
+        /^locker\slabel\sremove\s#{RESOURCES_REGEX}\sfrom\s#{LABEL_REGEX}#{COMMENT_REGEX}$/,
         :remove,
         command: true,
         help: { t('help.label.remove.syntax') => t('help.label.remove.desc') }
       )
 
       def list(response)
-        after 0 do
-          should_rate_limit = false
+        begin
+          list = ::Locker::List.new(Label, config.per_page, response.extensions[:kwargs][:page])
+        rescue ArgumentError
+          return response.reply(t('list.invalid_page_type'))
+        end
 
-          Label.list.each_slice(5) do |slice|
-            if should_rate_limit
-              sleep 3
-            else
-              should_rate_limit = true
-            end
+        return response.reply(t('list.page_outside_range', pages: list.pages)) unless list.valid_page?
 
-            slice.each do |n|
-              l = Label.new(n)
-              response.reply(unlocked(t('label.desc', name: n, state: l.state.value)))
-            end
+        message = list.requested_page.map do |key|
+          label = Label.new(key)
+
+          state = label.state.value.to_s
+
+          case state
+          when 'unlocked'
+            unlocked(t('label.desc', name: key, state: state))
+          when 'locked'
+            locked(t('label.desc', name: key, state: state))
+          else
+            # This case shouldn't happen, but it will if a label
+            # gets saved with some other value for `state`.
+            t('label.desc', name: key, state: state)
           end
-        end
+        end.join("\n")
+
+        message += "\n#{t('list.paginate', page: list.page, pages: list.pages)}" if list.multiple_pages?
+
+        response.reply(message)
       end
 
       def create(response)
@@ -104,7 +121,7 @@ module Lita
         name = response.match_data['label']
         return response.reply(failed(t('label.does_not_exist', name: name))) unless Label.exists?(name)
         l = Label.new(name)
-        return response.reply(t('label.has_no_resources', name: name)) unless l.membership.count > 0
+        return response.reply(t('label.has_no_resources', name: name)) unless l.membership.count.positive?
         res = []
         l.membership.each do |member|
           res.push(member)

data/lib/lita/handlers/locker_misc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Lita
   module Handlers
     # Misc Locker handlers
@@ -10,28 +12,28 @@ module Lita
       include ::Locker::Resource
 
       route(
-        /^locker\sstatus\s#{LABEL_WILDCARD_REGEX}$/,
+        /^locker\sstatus\s#{LABEL_WILDCARD_REGEX}#{COMMENT_REGEX}$/,
         :status,
         command: true,
         help: { t('help.status.syntax') => t('help.status.desc') }
       )
 
       route(
-        /^locker\slist\s#{USER_REGEX}$/,
+        /^locker\slist\s#{USER_REGEX}#{COMMENT_REGEX}$/,
         :list,
         command: true,
         help: { t('help.list.syntax') => t('help.list.desc') }
       )
 
       route(
-        /^locker\s(dq|dequeue)\s#{LABEL_REGEX}$/,
+        /^locker\s(dq|dequeue)\s#{LABEL_REGEX}#{COMMENT_REGEX}$/,
         :dequeue,
         command: true,
         help: { t('help.dequeue.syntax') => t('help.dequeue.desc') }
       )
 
       route(
-        /^locker\slog\s#{LABEL_REGEX}$/,
+        /^locker\slog\s#{LABEL_REGEX}#{COMMENT_REGEX}$/,
         :log,
         command: true,
         help: { t('help.log.syntax.') => t('help.log.desc') }
@@ -48,7 +50,7 @@ module Lita
 
       def status(response)
         name = response.match_data['label']
-        unless name =~ /\*/
+        unless name.match?(/\*/)
           # Literal query
           return response.reply(status_label(name)) if Label.exists?(name)
           return response.reply(status_resource(name)) if Resource.exists?(name)
@@ -90,7 +92,7 @@ module Lita
       def status_label(name)
         l = Label.new(name)
         return unlocked(t('label.desc', name: name, state: l.state.value)) unless l.locked?
-        if l.wait_queue.count > 0
+        if l.wait_queue.count.positive?
           queue = []
           l.wait_queue.each do |u|
             usr = Lita::User.find_by_id(u)

data/lib/lita/handlers/locker_resources.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'locker/list'
+
 module Lita
   module Handlers
     # Resource-related handlers
@@ -10,14 +14,15 @@ module Lita
       include ::Locker::Resource
 
       route(
-        /^locker\sresource\slist$/,
+        /^locker\sresource\slist/,
         :list,
         command: true,
+        kwargs: { page: { default: 1 } },
         help: { t('help.resource.list.syntax') => t('help.resource.list.desc') }
       )
 
       route(
-        /^locker\sresource\screate\s#{RESOURCES_REGEX}$/,
+        /^locker\sresource\screate\s#{RESOURCES_REGEX}#{COMMENT_REGEX}$/,
         :create,
         command: true,
         restrict_to: [:locker_admins],
@@ -27,7 +32,7 @@ module Lita
       )
 
       route(
-        /^locker\sresource\sdelete\s#{RESOURCES_REGEX}$/,
+        /^locker\sresource\sdelete\s#{RESOURCES_REGEX}#{COMMENT_REGEX}$/,
         :delete,
         command: true,
         restrict_to: [:locker_admins],
@@ -37,29 +42,41 @@ module Lita
       )
 
       route(
-        /^locker\sresource\sshow\s#{RESOURCE_REGEX}$/,
+        /^locker\sresource\sshow\s#{RESOURCE_REGEX}#{COMMENT_REGEX}$/,
         :show,
         command: true,
         help: { t('help.resource.show.syntax') => t('help.resource.show.desc') }
       )
 
       def list(response)
-        after 0 do
-          should_rate_limit = false
-
-          Resource.list.each_slice(5) do |slice|
-            if should_rate_limit
-              sleep 3
-            else
-              should_rate_limit = true
-            end
-
-            slice.each do |r|
-              res = Resource.new(r)
-              response.reply(t('resource.desc', name: r, state: res.state.value))
-            end
-          end
+        begin
+          list = ::Locker::List.new(Resource, config.per_page, response.extensions[:kwargs][:page])
+        rescue ArgumentError
+          return response.reply(t('list.invalid_page_type'))
         end
+
+        return response.reply(t('list.page_outside_range', pages: list.pages)) unless list.valid_page?
+
+        message = list.requested_page.map do |key|
+          resource = Resource.new(key)
+
+          state = resource.state.value
+
+          case state
+          when 'unlocked'
+            unlocked(t('resource.desc', name: key, state: state))
+          when 'locked'
+            locked(t('resource.desc', name: key, state: state))
+          else
+            # This case shouldn't happen, but it will if a label
+            # gets saved with some other value for `state`.
+            t('resource.desc', name: key, state: state)
+          end
+        end.join("\n")
+
+        message += "\n#{t('list.paginate', page: list.page, pages: list.pages)}" if list.multiple_pages?
+
+        response.reply(message)
       end
 
       def create(response)
@@ -99,7 +116,7 @@ module Lita
         return response.reply(t('resource.does_not_exist', name: name)) unless Resource.exists?(name)
         r = Resource.new(name)
         resp = t('resource.desc', name: name, state: r.state.value)
-        if r.labels.count > 0
+        if r.labels.count.positive?
           resp += ', used by: '
           r.labels.each do |label|
             resp += Label.new(label).id

data/lib/locker/label.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Locker subsystem
 module Locker
   # Label helpers
@@ -40,7 +42,7 @@ module Locker
 
       def self.delete(key)
         raise 'Unknown label key' unless Label.exists?(key)
-        %w(state, owner_id, membership, wait_queue, journal, observer_ids).each do |item|
+        %w[state owner_id membership wait_queue journal observer_ids].each do |item|
           redis.del("label:#{key}:#{item}")
         end
         redis.srem('label-list', Label.normalize(key))
@@ -93,7 +95,7 @@ module Locker
         log('Unlocked')
 
         # FIXME: Possible race condition where resources become unavailable between unlock and relock
-        if wait_queue.count > 0
+        if wait_queue.count.positive?
           next_user = wait_queue.shift
           lock!(next_user)
         end
@@ -207,9 +209,7 @@ module Locker
       l = Label.new(name)
       l.membership.each do |resource_name|
         resource = Locker::Resource::Resource.new(resource_name)
-        if resource.state.value == 'locked'
-          deps.push "#{resource_name} - #{resource.owner.name}"
-        end
+        deps.push "#{resource_name} - #{resource.owner.name}" if resource.state.value == 'locked'
       end
       msg += deps.join("\n")
       msg

data/lib/locker/list.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Locker subsystem
+module Locker
+  # A paginated list of items (e.g. labels or resources).
+  #
+  # @api private
+  class List
+    # @return [#list] The Ruby class of the item to be listed.
+    attr_reader :item_class
+
+    # @return [Enumerable] The full list of items.
+    attr_reader :list
+
+    # @return [Integer] The number of items displayed per page.
+    attr_reader :per_page
+
+    # @return [Integer] The page the user has requested.
+    attr_reader :page
+
+    # @return [Integer] The total number of pages.
+    attr_reader :pages
+
+    # @return [Integer] The zero-based index offset that the requested page starts on within the full list.
+    attr_reader :offset
+
+    def initialize(item_class, per_page, page)
+      @item_class = item_class
+      @list = item_class.list
+      @per_page = per_page
+      @page = Integer(page.to_s, 10)
+      @pages = (list.count / per_page).ceil + 1
+      @offset = per_page * (self.page - 1)
+    end
+
+    # Whether or not the list has multiple pages.
+    #
+    # @return [Boolean]
+    def multiple_pages?
+      list.count > per_page
+    end
+
+    # An enumerable of the items in the requested page.
+    #
+    # @return [Enumerable]
+    def requested_page
+      list[offset, per_page]
+    end
+
+    # Whether or not the requested page exists.
+    #
+    # @return [Boolean]
+    def valid_page?
+      page >= 1 && page <= pages
+    end
+  end
+end

data/lib/locker/misc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Locker subsystem
 module Locker
   # Misc helpers

data/lib/locker/regex.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Locker subsystem
 module Locker
   # Regex definitions

data/lib/locker/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Locker subsystem
 module Locker
   # Resource helpers
@@ -34,7 +36,7 @@ module Locker
 
       def self.delete(key)
         raise 'Unknown resource key' unless Resource.exists?(key)
-        %w(state, owner_id).each do |item|
+        %w[state owner_id].each do |item|
           redis.del("resource:#{key}:#{item}")
         end
         redis.srem('resource-list', key)

data/lita-locker.gemspec

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |spec|
   spec.name          = 'lita-locker'
-  spec.version       = '1.0.10'
+  spec.version       = '1.1.0'
   spec.authors       = ['Eric Sigler']
   spec.email         = ['me@esigler.com']
   spec.description   = '"lock" and "unlock" arbitrary subjects'
@@ -15,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'lita', '>= 4.2'
+  spec.add_runtime_dependency 'lita-keyword-arguments'
   spec.add_runtime_dependency 'redis-objects'
   spec.add_runtime_dependency 'time-lord'
 

data/locales/en.yml

@@ -16,6 +16,10 @@ en:
           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}"
+        list:
+          paginate: "Page %{page} of %{pages} shown. Use --page to specify additional pages."
+          invalid_page_type: "Page specified must be an integer."
+          page_outside_range: "Page specified must be between 1 and %{pages}."
         help:
           log:
             syntax: locker log <label>
@@ -49,7 +53,7 @@ en:
             desc: Show what locks a user currently holds
           resource:
             list:
-              syntax: locker resource list
+              syntax: locker resource list [--page N]
               desc: List all resources
             create:
               syntax: "locker resource create <name>[, <name> ...]"
@@ -62,7 +66,7 @@ en:
               desc: Show the state of <name>
           label:
             list:
-              syntax: locker label list
+              syntax: locker label list [--page N]
               desc: List all labels
             create:
               syntax: "locker label create <name>[, <name> ...]"
@@ -105,7 +109,7 @@ en:
           unlocked_no_queue: "%{name} is unlocked and no one is next up %{mention}"
           unable_to_lock: "%{name} unable to be locked"
           lock: "%{name} locked"
-          desc: "%{name} is unlocked"
+          desc: "%{name} is %{state}"
           desc_owner: "%{name} is locked by %{owner_name} (taken %{time})"
           desc_owner_queue: "%{name} is locked by %{owner_name} (taken %{time}). Next up: %{queue}"
           created: "Label %{name} created"

data/spec/lita/handlers/locker_events_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Lita::Handlers::LockerEvents, lita_handler: true do

data/spec/lita/handlers/locker_http_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Lita::Handlers::LockerHttp, lita_handler: true do
@@ -24,7 +26,7 @@ describe Lita::Handlers::LockerHttp, lita_handler: true do
     it 'shows json if the label exists' do
       send_command('locker label create foo')
       subject.label_show(request, response)
-      expect(response.body).to eq(['{"id":"foo","state":"unlocked","membership":""}'])
+      expect(response.body).to eq(['{"id":"foo","state":"unlocked","membership":{"key":"label:foo:membership","options":{"type":"set"},"value":[]}}'])
     end
 
     it 'shows 404 if the label does not exist' do

data/spec/lita/handlers/locker_labels_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Lita::Handlers::LockerLabels, lita_handler: true do
@@ -17,6 +19,12 @@ describe Lita::Handlers::LockerLabels, lita_handler: true do
       is_expected.to route_command("locker label add foo, bar to #{l}").to(:add)
       is_expected.to route_command("locker label remove resource from #{l}").to(:remove)
       is_expected.to route_command("locker label remove foo, bar from #{l}").to(:remove)
+
+      is_expected.to route_command("locker label create #{l} # comment").to(:create)
+      is_expected.to route_command("locker label delete #{l} # comment").to(:delete)
+      is_expected.to route_command("locker label show #{l} # comment").to(:show)
+      is_expected.to route_command("locker label add resource to #{l} # comment").to(:add)
+      is_expected.to route_command("locker label remove resource from #{l} # comment").to(:remove)
     end
   end
 
@@ -33,12 +41,55 @@ describe Lita::Handlers::LockerLabels, lita_handler: true do
 
   describe '#label_list' do
     it 'shows a list of labels if there are any' do
+      send_command('locker resource create whatever')
       send_command('locker label create foobar')
       send_command('locker label create bazbat')
+      send_command('locker label add whatever to bazbat')
+      send_command('lock bazbat')
       send_command('locker label list')
-      sleep 1 # TODO: HAAAACK.  Need after to have a more testable behavior.
-      expect(replies.include?('foobar is unlocked')).to eq(true)
-      expect(replies.include?('bazbat is unlocked')).to eq(true)
+      expect(replies.last).to include('foobar is unlocked')
+      expect(replies.last).to include('bazbat is locked')
+    end
+
+    context 'when per_page is configured to 3' do
+      before do
+        robot.config.handlers.locker.per_page = 3
+      end
+
+      context 'when there are 4 labels' do
+        before do
+          send_command('locker label create 1')
+          send_command('locker label create 2')
+          send_command('locker label create 3')
+          send_command('locker label create 4')
+        end
+
+        it 'includes details about what page was shown' do
+          send_command('locker label list')
+          expect(replies.last).to include('Page 1 of 2 shown. Use --page to specify additional pages.')
+        end
+
+        it 'displays the page specified' do
+          send_command('locker label list --page 2')
+          expect(replies.last).to include('4 is unlocked')
+          expect(replies.last).to include('Page 2 of 2 shown. Use --page to specify additional pages.')
+        end
+
+        it 'rejects pages lower than 1' do
+          send_command('locker label list --page 0')
+          expect(replies.last).to eq('Page specified must be between 1 and 2.')
+        end
+
+        it 'rejects pages higher than the number there are' do
+          send_command('locker label list --page 3')
+          expect(replies.last).to eq('Page specified must be between 1 and 2.')
+        end
+      end
+
+      it 'rejects non-integer values for pages' do
+        send_command('locker label list --page x')
+        expect(replies.last).to eq('Page specified must be an integer.')
+      end
     end
   end
 

data/spec/lita/handlers/locker_misc_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Lita::Handlers::LockerMisc, lita_handler: true do
@@ -18,19 +20,23 @@ describe Lita::Handlers::LockerMisc, lita_handler: true do
   end
 
   it { is_expected.to route_command('locker status foo*').to(:status) }
+  it { is_expected.to route_command('locker status foo* # comment').to(:status) }
 
   it do
     is_expected.to route_command('locker list @alice').to(:list)
     is_expected.to route_command('locker list Alice').to(:list)
+    is_expected.to route_command('locker list Alice # comment').to(:list)
   end
 
   it do
     is_expected.to route_command('locker log something').to(:log)
+    is_expected.to route_command('locker log something # comment').to(:log)
   end
 
   it do
     is_expected.to route_command('locker dequeue something something').to(:dequeue)
     is_expected.to route_command('locker dq something something').to(:dequeue)
+    is_expected.to route_command('locker dq something something # comment').to(:dequeue)
   end
 
   let(:alice) do

data/spec/lita/handlers/locker_resources_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Lita::Handlers::LockerResources, lita_handler: true do
@@ -12,6 +14,9 @@ describe Lita::Handlers::LockerResources, lita_handler: true do
       is_expected.to route_command("locker resource create #{r}").to(:create)
       is_expected.to route_command("locker resource delete #{r}").to(:delete)
       is_expected.to route_command("locker resource show #{r}").to(:show)
+      is_expected.to route_command("locker resource create #{r} # comment").to(:create)
+      is_expected.to route_command("locker resource delete #{r} # comment").to(:delete)
+      is_expected.to route_command("locker resource show #{r} # comment").to(:show)
     end
   end
 
@@ -25,15 +30,56 @@ describe Lita::Handlers::LockerResources, lita_handler: true do
   end
 
   it { is_expected.to route_command('locker resource list').to(:list) }
+  it { is_expected.to route_command('locker resource list # comment').to(:list) }
 
   describe '#resource_list' do
     it 'shows a list of resources if there are any' do
       send_command('locker resource create foobar')
       send_command('locker resource create bazbat')
       send_command('locker resource list')
-      sleep 1 # TODO: HAAAAACK.  Need after to have a more testable behavior.
-      expect(replies).to include('Resource: foobar, state: unlocked')
-      expect(replies).to include('Resource: bazbat, state: unlocked')
+      expect(replies.last).to include('Resource: foobar, state: unlocked')
+      expect(replies.last).to include('Resource: bazbat, state: unlocked')
+    end
+
+    context 'when per_page is configured to 3' do
+      before do
+        robot.config.handlers.locker.per_page = 3
+      end
+
+      context 'when there are 4 resources' do
+        before do
+          send_command('locker resource create 1')
+          send_command('locker resource create 2')
+          send_command('locker resource create 3')
+          send_command('locker resource create 4')
+        end
+
+        it 'includes details about what page was shown' do
+          send_command('locker resource list')
+          expect(replies.last).to include('Page 1 of 2 shown. Use --page to specify additional pages.')
+        end
+
+        it 'displays the page specified' do
+          send_command('locker resource list --page 2')
+          expect(replies.last).to include('Resource: 4, state: unlocked')
+          expect(replies.last).to include('Page 2 of 2 shown. Use --page to specify additional pages.')
+        end
+
+        it 'rejects pages lower than 1' do
+          send_command('locker resource list --page 0')
+          expect(replies.last).to eq('Page specified must be between 1 and 2.')
+        end
+
+        it 'rejects pages higher than the number there are' do
+          send_command('locker resource list --page 3')
+          expect(replies.last).to eq('Page specified must be between 1 and 2.')
+        end
+      end
+
+      it 'rejects non-integer values for pages' do
+        send_command('locker resource list --page x')
+        expect(replies.last).to eq('Page specified must be an integer.')
+      end
     end
   end
 

data/spec/lita/handlers/locker_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 require 'spec_helper'
 
 describe Lita::Handlers::Locker, lita_handler: true do

data/spec/locker/list_spec.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Locker::List do
+  let(:item_class) { double('item class', list: [one, two, three, four]) }
+
+  let(:one) { double('one') }
+  let(:two) { double('two') }
+  let(:three) { double('three') }
+  let(:four) { double('four') }
+
+  it 'raises an argument error if a non-integer page is requested' do
+    expect { described_class.new(item_class, 3, 'z') }.to raise_error(ArgumentError)
+  end
+
+  describe '#multiple_pages' do
+    it 'is true when there are more total items than can be displayed on one page' do
+      subject = described_class.new(item_class, 1, 1)
+
+      expect(subject).to be_multiple_pages
+    end
+
+    it 'is false when the whole list fits in one page' do
+      subject = described_class.new(item_class, 10, 1)
+
+      expect(subject).not_to be_multiple_pages
+    end
+  end
+
+  describe '#requested_page' do
+    context 'with an empty list' do
+      let(:item_class) { double('item class', list: []) }
+
+      it 'returns an empty list' do
+        subject = described_class.new(item_class, 3, 1)
+
+        expect(subject.requested_page).to be_empty
+      end
+    end
+
+    context 'with a single item list' do
+      let(:item_class) { double('item class', list: [one]) }
+
+      it 'returns a list with one item' do
+        subject = described_class.new(item_class, 3, 1)
+
+        expect(subject.requested_page).to eq([one])
+      end
+    end
+
+    context 'with a four item list' do
+      it 'splits the pages correctly when there are two items per page' do
+        subject = described_class.new(item_class, 2, 1)
+
+        expect(subject.requested_page).to eq([one, two])
+
+        subject = described_class.new(item_class, 2, 2)
+
+        expect(subject.requested_page).to eq([three, four])
+      end
+
+      it 'splits the pages correctly when there are three items per page' do
+        subject = described_class.new(item_class, 3, 1)
+
+        expect(subject.requested_page).to eq([one, two, three])
+
+        subject = described_class.new(item_class, 3, 2)
+
+        expect(subject.requested_page).to eq([four])
+      end
+    end
+  end
+
+  describe '#valid_page?' do
+    it 'is true when the first page is requested' do
+      subject = described_class.new(item_class, 3, 1)
+
+      expect(subject).to be_valid_page
+    end
+
+    it 'is true when the page is between 1 and the total number of pages' do
+      subject = described_class.new(item_class, 3, 2)
+
+      expect(subject).to be_valid_page
+    end
+
+    it 'is false when the page is less than 1' do
+      subject = described_class.new(item_class, 3, 0)
+
+      expect(subject).not_to be_valid_page
+    end
+
+    it 'is false when the page is greater than the total number of pages' do
+      subject = described_class.new(item_class, 3, 10)
+
+      expect(subject).not_to be_valid_page
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 require 'coveralls'
 SimpleCov.formatters = [
@@ -12,12 +14,15 @@ Lita.version_3_compatibility_mode = false
 
 RSpec.configure do |config|
   config.before do
-    registry.register_handler(Lita::Handlers::Locker)
-    registry.register_handler(Lita::Handlers::LockerEvents)
-    registry.register_handler(Lita::Handlers::LockerHttp)
-    registry.register_handler(Lita::Handlers::LockerLabels)
-    registry.register_handler(Lita::Handlers::LockerMisc)
-    registry.register_handler(Lita::Handlers::LockerResources)
+    if defined? registry
+      registry.register_hook(:trigger_route, Lita::Extensions::KeywordArguments)
+      registry.register_handler(Lita::Handlers::Locker)
+      registry.register_handler(Lita::Handlers::LockerEvents)
+      registry.register_handler(Lita::Handlers::LockerHttp)
+      registry.register_handler(Lita::Handlers::LockerLabels)
+      registry.register_handler(Lita::Handlers::LockerMisc)
+      registry.register_handler(Lita::Handlers::LockerResources)
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-locker
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.1.0
 platform: ruby
 authors:
 - Eric Sigler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2018-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: lita-keyword-arguments
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis-objects
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +160,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
@@ -161,6 +176,7 @@ files:
 - lib/lita/handlers/locker_misc.rb
 - lib/lita/handlers/locker_resources.rb
 - lib/locker/label.rb
+- lib/locker/list.rb
 - lib/locker/misc.rb
 - lib/locker/regex.rb
 - lib/locker/resource.rb
@@ -172,6 +188,7 @@ files:
 - spec/lita/handlers/locker_misc_spec.rb
 - spec/lita/handlers/locker_resources_spec.rb
 - spec/lita/handlers/locker_spec.rb
+- spec/locker/list_spec.rb
 - spec/spec_helper.rb
 - templates/failed.erb
 - templates/failed.hipchat.erb
@@ -209,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: '"lock" and "unlock" arbitrary subjects'
@@ -220,4 +237,5 @@ test_files:
 - spec/lita/handlers/locker_misc_spec.rb
 - spec/lita/handlers/locker_resources_spec.rb
 - spec/lita/handlers/locker_spec.rb
+- spec/locker/list_spec.rb
 - spec/spec_helper.rb