Skip to content

fixes#1619

Merged
gerrycampion merged 35 commits intomainfrom
issue_reports
Mar 11, 2026
Merged

fixes#1619
gerrycampion merged 35 commits intomainfrom
issue_reports

Conversation

@SFJohnson24
Copy link
Collaborator

@SFJohnson24 SFJohnson24 commented Feb 16, 2026

This PR

  • removes the unused rule type from docs, tests and code as it does not fit the factory archetype that has been implemented, has no rules for it.
  • removes the VLM operators that were also unused
  • correctly maps Record Data rule type to Contents Builder //changed the get_service call to raise an error if the rule_type does not correctly match a rule, instead of defaulting to a potential incorrect rule type
  • added record data to tests that had no rule type and were falling into this default pattern
  • restores Rule Macro for each rule type
  • removes the old code in rule_engine for rule types.
  • updates the update-cache docs
  • removes add_comparator_to_rule_conditions was injecting comparators into rules/silently mutating them? From the test it seems it would grab literal values from metadata values

RuleTypes.DOMAIN_PRESENCE_CHECK_AGAINST_DEFINE.value: DomainListWithDefineDatasetBuilder,
RuleTypes.DEFINE_ITEM_METADATA_CHECK.value: DefineVariablesDatasetBuilder,
RuleTypes.VARIABLE_METADATA_CHECK_AGAINST_DEFINE.value: VariablesMetadataWithDefineDatasetBuilder,
RuleTypes.DATASET_CONTENTS_CHECK_AGAINST_DEFINE_AND_LIBRARY.value: ContentsDatasetBuilder,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please update the documentation of Rule Type to remove this from there too?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we planning to keep it in the documentation and remove form code? @SFJohnson24

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

odd I had though I removed it. It is done @RamilCDISC

README.md Outdated

To obtain an api key, please follow the instructions found here: <https://wiki.cdisc.org/display/LIBSUPRT/Getting+Started%3A+Access+to+CDISC+Library+API+using+API+Key+Authentication>. Please note it can take up to an hour after sign up to have an api key issued

This will show the list of cache update options.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this line is incomplete. The command it is referring to is missing from here

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line is a bit strangely worded. changed it.

@@ -1,5 +1,3 @@
## Dataset Contents Check against Define XML and Library Metadata

#### Columns
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please remove the description of the rule type too? The title is removed but sub headings are still there.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not see the sub headings you are referring to @RamilCDISC

@SFJohnson24 SFJohnson24 self-assigned this Feb 26, 2026
Copy link
Collaborator

@RamilCDISC RamilCDISC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR does cleaning of the codebase by removing unused rule types and operators. It also updates the documentation. the validation was done by:

  1. Reviewing the PR for any unwanted code or changes.
  2. Validating all tests pass.
  3. Ensuring removed rule type documentation and tests are properly removed.
  4. Ensuring removed operators tests and documentation is removed too.
  5. validating update cache documentation is updated.
  6. Ensuring CORE test suite validation pass.
  7. Verifying readability of the updated documentation.

Copy link
Collaborator

@gerrycampion gerrycampion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like this resolves part of ticket #514 as well. Maybe take a look to see if it makes sense to address anything else from that ticket. I don't think we want to move forward with removing the items in the Operations section

@SFJohnson24 SFJohnson24 requested a review from gerrycampion March 2, 2026 19:58
RuleTypes.VARIABLE_METADATA_CHECK_AGAINST_LIBRARY.value: VariablesMetadataWithLibraryMetadataDatasetBuilder,
RuleTypes.DEFINE_ITEM_METADATA_CHECK_AGAINST_LIBRARY.value: DefineVariablesWithLibraryMetadataDatasetBuilder,
RuleTypes.VARIABLE_METADATA_CHECK_AGAINST_DEFINE_XML_AND_LIBRARY.value: VariablesMetadataWithDefineAndLibraryDatasetBuilder,
RuleTypes.VARIABLE_METADATA_CHECK_AGAINST_DEFINE_XML_AND_LIBRARY.value: VariablesMetadataWithDefineAndLibraryDatasetBuilder, # noqa: E501
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why does this need to be here now if it is in flake8?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed this and several other inline # noqa: E501

@gerrycampion gerrycampion merged commit c02cbdb into main Mar 11, 2026
12 of 13 checks passed
@gerrycampion gerrycampion deleted the issue_reports branch March 11, 2026 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

--apikey option in addition to setting a local environment variable

3 participants