cljoly / rusqlite_migration
94%
master: 95%

LAST BUILD BRANCH: refactor-tests
DEFAULT BRANCH: master
Repo Added
Token pB6wRhQDsdC88inn2GVgCM6IKevWTVuLm regen
Build 891 Last
Files 5
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH migrations-to-apply
branch: migrations-to-apply
CHANGE BRANCH
x
Sync Branches

coverage: 94.083% (+0.04%) from 94.048%
14429757190

Pull #248

github

cljoly 
feat: expose the number of migrations to be applied

This is a slightly different take on #170, where instead of returning
the total number of migrations defined, we return the number of
migrations defined, but not yet applied.

Going back to the discussion in #170, what we actually need is:
1. tell whether migrations will be run, without actually running them.
   One use of this information is to run a backups before applying the
   migrations.
2. [“see the version difference somehow”][diff], i.e. the number of
   migrations to be applied.

Thus I think that returning the number of migrations to be applied,
instead of the number of migrations already applied fulfills the need
better. And it is less of a foot gun in my opinion:
1. The index in the vector of migration is off by one compared to the
   index in the user version, which is the one exposed by
   [`to_version()`][to_version] effectively. In other words, the first
   migration in the array is index 0, but that’s effectively version 1.
2. As discussed in #170, users might be tempted to write something like:
   ```rust
   if migrations.needs_to_run() {
     migrations.to_latest()
   }
   ```
   which would be suboptimal, as `to_latest` performs the same check.

Closes https://github.com/cljoly/rusqlite_migration/issues/170

[to_version]: https://docs.rs/rusqlite_migration/1.3.1/rusqlite_migration/struct.AsyncMigrations.html#example-4
[difference]: https://github.com/cljoly/rusqlite_migration/issues/170#issuecomment-2343979134

Builds-on: https://github.com/cljoly/rusqlite_migration/pull/171
Co-authored-by: Alex Helfet <alex.helfet@gmail.com>
Pull Request #248: feat: expose the number of migrations to be applied

2 of 2 new or added lines in 1 file covered. (100.0%)

318 of 338 relevant lines covered (94.08%)

5.69 hits per line

Relevant lines Covered
338 RELEVANT LINES 318 COVERED LINES
5.69 HITS PER LINE
Source Files on migrations-to-apply

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
14429757190 migrations-to-apply feat: expose the number of migrations to be applied This is a slightly different take on #170, where instead of returning the total number of migrations defined, we return the number of migrations defined, but not yet applied. Going back to the ... Pull #248 cljoly github
94.08
14428512152 migrations-to-apply feat: expose the number of migrations to be applied This is a slightly different take on #170, where instead of returning the total number of migrations defined, we return the number of migrations defined, but not yet applied. Going back to the ... Pull #248 cljoly github
94.08
14391348666 migrations-to-apply feat: expose the number of migrations to be applied This is a slightly different take on #170, where instead of returning the total number of migrations defined, we return the number of migrations defined, but not yet applied. Going back to the ... Pull #248 cljoly github
94.08
14368033128 migrations-to-apply feat: expose the number of migrations to be applied This is a slightly different take on #170, where instead of returning the total number of migrations defined, we return the number of migrations defined, but not yet applied. Going back to the ... Pull #248 cljoly github
94.03
14368016206 migrations-to-apply feat: expose the number of migrations to be applied This is a slightly different take on #170, where instead of returning the total number of migrations defined, we return the number of migrations defined, but not yet applied. Going back to the ... push cljoly github
94.03
14048488454 migrations-to-apply feat: expose the number of migrations to be applied This is a slightly different take on #170, where instead of returning the total number of migrations defined, we return the number of migrations defined, but not yet applied. Going back to the ... Pull #248 cljoly github
94.03
14024015853 migrations-to-apply WIP migrations_to_apply push cljoly github
93.43
14023743233 migrations-to-apply WIP migrations_to_apply push cljoly github
93.43
14023079257 migrations-to-apply WIP migrations_to_apply push cljoly github
92.63
14021340861 migrations-to-apply WIP migrations_to_apply push cljoly github
92.63
See All Builds (635)

Badge your Repo: rusqlite_migration

We detected this repo isn’t badged! Grab the embed code to the right, add it to your repo to show off your code coverage, and when the badge is live hit the refresh button to remove this message.
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

Refresh