chromable 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6d73bbad7320d850d166f26242c6dda3e66d953c8fce98ff6f7ccc442ba79be
-  data.tar.gz: 8d5c5bf8082c3736715f11c79d68d95781917e86c511e09a148293758d4bba4d
+  metadata.gz: 9df743def1991fb00b56fdfb0878642a2e5568136d4078dcb77084cf47c6ce14
+  data.tar.gz: 6972ef16ef5c9f6f2f39de7e18c7028399d73b917001243c272e3b94d41839dc
 SHA512:
-  metadata.gz: c023701e1f6cf205af6d5fe8dfbf44f84904896c1cf8bb1937060d98f1f218c668524f02a75f60384ce109a26eb3c0a4a7394ab37c2a56c938dac33387572874
-  data.tar.gz: 5d75a9dc95ddefd0698d3544d9281a361ec16d89d49de3b93742f10f3a2798ac700da1c609a78bc2d6af31817ee798ffff8bfb28aa6d18b1793c871e07a84ef9
+  metadata.gz: 07adc75fffe609a6e493f30091745093c3bb9164cd8e64c1f81519f8c447c4a6142075de97d461062903c28ac4d1a15d79bc501c57731e0d167a8562a696650b
+  data.tar.gz: 7818ee8d5a931f5e7936a0e27bb3bc716f349415e01f3cda33ff4cd72cf3ee237a5df157709a562238469659a828121e7d55b772b531bd06c1ddc2c7bc499204

data/README.md

@@ -4,19 +4,11 @@ Ruby on Rails integration for ChromaDB based on `chroma-db` gem.
 
 ## Installation
 
-Since `chromable` is depending on `chroma-db` gem, you will need to install it using:
-
-    $ bundle add chroma-db
-
-Or, if you are not using bundler, install it by executing:
-
-    $ gem install chroma-db
-
-Then, install `chromable` and add to the application's Gemfile by executing:
+Install `chromable` and add it to the application's Gemfile by executing:
 
     $ bundle add chromable
 
-Or, if you are not using bundler, install it by executing:
+Or, if bundler is not being used to manage dependencies, install `chromable` by executing:
 
     $ gem install chromable
 
@@ -39,6 +31,10 @@ class Post < ApplicationRecord
   include Chromable
 
   chromable document: :content, metadata: %i[author category], embedder: :embed
+
+  def embed
+    # Call OpenAI now please :)
+  end
 end
 ```
 
@@ -51,6 +47,8 @@ Optionaly you can pass `collection_name:`. If not passed, the plural form of the
 
 All `chromable` method arguments are optional.
 
+At this point, `chromable` will create, update, and destroy the ChromaDB embeddings for your objects based on Rails callbacks.
+
 To interact with the ChromaDB collection, `chromable` provides `Model.collection` method to retrieve the collection instance.
 Also, `chromable` provides the following methods for each model instance:
 

data/chromable.gemspec

@@ -32,7 +32,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '>= 6.1'
   spec.add_dependency 'chroma-db', '>= 0.6.0'
 
   # For more information and examples about making a new gem, check out our

data/lib/chromable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chromable
-  VERSION = '0.1.3'
+  VERSION = '0.1.5'
 end

data/lib/chromable.rb

@@ -1,24 +1,21 @@
 # frozen_string_literal: true
 
-require 'active_support/concern'
-
 require_relative 'chromable/version'
 
 # Ruby on Rails integration for ChromaDB.
 module Chromable
-  extend ActiveSupport::Concern
-
-  included do
-    after_save :chroma_upsert_embedding
-    after_destroy :chroma_destroy_embedding
-
-    class_attribute :collection_name
-    class_attribute :document
-    class_attribute :metadata
-    class_attribute :embedder
+  def self.included(base) 
+    base.extend ClassMethods
+    base.class_attribute :collection_name
+    base.class_attribute :document
+    base.class_attribute :metadata
+    base.class_attribute :embedder
+    
+    base.after_save :chroma_upsert_embedding
+    base.after_destroy :chroma_destroy_embedding
   end
 
-  class_methods do
+  module ClassMethods
     def chromable(collection_name: nil, document: nil, metadata: nil, embedder: nil)
       self.collection_name = (collection_name.presence || name.underscore.pluralize)
       self.document = document
@@ -53,6 +50,6 @@ module Chromable
   end
 
   alias embedding chroma_embedding unless method_defined? :embedding
-  alias upsert_embedding chroma_embedding unless method_defined? :upsert_embedding
-  alias destroy_embedding chroma_embedding unless method_defined? :destroy_embedding
+  alias upsert_embedding chroma_upsert_embedding unless method_defined? :upsert_embedding
+  alias destroy_embedding chroma_destroy_embedding unless method_defined? :destroy_embedding
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: chromable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Ali Hamdi Ali Fadel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-07 00:00:00.000000000 Z
+date: 2023-12-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: chroma-db
   requirement: !ruby/object:Gem::Requirement