fixpoints 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdfded4c7c676dbe7670b38df98318ea3d3728252353b6da8eae9cb906cfb719
-  data.tar.gz: 2d786c4fbbe81c5607ccbb92d6610e5da8d5d04fe2b7287fffaa62fdcfd72a3d
+  metadata.gz: 64fc801ca2cedc0a4abc0de5eda59a90ade61b99b462bff2dcad91c7f11909f7
+  data.tar.gz: 60267a9065b27e86f9180a3da0243267a0fcdc7aa45a8b9f35390ad3e5ac5fdc
 SHA512:
-  metadata.gz: ab745775d4fe7da0966d0600bce51e8f18ff20dfbc948cb6a4bfbe470371a219d797389b475471a742aee57e360b57e27f4bed4d8275e5dbda8c61807cd641a8
-  data.tar.gz: 9aa530efeb5c6d3bc9bb368a5cf60f276766257e126c341a508400e6081baca1046fee32502e2885568b59c038bd0b07aaed6c7f846cd824a99ba340c86fbd41
+  metadata.gz: 3e6d1e3ae14981d469135f62ca1b5f66f81e8239cbe27b7965694791ac22a79652cea2532cfc8c35f625aa870131d73cb56a9c245ed8d7e4a044d28956702b09
+  data.tar.gz: 94b15a4d1b186466eed68c7db66c32f1f73c8bb168a818a46a137181adacddb67756ccdb1f911c1bd6f12a7547033235682616a065829c5719fb8196ba71a379

data/Gemfile.lock

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

data/README.md

@@ -85,9 +85,7 @@ A change in a fixpoint might point to an unintended change in code.
 We need to be be careful to use `let` and `let!` with factories.
 Records might be created twice when using create in there (once by the fixpoint and once by the factory).
 
-**Ignoring columns**
-
-Often you might want to add more columns to ignore (e.g. login time stamps):
+**Ignoring columns** Often you might want to add more columns to ignore (e.g. login time stamps):
 
 ```ruby
 let(:ignored_fixpoint_columns) { [:updated_at, :created_at, users: [:last_login_at] }

data/lib/fixpoint_test_helpers.rb

@@ -0,0 +1,58 @@
+# Helper methods to be included into RSpec
+module FixpointTestHelpers
+  def restore_fixpoint(fixname)
+    @last_restored = fixname
+    IncrementalFixpoint.from_file(fixname).load_into_database
+  end
+
+  # Compares the fixpoint with the records in the database.
+  # If there is no such fixpoint yet, it will write a new one to the file system.
+  # The latter is useful if the fixpoint was deleted to accommodate changes to it (see example in class description).
+  #
+  # +tables_to_compare+ can either be +:all+ or a list of table names (e.g. ['users', 'posts'])
+  # +ignored_columns+ see Fixnum#records_for_table
+  # +store_fixpoint_and_fail+ when given and the fixpoint does not already exist, a new fixpoint is created an the test will be marked pending/failed
+  # +parent_fixname+ when storing a new fixpoint, use this as parent fixpoint (you can specify `:last_restored` then the last given to restore_fixpoint is used; not thread safe)
+  # ---
+  # 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)
+    if !IncrementalFixpoint.exists?(fixname)
+      if store_fixpoint_and_fail
+        store_fixpoint(fixname, parent_fixname)
+        pending("Fixpoint \"#{fixname}\" did not exist yet. Skipping comparison, but created fixpoint from database. Try re-running the test.")
+        fail
+      else
+        raise Fixpoint::Error, "Fixpoint #{fixname} does not exist"
+      end
+    end
+
+    database_fp = IncrementalFixpoint.from_database
+    fixpoint_fp = IncrementalFixpoint.from_file(fixname)
+
+    tables_to_compare = (database_fp.table_names + fixpoint_fp.table_names).uniq if tables_to_compare == :all
+    tables_to_compare.each do |table_name|
+      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."
+    end
+  end
+
+  # 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)
+  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)
+    parent_fixname = @last_restored if parent_fixname == :last_restored
+    IncrementalFixpoint.from_database(parent_fixname).save_to_file(fixname)
+  end
+end

data/lib/fixpoints/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixpoints
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Tom Rothe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -55,6 +55,7 @@ files:
 - fixpoints.gemspec
 - lib/fixpoint.rb
 - lib/fixpoint_diff.rb
+- lib/fixpoint_test_helpers.rb
 - lib/fixpoints.rb
 - lib/fixpoints/version.rb
 - lib/incremental_fixpoint.rb