Check deprecated methods on release #2673

deivid-rodriguez · 2019-03-07T12:07:24Z

Description:

I noticed that we have a bunch of methods in the code base that were supposed to have been deprecated in December 2018, when rubygems 3 was released, but that didn't happen?

I'm not sure if it was intentional or not, but I figured we could have a release check that makes sure we either definitively remove the methods, or expand the deprecation horizon.

Tasks:

Describe the problem / feature
Write tests
Write code to solve the problem
Get code review from coworkers / friends

I will abide by the code of conduct.

deivid-rodriguez · 2019-03-07T14:27:45Z

This is what one currently gets by running rake check_deprecations (manually editing the version in rubygems-update.gemspec to be 4.0.0.pre1):

$ rake check_deprecations
util/rubocop -r ./util/cops/deprecations --only Rubygems/Deprecations
Inspecting 324 files
.......................................................................................................................................................C...............C...............................................................................C...........................................................CCC..C...........

Offenses:

lib/rubygems.rb:597:5: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
    deprecate :gunzip, "Gem::Util.gunzip", 2018, 12
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems.rb:611:5: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
    deprecate :gzip, "Gem::Util.gzip", 2018, 12
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems.rb:625:5: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
    deprecate :inflate, "Gem::Util.inflate", 2018, 12
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems.rb:1226:5: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
    deprecate :detect_gemdeps, "Gem.use_gemdeps", 2018, 12
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/dependency_installer.rb:161:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :add_found_dependencies, :none, 2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/dependency_installer.rb:353:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :gather_dependencies, :none, 2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/specification.rb:723:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :default_executable=, :none,       2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/specification.rb:1787:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :default_executable,  :none,       2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/specification.rb:1996:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :has_rdoc,            :none,       2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/specification.rb:2006:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :has_rdoc=,           :none,       2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/specification.rb:2009:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :has_rdoc?,           :none,       2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/user_interaction.rb:367:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :debug, :none, 2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/test_case.rb:717:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :quick_spec, :util_spec, 2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/test_case.rb:864:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :new_spec, :none, 2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/installer.rb:847:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :extension_build_error, :none, 2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lib/rubygems/exceptions.rb:21:3: C: Rubygems/Deprecations: Remove deprecate calls with dates in the past, along with the methods they deprecate, or expand the deprecation horizons to a future date
  deprecate :source_exception, :none, 2018, 12
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

324 files inspected, 16 offenses detected
rake aborted!
Command failed with status (1): [util/rubocop -r ./util/cops/deprecations -...]
/home/deivid/Code/rubygems/Rakefile:95:in `block in <top (required)>'
Tasks: TOP => check_deprecations
(See full trace by running task with --trace)

I guess we should delay the removal of these to rubygems 4.0 (2019/12, I guess).

bronzdoc

Oh this is great! thanks @deivid-rodriguez!

deivid-rodriguez · 2019-03-07T16:17:03Z

util/cops/deprecations.rb

+      #   deprecate :safdfa, nil, 2019, 02
+      #
+      #   # good
+      #   deprecate :safdfa, nil, 2019, 03


Just noticed that this example doesn't match the code. If we try to release a major version, and rubocop finds a method that's supposed to be removed in that same month, it will print an offense, although it's documented as "good" here. I'll fix it now.

Make sure we remove expired deprecations upon release.

deivid-rodriguez · 2019-03-08T12:53:24Z

I corrected the tiny documentation change, this should be ready now!

bronzdoc · 2019-03-08T14:43:58Z

@bundlerbot r+

2673: Check deprecated methods on release r=bronzdoc a=deivid-rodriguez # Description: I noticed that we have a bunch of methods in the code base that were supposed to have been deprecated in December 2018, when rubygems 3 was released, but that didn't happen? I'm not sure if it was intentional or not, but I figured we could have a release check that makes sure we either definitively remove the methods, or expand the deprecation horizon. # Tasks: - [x] Describe the problem / feature - [ ] Write tests - [x] Write code to solve the problem - [ ] Get code review from coworkers / friends I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md). 2676: Fix metadata description docs r=bronzdoc a=sonalkr132 # Description: > settable by gem authors without requiring an update to the rubygems software. this has never been true. Not sure why it said that. Using G in the gem is converting it to link on using `rake spec_guide` ([broken here](rubygems/guides@2ca58b0#diff-a0ed24268b853e4412f766326125de00L12)). # Tasks: - [ ] Describe the problem / feature - [ ] Write tests - [ ] Write code to solve the problem - [ ] Get code review from coworkers / friends I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md). Co-authored-by: David Rodríguez <deivid.rodriguez@riseup.net> Co-authored-by: Aditya Prakash <aditya.prakash132@gmail.com>

ghost · 2019-03-08T15:35:54Z

Build succeeded

continuous-integration/travis-ci/push

2704: Remove long ago deprecated methods r=bronzdoc a=deivid-rodriguez # Description: Use our `deprecate` helper so that we don't forget to kill this code in the next major release (thanks to #2673). The diff is simple, view it without whitespace changes though. Or maybe I should just go ahead and kill all this code now... 🤔. # Tasks: - [x] Describe the problem / feature - [ ] Write tests - [x] Write code to solve the problem - [ ] Get code review from coworkers / friends I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md). Co-authored-by: David Rodríguez <deivid.rodriguez@riseup.net>

2673: Check deprecated methods on release r=bronzdoc a=deivid-rodriguez # Description: I noticed that we have a bunch of methods in the code base that were supposed to have been deprecated in December 2018, when rubygems 3 was released, but that didn't happen? I'm not sure if it was intentional or not, but I figured we could have a release check that makes sure we either definitively remove the methods, or expand the deprecation horizon. # Tasks: - [x] Describe the problem / feature - [ ] Write tests - [x] Write code to solve the problem - [ ] Get code review from coworkers / friends I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md). 2676: Fix metadata description docs r=bronzdoc a=sonalkr132 # Description: > settable by gem authors without requiring an update to the rubygems software. this has never been true. Not sure why it said that. Using G in the gem is converting it to link on using `rake spec_guide` ([broken here](rubygems/guides@2ca58b0#diff-a0ed24268b853e4412f766326125de00L12)). # Tasks: - [ ] Describe the problem / feature - [ ] Write tests - [ ] Write code to solve the problem - [ ] Get code review from coworkers / friends I will abide by the [code of conduct](https://github.com/rubygems/rubygems/blob/master/CODE_OF_CONDUCT.md). Co-authored-by: David Rodríguez <deivid.rodriguez@riseup.net> Co-authored-by: Aditya Prakash <aditya.prakash132@gmail.com>

bronzdoc added the status: triage label Mar 7, 2019

deivid-rodriguez force-pushed the check_deprecated_methods_on_release branch from be23d02 to 4712d2b Compare March 7, 2019 14:28

bronzdoc approved these changes Mar 7, 2019

View reviewed changes

deivid-rodriguez commented Mar 7, 2019

View reviewed changes

hsbt approved these changes Mar 8, 2019

View reviewed changes

deivid-rodriguez added 2 commits March 8, 2019 11:24

Exclude pkg folder from the rubocop task

f045390

Add a pre-release task to check for deprecations

fe67f62

Make sure we remove expired deprecations upon release.

deivid-rodriguez force-pushed the check_deprecated_methods_on_release branch from 4712d2b to fe67f62 Compare March 8, 2019 10:25

ghost merged commit fe67f62 into master Mar 8, 2019

bronzdoc removed the status: triage label Mar 8, 2019

ghost deleted the check_deprecated_methods_on_release branch March 8, 2019 15:35

deivid-rodriguez mentioned this pull request Mar 29, 2019

Remove long ago deprecated methods #2704

Merged

4 tasks

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check deprecated methods on release #2673

Check deprecated methods on release #2673

deivid-rodriguez commented Mar 7, 2019

deivid-rodriguez commented Mar 7, 2019

bronzdoc left a comment

deivid-rodriguez Mar 7, 2019 •

edited

deivid-rodriguez commented Mar 8, 2019

bronzdoc commented Mar 8, 2019

ghost commented Mar 8, 2019

Check deprecated methods on release #2673

Check deprecated methods on release #2673

Conversation

deivid-rodriguez commented Mar 7, 2019

Description:

Tasks:

deivid-rodriguez commented Mar 7, 2019

bronzdoc left a comment

Choose a reason for hiding this comment

deivid-rodriguez Mar 7, 2019 • edited

Choose a reason for hiding this comment

deivid-rodriguez commented Mar 8, 2019

bronzdoc commented Mar 8, 2019

ghost commented Mar 8, 2019

Build succeeded

deivid-rodriguez Mar 7, 2019 •

edited