bridgetown-activerecord 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccfd8d0b6032758ade7b72ece8ff373552c3257d84a35cab4a34e98c88789fb3
-  data.tar.gz: 244806f70399573021e39162d2aca78e634a8e41279c3e23c85cf42f8d1fa176
+  metadata.gz: ef8ced2ced4ceb5c4945477bb4ff888effd806d532b923f08524963210f211dd
+  data.tar.gz: 9945be6d6dc6c7d11089ae5d227102d23f5f61c92d10d2891fbb45da12a6b4ed
 SHA512:
-  metadata.gz: db2527fb6c3ca7da3f67678bbb75d845a01d310ab762ec05661b688650a19b203c400bbfd8de4c1c86f2fdbd143e8383cda37142a751904c27368ea04612a17b
-  data.tar.gz: fea781ad77051b5018687ba9199a40839bbfc00926810170942309cdb0c5ec5e772589214d31b04731778d57aa25e8430e9518b51c2f3766b05de652c7b78af6
+  metadata.gz: 55d827960c968db59a1477dc39945c54c6f6f55a9d040da866f30295e9902563b64325fb29eae2a3e69a656fa5913534a75daaebff11daf69f91445b2a07afd0
+  data.tar.gz: 072241e0d27f71b085c5a9f54cfeae05c7a0ef34f4ad4e0bc74207579dbd6deb343cbded7edea844eeedc8901bd57032b60dae11dd7eaff1364edf2435ae48f1

data/README.md

@@ -1,10 +1,12 @@
-# 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 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!
 
 ## 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 +15,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 +26,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 +96,18 @@ $ 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.)
 
 ## 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
 

data/lib/bridgetown-activerecord/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownActiveRecord
-  VERSION = "2.0.0"
+  VERSION = "2.1.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.1.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-09 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown