fixpoints 0.2.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ef08ea7ece7fead58adea51cc099a9fdf2b54db15af1b54406a4123bafd9f58
-  data.tar.gz: 3adb38547c45cc8bcaf2c105ba22a60c5eceb1caeeb1de423c4a27524cf42e20
+  metadata.gz: 4a12beeaa3e9a600b6bafeb91a4ed10e769dd24c5e179634e71044f8b91cff4f
+  data.tar.gz: 7156873029ee1e27e9e5487c43fccdd929078eb83de1b67e87abc11e73cc4d08
 SHA512:
-  metadata.gz: b2de749871dc8108723bb6ff7187526ed30b4a4d920fa8562bb611e34373a2666f2053ab247d3f6280a6968b161e4057fb4dfae6732989a8feb215838b15774f
-  data.tar.gz: 9e6c9dd9d176073a3a930e3228ec10dd0f38a5ab811c9aba1fa03642401ee1a8c6ad47a117f0c649288af71acff1028c2f14007b1929ccc3bc88bbf20c4610bb
+  metadata.gz: eaa831ed5ad889e9b1d18071ccf721dfc7973efe1a86f7fc9aea02f5aab13616c68eddff8a50d8a6e07c1ff8ad59a386b7d5f8cdf0ac4f67470ec918d7293ca6
+  data.tar.gz: ab9cfcca94232a87eb09d02a158756eaef69edf92468af02abea478638ad9134523ce4e564c9940f4c62fa5ab8d1b2855725970dd54b527856c3ee3bf06a95ba

data/Gemfile.lock

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

data/README.md

@@ -123,6 +123,16 @@ to specify the database connection to use.
   end
 ```
 
+**Exclude Tables** If a database contains tables that are irrelevant to your tests, you can use the optional `exclude_tables` parameter
+to specify a set of tables to exclude from the fixpoint.
+
+```ruby
+  it 'excludes versions' do
+    store_fixpoint_unless_present :registered_user, exclude_tables: ['versions']
+    # ...
+  end
+```
+
 ## Limitations & Known issues
 
 - The records in tables are ordered by their id.

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(conn)
-      new(read_database_records(conn))
+    def from_database(conn, exclude_tables: [])
+      new(read_database_records(conn, exclude_tables: exclude_tables))
     end
 
     def remove(fixname)
@@ -81,11 +81,11 @@ class Fixpoint
       File.join(spec_path, FIXPOINT_FOLDER)
     end
 
-    def read_database_records(conn)
+    def read_database_records(conn, exclude_tables: [])
       # 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) }
-
+      excluded_tables = TABLES_TO_SKIP + exclude_tables
+      tables.reject! { |table_name| excluded_tables.include?(table_name) }
       tables.each_with_object({}) do |table_name, acc|
         result = conn.select_all("SELECT * FROM #{conn.quote_table_name(table_name)}")
         next if result.count.zero?

data/lib/fixpoint_test_helpers.rb

@@ -10,16 +10,17 @@ module FixpointTestHelpers
   # 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'])
+  # +exclude_tables+ a list of tables which should be ignored when storing a fixpoint (e.g. ['versions'])
   # +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, connection: default_connection)
+  def compare_fixpoint(fixname, ignored_columns=[:updated_at, :created_at], tables_to_compare: :all, exclude_tables: [], 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, connection: connection)
+        store_fixpoint(fixname, parent_fixname, connection: connection, exclude_tables: exclude_tables)
         pending("Fixpoint \"#{fixname}\" did not exist yet. Skipping comparison, but created fixpoint from database. Try re-running the test.")
         fail
       else
@@ -27,15 +28,14 @@ module FixpointTestHelpers
       end
     end
 
-    database_fp = IncrementalFixpoint.from_database(nil, connection)
+    database_fp = IncrementalFixpoint.from_database(nil, connection, exclude_tables: exclude_tables)
     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)
+      db_records = database_fp.records_for_table(table_name, ignored_columns) || []
+      fp_records = fixpoint_fp.records_for_table(table_name, ignored_columns) || []
 
-      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
@@ -43,15 +43,15 @@ 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, connection: default_connection)
-    store_fixpoint(fixname, parent_fixname, connection: connection) unless IncrementalFixpoint.exists?(fixname)
+  def store_fixpoint_unless_present(fixname, parent_fixname = nil, connection: default_connection, exclude_tables: [])
+    store_fixpoint(fixname, parent_fixname, connection: connection, exclude_tables: exclude_tables) 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, connection: default_connection)
+  def store_fixpoint(fixname, parent_fixname = nil, connection: default_connection, exclude_tables: [])
     parent_fixname = @last_restored if parent_fixname == :last_restored
-    IncrementalFixpoint.from_database(parent_fixname, connection).save_to_file(fixname)
+    IncrementalFixpoint.from_database(parent_fixname, connection, exclude_tables: exclude_tables).save_to_file(fixname)
   end
 
   private def default_connection

data/lib/fixpoints/version.rb

@@ -1,3 +1,3 @@
 module Fixpoints
-  VERSION = "0.2.3"
+  VERSION = "0.2.6"
 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, conn)
-    return super(conn) if parent_fixname.nil?
+  def self.from_database(parent_fixname=nil, conn, exclude_tables: [])
+    return super(conn, exclude_tables: exclude_tables) if parent_fixname.nil?
 
     parent = from_file(parent_fixname)
-    changes_in_tables = FixpointDiff.extract_changes(parent.records_in_tables, read_database_records(conn))
+    changes_in_tables = FixpointDiff.extract_changes(parent.records_in_tables, read_database_records(conn, exclude_tables: exclude_tables))
     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.2.3
+  version: 0.2.6
 platform: ruby
 authors:
 - Tom Rothe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Don't discard the database state at the end of your test. Use it!