neighbor 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5818fdfa27cc4b0678fb125e82d2fa0a3066ea173674ca541987b9084a94ac14
-  data.tar.gz: e874541532172dce9932a98506bd5ce7866a0f5c3e600ffd9d6473f226829368
+  metadata.gz: 0c8b5d19222742f33f51f2c30f9d03108ebd3ed99908a7e9dd5f4e49caa2e225
+  data.tar.gz: c9cfa942f2cdd8b9757c9ecfe5e89d0aced11263f8a559004ee15fa0c8adb3f4
 SHA512:
-  metadata.gz: 96211da20caf70383018ca626cbd83bbda5e4ffaf95e5a9b5405686b192643916325f89a652b4ba9e34e17daa1b84e8045cc644b606bab8aa6ea339ed4d7ea0d
-  data.tar.gz: bf855dc34617d489618417b9c807969f828358de19462458b7c09e1743102a8b9967b32b09660fab35f35543b77d588297c69971edb7442af0995cdca3b6ff8e
+  metadata.gz: e9e0050031ce7691baa9242b3b6b5aa76afb1fe7c63575129e68b2f5c027143b3c08f68a7babfcf2a9b02f1d9327679f75e9c40b95ac2245ea7c8dd3025d3cdb
+  data.tar.gz: a9c505740cba454437617733d4025360848a16ef9a4c9c83fc16d5bc82a3e5521c77e3cba874ef3cf318cf3a1e319567958a6156481f7fd82ef72ebaa87d97eb

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.2 (2023-12-12)
+
+- Added deprecation warning for `has_neighbors` without an attribute name
+- Added deprecation warning for `nearest_neighbors` without an attribute name
+
 ## 0.3.1 (2023-09-25)
 
 - Added support for passing multiple attributes to `has_neighbors`

data/README.md

@@ -14,7 +14,7 @@ gem "neighbor"
 
 ## Choose An Extension
 
-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.
+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 more dimensions and approximate nearest neighbor search.
 
 For cube, run:
 
@@ -35,7 +35,7 @@ rails db:migrate
 Create a migration
 
 ```ruby
-class AddNeighborVectorToItems < ActiveRecord::Migration[7.0]
+class AddEmbeddingToItems < ActiveRecord::Migration[7.1]
   def change
     add_column :items, :embedding, :cube
     # or
@@ -114,7 +114,7 @@ end
 For vector, add an approximate index to speed up queries. Create a migration with:
 
 ```ruby
-class AddIndexToItemsNeighborVector < ActiveRecord::Migration[7.0]
+class AddIndexToItemsEmbedding < ActiveRecord::Migration[7.1]
   def change
     add_index :items, :embedding, using: :ivfflat, opclass: :vector_l2_ops
     # or with pgvector 0.5.0+

data/lib/neighbor/model.rb

@@ -2,6 +2,7 @@ module Neighbor
   module Model
     def has_neighbors(*attribute_names, dimensions: nil, normalize: nil)
       if attribute_names.empty?
+        warn "[neighbor] has_neighbors without an attribute name is deprecated"
         attribute_names << :neighbor_vector
       else
         attribute_names.map!(&:to_sym)
@@ -44,6 +45,7 @@ module Neighbor
           raise ArgumentError, "unknown keywords: #{options.keys.map(&:inspect).join(", ")}" if options.any?
 
           if vector.nil? && !attribute_name.nil? && attribute_name.respond_to?(:to_a)
+            warn "[neighbor] nearest_neighbors without an attribute name is deprecated"
             vector = attribute_name
             attribute_name = :neighbor_vector
           end
@@ -123,7 +125,11 @@ module Neighbor
             .order(Arel.sql(order))
         }
 
-        def nearest_neighbors(attribute_name = :neighbor_vector, **options)
+        def nearest_neighbors(attribute_name = nil, **options)
+          if attribute_name.nil?
+            warn "[neighbor] nearest_neighbors without an attribute name is deprecated"
+            attribute_name = :neighbor_vector
+          end
           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]

data/lib/neighbor/type/cube.rb

@@ -0,0 +1,38 @@
+module Neighbor
+  module Type
+    class Cube < ActiveRecord::Type::String
+      def type
+        :cube
+      end
+
+      def cast(value)
+        if value.is_a?(Array)
+          if value.first.is_a?(Array)
+            value.map { |v| cast_point(v) }.join(", ")
+          else
+            cast_point(value)
+          end
+        else
+          super
+        end
+      end
+
+      # TODO uncomment in 0.4.0
+      # def deserialize(value)
+      #   if value.nil?
+      #     super
+      #   elsif value.include?("),(")
+      #     value[1..-1].split("),(").map { |v| v.split(",").map(&:to_f) }
+      #   else
+      #     value[1..-1].split(",").map(&:to_f)
+      #   end
+      # end
+
+      private
+
+      def cast_point(value)
+        "(#{value.map(&:to_f).join(", ")})"
+      end
+    end
+  end
+end

data/lib/neighbor/type/vector.rb

@@ -0,0 +1,14 @@
+module Neighbor
+  module Type
+    class Vector < ActiveRecord::Type::String
+      def type
+        :vector
+      end
+
+      # TODO uncomment in 0.4.0
+      # def deserialize(value)
+      #   value[1..-1].split(",").map(&:to_f) unless value.nil?
+      # end
+    end
+  end
+end

data/lib/neighbor/version.rb

@@ -1,3 +1,3 @@
 module Neighbor
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/lib/neighbor.rb

@@ -10,10 +10,10 @@ module Neighbor
   module RegisterTypes
     def initialize_type_map(m = type_map)
       super
-      m.register_type "cube", ActiveRecord::ConnectionAdapters::PostgreSQL::OID::SpecializedString.new(:cube)
+      m.register_type "cube", Type::Cube.new
       m.register_type "vector" do |_, _, sql_type|
         limit = extract_limit(sql_type)
-        ActiveRecord::ConnectionAdapters::PostgreSQL::OID::SpecializedString.new(:vector, limit: limit)
+        Type::Vector.new(limit: limit)
       end
     end
   end
@@ -22,6 +22,8 @@ end
 ActiveSupport.on_load(:active_record) do
   require_relative "neighbor/model"
   require_relative "neighbor/vector"
+  require_relative "neighbor/type/cube"
+  require_relative "neighbor/type/vector"
 
   extend Neighbor::Model
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neighbor
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -40,6 +40,8 @@ files:
 - lib/neighbor.rb
 - lib/neighbor/model.rb
 - lib/neighbor/railtie.rb
+- lib/neighbor/type/cube.rb
+- lib/neighbor/type/vector.rb
 - lib/neighbor/vector.rb
 - lib/neighbor/version.rb
 homepage: https://github.com/ankane/neighbor