activerage 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 250d9a9b72a053184a1beb954b2246f1ad7632ee6d7fcb26885ca3989af62520
+  data.tar.gz: b36a58e4605afdc47755c2d9e5ec80ebbdf18111a43d0e759080533b19d814c2
+SHA512:
+  metadata.gz: c9cec420afffc918b1ba65c869b703cc1467711140f7b5d88e13519c539ee09507c01cd0e8109c3acb60c259876e878cabd88a018e563d4dea79c6c545482a09
+  data.tar.gz: e95c25df4669225349f01c26b53c8901335926726735b325dfbf217807ef5ee56f5d6a71375d6be3dbeb8b224465c0619f967be890ddab4f623b8bf0970e406a

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Abdelkader Boudih
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# ActiveRage
+
+A Rails engine for RAG (Retrieval Augmented Generation) functionality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerage'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+### Configuration
+
+Create a configuration file at `config/active_rage.yml`:
+
+```yaml
+development:
+  embedding_model: "text-embedding-3-small"
+  search_limit: 10
+  vector_dimensions: 1536
+```
+
+### Basic Setup
+
+```ruby
+# config/initializers/active_rage.rb
+ActiveRage.configure do |config|
+  config.embedding_model = "text-embedding-3-small"
+  config.search_limit = 10
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/seuros/active_rage.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task default: :test
+

data/app/jobs/active_rage/application_job.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActiveRage
+  class ApplicationJob < ActiveJob::Base
+    # Placeholder
+  end
+end
+

data/app/jobs/active_rage/indexing_job.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActiveRage
+  class IndexingJob < ApplicationJob
+    # Placeholder
+  end
+end
+

data/app/models/active_rage/application_record.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActiveRage
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end
+

data/app/models/active_rage/document.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActiveRage
+  class Document < ApplicationRecord
+    # Placeholder
+  end
+end
+

data/app/services/active_rage/embedding_service.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActiveRage
+  class EmbeddingService
+    # Placeholder
+  end
+end
+

data/app/services/active_rage/search_service.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module ActiveRage
+  class SearchService
+    # Placeholder
+  end
+end
+

data/config/active_rage.example.yml

@@ -0,0 +1,14 @@
+development:
+  embedding_model: "text-embedding-3-small"
+  search_limit: 10
+  vector_dimensions: 1536
+
+test:
+  embedding_model: "text-embedding-3-small"
+  search_limit: 5
+  vector_dimensions: 1536
+
+production:
+  embedding_model: "text-embedding-3-large"
+  search_limit: 20
+  vector_dimensions: 3072

data/lib/active_rage/configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ActiveRage
+  class Configuration
+    attr_accessor :environment, :embedding_model, :search_limit, :vector_dimensions
+
+    def initialize
+      @environment = 'development'
+      @embedding_model = nil
+      @search_limit = 10
+      @vector_dimensions = 1536
+    end
+
+    def load_from_file(path)
+      return unless File.exist?(path)
+
+      config = YAML.load_file(path)[environment]
+      return unless config
+
+      config.each do |key, value|
+        public_send("#{key}=", value) if respond_to?("#{key}=")
+      end
+    end
+  end
+end

data/lib/active_rage/engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveRage
+  class Engine < Rails::Engine
+    isolate_namespace ActiveRage
+
+    config.active_rage = ActiveSupport::OrderedOptions.new
+
+    initializer 'active_rage.configure' do |app|
+      ActiveRage.configure do |config|
+        config.environment = Rails.env.to_s
+        config.load_from_file(app.config.active_rage.config_path) if app.config.active_rage.config_path
+      end
+    end
+
+    config.generators do |g|
+      g.test_framework :minitest
+    end
+  end
+end
+

data/lib/active_rage/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveRage
+  module VERSION
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end
+

data/lib/active_rage.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'active_record'
+require 'active_job'
+require 'active_rage/engine' if defined?(Rails)
+
+loader = Zeitwerk::Loader.for_gem
+loader.ignore("#{__dir__}/generators")
+loader.inflector.inflect(
+  'openai' => 'OpenAI'
+)
+loader.setup
+
+module ActiveRage
+  class Error < StandardError; end
+
+  mattr_accessor :configuration
+  @@configuration = nil
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+    configuration
+  end
+
+  def self.config
+    configuration || configure
+  end
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: activerage
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Abdelkader Boudih
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+description: A RAG (Retrieval Augmented Generation) engine that integrates seamlessly
+  with Rails applications
+email:
+- terminale@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/jobs/active_rage/application_job.rb
+- app/jobs/active_rage/indexing_job.rb
+- app/models/active_rage/application_record.rb
+- app/models/active_rage/document.rb
+- app/services/active_rage/embedding_service.rb
+- app/services/active_rage/search_service.rb
+- config/active_rage.example.yml
+- lib/active_rage.rb
+- lib/active_rage/configuration.rb
+- lib/active_rage/engine.rb
+- lib/active_rage/version.rb
+homepage: https://github.com/seuros/active_rage
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/seuros/active_rage
+  source_code_uri: https://github.com/seuros/active_rage
+  changelog_uri: https://github.com/seuros/active_rage/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: 'ActiveRage: RAG Engine for Rails'
+test_files: []