bridgetown-activerecord 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86121e3d1de53dc4a6cb5af343f14532e57052ccd3fc2e86c8e87996d6325a72
-  data.tar.gz: a95b95bd75f2832c103f1595b4f4faaa54fd4b0dbad3a751c87026dbb0091027
+  metadata.gz: ccfd8d0b6032758ade7b72ece8ff373552c3257d84a35cab4a34e98c88789fb3
+  data.tar.gz: 244806f70399573021e39162d2aca78e634a8e41279c3e23c85cf42f8d1fa176
 SHA512:
-  metadata.gz: 6c60311f9a4b459010156dd772f4b7515ddb9ce91aa10168faddd31cb349950918c86df428e1db694531dba263b6263ec1e69bc12aa7aae14fe450268f5ca97e
-  data.tar.gz: 95f8564b8a9f4fc36a0a85bd75d7f57d59e66de6a951a1c9f0bb3c5f5f549e186e66397b5c0aa50f00753b706ab195973268de0bc459e230e26f9e4bd818c816
+  metadata.gz: db2527fb6c3ca7da3f67678bbb75d845a01d310ab762ec05661b688650a19b203c400bbfd8de4c1c86f2fdbd143e8383cda37142a751904c27368ea04612a17b
+  data.tar.gz: fea781ad77051b5018687ba9199a40839bbfc00926810170942309cdb0c5ec5e772589214d31b04731778d57aa25e8430e9518b51c2f3766b05de652c7b78af6

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,5 +1,7 @@
 # Bridgetown ActiveRecord plugin
 
+**NOTE:** currently waiting on a bugfix in Bridgetown itself before getting the green light…coming very soon!
+
 ## Installation
 
 It's recommended you run our automation script to set up your project to support ActiveRecord and DB models:
@@ -24,7 +26,73 @@ $ bundle add pg
 
 ## 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 ActiveRecord database models in your Bridgetown site!
 
 ## 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

@@ -62,7 +62,9 @@ append_to_file "bridgetown.config.yml" do
   YML
 end
 
-insert_into_file "Rakefile", "BridgetownActiveRecord.load_tasks\n", :after => "Bridgetown.load_tasks\n"
+insert_into_file "Rakefile", "require \"bridgetown-activerecord\"\nBridgetownActiveRecord.load_tasks\n", :after => "Bridgetown.load_tasks\n"
+
+# TODO: add to initializer !!!
 
 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,27 @@
+# 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
+
+  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.0.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
 
-# 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
+
+# Setup Annotate so it runs on db:migrate, etc.
+if Bridgetown.environment.development?
+  require "annotate"
+  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
+    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.0.0
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-10 00:00:00.000000000 Z
+date: 2022-10-09 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