ruby - 在 Ruby on Rails 中将 rake 任务和测试文件的辅助函数放在哪里？

Question

在我的 Rails 应用程序中，我的目录中有一个文件sample_data.rb以及/lib/tasks一堆测试文件/spec。

所有这些文件通常具有共同的功能，例如：

def random_address
  [Faker::Address.street_address, Faker::Address.city].join("\n")
end

我应该把这些辅助函数放在哪里？对此有某种约定吗？

谢谢你的帮助！

Answer 1

您可以使用静态函数创建一个静态类。看起来像这样：

class HelperFunctions

     def self.random_address
          [Faker::Address.street_address, Faker::Address.city].join("\n")
     end

     def self.otherFunction
     end
end

然后，您需要做的就是：

1. 在您要使用的文件中包含您的助手类

2. 像这样执行它：

   HelperFunctions::random_address(anyParametersYouMightHave)
   

执行此操作时，请确保在HelperFunctions类中包含任何依赖项。

Answer 2

如果您确定它只是特定于 rake，您也可以直接添加RAILS_ROOT/Rakefile（您使用的示例可能不是这种情况）。

我用它来简化 rake 的调用语法：

#!/usr/bin/env rake
# Add your own tasks in files placed in lib/tasks ending in .rake,
# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.

require File.expand_path('../config/application', __FILE__)

def invoke( task_name )
  Rake::Task[ task_name ].invoke
end

MyApp::Application.load_tasks

这样，我可以invoke "my_namespace:my_task"在 rake 任务中使用而不是Rake::Task[ "my_namespace:my_task" ].invoke.

Answer 3

您在模块中共享方法，并将这样的模块放置在lib文件夹中。

像lib/fake_data.rb包含的东西

module FakeData
  def random_address
    [Faker::Address.street_address, Faker::Address.city].join("\n")
  end

  module_function 
end

在你的 rake 任务中只需要模块，然后调用FakeData.random_address.

但是，如果它就像你每次运行测试时都需要做的种子，你应该考虑将它添加到你的 general before all.

例如我的spec_helper样子是这样的：

# Requires supporting ruby files with custom matchers and macros, etc,
# in spec/support/ and its subdirectories.
Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }

RSpec.configure do |config|
  config.use_transactional_fixtures = true
  config.infer_base_class_for_anonymous_controllers = false
  config.order = "random"

  include SetupSupport

  config.before(:all) do
    load_db_seed
  end
end

模块SetupSupport定义spec/support/setup_support.rb如下：

module SetupSupport

  def load_db_seed
    load(File.join(Rails.root, 'db', 'seeds.rb'))
  end

end

不确定您是否需要加载种子，或者已经在这样做，但这是生成所需假数据的理想场所。

请注意，我的设置支持类已定义，spec/support因为代码仅与我的规范相关，我没有 rake 任务也需要相同的代码。