bridgetown-activerecord 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86121e3d1de53dc4a6cb5af343f14532e57052ccd3fc2e86c8e87996d6325a72
+  data.tar.gz: a95b95bd75f2832c103f1595b4f4faaa54fd4b0dbad3a751c87026dbb0091027
+SHA512:
+  metadata.gz: 6c60311f9a4b459010156dd772f4b7515ddb9ce91aa10168faddd31cb349950918c86df428e1db694531dba263b6263ec1e69bc12aa7aae14fe450268f5ca97e
+  data.tar.gz: 95f8564b8a9f4fc36a0a85bd75d7f57d59e66de6a951a1c9f0bb3c5f5f549e186e66397b5c0aa50f00753b706ab195973268de0bc459e230e26f9e4bd818c816

data/.gitignore

@@ -0,0 +1,38 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+test/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+    - "*.gemspec"
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+    - Rakefile
+    - bridgetown.automation.rb
+    - lib/tasks/database.rake
+
+    - script/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+- ...
+
+## 0.1.0 - YYYY-MM-DD
+
+- First version

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+group :test do
+  gem "minitest"
+  gem "minitest-reporters"
+  gem "shoulda"
+end
+
+gem "pg", "~> 1.3", group: :test

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present Jared White and Bridgetown Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Bridgetown ActiveRecord plugin
+
+## Installation
+
+It's recommended you run our automation script to set up your project to support ActiveRecord and DB models:
+
+```shell
+$ bin/bridgetown apply https://github.com/bridgetownrb/bridgetown-activerecord
+```
+
+Or for a fully manual setup:
+
+```shell
+$ bundle add bridgetown-activerecord -g bridgetown_plugins
+```
+
+then replicate the individual steps outlined in the [automation script](https://github.com/bridgetownrb/bridgetown-activerecord/blob/main/bridgetown.automation.rb).
+
+You will need to decide on your database adapter of choice. For a typical PostgreSQL configuration, add the `pg` gem.
+
+```shell
+$ bundle add pg
+```
+
+## Usage
+
+TBC
+
+## Testing
+
+* Run `bundle exec rake test` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and Minitest together.
+
+## Contributing
+
+1. Fork it (https://github.com/bridgetownrb/bridgetown-activerecord/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/bridgetown-activerecord.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-activerecord/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-activerecord"
+  spec.version       = BridgetownActiveRecord::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "Plugin to add ActiveRecord support to Bridgetown sites"
+  spec.homepage      = "https://github.com/bridgetownrb/bridgetown-activerecord"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency "bridgetown", ">= 1.0", "< 2.0"
+  spec.add_dependency "activerecord", "~> 7.0"
+  spec.add_dependency "standalone_migrations", "~> 7.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
+end

data/bridgetown.automation.rb

@@ -0,0 +1,71 @@
+add_bridgetown_plugin "bridgetown-activerecord"
+run "bundle add annotate -g development", abort_on_failure: false
+
+# TODO:
+#dboptions = ["postgresql", "mysql", "vanilla"]
+#dbadapter = ask("Which adapter should be used for your database?", limited_to: dboptions)
+
+dbadapter = "postgresql"
+dbprefix = ask("What identifier should be used for your database prefix?", default: "bt_demo")
+
+# TODO: use Rails DB templates
+#rails_db_tmpl_url = "https://github.com/rails/rails/blob/7-0-stable/railties/lib/rails/generators/rails/app/templates/config/databases/"
+
+create_file "config/database.yml" do
+  <<~YML
+    default: &default
+      adapter: #{dbadapter}
+      encoding: unicode
+      pool: 5
+
+    development:
+      <<: *default
+      database: #{dbprefix}_development
+
+    test: &test
+      <<: *default
+      database: #{dbprefix}_test
+
+    production:
+      <<: *default
+      url: <%= ENV['DATABASE_URL'] %>
+      database: #{dbprefix}_production
+  YML
+end
+
+create_file "models/application_record.rb" do
+  <<~RUBY
+    require "active_record"
+
+    class ApplicationRecord < ActiveRecord::Base
+      primary_abstract_class
+    end
+  RUBY
+end
+
+create_file ".standalone_migrations" do
+  <<~YML
+    config:
+      database: config/database.yml
+  YML
+end
+
+append_to_file "bridgetown.config.yml" do
+  <<~YML
+
+    autoload_paths:
+      - path: models
+        eager: true
+
+    autoloader_collapsed_paths:
+      - models/concerns
+  YML
+end
+
+insert_into_file "Rakefile", "BridgetownActiveRecord.load_tasks\n", :after => "Bridgetown.load_tasks\n"
+
+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"
+
+say_status :active_record, "Don't forget to add a specific database adapter to your Gemfile! For example:"
+say_status :active_record, "$ bundle add pg".bold

data/lib/bridgetown-activerecord/builder.rb

@@ -0,0 +1,32 @@
+# 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

data/lib/bridgetown-activerecord/version.rb

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

data/lib/bridgetown-activerecord.rb

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

data/lib/tasks/database.rake

@@ -0,0 +1,18 @@
+# Setup ActiveRecord tasks like db:migrate, etc.
+# Also see .standalone_migrations config file in project root
+ENV["RAILS_ENV"] = Bridgetown.environment
+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
+  end
+end
+Annotate.load_tasks

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-activerecord
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: standalone_migrations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description:
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown-activerecord.gemspec
+- bridgetown.automation.rb
+- lib/bridgetown-activerecord.rb
+- lib/bridgetown-activerecord/builder.rb
+- lib/bridgetown-activerecord/version.rb
+- lib/tasks/database.rake
+homepage: https://github.com/bridgetownrb/bridgetown-activerecord
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Plugin to add ActiveRecord support to Bridgetown sites
+test_files: []