otr-activerecord 2.2.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 813027ace691548c8f6c14dc025a3fbd2d55fbef0d5d3bbb54882292d4c96ea7
-  data.tar.gz: 50e233490ac4b9eec80546280d9761d8d771cf70dc43e92d06aabe2a5ab5db79
+  metadata.gz: b0bc6ffa0d49d91364fb651969e0806f1fdedb42d2c4d00cc47e47af4e41bb33
+  data.tar.gz: 9ecc2f541f28771bee096d3ebde083cdbb7274132e2ccb764d13df32da570f83
 SHA512:
-  metadata.gz: 7947804eaa585a81abb55783b89448026c76ae83b2c199d7680cb6116232b1fe79816c6cafc504b85bc4fecc5972cbd7c29f7c993d3f050273f3858155410434
-  data.tar.gz: 6dc69872eab940e8bc0b0bd3ecd918d1a4a3c3da58350c98b0a4cdfc9f6f72fa75ce8ad3144b1c929618c7b603cc1bca297d022f88c212efc5e1fd478ea1a618
+  metadata.gz: 36c0b8a6088067f5f816779277d857af8fce627da9c0141339c38589dde36ccaf75e2271fd227726cb493bd4a42dcf9b7120d92377c395570bfa0e05589c4d58
+  data.tar.gz: 4e1723531212fd09ab669a29a69cdaa6d3041574db13837d6962743ccb30d66cd14786f22635df9d1db8721da55056270983c652896232c6394a72486ec57ad9

data/README.md

@@ -2,24 +2,29 @@
 
 An easy way to use ActiveRecord "off the rails." Works with Grape, Sinatra, plain old Rack, or even in a boring little script! The defaults are all very Railsy (`config/database.yml`, `db/seeds.rb`, `db/migrate`, etc.), but you can easily change them. (Formerly known as `grape-activerecord`.) Supports:
 
+* ActiveRecord 7.2
+* ActiveRecord 7.1
 * ActiveRecord 7.0 (new AR features, like encryption, not tested)
-* ActiveRecord 6.x
-* ActiveRecord 5.x
-* ActiveRecord 4.2
+* ActiveRecord 6.1
+* See older versions of this library for older versions of ActiveRecord
 
 ## How to use
 
 #### 1. Add it to your Gemfile
 
-    gem "otr-activerecord"
+```ruby
+gem "otr-activerecord"
+```
 
 #### 2. Configure your database connection
 
-After loading your gems, tell `OTR::ActiveRecord` about your database config using one of the following examples:
+After loading your gems, tell `OTR::ActiveRecord` about your database config using *one* of the following examples:
 
-    OTR::ActiveRecord.configure_from_file! "config/database.yml"
-    OTR::ActiveRecord.configure_from_url! ENV['DATABASE_URL'] # e.g. postgres://user:pass@host/db
-    OTR::ActiveRecord.configure_from_hash!(adapter: "postgresql", host: "localhost", database: "db", username: "user", password: "pass", encoding: "utf8", pool: 10, timeout: 5000)
+```ruby
+OTR::ActiveRecord.configure_from_file! "config/database.yml"
+OTR::ActiveRecord.configure_from_url! ENV['DATABASE_URL'] # e.g. postgres://user:pass@host/db
+OTR::ActiveRecord.configure_from_hash!(adapter: "postgresql", host: "localhost", database: "db", username: "user", password: "pass", encoding: "utf8", pool: 10, timeout: 5000)
+```
 
 **Important note**: `configure_from_file!` won't work as expected if you have already `DATABASE_URL` set as part of your environment variables.
 This is because in ActiveRecord when that env variable is set it will merge its properties into the current connection configuration.
@@ -28,57 +33,91 @@ This is because in ActiveRecord when that env variable is set it will merge its
 
 If you have a single database (most apps), use this helper:
 
-    OTR::ActiveRecord.establish_connection!
+```ruby
+OTR::ActiveRecord.establish_connection!
+```
 
 If you're using multiple databases, call your base class(es) instead:
 
-    MyBase.establish_connection :primary
-    MyBase.establish_connection :primary_replica
-    ...
+```ruby
+MyBase.establish_connection :primary
+MyBase.establish_connection :primary_replica
+...
+```
 
 #### 4. Enable middleware for Rack apps
 
 Add these middlewares in `config.ru`:
 
-    # Clean up database connections after every request (required)
-    use OTR::ActiveRecord::ConnectionManagement
+```ruby
+# Clean up database connections after every request (required)
+use OTR::ActiveRecord::ConnectionManagement
 
-    # Enable ActiveRecord's QueryCache for every request (optional)
-    use OTR::ActiveRecord::QueryCache
+# Enable ActiveRecord's QueryCache for every request (optional)
+use OTR::ActiveRecord::QueryCache
+```
 
 #### 5. Import ActiveRecord tasks into your Rakefile
 
 This will give you most of the standard `db:` tasks you get in Rails. Add it to your `Rakefile`.
 
-    require "bundler/setup"
-    load "tasks/otr-activerecord.rake"
+```ruby
+require "bundler/setup"
+load "tasks/otr-activerecord.rake"
 
-    namespace :db do
-      # Some db tasks require your app code to be loaded; they'll expect to find it here
-      task :environment do
-        require_relative "app"
-      end
-    end
+namespace :db do
+  # Some db tasks require your app code to be loaded; they'll expect to find it here
+  task :environment do
+    require_relative "app"
+  end
+end
+```
 
 Unlike in Rails, creating a new migration is also a rake task. Run `bundle exec rake -T` to get a full list of tasks.
 
-    bundle exec rake db:create_migration[create_widgets]
-
-## Examples
-
-Look under [/examples](https://github.com/jhollinger/otr-activerecord/tree/master/examples) for some example apps.
+```bash
+bundle exec rake db:create_migration[create_widgets]
+```
 
 ## Advanced options
 
 The defaults for db-related files like migrations, seeds, and fixtures are the same as Rails. If you want to override them, use the following options in your `Rakefile`:
 
-    OTR::ActiveRecord.db_dir = 'db'
-    OTR::ActiveRecord.migrations_paths = ['db/migrate']
-    OTR::ActiveRecord.fixtures_path = 'test/fixtures'
-    OTR::ActiveRecord.seed_file = 'seeds.rb'
+```ruby
+OTR::ActiveRecord.db_dir = 'db'
+OTR::ActiveRecord.migrations_paths = ['db/migrate']
+OTR::ActiveRecord.fixtures_path = 'test/fixtures'
+OTR::ActiveRecord.seed_file = 'seeds.rb'
+```
+
+## Testing
+
+Testing is fully scripted under the `bin/` directory. Appraisal is used to test against various ActiveRecord versions, and Docker or Podman is used to test against various Ruby versions. The combinations to test are defined in [test/matrix](https://github.com/jhollinger/otr-activerecord/blob/main/test/matrix).
+
+```bash
+# Run all tests
+bin/testall
+
+# Filter tests
+bin/testall ruby-3.3
+bin/testall ar-7.1
+bin/testall ruby-3.3 ar-7.1
+
+# Run one specific line from test/matrix
+bin/test ruby-3.3 ar-7.1 sqlite3
+
+# Run a specific file
+bin/test ruby-3.3 ar-7.1 sqlite3 test/configure_test.rb
+
+# Run a specific test
+bin/test ruby-3.3 ar-7.1 sqlite3 N=test_configure_from_file
+
+# Use podman
+PODMAN=1 bin/testall
+```
 
 ## License
 
 Licensed under the MIT License
 
-Copyright 2016 Jordan Hollinger
+Copyright 2024 Jordan Hollinger

data/lib/otr-activerecord/activerecord.rb

@@ -1,13 +1,19 @@
 require 'erb'
+require 'uri'
+require 'yaml'
 
 # "Off the Rails" ActiveRecord configuration/integration for Grape, Sinatra, Rack, and any other kind of app
 module OTR
   # ActiveRecord configuration module
   module ActiveRecord
-    autoload :Compatibility4, 'otr-activerecord/compatibility_4'
-    autoload :Compatibility5, 'otr-activerecord/compatibility_5'
-    autoload :Compatibility6, 'otr-activerecord/compatibility_6'
-    autoload :Compatibility7, 'otr-activerecord/compatibility_7'
+    autoload :ConnectionManagement, 'otr-activerecord/middleware/connection_management'
+    autoload :QueryCache, 'otr-activerecord/middleware/query_cache'
+    autoload :Shim,
+      case ::ActiveRecord::VERSION::MAJOR
+      when 6 then 'otr-activerecord/shim/v6'
+      when 7 then 'otr-activerecord/shim/v7'
+      else raise "Unsupported ActiveRecord version"
+      end
 
     class << self
       # Relative path to the "db" dir
@@ -19,19 +25,17 @@ module OTR
       # Name of the seeds file in db_dir
       attr_accessor :seed_file
       # Internal compatibility layer across different major versions of AR
-      attr_accessor :_normalizer
+      attr_accessor :shim
     end
 
     # Connect to database with a Hash. Example:
     # {adapter: 'postgresql', host: 'localhost', database: 'db', username: 'user', password: 'pass', encoding: 'utf8', pool: 10, timeout: 5000}
     def self.configure_from_hash!(spec)
-      config = spec.stringify_keys.merge("migrations_paths" => ::OTR::ActiveRecord.migrations_paths)
-      ::ActiveRecord::Base.configurations = {rack_env.to_s => config}
+      ::ActiveRecord::Base.configurations = transform_config({rack_env.to_s => spec})
     end
 
     # Connect to database with a DB URL. Example: "postgres://user:pass@localhost/db"
     def self.configure_from_url!(url)
-      require 'uri'
       uri = URI(url)
       spec = {"adapter" => uri.scheme}
 
@@ -57,17 +61,9 @@ module OTR
 
     # Connect to database with a yml file. Example: "config/database.yml"
     def self.configure_from_file!(path)
-      raise "#{path} does not exist!" unless File.file? path
-        result = load_yaml(path)
-        ::ActiveRecord::Base.configurations = begin
-        result.each do |_env, config|
-          if config.all? { |_, v| v.is_a?(Hash) }
-            config.each { |_, v| append_migration_path(v) }
-          else
-            append_migration_path(config)
-          end
-        end
-      end
+      yaml = ERB.new(File.read(path)).result
+      spec = YAML.safe_load(yaml, aliases: true) || {}
+      ::ActiveRecord::Base.configurations = transform_config spec
     end
 
     # Establish a connection to the given db (defaults to current rack env)
@@ -75,29 +71,26 @@ module OTR
       ::ActiveRecord::Base.establish_connection(db)
     end
 
-    def self.append_migration_path(config)
-      config['migrations_paths'] = ::OTR::ActiveRecord.migrations_paths unless config.key?('migrations_paths')
-      config
-    end
-
     # The current Rack environment
     def self.rack_env
       (ENV['RACK_ENV'] || ENV['RAILS_ENV'] || ENV['APP_ENV'] || ENV['OTR_ENV'] || 'development').to_sym
     end
 
-    # Support old Psych versions
-    def self.load_yaml(path)
-      erb_result = ERB.new(File.read(path)).result
-
-      result = if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.1.0.pre1')
-        YAML.safe_load(erb_result, aliases: true)
-      else
-        YAML.safe_load(erb_result, [], [], true)
-      end
-
-      result || {}
+    def self.transform_config(spec)
+      fixup = ->(config) {
+        config = config.stringify_keys
+        config["migrations_paths"] ||= migrations_paths
+        config
+      }
+      spec.stringify_keys.transform_values { |config|
+        if config.all? { |_, v| v.is_a? Hash }
+          config.transform_values { |v| fixup.(v) }
+        else
+          fixup.(config)
+        end
+      }
     end
 
-    private_class_method :load_yaml
+    private_class_method :transform_config
   end
 end

data/lib/otr-activerecord/middleware/connection_management.rb

@@ -13,13 +13,13 @@ module OTR
 
         resp = @app.call env
         resp[2] = ::Rack::BodyProxy.new resp[2] do
-          ::ActiveRecord::Base.clear_active_connections! unless testing
+          ::ActiveRecord::Base.connection_handler.clear_active_connections! unless testing
         end
         resp
 
-      rescue Exception
-        ::ActiveRecord::Base.clear_active_connections! unless testing
-        raise
+      rescue => e
+        ::ActiveRecord::Base.connection_handler.clear_active_connections! unless testing
+        raise e
       end
     end
   end

data/lib/otr-activerecord/middleware/query_cache.rb

@@ -5,28 +5,15 @@ module OTR
     #
     class QueryCache
       def initialize(app)
-        @handler = case ::ActiveRecord::VERSION::MAJOR
-                   when 4 then ::ActiveRecord::QueryCache.new(app)
-                   when 5, 6, 7 then ActionDispatchHandler.new(app)
-                   end
+        @app = app
       end
 
       def call(env)
-        @handler.call(env)
-      end
-
-      class ActionDispatchHandler
-        def initialize(app)
-          @app = app
-        end
-
-        def call(env)
-          state = nil
-          state = ::ActiveRecord::QueryCache.run
-          @app.call(env)
-        ensure
-          ::ActiveRecord::QueryCache.complete(state) if state
-        end
+        state = nil
+        state = ::ActiveRecord::QueryCache.run
+        @app.call(env)
+      ensure
+        ::ActiveRecord::QueryCache.complete(state) if state
       end
     end
   end

data/lib/otr-activerecord/{compatibility_6.rb → shim/v6.rb}

@@ -1,12 +1,8 @@
 module OTR
   module ActiveRecord
     # Compatibility layer for ActiveRecord 6
-    class Compatibility6
-      attr_reader :major_version
-
-      # Compatibility layer for ActiveRecord 6
+    class Shim
       def initialize
-        @major_version = 6
         ::ActiveRecord::Base.default_timezone = :utc
       end
 
@@ -22,7 +18,7 @@ module OTR
 
       # Basename of migration classes
       def migration_base_class_name
-        version = "#{@major_version}.#{::ActiveRecord::VERSION::MINOR}"
+        version = "6.#{::ActiveRecord::VERSION::MINOR}"
         "ActiveRecord::Migration[#{version}]"
       end
 

data/lib/otr-activerecord/{compatibility_5.rb → shim/v7.rb}

@@ -1,13 +1,9 @@
 module OTR
   module ActiveRecord
-    # Compatibility layer for ActiveRecord 5
-    class Compatibility5
-      attr_reader :major_version
-
-      # Compatibility layer for ActiveRecord 5
+    # Compatibility layer for ActiveRecord 7
+    class Shim
       def initialize
-        @major_version = 5
-        ::ActiveRecord::Base.default_timezone = :utc
+        ::ActiveRecord.default_timezone = :utc
       end
 
       # All db migration dir paths
@@ -22,7 +18,7 @@ module OTR
 
       # Basename of migration classes
       def migration_base_class_name
-        version = "5.#{::ActiveRecord::VERSION::MINOR}"
+        version = "7.#{::ActiveRecord::VERSION::MINOR}"
         "ActiveRecord::Migration[#{version}]"
       end
 

data/lib/otr-activerecord/version.rb

@@ -1,6 +1,6 @@
 module OTR
   module ActiveRecord
     # Gem version
-    VERSION = '2.2.0'
+    VERSION = '2.4.0'
   end
 end

data/lib/otr-activerecord.rb

@@ -1,7 +1,13 @@
 require 'active_record'
 require 'hashie-forbidden_attributes'
+
 require 'otr-activerecord/version'
 require 'otr-activerecord/activerecord'
-require 'otr-activerecord/middleware/connection_management'
-require 'otr-activerecord/middleware/query_cache'
-require 'otr-activerecord/defaults'
+
+ENV["DISABLE_DATABASE_ENVIRONMENT_CHECK"] ||= "true"
+
+OTR::ActiveRecord.db_dir = 'db'
+OTR::ActiveRecord.migrations_paths = %w(db/migrate)
+OTR::ActiveRecord.fixtures_path = 'test/fixtures'
+OTR::ActiveRecord.seed_file = 'seeds.rb'
+OTR::ActiveRecord.shim = OTR::ActiveRecord::Shim.new

data/lib/tasks/otr-activerecord.rake

@@ -53,13 +53,13 @@ namespace :db do
     task :environment do
       ENV['RACK_ENV'] = 'test'
     end
-  end if OTR::ActiveRecord._normalizer.force_db_test_env?
+  end if OTR::ActiveRecord.shim.force_db_test_env?
 
   desc "Create a migration"
   task :create_migration, [:name] do |_, args|
     name, version = args[:name], Time.now.utc.strftime("%Y%m%d%H%M%S")
 
-    OTR::ActiveRecord._normalizer.migrations_paths.each do |directory|
+    OTR::ActiveRecord.shim.migrations_paths.each do |directory|
       next unless File.exist?(directory)
 
       migration_files = Pathname(directory).children
@@ -69,12 +69,12 @@ namespace :db do
     end
 
     filename = "#{version}_#{name}.rb"
-    dirname = OTR::ActiveRecord._normalizer.migrations_path
+    dirname = OTR::ActiveRecord.shim.migrations_path
     path = File.join(dirname, filename)
 
     FileUtils.mkdir_p(dirname)
     File.write path, <<-MIGRATION.strip_heredoc
-      class #{name.camelize} < #{OTR::ActiveRecord._normalizer.migration_base_class_name}
+      class #{name.camelize} < #{OTR::ActiveRecord.shim.migration_base_class_name}
         def change
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: otr-activerecord
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-30 00:00:00.000000000 Z
+date: 2024-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.3'
 - !ruby/object:Gem::Dependency
   name: hashie-forbidden_attributes
   requirement: !ruby/object:Gem::Requirement
@@ -55,13 +55,10 @@ files:
 - README.md
 - lib/otr-activerecord.rb
 - lib/otr-activerecord/activerecord.rb
-- lib/otr-activerecord/compatibility_4.rb
-- lib/otr-activerecord/compatibility_5.rb
-- lib/otr-activerecord/compatibility_6.rb
-- lib/otr-activerecord/compatibility_7.rb
-- lib/otr-activerecord/defaults.rb
 - lib/otr-activerecord/middleware/connection_management.rb
 - lib/otr-activerecord/middleware/query_cache.rb
+- lib/otr-activerecord/shim/v6.rb
+- lib/otr-activerecord/shim/v7.rb
 - lib/otr-activerecord/version.rb
 - lib/tasks/otr-activerecord.rake
 homepage: https://github.com/jhollinger/otr-activerecord
@@ -76,14 +73,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: 'Off The Rails: Use ActiveRecord with Grape, Sinatra, Rack, or anything else!'

data/lib/otr-activerecord/compatibility_4.rb

@@ -1,34 +0,0 @@
-module OTR
-  module ActiveRecord
-    # Compatibility layer for ActiveRecord 4
-    class Compatibility4
-      attr_reader :major_version
-
-      # Compatibility layer for ActiveRecord 4
-      def initialize
-        @major_version = 4
-        ::ActiveRecord::Base.default_timezone = :utc
-      end
-
-      # All db migration dir paths
-      def migrations_paths
-        OTR::ActiveRecord.migrations_paths
-      end
-
-      # The dir in which to put new migrations
-      def migrations_path
-        OTR::ActiveRecord.migrations_paths[0]
-      end
-
-      # Basename of migration classes
-      def migration_base_class_name
-        'ActiveRecord::Migration'
-      end
-
-      # Force RACK_ENV/RAILS_ENV to be 'test' when running any db:test:* tasks
-      def force_db_test_env?
-        true
-      end
-    end
-  end
-end

data/lib/otr-activerecord/compatibility_7.rb

@@ -1,11 +0,0 @@
-module OTR
-  module ActiveRecord
-    # Compatibility layer for ActiveRecord 7
-    class Compatibility7 < Compatibility6
-      def initialize
-        @major_version = 7
-        ::ActiveRecord.default_timezone = :utc
-      end
-    end
-  end
-end

data/lib/otr-activerecord/defaults.rb

@@ -1,13 +0,0 @@
-ENV["DISABLE_DATABASE_ENVIRONMENT_CHECK"] ||= "true"
-
-OTR::ActiveRecord.db_dir = 'db'
-OTR::ActiveRecord.migrations_paths = %w(db/migrate)
-OTR::ActiveRecord.fixtures_path = 'test/fixtures'
-OTR::ActiveRecord.seed_file = 'seeds.rb'
-OTR::ActiveRecord._normalizer =
-  case ::ActiveRecord::VERSION::MAJOR
-  when 4 then OTR::ActiveRecord::Compatibility4.new
-  when 5 then OTR::ActiveRecord::Compatibility5.new
-  when 6 then OTR::ActiveRecord::Compatibility6.new
-  when 7 then OTR::ActiveRecord::Compatibility7.new
-  end