predictor 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c267ff0bf82d11ccefe19ae4314a62b09e9300fa
-  data.tar.gz: 7eed86238af5297d8c32250c6ebf28f992b9e331
+  metadata.gz: f4df4be1a5695f1d3166382a5cf25efd1925bcb1
+  data.tar.gz: 4468cd0189e18ec27d0651501e37ff07cb826446
 SHA512:
-  metadata.gz: eaa28d8a14437dd11742499a10211827ebc212feeb99d421185676d4a06ed1253f67a5252e7e4a748c6f87c69b6d0ed136b461f1df7b557ef4c92514b399e2c3
-  data.tar.gz: c60c5a6572cb6c42ef4e9633e29a73e8baee84384b6dbc3371b9979e7b0a5fc2c6bc2b67dd64e0a2733a38fbadb1e8df73b4e024bdb22b501aaf88b1732d438d
+  metadata.gz: 8a45d82c57f57f219b86a19ca759d04dacdcce44ece6a4ae92d80a115229fca6b7d23ae9c1ab78012049c9337b576777a8fcee517b1371b4daecf57db42dd595
+  data.tar.gz: 046bc87e3faf2ecbc1bbf1a6bd04f1e92c09fbdb17053aa9bbac597bc98b79f11d4d09af02ba230bafa44c546dd7bdfb150d5620048cce4320c1d169968c3038

data/README.md

@@ -219,6 +219,26 @@ You can also configure the namespace used by each class you create:
   end
 ```
 
+You can also configure the namespace used by each instance you create in addition to class and global namespace:
+
+```ruby
+  class CourseRecommender
+    include Predictor::Base
+
+    def initialize(prefix)
+      @prefix = prefix
+    end
+
+    # Simply override this instance method with the prefix you want
+    def get_redis_prefix
+      @prefix
+    end
+  end
+
+  recommender = CourseRecommender.new("super")
+  recommender.redis_prefix # "predictor:CourseRecommender:super"
+```
+
 Processing Items
 ---------------------
 As of 2.3.0, there are now multiple techniques available for processing item similarities. You can choose between them by setting a global default like `Predictor.processing_technique(:lua)` or setting a technique for certain classes like `CourseRecommender.processing_technique(:union)`. There are three values.
@@ -266,6 +286,12 @@ predictor.delete_from_matrix!(:topics, "course-1")
 ```
 * Regenerate your recommendations, as redis keys have changed for Predictor 2. You can use the recommender.clean! to clear out old similarities, then run your rake task (or whatever you've setup) to create new similarities.
 
+About Pathgather
+---------------------
+Pathgather is an NYC-based startup building a platform that dramatically accelerates learning for enterprises by bringing employees, training content, and existing enterprise systems into one engaging platform.
+
+Every Friday, we work on open-source software (our own or other projects). Want to join our always growing team? Peruse our [current opportunities](http://www.pathgather.com/jobs/) or reach out to us at <tech@pathgather.com>!
+
 Problems? Issues? Want to help out?
 ---------------------
 Just submit a Gihub issue or pull request! We'd love to have you help out, as the most common library to use for this need, Recommendify, was last updated 2 years ago. We'll be sure to keep this maintained, but we could certainly use your help!

data/lib/predictor/base.rb

@@ -63,8 +63,12 @@ module Predictor::Base
     }]
   end
 
+  def get_redis_prefix
+    nil # Override in subclass.
+  end
+
   def redis_prefix
-    [Predictor.get_redis_prefix, self.class.get_redis_prefix]
+    [Predictor.get_redis_prefix, self.class.get_redis_prefix, self.get_redis_prefix].compact
   end
 
   def similarity_limit
@@ -263,6 +267,10 @@ module Predictor::Base
     return self
   end
 
+  def add_item(item)
+    Predictor.redis.sadd(redis_key(:all_items), item)
+  end
+
   def delete_item!(item)
     Predictor.redis.srem(redis_key(:all_items), item)
     Predictor.redis.watch(redis_key(:similarities, item)) do

data/lib/predictor/version.rb

@@ -1,3 +1,3 @@
 module Predictor
-  VERSION = "2.3.0"
-end
+  VERSION = "2.3.1"
+end

data/spec/base_spec.rb

@@ -142,6 +142,21 @@ describe Predictor::Base do
       expect(br.redis_key(:another, :key)).to eq("predictor-test:BaseRecommender:another:key")
       expect(br.redis_key(:another, [:set, :of, :keys])).to eq("predictor-test:BaseRecommender:another:set:of:keys")
     end
+
+    it "should respect the instance prefix configuration setting" do
+      br = PrefixRecommender.new("foo")
+
+      expect(br.redis_key).to eq("predictor-test:PrefixRecommender:foo")
+      expect(br.redis_key(:another)).to eq("predictor-test:PrefixRecommender:foo:another")
+      expect(br.redis_key(:another, :key)).to eq("predictor-test:PrefixRecommender:foo:another:key")
+      expect(br.redis_key(:another, [:set, :of, :keys])).to eq("predictor-test:PrefixRecommender:foo:another:set:of:keys")
+
+
+      br.prefix = nil
+      expect(br.redis_key).to eq("predictor-test:PrefixRecommender")
+      expect(br.redis_key(:another)).to eq("predictor-test:PrefixRecommender:another")
+
+    end
   end
 
   describe "all_items" do

data/spec/spec_helper.rb

@@ -24,6 +24,22 @@ class TestRecommender
   input_matrix :jaccard_one
 end
 
+class PrefixRecommender
+  include Predictor::Base
+
+  def initialize(prefix)
+    @prefix = prefix
+  end
+
+  def prefix=(new_prefix)
+    @prefix = new_prefix
+  end
+
+  def get_redis_prefix
+    @prefix
+  end
+end
+
 class Predictor::TestInputMatrix
   def initialize(opts)
     @opts = opts

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: predictor
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Pathgather
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Fast and efficient recommendations and predictions using Redis
@@ -115,17 +115,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Fast and efficient recommendations and predictions using Redis