lita-karma 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2cca610120cdae102e8f021e5081a9b5c4541ab
-  data.tar.gz: 4338a3c24a567f640526b31f25677b46ee6a3f0e
+  metadata.gz: 5f7807772d594056ec3c21dae05d056be2394e3a
+  data.tar.gz: d28351489ce8234e359a15657bccb4cc87f4e0a7
 SHA512:
-  metadata.gz: 4e3bfe036aaeab1084ff3a9bfa3ff3449b1d9744f70ee967dfd759055e33768f148e37ac59a904925ce9ec9be8e4b01b4b5570d1eb3f9f4e54c13eb79093316a
-  data.tar.gz: 48b1012b1d3ad30606714267bc07bd165f7ff72446725e97aea3168d2eebf22755815770a547a74ac0e58243dbc268b90ba89c343da695c758653343c074e782
+  metadata.gz: ae64368983385ac07aa53548fdb5f91276b4d15c323cf47845208b46f4b1e7d1bf1fdc8ef041daee27bcf5eadb33821d0a7132eda98a2739bd8fdbec626248f3
+  data.tar.gz: f5b8da41d0caa619038e2518a400312d54afd9a005e807c04d39f83a71f798f68b07e4a7df8abd14de9470ec8266990decea488038e037605a941f1a6d118e22

data/README.md

@@ -18,7 +18,8 @@ gem "lita-karma"
 
 ### Optional attributes
 
-* `cooldown` (Integer, nil) - Controls how long a user must wait after modifying a term before they can modify it again. The value should be an integer number of seconds. Set it to `nil` to disable rate limiting. Default: `300` (5 minutes.
+* `cooldown` (Integer, nil) - Controls how long a user must wait after modifying a term before they can modify it again. The value should be an integer number of seconds. Set it to `nil` to disable rate limiting. Default: `300` (5 minutes).
+* `link_karma_threshold` (Integer, nil) - Controls how many points a term must have before it can be linked to other terms or before terms can be linked to it. Treated as an absolute value, so it applies to both positive and negative karma. Set it to `nil` to allow all terms to be linked regardless of karma. Default: `10`.
 * `term_pattern` (Regexp) - Determines what Lita will recognize as a valid term for tracking karma. Default: `/[\[\]\p{Word}\._|\{\}]{2,}/`.
 * `term_normalizer` (Proc) - A custom callable that determines how each term will be normalized before being stored in Redis. The proc should take one argument, the term as matched via regular expression, and return one value, the normalized version of the term.
 

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/lita/handlers/karma.rb

@@ -4,19 +4,18 @@ module Lita
   module Handlers
     # Tracks karma points for arbitrary terms.
     class Karma < Handler
-      TERM_PATTERN = /[\[\]\p{Word}\._|\{\}]{2,}/
-
-      class << self
-        attr_accessor :term_pattern
+      config :cooldown, types: [Integer, nil], default: 300
+      config :link_karma_threshold, types: [Integer, nil], default: 10
+      config :term_pattern, type: Regexp, default: /[\[\]\p{Word}\._|\{\}]{2,}/
+      config :term_normalizer do
+        validate do |value|
+          "must be a callable object" unless value.respond_to?(:call)
+        end
       end
 
       on :loaded, :upgrade_data
       on :loaded, :define_routes
 
-      def self.default_config(config)
-        config.cooldown = 300
-      end
-
       def upgrade_data(payload)
         return if redis.exists("support:reverse_links")
         redis.keys("links:*").each do |key|
@@ -29,11 +28,8 @@ module Lita
       end
 
       def define_routes(payload)
-        self.class.term_pattern =
-          Lita.config.handlers.karma.term_pattern || TERM_PATTERN
-
         define_static_routes
-        define_dynamic_routes(term_pattern.source)
+        define_dynamic_routes(config.term_pattern.source)
       end
 
       def increment(response)
@@ -73,6 +69,18 @@ module Lita
         response.matches.each do |match|
           term1, term2 = normalize_term(match[0]), normalize_term(match[1])
 
+          if config.link_karma_threshold
+            threshold = config.link_karma_threshold.abs
+
+            _total_score, term2_score, _links = scores_for(term2)
+            _total_score, term1_score, _links = scores_for(term1)
+
+            if term1_score.abs < threshold || term2_score.abs < threshold
+              response.reply "Terms must have less than -#{threshold} or more than #{threshold} karma to be linked or linked to."
+              return
+            end
+          end
+
           if redis.sadd("links:#{term1}", term2)
             redis.sadd("linked_to:#{term2}", term1)
             response.reply "#{term2} has been linked to #{term1}."
@@ -258,10 +266,8 @@ HELP
       end
 
       def normalize_term(term)
-        term_normalizer = Lita.config.handlers.karma.term_normalizer
-
-        if term_normalizer.respond_to?(:call)
-          term_normalizer.call(term)
+        if config.term_normalizer
+          config.term_normalizer.call(term)
         else
           term.to_s.downcase.strip
         end
@@ -300,19 +306,7 @@ HELP
       end
 
       def set_cooldown(term, user_id)
-        cooldown = Lita.config.handlers.karma.cooldown
-
-        if cooldown
-          redis.setex(
-            "cooldown:#{user_id}:#{term}",
-            cooldown.to_i,
-            1
-          )
-        end
-      end
-
-      def term_pattern
-        self.class.term_pattern
+        redis.setex("cooldown:#{user_id}:#{term}", config.cooldown.to_i, 1) if config.cooldown
       end
     end
 

data/lita-karma.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-karma"
-  spec.version       = "2.1.0"
+  spec.version       = "3.0.0"
   spec.authors       = ["Jimmy Cuadra"]
   spec.email         = ["jimmy@jimmycuadra.com"]
   spec.description   = %q{A Lita handler for tracking karma points for arbitrary terms.}
@@ -14,11 +14,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "lita", ">= 2.6"
+  spec.add_runtime_dependency "lita", ">= 4.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"
 end

data/spec/lita/handlers/karma_spec.rb

@@ -4,23 +4,26 @@ describe Lita::Handlers::Karma, lita_handler: true do
   let(:payload) { double("payload") }
 
   before do
-    Lita.config.handlers.karma.cooldown = nil
+    registry.config.handlers.karma.cooldown = nil
+    registry.config.handlers.karma.link_karma_threshold = nil
     described_class.routes.clear
     subject.define_routes(payload)
   end
 
-  it { routes("foo++").to(:increment) }
-  it { routes("foo--").to(:decrement) }
-  it { routes("foo~~").to(:check) }
-  it { routes_command("karma best").to(:list_best) }
-  it { routes_command("karma worst").to(:list_worst) }
-  it { routes_command("karma modified").to(:modified) }
-  it { routes_command("karma delete").to(:delete) }
-  it { routes_command("karma").to(:list_best) }
-  it { routes_command("foo += bar").to(:link) }
-  it { routes_command("foo -= bar").to(:unlink) }
-  it { doesnt_route("+++++").to(:increment) }
-  it { doesnt_route("-----").to(:decrement) }
+  it { is_expected.to route("foo++").to(:increment) }
+  it { is_expected.to route("foo--").to(:decrement) }
+  it { is_expected.to route("foo~~").to(:check) }
+  it { is_expected.to route_command("karma best").to(:list_best) }
+  it { is_expected.to route_command("karma worst").to(:list_worst) }
+  it { is_expected.to route_command("karma modified").to(:modified) }
+  it do
+    is_expected.to route_command("karma delete").with_authorization_for(:karma_admins).to(:delete)
+  end
+  it { is_expected.to route_command("karma").to(:list_best) }
+  it { is_expected.to route_command("foo += bar").to(:link) }
+  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) }
 
   describe "#update_data" do
     before { subject.redis.flushdb }
@@ -28,8 +31,8 @@ describe Lita::Handlers::Karma, lita_handler: true do
     it "adds reverse link data for all linked terms" do
       subject.redis.sadd("links:foo", ["bar", "baz"])
       subject.upgrade_data(payload)
-      expect(subject.redis.sismember("linked_to:bar", "foo")).to be_true
-      expect(subject.redis.sismember("linked_to:baz", "foo")).to be_true
+      expect(subject.redis.sismember("linked_to:bar", "foo")).to be(true)
+      expect(subject.redis.sismember("linked_to:baz", "foo")).to be(true)
     end
 
     it "skips the update if it's already been done" do
@@ -57,7 +60,7 @@ describe Lita::Handlers::Karma, lita_handler: true do
     end
 
     it "replies with a warning if term increment is on cooldown" do
-      Lita.config.handlers.karma.cooldown = 10
+      registry.config.handlers.karma.cooldown = 10
       send_message("foo++")
       send_message("foo++")
       expect(replies.last).to match(/cannot modify foo/)
@@ -93,7 +96,7 @@ describe Lita::Handlers::Karma, lita_handler: true do
     end
 
     it "replies with a warning if term increment is on cooldown" do
-      Lita.config.handlers.karma.cooldown = 10
+      registry.config.handlers.karma.cooldown = 10
       send_message("foo--")
       send_message("foo--")
       expect(replies.last).to match(/cannot modify foo/)
@@ -178,6 +181,45 @@ MSG
         /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
@@ -227,7 +269,7 @@ MSG
 
   describe "#delete" do
     before do
-      allow(Lita::Authorization).to receive(:user_in_group?).and_return(true)
+      robot.auth.add_user_to_group!(user, :karma_admins)
     end
 
     it "deletes the term" do
@@ -278,8 +320,8 @@ MSG
 
   describe "custom term patterns and normalization" do
     before do
-      Lita.config.handlers.karma.term_pattern = /[<:]([^>:]+)[>:]/
-      Lita.config.handlers.karma.term_normalizer = lambda do |term|
+      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

data/spec/spec_helper.rb

@@ -8,3 +8,5 @@ SimpleCov.start { add_filter "/spec/" }
 
 require "lita-karma"
 require "lita/rspec"
+
+Lita.version_3_compatibility_mode = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lita-karma
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jimmy Cuadra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-06 00:00:00.000000000 Z
+date: 2014-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -133,11 +133,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Lita handler for tracking karma points for arbitrary terms.
 test_files:
 - spec/lita/handlers/karma_spec.rb
 - spec/spec_helper.rb
-has_rdoc: