test against rails

Author: jethrodaniel

.github/workflows/ruby.yml

@@ -27,5 +27,8 @@ jobs:
     - name: Lint
       run: bundle exec rake rubocop
 
-    - name: Build and test
-      run: bundle exec rake test
+    - name: Build
+      run: bundle exec rake
+
+    - name: Test
+      run: bundle exec rspec

Gemfile.lock

@@ -7,26 +7,172 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+    actionmailer (8.0.2)
+      actionpack (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activesupport (= 8.0.2)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (8.0.2)
+      actionview (= 8.0.2)
+      activesupport (= 8.0.2)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actiontext (8.0.2)
+      actionpack (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (8.0.2)
+      activesupport (= 8.0.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (8.0.2)
+      activesupport (= 8.0.2)
+      globalid (>= 0.3.6)
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activerecord (8.0.2)
+      activemodel (= 8.0.2)
+      activesupport (= 8.0.2)
+      timeout (>= 0.4.0)
+    activestorage (8.0.2)
+      actionpack (= 8.0.2)
+      activejob (= 8.0.2)
+      activerecord (= 8.0.2)
+      activesupport (= 8.0.2)
+      marcel (~> 1.0)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ast (2.4.2)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    crass (1.0.6)
+    date (3.4.1)
     debug (1.9.2)
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.6.0)
+    drb (2.2.1)
+    erubi (1.13.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
     io-console (0.7.2)
     irb (1.14.1)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
+    logger (1.6.6)
+    loofah (2.24.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    mini_mime (1.1.5)
     mini_portile2 (2.8.8)
+    minitest (5.25.5)
+    net-imap (0.5.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.5-x86_64-linux-gnu)
+      racc (~> 1.4)
     parallel (1.26.3)
     parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
     racc (1.8.1)
+    rack (3.1.12)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (8.0.2)
+      actioncable (= 8.0.2)
+      actionmailbox (= 8.0.2)
+      actionmailer (= 8.0.2)
+      actionpack (= 8.0.2)
+      actiontext (= 8.0.2)
+      actionview (= 8.0.2)
+      activejob (= 8.0.2)
+      activemodel (= 8.0.2)
+      activerecord (= 8.0.2)
+      activestorage (= 8.0.2)
+      activesupport (= 8.0.2)
+      bundler (>= 1.15.0)
+      railties (= 8.0.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.2)
+      actionpack (= 8.0.2)
+      activesupport (= 8.0.2)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
     rake-compiler (1.2.8)
@@ -69,6 +215,7 @@ GEM
     rubocop-rspec (3.4.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
     sqlite3 (2.4.0)
       mini_portile2 (~> 2.8.0)
     standard (1.35.0.1)
@@ -84,13 +231,25 @@ GEM
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.23.0)
     stringio (3.1.1)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.6.0)
+    uri (1.0.3)
+    useragent (0.16.11)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.7.2)
 
 PLATFORMS
   x86_64-linux-gnu
 
 DEPENDENCIES
   debug (>= 1.0.0)
+  rails (= 8.0.2)
   rake
   rake-compiler
   rspec

Rakefile

@@ -7,9 +7,13 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |c|
+  # loading rails in this file breaks `rake`
+  c.exclude_pattern = "spec/sqlite_extensions/rails_spec.rb"
+end
 
 Rake::ExtensionTask.new("sqlite_extensions/uuid") do |ext|
+  ext.gem_spec = Gem::Specification.load("sqlite_extensions-uuid.gemspec")
   ext.name = "uuid"
   ext.lib_dir = "lib/sqlite_extensions/uuid"
 end

config/database.yml

@@ -0,0 +1,5 @@
+production:
+  database: ':memory:'
+  adapter: sqlite3
+  extensions:
+    - <%= SqliteExtensions::UUID.to_path %>

spec/spec_helper.rb

@@ -8,3 +8,7 @@
 end
 
 require "sqlite_extensions-uuid"
+require "debug"
+
+# good enough for testing
+UUID_REGEX = /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/i

spec/sqlite_extensions/rails_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# not required by our gem, but needed for these tests
+require "sqlite3"
+require "active_record/railtie"
+require "minitest/autorun"
+
+# Adapted from https://github.com/rails/rails/blob/v8.0.2/guides/bug_report_templates/active_record_migrations.rb
+#
+RSpec.describe "Rails usage" do # rubocop:disable RSpec/DescribeClass
+  before do
+    gemspec = instance_double(
+      Gem::Specification,
+      require_path: File.join(__dir__, "../../lib")
+    )
+    allow(Gem).to receive(:loaded_specs).and_return("sqlite_extensions-uuid" => gemspec)
+
+    ENV["RAILS_ENV"] = "production"
+
+    # config/application.rb
+    stub_const("TestApp", Class.new(Rails::Application) do
+      config.load_defaults Rails::VERSION::STRING.to_f
+      config.eager_load = false
+      config.secret_key_base = "secret_key_base"
+    end)
+    Rails.application.initialize!
+
+    # db/migrate/yyyymmddhhmmss_create_users.rb
+    stub_const("CreateUsers", Class.new(ActiveRecord::Migration[8.0]) do
+      def change
+        create_table :users, id: :string, default: -> { "uuid()" }, limit: 36 do |t|
+          t.string :email_address, null: false
+          t.timestamps
+        end
+        add_index :users, :email_address, unique: true
+      end
+    end)
+
+    # app/models/user.rb
+    stub_const("User", Class.new(ActiveRecord::Base))
+  end
+
+  it "allows Rails to support UUIDs for SQLite" do
+    log_file = StringIO.new
+
+    # TODO: prevent Rails from logging to stdout entirely
+    allow(Rails.logger).to receive(:debug).and_wrap_original do |m, msg|
+      log_file.write msg
+    end
+
+    CreateUsers.migrate(:up)
+
+    log_file.rewind
+    output = log_file.read
+
+    expect(output).to include('CREATE TABLE "users"')
+    expect(output).to include("varchar(36) DEFAULT (uuid())")
+
+    id_column = User.columns.find { |column| column.name == "id" }
+    expect(id_column.sql_type).to eq "varchar(36)"
+
+    user = User.create!(email_address: "[email protected]")
+    expect(user.id).to match(UUID_REGEX)
+  end
+end

spec/sqlite_extensions/sqlite_spec.rb

@@ -12,19 +12,14 @@
     allow(Gem).to receive(:loaded_specs).and_return("sqlite_extensions-uuid" => gemspec)
   end
 
-  # good enough for testing
-  let(:uuid_regex) do
-    /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/i
-  end
-
   it "works when passed as an extension to SQLite3::Database.new" do
     db = SQLite3::Database.new(":memory:", extensions: [SqliteExtensions::UUID.to_path])
 
     result = db.execute("select uuid()")
 
     expect(result).to match([[an_instance_of(String)]])
     uuid = result.first.first
-    expect(uuid).to match(uuid_regex)
+    expect(uuid).to match(UUID_REGEX)
   end
 
   it "works when using `enable_load_extension`" do
@@ -36,6 +31,6 @@
 
     expect(result).to match([[an_instance_of(String)]])
     uuid = result.first.first
-    expect(uuid).to match(uuid_regex)
+    expect(uuid).to match(UUID_REGEX)
   end
 end

sqlite_extensions-uuid.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop-rake"
   spec.add_development_dependency "rubocop-rspec"
   spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rails", "8.0.2"
 end