Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename SerializeCql to SerializeValue #1000

Merged
merged 4 commits into from
Jun 4, 2024

Conversation

muzarski
Copy link
Contributor

Fixes: #905

Changes

  • renamed SerializeCql trait/macro to SerializeValue. Changed all occurrences of SerializeCql to SerializeValue (in the docs, etc.)
  • renamed serialize_cql to serialize_value in functions that implement derive macro
  • renamed macro impl_serialize_cql_via_value to impl_serialize_value_via_value

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • [ ] I added relevant tests for new features and bug fixes.
  • All commits compile, pass static checks and pass test.
  • PR description sums up the changes and reasons why they should be introduced.
  • [ ] I have provided docstrings for the public items that I want to introduce.
  • I have adjusted the documentation in ./docs/source/.
  • I added appropriate Fixes: annotations to PR description.

@github-actions github-actions bot added the semver-checks-breaking cargo-semver-checks reports that this PR introduces breaking API changes label May 14, 2024
Copy link

github-actions bot commented May 14, 2024

cargo semver-checks detected some API incompatibilities in this PR.
Checked commit: 7440d3d

See the following report for details:

cargo semver-checks output
./scripts/semver-checks.sh --baseline-rev 5dbb10b800ef90a2f5ec08ca9b39c2c3e78c5e86
+ cargo semver-checks -p scylla -p scylla-cql --baseline-rev 5dbb10b800ef90a2f5ec08ca9b39c2c3e78c5e86
     Cloning 5dbb10b800ef90a2f5ec08ca9b39c2c3e78c5e86
     Parsing scylla v0.13.0 (current)
      Parsed [  19.073s] (current)
     Parsing scylla v0.13.0 (baseline)
      Parsed [  17.956s] (baseline)
    Checking scylla v0.13.0 -> v0.13.0 (no change)
     Checked [   0.560s] 72 checks; 72 passed, 0 unnecessary
    Finished [  37.637s] scylla
     Parsing scylla-cql v0.2.0 (current)
      Parsed [   9.700s] (current)
     Parsing scylla-cql v0.2.0 (baseline)
      Parsed [   9.823s] (baseline)
    Checking scylla-cql v0.2.0 -> v0.2.0 (no change)
     Checked [   0.269s] 72 checks; 70 passed, 2 failed, 0 unnecessary

--- failure enum_missing: pub enum removed or renamed ---

Description:
A publicly-visible enum cannot be imported by its prior path. A `pub use` may have been removed, or the enum itself may have been renamed or removed entirely.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.31.0/src/lints/enum_missing.ron

Failed in:
  enum scylla_cql::types::serialize::value::ValueToSerializeCqlAdapterError, previously in file /home/runner/work/scylla-rust-driver/scylla-rust-driver/target/semver-checks/git-5dbb10b800ef90a2f5ec08ca9b39c2c3e78c5e86/9d56708774382af089bdfc1466263fbbb6f42efa/scylla-cql/src/types/serialize/value.rs:1470

--- failure trait_missing: pub trait removed or renamed ---

Description:
A publicly-visible trait cannot be imported by its prior path. A `pub use` may have been removed, or the trait itself may have been renamed or removed entirely.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.31.0/src/lints/trait_missing.ron

Failed in:
  trait scylla_cql::types::serialize::value::SerializeCql, previously in file /home/runner/work/scylla-rust-driver/scylla-rust-driver/target/semver-checks/git-5dbb10b800ef90a2f5ec08ca9b39c2c3e78c5e86/9d56708774382af089bdfc1466263fbbb6f42efa/scylla-cql/src/types/serialize/value.rs:37
     Summary semver requires new major version: 2 major and 0 minor checks failed
    Finished [  19.828s] scylla-cql
make: *** [Makefile:61: semver-rev] Error 1

@muzarski muzarski self-assigned this May 14, 2024
@muzarski muzarski requested review from Lorak-mmk and wprzytula May 14, 2024 12:56
@wprzytula
Copy link
Collaborator

Please also rename cql.rs in scylla-macros to value.rs.

@wprzytula wprzytula added this to the 0.14.0 milestone May 15, 2024
@muzarski muzarski force-pushed the rename_serialize_cql branch from 5289f65 to 7440d3d Compare May 22, 2024 12:06
@muzarski
Copy link
Contributor Author

muzarski commented May 22, 2024

v1.1: rebased on top of main

@Lorak-mmk Lorak-mmk self-assigned this Jun 1, 2024
@roydahan
Copy link
Collaborator

roydahan commented Jun 3, 2024

@wprzytula / @Lorak-mmk I think this one can be merged, both of you approved it.

@wprzytula wprzytula self-assigned this Jun 4, 2024
@wprzytula wprzytula merged commit 4b1eca9 into scylladb:main Jun 4, 2024
13 checks passed
@muzarski muzarski deleted the rename_serialize_cql branch October 29, 2024 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver-checks-breaking cargo-semver-checks reports that this PR introduces breaking API changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SerializeCql is a confusing name for a macro
4 participants