Use app namespace for framework tasks #23439

ryohashimoto · 2016-02-03T01:47:35Z

By introducing Rake proxy, rake rails commands become rails rails commands (rails rails:template, rails rails:update etc.) .

For simplicity, I removed the rails namespace from the framework codes and docs. (and now we can use rails template, rails update etc.)

updated:

Not removing the rails namespace, use app namespace instead.
e.g. rails rails:template and rails rails:update tasks should be rails app:template, rails app:update

rails-bot · 2016-02-03T01:47:38Z

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @kaspth (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

ryohashimoto · 2016-02-03T02:34:43Z

railties/lib/rails/tasks/framework.rake

@@ -1,68 +1,66 @@
-namespace :rails do


In this file, only the namespace and indentations are changed.

kaspth · 2016-02-03T08:19:18Z

I don't think we should change this right now. I think more of bin/rails as the runner, and that the commands it runs pertains to the app itself... mostly. Because some commands fiddle more with the framework, i.e. those in the rails namespace. I say we keep it like this for 5.0 and spare the deprecation cycle. Thanks!

matthewd · 2016-02-03T08:57:06Z

@kaspth should we change the namespace to app: or something? rails rails:foo does look pretty terrible.

ryohashimoto · 2016-02-03T09:23:53Z

@matthewd
I think so too.
The rails namespace is used for multiple purposes (update and template). So we could remove the namespace or use another namespace.

kaspth · 2016-02-03T12:44:00Z

Yeah, app sounds good.

We should still define the rails versions but enrich them with a deprecation prerequisite task.

ryohashimoto · 2016-02-04T03:50:36Z

@kaspth
Thanks for reopening this PR.
I updated the PR to use app namespace and add deprecation warnings for existing tasks under the rails namespace.

kaspth · 2016-02-07T17:28:27Z

railties/CHANGELOG.md

@@ -1,3 +1,7 @@
+* Use app namespace instead of rails namespace from the framework rake tasks.


Needs more info. Mention some of the tasks and that the rails: namespace has been deprecated.

kaspth · 2016-02-07T17:35:28Z

Also needs a rebase (and remember to keep your commits squashed). Thanks ❤️

ryohashimoto · 2016-02-13T05:22:56Z

@kaspth
Thanks for your advice.
Modified to use ActiveSupport::Deprecation.warn and removed deprecated task in the rails namespace.
So, when the task in the rails namespace is executed, only a deprecation message is printed out.

kaspth · 2016-02-13T14:15:33Z

railties/lib/rails/tasks/framework.rake

+      Running this task with the rails task namespace is deprecated in favor of app.
+      Please run e.g. bin/rails #{task.sub(/^rails:/, 'app:')} instead."
+    MSG
+  end


Sorry wasn't clear enough.

Don't need to print deprecation warnings for every task in the namespace.

I meant we shouldn't use Rake.application.top_level_tasks.grep(/^rails:/). I didn't mean to remove the deprecation enrichment of the rails: namespaced tasks, that part was correct before.

We should replace this with:

task :deprecated do |task| ActiveSupport::Deprecation.warn(<<-MSG.squish) Running #{task.name.sub('deprecated:', '')} with the rails: namespace is deprecated in favor of app. Run e.g. bin/rails app:update instead." MSG end

I modified the codes for the :rails namespace in my local environment.

namespace :rails do task :deprecated do |task| ActiveSupport::Deprecation.warn(<<-MSG.squish) Running #{task.name.sub('deprecated:', '')} with the rails: namespace is deprecated in favor of app. Run e.g. bin/rails app:update instead." MSG end task :update => ['deprecated', 'app:update'] task :template => ['deprecated', 'app:template'] namespace :templates do task :copy => ['deprecated', 'app:templates:copy'] end namespace :update do task :configs => ['deprecated', 'app:update:configs'] task :bin => ['deprecated', 'app:update:bin'] end end

and ran the command.

$ rails rails:update 1 ↵ DEPRECATION WARNING: Running rails:deprecated with the rails: namespace is deprecated in favor of app. Run e.g. bin/rails app:update instead.". (called from block in execute at /Users/ryo/.rbenv/versions/2.3.0/lib/ruby/gems/2.3.0/gems/rake-10.5.0/lib/rake/task.rb:238)

The message is incorrect because rails:deprecated isn't the original task used by the actual command.

The code

Rake.application.top_level_tasks

returns only task names given in a command. (e.g. when rails rails:update is given, only [rails:update] is returned, not all tasks in the rails: namespace.)

So, I think the below snippet is correct.

namespace :rails do task :deprecated do |task| Rake.application.top_level_tasks.grep(/^rails:/).each do |task| ActiveSupport::Deprecation.warn(<<-MSG.squish) Running #{task} with the rails: namespace is deprecated in favor of app. Run e.g. bin/rails #{task.sub(/^rails:/, 'app:')} instead." MSG end end task :update => ['deprecated', 'app:update'] task :template => ['deprecated', 'app:template'] namespace :templates do task :copy => ['deprecated', 'app:templates:copy'] end namespace :update do task :configs => ['deprecated', 'app:update:configs'] task :bin => ['deprecated', 'app:update:bin'] end end

OK, I understand.
I removed Rake.application.top_level_tasks.grep(/^rails:/)

ryohashimoto · 2016-02-16T01:40:14Z

Updated and rebased. I think it's better to use deprecated task names like below.
(And it doesn't deprecate all tasks with rails: namespace.)

namespace :rails do
  %i(update template templates:copy update:configs update:bin).each do |task_name|
    task "#{task_name}" do
      ActiveSupport::Deprecation.warn(<<-MSG.squish)
        Running #{task_name} with the rails: namespace is deprecated in favor of app.
        Run e.g. bin/rails app:#{task_name} instead."
      MSG
      Rake.application.invoke_task("app:#{task_name}")
    end
  end
end

ryohashimoto · 2016-02-16T01:52:05Z

@kaspth
Could you take a look?

kaspth · 2016-02-24T12:11:52Z

Looks good and thanks for your patience! Can you rebase? If not, I will do it tonight 😄

kaspth · 2016-02-24T12:12:50Z

Wait, what do you mean by "(And it doesn't deprecate all tasks with rails: namespace.)"?

ryohashimoto · 2016-02-24T13:04:02Z

@kaspth
Thanks for your support. Rebased now.

(And it doesn't deprecate all tasks with rails: namespace.)

I mean only tasks listed below are now deprecated. If someone add other tasks in the 'rails' namespace,
they shouldn't be deprecated because they don't have corresponding tasks in the 'app' namespace.
I believe this approach is natural.

%i(update template templates:copy update:configs update:bin) # in the rails namespace

…amespace. (e.g. `rails:update` and `rails:template` tasks is renamed to `app:update` and `app:template`.)

Use app namespace for framework tasks

kaspth · 2016-02-27T14:15:10Z

@ryohashimoto thanks!

ryohashimoto · 2016-02-27T14:35:43Z

@kaspth Thanks a lot !

@kaspth

This guides were pointing to this command `rails app:update`, which I tried to run, but it didnt worked. I think the right command is `rails rails:update` instead. Also thats the name of the rake task. Also I removed the `Rake` word from the title, as we run it using `rails` bin now. cc @kaspth [skip ci]

Rake tasks `rails:update` or `rails:template` and so on were deprecated on Rails 5.0, and will be removed on Rails 5.1. So we should switch a task name. ref: * rails/rails#23439 * rails/rails@f778281

rails-bot assigned kaspth Feb 3, 2016

ryohashimoto force-pushed the 160203_rake_rails branch from 798e4cc to 39f47bb Compare February 3, 2016 02:26

ryohashimoto reviewed Feb 3, 2016
View reviewed changes

ryohashimoto force-pushed the 160203_rake_rails branch from 39f47bb to 06e051e Compare February 3, 2016 02:35

kaspth closed this Feb 3, 2016

kaspth reopened this Feb 3, 2016

ryohashimoto force-pushed the 160203_rake_rails branch 5 times, most recently from 3ccfddb to 80aaef1 Compare February 4, 2016 03:47

ryohashimoto changed the title ~~Remove rails namespace for framework tasks~~ Use app namespace for framework tasks Feb 4, 2016

ryohashimoto force-pushed the 160203_rake_rails branch 2 times, most recently from 7d3c04b to cb3b482 Compare February 5, 2016 03:46

kaspth reviewed Feb 7, 2016
View reviewed changes

ryohashimoto force-pushed the 160203_rake_rails branch 2 times, most recently from d6435f5 to 4fa1ded Compare February 13, 2016 05:14

kaspth reviewed Feb 13, 2016
View reviewed changes

ryohashimoto force-pushed the 160203_rake_rails branch from 4fa1ded to 5da0c51 Compare February 16, 2016 01:34

ryohashimoto force-pushed the 160203_rake_rails branch from 5da0c51 to 237ff9e Compare February 16, 2016 01:54

ryohashimoto force-pushed the 160203_rake_rails branch from 237ff9e to 9506907 Compare February 23, 2016 09:48

ryohashimoto force-pushed the 160203_rake_rails branch from 9506907 to 3bcaba0 Compare February 24, 2016 12:53

ryohashimoto force-pushed the 160203_rake_rails branch from 3bcaba0 to 5d16e7f Compare February 25, 2016 01:23

The tasks in the rails task namespace is deprecated in favor of app n…

eaec958

…amespace. (e.g. `rails:update` and `rails:template` tasks is renamed to `app:update` and `app:template`.)

ryohashimoto force-pushed the 160203_rake_rails branch from 5d16e7f to eaec958 Compare February 26, 2016 10:36

kaspth added a commit that referenced this pull request Feb 27, 2016

Merge pull request #23439 from ryohashimoto/160203_rake_rails

6fb3163

Use app namespace for framework tasks

kaspth merged commit 6fb3163 into rails:master Feb 27, 2016

maclover7 added railties docs labels Feb 27, 2016

ryohashimoto deleted the 160203_rake_rails branch February 27, 2016 14:35

vipulnsward mentioned this pull request Apr 15, 2016

Fix wrong task name in 'A Guide for Upgrading Ruby on Rails' [ci skip] #24562

Closed

yui-knk mentioned this pull request Mar 23, 2017

Switch template task name depending on Rails version rspec/rspec-rails#1796

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use app namespace for framework tasks #23439

Use app namespace for framework tasks #23439

ryohashimoto commented Feb 3, 2016

rails-bot commented Feb 3, 2016

ryohashimoto Feb 3, 2016

kaspth commented Feb 3, 2016

matthewd commented Feb 3, 2016

ryohashimoto commented Feb 3, 2016

kaspth commented Feb 3, 2016

ryohashimoto commented Feb 4, 2016

kaspth Feb 7, 2016

kaspth commented Feb 7, 2016

ryohashimoto commented Feb 13, 2016

kaspth Feb 13, 2016

kaspth Feb 13, 2016

ryohashimoto Feb 15, 2016

ryohashimoto Feb 15, 2016

ryohashimoto Feb 16, 2016

ryohashimoto commented Feb 16, 2016

ryohashimoto commented Feb 16, 2016

kaspth commented Feb 24, 2016

kaspth commented Feb 24, 2016

ryohashimoto commented Feb 24, 2016

kaspth commented Feb 27, 2016

ryohashimoto commented Feb 27, 2016

		@@ -1,3 +1,7 @@
		* Use app namespace instead of rails namespace from the framework rake tasks.

Use app namespace for framework tasks #23439

Use app namespace for framework tasks #23439

Conversation

ryohashimoto commented Feb 3, 2016

rails-bot commented Feb 3, 2016

ryohashimoto Feb 3, 2016

Choose a reason for hiding this comment

kaspth commented Feb 3, 2016

matthewd commented Feb 3, 2016

ryohashimoto commented Feb 3, 2016

kaspth commented Feb 3, 2016

ryohashimoto commented Feb 4, 2016

kaspth Feb 7, 2016

Choose a reason for hiding this comment

kaspth commented Feb 7, 2016

ryohashimoto commented Feb 13, 2016

kaspth Feb 13, 2016

Choose a reason for hiding this comment

kaspth Feb 13, 2016

Choose a reason for hiding this comment

ryohashimoto Feb 15, 2016

Choose a reason for hiding this comment

ryohashimoto Feb 15, 2016

Choose a reason for hiding this comment

ryohashimoto Feb 16, 2016

Choose a reason for hiding this comment

ryohashimoto commented Feb 16, 2016

ryohashimoto commented Feb 16, 2016

kaspth commented Feb 24, 2016

kaspth commented Feb 24, 2016

ryohashimoto commented Feb 24, 2016

kaspth commented Feb 27, 2016

ryohashimoto commented Feb 27, 2016