transient_record 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec82a53a901401c6da1c375a61208fa4fcd6137fbcb734f67f75fee638840143
-  data.tar.gz: 6de93628576efa93f7a84e7625fe5a62f3d929d325f94bae90cd1c9ad1f26585
+  metadata.gz: 4211a0125277e2db4878ea00018ee3f9e1509a05570cacf2aa386327f06e2698
+  data.tar.gz: 1fe18d87b43f1d371ec3d40995c74fc9b5309acf727d75423cc0c4a5c9ee9932
 SHA512:
-  metadata.gz: 648a58873ea44f72876d77ee69375a7da4230466c0f10c755481d92a88e90faa5b605938121991fc749644a8f2d0683e9c6eb68df5dfb8df4554f203fadf37a9
-  data.tar.gz: 06a60e614822af22c7b4e730f11d731530ba5cba1eb85f4945e483ab1d6dbb584fbd1cd2bb3f69bd73dbd17d8c7da6d36d02d71ce1891d4038c3dd1462ee2741
+  metadata.gz: 1937db626c3d1fd04b74131286c24164ba3f205853f49b2575428823df8121ace467b5f4df6dabebb1f5cfae9f0d0ae63531a3ac325ca99bd6e7e06c46676460
+  data.tar.gz: af21ea9a803ad6255583e6d928358fb185fc71290dccb0afe5d6f8ebafe6cdea7f457f2e4c2e00448b19e1798e1150dbf9f6fc341d44521d91e53e672db1c1b2

data/README.md

@@ -7,6 +7,10 @@ and libraries**.
 The library was extracted from [active_record_doctor](https://github.com/gregnavis/active_record_doctor)
 to allow reuse.
 
+## Requirements
+
+Transient Record requires Ruby 3.1 or newer and Active Record 7.0 or newer.
+
 ## Installation
 
 Installing Transient Record is a two-step process.
@@ -138,6 +142,13 @@ class Primary::User < ActiveRecord::Base
 end
 ```
 
+If you need to run an arbitrary query in a given context you can do so via
+`#execute`, which is a wrapper around [the method with the same name in Rails](https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/DatabaseStatements.html#method-i-execute):
+
+```ruby
+Primary.execute("CREATE ROLE gregnavis")
+```
+
 ## Caveats and Limitations
 
 Transient Record does **NOT** default to using temporary tables (created via

data/lib/transient_record.rb

@@ -60,7 +60,6 @@
 #   user = Primary::User.new email: nil
 #
 # @example Creating a table and a model in another database
-#   #
 #   Analytics = TransientRecord.context_for AnalyticsRecord
 #
 #   Analytics.create_table :events do |t|
@@ -70,9 +69,17 @@
 #   end
 #
 #   event = Analytics::Event.new
+#
+# @example Executing an arbitrary query
+#   # Create a Transient Record context.
+#   Primary = TransientRecord.context_for ActiveRecord::Base
+#
+#   # Call #execute on the context, which is delegated to the same method
+#   # provided by Rails.
+#   Primary.execute("CREATE ROLE gregnavis")
 class TransientRecord
   # Transient Record version number.
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 
   # A class representing Transient Record errors.
   class Error < RuntimeError; end
@@ -90,7 +97,7 @@ class TransientRecord
     # @param base_class [Class] class inheriting from {::ActiveRecord::Base}
     # @return [Module] module where transient models will be defined; the module
     #   extends {Context}, so it's instance methods can be called on the module.
-    def context_for base_class
+    def context_for(base_class)
       @contexts[base_class] ||= Context.create base_class
     end
 
@@ -114,7 +121,7 @@ class TransientRecord
     # @return [Module] context module used as a namespace for models
     #
     # @api private
-    def self.create base_class
+    def self.create(base_class)
       Module.new do
         extend Context
         @base_class       = base_class
@@ -147,11 +154,11 @@ class TransientRecord
     # @return [ModelDefinitionProxy]
     #
     # @see https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-create_table Documentation for #create_table in Ruby on Rails
-    def create_table table_name, options = {}, &block
+    def create_table(table_name, options = {}, &)
       table_name = table_name.to_sym
       @transient_tables << table_name
 
-      @base_class.connection.create_table table_name, **options, &block
+      @base_class.connection.create_table(table_name, **options, &)
 
       ModelDefinitionProxy.new self, table_name
     end
@@ -188,7 +195,7 @@ class TransientRecord
     # @yield class definition
     #
     # @return [nil]
-    def define_model model_name, base_class = nil, &block
+    def define_model(model_name, base_class = nil, &)
       base_class ||= @base_class
 
       if base_class > @base_class
@@ -200,11 +207,25 @@ class TransientRecord
       klass = Class.new base_class
       const_set model_name, klass
 
-      klass.class_eval(&block) if block_given?
+      klass.class_eval(&) if block_given?
 
       nil
     end
 
+    # Executes an arbitrary query.
+    #
+    # This method is a wrapper around the `#execute` method on the Active Record
+    # database connection adapter.
+    #
+    # @param query [String] query to execute
+    # @param name [String] name to log along the query
+    # @return The query result returned by the database connection adapter.
+    #
+    # @see https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/DatabaseStatements.html#method-i-execute Documentation for #execute in Ruby on Rails
+    def execute(query, name = nil)
+      @base_class.connection.execute query, name
+    end
+
     # Drops transient tables and models.
     #
     # Calling this method removes all models and drops all tables created within
@@ -255,13 +276,13 @@ class TransientRecord
   # model in close succession. It's marked private as there's no need for
   # callers to access it directly.
   class ModelDefinitionProxy
-    def initialize context, table_name
+    def initialize(context, table_name)
       @context    = context
       @table_name = table_name
     end
 
-    def define_model *args, &block
-      @context.define_model @table_name.to_s.classify, *args, &block
+    def define_model(...)
+      @context.define_model(@table_name.to_s.classify, ...)
     end
   end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: transient_record
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Greg Navis
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-02 00:00:00.000000000 Z
+date: 2025-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,47 +24,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 3.1.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 3.1.9
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: mutex_m
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.4
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.4
+        version: 0.5.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.4
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +94,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.28
+        version: 1.5.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.28
+        version: 1.5.4
 - !ruby/object:Gem::Dependency
   name: webrick
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +121,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.43.0
+        version: 1.70.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.43.0
+        version: 1.70.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +163,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.0
-description:
 email:
 - contact@gregnavis.com
 executables: []
@@ -151,7 +177,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,15 +184,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Define transient tables and Active Record models for testing purposes.
 test_files: []