Patch #15118

Deprecate and rename rss_* methods to atom_* methods

Added by Mischa The Evil over 6 years ago. Updated over 6 years ago.

Status:NewStart date:
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:Code cleanup/refactoring
Target version:Candidate for next major release

Description

This issue is extracted from #13460-2 after 2.4 feature freeze.

Relevant history:

Daniel Felix wrote in #13460-2 (note-2):

  • File Attachment:functional_renaming_rss_to_atom.diff added

I'll provide two patches.
[...]
Number 2: functional renaming. Deprecation of old rss_* methods and redefining them as atom_* methods. Old methods are still available and give deprecation warnings. Please test Number 2, too. But it seems to work in the first test.

Jean-Philippe Lang wrote in #13460-7 (note-7):

I've committed the translations in r11654 but I think it's a bit late to change the methods for 2.3.0.

functional_renaming_rss_to_atom.diff Magnifier - Patch authored by Daniel Felix (transported from #13460-2) (26.9 KB) Mischa The Evil, 2013-10-14 01:31

Related issues

Related to Redmine - Patch #13460: All translations: RSS -> Atom Closed

History

#1 Updated by Mischa The Evil over 6 years ago

The affected methods are MyController#reset_rss_key, User#rss_key and User.find_by_rss_key.

Daniel Felix wrote in #13460-8 (note-8):

Hopefully the way I use to deprecate those methods is good enough for the implementation. :-)

Pretty much I think, though some of the deprecation warnings used in the patch are not correct:
  1. the warning for MyController#reset_rss_key reads:
    "My#reset_rss_key is deprecated and will be removed in Redmine 3.0. Please use #reset_atom_key instead."
    this should be
    "MyController#reset_rss_key is deprecated and will be removed in Redmine 3.0. Please use MyController#reset_atom_key instead."
  2. the warning for User#rss_key reads:
    "User.rss_key is deprecated and will be removed in Redmine 3.0. Please use User.atom_key instead."
    this should be
    "User#rss_key is deprecated and will be removed in Redmine 3.0. Please use User#atom_key instead."
For 1:
  • My#reset_rss_key says that reset_rss_key is an instance method of My (suggesting that My is an existing model in the Redmine core, which isn't), whereas the change you've made is in the reset_rss_key instance method of MyController
  • I think it is better to include the class name when redirecting (in text obviously :) the user to the new, replacing method
For 2:
  • User.rss_key refers to a class method in the User class, while in the Redmine core rss_key is an instance method in the User class

#2 Updated by Mischa The Evil over 6 years ago

  • Related to Patch #13460: All translations: RSS -> Atom added

Also available in: Atom PDF