neighbor 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a71d9aff5133b9551dc47cfe490d5d6a0ee63d2b77ac1d3d2f381f58aef67d6
-  data.tar.gz: d22cab3140b979ee0d13ddd2c99f064282e896d49c265bf9b1946dafbda7783a
+  metadata.gz: da5f64785d929d673be65b5cf224894b6e5d6bbd8d66a27b84339ced5e8c1334
+  data.tar.gz: fbb217005dcd6a3c1d946eec178acf7f0f87ac3521e2deb4b7c8c2bc5433b633
 SHA512:
-  metadata.gz: 3e24a71c6ace693525fc4866aaa21ee7c75f7251d5d6e0820da3b6abc0bd6fd5921b20c2edbb7fc656b75991e1fc5607357dc02870072900e7b6ef972c840280
-  data.tar.gz: 5b75200355c62c549c2d61820e74e1cc71e4ebce68a1e390af60dbe76b6e1b7a69e71d73c8121db42ea05fc296db4ecc1f5776c71ad988685f13f71fc00fec66
+  metadata.gz: d293a32bfd18e00851bcbbaecac507374e9105071fbf7ab8446eaea093b9741b573356a7b292bf19dd420c2d7208c62023be4f7106711e19f9e84970aedba2bd
+  data.tar.gz: 07ed7bccab0924fe183df1176937d6ce98d1e53313e2be53d96605d691ad697ff4e14abc722b7a3501b20a5ca2880774625a306c274f81d308895fa78a1bf068

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.2 (2022-07-13)
+
+- Added support for configurable attribute name
+- Added support for multiple attributes per model
+
 ## 0.2.1 (2021-12-15)
 
 - Added support for Active Record 7

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Andrew Kane
+Copyright (c) 2021-2022 Andrew Kane
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -9,12 +9,12 @@ Nearest neighbor search for Rails and Postgres
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'neighbor'
+gem "neighbor"
 ```
 
 ## Choose An Extension
 
-Neighbor supports two extensions: [cube](https://www.postgresql.org/docs/current/cube.html) and [vector](https://github.com/ankane/pgvector). cube ships with Postgres, while vector supports approximate nearest neighbor search.
+Neighbor supports two extensions: [cube](https://www.postgresql.org/docs/current/cube.html) and [vector](https://github.com/pgvector/pgvector). cube ships with Postgres, while vector supports approximate nearest neighbor search.
 
 For cube, run:
 
@@ -23,7 +23,7 @@ rails generate neighbor:cube
 rails db:migrate
 ```
 
-For vector, [install pgvector](https://github.com/ankane/pgvector#installation) and run:
+For vector, [install pgvector](https://github.com/pgvector/pgvector#installation) and run:
 
 ```sh
 rails generate neighbor:vector

data/lib/neighbor/model.rb

@@ -1,16 +1,43 @@
 module Neighbor
   module Model
-    def has_neighbors(dimensions: nil, normalize: nil)
-      # TODO make configurable
-      # likely use argument
-      attribute_name = :neighbor_vector
+    def has_neighbors(attribute_name = :neighbor_vector, dimensions: nil, normalize: nil)
+      attribute_name = attribute_name.to_sym
 
       class_eval do
-        raise Error, "nearest_neighbors already defined" if method_defined?(:nearest_neighbors)
+        @neighbor_attributes ||= {}
+
+        if @neighbor_attributes.empty?
+          def self.neighbor_attributes
+            parent_attributes =
+              if superclass.respond_to?(:neighbor_attributes)
+                superclass.neighbor_attributes
+              else
+                {}
+              end
+
+            parent_attributes.merge(@neighbor_attributes || {})
+          end
+        end
+
+        raise Error, "has_neighbors already called for #{attribute_name.inspect}" if neighbor_attributes[attribute_name]
+        @neighbor_attributes[attribute_name] = {dimensions: dimensions, normalize: normalize}
 
         attribute attribute_name, Neighbor::Vector.new(dimensions: dimensions, normalize: normalize, model: self, attribute_name: attribute_name)
 
-        scope :nearest_neighbors, ->(vector, distance:) {
+        return if @neighbor_attributes.size != 1
+
+        scope :nearest_neighbors, ->(attribute_name, vector = nil, distance:) {
+          if vector.nil? && !attribute_name.nil? && attribute_name.respond_to?(:to_a)
+            vector = attribute_name
+            attribute_name = :neighbor_vector
+          end
+          attribute_name = attribute_name.to_sym
+
+          options = neighbor_attributes[attribute_name]
+          raise ArgumentError, "Invalid attribute" unless options
+          normalize = options[:normalize]
+          dimensions = options[:dimensions]
+
           return none if vector.nil?
 
           distance = distance.to_s
@@ -80,10 +107,14 @@ module Neighbor
             .order(Arel.sql(order))
         }
 
-        define_method :nearest_neighbors do |**options|
+        def nearest_neighbors(attribute_name = :neighbor_vector, **options)
+          attribute_name = attribute_name.to_sym
+          # important! check if neighbor attribute before calling send
+          raise ArgumentError, "Invalid attribute" unless self.class.neighbor_attributes[attribute_name]
+
           self.class
             .where.not(self.class.primary_key => send(self.class.primary_key))
-            .nearest_neighbors(send(attribute_name), **options)
+            .nearest_neighbors(attribute_name, send(attribute_name), **options)
         end
       end
     end

data/lib/neighbor/version.rb

@@ -1,3 +1,3 @@
 module Neighbor
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neighbor
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Nearest neighbor search for Rails and Postgres