bridgetown-activerecord 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccfd8d0b6032758ade7b72ece8ff373552c3257d84a35cab4a34e98c88789fb3
-  data.tar.gz: 244806f70399573021e39162d2aca78e634a8e41279c3e23c85cf42f8d1fa176
+  metadata.gz: e1ec1ff457bbf992255599d52b2c8efa8708f80c97dd7c4e9e5b4497adc7edb9
+  data.tar.gz: b8dbab9b63c86433665feda57f3f316c6c01ca4418a17c0bc3bcb2768431d9b5
 SHA512:
-  metadata.gz: db2527fb6c3ca7da3f67678bbb75d845a01d310ab762ec05661b688650a19b203c400bbfd8de4c1c86f2fdbd143e8383cda37142a751904c27368ea04612a17b
-  data.tar.gz: fea781ad77051b5018687ba9199a40839bbfc00926810170942309cdb0c5ec5e772589214d31b04731778d57aa25e8430e9518b51c2f3766b05de652c7b78af6
+  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,10 +1,14 @@
-# Bridgetown ActiveRecord plugin
+# Bridgetown Active Record plugin
 
-**NOTE:** currently waiting on a bugfix in Bridgetown itself before getting the green light…coming very soon!
+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
 
-It's recommended you run our automation script to set up your project to support ActiveRecord and DB models:
+> **IMPORTANT NOTE:** there's currently a compatibilty issue between Rails 7 gems and Rack version 3. For now, please add `gem "rack", "~> 2.2"` to your Gemfile _before_ you install this plugin.
+
+It's recommended you run our automation script to set up your project to support Active Record and DB models:
 
 ```shell
 $ bin/bridgetown apply https://github.com/bridgetownrb/bridgetown-activerecord
@@ -13,7 +17,7 @@ $ bin/bridgetown apply https://github.com/bridgetownrb/bridgetown-activerecord
 Or for a fully manual setup:
 
 ```shell
-$ bundle add bridgetown-activerecord -g bridgetown_plugins
+$ bundle add bridgetown-activerecord
 ```
 
 then replicate the individual steps outlined in the [automation script](https://github.com/bridgetownrb/bridgetown-activerecord/blob/main/bridgetown.automation.rb).
@@ -24,6 +28,8 @@ You will need to decide on your database adapter of choice. For a typical Postgr
 $ bundle add pg
 ```
 
+When deploying to production, the `DATABASE_URL` ENV var will need to be set with the appropriate connection string…many hosting services will do this for you automatically.
+
 ## Usage
 
 Let's create a simple Movie model to load and save our favorite movies. Add the file `models/movie.rb`:
@@ -92,7 +98,40 @@ $ bin/bridgetown console
 }
 ```
 
-You're ready to roll to take full advantage of ActiveRecord database models in your Bridgetown site!
+You're ready to roll to take full advantage of Active Record database models in your Bridgetown site!
+
+## Changing the Models Directory
+
+If you'd prefer to set up your models folder elsewhere other than `./models`, you can move the files to another path and then update your Rakefile to pass in that path. For example, you could use the more familiar `app/models`:
+
+```ruby
+require "bridgetown-activerecord"
+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
 

data/bridgetown.automation.rb

@@ -1,5 +1,5 @@
-add_bridgetown_plugin "bridgetown-activerecord"
-run "bundle add annotate -g development", abort_on_failure: false
+add_gem "bridgetown-activerecord"
+add_gem "annotate", group: :development
 
 # TODO:
 #dboptions = ["postgresql", "mysql", "vanilla"]
@@ -50,21 +50,20 @@ create_file ".standalone_migrations" do
   YML
 end
 
-append_to_file "bridgetown.config.yml" do
-  <<~YML
+insert_into_file "Rakefile", "require \"bridgetown-activerecord\"\nBridgetownActiveRecord.load_tasks\n", :after => "Bridgetown.load_tasks\n"
 
-    autoload_paths:
-      - path: models
-        eager: true
+ruby_configure "Support for autoloading models" do
+  <<~RUBY
+    config.autoload_paths << {
+      path: "models",
+      eager: true
+    }
 
-    autoloader_collapsed_paths:
-      - models/concerns
-  YML
+    config.autoloader_collapsed_paths << "models/concerns"
+  RUBY
 end
 
-insert_into_file "Rakefile", "require \"bridgetown-activerecord\"\nBridgetownActiveRecord.load_tasks\n", :after => "Bridgetown.load_tasks\n"
-
-# TODO: add to initializer !!!
+add_initializer :"bridgetown-activerecord"
 
 say_status :active_record, "The plugin has been configured. For usage help visit:"
 say_status :active_record, "https://github.com/bridgetownrb/bridgetown-activerecord/blob/main/README.md"

data/lib/bridgetown-activerecord/initializer.rb

@@ -6,7 +6,8 @@ require "active_record"
 require "active_support/configuration_file"
 
 module BridgetownActiveRecord
-  def self.load_tasks
+  def self.load_tasks(models_dir: "models")
+    ENV["BRIDGETOWN_ACTIVERECORD_MODELS_DIR"] ||= models_dir
     load File.expand_path("../tasks/database.rake", __dir__)
   end
 
@@ -19,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.0.0"
+  VERSION = "2.2.0"
 end

data/lib/tasks/database.rake

@@ -5,12 +5,12 @@ ENV["SCHEMA"] = File.join(Dir.pwd, "db", "schema.rb")
 require "standalone_migrations"
 StandaloneMigrations::Tasks.load_tasks
 
-require "./models/application_record"
+require "./#{ENV.fetch("BRIDGETOWN_ACTIVERECORD_MODELS_DIR", "models")}/application_record"
 
 # Setup Annotate so it runs on db:migrate, etc.
 if Bridgetown.environment.development?
   require "annotate"
-  ENV["model_dir"] = "models"
+  ENV["model_dir"] = ENV.fetch("BRIDGETOWN_ACTIVERECORD_MODELS_DIR", "models")
   Annotate::Helpers.class_eval do
     # We need to redefine this because our custom model_dir shortcircuits the migration task enhancement
     def self.include_models?

metadata

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