How do I make a method available to both my controller and model in Rails?
I have a private method in my Rails app to connect to Amazon S3, execute a passed block of code, then close the connection to S3. It looks like so;
def S3
AWS::S3::Base.establish_connection!(
:access_key_id => 'Not telling',
:secret_access_key => 'Really not telling'
)
data = yield
AWS::S3::Base.disconnect
data
end
It is called like this (as an example);
send_data(S3 {AWS::S3::S3Object.value("#{@upload_file.name}",'bucket')}, :filename => @upload_file.name)
I call this method in a number of ways in my controller and model so have it included in both classes as a private method. This works fine and I'm happy with it but it's not very DRY.
How can I make this method accessible to both my model and controller but only have the code appear once? This is more of a Ruby question than a Rails question and reflects my newness to OOP. I'm guessing a module or a mix-in is the answer but I haven't really been using either of these up until now and need a little hand-holding.
Thanks.
3 ответа
В Ruby модули используются для трех разных целей. Во-первых, это пространство имен. Наличие определений классов или констант внутри модуля не будет конфликтовать с классами или константами вне этого модуля. Примерно так
class Product
def foo
puts 'first'
end
end
module Affiliate
class Product
puts 'second'
end
end
p = Product.new
p.foo # => 'first'
p = Affiliate::Product.new
p.foo # => 'second'
Второе использование модулей - это место для размещения методов, которым больше нигде нет места. Вы также можете сделать это внутри класса, но использование модуля говорит людям, читающим код, что он не предназначен для создания экземпляра. Что-то вроде этого
module Foo
def self.bar
puts 'hi'
end
end
Foo.bar #=> 'hi'
Наконец (и самое запутанное) то, что модули могут быть включены в другие классы. Их использование также называется миксином, потому что вы «смешиваете» все методы с тем, что вы включаете.
module Foo
def bar
puts 'hi'
end
end
class Baz
include Foo
end
b = Baz.new
b.bar #=> 'hi'
На самом деле миксины - это более полная тема, чем я рассматриваю здесь, но углубление, вероятно, сбивает с толку.
Мне кажется, что S3 действительно принадлежит контроллеру, поскольку именно контроллеры обычно имеют дело с входящими и исходящими соединениями.Если это так, я бы просто имел защищенный метод на контроллере приложения, так как он будет доступен для всех других контроллеров, но по-прежнему будет частным.
Если у вас есть веская причина для того, чтобы это тоже было в модели, я бы пошел на миксин. Что-то вроде
module AwsUtils
private
def S3
AWS::S3::Base.establish_connection!\
:access_key_id => 'Not telling',
:secret_access_key => 'Really not telling'
data = yield
AWS::S3::Base.disconnect
data
end
end
. Если вы поместите это в lib / aws_utils.rb , вы сможете использовать его, добавив include AwsUtils как в ваш контроллер, так и в вашу модель. Rails умеет искать классы и модули в lib, но только если имя совпадает (в широком регистре). Я назвал его AwsUtils, потому что я знаю, какие рельсы будут искать, когда он это увидит (aws_utils.rb), и, честно говоря, я понятия не имею, что ему понадобится для S3Utils; -)
Не стесняйтесь спрашивать дополнительную информацию если я что-то не понял. Модули, как правило, являются одной из тех вещей в Ruby, которые, хотя и удивительны, совершенно сбивают с толку новичков.
Ваша догадка верна: вы можете поместить модуль в каталог lib. В чтобы сделать эти методы доступными для ваших моделей, просто включите их with:
class Model < ActiveRecord::Base
include MyModule
end
Методы экземпляра включенного модуля станут методами экземпляра в вашем классе. (Это называется миксином)
module MyModule
def S3
#...
end
end
Вы можете написать модуль как:
module MyModule
def self.S3(args*)
AWS::S3::Base.establish_connection!(
:access_key_id => 'Not telling',
:secret_access_key => 'Really not telling'
)
data = yield
AWS::S3::Base.disconnect
data
end
end
, а затем вызвать его в своем контроллере или модели как
MyModule.S3 (params *)