otr-activerecord 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e901d95b96b53e3558c490bde1012d91a55b86db6ef1ad2158104c7c339c086
-  data.tar.gz: f0eb40274e92d6b61f1802c8344c80db158727df3e227bb415d083b2138d18dc
+  metadata.gz: b7cab0f2557ace7ed091eb02c7090a595d0cfb586313b9f03b4727172e9fd670
+  data.tar.gz: 5dcc6d2ee8e6d99612e6999549c944820b7485735947e80ee953498f2c5cf829
 SHA512:
-  metadata.gz: d4ce3da9776d7c3771ef4f62fca66618036630cdc54ad3487bedf8b3901f2b224f6fba0124c3407b17ff3a11ac169e30ed9642b2b41c5865638db2a45901d9b2
-  data.tar.gz: 845f66293799de390aea7c7ad731f02a7ffb050a4219c45f4af7c60073f25fe16b01ebab450ed7abb2cd238285116728ad2b9e0ddc4b912f4ab6d1ab9b67435d
+  metadata.gz: 71561f7bf678621e8061be51fd5a833c47ac219eb7f7ba010f8a210ba45c108d3f389ab743b87ab4bbc9d6f6aba95bfbd1694bb6f6c9319fa6e17880cd9fa54f
+  data.tar.gz: 2c596c55ae278c66b5081a4d06aabfa43f83e8fd162675c2517299f120e231dd56f8d91a7fa0e7d1d7d0e7390022c825db71d5e71013b4d68b98b8daaf89ce86

data/README.md

@@ -2,9 +2,9 @@
 
 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 4
+* ActiveRecord 6
 * ActiveRecord 5
-* ActiveRecord 6 (experimental)
+* ActiveRecord 4
 
 ## How to use
 
@@ -23,13 +23,29 @@ After loading your gems, tell `OTR::ActiveRecord` about your database config usi
 **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.
 
-#### 3. Enable ActiveRecord connection management in Rack apps
+#### 3. Connect to your database(s)
+
+If you have a single database (most apps), use this helper:
+
+    OTR::ActiveRecord.establish_connection!
 
-This middleware cleans up your database connections after each request. Add it to your `config.ru` file:
+If you're using multiple databases, call your base class(es) instead:
 
+    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
 
-#### 4. Import ActiveRecord tasks into your Rakefile
+    # 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`.
 

data/lib/otr-activerecord.rb

@@ -2,5 +2,6 @@ require 'active_record'
 require 'hashie-forbidden_attributes'
 require 'otr-activerecord/version'
 require 'otr-activerecord/activerecord'
-require 'otr-activerecord/middleware/connection_management.rb'
+require 'otr-activerecord/middleware/connection_management'
+require 'otr-activerecord/middleware/query_cache'
 require 'otr-activerecord/defaults'

data/lib/otr-activerecord/activerecord.rb

@@ -26,7 +26,6 @@ module OTR
     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.establish_connection(rack_env)
     end
 
     # Connect to database with a DB URL. Example: "postgres://user:pass@localhost/db"
@@ -40,10 +39,20 @@ module OTR
       ::ActiveRecord::Base.configurations =
         (YAML.load(ERB.new(File.read(path)).result) || {}).
         reduce({}) { |a, (env, config)|
-          a[env] = {"migrations_paths" => ::OTR::ActiveRecord.migrations_paths}.merge config
+          if config.has_key? "database"
+            a[env] = {"migrations_paths" => ::OTR::ActiveRecord.migrations_paths}.merge config
+          elsif env == rack_env.to_s
+            config.each do |dbname, subconfig|
+              a[dbname.to_sym] = {"migrations_paths" => ::OTR::ActiveRecord.migrations_paths}.merge subconfig
+            end
+          end
           a
         }
-      ::ActiveRecord::Base.establish_connection(rack_env)
+    end
+
+    # Establish a connection to the given db (defaults to current rack env)
+    def self.establish_connection!(db = rack_env)
+      ::ActiveRecord::Base.establish_connection(db)
     end
 
     # The current Rack environment

data/lib/otr-activerecord/compatibility_6.rb

@@ -34,10 +34,3 @@ module OTR
     end
   end
 end
-
-# https://github.com/rails/rails/issues/35902
-module ActiveRecord::Tasks::DatabaseTasks
-  def for_each
-    return
-  end
-end

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

@@ -0,0 +1,33 @@
+module OTR
+  module ActiveRecord
+    #
+    # Rack middleware to enable ActiveRecord's query cache for each request.
+    #
+    class QueryCache
+      def initialize(app)
+        @handler = case ::ActiveRecord::VERSION::MAJOR
+                   when 4 then ::ActiveRecord::QueryCache.new(app)
+                   when 5, 6 then ActionDispatchHandler.new(app)
+                   end
+      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
+      end
+    end
+  end
+end

data/lib/otr-activerecord/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: otr-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.3'
 - !ruby/object:Gem::Dependency
   name: hashie-forbidden_attributes
   requirement: !ruby/object:Gem::Requirement
@@ -60,6 +60,7 @@ files:
 - lib/otr-activerecord/compatibility_6.rb
 - lib/otr-activerecord/defaults.rb
 - lib/otr-activerecord/middleware/connection_management.rb
+- lib/otr-activerecord/middleware/query_cache.rb
 - lib/otr-activerecord/version.rb
 - lib/tasks/otr-activerecord.rake
 homepage: https://github.com/jhollinger/otr-activerecord
@@ -81,8 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: 'Off The Rails: Use ActiveRecord with Grape, Sinatra, Rack, or anything else!'