Refactor to Rails::Engine (#1003)

Author: lemingos

.gitignore

@@ -16,3 +16,13 @@
 .idea
 test.ann
 Gemfile.lock
+
+/log/*.log
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-*
+test/dummy/log/*.log
+test/dummy/storage/
+test/dummy/tmp/
+*.keep
+
+tags

.rspec

@@ -1,3 +1,4 @@
---format documentation
---color
 --require spec_helper
+--require rails_helper
+--format documentation
+--color

.tool-versions

@@ -1 +1 @@
-ruby 3.4
+ruby 3.4.4

CHANGELOG.md

@@ -12,6 +12,7 @@
 ## [Unreleased]
 - [COMPAT] [https://github.com/patterns-ai-core/langchainrb/pull/980] Suppress a Ruby 3.4 warning for URI parser.
 - [BREAKING] [https://github.com/patterns-ai-core/langchainrb/pull/997] Remove `Langchain::Vectorsearch::Epsilla` class
+- [BREAKING] [https://github.com/patterns-ai-core/langchainrb/pull/1003] Response classes are now namespaced under `Langchain::LLM::Response`, converted to Rails engine
 
 ## [0.19.5]
 - [BREAKING] [https://github.com/patterns-ai-core/langchainrb/pull/859] Add metadata support to PgVector storage
@@ -238,7 +239,7 @@
 
 ## [0.8.0]
 - [BREAKING] Updated llama_cpp.rb to 0.9.4. The model file format used by the underlying llama.cpp library has changed to GGUF. llama.cpp ships with scripts to convert existing files and GGUF format models can be downloaded from HuggingFace.
-- Introducing Langchain::LLM::GoogleVertexAi LLM provider
+- Introducing Langchain::LLM::GoogleVertexAI LLM provider
 
 ## [0.7.5] - 2023-11-13
 - Fixes

Gemfile

@@ -2,13 +2,19 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in langchain.gemspec
+# Specify your gem's dependencies in langchain.gemspec.
 gemspec
 
-gem "rake", "~> 13.0"
+group :test do
+  gem "sqlite3"
+end
 
-gem "rspec", "~> 3.0"
-
-gem "standard", ">= 1.35.1"
-# Lets add rubocop explicitly here, we are using only standardrb rules in .rubocop.yml
-gem "rubocop"
+# Development and test dependencies
+group :development, :test do
+  gem "rspec", "~> 3.0"
+  gem "rspec-rails"
+  gem "standard", ">= 1.35.1"
+  gem "rubocop"
+  gem "rubocop-rails-omakase", require: false
+  gem "rake", "~> 13.0"
+end

Rakefile

@@ -1,17 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "standard/rake"
-require "yard"
-
-RSpec::Core::RakeTask.new(:spec)
+require "bundler/setup"
 
-task default: :spec
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 
-Rake::Task["spec"].enhance do
-  Rake::Task["standard:fix"].invoke
-end
-
-YARD::Rake::YardocTask.new do |t|
-end
+require "bundler/gem_tasks"

bin/console

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/langchain/engine", __dir__)
+APP_PATH = File.expand_path("../test/dummy/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails"
+# Pick the frameworks you want:
+# require "active_model/railtie"
+# require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+# require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "action_mailbox/engine"
+# require "action_text/engine"
+# require "action_view/railtie"
+# require "action_cable/engine"
+# require "rails/test_unit/railtie"
+require "rails/engine/commands"

bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler/setup"
+
+# explicit rubocop config increases performance slightly while avoiding config confusion.
+ARGV.unshift("--config", File.expand_path("../.rubocop.yml", __dir__))
+
+load Gem.bin_path("rubocop", "rubocop")