如何在Rails项目中重命名控制器和模型

Question

如何在Rails项目中重命名控制器和模型

ruby-on-railsmodelcontrollerrename

98

我创建了一个Rails应用程序，一切都运行良好。但现在，我想要重命名一个控制器和相关模型：

我想将Corps控制器更改为Stores，并将相应的模型也更改为Store。

在Google上查找，人们建议删除并重新生成控制器和模型。问题是这样会擦除每个文件的实际代码！

有什么解决方案吗？

- Hassen

8个回答

11

除了Nobita的回答之外，您还需要更改测试和辅助类定义及文件名，将corps更改为store。 更重要的是，您应该在config/routes.rb文件中将corps更改为store。

因此，您将对控制器、相关模型、视图、辅助程序、测试和路由文件进行更改。

我认为您所看到的使用destroy和generate更好一些。我已经在这里提供了如何操作的答案：Rails：重命名控制器和相应模型

- Holly

7

你可以尝试使用Rails Refactor gem，这是一个命令行工具，用于对Rails项目进行简单的重构，例如重命名model和controller。 使用方法： Rails项目的基本重命名和重构。虽然这些不是完美的，但它们会为您做很多工作，并节省您的时间。在使用之前，建议您从干净的存储库状态开始，以便轻松审查更改。安装：
gem install rails_refactor 使用前，请确保cd到您的Rails项目的根目录。 重命名控制器：
rails_refactor rename OldController NewController

重命名控制器文件和文件中的类名
重命名控制器规范文件和文件中的类名
重命名视图目录
重命名帮助程序文件和文件中的模块名称
更新路由

重命名控制器操作：
$ rails_refactor rename DummyController.old_action new_action

在控制器类文件中重命名控制器操作
重命名所有格式的视图文件

重命名模型：
$ rails_refactor rename OldModel NewModel

重命名模型文件和文件中的类名
重命名规范文件和文件中的类名
重命名迁移和文件中的类名和表名

...

- Asme Just

6

还有一件重要的事情是，您需要更新模型关联。无论您是手动更名还是销毁并生成资源（因为它们存在于其他模型中），都必须这样做。您可以运行迁移以更改数据库中外键列的名称，并更改代码中对这些外键的所有引用：

rename_column :table, :old_id, :new_id

或者在声明使用旧外键的关联时设置自定义外键：

belongs_to :new, foreign_key: "old_id"

此外，如果您的资源包括图像，则通常存储在包含资源名称的目录中，但是（至少使用Carrierwave），一旦更改了资源的名称，它们将被错误地引用（文件存在于“/uploads/old/image/1/pic.jpg”但是被搜索时应该在“uploads/new/...”），因此您必须删除并重新上传图像，将它们移动到新路径，或者更改它们的查找位置。

- Pwnrar

6

除了Nobita的答案（如果我有足够的声望，我会进行评论），如果你感觉勇敢，那么可以在一定程度上自动更改文件名和代码中对模型的引用。例如，要更改代码中的引用，您可以使用单数、减号和大写字母：

单数、减号和大写字母：

grep -rl corp | xargs sed -i 's/corp/store/g'
grep -rl Corp | xargs sed -i 's/Corp/Store/g'

复数、负数和正数（如果复数只需要在末尾添加一个s字符，则将单数替换为复数）：

grep -rl corps | xargs sed -i 's/corps/stores/g'
grep -rl Corps | xargs sed -i 's/Corps/Stores/g'

重命名文件：

find . -name '*corp*' -exec bash -c 'mv $0 ${0/corp/store}' {} \;

在一些*nix操作系统中（包括Slackware），有一个叫做rename的实用工具可以帮助你重命名文件：

shopt -s globstar
rename -v corps stores app/**/*corps* config/**/*corps* test/**/*corps*

请注意，检查重命名是否是您所认为的内容。我知道其他发行版（如Ubuntu）可能会使用同名但不同的实用程序（参见https://unix.stackexchange.com/questions/78621/find-rename-command-doesnt-work）。在Ubuntu上，您应该执行以下操作：

shopt -s globstar
rename -v 's/corps/stores/' app/**/*corps* config/**/*corps* test/**/*corps*

请注意，您要避免重命名 db/ 目录中的任何文件，除非在 seeds.rb 文件中可能需要进行更改，因此您可能希望将此目录排除在外并手动进行任何更改。

- Dan

0

如果您有模型测试，您需要进行更改：

文件重命名：corp_test.rb -> store_test.rb（控制器测试、集成测试、固定装置等也是如此）

store_test.rb的代码：将class CorpTest更改为class StoreTest。

并且所有控制器、模型、集成、固定装置测试中的corp引用都需要更改。

- Benjamin J. Benoudis

0

如果您要手动更改控制器，则需要在以下位置进行更改：

路由
app/views
app/controllers
test/controllers
app/helper
app/assets/javascripts/
app/assets/stylesheets/

对于模型，Nobita的答案非常好。

- Ravi

0

作为一个刚刚完成这个痛苦过程的人，最重要的步骤是构建足够的测试来检查尽可能多的功能。它们不仅应该涵盖您计划重命名的模型/控制器，还应涵盖所有其他模型/控制器/视图部分。无论如何，这都是一个很好的（甚至是必须的）实践。

通过迭代来执行这些步骤，有时候你需要回到几次步骤（5次或更多次）以发现需要更改的其他文件。现在来看看重命名步骤：

将 db/migrate 文件夹中所有包含 Corps/Corp 的文件（名称和内容）更改为 Stores/Store
尝试运行：

rake db:drop:all

rake db:create

rake db:migrate
更改 db/seeds.rb 文件的内容。
尝试运行：rake db:seed --trace（在此步骤中，您可能需要更改其他模型/控制器文件）
更改 test/fixtures 文件。您可能不仅需要更改 corps.yml 文件，还需要更改其他相关文件（有些文件可能包括 corp_id）。
尝试运行测试，最好使用固定的 seed 运行它（添加：TESTOPTS="--seed=1981" 或任何其他数字）
重命名文件（名称和内容），请注意有时需要更改测试和其他应用程序文件

- ChaosPredictor

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Nobita · Accepted Answer

以下是我的做法：

创建一个迁移(migration)以更改表名(数据库层面)。我假设你的旧表名为corps。迁移内容将如下：

class RenameCorpsToStores < ActiveRecord::Migration
  def change
    rename_table :corps, :stores
  end
end

更改您的模型文件名、模型类定义和模型关联：

将文件名从corp.rb改为store.rb
store.rb中的代码：将class Corp更改为class Store
重命名所有模型关联，例如将has_many :corps改为has_many :stores

更改您的控制器文件名和控制器类定义：

将文件名从corps_controller.rb改为stores_controller.rb
stores_controller.rb中的代码：将class CorpsController更改为class StoresController

重命名视图文件夹，从corps改为stores。

在config/routes.rb文件中对路径进行必要的更改，例如resources :corps改为resources :stores，并确保代码中所有引用都从corps更改为stores（如corps_path等）。

记得运行迁移 :)

如果上述不可行，则尝试删除db/schema.rb并执行：

 $ rake db:drop db:create db:migrate