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.

Sign up for GitHub

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

Jump to bottom

Clean up modules' exporting/importing symbols #534

Merged
merged 33 commits into from
Oct 16, 2024
Merged

Clean up modules' exporting/importing symbols #534

merged 33 commits into from
Oct 16, 2024

Conversation

gemmaro
Copy link
Contributor

@gemmaro gemmaro commented Oct 14, 2024 •
edited
Loading

This is a continuation from #533.

According to the Exporter's perldoc, this change follows the rationales:

  • Do as little exporting as possible.
  • If exporting is necessary, use @EXPORT_OK.
    • Except for Testhelper; It sounds natural to align with Test::More.
  • And make sure that the relationships (and inheritance) between modules are clear.

Commits are grouped as follows.

  • Common module
  • Po module
  • TransTractor module
  • Each format modules (from ancestor to descendant)

Followings are not the targets of this pull request:

  • Remove @AUTOLOAD variable declarations
  • Remove unused makespace subroutine declarations
  • Use our for the version variable

Thank you,

TODO list:

  • Use @EXPORT_OK instead of @EXPORT in the Xml module, or remove it and use explicit calling
  • Tidy commits (improve message, merge some of them, and etc.)
  • Maybe split into several pull requests
  • Check each commits again

@gemmaro
Remove the "textdomain" subroutine from export-list in Common module
59aaaaf 
* lib/Locale/Po4a/Common.pm: Remove the "textdomain" subroutine from
export-list in Common module.  The every callers use the fully qualified
subroutine name.
* scripts/msgsearch: Use fully qualified method name "textdomain" in
the msgsearch script.
@gemmaro
Explicitly export and import Common module's "wrap_msg" subroutine
a464f5d 
* lib/Locale/Po4a/Common.pm: Explicitly export the Common module's
wrap_msg subroutine.  @EXPORT_OK is preferred way of exporting to
@export.
* lib/Locale/Po4a/Chooser.pm, lib/Locale/Po4a/TransTractor.pm,
lib/Locale/Po4a/Wml.pm, msguntypot, po4a, po4a-gettextize,
po4a-normalize, po4a-translate, po4a-updatepo: Explicitly import the
Common module's wrap_msg subroutine.
@gemmaro
Explicitly export and import Common module's "wrap_mod" subroutine
7cfc131 
* lib/Locale/Po4a/Common.pm: Explicitly export the Common module's
"wrap_mod" subroutine.  @EXPORT_OK is the preferred way to export.
* lib/Locale/Po4a/AsciiDoc.pm, lib/Locale/Po4a/Chooser.pm,
lib/Locale/Po4a/InProgress/Debconf.pm, lib/Locale/Po4a/Man.pm,
lib/Locale/Po4a/Org.pm, lib/Locale/Po4a/Pod.pm,
lib/Locale/Po4a/RubyDoc.pm, lib/Locale/Po4a/Sgml.pm,
lib/Locale/Po4a/TeX.pm, lib/Locale/Po4a/Text.pm,
lib/Locale/Po4a/TransTractor.pm, lib/Locale/Po4a/Xhtml.pm,
lib/Locale/Po4a/Xml.pm, lib/Locale/Po4a/Yaml.pm, po4a-gettextize:
Explicitly import the Common module's "wrap_mod" subroutine.
@gemmaro
Explicitly export and import the Common's "wrap_ref_mod" subroutine
34f638c 
* lib/Locale/Po4a/Common.pm: Explicitly export the Common's
"wrap_ref_mod" subroutine.  @EXPORT_OK is the preferred way of
exporting to @export.
* lib/Locale/Po4a/InProgress/NewsDebian.pm,
lib/Locale/Po4a/KernelHelp.pm, lib/Locale/Po4a/Man.pm,
lib/Locale/Po4a/Sgml.pm, lib/Locale/Po4a/TeX.pm,
lib/Locale/Po4a/Xml.pm, po4a: Explicitly import the Common's
"wrap_ref_mod" subroutine.
@gemmaro
Explicitly export and import the Common's "gettext" subroutine
5504610 
* lib/Locale/Po4a/Common.pm: Explicitly export the Common's
"gettext" subroutine.  The @EXPORT_OK is the preferred way of
exporting to @export.
* lib/Locale/Po4a/Chooser.pm, lib/Locale/Po4a/KernelHelp.pm,
lib/Locale/Po4a/TransTractor.pm, lib/Locale/Po4a/Wml.pm, msguntypot,
po4a, po4a-gettextize, po4a-normalize, po4a-translate, po4a-updatepo,
scripts/msgsearch: Explicitly import the Common's "gettext"
subroutine.
@gemmaro
Explicitly export and import the Common's "dgettext" subroutine
c0431e5 
* lib/Locale/Po4a/Common.pm: Explicitly export the Common's "dgettext"
subroutine.  The @EXPORT_OK is the preferred way to export.
* lib/Locale/Po4a/AsciiDoc.pm, lib/Locale/Po4a/InProgress/Debconf.pm,
lib/Locale/Po4a/InProgress/NewsDebian.pm, lib/Locale/Po4a/Man.pm,
lib/Locale/Po4a/Org.pm, lib/Locale/Po4a/Pod.pm,
lib/Locale/Po4a/RubyDoc.pm, lib/Locale/Po4a/Sgml.pm,
lib/Locale/Po4a/TeX.pm, lib/Locale/Po4a/Text.pm,
lib/Locale/Po4a/TransTractor.pm, lib/Locale/Po4a/Xhtml.pm,
lib/Locale/Po4a/Xml.pm, lib/Locale/Po4a/Yaml.pm, po4a,
po4a-gettextize, po4a-normalize: Explicitly import the Common's
"dgettext" subroutine.
@gemmaro
Do not export the %debug variable by default from the Po module
1522a93 
* lib/Locale/Po4a/Po.pm: Do not export the %debug variable by default
from the Po module.  The variable is not used anywhere unconditionally.
@gemmaro
Removed the TransTractor module from the Po module
2ab68a0 
* lib/Locale/Po4a/Po.pm: Removed the TransTractor module from the Po
module.  Po and TransTractor used to "use" each others.
gemmaro added 20 commits October 15, 2024 20:37
@gemmaro
Removed the Exporter module from the TransTractor module
1e8c4a4 
* lib/Locale/Po4a/TransTractor.pm: There were TransTractor's export
list, but they were not used anywhere.
@gemmaro
Add empty "initialize" subroutine to the TransTractor module
916fb96
@gemmaro
Removed the empty "initialize" subroutines from per-format modules
9833241
@gemmaro
Removed the empty export-list from the AsciiDoc module
6b89f9a 
* lib/Locale/Po4a/AsciiDoc.pm: Removed the empty export-list from the
AsciiDoc module.  The @export variable was empty.
@gemmaro
Removed the empty export-list from the Debconf module
790c787 
* lib/Locale/Po4a/InProgress/Debconf.pm: Removed the empty export-list
from the Debconf module.  The @export list was empty.
@gemmaro
Removed the empty export-list from the Gemtext module
e246cd4 
* lib/Locale/Po4a/Gemtext.pm: Removed the Exporter and the @export
variable from the Gemtext module.  The @export list was empty.
@gemmaro
Removed the empty export-list from the KernelHelp module
f38ea77 
* lib/Locale/Po4a/KernelHelp.pm: Removed the Exporter module and the
@export variable from the KernelHelp module.  The list was empty.
@gemmaro
Removed the empty export-list from the Man module
dfee1dc 
* lib/Locale/Po4a/Man.pm: Removed the empty export-list from the Man
module.  The @export list was empty.
@gemmaro
Removed the empty export-list from the NewsDebian module
08b9119 
* lib/Locale/Po4a/InProgress/NewsDebian.pm: Removed the empty
export-list from the NewsDebian module.  The @export list was empty.
@gemmaro
Removed the Exporter module from the Pod module
9c3d715 
* lib/Locale/Po4a/Pod.pm: Removed the Exporter module from the Pod
module.  There is nothing to export.
@gemmaro
Removed the Exporter module from the RubyDoc module
2dbe4bc 
* lib/Locale/Po4a/RubyDoc.pm: Removed the Exporter module from the
RubyDoc module.  There was no export-list.
@gemmaro
Removed the empty export-list from the BibTeX module
70741c6 
* lib/Locale/Po4a/BibTeX.pm: Removed the empty export-list from the
BibTeX module.  The @export list was empty.
@gemmaro
Removed the Exporter module from the TeX module
7f13fde 
* lib/Locale/Po4a/TeX.pm: Removed the Exporter module from the TeX
module.  The exported symbols were not used implicitly by its child modules.
@gemmaro
Removed the empty export-list from the Halibut module
4ae55d8 
* lib/Locale/Po4a/Halibut.pm: Removed the empty export-list from the
Halibut module.  The @export list was empty.
@gemmaro
Removed the empty export-list from the LaTeX module
b44b4ca 
* lib/Locale/Po4a/LaTeX.pm: Removed the empty export-list from the
LaTeX module.  The @export list was empty.
@gemmaro
Removed the empty export-list from the Texinfo module
cc182cf 
* lib/Locale/Po4a/Texinfo.pm: Removed the empty export-list from the
Texinfo module.  The @export list was empty.
@gemmaro
Removed the empty export-list from the Ini module
ef9755d 
* lib/Locale/Po4a/Ini.pm: Removed the Exporter module and the @export
variable from the Ini module.  The @export list was empty.
@gemmaro
Removed the empty export-list from the Yaml module
8dfae2b 
* lib/Locale/Po4a/Yaml.pm: Removed the Exporter module and the
@export variable from the Yaml module.  The list was empty.
@gemmaro
Removed the empty export-list from the Text module
68d93fe 
* lib/Locale/Po4a/Text.pm: Removed the empty export-list from the Text
module.  The @export list was empty.
@gemmaro
Removed the empty export-list from the Sgml module
ee79c33 
* lib/Locale/Po4a/Sgml.pm: Removed the empty export-list from the Sgml
module.  The @export list was empty.
@gemmaro
Removed the Xml module's "new" symbol from the export list
66a4e88 
* lib/Locale/Po4a/Xml.pm: Removed the Xml module's "new" subroutine
symbol from its export list.  The Xml module inherits from the
TransTractor module and uses the TransTractor's "new" subroutine.
@gemmaro
Remove the @tag_types variable from the Xml module's export list
9de41ce
@gemmaro
Remove the Exporter and the export-list from the Xml module.
88f847c
@gemmaro
Add missing return value of the Xhtml module
1d05ee7
@gemmaro
Removed the empty export-list from the Wml module
919a263 
* lib/Locale/Po4a/Wml.pm: Removed the empty export-list from the Wml
module.  The @export list was empty.
@gemmaro gemmaro marked this pull request as ready for review October 15, 2024 11:46
@mquinson
Copy link
Owner

Thank you very much for this change @gemmaro. I reviewed it, and it sounds good. I'm so happy that you help me preventing this code from rotting. Please do not hesitate to do the cleanups that were not target of this PR if you feel so :)

@mquinson mquinson merged commit 3266006 into mquinson:master Oct 16, 2024
1 check passed
@gemmaro gemmaro deleted the exporter branch October 16, 2024 10:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gemmaro @mquinson