Dove mettere le funzioni di supporto per le attività rake e testare i file in Ruby on Rails?

Question

Nella mia applicazione Rails ho un file sample_data.rb all'interno di /lib/tasks e un mucchio di file di test nella mia directory /spec.

Tutti questi file spesso condividono funzionalità comuni come ad esempio:

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

Dove devo mettere quelle funzioni di aiuto? C'è una sorta di convenzione su questo?

Grazie per qualsiasi aiuto!

Answer 1

È possibile creare una classe statica, con funzioni statiche. Che qualcosa sarebbe simile a questa:

class HelperFunctions 

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

    def self.otherFunction 
    end 
end 

Poi, tutto quello che avrebbe bisogno di fare è:

1. Includi la tua classe di supporto nel file che si desidera utilizzare

2. eseguirlo piace:

   HelperFunctions::random_address(anyParametersYouMightHave) 
   

Nel fare questo, assicuratevi di includere eventuali dipendenze nella classe HelperFunctions.

Answer 2

Se si è sicuri che il rake sia solo specifico, è anche possibile aggiungere direttamente in RAILS_ROOT/Rakefile (che probabilmente non è il caso per l'esempio che si utilizza).

Io lo uso per semplificare la sintassi invoke del 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 

In questo modo, posso usare invoke "my_namespace:my_task" in compiti rake invece di Rake::Task[ "my_namespace:my_task" ].invoke.

Answer 3

Si condividono i metodi in un modulo e si inserisce tale modulo nella cartella lib.

Qualcosa di simile lib/fake_data.rb contenente

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

    module_function 
end 

e dentro il vostro compito rake richiedono solo il modulo, e chiamare FakeData.random_address.

Ma, se è come un seme che devi fare ogni volta che esegui i test, dovresti considerare di aggiungere questo al tuo generale before all.

E.g. il mio spec_helper assomiglia a questo:

e il modulo SetupSupport è definito in spec/support/setup_support.rb e si presenta come segue:

module SetupSupport 

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

end 

Non sono sicuro se è necessario caricare i semi, o lo stanno già facendo, ma questo è il posto ideale per generare anche dati falsi necessari.

Si noti che la mia classe di supporto di installazione è definita in spec/support perché il codice è rilevante solo per le mie specifiche, non ho attività rake che richiede lo stesso codice.