bridgetown-activerecord 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef8ced2ced4ceb5c4945477bb4ff888effd806d532b923f08524963210f211dd
-  data.tar.gz: 9945be6d6dc6c7d11089ae5d227102d23f5f61c92d10d2891fbb45da12a6b4ed
+  metadata.gz: e1ec1ff457bbf992255599d52b2c8efa8708f80c97dd7c4e9e5b4497adc7edb9
+  data.tar.gz: b8dbab9b63c86433665feda57f3f316c6c01ca4418a17c0bc3bcb2768431d9b5
 SHA512:
-  metadata.gz: 55d827960c968db59a1477dc39945c54c6f6f55a9d040da866f30295e9902563b64325fb29eae2a3e69a656fa5913534a75daaebff11daf69f91445b2a07afd0
-  data.tar.gz: 072241e0d27f71b085c5a9f54cfeae05c7a0ef34f4ad4e0bc74207579dbd6deb343cbded7edea844eeedc8901bd57032b60dae11dd7eaff1364edf2435ae48f1
+  metadata.gz: f1ecfaec16724b1f609e6ea43b645afd1d8b08bc4d8a1332254d4f7ff32d599d52b7c3f8cfdcd0519cef550ddf61acc68e693290c78b3f2abf251aa7ca78cc30
+  data.tar.gz: c96065139c88134350b93e71109a9090355f2e6954b3be5ea437f106be18ac7f7473e23fe634798b8139227a5ace8a09ae4398166626614c95de6c784f1be77b

data/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [2.2.0] - 2023-03-13
+
+- Add support for Sequel with shared DB connection
+
+## [2.1.0] - 2022-10-10
+
+- Allow customizing of the models dir
+
 ## [2.0.0] - 2022-10-08
 
 - Upgrade to initializers system in Bridgetown 1.2

data/Gemfile

@@ -8,7 +8,7 @@ gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
 group :test do
   gem "minitest"
   gem "minitest-reporters"
+  gem "pg", "~> 1.3"
+  gem "sequel-activerecord_connection", "~> 1.2"
   gem "shoulda"
 end
-
-gem "pg", "~> 1.3", group: :test

data/README.md

@@ -1,6 +1,8 @@
 # Bridgetown Active Record plugin
 
-This plugin adds Active Record support to Bridgetown sites (v1.2 or higher). You can pull data from a database (currently PostgreSQL is officially supported) during a static build or during server requests (or both!) and use many of the features you know and love from Active Record in Rails—including migrations!
+This plugin adds [Active Record](https://guides.rubyonrails.org/active_record_basics.html) support to Bridgetown sites (v1.2 or higher). You can pull data from a database (currently PostgreSQL is officially supported) during a static build or during server requests (or both!) and use many of the features you know and love from Active Record in Rails—including migrations!
+
+In addition, if you also like using the [Sequel gem](https://github.com/jeremyevans/sequel) for your database access, this plugin can support instantiating Sequel with a shared DB connection via the [sequel-activerecord_connection](https://github.com/janko/sequel-activerecord_connection) extension ([see below](#using-with-sequel)).
 
 ## Installation
 
@@ -109,6 +111,28 @@ BridgetownActiveRecord.load_tasks(models_dir: "app/models")
 
 (Don't forget to update your autoload path in `config/initializers.rb` accordingly.)
 
+## Using with Sequel
+
+To set up [Sequel](https://github.com/jeremyevans/sequel) using the same database connection as Active Record, follow these steps:
+
+First, install the sequel-activerecord_connection gem:
+
+```sh
+bundle add sequel-activerecord_connection
+```
+
+Next, update your configuration in `config/initializers.rb` as follows:
+
+```ruby
+init :"bridgetown-activerecord", sequel_support: :postgres # or mysql2 or sqlite3
+```
+
+Now you should be able to call `DB` to access the Sequel API anywhere in your Bridgetown or Roda code:
+
+```ruby
+DB.tables # => [:ar_internal_metadata, :schema_migrations, etc.]
+```
+
 ## Testing
 
 * Run `bundle exec rake test` to run the test suite

data/lib/bridgetown-activerecord/initializer.rb

@@ -20,9 +20,14 @@ module BridgetownActiveRecord
   end
 end
 
-Bridgetown.initializer :"bridgetown-activerecord" do |config|
+Bridgetown.initializer :"bridgetown-activerecord" do |config, sequel_support: nil|
   ActiveRecord::Base.establish_connection(
     BridgetownActiveRecord.db_configuration(config)[Bridgetown.environment]
   )
   ActiveRecord::Base.logger = BridgetownActiveRecord.log_writer
+
+  next unless sequel_support
+
+  require "sequel"
+  DB = Sequel.send(sequel_support, extensions: :activerecord_connection) # rubocop:disable Lint/ConstantDefinitionInBlock
 end

data/lib/bridgetown-activerecord/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownActiveRecord
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-activerecord
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-11 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown