Fix tests by introducing DSL separating DDL, relations, and seeding

Before that, emerging dependencies between spec parts were hard to navigate: when you call  `container` it materializes the container meaning you won't be able to add new tables/relations to the container. It's a mystery to me how we've managed to continue without proper separation the stages so far. Finally, I've hit it pretty hard when fixing failing specs.

What this introduces are three DSL methods accepting blocks:
- setup_tables
- setup_relations
- seed
No setup_relations blocks are yielded before all setup_tables are run. seed blocks follow setup_relations.

These methods have an additional optional parameter for sequencing blocks within one stage:

```ruby
setup_tables(:base) {}  # called first
setup_tables(dep: :base) {} # depends on base, called second
setup_tables {} # no dependency provided, will be called last

```

Also, in a given spec you can use metadata to prevent seeding or declaring relations from a shared context:

```ruby
include 'users and tasks'

describe 'a block without seeding and relations', relations: false, seeds: false do
   ....
end

describe 'a block without seeding', seeds: false do
  ....
end
```

Author: flash-gordon

.rubocop.yml

@@ -51,6 +51,10 @@ Lint/EmptyClass:
   Exclude:
     - "spec/**/*.rb"
 
+Lint/NestedMethodDefinition:
+  Exclude:
+    - "spec/**/*.rb"
+
 Lint/RaiseException:
   Enabled: false
 
@@ -63,6 +67,8 @@ Lint/SuppressedException:
 
 Metrics/AbcSize:
   Max: 20
+  Exclude:
+    - "spec/**/*.rb"
 
 Metrics/BlockLength:
   Enabled: false
@@ -76,6 +82,8 @@ Metrics/CyclomaticComplexity:
 
 Metrics/MethodLength:
   Max: 22
+  Exclude:
+    - "spec/**/*.rb"
 
 Naming/FileName:
   Exclude:

lib/rom/sql/plugin/associates.rb

@@ -162,7 +162,7 @@ def associate(
           def with_association(name, opts = EMPTY_HASH)
             self.class.build(
               relation,
-              **options, associations: associations.merge(name => opts)
+              **options, associations: { **associations, name => opts }
             )
           end
         end

lib/rom/sql/schema/inferrer.rb

@@ -36,7 +36,7 @@ def call(schema, gateway)
           else
             infer_from_attributes(gateway, schema, **super)
           end
-        rescue Sequel::Error => e
+        rescue ::Sequel::Error => e
           on_error(schema.name, e)
           { **FALLBACK_SCHEMA, indexes: schema.indexes }
         end

spec/extensions/postgres/attribute/array_spec.rb

@@ -5,7 +5,7 @@
 
   include_context 'database setup'
 
-  before do
+  setup_relations do
     conf.relation(:pg_arrays) do
       schema(infer: true)
     end
@@ -16,7 +16,7 @@
   end
 
   context 'with a primitive type' do
-    before do
+    setup_tables do
       conn.create_table :pg_arrays do
         column :numbers, 'int[]'
       end
@@ -34,7 +34,7 @@
   end
 
   context 'with a custom json type' do
-    before do
+    setup_tables do
       conn.create_table :pg_arrays do
         column :meta, 'json[]'
       end

spec/extensions/postgres/attribute/range_spec.rb

@@ -3,27 +3,6 @@
 RSpec.describe 'ROM::SQL::Attribute', :postgres do
   include_context 'database setup'
 
-  def create_ranges_table(db_type, values)
-    conn.create_table :pg_ranges do
-      primary_key :id
-      text :name
-
-      send(db_type, :range)
-    end
-
-    conf.relation(:pg_ranges) do
-      schema(:pg_ranges, infer: true)
-    end
-
-    conf.commands(:pg_ranges) do
-      define(:create)
-    end
-
-    values.each do |key, value|
-      commands[:pg_ranges].create.(name: key.to_s, range: value)
-    end
-  end
-
   shared_examples 'range type' do
     let(:rel) { pg_ranges.select { [name] } }
 
@@ -106,10 +85,33 @@ def create_ranges_table(db_type, values)
     let(:pg_ranges) { relations[:pg_ranges] }
     let(:range_value) { ROM::SQL::Postgres::Values::Range }
 
-    before do
+    setup_tables do
       conn.extension(:pg_range)
       conn.drop_table?(:pg_ranges)
-      create_ranges_table(db_type, values)
+
+      ctx = self
+      conn.create_table :pg_ranges do
+        primary_key :id
+        text :name
+
+        send(ctx.db_type, :range)
+      end
+    end
+
+    setup_relations do
+      conf.relation(:pg_ranges) do
+        schema(:pg_ranges, infer: true)
+      end
+
+      conf.commands(:pg_ranges) do
+        define(:create)
+      end
+    end
+
+    seed do
+      values.each do |key, value|
+        commands[:pg_ranges].create.(name: key.to_s, range: value)
+      end
     end
 
     describe 'numrange' do

spec/extensions/postgres/attribute_spec.rb

@@ -3,10 +3,12 @@
 RSpec.describe 'ROM::SQL::Attribute', :postgres do
   include_context 'database setup'
 
-  before do
+  setup_tables do
     conn.drop_table?(:pg_people)
     conn.drop_table?(:people)
+  end
 
+  setup_relations do
     conf.relation(:people) do
       schema(:pg_people, infer: true)
     end
@@ -17,18 +19,22 @@
 
   %i[json jsonb].each do |type|
     describe "using arrays in #{type}" do
-      before do
+      setup_tables do
         conn.create_table :pg_people do
           primary_key :id
           String :name
           column :fields, type
         end
+      end
 
+      setup_relations do
         conf.commands(:people) do
           define(:create)
           define(:update)
         end
+      end
 
+      seed do
         create_person.(
           name: 'John Doe',
           fields: [
@@ -100,18 +106,22 @@
     next unless type == :jsonb
 
     describe "using maps in #{type}" do
-      before do
+      setup_tables do
         conn.create_table :pg_people do
           primary_key :id
           String :name
           column :data, type
         end
+      end
 
+      setup_relations do
         conf.commands(:people) do
           define(:create)
           define(:update)
         end
+      end
 
+      seed do
         create_person.(name: 'John Doe', data: { age: 30, height: 180 })
         create_person.(name: 'Jade Doe', data: { age: 25 })
       end
@@ -160,19 +170,23 @@
   end
 
   describe 'using array types' do
-    before do
+    setup_tables do
       conn.create_table :pg_people do
         primary_key :id
         String :name
         column :emails, 'text[]'
         column :bigids, 'bigint[]'
       end
+    end
 
+    setup_relations do
       conf.commands(:people) do
         define(:create)
         define(:update)
       end
+    end
 
+    seed do
       create_person.(name: 'John Doe', emails: %w[john@doe.com john@example.com], bigids: [84])
       create_person.(name: 'Jade Doe', emails: %w[jade@hotmail.com], bigids: [42])
     end
@@ -253,7 +267,7 @@
   end
 
   describe 'using ltree types' do
-    before do
+    setup_tables do
       conn.execute('create extension if not exists ltree')
 
       conn.create_table :pg_people do
@@ -262,12 +276,16 @@
         column :ltree_tags, :ltree
         column :parents_tags, 'ltree[]', default: []
       end
+    end
 
+    setup_relations do
       conf.commands(:people) do
         define(:create)
         define(:update)
       end
+    end
 
+    seed do
       create_person.(name: 'John Wilkson', ltree_tags: ltree('Bottom'), parents_tags: [ltree('Top'), ltree('Top.Building')])
       create_person.(name: 'John Wayne', ltree_tags: ltree('Bottom.Countries'), parents_tags: [ltree('Left'), ltree('Left.Parks')])
       create_person.(name: 'John Fake', ltree_tags: ltree('Bottom.Cities'), parents_tags: [ltree('Top.Building.EmpireState'), ltree('Top.Building.EmpireState.381')])

spec/extensions/postgres/integration_spec.rb

@@ -3,20 +3,22 @@
 RSpec.describe 'PostgreSQL extension', :postgres do
   include_context 'database setup'
 
-  before do
+  setup_tables do
     conn.drop_table?(:pg_people)
     conn.drop_table?(:people)
   end
 
   context 'with arrays' do
-    before do
+    setup_tables do
       conn.create_table :pg_people do
         primary_key :id
         String :name
         column :tags, 'text[]'
         column :allowed_subnets, 'cidr[]'
       end
+    end
 
+    setup_relations do
       conf.relation(:people) do
         schema(:pg_people, infer: true)
       end
@@ -85,13 +87,15 @@
   end
 
   context 'with jsonb' do
-    before do
+    setup_tables do
       conn.create_table :pg_people do
         primary_key :id
         String :name
         column :attributes, 'jsonb'
       end
+    end
 
+    setup_relations do
       conf.relation(:people) do
         schema(:pg_people, infer: true)
       end

spec/integration/associations/many_to_many/custom_fks_spec.rb

@@ -15,7 +15,7 @@
   let(:puzzle_solvers) { relations[:puzzle_solvers] }
 
   with_adapters do
-    before do
+    setup_tables do
       conn.create_table(:puzzles) do
         primary_key :id
         column :text, String, null: false
@@ -26,7 +26,9 @@
         foreign_key :puzzle_id, :puzzles, null: false
         primary_key [:solver_id, :puzzle_id]
       end
+    end
 
+    setup_relations do
       conf.relation(:puzzles) { schema(infer: true) }
 
       conf.relation(:puzzle_solvers) do
@@ -46,7 +48,9 @@
           end
         end
       end
+    end
 
+    seed do
       p1_id = relations[:puzzles].insert(text: 'P1')
       p2_id = relations[:puzzles].insert(text: 'P2')
       p3_id = relations[:puzzles].insert(text: 'P3')

spec/integration/associations/many_to_many/from_view_spec.rb

@@ -15,7 +15,7 @@
   let(:puzzle_solvers) { relations[:puzzle_solvers] }
 
   with_adapters do
-    before do
+    setup_tables do
       conn.create_table(:puzzles) do
         primary_key :id
         column :text, String, null: false
@@ -27,7 +27,9 @@
         foreign_key :puzzle_id, :puzzles, null: false
         primary_key [:user_id, :puzzle_id]
       end
+    end
 
+    setup_relations do
       conf.relation(:puzzles) do
         schema(infer: true)
 
@@ -54,7 +56,9 @@
           end
         end
       end
+    end
 
+    seed do
       p1_id = relations[:puzzles].insert(text: 'P1')
       p2_id = relations[:puzzles].insert(text: 'P2', solved: true)
       p3_id = relations[:puzzles].insert(text: 'P3')

spec/integration/associations/many_to_many/self_ref_spec.rb

@@ -16,7 +16,7 @@
   end
 
   with_adapters do
-    before do
+    setup_tables(hr: :db) do
       conn.create_table :employees do
         primary_key :id, Integer
         column :name, String
@@ -27,7 +27,9 @@
         foreign_key :manager_id, :employees
         foreign_key :participant_id, :employees
       end
+    end
 
+    setup_relations do
       conf.relation(:employees) do
         schema(:employees, infer: true) do
           associations do
@@ -46,17 +48,19 @@
       end
     end
 
+    seed do
+      jane = employees.insert(name: 'Jane')
+      fred = employees.insert(name: 'Fred')
+
+      positions.insert(manager_id: jane, participant_id: fred)
+    end
+
     after do
       conn.drop_table?(:positions)
       conn.drop_table?(:employees)
     end
 
     it 'preloads self-referenced tuples' do
-      jane = employees.insert(name: 'Jane')
-      fred = employees.insert(name: 'Fred')
-
-      positions.insert(manager_id: jane, participant_id: fred)
-
       expect(assoc.().to_a).to eql([{ id: 1, name: 'Jane', participant_id: 2 }])
     end
   end