rust-db · jxs · Sep 5, 2021 · Aug 30, 2021 · Aug 30, 2021 · Aug 30, 2021
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -170,7 +170,5 @@ jobs:
       - name: Install Rust
         uses: actions-rs/toolchain@v1
         with:
-          profile: minimal
-          toolchain: nightly
-          override: true
-      - run: cd refinery && cargo rustdoc --all-features -- -D broken_intra_doc_links
+          toolchain: stable
+      - run: cd refinery && cargo rustdoc --all-features -- -D rustdoc::broken_intra_doc_links
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+### Unreleased (X 2021)
+- Removal of `include_migration_mods` macro (Instead use `embed_migrations` macro, and there is no need to have `mod.rs`) [#154](https://github.com/rust-db/refinery/pull/154)
+
 ### v0.6.0 (July 2021)
 - Update mysql to 0.21, [#164](https://github.com/rust-db/refinery/pull/164)
 - Update mysql_async to 0.28, [#164](https://github.com/rust-db/refinery/pull/164)
@@ -25,7 +28,7 @@
 - Warn when migration file name is malformed [#130](https://github.com/rust-db/refinery/pull/130)
 - Add `Unversioned` migration type, [#128](https://github.com/rust-db/refinery/pull/128)
 - Add `get_migrations` method to runner to allow inspecting gathered migrations, [#120](https://github.com/rust-db/refinery/pull/120)
-- Add support for 'postgresl' url schema prefix, [#107](https://github.com/rust-db/refinery/pull/107)
+- Add support for 'postgresql' url schema prefix, [#107](https://github.com/rust-db/refinery/pull/107)
 - Add lib option to load config from a string, [1#13](https://github.com/rust-db/refinery/pull/113)
 - Add lib and cli option to load config from env var, [#103](https://github.com/rust-db/refinery/pull/103)
 
@@ -43,7 +46,7 @@
   - Rename Config.get_db_type to Config.db_type, [#95](https://github.com/rust-db/refinery/pull/95)
   - Deprecate migrate_from_config and migrate_from_config_async, instead impl Migrate for Config, [#94](https://github.com/rust-db/refinery/pull/94)
   - Update Runner.run and Runner.run_async return signature, Result<(), Error> -> Result<Report, Error> where report contains applied Migration's, [#92](https://github.com/rust-db/refinery/pull/92)
-  - Deprecate AppliedMigration, merge it's functionality into Migration, [#91](https://github.com/rust-db/refinery/pull/91)
+  - Deprecate AppliedMigration, merge its functionality into Migration, [#91](https://github.com/rust-db/refinery/pull/91)
   - Add Runner.get_applied_migrations_async method, [#90](https://github.com/rust-db/refinery/pull/90)
   - Add Runner.get_applied_migrations method, [#90](https://github.com/rust-db/refinery/pull/90)
   - Add Runner.get_last_applied_migration_async method, [#90](https://github.com/rust-db/refinery/pull/90)
@@ -55,15 +58,15 @@
 
 ### v0.2.1 (February 2020)
 
-- **Bufixes**:
+- **Bugfixes**:
   - Update cfg-if to 0.1.10 to fix backtrace bug [#66](https://github.com/rust-db/refinery/pull/66)
 
 ### v0.2.0 (December 2019)
 
 - **Features**:
 
   - Add `tokio-postgres` driver support [#10](https://github.com/rust-db/refinery/pull/19).
-  - Add `mysql_async` driver suport [#22](https://github.com/rust-db/refinery/pull/19).
+  - Add `mysql_async` driver support [#22](https://github.com/rust-db/refinery/pull/19).
   - Add `migrate_from_config` function
   - Add `migrate_from_config_async` function
   - Update postgres to version 0.17 [#32](https://github.com/rust-db/refinery/pull/32)
@@ -72,7 +75,7 @@
 - **Bugfixes**:
   - allow multiple statements in migration files [#10](https://github.com/rust-db/refinery/issues/21)
   - when building refinery_cli with default features, build with rusqlite bundled libsqlite3 [#33](https://github.com/rust-db/refinery/issues/21)
-  - rename ConnectionError to just Connection as it is a variant for Error enum, and add its source as as source [#36](https://github.com/rust-db/refinery/issues/36)
+  - rename ConnectionError to just Connection as it is a variant for Error enum, and add its source as source [#36](https://github.com/rust-db/refinery/issues/36)
 
 - **Dependencies**:
   - update rusqlite dependency, 0.18 -> 0.21 [#26](https://github.com/rust-db/refinery/issues/26)

diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ If you are using a driver that is not yet supported, namely [`SQLx`](https://git
 - Migrations can be defined in .sql files or Rust modules that must have a function called `migration` that returns a [`String`](https://doc.rust-lang.org/std/string/struct.String.html).
 - Migrations can be strictly versioned by prefixing the file with `V` or not strictly versioned by prefixing the file with `U`.
 - Migrations, both .sql files and Rust modules must be named in the format `[U|V]{1}__{2}.sql` or `[U|V]{1}__{2}.rs`, where `{1}` represents the migration version and `{2}` the name.
-- Migrations can be run either by embedding them in your Rust code with `embed_migrations` and `include_migration_mods` macros, or via `refinery_cli`.
+- Migrations can be run either by embedding them in your Rust code with `embed_migrations` macro, or via `refinery_cli`.
 
 ### Example
 ```rust,no_run
@@ -55,12 +55,12 @@ This is because you can be sure the next migration being run is _always_ going t
 
 With Unversioned migrations there is more flexibility in the order that the migrations can be created and deployed.
 If developer 1 creates a PR with a migration today `U11__update_cars_table.sql`, but it is reviewed for a week.
-Meanwhile developer 2 creates a PR with migration `U12__create_model_tags.sql` that is much simpler and gets merged and deployed immediately.
+Meanwhile, developer 2 creates a PR with migration `U12__create_model_tags.sql` that is much simpler and gets merged and deployed immediately.
 This would stop developer 1's migration from ever running if you were using Versioned migrations because the next migration would need to be > 12.
 
 ## Implementation details
 
-refinery works by creating a table that keeps all the applied migrations' versions and their metadata. When you [run](https://docs.rs/refinery/latest/refinery/struct.Runner.html#method.run) the migrations `Runner`, refinery compares the applied migrations with the the ones to be applied, checking for [divergent](https://docs.rs/refinery/latest/refinery/struct.Runner.html#method.set_abort_divergent) and [missing](https://docs.rs/refinery/latest/refinery/struct.Runner.html#method.set_abort_missing) and executing unapplied migrations.\
+refinery works by creating a table that keeps all the applied migrations' versions and their metadata. When you [run](https://docs.rs/refinery/latest/refinery/struct.Runner.html#method.run) the migrations `Runner`, refinery compares the applied migrations with the ones to be applied, checking for [divergent](https://docs.rs/refinery/latest/refinery/struct.Runner.html#method.set_abort_divergent) and [missing](https://docs.rs/refinery/latest/refinery/struct.Runner.html#method.set_abort_missing) and executing unapplied migrations.\
 By default, refinery runs each migration in a single transaction. Alternatively, you can also configure refinery to wrap the entire execution of all migrations in a single transaction by setting [set_grouped](https://docs.rs/refinery/latest/refinery/struct.Runner.html#method.set_grouped) to true.
 
 ### Rollback
@@ -79,7 +79,7 @@ For Rusqlite, the best way to run migrations in an async context is to run them
 
 ## Contributing
 
-:balloon: Thanks for your help improving the project!
+:balloon: Thanks for your help to improve the project!
 No contribution is too small and all contributions are valued, feel free to open Issues and submit Pull Requests.
 
 ## License

diff --git a/examples/embedded/main.rs → examples/main.rs b/examples/embedded/main.rs → examples/main.rs
diff --git a/examples/embedded/migrations/V1__initial.sql → examples/migrations/V1__initial.sql b/examples/embedded/migrations/V1__initial.sql → examples/migrations/V1__initial.sql
diff --git a/...mbedded/migrations/V2__add_cars_table.sql → examples/migrations/V2__add_cars_table.sql b/...mbedded/migrations/V2__add_cars_table.sql → examples/migrations/V2__add_cars_table.sql
diff --git a/...migrations/V3__add_brand_to_cars_table.rs → ...migrations/V3__add_brand_to_cars_table.rs b/...migrations/V3__add_brand_to_cars_table.rs → ...migrations/V3__add_brand_to_cars_table.rs
@@ -8,4 +8,4 @@ pub fn migration() -> String {
     });
 
     m.make::<Sqlite>()
-}
+}
diff --git a/examples/modules/main.rs b/examples/modules/main.rs
diff --git a/examples/modules/migrations/V1__initial.rs b/examples/modules/migrations/V1__initial.rs
diff --git a/examples/modules/migrations/V2__add_cars_table.rs b/examples/modules/migrations/V2__add_cars_table.rs
diff --git a/examples/modules/migrations/mod.rs b/examples/modules/migrations/mod.rs
diff --git a/refinery/src/lib.rs b/refinery/src/lib.rs
@@ -11,10 +11,9 @@ Currently, [`Postgres`](https://crates.io/crates/postgres), [`Rusqlite`](https:/
 
 - Migrations can be defined in .sql files or Rust modules that must have a function called `migration()` that returns a [`std::string::String`]
 - Migrations, both .sql files and Rust modules must be named in the format `V{1}__{2}.rs ` where `{1}` represents the migration version and `{2}` the name.
-- Migrations can be run either by embedding them on your Rust code with [`embed_migrations!`] and [`include_migration_mods!`] macros, or via `refinery_cli`.
+- Migrations can be run either by embedding them on your Rust code with [`embed_migrations!`] macro, or via `refinery_cli`.
 
 [`embed_migrations!`]: macro.embed_migrations.html
-[`include_migration_mods!`]: macro.include_migration_mods.html
 
 ### Example
 ```rust,ignore
@@ -36,4 +35,4 @@ pub use refinery_core::config;
 pub use refinery_core::{error, Error, Migration, Report, Runner, Target};
 #[doc(hidden)]
 pub use refinery_core::{AsyncMigrate, Migrate};
-pub use refinery_macros::{embed_migrations, include_migration_mods};
+pub use refinery_macros::embed_migrations;
diff --git a/refinery/tests/mod_migrations/V1__initial.rs → refinery/tests/migrations/V1__initial.rs b/refinery/tests/mod_migrations/V1__initial.rs → refinery/tests/migrations/V1__initial.rs
diff --git a/...ests/mod_migrations/V2__add_cars_table.rs → ...ry/tests/migrations/V2__add_cars_table.rs b/...ests/mod_migrations/V2__add_cars_table.rs → ...ry/tests/migrations/V2__add_cars_table.rs
diff --git a/refinery/tests/migrations/V3__add_brand_to_cars_table.sql b/refinery/tests/migrations/V3__add_brand_to_cars_table.sql
@@ -0,0 +1,2 @@
+ALTER TABLE cars
+    ADD COLUMN brand VARCHAR(255) NULL;
diff --git a/...migrations/V4__add_year_to_motos_table.rs → ...migrations/V4__add_year_to_motos_table.rs b/...migrations/V4__add_year_to_motos_table.rs → ...migrations/V4__add_year_to_motos_table.rs
diff --git a/...tests/sql_migrations/V1-2/V1__initial.sql → ...y/tests/migrations_broken/V1__initial.sql b/...tests/sql_migrations/V1-2/V1__initial.sql → ...y/tests/migrations_broken/V1__initial.sql
diff --git a/..._migrations_broken/V2__add_cars_table.sql → .../migrations_broken/V2__add_cars_table.sql b/..._migrations_broken/V2__add_cars_table.sql → .../migrations_broken/V2__add_cars_table.sql
diff --git a/...ns_broken/V3__add_brand_to_cars_table.sql → ...ns_broken/V3__add_brand_to_cars_table.sql b/...ns_broken/V3__add_brand_to_cars_table.sql → ...ns_broken/V3__add_brand_to_cars_table.sql
diff --git a/...migrations_missing/V2__add_cars_table.sql → ...migrations_missing/V2__add_cars_table.sql b/...migrations_missing/V2__add_cars_table.sql → ...migrations_missing/V2__add_cars_table.sql
diff --git a/...sts/sql_migrations_broken/V1__initial.sql → ...ts/migrations_subdir/V1-2/V1__initial.sql b/...sts/sql_migrations_broken/V1__initial.sql → ...ts/migrations_subdir/V1-2/V1__initial.sql
diff --git a/...ons/V1-2/V2__add_cars_and_motos_table.sql → ...dir/V1-2/V2__add_cars_and_motos_table.sql b/...ons/V1-2/V2__add_cars_and_motos_table.sql → ...dir/V1-2/V2__add_cars_and_motos_table.sql
diff --git a/...igrations/V3__add_brand_to_cars_table.sql → ...subdir/V3/V3__add_brand_to_cars_table.sql b/...igrations/V3__add_brand_to_cars_table.sql → ...subdir/V3/V3__add_brand_to_cars_table.sql
diff --git a/...igrations/V4__add_year_to_motos_table.sql → ...ns_subdir/V4__add_year_to_motos_table.sql b/...igrations/V4__add_year_to_motos_table.sql → ...ns_subdir/V4__add_year_to_motos_table.sql
diff --git a/...ns_unversioned/U0__merge_out_of_order.sql → ...ns_unversioned/U0__merge_out_of_order.sql b/...ns_unversioned/U0__merge_out_of_order.sql → ...ns_unversioned/U0__merge_out_of_order.sql
diff --git a/refinery/tests/mod_migrations/V3__add_brand_to_cars_table.rs b/refinery/tests/mod_migrations/V3__add_brand_to_cars_table.rs
diff --git a/refinery/tests/mod_migrations/mod.rs b/refinery/tests/mod_migrations/mod.rs
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,4 +8,4 @@ pub fn migration() -> String { @@
         });
         m.make::<Sqlite>()
-    }
+    }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		ALTER TABLE cars
Copy link Member jxs Sep 2, 2021 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. is the addition of this sql migration on the mod migrations dir on purpose? i.e. to test a dir with both sql and mod migrations, I think since we are now merging the macro do embed migrations it probably makes sense to change the tests to work with both, what do you think? Copy link Contributor Author omid Sep 2, 2021 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. I did it on purpose, to test both sql and mod. Also agree tests need a revisit! Copy link Member jxs Sep 2, 2021 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. ok yeah so since the tests are passing and work, we can do it on a subsequent PR if you feel like doing it, and we can merge this one before omid reacted with thumbs up emoji
		ADD COLUMN brand VARCHAR(255) NULL;