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

Separate namespace for modules providing web interface #200

Closed
wants to merge 5 commits into from

Conversation

ikedas
Copy link
Member

@ikedas ikedas commented Feb 18, 2018

Following modules are referred only by web applications (wwsympa.fcgi and sympa_soap_server.fcgi), and they would be moved to separate namespace. Because:

  • Packager may select necessary modules.
  • On the next major release, web interface will be replaced entirely and developers may omit following modules.
Current name New name
Sympa::Auth WWSympa::Auth
Sympa::Marc WWSympa::Marc
Sympa::Marc::Search WWSympa::Marc::Search
Sympa::Report WWSympa::Report
Sympa::SOAP WWSympa::SOAP
Sympa::SOAP::Transport WWSympa::SOAP::Transport
Sympa::Session WWSympa::Session
Sympa::SharedDocument WWSympa::SharedDocument
Sympa::Tools::WWW WWSympa::Tools

@ikedas ikedas added the design label Feb 18, 2018
. $label . '.'
$spool_task . '/'
. $date . '.'
. $label . '.'
Copy link
Contributor

Choose a reason for hiding this comment

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

This hunk introduces trailing white spaces.

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe a bug of perltidy. I fixed. Thanks.

@dverdin
Copy link
Contributor

dverdin commented Feb 19, 2018

Totally agree with you. This certainly clarifies the usage of these modules.

@racke
Copy link
Contributor

racke commented Feb 19, 2018

Hm, I think the namespace "Sympa::WWW" would be better. Just my two cents.

@ikedas
Copy link
Member Author

ikedas commented Feb 20, 2018

I think naming method is matter of preference. The method getting more support would be carried out.

@racke
Copy link
Contributor

racke commented Feb 20, 2018

So let's discuss the new namespace on the (developers) mailing list. I also think it is a good idea and it is a good time to this before sympa-7.0 branch starts to take off.

@ikedas
Copy link
Member Author

ikedas commented Feb 24, 2018

There seems no objection to moving. Rest of issue is how we may move (rename). Before we move to dev list, we would be better to present rationale by each.

My favorite is new top-level namespace WWSympa. By this proposal, directory listing of src/lib will be:

Sympa/
Sympa.pm
WWSympa/
WWSympa.pm

(`Conf.pm will be removed --- hopefully in this year, besides)

Separate namespaces will make separating packages easy:

  • Packagers may pick out Sympa* for core package and WWSympa* for web package.
  • Developers of new web interace may create new namespace and may work only on Sympa and MojoSympa namespaces.
  • I personally have plan of LMTP frontend of Sympa and I may work on LMTPSympa namespace.

etc.

@racke
Copy link
Contributor

racke commented Feb 24, 2018

My favourite is to keep all our modules within a single namespace Sympa - this makes more sense to me and doesn't look so ugly like "WWSympa", "LMTPSympa", e.g.

  • Sympa::WWW or Sympa::Web
  • Sympa::LMTP or Sympa::Mail::LMTP

This doesn't affect the separation of the modules for packaging.

Also, while we are at it, a separate namespace for 3rd party modules would be nice to, e.g. one of these:

  • Sympa::Plugin::
  • Sympa::Module::
  • Sympa::Extension::

@ikedas
Copy link
Member Author

ikedas commented Mar 6, 2018

Okey, let's continue on dev list.

@eiro
Copy link

eiro commented Mar 9, 2018

@dverdin both @racke and i are agree about the namespaces @racke proposed. no one else provided another solution. what's your opinion ?

@ikedas ikedas added this to the 6.2.26 milestone Mar 12, 2018
@ikedas ikedas closed this Mar 12, 2018
@sympa-community sympa-community locked as resolved and limited conversation to collaborators Mar 12, 2018
@ikedas ikedas deleted the WWSympa_namespace branch March 13, 2018 09:03
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants