test_data 0.2.2 → 0.3.2

data/example/Gemfile.lock

@@ -1,171 +1,194 @@
 PATH
   remote: ..
   specs:
-    test_data (0.2.2)
-      railties (~> 6.0)
+    test_data (0.3.2)
+      railties (>= 6.0, < 8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actioncable (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activejob (= 6.1.3.2)
-      activerecord (= 6.1.3.2)
-      activestorage (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actionmailbox (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       mail (>= 2.7.1)
-    actionmailer (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      actionview (= 6.1.3.2)
-      activejob (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.3.2)
-      actionview (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
-      rack (~> 2.0, >= 2.0.9)
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activerecord (= 6.1.3.2)
-      activestorage (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actiontext (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (6.1.3.2)
-      activesupport (= 6.1.3.2)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.3.2)
-      activesupport (= 6.1.3.2)
+    activejob (7.0.2.3)
+      activesupport (= 7.0.2.3)
       globalid (>= 0.3.6)
-    activemodel (6.1.3.2)
-      activesupport (= 6.1.3.2)
-    activerecord (6.1.3.2)
-      activemodel (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
-    activestorage (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activejob (= 6.1.3.2)
-      activerecord (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
-      marcel (~> 1.0.0)
-      mini_mime (~> 1.0.2)
-    activesupport (6.1.3.2)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activestorage (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
-    bootsnap (1.7.5)
-      msgpack (~> 1.0)
+    bootsnap (1.11.1)
+      msgpack (~> 1.2)
     builder (3.2.4)
-    capybara (3.35.3)
+    capybara (3.36.0)
       addressable
+      matrix
       mini_mime (>= 0.1.3)
       nokogiri (~> 1.8)
       rack (>= 1.6.0)
       rack-test (>= 0.6.3)
       regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
-    childprocess (3.0.0)
+    childprocess (4.1.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
+    digest (3.1.0)
     erubi (1.10.0)
-    factory_bot (6.2.0)
+    factory_bot (6.2.1)
       activesupport (>= 5.0.0)
     factory_bot_rails (6.2.0)
       factory_bot (~> 6.2.0)
       railties (>= 5.0.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.10)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.10.0)
+    loofah (2.16.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.1)
+    marcel (1.0.2)
+    matrix (0.4.2)
     method_source (1.0.0)
-    mini_mime (1.0.3)
-    mini_portile2 (2.5.3)
-    minitest (5.14.4)
-    msgpack (1.4.2)
-    nio4r (2.5.7)
-    nokogiri (1.11.7)
-      mini_portile2 (~> 2.5.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.15.0)
+    msgpack (1.5.1)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     noncommittal (0.2.0)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    parallel (1.22.1)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
-    pg (1.2.3)
+    pg (1.3.5)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-rails (0.3.9)
       pry (>= 0.10.4)
     public_suffix (4.0.6)
-    puma (5.3.2)
+    puma (5.6.4)
       nio4r (~> 2.0)
-    racc (1.5.2)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.1.3.2)
-      actioncable (= 6.1.3.2)
-      actionmailbox (= 6.1.3.2)
-      actionmailer (= 6.1.3.2)
-      actionpack (= 6.1.3.2)
-      actiontext (= 6.1.3.2)
-      actionview (= 6.1.3.2)
-      activejob (= 6.1.3.2)
-      activemodel (= 6.1.3.2)
-      activerecord (= 6.1.3.2)
-      activestorage (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    rails (7.0.2.3)
+      actioncable (= 7.0.2.3)
+      actionmailbox (= 7.0.2.3)
+      actionmailer (= 7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actiontext (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       bundler (>= 1.15.0)
-      railties (= 6.1.3.2)
-      sprockets-rails (>= 2.0.0)
+      railties (= 7.0.2.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.1.3.2)
-      actionpack (= 6.1.3.2)
-      activesupport (= 6.1.3.2)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
       method_source
-      rake (>= 0.8.7)
+      rake (>= 12.2)
       thor (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
     rexml (3.2.5)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-rails (5.0.1)
+      rspec-support (~> 3.11.0)
+    rspec-rails (5.1.1)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
@@ -173,50 +196,46 @@ GEM
       rspec-expectations (~> 3.10)
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
-    rspec-support (3.10.2)
-    rubocop (1.14.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.1)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.5.0, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.11.2)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    rubyzip (2.3.0)
-    selenium-webdriver (3.142.7)
-      childprocess (>= 0.5, < 4.0)
+    rubyzip (2.3.2)
+    selenium-webdriver (4.1.0)
+      childprocess (>= 0.5, < 5.0)
+      rexml (~> 3.2, >= 3.2.5)
       rubyzip (>= 1.2.2)
-    sprockets (4.0.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    standard (1.1.1)
-      rubocop (= 1.14.0)
-      rubocop-performance (= 1.11.2)
-    thor (1.1.0)
+    standard (1.9.1)
+      rubocop (= 1.26.1)
+      rubocop-performance (= 1.13.3)
+    strscan (3.0.1)
+    thor (1.2.1)
+    timeout (0.2.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    webdrivers (4.6.0)
+    unicode-display_width (2.1.0)
+    webdrivers (5.0.0)
       nokogiri (~> 1.6)
       rubyzip (>= 1.3.0)
-      selenium-webdriver (>= 3.0, < 4.0)
+      selenium-webdriver (~> 4.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     xpath (3.2.0)
       nokogiri (~> 1.8)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -237,4 +256,4 @@ DEPENDENCIES
   webdrivers
 
 BUNDLED WITH
-   2.2.15
+   2.3.10

data/lib/generators/test_data/webpacker_yaml_generator.rb

@@ -4,22 +4,36 @@ require_relative "../../test_data/generator_support"
 module TestData
   class WebpackerYamlGenerator < Rails::Generators::Base
     AFTER_DEVELOPMENT_WEBPACK_STANZA_REGEX = /^development:/
+    AFTER_TEST_DATA_WEBPACK_STANZA_REGEX = /^test_data:\n  <<: \*development/
 
     def call
-      if Configurators::WebpackerYaml.new.verify.looks_good?
-        TestData.log.debug "'test_data' section not needed in config/webpacker.yml"
+      configurator = Configurators::WebpackerYaml.new
+      webpacker_config = Wrap::WebpackerConfig.new
+
+      if configurator.verify.looks_good?
+        TestData.log.debug "'test_data' section looks good in `config/webpacker.yml'"
       else
-        inject_into_file "config/webpacker.yml", after: AFTER_DEVELOPMENT_WEBPACK_STANZA_REGEX do
-          " &development"
-        end
-        inject_into_file "config/webpacker.yml", before: BEFORE_TEST_STANZA_REGEX do
-          <<~YAML
+        unless webpacker_config.user_config.key?("test_data")
+          inject_into_file "config/webpacker.yml", after: AFTER_DEVELOPMENT_WEBPACK_STANZA_REGEX do
+            " &development"
+          end
+          inject_into_file "config/webpacker.yml", before: BEFORE_TEST_STANZA_REGEX do
+            <<~YAML
 
-            # Used in conjunction with the test_data gem
-            test_data:
-              <<: *development
+              # Used in conjunction with the test_data gem
+              test_data:
+                <<: *development
+
+            YAML
+          end
+        end
 
-          YAML
+        if (missing_entries = webpacker_config.required_entries_missing_from_test_data_config)
+          inject_into_file "config/webpacker.yml", after: /^test_data:\n/ do
+            missing_entries.map { |(key, val)|
+              "  #{key}: #{val.inspect}\n"
+            }.join
+          end
         end
       end
     end

data/lib/test_data/configurators/webpacker_yaml.rb

@@ -3,21 +3,23 @@ module TestData
     class WebpackerYaml
       def initialize
         @generator = WebpackerYamlGenerator.new
-        @config = TestData.config
+        @webpacker_config = Wrap::WebpackerConfig.new
       end
 
       def verify
-        path = "config/webpacker.yml"
-        pathname = Pathname.new("#{@config.pwd}/#{path}")
-        return ConfigurationVerification.new(looks_good?: true) unless pathname.readable?
-        yaml = load_yaml(pathname)
-        if yaml.nil?
+        if @webpacker_config.no_user_config_exists?
+          ConfigurationVerification.new(looks_good?: true)
+        elsif (user_config = @webpacker_config.user_config).nil?
+          ConfigurationVerification.new(problems: [
+            "`#{@webpacker_config.relative_user_config_path}' is not valid YAML"
+          ])
+        elsif !user_config.key?("test_data")
           ConfigurationVerification.new(problems: [
-            "'#{path}' is not valid YAML"
+            "`#{@webpacker_config.relative_user_config_path}' does not contain a `test_data' section"
           ])
-        elsif !yaml.key?("test_data")
+        elsif (entries = @webpacker_config.required_entries_missing_from_test_data_config)
           ConfigurationVerification.new(problems: [
-            "'#{path}' does not contain a 'test_data' section"
+            "`#{@webpacker_config.relative_user_config_path}' is missing #{"entry".pluralize(entries.size)} #{entries.map { |(k, v)| "`#{k}' (default: #{v.inspect})" }.join(", ")} in its `test_data' section"
           ])
         else
           ConfigurationVerification.new(looks_good?: true)
@@ -27,13 +29,6 @@ module TestData
       def configure
         @generator.call
       end
-
-      private
-
-      def load_yaml(pathname)
-        YAML.load_file(pathname)
-      rescue
-      end
     end
   end
 end

data/lib/test_data/detects_database_existence.rb

@@ -0,0 +1,19 @@
+module TestData
+  class DetectsDatabaseExistence
+    def initialize
+      @config = TestData.config
+    end
+
+    def call
+      rows = ActiveRecord::Base.connection.execute <<~SQL
+        select datname database_name
+        from pg_catalog.pg_database
+      SQL
+      rows.any? { |row|
+        row["database_name"] == @config.database_name
+      }
+    rescue ActiveRecord::NoDatabaseError
+      false
+    end
+  end
+end

data/lib/test_data/determines_databases_associated_dump_time.rb

@@ -0,0 +1,13 @@
+module TestData
+  class DeterminesDatabasesAssociatedDumpTime
+    def call
+      if (last_dumped_at = ActiveRecord::InternalMetadata.find_by(key: "test_data:last_dumped_at")&.value)
+        Time.parse(last_dumped_at)
+      end
+    rescue ActiveRecord::StatementInvalid
+      # This will be raised if the DB exists but hasn't been migrated/schema-loaded
+    rescue ActiveRecord::NoDatabaseError
+      # This will be raised if the DB doesn't exist yet, which we don't need to warn about
+    end
+  end
+end

data/lib/test_data/determines_when_sql_dump_was_made.rb

@@ -0,0 +1,24 @@
+module TestData
+  class DeterminesWhenSqlDumpWasMade
+    def initialize
+      @config = TestData.config
+    end
+
+    def call
+      if (last_dumped_at = find_last_dumped_value)
+        Time.zone.parse(last_dumped_at)
+      end
+    end
+
+    private
+
+    def find_last_dumped_value
+      return unless File.exist?(@config.non_test_data_dump_path)
+      File.open(@config.non_test_data_dump_path, "r").each_line do |line|
+        if (match = line.match(/INSERT INTO public\.ar_internal_metadata VALUES \('test_data:last_dumped_at', '([^']*)'/))
+          return match[1]
+        end
+      end
+    end
+  end
+end

data/lib/test_data/dumps_database.rb

@@ -6,9 +6,12 @@ module TestData
   class DumpsDatabase
     def initialize
       @config = TestData.config
+      @records_dump_metadata = RecordsDumpMetadata.new
     end
 
     def call
+      @records_dump_metadata.call
+
       dump(
         type: :schema,
         database_name: @config.database_name,

data/lib/test_data/railtie.rb

@@ -8,5 +8,9 @@ module TestData
     rake_tasks do
       load Pathname.new(__dir__).join("rake.rb")
     end
+
+    initializer "test_data.validate_data_up_to_date" do
+      WarnsIfDumpIsNewerThanDatabase.new.call
+    end
   end
 end

data/lib/test_data/rake.rb

@@ -3,24 +3,25 @@ def wrong_env?
 end
 
 def run_in_test_data_env(task_name)
-  command = "RAILS_ENV=test_data #{Rails.root}/bin/rake #{task_name}"
+  command = "RAILS_ENV=test_data #{Rails.root}/bin/rake #{task_name} --trace"
   unless system(command)
     fail "An error ocurred when running: #{command}"
   end
 end
 
 def create_database_or_else_blow_up_if_its_not_empty!
+  raise unless Rails.env.test_data?
+
+  unless TestData::DetectsDatabaseExistence.new.call
+    Rake::Task["test_data:create_database"].invoke
+  end
+
   unless TestData::DetectsDatabaseEmptiness.new.empty?
     raise TestData::Error.new("Database '#{TestData.config.database_name}' already exists and is not empty. To re-initialize it, drop it first (e.g. `rake test_data:drop_database`)")
   end
-rescue TestData::Error => e
-  raise e
-rescue
-  # Only (anticipated) cause for raise here is DB did not exist
-  Rake::Task["test_data:create_database"].invoke
 end
 
-desc "Verifies test_data environment looks good"
+desc "Verifies that the test_data environment looks good"
 task "test_data:verify_config" do
   TestData.log.with_plain_writer do
     config = TestData::VerifiesConfiguration.new.call
@@ -34,12 +35,12 @@ task "test_data:verify_config" do
   end
 end
 
-desc "Install default configuration files and snippets"
+desc "Installs default configuration files and snippets"
 task "test_data:configure" do
   TestData::InstallsConfiguration.new.call
 end
 
-desc "Initialize test_data's interactive database"
+desc "Initializes test_data's interactive database"
 task "test_data:initialize" => ["test_data:verify_config", :environment] do
   next run_in_test_data_env("test_data:initialize") if wrong_env?
 
@@ -59,7 +60,36 @@ task "test_data:initialize" => ["test_data:verify_config", :environment] do
   MSG
 end
 
-desc "Initialize test_data Rails environment & configure database"
+desc "Re-initializes test_data's interactive database (by dropping and reloading it)"
+task "test_data:reinitialize" => ["test_data:verify_config", :environment] do
+  next run_in_test_data_env("test_data:reinitialize") if wrong_env?
+
+  # Take caution only if the test_data database exists
+  if TestData::DetectsDatabaseExistence.new.call
+    TestData::WarnsIfDatabaseIsNewerThanDump.new.call
+
+    unless ENV["TEST_DATA_CONFIRM"].present?
+      confirmed = if $stdin.isatty
+        puts "This will DROP test_data database '#{TestData.config.database_name}'. Are you sure you want to re-initialize it? [yN]"
+        $stdin.gets.chomp.downcase.start_with?("y")
+      else
+        puts "'#{TestData.config.database_name}' exists. Set TEST_DATA_CONFIRM=true to drop the database and re-initialize it."
+        false
+      end
+
+      unless confirmed
+        puts "Exiting without making any changes"
+        exit 1
+      end
+    end
+
+    Rake::Task["test_data:drop_database"].invoke
+  end
+
+  Rake::Task["test_data:initialize"].invoke
+end
+
+desc "Initializes test_data Rails environment & configure database"
 task "test_data:install" => ["test_data:configure", "test_data:initialize"]
 
 desc "Dumps the interactive test_data database"

data/lib/test_data/records_dump_metadata.rb

@@ -0,0 +1,9 @@
+module TestData
+  class RecordsDumpMetadata
+    def call
+      ActiveRecord::InternalMetadata
+        .find_or_initialize_by(key: "test_data:last_dumped_at")
+        .update!(value: Time.now.utc.inspect)
+    end
+  end
+end

data/lib/test_data/version.rb

@@ -1,3 +1,3 @@
 module TestData
-  VERSION = "0.2.2"
+  VERSION = "0.3.2"
 end