chromable 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8aaa1100d93658218b9e57e77b9720ad67ab4efc042aa696f2fd79618951674
-  data.tar.gz: f4d8cebff2db9c51f52a14d1ae2207efeb78b069f648ac1c5091351828275923
+  metadata.gz: a6d73bbad7320d850d166f26242c6dda3e66d953c8fce98ff6f7ccc442ba79be
+  data.tar.gz: 8d5c5bf8082c3736715f11c79d68d95781917e86c511e09a148293758d4bba4d
 SHA512:
-  metadata.gz: aeff8a1f0407ab8596a578e0243a42de80b882d3ae0db19e6ce5e973763d4149a926b2cf8a84fdad9fa4b89d008cfae7f7abac9a14eccb1e8fdb0983eac946e6
-  data.tar.gz: ce1f9e3b1ec077832a914a46ba4259803051ef8db36d488e1ed5c074574c36645412777929b7bf116c449f89e4a5162652ac8733fc66b275cefc07c86ceafa41
+  metadata.gz: c023701e1f6cf205af6d5fe8dfbf44f84904896c1cf8bb1937060d98f1f218c668524f02a75f60384ce109a26eb3c0a4a7394ab37c2a56c938dac33387572874
+  data.tar.gz: 5d75a9dc95ddefd0698d3544d9281a361ec16d89d49de3b93742f10f3a2798ac700da1c609a78bc2d6af31817ee798ffff8bfb28aa6d18b1793c871e07a84ef9

data/README.md

@@ -1,34 +1,74 @@
 # Chromable
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chromable`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby on Rails integration for ChromaDB based on `chroma-db` gem.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+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
 
-Install the gem and add to the application's Gemfile by executing:
+Then, install `chromable` and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add chromable
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or, if you are not using bundler, install it by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install chromable
 
 ## Usage
 
-TODO: Write usage instructions here
+`chromable` is depending on `chroma-db`, so you will need to initialize it in `config/initializers/chroma.rb`:
+
+```ruby
+require 'chroma-db'
+
+Chroma.connect_host = ENV.fetch('CHROMA_DB_URL', 'http://localhost:8000')
+Chroma.logger = Logger.new($stdout)
+Chroma.log_level = Chroma::LEVEL_ERROR
+```
+
+Then, include `Chromable` module in your model and initialize it:
+
+```ruby
+class Post < ApplicationRecord
+  include Chromable
+
+  chromable document: :content, metadata: %i[author category], embedder: :embed
+end
+```
+
+Where:
+- `document:` is a callable represents the text content you want to embed and store in ChromaDB.
+- `metadata:` is the list of attributes to be passed to ChromaDB as metadata to be used to filter.
+- `embedder:` is a callable returns the embedding representation for the current instance.
+
+Optionaly you can pass `collection_name:`. If not passed, the plural form of the model name will be used.
+
+All `chromable` method arguments are optional.
+
+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:
+
+- `embedding`: Retrieves the instance's ChromaDB embedding object.
+- `upsert_embedding`: Creates or updates the instance's ChromaDB embedding object.
+- `destroy_embedding`: Destroys the instance's ChromaDB embedding object.
+
+All these methods (including `Model.collection`) are available with `chroma_` prefix, if you have similar methods defined in your model.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle install`. To release a new version, update the version number in `version.rb`, and then create a git tag for the version, push git commits and the created tag. The `Publish Gem` Github Action will push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chromable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/chromable/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/AliOsm/chromable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/chromable/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/chromable.gemspec

@@ -32,8 +32,8 @@ 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'
+  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
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/chromable/version.rb

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

data/lib/chromable.rb

@@ -19,7 +19,7 @@ module Chromable
   end
 
   class_methods do
-    def chromable(document:, metadata:, embedder:, collection_name: nil)
+    def chromable(collection_name: nil, document: nil, metadata: nil, embedder: nil)
       self.collection_name = (collection_name.presence || name.underscore.pluralize)
       self.document = document
       self.metadata = metadata
@@ -41,9 +41,9 @@ module Chromable
     self.class.chroma_collection.upsert(
       Chroma::Resources::Embedding.new(
         id: id,
-        document: send(self.class.document),
-        embedding: send(self.class.embedder),
-        metadata: self.class.metadata.index_with { |attribute| send(attribute) }
+        document: self.class.document ? send(self.class.document) : nil,
+        embedding: self.class.embedder ? send(self.class.embedder) : nil,
+        metadata: self.class.metadata ? self.class.metadata.index_with { |attribute| send(attribute) } : nil
       )
     )
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chromable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Ali Hamdi Ali Fadel
@@ -14,28 +14,28 @@ dependencies:
   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
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
 description: