database_recorder 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0b2575a34a9e68ee59f68884a492a33c071a05b9d9999caf3baeca5c070c11d
-  data.tar.gz: 29b78920c82393f3e9a23d334b7675d29dc96f3b77f13ff1bf33384cc3206a0d
+  metadata.gz: 48d1f4f88105fa9ac49075181f90208ca051bec2273daaeaf77cca9ad2c1ed77
+  data.tar.gz: 9ef096a48a9a0dafd7bbab635a20805d4b5ec0f06710d9b596554a1f03016c8e
 SHA512:
-  metadata.gz: 0c7c56cc0c95e24b410ec5d63ac64b1944a20d7084d63ae64b0d80ea265b815435d2c3ce14eec3fb9d2f69261c567ddd59eaba24b4ca0c28f3993272fbb2e33b
-  data.tar.gz: 78db7a6377ba564f5e039bd74f32ffe4c4f6d6c6ff5719340818738a7a4ea40caf4f2164da1cf72e1ebb3800863e1921d3c2bbf32952ff00dc1154487367fe4a
+  metadata.gz: 177da34267bb1fb58fb1b99e68d68430f8d36822facffb9fcd42e2e024176bbfc7be4d57ef807ce834bf1522151255c1614e5a9bb73833d86b70eb502aac0a30
+  data.tar.gz: 43d907dd4dc7902280bb379a4ae20dadca9c89712e62a188be7609795efd0c87db968c0b938e303e1f3e38bf44e23d34ed91be567169e118b42b3c00bd7e212e

data/README.md

@@ -6,7 +6,7 @@
 [![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.
-Supports only RSpec at the moment. Store queries information on files or Redis.
+Store queries information on files or Redis.
 
 Main features:
 - store the history of the queries of a test when it run (for monitoring);
@@ -15,10 +15,16 @@ Main features:
 
 Sample output: [test.yml](extra/sample.yml)
 
+Creating an environment variable to enable it with RSpec:
+
+![image1](extra/image1.png)
+
 ## Install
 
+### With RSpec
+
 - Add to your Gemfile: `gem 'database_recorder', require: false` (:development, :test groups recommended)
-- Using RSpec, add in **rails_helper.rb**:
+- Add in **rails_helper.rb**:
 
 ```rb
 require 'database_recorder'
@@ -49,9 +55,20 @@ RSpec.configure do |config|
 end
 ```
 
-Using an environment variable to enable it:
+### With plain Ruby
 
-![image1](extra/image1.png)
+```rb
+DatabaseRecorder::Config.db_driver = :pg
+DatabaseRecorder::Core.setup
+DatabaseRecorder::Recording.new(options: { name: 'pg_file' }).tap do |recording|
+  pp recording.start do
+    PG.connect(DB_CONFIG).exec("INSERT INTO tags(name, created_at, updated_at) VALUES('tag1', NOW(), NOW())")
+    PG.connect(DB_CONFIG).exec("SELECT * FROM tags")
+  end
+end
+```
+
+Please check more [examples](examples).
 
 ## Config
 
@@ -61,7 +78,10 @@ Add to your _spec_helper.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
+# Log queries format (default: '[DB] %sql [%name]')
+DatabaseRecorder::Config.log_format = '>>> %name -- %sql'
+
+# To print/log the queries while executing the specs: false | true | :color
 DatabaseRecorder::Config.print_queries = true
 
 # Replay the recordings intercepting the queries

data/lib/database_recorder/config.rb

@@ -8,6 +8,7 @@ module DatabaseRecorder
     include Singleton
 
     DEFAULT_DB_DRIVER = :active_record
+    DEFAULT_LOG_FORMAT = '[DB] %sql [%name]'
     DEFAULT_STORAGE = DatabaseRecorder::Storage::File
 
     DB_DRIVER_VALUES = %i[active_record mysql2 pg].freeze
@@ -17,16 +18,17 @@ module DatabaseRecorder
       redis: DatabaseRecorder::Storage::Redis
     }.freeze
 
-    attr_accessor :db_driver, :print_queries, :replay_recordings, :storage, :storage_options
+    attr_accessor :db_driver, :log_format, :print_queries, :replay_recordings, :storage, :storage_options
 
     class << self
       extend Forwardable
 
-      def_delegators :instance, :db_driver, :print_queries, :replay_recordings, :replay_recordings=, :storage,
-                     :storage_options, :storage_options=
+      def_delegators :instance, :db_driver, :log_format, :log_format=, :print_queries, :replay_recordings,
+                     :replay_recordings=, :storage, :storage_options, :storage_options=
 
       def load_defaults
         instance.db_driver = DEFAULT_DB_DRIVER
+        instance.log_format = DEFAULT_LOG_FORMAT
         instance.print_queries = false
         instance.replay_recordings = false
         instance.storage = DEFAULT_STORAGE

data/lib/database_recorder/core.rb

@@ -7,8 +7,11 @@ module DatabaseRecorder
     def log_query(sql, source = nil)
       log =
         case DatabaseRecorder::Config.print_queries
-        when true then "[DB] #{sql} [#{source}]"
-        when :color then "[DB] #{CodeRay.scan(sql, :sql).term} [#{source}]"
+        when true
+          DatabaseRecorder::Config.log_format.sub('%name', source.to_s).sub('%sql', sql)
+        when :color
+          code_ray_sql = CodeRay.scan(sql, :sql).term
+          DatabaseRecorder::Config.log_format.sub('%name', source.to_s).sub('%sql', code_ray_sql || '')
         end
 
       puts log if log

data/lib/database_recorder/rspec.rb

@@ -13,8 +13,8 @@ module DatabaseRecorder
         config.around(:each, :dbr) do |example|
           ref = (example.metadata[:scoped_id] || '').split(':')[-1]
           options = {}
+          options[:name] = "#{example.full_description}__#{ref}"
           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 }

data/lib/database_recorder/storage/file.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+require 'yaml'
+
 module DatabaseRecorder
   module Storage
     class File < Base
@@ -21,7 +24,7 @@ module DatabaseRecorder
         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
+        serialized_data = ::YAML.dump(Core.string_keys_recursive(data))
         ::File.write(storage_path, serialized_data)
         true
       end
@@ -30,7 +33,7 @@ module DatabaseRecorder
         @storage_path ||= begin
           name = normalize_name(@name)
           path = @options[:recordings_path] || 'spec/dbr'
-          FileUtils.mkdir_p(path)
+          ::FileUtils.mkdir_p(path)
           "#{path}/#{name}.yml"
         end
       end

data/lib/database_recorder/storage/redis.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'json'
+
 module DatabaseRecorder
   module Storage
     class Redis < Base

data/lib/database_recorder/version.rb

@@ -2,6 +2,6 @@
 
 # :nocov:
 module DatabaseRecorder
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end
 # :nocov:

metadata

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