fixpoints 0.1.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64fc801ca2cedc0a4abc0de5eda59a90ade61b99b462bff2dcad91c7f11909f7
-  data.tar.gz: 60267a9065b27e86f9180a3da0243267a0fcdc7aa45a8b9f35390ad3e5ac5fdc
+  metadata.gz: 458dad6937238c418302f72cb371a6ff84792bd90f5e3f7ca4ad481915dbc770
+  data.tar.gz: 78500279e1b0c01bbf9112e94bcf94ee2c1b52cf9b9b44de75bf9a8ccb376f8f
 SHA512:
-  metadata.gz: 3e6d1e3ae14981d469135f62ca1b5f66f81e8239cbe27b7965694791ac22a79652cea2532cfc8c35f625aa870131d73cb56a9c245ed8d7e4a044d28956702b09
-  data.tar.gz: 94b15a4d1b186466eed68c7db66c32f1f73c8bb168a818a46a137181adacddb67756ccdb1f911c1bd6f12a7547033235682616a065829c5719fb8196ba71a379
+  metadata.gz: c47ceec17bf52c8f287d8a31c46592da2c41cd1c7663f2bb8d668af3f1c98c13d8b932911809f3e0ec826c1997eb9539de1fc888cc1ba8b1f7a59a3305eb33a1
+  data.tar.gz: 8e7d0edf727a1efbf4140448cb014f2066d2bba2fb7ce2a8128956a2ccfcc4654d8d57ee6788ee7d9a81fde25fb82c19b7c77abd5e140a2df911a028e6dfe588

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fixpoints (0.1.2)
+    fixpoints (0.2.3)
       activerecord (>= 5.0.0)
       rspec
 

data/README.md

@@ -54,7 +54,7 @@ RSpec.describe 'User Flow', order: :defined do # !!! mind the order here !!!
     fill_in 'Name', with: 'Tom'
     click_on 'Save'
 
-    store_fixpoint_unless_present :registred_user
+    store_fixpoint_unless_present :registered_user
     # creates a YAML file containing all records (/spec/fixpoints/registred_user.yml)
   end
 
@@ -113,6 +113,15 @@ In order to achieve this, we must make sure that we let the store function know
   end
 ```
 
+**Multiple Databases** If an application uses multiple databases, you can use the optional `connection` parameter
+to specify the database connection to use.
+
+```ruby
+  it 'posts an item' do
+    restore_fixpoint :registered_user, connection: ActiveRecord::Base.connection
+    # ...
+  end
+```
 
 ## Limitations & Known issues
 

data/lib/fixpoint.rb

@@ -45,8 +45,8 @@ class Fixpoint
     end
 
     # Creates a Fixpoint from the database contents. Empty tables are skipped.
-    def from_database
-      new(read_database_records)
+    def from_database(conn)
+      new(read_database_records(conn))
     end
 
     def remove(fixname)
@@ -56,7 +56,7 @@ class Fixpoint
     # reset primary key sequences for all tables
     # useful when tests sometimes run before the storing the first fixpoint.
     # these test might have incremented the id sequence already, so the ids in the fixpoints chance (which leads to differences).
-    def reset_pk_sequences!
+    def reset_pk_sequences!(conn)
       return unless conn.respond_to?(:reset_pk_sequence!)
       conn.tables.each { |table_name| conn.reset_pk_sequence!(table_name) }
     end
@@ -69,10 +69,6 @@ class Fixpoint
       File.join(fspath, "#{fixname}.yml")
     end
 
-    def conn
-      ActiveRecord::Base.connection
-    end
-
     protected
 
     def fixpoints_path
@@ -85,17 +81,21 @@ class Fixpoint
       File.join(spec_path, FIXPOINT_FOLDER)
     end
 
-    def read_database_records
+    def read_database_records(conn)
       # adapted from: https://yizeng.me/2017/07/16/generate-rails-test-fixtures-yaml-from-database-dump/
       tables = conn.tables
       tables.reject! { |table_name| TABLES_TO_SKIP.include?(table_name) }
 
       tables.each_with_object({}) do |table_name, acc|
-        result = conn.select_all("SELECT * FROM #{table_name}")
+        result = conn.select_all("SELECT * FROM #{conn.quote_table_name(table_name)}")
         next if result.count.zero?
 
         rows = result.to_a
         rows.sort_by! { |row| row['id'] } if result.columns.include?('id') # let's make the order of items stable
+        # fix jsonb columns by re-parsing them, so they are not saved as string to the yaml file
+        jsonb_columns = result.column_types.select { |_, col_type| col_type.type == :jsonb }.collect { |col_name, _| col_name }
+        rows.collect! { |row| jsonb_columns.each {|jcol| row[jcol] = JSON.parse(row[jcol] || 'null') }; row }
+
         acc[table_name] = rows
       end
     end
@@ -107,7 +107,7 @@ class Fixpoint
     @records_in_tables = records_in_tables
   end
 
-  def load_into_database
+  def load_into_database(conn)
     # Here some more pointers on implementation details of fixtures:
     # - https://github.com/rails/rails/blob/2998672fc22f0d5e1a79a29ccb60d0d0e627a430/activerecord/lib/active_record/fixtures.rb#L612
     # - http://api.rubyonrails.org/v5.2.4/classes/ActiveRecord/FixtureSet.html#method-c-create_fixtures
@@ -123,7 +123,7 @@ class Fixpoint
 
     # actually insert
     conn.insert_fixtures_set(@records_in_tables)
-    self.class.reset_pk_sequences!
+    self.class.reset_pk_sequences!(conn)
   end
 
   def save_to_file(fixname)
@@ -146,8 +146,6 @@ class Fixpoint
 
   protected
 
-  delegate :conn, to: :class
-
   def contents_for_file
     YAML.dump(@records_in_tables)
   end

data/lib/fixpoint_test_helpers.rb

@@ -1,8 +1,8 @@
 # Helper methods to be included into RSpec
 module FixpointTestHelpers
-  def restore_fixpoint(fixname)
+  def restore_fixpoint(fixname, connection: default_connection)
     @last_restored = fixname
-    IncrementalFixpoint.from_file(fixname).load_into_database
+    IncrementalFixpoint.from_file(fixname).load_into_database(connection)
   end
 
   # Compares the fixpoint with the records in the database.
@@ -16,10 +16,10 @@ module FixpointTestHelpers
   # ---
   # If we refactor this to a gem, we should rely on rspec (e.g. use minitest or move comparison logic to Fixpoint class).
   # Anyhow, we keep it like this for now, because the expectations give much nicer output than the minitest assertions.
-  def compare_fixpoint(fixname, ignored_columns=[:updated_at, :created_at], tables_to_compare: :all, store_fixpoint_and_fail: false, parent_fixname: nil)
+  def compare_fixpoint(fixname, ignored_columns=[:updated_at, :created_at], tables_to_compare: :all, store_fixpoint_and_fail: false, parent_fixname: nil, connection: default_connection)
     if !IncrementalFixpoint.exists?(fixname)
       if store_fixpoint_and_fail
-        store_fixpoint(fixname, parent_fixname)
+        store_fixpoint(fixname, parent_fixname, connection: connection)
         pending("Fixpoint \"#{fixname}\" did not exist yet. Skipping comparison, but created fixpoint from database. Try re-running the test.")
         fail
       else
@@ -27,7 +27,7 @@ module FixpointTestHelpers
       end
     end
 
-    database_fp = IncrementalFixpoint.from_database
+    database_fp = IncrementalFixpoint.from_database(nil, connection)
     fixpoint_fp = IncrementalFixpoint.from_file(fixname)
 
     tables_to_compare = (database_fp.table_names + fixpoint_fp.table_names).uniq if tables_to_compare == :all
@@ -35,8 +35,6 @@ module FixpointTestHelpers
       db_records = database_fp.records_for_table(table_name, ignored_columns)
       fp_records = fixpoint_fp.records_for_table(table_name, ignored_columns)
 
-      # if a table is present in a fixpoint, there must be records in it because empty tables are stripped from fixpoints
-      expect(db_records).not_to be_empty, "#{table_name} not in database, but in fixpoint"
       expect(fp_records).not_to be_empty, "#{table_name} not in fixpoint, but in database"
       # we assume that the order of records returned by SELECT is stable (so we do not do any sorting)
       expect(db_records).to eq(fp_records), "Database records for table \"#{table_name}\" did not match fixpoint \"#{fixname}\". Consider removing the fixpoint and re-running the test if the change is intended."
@@ -45,14 +43,18 @@ module FixpointTestHelpers
 
   # it is not a good idea to overwrite the fixpoint each time because timestamps may change (which then shows up in version control).
   # Hence we only provide a method to write to it if it does not exist.
-  def store_fixpoint_unless_present(fixname, parent_fixname = nil)
-    store_fixpoint(fixname, parent_fixname) unless IncrementalFixpoint.exists?(fixname)
+  def store_fixpoint_unless_present(fixname, parent_fixname = nil, connection: default_connection)
+    store_fixpoint(fixname, parent_fixname, connection: connection) unless IncrementalFixpoint.exists?(fixname)
   end
 
   # +parent_fixname+ when given, only the (incremental) changes to the parent are saved
   # please see store_fixpoint_unless_present for note on why not to use this method
-  def store_fixpoint(fixname, parent_fixname = nil)
+  def store_fixpoint(fixname, parent_fixname = nil, connection: default_connection)
     parent_fixname = @last_restored if parent_fixname == :last_restored
-    IncrementalFixpoint.from_database(parent_fixname).save_to_file(fixname)
+    IncrementalFixpoint.from_database(parent_fixname, connection).save_to_file(fixname)
+  end
+
+  private def default_connection
+    ActiveRecord::Base.connection
   end
 end

data/lib/fixpoints/version.rb

@@ -1,3 +1,3 @@
 module Fixpoints
-  VERSION = "0.1.3"
+  VERSION = "0.2.4"
 end

data/lib/incremental_fixpoint.rb

@@ -33,11 +33,11 @@ class IncrementalFixpoint < Fixpoint
   end
 
   # Creates a Fixpoint from the database contents. Empty tables are skipped.
-  def self.from_database(parent_fixname=nil)
-    return super() if parent_fixname.nil?
+  def self.from_database(parent_fixname=nil, conn)
+    return super(conn) if parent_fixname.nil?
 
     parent = from_file(parent_fixname)
-    changes_in_tables = FixpointDiff.extract_changes(parent.records_in_tables, read_database_records)
+    changes_in_tables = FixpointDiff.extract_changes(parent.records_in_tables, read_database_records(conn))
     new(changes_in_tables, parent_fixname)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixpoints
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Tom Rothe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-15 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord