Skip to content

[core] Consolidate @InternalApi classes#4809

Merged
adangel merged 38 commits into
pmd:masterfrom
adangel:issue-4348-internal-api
Feb 22, 2024
Merged

[core] Consolidate @InternalApi classes#4809
adangel merged 38 commits into
pmd:masterfrom
adangel:issue-4348-internal-api

Conversation

@adangel

@adangel adangel commented Jan 26, 2024 •
edited
Loading

Copy link
Copy Markdown
Member

Describe the PR

  • [core] Internalize AnalysisCache and related types

    • net.sourceforge.pmd.cache.AbstractAnalysisCache
    • net.sourceforge.pmd.cache.AnalysisCache
    • net.sourceforge.pmd.cache.AnalysisCacheListener
    • net.sourceforge.pmd.cache.AnalysisResult
    • net.sourceforge.pmd.cache.CachedRuleMapper
    • net.sourceforge.pmd.cache.CachedRuleViolation
    • net.sourceforge.pmd.cache.ChecksumAware
    • net.sourceforge.pmd.cache.FileAnalysisCache
    • net.sourceforge.pmd.cache.NoopAnalysisCache
    • whole package net.sourceforge.pmd.cache

  • PmdReporter

    • Already in internal packages
      • net.sourceforge.pmd.util.log.internal.ErrorsAsWarningsReporter
      • net.sourceforge.pmd.util.log.internal.QuietReporter
      • net.sourceforge.pmd.util.log.internal.SimpleMessageReporter
    • Renamed MessageReporter to PmdReporter - and removed InternalApi, since the reporter is supposed to be configurable via AbstractConfiguration#setReporter, so is part of the public API

  • net.sourceforge.pmd.util.ResourceLoader

    • moved to net.sourceforge.pmd.util.internal.ResourceLoader

  • net.sourceforge.pmd.cpd.Tokens

    • ctor net.sourceforge.pmd.cpd.Tokens#Tokens() is hidden now
    • the class itself is not anymore InternalApi, because it is used in public API: net.sourceforge.pmd.cpd.TokenEntry#getImage

  • net.sourceforge.pmd.properties.PropertyTypeId

  • net.sourceforge.pmd.properties.PropertyDescriptor#getTypeId

  • net.sourceforge.pmd.lang.document.FileCollector

    • #newCollector(net.sourceforge.pmd.lang.LanguageVersionDiscoverer, net.sourceforge.pmd.util.log.MessageReporter) and #newCollector(net.sourceforge.pmd.util.log.MessageReporter)
    • #getCollectedFiles and #getReporter are promoted to public API

  • net.sourceforge.pmd.lang.rule.RuleTargetSelector#isRuleChain

    • removed, as it was only used in a unit test

  • net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask#AnalysisTask

    • also make net.sourceforge.pmd.lang.LanguageProcessor.AnalysisTask#withFiles internal, that's the other way to create a new AnalysisTask

  • net.sourceforge.pmd.renderers.AbstractAccumulatingRenderer#renderFileReport

    • the method is made final, so that it can't be overridden anymore in subclasses. That's how the AccumulatingRenderer works now.

  • net.sourceforge.pmd.Report - made the following methods private

  • net.sourceforge.pmd.RuleContext

  • pmd-ant

    • Formatter
      • The method getRenderer() has been removed (not used, can access field directly here)
      • The method start(String) is private now and not accessible anymore.
      • The method end(Report) has been removed (has not been used)
      • The method isNoOutputSupplied() is now package private and not accessible anymore.
      • The method newListener(Project) is now package private and not accessible anymore. Added InternalApiBridge, so that we access it from PMDTaskImpl
    • PMDTask
      • The method getRelativizeRoots() has been removed - actually moved into PMDTaskImpl

  • pmd-apex - cleanups done, see [core] Consolidate @InternalApi classes #4348

  • pmd-java - cleanups done, see [core] Consolidate @InternalApi classes #4348

  • pmd-jsp

  • pmd-modelica

  • pmd-plsql

  • pmd-scala

  • pmd-visualforce

  • Accept ADR 3 ([doc] ADR 3 - API evolution principles #4756)

  • javadoc generation - exclude internal

  • net.sourceforge.pmd.lang.rule.ParametricRuleViolation - to be done after [core] Consolidate n.s.pmd.reporting package #4803

  • net.sourceforge.pmd.RuleSet etc. - to be done after [core] Consolidate n.s.pmd.lang.rule package #4799

Related issues

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

@adangel adangel mentioned this pull request Jan 26, 2024
Closed
55 tasks
@adangel adangel changed the title [core] Internalize AnalysisCache and related types [core] Consolidate @InternalApi classes Jan 26, 2024
@adangel
[core] Rename MessageReporter to PmdReporter as public API
3a5ff11 
PmdReporter is supposed to be used when configuring PMD
(see AbstractConfiguration#setReporter), so it can't be internal.

Refs pmd#4348
@ghost

ghost commented Jan 26, 2024 •
edited by ghost
Loading

Copy link
Copy Markdown
1 Message
📖 Compared to master:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact
✅ Compared to master:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact
✅ Compared to master:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact
✅ Compared to master:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact
✅ Compared to master:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact
✅ Compared to master:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact
✅ Compared to master:
This changeset changes 0 violations,
introduces 0 new violations, 0 new errors and 0 new configuration errors,
removes 0 violations, 0 errors and 0 configuration errors.
Download full report as build artifact

Generated by 🚫 Danger

@adangel adangel added this to the 7.0.0 milestone Jan 27, 2024
adangel added 12 commits January 27, 2024 18:39
@adangel
[core] n.s.pmd.cpd.Tokens#Tokens() is now package private
db0392c 
Refs pmd#4348
@adangel
[core] PropertyTypeId and PropertyDescriptor#getTypeId
217f0f4 
Both stay Internal API, update javadoc

Refs pmd#4348
@adangel
[core] FileCollector - factories stay internal, other methods are now…
4f8d094 
… public api

Refs pmd#4348
@adangel
[core] XPath Attribute#replacementIfDeprecated stays Internal API
932c2e3 
Refs pmd#4348
@adangel
[core] RuleTargetSelector#isRuleChain removed
a0a289f 
Refs pmd#4348
@adangel
[core] LanguageProcessor.AnalysisTask#withFiles now internal
bc31401 
Refs pmd#4348
@adangel
[core] AbstractAccumulatingRenderer#renderFileReport(Report) is final
8b8b11d 
Refs pmd#4348
@adangel
[core] Report - ctor and addRuleViolation, addConfigError, addError a…
589d144 
…re private

Refs pmd#4348
@adangel
[core] RuleContext - remove getRule(), create()
627fef1 
Introduce InternalApiBridge to collect all internal
API endpoints.

Refs pmd#4348
@adangel
[core] RuleContext - addViolationNoSuppress()
e3cf1c6 
This was not used and not tested.
To be readded with pmd#2736 and pmd#2896

Refs pmd#4348
@adangel
[ant] Cleanup InternalApi methods
2f47edf 
Refs pmd#4348
@adangel
[apex] Cleanup InternalApi methods
7ec2bc4 
Refs pmd#4348
oowekyala

This comment was marked as resolved.

Sign in to view

@adangel

This comment was marked as resolved.

Sign in to view
@adangel adangel mentioned this pull request Feb 9, 2024
Closed
19 tasks
adangel added 10 commits February 9, 2024 21:31
@adangel
Merge branch 'master' into issue-4348-internal-api
bc5be45
@adangel
[core] Internalize ParametricRuleViolation
72edaee
@adangel
[core] Consolidate internal api in n.s.p.lang.rule
7c5bf74 
RuleSet#applies
RuleSetLoader#loadRuleSetsWithoutException
RuleSetLoadException ctors
@adangel
[core] Consolidate internal api in LexException
2cc9ae9
@adangel
[core] Consolidate internal api in PMDConfiguration
3a635da 
PMDConfiguration#setAnalysisCache
PMDConfiguration#getAnalysisCache
@adangel
[core] Consolidate internal api in FileCollector
5e92b59 
FileCollector#newCollector
@adangel
[core] Consolidate internal api in XPath Attribute
68d4561 
Attribute#replacementIfDeprecated
@adangel
[core] Consolidate internal api in properties
5705847 
PropertyTypeId - moved to internal
PropertyDescriptor#getTypeId
@adangel
[doc] Fix javadoc for moved classes
dc4d195
@adangel
[ant] Add javadoc, internalize ReportException
b081836
@adangel

adangel commented Feb 10, 2024

Copy link
Copy Markdown
Member Author

This is finally ready now.

@adangel adangel marked this pull request as ready for review February 10, 2024 12:12
@adangel adangel added the in:pmd-internals Affects PMD's internals label Feb 10, 2024
@adangel adangel merged commit 609e364 into pmd:master Feb 22, 2024
@adangel adangel deleted the issue-4348-internal-api branch February 22, 2024 16:36
This was referenced Feb 22, 2024
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@oowekyala oowekyala oowekyala left review comments

Assignees

No one assigned

Labels

in:pmd-internals Affects PMD's internals

Projects

None yet

Milestone

7.0.0

Development

Successfully merging this pull request may close these issues.

[core] Consolidate @InternalApi classes

2 participants

@adangel @oowekyala