database_recorder 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c43f3f7036d73a7133d4a79984dc7035ec2ccfcaccbf23b3e2f36053debc0f5
-  data.tar.gz: 0d8bc0cdf33d2626811f95bfac45b6dfce0383455a39b58940350048c9d92a70
+  metadata.gz: d0b2575a34a9e68ee59f68884a492a33c071a05b9d9999caf3baeca5c070c11d
+  data.tar.gz: 29b78920c82393f3e9a23d334b7675d29dc96f3b77f13ff1bf33384cc3206a0d
 SHA512:
-  metadata.gz: 611e9419ea6c8f1e536c2b0ba5ad19b46327842e15032168c14db5ac8d109cca14a15bf000329538b894851bb51e6ceaf22fc5970356f31f2f3abd182cced339
-  data.tar.gz: 25eba80806a035ca9da8063a1d745e218b3a0851b008fb0b31b3036680c82758210fa596d3386d31daed0bbee72041242150bcadd37337a828918ee511c0fdb1
+  metadata.gz: 0c7c56cc0c95e24b410ec5d63ac64b1944a20d7084d63ae64b0d80ea265b815435d2c3ce14eec3fb9d2f69261c567ddd59eaba24b4ca0c28f3993272fbb2e33b
+  data.tar.gz: 78db7a6377ba564f5e039bd74f32ffe4c4f6d6c6ff5719340818738a7a4ea40caf4f2164da1cf72e1ebb3800863e1921d3c2bbf32952ff00dc1154487367fe4a

data/README.md

@@ -70,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/recorder.rb

@@ -18,16 +18,16 @@ module DatabaseRecorder
         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
+          return yield if !data || !data[:result] # cache miss
 
-          RecordedResult.new(data['result']['fields'], data['result']['values'])
+          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 }
+                { count: result.count, fields: fields, values: values }
               end
             Recording.push(sql: sql, name: name, binds: type_casted_binds, result: result_data)
           end

data/lib/database_recorder/config.rb

@@ -17,18 +17,20 @@ module DatabaseRecorder
       redis: DatabaseRecorder::Storage::Redis
     }.freeze
 
-    attr_accessor :db_driver, :print_queries, :replay_recordings, :storage
+    attr_accessor :db_driver, :print_queries, :replay_recordings, :storage, :storage_options
 
     class << self
       extend Forwardable
 
-      def_delegators :instance, :db_driver, :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 = DEFAULT_DB_DRIVER
         instance.print_queries = false
         instance.replay_recordings = false
         instance.storage = DEFAULT_STORAGE
+        instance.storage_options = {}
       end
 
       def db_driver=(value)

data/lib/database_recorder/core.rb

@@ -22,5 +22,29 @@ module DatabaseRecorder
       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
 end

data/lib/database_recorder/mysql2/recorded_result.rb

@@ -17,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

@@ -13,7 +13,7 @@ module DatabaseRecorder
       end
 
       def format_result(result)
-        { 'count' => result.count, 'fields' => result.fields, 'values' => result.to_a } if result.is_a?(::Mysql2::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 }
@@ -36,14 +36,14 @@ module DatabaseRecorder
 
       def store_prepared_statement(adapter, source:, binds:)
         # sql = @last_prepared&.send(:[], 'sql')
-        sql = @last_prepared['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 }
+          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'))
+          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)
@@ -60,7 +60,7 @@ module DatabaseRecorder
           data = Recording.cached_query_for(sql)
           return yield unless data # cache miss
 
-          RecordedResult.new.prepare(data['result'].slice('count', 'fields', 'values')) if data['result']
+          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)

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

@@ -12,7 +12,7 @@ module DatabaseRecorder
       end
 
       def format_result(result)
-        { 'count' => result.count, 'fields' => result.fields, 'values' => result.values } if result
+        { count: result.count, fields: result.fields, values: result.values } if result
       end
 
       def prepare_statement(sql: nil, name: nil, binds: nil, source: nil)
@@ -28,18 +28,18 @@ module DatabaseRecorder
 
       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 }
+          data = Recording.cache.find { |query| query[:name] == name }
           return yield unless data # cache miss
 
-          Core.log_query(data['sql'], source)
-          Recording.push(sql: data['sql'], binds: data['binds'], source: source)
-          RecordedResult.new(data['result'].slice('count', 'fields', 'values'))
+          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)
+            Core.log_query(query[:sql], source)
           end
         end
       end
@@ -54,7 +54,7 @@ module DatabaseRecorder
           data = Recording.cached_query_for(sql)
           return yield unless data # cache miss
 
-          RecordedResult.new(data['result'].slice('count', 'fields', 'values'))
+          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)

data/lib/database_recorder/recording.rb

@@ -4,13 +4,14 @@ require 'forwardable'
 
 module DatabaseRecorder
   class Recording
-    attr_accessor :cache, :entities
+    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
@@ -21,7 +22,7 @@ module DatabaseRecorder
       current = @search_index
       match = cache[@search_index..].find do |item|
         current += 1
-        item['sql'] == sql
+        item[:sql] == sql
       end
       return unless match
 
@@ -32,7 +33,7 @@ module DatabaseRecorder
     end
 
     def new_entity(model:, id:)
-      @entities.push('model' => model, 'id' => id)
+      @entities.push(model: model, id: id)
     end
 
     def pull_entity
@@ -40,32 +41,32 @@ module DatabaseRecorder
     end
 
     def push(sql:, name: nil, binds: nil, result: nil, source: nil)
-      query = { 'name' => name, 'sql' => sql, 'binds' => binds, 'result' => result }.compact
+      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
+      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
+      query[:sql] = sql if sql
+      query[:binds] = binds if binds
+      query[:result] = result if result
       @queries.push(query)
       query
     end

data/lib/database_recorder/rspec.rb

@@ -16,6 +16,7 @@ module DatabaseRecorder
           options.merge!(example.metadata[:dbr]) if example.metadata[:dbr].is_a?(Hash)
           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

@@ -3,9 +3,10 @@
 module DatabaseRecorder
   module Storage
     class Base
-      def initialize(recording, name:)
+      def initialize(recording, name:, options: {})
         @recording = recording
         @name = name
+        @options = options
       end
     end
   end

data/lib/database_recorder/storage/file.rb

@@ -4,11 +4,12 @@ module DatabaseRecorder
   module Storage
     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) # rubocop:disable Security/YAMLLoad
-          @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
@@ -16,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
@@ -27,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

@@ -3,12 +3,17 @@
 module DatabaseRecorder
   module Storage
     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
@@ -16,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.2.0'
+  VERSION = '0.2.1'
 end
+# :nocov:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: database_recorder
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mattia Roccoberton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay