weaviate_record 0.0.3

data/lib/weaviate_record/schema.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module WeaviateRecord
+  # This module contains methods that helps to build, maintain and read data from weaviate schema
+  class Schema
+    class << self
+      # :stopdoc:
+
+      STRUCTURE_FILE_BOILERPLATE = lambda do |schema|
+        <<~RUBY
+          # frozen_string_literal: true
+
+          module WeaviateRecord
+            # This class stores the schema of all Weaviate Collections
+            # Don't change it manually, use the WeaviateRecord::Schema.update! method to update the schema
+            class Schema
+              def self.all_collections # rubocop:disable Metrics/MethodLength
+                #{schema}
+              end
+            end
+          end
+        RUBY
+      end
+
+      # :startdoc:
+
+      # This method updates the local schema file with the latest schema from Weaviate
+      # The schema file path is configured by setting +WeaviateRecord.config.schema_file_path+
+      #
+      # If the rubocop is installed in the system, it will format the generated schema file too.
+      def update!
+        create_weaviate_db_dir!
+        File.write(WeaviateRecord.config.schema_file_path, STRUCTURE_FILE_BOILERPLATE[pretty_schema])
+        rubocop_format_file
+        nil
+      end
+
+      # This method checks if the local schema file is in sync with the schema in Weaviate database
+      def synced?
+        if File.exist?(WeaviateRecord.config.schema_file_path)
+          load WeaviateRecord.config.schema_file_path
+          WeaviateRecord::Schema.all_collections == schema_list
+        else
+          false
+        end
+      end
+
+      # This method returns the weaviate schema for the given collection class
+      def find_collection(klass)
+        load WeaviateRecord.config.schema_file_path
+        collection_schema = all_collections[:classes].find { |collection| collection[:class] == klass.to_s }
+        if collection_schema.nil?
+          raise WeaviateRecord::Errors::CollectionNotFound, "Collection #{klass} not found in the schema"
+        end
+
+        new(collection_schema)
+      end
+
+      # :stopdoc:
+
+      private
+
+      def schema_list
+        WeaviateRecord::Connection.new.schema_list
+      end
+
+      def pretty_schema
+        schema_list.pretty_inspect
+      end
+
+      def rubocop_format_file
+        # To prettify the generated file
+        system("rubocop -a #{WeaviateRecord.config.schema_file_path}", %i[err out] => File::NULL)
+      end
+
+      def create_weaviate_db_dir!
+        dir_path = WeaviateRecord.config.schema_file_path.delete_suffix('/schema.rb')
+        FileUtils.mkdir_p(dir_path) unless File.directory?(dir_path)
+      end
+    end
+
+    def initialize(schema)
+      @schema = schema
+    end
+
+    # :startdoc:
+    # This method returns the list of attributes for the collection
+    #
+    # ==== Usage
+    #  WeaviateRecord::Schema.find_collection(Article).attributes_list
+    def attributes_list
+      @schema[:properties].map { |property| property[:name] }
+    end
+
+    # This attribute returns the schema of the collection in Hash format
+    attr_reader :schema
+
+    # :enddoc:
+    private_class_method :new
+  end
+end

data/lib/weaviate_record.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'active_model'
+require 'active_support/core_ext/string/conversions'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+# Starting point of the gem
+module WeaviateRecord
+  class << self
+    # Configuration object for WeaviateRecord
+    def config
+      @config ||= Struct.new(
+        :similarity_search_threshold,
+        :schema_file_path,
+        :sync_schema_on_load
+      ).new(0.55, "#{Object.const_defined?('Rails') ? Rails.root : Dir.pwd}/db/weaviate/schema.rb", false)
+    end
+
+    # Used to configure WeaviateRecord, accepts a block and yields the configuration object
+    #
+    # ==== Example:
+    #   WeaviateRecord.configure do |config|
+    #     config.similarity_search_threshold = 0.6
+    #     config.schema_file_path = "#{Rails.root}/db/weaviate/schema.rb"
+    #     config.sync_schema_on_load = true
+    #   end
+    #
+    # When sync_schema_on_load is set to true, the local schema will be synced
+    # with the database schema when WeaviateRecord is loaded.
+    def configure
+      yield config if block_given?
+      WeaviateRecord::Schema.update! if config.sync_schema_on_load && !WeaviateRecord::Schema.synced?
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: weaviate_record
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Sriram V
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: weaviate-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: An ORM for Weaviate vector database that follows the same conventions
+  as the ActiveRecord. This gem uses weaviate-ruby internally to connect with weaviate
+  database.
+email: srira.venkat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/weaviate_record.rb
+- lib/weaviate_record/base.rb
+- lib/weaviate_record/concerns/attribute_concern.rb
+- lib/weaviate_record/concerns/record_concern.rb
+- lib/weaviate_record/connection.rb
+- lib/weaviate_record/constants.rb
+- lib/weaviate_record/errors.rb
+- lib/weaviate_record/inspect.rb
+- lib/weaviate_record/method_missing.rb
+- lib/weaviate_record/queries/ask.rb
+- lib/weaviate_record/queries/bm25.rb
+- lib/weaviate_record/queries/count.rb
+- lib/weaviate_record/queries/limit.rb
+- lib/weaviate_record/queries/near_object.rb
+- lib/weaviate_record/queries/near_text.rb
+- lib/weaviate_record/queries/near_vector.rb
+- lib/weaviate_record/queries/offset.rb
+- lib/weaviate_record/queries/order.rb
+- lib/weaviate_record/queries/select.rb
+- lib/weaviate_record/queries/where.rb
+- lib/weaviate_record/relation.rb
+- lib/weaviate_record/relation/query_builder.rb
+- lib/weaviate_record/schema.rb
+homepage: https://rubygems.org/gems/weaviate_record
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/ruby-ist/weaviate_record
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: An ORM for Weaviate vector database
+test_files: []