commendo 1.2.4 → 2.0.0

data/lib/commendo/redis-backed/tag_set.rb

@@ -0,0 +1,54 @@
+module Commendo
+  module RedisBacked
+    class TagSet
+
+      attr_accessor :redis, :key_base
+
+      def initialize(key_base)
+        @redis = Redis.new(host: Commendo.config.host, port: Commendo.config.port, db: Commendo.config.database)
+        @key_base = key_base
+      end
+
+      def empty?
+        cursor, keys = redis.scan(0, match: "#{key_base}:*", count: 1)
+        cursor.to_i == 0 && keys.empty?
+      end
+
+      def get(resource)
+        redis.smembers(resource_key(resource)).sort
+      end
+
+      def add(resource, *tags)
+        redis.sadd(resource_key(resource), tags) unless tags.empty?
+      end
+
+      def set(resource, *tags)
+        delete(resource)
+        add(resource, *tags)
+      end
+
+      def matches(resource, include, exclude = [])
+        resource_tags = get(resource)
+        can_include = include.nil? || include.empty? || (resource_tags & include).length > 0
+        should_exclude = !exclude.nil? && !exclude.empty? && (resource_tags & exclude).length > 0
+        return can_include && !should_exclude
+      end
+
+      def delete(resource, *tags)
+        if tags.empty?
+          redis.del(resource_key(resource))
+        else
+          redis.srem(resource_key(resource), tags)
+        end
+      end
+
+      private
+
+      def resource_key(resource)
+        "#{key_base}:#{resource}"
+      end
+
+    end
+  end
+end
+

data/lib/commendo/redis-backed/weighted_group.rb

@@ -0,0 +1,54 @@
+module Commendo
+  module RedisBacked
+
+    class WeightedGroup
+
+      attr_accessor :content_sets, :redis, :key_base, :tag_set
+
+      def initialize(key_base, *content_sets)
+        @redis = Redis.new(host: Commendo.config.host, port: Commendo.config.port, db: Commendo.config.database)
+        @key_base = key_base
+        @content_sets = content_sets
+      end
+
+      def similar_to(resource, limit = 0)
+        finish = limit -1
+        resources = resource.kind_of?(Array) ? resource : [resource]
+        keys = []
+        weights = []
+        content_sets.each do |cs|
+          resources.each do |resource|
+            keys << cs[:cs].similarity_key(resource)
+            weights << cs[:weight]
+          end
+        end
+        tmp_key = "#{key_base}:tmp:#{SecureRandom.uuid}"
+        redis.zunionstore(tmp_key, keys, weights: weights)
+        similar_resources = redis.zrevrange(tmp_key, 0, finish, with_scores: true)
+        redis.del(tmp_key)
+
+        similar_resources.map do |resource|
+          {resource: resource[0], similarity: resource[1].to_f.round(3)}
+        end
+
+      end
+
+      def filtered_similar_to(resource, options = {})
+        if @tag_set.nil? || (options[:include].nil? && options[:exclude].nil?)
+          return similar_to(resource, options[:limit] || 0)
+        else
+          similar = similar_to(resource)
+          limit = options[:limit] || similar.length
+          filtered = []
+          similar.each do |s|
+            return filtered if filtered.length >= limit
+            filtered << s if @tag_set.matches(s[:resource], options[:include], options[:exclude])
+          end
+          return filtered
+        end
+      end
+
+    end
+
+  end
+end

data/lib/commendo/tag_set.rb

@@ -1,51 +1,15 @@
 module Commendo
-
   class TagSet
+    extend Forwardable
 
-    attr_accessor :redis, :key_base
-
-    def initialize(redis, key_base)
-      @redis, @key_base = redis, key_base
-    end
-
-    def empty?
-      cursor, keys = redis.scan(0, match: "#{key_base}:*", count: 1)
-      cursor.to_i == 0 && keys.empty?
-    end
-
-    def get(resource)
-      redis.smembers(resource_key(resource)).sort
-    end
+    def_delegators :@backend, :empty?, :get, :add, :set, :matches, :delete, :redis, :key_base
 
-    def add(resource, *tags)
-      redis.sadd(resource_key(resource), tags) unless tags.empty?
+    def initialize(args)
+      @backend = RedisBacked::TagSet.new(args[:key_base]) if Commendo.config.backend == :redis
+      @backend = MySqlBacked::TagSet.new(args[:key_base]) if Commendo.config.backend == :mysql
+      raise 'Unrecognised backend type, try :redis or :mysql' if @backend.nil?
     end
 
-    def set(resource, *tags)
-      delete(resource)
-      add(resource, *tags)
-    end
-
-    def matches(resource, include, exclude = [])
-      resource_tags = get(resource)
-      can_include = include.nil? || include.empty? || (resource_tags & include).length > 0
-      should_exclude = !exclude.nil? && !exclude.empty? && (resource_tags & exclude).length > 0
-      return can_include && !should_exclude
-    end
-
-    def delete(resource, *tags)
-      if tags.empty?
-      redis.del(resource_key(resource))
-      else
-        redis.srem(resource_key(resource), tags)
-      end
-    end
-
-    private
-
-    def resource_key(resource)
-      "#{key_base}:#{resource}"
-    end
 
   end
 end

data/lib/commendo/version.rb

@@ -1,3 +1,3 @@
 module Commendo
-  VERSION = '1.2.4'
+  VERSION = '2.0.0'
 end

data/lib/commendo/weighted_group.rb

@@ -1,50 +1,16 @@
 module Commendo
 
   class WeightedGroup
+    extend Forwardable
 
-    attr_accessor :content_sets, :redis, :key_base, :tag_set
-
-    def initialize(redis, key_base, *content_sets)
-      @content_sets, @redis, @key_base = content_sets, redis, key_base
-    end
-
-    def similar_to(resource, limit = 0)
-      finish = limit -1
-      resources = resource.kind_of?(Array) ? resource : [resource]
-      keys = []
-      weights = []
-      content_sets.each do |cs|
-        resources.each do |resource|
-          keys << cs[:cs].similarity_key(resource)
-          weights << cs[:weight]
-        end
-      end
-      tmp_key = "#{key_base}:tmp:#{SecureRandom.uuid}"
-      redis.zunionstore(tmp_key, keys, weights: weights)
-      similar_resources = redis.zrevrange(tmp_key, 0, finish, with_scores: true)
-      redis.del(tmp_key)
-
-      similar_resources.map do |resource|
-        {resource: resource[0], similarity: resource[1].to_f.round(3)}
-      end
-
+    def initialize(args)
+      @backend = RedisBacked::WeightedGroup.new(args[:key_base], *args[:content_sets]) if Commendo.config.backend == :redis
+      @backend = MySqlBacked::WeightedGroup.new(args[:key_base], *args[:content_sets]) if Commendo.config.backend == :mysql
+      raise 'Unrecognised backend type, try :redis or :mysql' if @backend.nil?
     end
 
-    def filtered_similar_to(resource, options = {})
-      if @tag_set.nil? || (options[:include].nil? && options[:exclude].nil?)
-        return similar_to(resource, options[:limit] || 0)
-      else
-        similar = similar_to(resource)
-        limit = options[:limit] || similar.length
-        filtered = []
-        similar.each do |s|
-          return filtered if filtered.length >= limit
-          filtered << s if @tag_set.matches(s[:resource], options[:include], options[:exclude])
-        end
-        return filtered
-      end
-    end
+    def_delegators :@backend, :similar_to, :filtered_similar_to, :content_sets, :redis, :key_base, :tag_set, :tag_set=
 
   end
 
-end
+end

data/lib/mysql2/client.rb

@@ -0,0 +1,17 @@
+module Mysql2
+  class Client
+    def transaction(&block)
+      raise ArgumentError, 'No block was given' unless block_given?
+      begin
+        query('BEGIN')
+        yield(self)
+        query('COMMIT')
+        return true # Successful Transaction
+      rescue
+        query('ROLLBACK')
+        raise
+        return false # Failed Transaction
+      end
+    end
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,71 @@
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/mock'
+require 'mocha/setup'
+require 'commendo'
+
+module Commendo
+
+  class ConfigurationTest < Minitest::Test
+
+    def setup
+      Commendo.config = nil
+    end
+
+    def test_default_values_on_configuration_class
+      assert_equal :redis, Commendo::Configuration.new.backend
+      assert_equal 'localhost', Commendo::Configuration.new.host
+      assert_equal 6379, Commendo::Configuration.new.port
+      assert_equal 15, Commendo::Configuration.new.database
+      assert_nil Commendo::Configuration.new.username
+      assert_nil Commendo::Configuration.new.password
+    end
+
+    def test_returns_same_object_each_time
+      config1 = Commendo.config
+      config2 = Commendo.config
+      config3 = Commendo.config
+      assert config1.equal? config2
+      assert config2.equal? config3
+    end
+
+    def test_config_returns_default_configuration
+      config = Commendo.config
+      assert config.is_a? Commendo::Configuration
+      assert_equal :redis, config.backend
+      assert_equal 'localhost', config.host
+      assert_equal 6379, config.port
+      assert_equal 15, config.database
+      assert_nil config.username
+      assert_nil config.password
+    end
+
+    def test_configure_stores_settings
+      config = Commendo.config do |config|
+        config.backend = :mysql
+        config.host = 'mysql.example.com'
+        config.port = 9999
+        config.database = 'some_mysql_db'
+        config.username = 'root'
+        config.password = 'Passw0rd!!'
+      end
+
+      assert config.is_a? Commendo::Configuration
+      assert_equal :mysql, config.backend
+      assert_equal 'mysql.example.com', config.host
+      assert_equal 9999, config.port
+      assert_equal 'some_mysql_db', config.database
+      assert_equal 'root', config.username
+      assert_equal 'Passw0rd!!', config.password
+    end
+
+    def test_to_hash
+      expected = {backend: :redis, host: 'localhost', port: 6379, database: 15, username: nil, password: nil}
+      actual = Commendo::Configuration.new.to_hash
+      assert_equal expected, actual
+    end
+
+  end
+
+end

data/test/mysql_content_set_test.rb

@@ -0,0 +1,40 @@
+require_relative 'tests_for_content_sets.rb'
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/mock'
+require 'mocha/setup'
+require 'commendo'
+
+module Commendo
+
+  class MySqlContentSetTest < Minitest::Test
+
+    def setup
+      Commendo.config do |config|
+        config.backend = :mysql
+        config.host = 'localhost'
+        config.port = 3306
+        config.database = 'commendo_test'
+        config.username = 'commendo'
+        config.password = 'commendo123'
+      end
+      client = Mysql2::Client.new(Commendo.config.to_hash)
+      %w(Tags Resources).each {|table| client.query("DELETE FROM #{table};") }
+      @key_base = 'CommendoTests'
+      @cs = ContentSet.new(key_base: @key_base)
+    end
+
+    def create_tag_set(kb)
+      Commendo::TagSet.new(key_base: kb)
+    end
+
+    def create_content_set(key_base, ts = nil)
+      Commendo::ContentSet.new(key_base: key_base, tag_set: ts)
+    end
+
+    include TestsForContentSets
+
+  end
+
+end

data/test/mysql_tag_set_test.rb

@@ -0,0 +1,34 @@
+require_relative 'tests_for_tag_sets'
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/mock'
+require 'mocha/setup'
+require 'commendo'
+
+module Commendo
+
+  class MySqlTagSetTest < Minitest::Test
+
+    def setup
+      Commendo.config do |config|
+        config.backend = :mysql
+        config.host = 'localhost'
+        config.port = 3306
+        config.database = 'commendo_test'
+        config.username = 'commendo'
+        config.password = 'commendo123'
+      end
+      client = Mysql2::Client.new(Commendo.config.to_hash)
+      %w(Tags Resources).each {|table| client.query("DELETE FROM #{table};") }
+      @ts = TagSet.new(key_base: 'TagSetTest')
+    end
+
+    def create_tag_set(kb)
+      Commendo::TagSet.new(key_base: kb)
+    end
+
+    include TestsForTagSets
+
+  end
+end

data/test/mysql_weighted_group_test.rb

@@ -0,0 +1,54 @@
+require_relative 'tests_for_weighted_groups'
+gem 'minitest'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/mock'
+require 'mocha/setup'
+require 'commendo'
+
+module Commendo
+
+  class MySqlWeightedGroupTest < Minitest::Test
+
+    def setup
+      super
+      Commendo.config do |config|
+        config.backend = :mysql
+        config.host = 'localhost'
+        config.port = 3306
+        config.database = 'commendo_test'
+        config.username = 'commendo'
+        config.password = 'commendo123'
+      end
+      client = Mysql2::Client.new(Commendo.config.to_hash)
+      %w(Tags Resources).each {|table| client.query("DELETE FROM #{table};") }
+      @tag_set = TagSet.new(key_base: 'CommendoTests:Tags')
+      @cs1 = ContentSet.new(key_base: 'CommendoTests:ContentSet1', tag_set: @tag_set)
+      @cs2 = ContentSet.new(key_base: 'CommendoTests:ContentSet2', tag_set: @tag_set)
+      @cs3 = ContentSet.new(key_base: 'CommendoTests:ContentSet3', tag_set: @tag_set)
+      (3..23).each do |group|
+        (3..23).each do |res|
+          @cs1.add_by_group(group, res) if res.modulo(group).zero? && res.modulo(2).zero?
+          @cs2.add_by_group(group, res) if res.modulo(group).zero? && res.modulo(3).zero?
+          @cs3.add_by_group(group, res) if res.modulo(group).zero? && res.modulo(6).zero?
+          @tag_set.add(res, 'mod3') if res.modulo(3).zero?
+          @tag_set.add(res, 'mod4') if res.modulo(4).zero?
+          @tag_set.add(res, 'mod5') if res.modulo(5).zero?
+          @tag_set.add(res, 'mod7') if res.modulo(7).zero?
+        end
+      end
+      [@cs1, @cs2, @cs3].each { |cs| cs.calculate_similarity }
+      @weighted_group = Commendo::WeightedGroup.new(key_base: 'CommendoTests:WeightedGroup',
+                                                    content_sets: [{cs: @cs1, weight: 1.0},
+                                                                   {cs: @cs2, weight: 10.0},
+                                                                   {cs: @cs3, weight: 100.0}]
+      )
+    end
+
+    include TestsForWeightedGroups
+
+  end
+
+end
+
+