database_recorder 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d51e080ba82dada7af93fbb37380af72e25fef001ecc3f691080048b951f67f
-  data.tar.gz: 5a902b17cab7f30b5cedae2b1e00e374fdc58b3e992cf3bc08d1be8421f37421
+  metadata.gz: d0b2575a34a9e68ee59f68884a492a33c071a05b9d9999caf3baeca5c070c11d
+  data.tar.gz: 29b78920c82393f3e9a23d334b7675d29dc96f3b77f13ff1bf33384cc3206a0d
 SHA512:
-  metadata.gz: 936d740c398c162be09d7f9631c64ad3c516a55ab787991104df7e32bd53299ebf1d7b50d0f6b605f7118e495a7c7e1d551f2029085d123451291a6c054547f5
-  data.tar.gz: 260f2d6c7bd1d3b65c67a25db41fce5efbd65dc19f294af7e852003c08e78126d58d0f6679b48299ff2ad0646eb96577f8ffc2383e137278e44f222d13326f70
+  metadata.gz: 0c7c56cc0c95e24b410ec5d63ac64b1944a20d7084d63ae64b0d80ea265b815435d2c3ce14eec3fb9d2f69261c567ddd59eaba24b4ca0c28f3993272fbb2e33b
+  data.tar.gz: 78db7a6377ba564f5e039bd74f32ffe4c4f6d6c6ff5719340818738a7a4ea40caf4f2164da1cf72e1ebb3800863e1921d3c2bbf32952ff00dc1154487367fe4a

data/README.md

@@ -1,34 +1,66 @@
 # Database Recorder
+[![Gem Version](https://badge.fury.io/rb/database_recorder.svg)](https://badge.fury.io/rb/database_recorder)
+[![Linters](https://github.com/blocknotes/database_recorder/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/database_recorder/actions/workflows/linters.yml)
+[![Specs ActiveRecord](https://github.com/blocknotes/database_recorder/actions/workflows/specs_active_record.yml/badge.svg)](https://github.com/blocknotes/database_recorder/actions/workflows/specs_active_record.yml)
+[![Specs MySQL](https://github.com/blocknotes/database_recorder/actions/workflows/specs_mysql.yml/badge.svg)](https://github.com/blocknotes/database_recorder/actions/workflows/specs_mysql.yml)
+[![Specs PostgreSQL](https://github.com/blocknotes/database_recorder/actions/workflows/specs_postgres.yml/badge.svg)](https://github.com/blocknotes/database_recorder/actions/workflows/specs_postgres.yml)
 
-Record database queries for testing and development purposes only.
-Support only RSpec at the moment, storing logs data on files or Redis.
+Record database queries for testing and development purposes.
+Supports only RSpec at the moment. Store queries information on files or Redis.
 
 Main features:
 - store the history of the queries of a test when it run (for monitoring);
 - eventually check if the current queries match the recorded ones (to prevent regressions);
 - [EXPERIMENTAL] optionally replay the recorded queries replacing the original requests.
 
-See below for more details.
+Sample output: [test.yml](extra/sample.yml)
 
 ## Install
 
-- Add to your Gemfile: `gem 'database_recorder'` (:development, :test groups recommended)
-- With RSpec:
-  + Add to the `spec_helper.rb` (or rails_helper): `DatabaseRecorder::RSpec.setup`
-  + In RSpec examples: add `:dbr` metadata
-  + To verify the matching with the recorded query use: `dbr: { verify_queries: true }`
+- Add to your Gemfile: `gem 'database_recorder', require: false` (:development, :test groups recommended)
+- Using RSpec, add in **rails_helper.rb**:
 
 ```rb
+require 'database_recorder'
+DatabaseRecorder::RSpec.setup
+```
+
+- In the tests add `:dbr` metadata, examples:
+
+```rb
+  # Activate DatabaseRecorder with the default options
   it 'returns 3 posts', :dbr do
     # ...
   end
+
+  # Verify queries comparing with the stored ones:
+  it 'returns more posts', dbr: { verify_queries: true } do
+    # ...
+  end
 ```
 
+Or eventually apply the metadata per path:
+
+```rb
+RSpec.configure do |config|
+  config.define_derived_metadata(file_path: %r{/spec/models/}) do |metadata|
+    metadata[:dbr] = true
+  end
+end
+```
+
+Using an environment variable to enable it:
+
+![image1](extra/image1.png)
+
 ## Config
 
 Add to your _spec_helper.rb_:
 
 ```rb
+# Database driver to use: :active_record | :mysql2 | :pg
+DatabaseRecorder::Config.db_driver = :pg
+
 # To print the queries while executing the specs: false | true | :color
 DatabaseRecorder::Config.print_queries = true
 
@@ -38,6 +70,12 @@ DatabaseRecorder::Config.replay_recordings = true
 # To store the queries: :file | :redis | nil
 DatabaseRecorder::Config.storage = :redis
 # nil to avoid storing the queries
+
+# File storage options
+DatabaseRecorder::Config.storage_options = { recordings_path: '/some/path' }
+
+# Redis storage options
+DatabaseRecorder::Config.storage_options = { connection: Redis.new }
 ```
 
 ## History of the queries

data/lib/database_recorder/active_record/abstract_adapter_ext.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DatabaseRecorder
+  module ActiveRecord
+    module AbstractAdapterExt
+      def log(*args)
+        Recorder.record(self, *args) do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/database_recorder/active_record/recorder.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module DatabaseRecorder
+  module ActiveRecord
+    module Recorder
+      module_function
+
+      def ignore_query?(sql, name)
+        !Recording.started? ||
+          %w[schema transaction].include?(name&.downcase) ||
+          sql.downcase.match?(/\A(begin|commit|release|rollback|savepoint)/i)
+      end
+
+      def record(adapter, sql, name = 'SQL', binds = [], type_casted_binds = [], *args)
+        return yield if ignore_query?(sql, name)
+
+        Core.log_query(sql, name)
+        if Config.replay_recordings && Recording.from_cache
+          Recording.push(sql: sql, binds: binds)
+          data = Recording.cached_query_for(sql)
+          return yield if !data || !data[:result] # cache miss
+
+          RecordedResult.new(data[:result][:fields], data[:result][:values])
+        else
+          yield.tap do |result|
+            result_data =
+              if result && (result.respond_to?(:fields) || result.respond_to?(:columns))
+                fields = result.respond_to?(:fields) ? result.fields : result.columns
+                values = result.respond_to?(:values) ? result.values : result.to_a
+                { count: result.count, fields: fields, values: values }
+              end
+            Recording.push(sql: sql, name: name, binds: type_casted_binds, result: result_data)
+          end
+        end
+      end
+
+      def setup
+        ::ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
+          prepend AbstractAdapterExt
+        end
+
+        # ::ActiveRecord::Base.class_eval do
+        #   prepend BaseExt
+        # end
+      end
+    end
+  end
+end

data/lib/database_recorder/config.rb

@@ -7,28 +7,46 @@ module DatabaseRecorder
   class Config
     include Singleton
 
-    attr_accessor :db_driver, :print_queries, :replay_recordings, :storage
+    DEFAULT_DB_DRIVER = :active_record
+    DEFAULT_STORAGE = DatabaseRecorder::Storage::File
+
+    DB_DRIVER_VALUES = %i[active_record mysql2 pg].freeze
+    PRINT_QUERIES_VALUES = [false, true, :color].freeze
+    STORAGE_VALUES = {
+      file: DatabaseRecorder::Storage::File,
+      redis: DatabaseRecorder::Storage::Redis
+    }.freeze
+
+    attr_accessor :db_driver, :print_queries, :replay_recordings, :storage, :storage_options
 
     class << self
       extend Forwardable
 
-      def_delegators :instance, :db_driver, :db_driver=, :print_queries, :print_queries=, :replay_recordings,
-                     :replay_recordings=, :storage
+      def_delegators :instance, :db_driver, :print_queries, :replay_recordings, :replay_recordings=, :storage,
+                     :storage_options, :storage_options=
 
       def load_defaults
-        instance.db_driver = :active_record
-        instance.print_queries = false # false | true | :color
+        instance.db_driver = DEFAULT_DB_DRIVER
+        instance.print_queries = false
         instance.replay_recordings = false
-        self.storage = :file # :file | :redis
+        instance.storage = DEFAULT_STORAGE
+        instance.storage_options = {}
+      end
+
+      def db_driver=(value)
+        instance.db_driver = DB_DRIVER_VALUES.include?(value) ? value : DEFAULT_DB_DRIVER
+      end
+
+      def print_queries=(value)
+        instance.print_queries = PRINT_QUERIES_VALUES.include?(value) ? value : false
       end
 
       def storage=(value)
         instance.storage =
-          case value
-          when :file then DatabaseRecorder::Storage::File
-          when :redis then DatabaseRecorder::Storage::Redis
-          when nil then nil
-          else raise ArgumentError, "Unknown storage: #{value}"
+          if value.is_a?(Class) && value < Storage::Base
+            value
+          else
+            STORAGE_VALUES[value]
           end
       end
     end

data/lib/database_recorder/core.rb

@@ -5,19 +5,45 @@ module DatabaseRecorder
     module_function
 
     def log_query(sql, source = nil)
-      case DatabaseRecorder::Config.print_queries
-      when true
-        puts "[DB] #{sql} [#{source}]"
-      when :color
-        puts "[DB] #{CodeRay.scan(sql, :sql).term} [#{source}]"
-      end
+      log =
+        case DatabaseRecorder::Config.print_queries
+        when true then "[DB] #{sql} [#{source}]"
+        when :color then "[DB] #{CodeRay.scan(sql, :sql).term} [#{source}]"
+        end
+
+      puts log if log
+      log
     end
 
     def setup
       case DatabaseRecorder::Config.db_driver
       when :active_record then ActiveRecord::Recorder.setup
-      when :mysql2 then Mysql2.setup
-      when :pg then PG.setup
+      when :mysql2 then Mysql2::Recorder.setup
+      when :pg then PG::Recorder.setup
+      end
+    end
+
+    def string_keys_recursive(hash)
+      {}.tap do |h|
+        hash.each do |key, value|
+          h[key.to_s] = transform(value, :string_keys_recursive)
+        end
+      end
+    end
+
+    def symbolize_recursive(hash)
+      {}.tap do |h|
+        hash.each do |key, value|
+          h[key.to_sym] = transform(value, :symbolize_recursive)
+        end
+      end
+    end
+
+    def transform(value, source_method)
+      case value
+      when Hash then method(source_method).call(value)
+      when Array then value.map { |v| transform(v, source_method) }
+      else value
       end
     end
   end

data/lib/database_recorder/mysql2/client_ext.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DatabaseRecorder
+  module Mysql2
+    module ClientExt
+      def query(sql, options = {})
+        Recorder.store_query(self, sql: sql, source: :query) do
+          super
+        end
+      end
+
+      def prepare(*args)
+        Recorder.prepare_statement(self, sql: args[0], source: :prepare) do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/database_recorder/mysql2/recorded_result.rb

@@ -4,7 +4,9 @@
 
 module DatabaseRecorder
   module Mysql2
-    class RecordedResult # < ::Mysql2::Result
+    class RecordedResult
+      # < ::Mysql2::Result
+
       # include Enumerable
       # extend Forwardable
 
@@ -15,10 +17,10 @@ module DatabaseRecorder
       alias :size :count
 
       def prepare(data)
-        @count = data['count']
-        @fields = data['fields']
-        @entries = data['values']
-        # @values = data['values']
+        @count = data[:count]
+        @fields = data[:fields]
+        @entries = data[:values]
+        # @values = data[:values]
       end
 
       # def server_flags

data/lib/database_recorder/mysql2/recorder.rb

@@ -3,50 +3,69 @@
 module DatabaseRecorder
   module Mysql2
     module Recorder
-      def query(sql, options = {})
-        Mysql2.record(self, sql: sql) do
-          super
-        end
+      module_function
+
+      def ignore_query?(sql)
+        !Recording.started? ||
+          sql == 'SELECT LAST_INSERT_ID() AS _dbr_last_insert_id' ||
+          sql.downcase.match?(/\A(begin|commit|release|rollback|savepoint|show full fields from)/i) ||
+          sql.match?(/information_schema.statistics/)
+      end
+
+      def format_result(result)
+        { count: result.count, fields: result.fields, values: result.to_a } if result.is_a?(::Mysql2::Result)
+        # else
+        #   last_insert_id = adapter.query('SELECT LAST_INSERT_ID() AS _dbr_last_insert_id').to_a
+        #   { 'count' => last_insert_id.count, 'fields' => ['id'], 'values' => last_insert_id }
       end
-    end
 
-    module_function
+      def prepare_statement(adapter, sql: nil, name: nil, binds: nil, source: nil)
+        @last_prepared = Recording.push_prepared(name: name, sql: sql, binds: binds, source: source)
+        yield if !Config.replay_recordings || Recording.cache.nil?
+      end
 
-    def ignore_query?(sql)
-      !Recording.started? ||
-        sql == 'SELECT LAST_INSERT_ID() AS _dbr_last_insert_id' ||
-        sql.downcase.match?(/\A(begin|commit|release|rollback|savepoint|show full fields from)/i) ||
-        sql.match?(/information_schema.statistics/)
-    end
+      def setup
+        ::Mysql2::Client.class_eval do
+          prepend ClientExt
+        end
 
-    def record(recorder, sql:)
-      return yield if ignore_query?(sql)
-
-      Core.log_query(sql)
-      if Config.replay_recordings && !Recording.cache.nil?
-        Recording.push(sql: sql)
-        data = Recording.cached_query_for(sql)
-        return yield unless data # cache miss
-
-        RecordedResult.new.prepare(data['result'].slice('count', 'fields', 'values')) if data['result']
-      else
-        yield.tap do |result|
-          result_data =
-            if result
-              { 'count' => result.count, 'fields' => result.fields, 'values' => result.to_a }
-            else
-              last_insert_id = recorder.query('SELECT LAST_INSERT_ID() AS _dbr_last_insert_id').to_a
-              { 'count' => last_insert_id.count, 'fields' => ['id'], 'values' => last_insert_id }
-            end
-
-          Recording.push(sql: sql, result: result_data)
+        ::Mysql2::Statement.class_eval do
+          prepend StatementExt
         end
       end
-    end
 
-    def setup
-      ::Mysql2::Client.class_eval do
-        prepend Recorder
+      def store_prepared_statement(adapter, source:, binds:)
+        # sql = @last_prepared&.send(:[], 'sql')
+        sql = @last_prepared[:sql]
+        Core.log_query(sql, source)
+        if Config.replay_recordings && !Recording.cache.nil?
+          data = Recording.cache.find { |query| query[:sql] == sql }
+          return yield unless data # cache miss
+
+          Recording.push(sql: data[:sql], binds: data[:binds], source: source)
+          RecordedResult.new(data[:result].slice(:count, :fields, :values))
+        else
+          yield.tap do |result|
+            Recording.update_prepared(sql: sql, binds: binds, result: format_result(result), source: source)
+          end
+        end
+      end
+
+      def store_query(adapter, sql:, source:)
+        return yield if ignore_query?(sql)
+
+        Core.log_query(sql, source)
+        if Config.replay_recordings && !Recording.cache.nil?
+          Recording.push(sql: sql, source: source)
+          data = Recording.cached_query_for(sql)
+          return yield unless data # cache miss
+
+          RecordedResult.new.prepare(data[:result].slice(:count, :fields, :values)) if data[:result]
+        else
+          yield.tap do |result|
+            Recording.push(sql: sql, result: format_result(result), source: source)
+          end
+        end
       end
     end
   end

data/lib/database_recorder/mysql2/statement_ext.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DatabaseRecorder
+  module Mysql2
+    module StatementExt
+      def execute(*args, **kwargs)
+        Recorder.store_prepared_statement(self, source: :execute, binds: args) do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/database_recorder/pg/connection_ext.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module DatabaseRecorder
+  module PG
+    module ConnectionExt
+      def async_exec(sql)
+        Recorder.store_query(sql: sql, source: :async_exec) do
+          super
+        end
+      end
+
+      def sync_exec(sql)
+        Recorder.store_query(sql: sql, source: :sync_exec) do
+          super
+        end
+      end
+
+      def exec(*args)
+        Recorder.store_query(sql: args[0], source: :exec) do
+          super
+        end
+      end
+
+      def exec_params(*args)
+        Recorder.store_query(sql: args[0], binds: args[1], source: :exec_params) do
+          super
+        end
+      end
+
+      def exec_prepared(*args)
+        Recorder.store_prepared_statement(name: args[0], binds: args[1], source: :exec_prepared) do
+          super
+        end
+      end
+
+      def prepare(*args)
+        Recorder.prepare_statement(name: args[0], sql: args[1], source: :prepare) do
+          super
+        end
+      end
+
+      def query(*args)
+        Recorder.store_query(sql: args[0], source: :query) do
+          super
+        end
+      end
+    end
+  end
+end

data/lib/database_recorder/pg/recorded_result.rb

@@ -11,9 +11,9 @@ module DatabaseRecorder
       alias :rows :values
 
       def initialize(data)
-        @count = data['count']
-        @fields = data['fields']
-        @values = data['values']
+        @count = data[:count]
+        @fields = data[:fields]
+        @values = data[:values]
       end
 
       def clear; end

data/lib/database_recorder/pg/recorder.rb

@@ -3,81 +3,64 @@
 module DatabaseRecorder
   module PG
     module Recorder
-      def async_exec(sql)
-        PG.record(sql: sql, source: :async_exec) do
-          super
-        end
-      end
+      module_function
 
-      def sync_exec(sql)
-        PG.record(sql: sql, source: :sync_exec) do
-          super
-        end
+      def ignore_query?(sql)
+        !Recording.started? ||
+          sql.downcase.match?(/\A(begin|commit|release|rollback|savepoint)/i) ||
+          sql.match?(/ pg_attribute |SHOW max_identifier_length|SHOW search_path/)
       end
 
-      # def exec(*args)
-      #   puts "-E- #{args[0]}"
-      #   super
-      # end
+      def format_result(result)
+        { count: result.count, fields: result.fields, values: result.values } if result
+      end
 
-      # def query(*args)
-      #   puts "-Q- #{args[0]}"
-      #   super
-      # end
+      def prepare_statement(sql: nil, name: nil, binds: nil, source: nil)
+        Recording.push_prepared(name: name, sql: sql, binds: binds, source: source)
+        yield if !Config.replay_recordings || Recording.cache.nil?
+      end
 
-      def exec_params(*args)
-        PG.record(sql: args[0], binds: args[1], source: :exec_params) do
-          super
+      def setup
+        ::PG::Connection.class_eval do
+          prepend ConnectionExt
         end
       end
 
-      # def async_exec_params(*args)
-      #   puts ">>> #{args[0]}"
-      #   super
-      # end
-
-      # def sync_exec_params(*args)
-      #   puts ">>> #{args[0]}"
-      #   super
-      # end
+      def store_prepared_statement(name: nil, sql: nil, binds: nil, source: nil)
+        if Config.replay_recordings && !Recording.cache.nil?
+          data = Recording.cache.find { |query| query[:name] == name }
+          return yield unless data # cache miss
 
-      def exec_prepared(*args)
-        PG.record(sql: args[0], binds: args[1], source: :exec_prepared) do
-          super
+          Core.log_query(data[:sql], source)
+          Recording.push(sql: data[:sql], binds: data[:binds], source: source)
+          RecordedResult.new(data[:result].slice(:count, :fields, :values))
+        else
+          Core.log_query(sql, source)
+          yield.tap do |query_result|
+            result = format_result(query_result)
+            query = Recording.update_prepared(name: name, sql: sql, binds: binds, result: result, source: source)
+            Core.log_query(query[:sql], source)
+          end
         end
       end
-    end
 
-    module_function
+      def store_query(name: nil, sql: nil, binds: nil, source: nil)
+        return yield if ignore_query?(sql)
 
-    def ignore_query?(sql)
-      !Recording.started? ||
-        sql.downcase.match?(/\A(begin|commit|release|rollback|savepoint)/i) ||
-        sql.match?(/ pg_attribute |SHOW max_identifier_length|SHOW search_path/)
-    end
-
-    def record(sql:, binds: nil, source: nil)
-      return yield if ignore_query?(sql)
-
-      Core.log_query(sql, source)
-      if Config.replay_recordings && !Recording.cache.nil?
-        Recording.push(sql: sql, binds: binds)
-        data = Recording.cached_query_for(sql)
-        return yield unless data # cache miss
+        Core.log_query(sql, source)
+        @prepared_statement = nil
+        if Config.replay_recordings && !Recording.cache.nil?
+          Recording.push(sql: sql, binds: binds, source: source)
+          data = Recording.cached_query_for(sql)
+          return yield unless data # cache miss
 
-        RecordedResult.new(data['result'].slice('count', 'fields', 'values'))
-      else
-        yield.tap do |result|
-          result_data = result ? { 'count' => result.count, 'fields' => result.fields, 'values' => result.values } : nil
-          Recording.push(sql: sql, binds: binds, result: result_data)
+          RecordedResult.new(data[:result].slice(:count, :fields, :values))
+        else
+          yield.tap do |result|
+            Recording.push(name: name, sql: sql, binds: binds, result: format_result(result), source: source)
+          end
         end
       end
     end
-
-    def setup
-      ::PG::Connection.class_eval do
-        prepend Recorder
-      end
-    end
   end
 end

data/lib/database_recorder/recording.rb

@@ -4,23 +4,25 @@ require 'forwardable'
 
 module DatabaseRecorder
   class Recording
-    attr_accessor :cache, :entities
-    attr_reader :from_cache, :options, :queries, :started
+    attr_accessor :cache, :entities, :metadata
+    attr_reader :from_cache, :options, :prepared_queries, :queries, :started
 
     def initialize(options: {})
       (@@instances ||= {})[Process.pid] = self
       @cache = nil
       @entities = []
+      @metadata = {}
       @options = options
       @queries = []
       @search_index = 0
+      @@prepared_queries ||= {}
     end
 
     def cached_query_for(sql)
       current = @search_index
       match = cache[@search_index..].find do |item|
         current += 1
-        item['sql'] == sql # TODo: try matching by normalized query (no values)
+        item[:sql] == sql
       end
       return unless match
 
@@ -31,34 +33,49 @@ module DatabaseRecorder
     end
 
     def new_entity(model:, id:)
-      @entities.push('model' => model, 'id' => id)
+      @entities.push(model: model, id: id)
     end
 
     def pull_entity
       @entities.shift
     end
 
-    def push(sql:, binds: nil, result: nil, name: nil)
-      query = { 'name' => name, 'sql' => sql, 'binds' => binds, 'result' => result }.compact
+    def push(sql:, name: nil, binds: nil, result: nil, source: nil)
+      query = { name: name, sql: sql, binds: binds, result: result }.compact
       @queries.push(query)
     end
 
+    def push_prepared(name: nil, sql: nil, binds: nil, result: nil, source: nil)
+      query = { name: name, sql: sql, binds: binds, result: result }.compact
+      @@prepared_queries[name || sql] = query
+    end
+
     def start
       @started = true
-      storage = Config.storage&.new(self, name: options[:name])
+      storage = Config.storage&.new(self, name: options[:name], options: Config.storage_options)
       @from_cache = storage&.load
       yield
       storage&.save unless from_cache
       @started = false
-      result = { current_queries: queries.map { _1['sql'] } }
-      result[:stored_queries] = cache.map { _1['sql'] } if from_cache
+      result = { current_queries: queries.map { |query| query[:sql] } }
+      result[:stored_queries] = cache.map { |query| query[:sql] } if from_cache
       result
     end
 
+    def update_prepared(name: nil, sql: nil, binds: nil, result: nil, source: nil)
+      query = @@prepared_queries[name || sql]
+      query[:sql] = sql if sql
+      query[:binds] = binds if binds
+      query[:result] = result if result
+      @queries.push(query)
+      query
+    end
+
     class << self
       extend Forwardable
 
-      def_delegators :current_instance, :cache, :cached_query_for, :from_cache, :new_entity, :pull_entity, :push
+      def_delegators :current_instance, :cache, :cached_query_for, :from_cache, :new_entity, :prepared_queries,
+                     :pull_entity, :push, :push_prepared, :queries, :update_prepared
 
       def current_instance
         (@@instances ||= {})[Process.pid]

data/lib/database_recorder/rspec.rb

@@ -14,9 +14,9 @@ module DatabaseRecorder
           ref = (example.metadata[:scoped_id] || '').split(':')[-1]
           options = {}
           options.merge!(example.metadata[:dbr]) if example.metadata[:dbr].is_a?(Hash)
-          options.merge!(example: example)
-          options.merge!(name: "#{example.full_description}__#{ref}") # TODO: if name is already set, append ref
+          options.merge!(example: example, name: "#{example.full_description}__#{ref}")
           Recording.new(options: options).tap do |recording|
+            recording.metadata = { example: example.id, started_at: Time.now }
             result = recording.start { example.run }
             if options[:verify_queries] && result[:stored_queries]
               expect(result[:stored_queries]).to match_array(result[:current_queries])

data/lib/database_recorder/storage/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DatabaseRecorder
+  module Storage
+    class Base
+      def initialize(recording, name:, options: {})
+        @recording = recording
+        @name = name
+        @options = options
+      end
+    end
+  end
+end

data/lib/database_recorder/storage/file.rb

@@ -2,18 +2,14 @@
 
 module DatabaseRecorder
   module Storage
-    class File
-      def initialize(recording, name:)
-        @recording = recording
-        @name = name
-      end
-
+    class File < Base
       def load
-        stored_data = ::File.exist?(record_file) ? ::File.read(record_file) : false
+        stored_data = ::File.exist?(storage_path) ? ::File.read(storage_path) : false
         if stored_data
-          data = YAML.load(stored_data)
-          @recording.cache = data['queries']
-          @recording.entities = data['entities']
+          parsed_data = YAML.load(stored_data) # rubocop:disable Security/YAMLLoad
+          data = Core.symbolize_recursive(parsed_data)
+          @recording.cache = data[:queries] || []
+          @recording.entities = data[:entities]
           true
         else
           false
@@ -21,10 +17,22 @@ module DatabaseRecorder
       end
 
       def save
-        data = { 'queries' => @recording.queries }
-        data['entities'] = @recording.entities if @recording.entities.any?
-        serialized_data = data.to_yaml
-        ::File.write(record_file, serialized_data)
+        data = {}
+        data[:metadata] = @recording.metadata unless @recording.metadata.empty?
+        data[:queries] = @recording.queries if @recording.queries.any?
+        data[:entities] = @recording.entities if @recording.entities.any?
+        serialized_data = Core.string_keys_recursive(data).to_yaml
+        ::File.write(storage_path, serialized_data)
+        true
+      end
+
+      def storage_path
+        @storage_path ||= begin
+          name = normalize_name(@name)
+          path = @options[:recordings_path] || 'spec/dbr'
+          FileUtils.mkdir_p(path)
+          "#{path}/#{name}.yml"
+        end
       end
 
       private
@@ -32,13 +40,6 @@ module DatabaseRecorder
       def normalize_name(string)
         string.gsub(%r{[:/]}, '-').gsub(/[^\w-]/, '_')
       end
-
-      def record_file
-        name = normalize_name(@name)
-        path = 'spec/dbr'
-        FileUtils.mkdir_p(path)
-        "#{path}/#{name}.yml"
-      end
     end
   end
 end

data/lib/database_recorder/storage/redis.rb

@@ -2,18 +2,18 @@
 
 module DatabaseRecorder
   module Storage
-    class Redis
-      def initialize(recording, name:)
-        @recording = recording
-        @name = name
+    class Redis < Base
+      def connection
+        @connection ||= @options[:connection] || ::Redis.new
       end
 
       def load
-        stored_data = self.class.connection.get(@name)
+        stored_data = connection.get(@name)
         if stored_data
-          data = JSON.parse(stored_data)
-          @recording.cache = data['queries']
-          @recording.entities = data['entities']
+          parsed_data = JSON.parse(stored_data)
+          data = Core.symbolize_recursive(parsed_data)
+          @recording.cache = data[:queries] || []
+          @recording.entities = data[:entities]
           true
         else
           false
@@ -21,16 +21,13 @@ module DatabaseRecorder
       end
 
       def save
-        data = { 'queries' => @recording.queries }
-        data['entities'] = @recording.entities if @recording.entities.any?
+        data = {}
+        data[:metadata] = @recording.metadata unless @recording.metadata.empty?
+        data[:queries] = @recording.queries if @recording.queries.any?
+        data[:entities] = @recording.entities if @recording.entities.any?
         serialized_data = data.to_json
-        self.class.connection.set(@name, serialized_data)
-      end
-
-      class << self
-        def connection
-          @connection ||= ::Redis.new
-        end
+        connection.set(@name, serialized_data)
+        true
       end
     end
   end

data/lib/database_recorder/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :nocov:
 module DatabaseRecorder
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end
+# :nocov:

data/lib/database_recorder.rb

@@ -3,22 +3,22 @@
 require_relative 'database_recorder/core'
 
 if defined? ::ActiveRecord
-  require_relative 'database_recorder/activerecord/abstract_adapter_ext'
-  require_relative 'database_recorder/activerecord/base_ext'
-  require_relative 'database_recorder/activerecord/recorded_result'
-  require_relative 'database_recorder/activerecord/recorder'
+  require_relative 'database_recorder/active_record/abstract_adapter_ext'
+  require_relative 'database_recorder/active_record/base_ext'
+  require_relative 'database_recorder/active_record/recorded_result'
+  require_relative 'database_recorder/active_record/recorder'
 end
 
-if defined? ::Mysql2
-  require_relative 'database_recorder/mysql2/recorded_result'
-  require_relative 'database_recorder/mysql2/recorder'
-end
+require_relative 'database_recorder/mysql2/client_ext'
+require_relative 'database_recorder/mysql2/recorded_result'
+require_relative 'database_recorder/mysql2/recorder'
+require_relative 'database_recorder/mysql2/statement_ext'
 
-if defined? ::PG
-  require_relative 'database_recorder/pg/recorded_result'
-  require_relative 'database_recorder/pg/recorder'
-end
+require_relative 'database_recorder/pg/connection_ext'
+require_relative 'database_recorder/pg/recorded_result'
+require_relative 'database_recorder/pg/recorder'
 
+require_relative 'database_recorder/storage/base'
 require_relative 'database_recorder/storage/file'
 require_relative 'database_recorder/storage/redis'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_recorder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -35,18 +35,22 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/database_recorder.rb
-- lib/database_recorder/activerecord/abstract_adapter_ext.rb
-- lib/database_recorder/activerecord/base_ext.rb
-- lib/database_recorder/activerecord/recorded_result.rb
-- lib/database_recorder/activerecord/recorder.rb
+- lib/database_recorder/active_record/abstract_adapter_ext.rb
+- lib/database_recorder/active_record/base_ext.rb
+- lib/database_recorder/active_record/recorded_result.rb
+- lib/database_recorder/active_record/recorder.rb
 - lib/database_recorder/config.rb
 - lib/database_recorder/core.rb
+- lib/database_recorder/mysql2/client_ext.rb
 - lib/database_recorder/mysql2/recorded_result.rb
 - lib/database_recorder/mysql2/recorder.rb
+- lib/database_recorder/mysql2/statement_ext.rb
+- lib/database_recorder/pg/connection_ext.rb
 - lib/database_recorder/pg/recorded_result.rb
 - lib/database_recorder/pg/recorder.rb
 - lib/database_recorder/recording.rb
 - lib/database_recorder/rspec.rb
+- lib/database_recorder/storage/base.rb
 - lib/database_recorder/storage/file.rb
 - lib/database_recorder/storage/redis.rb
 - lib/database_recorder/version.rb

data/lib/database_recorder/activerecord/abstract_adapter_ext.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module DatabaseRecorder
-  module ActiveRecord
-    module AbstractAdapterExt
-      def log(sql, name = 'SQL', binds = [], type_casted_binds = [], *args)
-        # puts "--- #{sql} | #{type_casted_binds}", "  > #{name}"
-        return super unless Recording.started?
-        return super if %w[schema transaction].include?(name&.downcase)
-        return super if sql.downcase.match(/\A(begin|commit|release|rollback|savepoint)/i)
-
-        Core.log_query(sql, name)
-        if Config.replay_recordings && Recording.from_cache
-          Recording.push(sql: sql, binds: binds)
-          data = Recording.cached_query_for(sql)
-          return yield if !data || !data['result'] # cache miss
-
-          RecordedResult.new(data['result']['fields'], data['result']['values'])
-        else
-          super.tap do |result|
-            result_data =
-              if result.is_a?(::ActiveRecord::Result)
-                fields = result.respond_to?(:fields) ? result.fields : result.columns
-                values = result.respond_to?(:values) ? result.values : result.to_a
-                { 'count' => result.count, 'fields' => fields, 'values' => values }
-              end
-            Recording.push(sql: sql, name: name, binds: type_casted_binds, result: result_data)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/database_recorder/activerecord/recorder.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module DatabaseRecorder
-  module ActiveRecord
-    module Recorder
-      module_function
-
-      def setup
-        ::ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
-          prepend AbstractAdapterExt
-        end
-
-        # ::ActiveRecord::Base.class_eval do
-        #   prepend BaseExt
-        # end
-      end
-    end
-  end
-end