lita-conferenz 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4b5b603523ab6945ca312403138be66d58bb927
-  data.tar.gz: 94583855cb7b7a9a8545ece100e7db0b8202f8bf
+  metadata.gz: c01edae6597a11d821cb3584499b884aea18bd30
+  data.tar.gz: d9def971f5d6708a941621b1adbd9d3b3717b4ae
 SHA512:
-  metadata.gz: 6e3089bc86479ea11ee2da7a1b1ba80594883bd9b443481ae74d6cb482426f30b6d6741cf4d788b0c19672b4851bb98c1d069858e440666953a0b54e99ba2454
-  data.tar.gz: b54af757417eff2d669d94fe99b6b4e2092375d9c78a3bcb69a801c4ec7d2cf94eac855d5ed1cd6d76356dd63c0b2776968c071e039a814d6d3951f14eb5c355
+  metadata.gz: 940ae2080b798b0dccde2859f84bc8ef737ebb518d145cfdc6c038040f8202761162a99d8dfc417bc716b358815023791aae827d5335d3728da1ee8a8cc6d7b2
+  data.tar.gz: 177610688810155fb8acbe14e6e8d64777a6fe14490998854c79969102136b16f97b5383edffae217d1fdc837ca92806c3e1e400e7ae73b6b2629d734974a9b5

data/lita-conferenz.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-conferenz"
-  spec.version       = "1.0.1"
+  spec.version       = "1.0.2"
   spec.authors       = ["Piotr Limanowski"]
   spec.email         = ["plimanowski+conferenz@gmail.com"]
   spec.description   = %q{A Lita handler for tracking conferences attendance.}

data/locales/en.yml

@@ -1,7 +1,7 @@
 en:
   lita:
     handlers:
-      karma:
+      conferenz:
         already_linked: "%{source} is already linked to %{target}."
         already_unlinked: "%{source} is not linked to %{target}."
         callable_required: must be a callable object
@@ -15,18 +15,18 @@ en:
           decrement_key: TERM--
           decrement_value: Decrements TERM by one.
           check_key: TERM~~
-          check_value: Shows the current karma of TERM.
+          check_value: Shows the current conferenz of TERM.
           link_key: TERM1 += TERM2
           link_value: Links TERM2 to TERM1.
           unlink_key: TERM1 -= TERM2
           unlink_value: Unlinks TERM2 from TERM1.
-          list_worst_key: "karma worst [N]"
-          list_worst_value: Lists the bottom N terms by karma. N defaults to 5.
-          list_best_key: "karma best [N]"
-          list_best_value: Lists the top N terms by karma. N defaults to 5.
-          modified_key: karma modified TERM
+          list_worst_key: "conferenz worst [N]"
+          list_worst_value: Lists the bottom N terms by conferenz. N defaults to 5.
+          list_best_key: "conferenz best [N]"
+          list_best_value: Lists the top N terms by conferenz. N defaults to 5.
+          modified_key: conferenz modified TERM
           modified_value: Lists the names of users who have upvoted or downvoted TERM.
-          delete_key: karma delete TERM
+          delete_key: conferenz delete TERM
           delete_value: >-
             Permanently removes TERM and all its link information. TERM is matched
             exactly as typed and does not adhere to the usual pattern for terms.
@@ -36,5 +36,5 @@ en:
         no_terms: There are no terms being tracked yet.
         threshold_not_satisfied: >-
           Terms must have less than or equal to -%{threshold} or greater than or equal to
-          %{threshold} karma to be linked or linked to.
+          %{threshold} conferenz to be linked or linked to.
         unlink_success: "%{source} has been unlinked from %{target}."

data/spec/lita/handlers/karma/chat_spec.rb

@@ -0,0 +1,339 @@
+# -*- coding: utf-8 -*-
+require "spec_helper"
+
+describe Lita::Handlers::Conferenz::Chat, lita_handler: true do
+  let(:payload) { double("payload") }
+
+  prepend_before { registry.register_handler(Lita::Handlers::Conferenz::Config) }
+
+  before do
+    registry.config.handlers.conferenz.cooldown = nil
+    registry.config.handlers.conferenz.link_karma_threshold = nil
+    described_class.routes.clear
+    subject.define_routes(payload)
+  end
+
+  it { is_expected.to route("foo++").to(:increment) }
+  it { is_expected.to route("foo--").to(:decrement) }
+  it { is_expected.to route("foo++ bar").to(:increment) }
+  it { is_expected.to route("foo-- bar").to(:decrement) }
+  it { is_expected.to route("foo~~").to(:check) }
+  it { is_expected.to route_command("conferenz best").to(:list_best) }
+  it { is_expected.to route_command("conferenz worst").to(:list_worst) }
+  it { is_expected.to route_command("conferenz modified foo").to(:modified) }
+  it do
+    is_expected.to route_command("conferenz delete").with_authorization_for(:karma_admins).to(:delete)
+  end
+  it { is_expected.to route_command("conferenz").to(:list_best) }
+  it { is_expected.to route_command("foo += bar").to(:link) }
+  it { is_expected.to route_command("foo += bar++").to(:link) }
+  it { is_expected.to route_command("foo += bar--").to(:link) }
+  it { is_expected.to route_command("foo += bar~~").to(:link) }
+  it { is_expected.to route_command("foo -= bar").to(:unlink) }
+  it { is_expected.to route_command("foo -= bar++").to(:unlink) }
+  it { is_expected.to route_command("foo -= bar--").to(:unlink) }
+  it { is_expected.to route_command("foo -= bar~~").to(:unlink) }
+  it { is_expected.not_to route("+++++").to(:increment) }
+  it { is_expected.not_to route("-----").to(:decrement) }
+  it { is_expected.not_to route("foo++bar").to(:increment) }
+  it { is_expected.not_to route("foo--bar").to(:decrement) }
+
+  describe "#increment" do
+    it "increases the term's score by one and says the new score" do
+      send_message("foo++")
+      expect(replies.last).to eq("foo: 1")
+    end
+
+    it "matches multiple terms in one message" do
+      send_message("foo++ bar++")
+      expect(replies.last).to eq("foo: 1; bar: 1")
+    end
+
+    it "doesn't start from zero if the term already has a positive score" do
+      send_message("foo++")
+      send_message("foo++")
+      expect(replies.last).to eq("foo: 2")
+    end
+
+    it "replies with a warning if term increment is on cooldown" do
+      registry.config.handlers.karma.cooldown = 10
+      send_message("foo++")
+      send_message("foo++")
+      expect(replies.last).to match(/cannot modify foo/)
+    end
+
+    it "is case insensitive" do
+      send_message("foo++")
+      send_message("FOO++")
+      expect(replies.last).to eq("foo: 2")
+    end
+
+    it "handles Unicode word characters" do
+      send_message("föö++")
+      expect(replies.last).to eq("föö: 1")
+    end
+  end
+
+  describe "#decrement" do
+    it "decreases the term's score by one and says the new score" do
+      send_message("foo--")
+      expect(replies.last).to eq("foo: -1")
+    end
+
+    it "matches multiple terms in one message" do
+      send_message("foo-- bar--")
+      expect(replies.last).to eq("foo: -1; bar: -1")
+    end
+
+    it "doesn't start from zero if the term already has a positive score" do
+      send_message("foo++")
+      send_message("foo--")
+      expect(replies.last).to eq("foo: 0")
+    end
+
+    it "replies with a warning if term increment is on cooldown" do
+      registry.config.handlers.karma.cooldown = 10
+      send_message("foo--")
+      send_message("foo--")
+      expect(replies.last).to match(/cannot modify foo/)
+    end
+  end
+
+  describe "#check" do
+    it "says the term's current score" do
+      send_message("foo~~")
+      expect(replies.last).to eq("foo: 0")
+    end
+
+    it "matches multiple terms in one message" do
+      send_message("foo~~ bar~~")
+      expect(replies.last).to eq("foo: 0; bar: 0")
+    end
+
+    it "doesn't match the same term multiple times in one message" do
+      send_message("foo~~ foo~~")
+      expect(replies.size).to eq(1)
+    end
+  end
+
+  describe "#list" do
+    it "replies with a warning if there are no terms" do
+      send_command("conferenz")
+      expect(replies.last).to match(/no terms being tracked/)
+    end
+
+    context "with modified terms" do
+      before do
+        send_message(
+          "one++ one++ one++ two++ two++ three++ four++ four-- five--"
+        )
+      end
+
+      it "lists the top 5 terms by default" do
+        send_command("conferenz")
+        expect(replies.last).to eq <<-MSG.chomp
+1. one (3)
+2. two (2)
+3. three (1)
+4. four (0)
+5. five (-1)
+MSG
+      end
+
+      it 'lists the bottom 5 terms when passed "worst"' do
+        send_command("conferenz worst")
+        expect(replies.last).to eq <<-MSG.chomp
+1. five (-1)
+2. four (0)
+3. three (1)
+4. two (2)
+5. one (3)
+MSG
+      end
+
+      it "limits the list to the count passed as the second argument" do
+        send_command("conferenz best 2")
+        expect(replies.last).to eq <<-MSG.chomp
+1. one (3)
+2. two (2)
+MSG
+      end
+    end
+  end
+
+  describe "#link" do
+    it "says that it's linked term 2 to term 1" do
+      send_command("foo += bar")
+      expect(replies.last).to eq("bar has been linked to foo.")
+    end
+
+    it "says that term 2 was already linked to term 1 if it was" do
+      send_command("foo += bar")
+      send_command("foo += bar")
+      expect(replies.last).to eq("bar is already linked to foo.")
+    end
+
+    it "causes term 1's score to be modified by term 2's" do
+      send_message("foo++ bar++ baz++")
+      send_command("foo += bar")
+      send_command("foo += baz")
+      send_message("foo~~")
+      expect(replies.last).to match(
+        /foo: 3 \(1\), linked to: ba[rz]: 1, ba[rz]: 1/
+      )
+    end
+
+    context "when link_karma_threshold is set" do
+      before do
+        registry.config.handlers.karma.link_karma_threshold = 1
+      end
+
+      it "doesn't allow a term to be linked if both are below the threshold" do
+        send_command("foo += bar")
+        expect(replies.last).to include("must have less than")
+      end
+
+      it "doesn't allow a term to be linked if it's below the threshold" do
+        send_command("foo++")
+        send_command("foo += bar")
+        expect(replies.last).to include("must have less than")
+      end
+
+      it "doesn't allow a term to be linked to another term below the threshold" do
+        send_command("bar++")
+        send_command("foo += bar")
+        expect(replies.last).to include("must have less than")
+      end
+
+      it "allows links if both terms meet the threshold" do
+        send_command("foo++ bar++")
+        send_command("foo += bar")
+        expect(replies.last).to include("has been linked")
+        send_command("bar += foo")
+        expect(replies.last).to include("has been linked")
+      end
+
+      it "uses the absolute value for terms with negative karma" do
+        send_command("foo-- bar--")
+        send_command("foo += bar")
+        expect(replies.last).to include("has been linked")
+        send_command("bar += foo")
+        expect(replies.last).to include("has been linked")
+      end
+    end
+  end
+
+  describe "#unlink" do
+    it "says that it's unlinked term 2 from term 1" do
+      send_command("foo += bar")
+      send_command("foo -= bar")
+      expect(replies.last).to eq("bar has been unlinked from foo.")
+    end
+
+    it "says that term 2 was not linked to term 1 if it wasn't" do
+      send_command("foo -= bar")
+      expect(replies.last).to eq("bar is not linked to foo.")
+    end
+
+    it "causes term 1's score to stop being modified by term 2's" do
+      send_message("foo++ bar++")
+      send_command("foo += bar")
+      send_command("foo -= bar")
+      send_message("foo~~")
+      expect(replies.last).to eq("foo: 1")
+    end
+  end
+
+  describe "#modified" do
+    it "replies with a message if the term hasn't been modified" do
+      send_command("conferenz modified foo")
+      expect(replies.last).to match(/never been modified/)
+    end
+
+    it "lists users who have modified the given term in count order" do
+      other_user = Lita::User.create("2", name: "Other User")
+      send_message("foo++", as: user)
+      send_message("foo++", as: user)
+      send_message("foo++", as: other_user)
+      send_command("conferenz modified foo")
+      expect(replies.last).to eq("#{user.name}, #{other_user.name}")
+    end
+  end
+
+  describe "#delete" do
+    before do
+      robot.auth.add_user_to_group!(user, :karma_admins)
+    end
+
+    it "deletes the term" do
+      send_message("foo++")
+      send_command("conferenz delete foo")
+      expect(replies.last).to eq("foo has been deleted.")
+      send_message("foo~~")
+      expect(replies.last).to eq("foo: 0")
+    end
+
+    it "matches terms exactly, including leading whitespace" do
+      term = "  'foo bar* 'baz''/ :"
+      subject.redis.zincrby("terms", 1, term)
+      send_command("conferenz delete #{term}")
+      expect(replies.last).to include("has been deleted")
+    end
+
+    it "clears the modification list" do
+      send_message("foo++")
+      send_command("conferenz delete foo")
+      send_command("conferenz modified foo")
+      expect(replies.last).to eq("foo has never been modified.")
+    end
+
+    it "clears the deleted term's links" do
+      send_command("foo += bar")
+      send_command("foo += baz")
+      send_command("conferenz delete foo")
+      send_message("foo++")
+      expect(replies.last).to eq("foo: 1")
+    end
+
+    it "clears links from other terms connected to the deleted term" do
+      send_command("bar += foo")
+      send_command("baz += foo")
+      send_command("conferenz delete foo")
+      send_message("bar++")
+      expect(replies.last).to eq("bar: 1")
+      send_message("baz++")
+      expect(replies.last).to eq("baz: 1")
+    end
+  end
+
+  describe "custom term patterns and normalization" do
+    before do
+      registry.config.handlers.karma.term_pattern = /[<:]([^>:]+)[>:]/
+      registry.config.handlers.karma.term_normalizer = lambda do |term|
+        term.to_s.downcase.strip.sub(/[<:]([^>:]+)[>:]/, '\1')
+      end
+      described_class.routes.clear
+      subject.define_routes(payload)
+    end
+
+    it "increments multi-word terms bounded by delimeters" do
+      send_message(":Some Thing:++")
+      expect(replies.last).to eq("some thing: 1")
+    end
+
+    it "increments terms with symbols that are bounded by delimeters" do
+      send_message("<C++>++")
+      expect(replies.last).to eq("c++: 1")
+    end
+
+    it "decrements multi-word terms bounded by delimeters" do
+      send_message(":Some Thing:--")
+      expect(replies.last).to eq("some thing: -1")
+    end
+
+    it "checks multi-word terms bounded by delimeters" do
+      send_message(":Some Thing:~~")
+      expect(replies.last).to eq("some thing: 0")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-conferenz
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Piotr Limanowski
@@ -111,6 +111,7 @@ files:
 - lita-conferenz.gemspec
 - locales/en.yml
 - spec/lita/handlers/conferenz/chat_spec.rb
+- spec/lita/handlers/karma/chat_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/peel/conferenz
 licenses:
@@ -139,4 +140,5 @@ specification_version: 4
 summary: A Lita handler for tracking conferences attendance.
 test_files:
 - spec/lita/handlers/conferenz/chat_spec.rb
+- spec/lita/handlers/karma/chat_spec.rb
 - spec/spec_helper.rb