prodder 1.8.3 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7709fb16a2203aee7eee5e75771b3439c5d086490e74fb8be8f5327eb21540ce
-  data.tar.gz: a9d397b82cfb40165459ee7a02b221a1cbc43a50e7ad70d6787b0057f61221b6
+  metadata.gz: 16388fe0003353484889449561b321aeacdbf4c7fbac924695cfa6d147586cc7
+  data.tar.gz: 44da9a1bdd4ad9a9d1443e61a8e98bd8123f3a323b9cd6fc6a9c7b4979335c22
 SHA512:
-  metadata.gz: 31168254cb004ace7e020bfd8957b4e6a6a8d50432706b6eef7f1ab32bfaa6d85912fecb855129fc03dacab34175986d05e45ed8a26d00773715ce4f47f2f7b9
-  data.tar.gz: 863da359bccf237b5479a6bca29446751841d96469ec68040a10722390ab88d33430b49035f8bcda18baef85981522fdffd8a1307724a87bd027d40d20b8127b
+  metadata.gz: 788a35ce10f96838d34349988d704d8f39fe3bfa42979938b7ec9a2e0a655fb758f62045885a961f680fcb6e6b5cee64d99c48aef3512f3f120467508fc9ed26
+  data.tar.gz: ee2a63269aeebd1cc3036be44558e9ff4aac5e1d38ce6aa436d71fdd3e863dfe65fa18335131b50aa87315bf08ebd2013dd80edb89c91dfd97394962cdb633a9

data/Dockerfile

@@ -1,4 +1,4 @@
-ARG RUBY_VERSION=3.0
+ARG RUBY_VERSION=3.3
 
 FROM ruby:${RUBY_VERSION}
 

data/Gemfile

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
+gemspec
+
 gem 'deject'
 gem 'thor'
 gem 'cocaine'
@@ -10,7 +12,7 @@ group :development, :test do
   gem 'pry'
   gem 'pry-remote'
   gem 'rspec'
-  gem 'cucumber', '< 3' # FIXME
-  gem 'aruba', '~> 0.5.0'
+  gem 'cucumber'
+  gem 'aruba'
   gem 'pg'
 end

data/Gemfile.lock

@@ -0,0 +1,122 @@
+PATH
+  remote: .
+  specs:
+    prodder (1.8.3)
+      deject
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (2.3.3)
+      bundler (>= 1.17)
+      contracts (>= 0.16.0, < 0.18.0)
+      cucumber (>= 8.0, < 11.0)
+      rspec-expectations (>= 3.4, < 5.0)
+      thor (~> 1.0)
+    base64 (0.3.0)
+    benzo (2.1.0)
+      cocaine (~> 0.5.8)
+    bigdecimal (3.3.1)
+    builder (3.3.0)
+    climate_control (0.2.0)
+    cocaine (0.5.8)
+      climate_control (>= 0.0.3, < 1.0)
+    coderay (1.1.3)
+    contracts (0.17.2)
+    cucumber (10.1.1)
+      base64 (~> 0.2)
+      builder (~> 3.2)
+      cucumber-ci-environment (> 9, < 11)
+      cucumber-core (> 15, < 17)
+      cucumber-cucumber-expressions (> 17, < 19)
+      cucumber-html-formatter (> 20.3, < 22)
+      diff-lcs (~> 1.5)
+      logger (~> 1.6)
+      mini_mime (~> 1.1)
+      multi_test (~> 1.1)
+      sys-uname (~> 1.3)
+    cucumber-ci-environment (10.0.1)
+    cucumber-core (15.3.0)
+      cucumber-gherkin (> 27, < 35)
+      cucumber-messages (> 26, < 30)
+      cucumber-tag-expressions (> 5, < 9)
+    cucumber-cucumber-expressions (18.0.1)
+      bigdecimal
+    cucumber-gherkin (34.0.0)
+      cucumber-messages (> 25, < 29)
+    cucumber-html-formatter (21.15.1)
+      cucumber-messages (> 19, < 28)
+    cucumber-messages (27.2.0)
+    cucumber-tag-expressions (8.1.0)
+    deject (0.2.3)
+    diff-lcs (1.6.2)
+    ffi (1.17.2)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    logger (1.7.0)
+    memoist3 (1.0.0)
+    method_source (1.1.0)
+    mini_mime (1.1.5)
+    multi_test (1.1.0)
+    pg (1.6.2)
+    pg (1.6.2-aarch64-linux)
+    pg (1.6.2-aarch64-linux-musl)
+    pg (1.6.2-arm64-darwin)
+    pg (1.6.2-x86_64-darwin)
+    pg (1.6.2-x86_64-linux)
+    pg (1.6.2-x86_64-linux-musl)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rake (13.3.1)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    slop (3.6.0)
+    sys-uname (1.4.1)
+      ffi (~> 1.1)
+      memoist3 (~> 1.0.0)
+    thor (1.4.0)
+
+PLATFORMS
+  aarch64-linux
+  aarch64-linux-musl
+  arm64-darwin
+  ruby
+  x86_64-darwin
+  x86_64-linux
+  x86_64-linux-musl
+
+DEPENDENCIES
+  aruba
+  benzo
+  cocaine
+  cucumber
+  deject
+  pg
+  prodder!
+  pry
+  pry-remote
+  rake
+  rspec
+  thor
+
+BUNDLED WITH
+  4.0.1

data/README.md

@@ -1,53 +1,111 @@
 
 # Prodder
 
+[![Ruby](https://img.shields.io/badge/ruby-2.7%2B-ruby.svg)](https://www.ruby-lang.org)
+[![PostgreSQL](https://img.shields.io/badge/postgresql-15%2B-blue.svg)](https://www.postgresql.org)
+
 A tool to maintain and load your Rails application's database structure, seed
 table contents, permissions and database settings based on its migration history
 and the current state in production databases.
 
-In short: `db:reset db:migrate`
-
-1. Your project maintains `db/structure.sql`, `db/seeds.sql`, and optional
-   `db/quality_checks.sql` and `db/permissions.sql` files as it sees fit (ie, by using `prodder` as a script to dump
-   production and push it to your git repository).
-2. Make sure `db/seeds.sql` includes the `schema_migrations` table.
-3. Only new migrations will be run against prod's structure using its seed table contents.
-4. Once a migration has been deployed, it should result in `db/structure.sql` and
-   `db/quality_checks.sql` files being modified, and any new seed data being added to
-   `db/seeds.sql` -- including the new entry in `schema_migrations`.
-5. That migration never needs to be run in development again. Feel free to `rm`.
-6. Any application related permission changes will result in `db/permissions.sql` being modified.
-
-## Replacing `rake db:*`
-`prodder` can be included as a railtie in your application to automatically
-replace many of Rails' `db:*` tasks. The only prerequisites to its usage are
-the existence of `db/structure.sql`, `db/seeds.sql` with at least the
-`schema_migrations` table contents included. Optional `db/quality_checks.sql` and `db/permissions.sql`
-will be loaded after seeding, which can be helpful if you wish to seed the database
-prior to enforcing foreign key constraints and if you want to develop in an environment
-with the same permissions setup as production.
+**In short:** Synchronize your development database with production structure without re-running all migrations.
+
+## Why Prodder?
+
+Traditional Rails development requires running all migrations from scratch, which:
+
+- ❌ Becomes slow as your migration history grows
+- ❌ Can fail if old migrations are incompatible with current code
+- ❌ Doesn't reflect actual production database state
+
+Prodder solves this by:
+
+- ✅ Loading production database structure directly
+- ✅ Running only new migrations not yet deployed to production
+- ✅ Maintaining permissions and quality checks from production
+- ✅ Automatically syncing structure files from production databases
+
+## Requirements
+
+- **Ruby 2.7+** - This gem requires Ruby 2.7.0 or later
+- **Bundler 2.0+** - For dependency management
+- **PostgreSQL 15+** - Requires PostgreSQL 15.0 or later
+
+**Note:** Support for Ruby 2.6 and PostgreSQL versions older than 15 has been removed as of the latest version. If you need to use older versions, please use a previous version of this gem.
+
+## Overview
+
+Prodder follows a simple workflow:
+
+1. **Maintain structure files**: Your project keeps `db/structure.sql`, `db/seeds.sql`, and optionally `db/quality_checks.sql` and `db/permissions.sql` in version control.
+
+2. **Include migrations table**: Ensure `db/seeds.sql` includes the `schema_migrations` table from production.
+
+3. **Run new migrations only**: Only migrations not yet in production's `schema_migrations` table will run locally.
+
+4. **Update structure files**: After deploying a migration to production, update your structure files by running `prodder dump` against production.
+
+5. **Delete old migrations**: Once a migration is deployed and the structure files are updated, the migration file can be safely removed.
+
+6. **Track permissions**: Application permission changes are captured in `db/permissions.sql` for consistent development environments.
+
+### The Prodder Workflow
+
+```
+Production DB → prodder dump → db/*.sql files → Git → Development
+                                                        ↓
+                                              db:reset + new migrations
+```
+
+## Replacing `rake db:*` Tasks
+
+Prodder can be included as a Railtie in your Rails application to automatically
+replace many of Rails' `db:*` tasks with versions that work with production-sourced
+structure files.
+
+### Prerequisites
+
+- `db/structure.sql` - Base database structure
+- `db/seeds.sql` - Seed data including `schema_migrations` table
+- `db/quality_checks.sql` (optional) - Foreign keys and constraints
+- `db/permissions.sql` (optional) - Database permissions for role-based access
 
 ### Installation
 
-In your Gemfile:
+Add to your Gemfile:
 
 ```ruby
 gem 'prodder', require: 'prodder/railtie'
 ```
 
-It doesn't really matter, but for sanity's sake, you should set your `schema_format`
-to `:sql`:
+Configure Rails to use SQL schema format:
 
 ```ruby
 # config/application.rb
-module Whatever
-  class Application
+module YourApp
+  class Application < Rails::Application
     config.active_record.schema_format = :sql
   end
 end
 ```
 
+### Basic Usage
+
+Once installed, use these commands:
+
+```bash
+# Recreate database from structure and seed files
+bundle exec rake db:reset
+
+# Run only new migrations (those not in production's schema_migrations)
+bundle exec rake db:migrate
+
+# The typical development workflow
+bundle exec rake db:reset db:migrate
+```
+
 If you want to work with permissions setup like production:
+
 ```ruby
 # config/database.yml
 
@@ -93,49 +151,48 @@ Things that really matter:
    does not make sense to restore permissions in your environment if you're just going to run everything as a single,
    most likely superuser.
 
-
 ### Details
 
 This will remove the `db:*` tasks:
 
-* `db:_dump`: an internal task used by rails to dump the schema after migrations. Obsolete.
-* `db:drop:*`
-* `db:create:*`
-* `db:migrate`
-* `db:migrate:reset`
-* `db:migrate:up`
-* `db:migrate:down`
-* `db:fixtures:.*`
-* `db:abort_if_pending_migrations`
-* `db:purge:*`
-* `db:charset`
-* `db:collation`
-* `db:rollback`
-* `db:version`
-* `db:forward`
-* `db:reset`
-* `db:schema:*`
-* `db:seed`
-* `db:setup`
-* `db:structure:*`
-* `db:test:*`
-* `test:prepare`: Rails 4.1 added this task to auto-maintain the test DB schema.
+- `db:_dump`: an internal task used by rails to dump the schema after migrations. Obsolete.
+- `db:drop:*`
+- `db:create:*`
+- `db:migrate`
+- `db:migrate:reset`
+- `db:migrate:up`
+- `db:migrate:down`
+- `db:fixtures:.*`
+- `db:abort_if_pending_migrations`
+- `db:purge:*`
+- `db:charset`
+- `db:collation`
+- `db:rollback`
+- `db:version`
+- `db:forward`
+- `db:reset`
+- `db:schema:*`
+- `db:seed`
+- `db:setup`
+- `db:structure:*`
+- `db:test:*`
+- `test:prepare`: Rails 4.1 added this task to auto-maintain the test DB schema.
 
 And reimplement only the following:
 
-* `db:structure:load`: Load the contents of `db/structure.sql` into the database of your current environment.
-* `db:seed`: Load `db/seeds.sql` into the database of your current environment.
-* `db:quality_check`: Load `db/quality_checks.sql` into the database of your current environment, if present.
-* `db:reset`: db:drop db:setup
-* `db:settings`: Load the contents of `db/settings.sql` into the database of your current environment.
-* `db:setup`: db:create db:structure:load db:seed db:quality_check db:settings
-* `db:test:prepare`: RAILS_ENV=test db:reset db:migrate
-* `db:test:clone_structure`: RAILS_ENV=test db:reset db:migrate
-* `test:prepare`: db:test:prepare
-* `db:drop`: Drop database as superuser
-* `db:create`:  Create database as `superuser` and transfer ownership to `migration_user`
-* `db:migrate:*`, `db:rollback` Run migrations up/down as `migration_user`
-* `db:purge:*, db:charset, db:collation, db:version, db:forward, db:rollback, db:abort_if_pending_migrations` as
+- `db:structure:load`: Load the contents of `db/structure.sql` into the database of your current environment.
+- `db:seed`: Load `db/seeds.sql` into the database of your current environment.
+- `db:quality_check`: Load `db/quality_checks.sql` into the database of your current environment, if present.
+- `db:reset`: db:drop db:setup
+- `db:settings`: Load the contents of `db/settings.sql` into the database of your current environment.
+- `db:setup`: db:create db:structure:load db:seed db:quality_check db:settings
+- `db:test:prepare`: RAILS_ENV=test db:reset db:migrate
+- `db:test:clone_structure`: RAILS_ENV=test db:reset db:migrate
+- `test:prepare`: db:test:prepare
+- `db:drop`: Drop database as superuser
+- `db:create`:  Create database as `superuser` and transfer ownership to `migration_user`
+- `db:migrate:*`, `db:rollback` Run migrations up/down as `migration_user`
+- `db:purge:*, db:charset, db:collation, db:version, db:forward, db:rollback, db:abort_if_pending_migrations` as
   appropriate users.
 
 See [lib/prodder/prodder.rake](lib/prodder/prodder.rake)
@@ -144,10 +201,40 @@ for more info.
 This is likely to cause issues across Rails versions. No other choice really. It
 has been used in anger on Rails 3.2.x and Rails 4.1.x.
 
-Confirmed working versions of Postgres:
+## Development and Testing
+
+### Ruby Version
+
+This project requires Ruby 2.7+ for gem usage, though development is done on Ruby 3.3+. The development Ruby version is specified in `.ruby-version` and minimum required version in the gemspec file.
+
+### Testing Frameworks
+
+This project uses the following testing frameworks:
+
+- **RSpec 3.13+** for unit tests
+- **Cucumber 10.x** for feature tests (upgraded from 2.x)
+- **Aruba 2.x** for CLI testing (upgraded from 0.5.x)
+
+### Running Tests
+
+```bash
+# Run RSpec tests
+bundle exec rspec
+
+# Run Cucumber features
+bundle exec cucumber
+
+# Run all tests
+bundle exec rspec && bundle exec cucumber
+```
+
+### Supported PostgreSQL Versions
+
+This gem requires PostgreSQL 15.0 or later. Tested and confirmed working on:
 
-* 9.1.11+
-* 9.2.6+
+- PostgreSQL 15.x
+- PostgreSQL 16.x
+- PostgreSQL 17.x
 
 ## Using prodder to maintain `db/*` files
 
@@ -208,7 +295,7 @@ store:
 ### Quality Checks
 
 In some cases, such as foreign key dependencies and triggers, you may wish to defer
-loading constraints on your tables until _after_ your seed data has been loaded.
+loading constraints on your tables until *after* your seed data has been loaded.
 `prodder` treats the presence of a `quality_check_file` key in the configuration
 as an indication that it should split `structure_file` into those statements which
 create the base structure, and put the constraints into the `quality_check_file`.
@@ -257,19 +344,20 @@ $ prodder push -c prodder.yml
 
 ## TODO
 
-* Log activity as it is performed.
-* Support tracking a particular branch instead of master.
-* Support specifying the options to pass to each pg_dump form.
-* Select dumping only a subset of a seed table. (pg_dump won't do this ...)
+- Log activity as it is performed.
+- Support tracking a particular branch instead of master.
+- Support specifying the options to pass to each pg_dump form.
+- Select dumping only a subset of a seed table. (pg_dump won't do this ...)
 
 ## Previous Contributors
 
-* [Kyle Hargraves](https://github.com/pd)
-* [Sri Rangarajan](https://github.com/Slania)
-* [Emmanuel Sambo](https://github.com/esambo)
-* [Cindy Wise](https://github.com/cyyyz)
-* [Robert Nubel](https://github.com/rnubel)
-* [Josh Cheek](https://github.com/JoshCheek)
+- [Kyle Hargraves](https://github.com/pd)
+- [Sri Rangarajan](https://github.com/Slania)
+- [Emmanuel Sambo](https://github.com/esambo)
+- [Cindy Wise](https://github.com/cyyyz)
+- [Robert Nubel](https://github.com/rnubel)
+- [Josh Cheek](https://github.com/JoshCheek)
+- [Alexandre Castro](https://github.com/acastro2)
 
 ## License
 

data/compose.yml

@@ -1,6 +1,6 @@
 services:
   postgres:
-    image: postgres:13-alpine
+    image: postgres:17-alpine
     volumes:
       - postgres_data:/var/lib/postgresql/data
     ports:
@@ -22,7 +22,7 @@ services:
       context: .
       dockerfile: Dockerfile
       args:
-        RUBY_VERSION: 3.0
+        RUBY_VERSION: 3.3
     volumes:
       - .:/app
       - /app/config

data/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet

data/features/step_definitions/git_steps.rb

@@ -1,31 +1,31 @@
-Given 'a "$project" git repository' do |project|
+Given 'a {string} git repository' do |project|
   fixture_repo = File.join(@prodder_root, 'features', 'support', "#{project}.git")
   unless File.directory? fixture_repo
     raise "Cannot initialize repo for project #{project}; expected fixture at: #{fixture_repo}"
   end
 
-  run_simple "mkdir -p repos"
-  if File.exist? File.join(current_dir, "repos", "#{project}.git")
-    run_simple "chmod -R a+w repos/#{project}.git"
-    run_simple "rm -rf repos/#{project}.git"
+  run_command_and_stop "mkdir -p repos"
+  if File.exist? File.join(expand_path('.'), "repos", "#{project}.git")
+    run_command_and_stop "chmod -R a+w repos/#{project}.git"
+    run_command_and_stop "rm -rf repos/#{project}.git"
   end
-  run_simple "cp -pR #{fixture_repo} repos/#{project}.git"
+  run_command_and_stop "cp -pR #{fixture_repo} repos/#{project}.git"
 end
 
-Given 'I deleted the "$project" git repository' do |project|
-  run_simple "rm -rf repos/#{project}.git"
+Given 'I deleted the {string} git repository' do |project|
+  run_command_and_stop "rm -rf repos/#{project}.git"
 end
 
-Given 'the "$project" git repository does not allow pushing to it' do |project|
-  run_simple "chmod -R a-w repos/#{project}.git"
+Given 'the {string} git repository does not allow pushing to it' do |project|
+  run_command_and_stop "chmod -R a-w repos/#{project}.git"
 end
 
-Given 'a new commit is already in the "$project" git repository' do |project|
+Given 'a new commit is already in the {string} git repository' do |project|
   commit_to_remote project
 end
 
-Then 'the new commit should be in the workspace copy of the "$project" repository' do |project|
-  check_file_content "prodder-workspace/#{project}/README", 'Also read this!', true
+Then 'the new commit should be in the workspace copy of the {string} repository' do |project|
+  expect("prodder-workspace/#{project}/README").to have_file_content(/Also read this!/)
 end
 
 Then(/^(\d+) commits? by "([^"]+)" should be in the "([^"]+)" repository$/) do |n, author, project|
@@ -35,14 +35,14 @@ Then(/^(\d+) commits? by "([^"]+)" should be in the "([^"]+)" repository$/) do |
   end
 end
 
-Then 'the file "$filename" should now be tracked' do |filename|
-  in_current_dir do
+Then 'the file {string} should now be tracked' do |filename|
+  in_current_directory do
     git = Prodder::Git.new(File.expand_path("prodder-workspace/blog"), nil)
     expect(git).to be_tracked(filename)
   end
 end
 
-Then 'the latest commit should have changed "$file" to contain "$content"' do |filename, content|
+Then 'the latest commit should have changed {string} to contain {string}' do |filename, content|
   in_workspace('blog') do
     changed = `git show --name-only HEAD | grep #{filename}`.split("\n")
     expect(changed).to_not be_empty
@@ -52,7 +52,7 @@ Then 'the latest commit should have changed "$file" to contain "$content"' do |f
   end
 end
 
-Then 'the latest commit should not have changed "$filename"' do |filename|
+Then 'the latest commit should not have changed {string}' do |filename|
   in_workspace('blog') do
     changed = `git show --name-only HEAD | grep #{filename}`.split("\n")
     expect(changed).to be_empty
@@ -60,7 +60,7 @@ Then 'the latest commit should not have changed "$filename"' do |filename|
 end
 
 Then 'the new commit should be in the remote repository' do
-  in_current_dir do
+  in_current_directory do
     latest = `git --git-dir="./repos/blog.git" log | grep prodder`.split("\n")
     expect(latest).to_not be_empty
   end