simple_recommender 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de68a178eb1100f0d5245a71d0d2af980c462068
-  data.tar.gz: 7a79d4fc80f4926e1a255ac3d9b77bc0f1c9e910
+  metadata.gz: a2cb3b1f905c25ef005cea8efb18ac33fd8247f6
+  data.tar.gz: 9bd804d22da171f530d108cd5f8f38ebe5c219b1
 SHA512:
-  metadata.gz: c31df3ffca819945788ff30a808413caf7ffc858b514748982dbb932c0a9077f73b91d30fc78b736cbd5b9f6bf69506f93cb6809f5d4b5be893ff3bcd3324e35
-  data.tar.gz: 481725920d711a3e1784fbf5e59fa90f54b205af08c7c0f87a835086394fe1481b82b6fd55999cba344c9b0f389e4c6cf24b2280f39d4062d62772d4adf35be1
+  metadata.gz: 373fd505ef35d570b7b36db8bbfdae06b96462a411ee8721fcf763adf528d2983f5e411b93babb987cdffa71627368166d20e3a8e841aaae61c44313acbc426c
+  data.tar.gz: 0d537aadd70ad398f1e28d61cc282f74d202750f10f07e9b6f965fe5aaf3e7a8126c7c2ff7f8330836cfa32632c938eabd64909bf9f1cbbfe7a877511fe5057a

data/lib/simple_recommender/recommendable.rb

@@ -1,32 +1,46 @@
 module SimpleRecommender
   module Recommendable
     extend ActiveSupport::Concern
+    DEFAULT_N_RESULTS = 10
+    SIMILARITY_KEY = "similarity" # todo: allow renaming to avoid conflicts
+    AssociationMetadata = Struct.new(:join_table, :foreign_key, :association_foreign_key)
 
-    included do
-      SIMILARITY_KEY = "similarity" # todo: allow renaming to avoid conflicts
-      DEFAULT_N_RESULTS = 10
-
-      def similar_by(association_name, n_results: DEFAULT_N_RESULTS)
-        query = similar_query(
-          association_name: association_name,
-          n_results: n_results
-        )
-
-        self.class.find_by_sql(query)
+    module ClassMethods
+      def similar_by(association_name)
+        define_method :similar_items do |n_results: DEFAULT_N_RESULTS|
+          query = similar_query(
+                    association_name: association_name,
+                    n_results: n_results
+                  )
+          self.class.find_by_sql(query)
+        end
       end
+    end
 
-      # For each applicable association, add a dynamically named shortcut method
-      # e.g. when basing similarity on users, define :similar_by_users
-      self.reflect_on_all_associations.each do |association|
-        association_name = association.name
+    included do
+      private
 
-        define_method "similar_by_#{association_name}" do |n_results: DEFAULT_N_RESULTS|
-          similar_by(association_name, n_results: n_results)
+      # Returns database metadata about an association based on its type,
+      # used in constructing a similarity query based on that association
+      def association_metadata(reflection)
+        case reflection
+        when ActiveRecord::Reflection::HasAndBelongsToManyReflection
+          AssociationMetadata.new(
+            reflection.join_table,
+            reflection.foreign_key,
+            reflection.association_foreign_key
+          )
+        when ActiveRecord::Reflection::ThroughReflection
+          AssociationMetadata.new(
+            reflection.through_reflection.table_name,
+            reflection.through_reflection.foreign_key,
+            reflection.association_foreign_key
+          )
+        else
+          raise ArgumentError, "Association '#{reflection.name}' is not a supported type"
         end
       end
 
-      private
-
       # Returns a Postgres query that can be executed to return similar items.
       # Reflects on the association to get relevant table names, and then
       # uses Postgres's integer array intersection/union operators to
@@ -63,29 +77,6 @@ module SimpleRecommender
           ORDER BY similarity DESC;
         SQL
       end
-
-      # Returns database metadata about an association based on its type,
-      # used in constructing a similarity query based on that association
-      def association_metadata(reflection)
-        case reflection
-        when ActiveRecord::Reflection::HasAndBelongsToManyReflection
-          AssociationMetadata.new(
-            reflection.join_table,
-            reflection.foreign_key,
-            reflection.association_foreign_key
-          )
-        when ActiveRecord::Reflection::ThroughReflection
-          AssociationMetadata.new(
-            reflection.through_reflection.table_name,
-            reflection.through_reflection.foreign_key,
-            reflection.association_foreign_key
-          )
-        else
-          raise ArgumentError, "Association '#{reflection.name}' is not a supported type"
-        end
-      end
-
-      AssociationMetadata = Struct.new(:join_table, :foreign_key, :association_foreign_key)
     end
   end
 end

data/lib/simple_recommender/version.rb

@@ -1,3 +1,3 @@
 module SimpleRecommender
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/dummy/app/models/book.rb

@@ -1,4 +1,6 @@
 class Book < ActiveRecord::Base
+  include SimpleRecommender::Recommendable
+
   has_and_belongs_to_many :tags
 
   has_many :likes
@@ -6,5 +8,5 @@ class Book < ActiveRecord::Base
 
   belongs_to :author, class_name: "User"
 
-  include SimpleRecommender::Recommendable
+  similar_by :users
 end