bridgetown-activerecord 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86121e3d1de53dc4a6cb5af343f14532e57052ccd3fc2e86c8e87996d6325a72
-  data.tar.gz: a95b95bd75f2832c103f1595b4f4faaa54fd4b0dbad3a751c87026dbb0091027
+  metadata.gz: ef8ced2ced4ceb5c4945477bb4ff888effd806d532b923f08524963210f211dd
+  data.tar.gz: 9945be6d6dc6c7d11089ae5d227102d23f5f61c92d10d2891fbb45da12a6b4ed
 SHA512:
-  metadata.gz: 6c60311f9a4b459010156dd772f4b7515ddb9ce91aa10168faddd31cb349950918c86df428e1db694531dba263b6263ec1e69bc12aa7aae14fe450268f5ca97e
-  data.tar.gz: 95f8564b8a9f4fc36a0a85bd75d7f57d59e66de6a951a1c9f0bb3c5f5f549e186e66397b5c0aa50f00753b706ab195973268de0bc459e230e26f9e4bd818c816
+  metadata.gz: 55d827960c968db59a1477dc39945c54c6f6f55a9d040da866f30295e9902563b64325fb29eae2a3e69a656fa5913534a75daaebff11daf69f91445b2a07afd0
+  data.tar.gz: 072241e0d27f71b085c5a9f54cfeae05c7a0ef34f4ad4e0bc74207579dbd6deb343cbded7edea844eeedc8901bd57032b60dae11dd7eaff1364edf2435ae48f1

data/CHANGELOG.md

@@ -7,8 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-- ...
+## [2.0.0] - 2022-10-08
 
-## 0.1.0 - YYYY-MM-DD
+- Upgrade to initializers system in Bridgetown 1.2
+
+## 1.0.0 - 2022-04-11
 
 - First version

data/README.md

@@ -1,8 +1,12 @@
-# Bridgetown ActiveRecord plugin
+# 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!
 
 ## 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
@@ -11,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).
@@ -22,9 +26,88 @@ 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
 
-TBC
+Let's create a simple Movie model to load and save our favorite movies. Add the file `models/movie.rb`:
+
+```rb
+class Movie < ApplicationRecord
+  validates :title, presence: true, uniqueness: { case_insensitive: true }
+
+  def uppercase_title
+    title.upcase
+  end
+end
+```
+
+Then add a new migration for the Movie model.
+
+```sh
+$ bin/bridgetown db:new_migration name=create_movies
+```
+
+That will create a new migration file in `db/migrate`. Edit the file so it looks like this:
+
+```ruby
+class CreateMovies < ActiveRecord::Migration[7.0]
+  def change
+    create_table :movies do |t|
+      t.string :title, null: false
+      t.string :director
+      t.integer :year
+
+      t.timestamps
+    end
+  end
+end
+```
+
+Awesome, now let's create the database and run the migration!
+
+```sh
+$ bin/bridgetown db:create
+$ bin/bridgetown db:migrate
+```
+
+If all goes well, the database should be created, the migration run, a new `db/schema.rb` saved, and schema annotations added to the top of `models/movie.rb`!
+
+Let's try it out in the Bridgetown console.
+
+```sh
+$ bin/bridgetown console
+```
+
+```ruby
+> Movie.count
+0
+> Movie.create(title: "Free Guy", director: "Shawn Levy", year: "2021") 
+> Movie.count
+1
+> Movie.last
+#<Movie:0x0000000109e26378> {
+          :id => 1,
+       :title => "Free Guy",
+    :director => "Shawn Levy",
+        :year => 2021,
+  :created_at => 2022-03-12 23:24:28.98137 UTC,
+  :updated_at => 2022-03-12 23:24:28.98137 UTC
+}
+```
+
+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-activerecord.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.7.0"
 
-  spec.add_dependency "bridgetown", ">= 1.0", "< 2.0"
+  spec.add_dependency "bridgetown", ">= 1.2.0.beta2", "< 2.0"
   spec.add_dependency "activerecord", "~> 7.0"
   spec.add_dependency "standalone_migrations", "~> 7.0"
 

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,19 +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", "BridgetownActiveRecord.load_tasks\n", :after => "Bridgetown.load_tasks\n"
+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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+ENV["RAILS_ENV"] = Bridgetown.environment
+
+require "active_record"
+require "active_support/configuration_file"
+
+module BridgetownActiveRecord
+  def self.load_tasks(models_dir: "models")
+    ENV["BRIDGETOWN_ACTIVERECORD_MODELS_DIR"] ||= models_dir
+    load File.expand_path("../tasks/database.rake", __dir__)
+  end
+
+  def self.db_configuration(config)
+    ActiveSupport::ConfigurationFile.parse(File.join(config.root_dir, "config", "database.yml"))
+  end
+
+  def self.log_writer
+    Bridgetown::LogWriter.new.tap(&:enable_prefix)
+  end
+end
+
+Bridgetown.initializer :"bridgetown-activerecord" do |config|
+  ActiveRecord::Base.establish_connection(
+    BridgetownActiveRecord.db_configuration(config)[Bridgetown.environment]
+  )
+  ActiveRecord::Base.logger = BridgetownActiveRecord.log_writer
+end

data/lib/bridgetown-activerecord/version.rb

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

data/lib/bridgetown-activerecord.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 require "bridgetown"
-require "bridgetown-activerecord/builder"
+require "bridgetown-activerecord/initializer"

data/lib/tasks/database.rake

@@ -5,14 +5,17 @@ ENV["SCHEMA"] = File.join(Dir.pwd, "db", "schema.rb")
 require "standalone_migrations"
 StandaloneMigrations::Tasks.load_tasks
 
+require "./#{ENV.fetch("BRIDGETOWN_ACTIVERECORD_MODELS_DIR", "models")}/application_record"
+
 # Setup Annotate so it runs on db:migrate, etc.
-require "annotate"
-require "./models/application_record"
-ENV["model_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?
-    true
+if Bridgetown.environment.development?
+  require "annotate"
+  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?
+      true
+    end
   end
+  Annotate.load_tasks
 end
-Annotate.load_tasks

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-10 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.2.0.beta2
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.2.0.beta2
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -116,7 +116,7 @@ files:
 - bridgetown-activerecord.gemspec
 - bridgetown.automation.rb
 - lib/bridgetown-activerecord.rb
-- lib/bridgetown-activerecord/builder.rb
+- lib/bridgetown-activerecord/initializer.rb
 - lib/bridgetown-activerecord/version.rb
 - lib/tasks/database.rake
 homepage: https://github.com/bridgetownrb/bridgetown-activerecord

data/lib/bridgetown-activerecord/builder.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-ENV["RAILS_ENV"] = Bridgetown.environment
-
-require "active_record"
-require "active_support/configuration_file"
-
-module BridgetownActiveRecord
-  def self.load_tasks
-    load File.expand_path("../tasks/database.rake", __dir__)
-  end
-
-  class Builder < Bridgetown::Builder
-    def self.db_configuration(site)
-      ActiveSupport::ConfigurationFile.parse(site.in_root_dir("config", "database.yml"))
-    end
-
-    def self.log_writer
-      Bridgetown::LogWriter.new.tap(&:enable_prefix)
-    end
-
-    Bridgetown::Hooks.register_one :site, :after_init, reloadable: false do |site|
-      ActiveRecord::Base.establish_connection db_configuration(site)[Bridgetown.environment]
-      ActiveRecord::Base.logger = log_writer
-    end
-
-    # no-op
-    def build; end
-  end
-end
-
-BridgetownActiveRecord::Builder.register