如何基于当前的Rails环境设置回形针的存储机制?


75

我有一个Rails应用程序,其中有多个带有回形针附件的模型,这些模型都已上载到S3。此应用程序还具有经常运行的大型测试套件。这样做的缺点是每次测试运行都会将大量文件上载到我们的S3帐户,从而使测试套件运行缓慢。它还会减慢开发速度,并且需要您具有Internet连接才能处理代码。

是否有合理的方法基于Rails环境设置回形针存储机制?理想情况下,我们的测试和开发环境将使用本地文件系统存储,而生产环境将使用S3存储。

我还想将此逻辑提取到某种共享模块中,因为我们有几个需要此行为的模型。我想在每个模型中避免这样的解决方案:

### We don't want to do this in our models...
if Rails.env.production?
  has_attached_file :image, :styles => {...},
                    :path => "images/:uuid_partition/:uuid/:style.:extension",
                    :storage => :s3,
                    :url => ':s3_authenticated_url', # generates an expiring url
                    :s3_credentials => File.join(Rails.root, 'config', 's3.yml'),
                    :s3_permissions => 'private',
                    :s3_protocol => 'https'
else
  has_attached_file :image, :styles => {...},
                    :storage => :filesystem
                    # Default :path and :url should be used for dev/test envs.
end

更新:棘手的部分是,根据所使用的存储系统,附件的附件:path:url选项需要有所不同。

任何意见或建议,将不胜感激!:-)

Answers:


78

我更喜欢Barry的建议,没有什么可以阻止您将变量设置为哈希,然后可以将其与回形针选项合并。

在config / environments / development.rb和test.rb中设置类似

PAPERCLIP_STORAGE_OPTIONS = {}

并在config / environments / production.rb中

PAPERCLIP_STORAGE_OPTIONS = {:storage => :s3, 
                               :s3_credentials => "#{Rails.root}/config/s3.yml",
                               :path => "/:style/:filename"}

最后在回形针模型中:

has_attached_file :image, {
    :styles => {:thumb => '50x50#', :original => '800x800>'}
}.merge(PAPERCLIP_STORAGE_OPTIONS)

更新:Paperclip for Rails 3.x应用程序最近实现了类似的方法。现在可以使用来设置特定于环境的设置config.paperclip_defaults = {:storage => :s3, ...}


32

您可以在特定于环境的配置文件中设置全局默认配置数据。例如,在config / environments / production.rb中:

Paperclip::Attachment.default_options.merge!({
  :storage => :s3,
  :bucket => 'wheresmahbucket',
  :s3_credentials => {
    :access_key_id => ENV['S3_ACCESS_KEY_ID'],
    :secret_access_key => ENV['S3_SECRET_ACCESS_KEY']
  }
})

更少的元数据,更明确的路径,绝对是必经之路。甚至可以将其提取到每个环境具有名称空间的YAML文件中。感谢@austinfromboston
肯尼思·

27

在玩了一段时间之后,我想出了一个可以满足我需要的模块。

内部app/models/shared/attachment_helper.rb

module Shared
  module AttachmentHelper

    def self.included(base)
      base.extend ClassMethods
    end

    module ClassMethods
      def has_attachment(name, options = {})

        # generates a string containing the singular model name and the pluralized attachment name.
        # Examples: "user_avatars" or "asset_uploads" or "message_previews"
        attachment_owner    = self.table_name.singularize
        attachment_folder   = "#{attachment_owner}_#{name.to_s.pluralize}"

        # we want to create a path for the upload that looks like:
        # message_previews/00/11/22/001122deadbeef/thumbnail.png
        attachment_path     = "#{attachment_folder}/:uuid_partition/:uuid/:style.:extension"

        if Rails.env.production?
          options[:path]            ||= attachment_path
          options[:storage]         ||= :s3
          options[:url]             ||= ':s3_authenticated_url'
          options[:s3_credentials]  ||= File.join(Rails.root, 'config', 's3.yml')
          options[:s3_permissions]  ||= 'private'
          options[:s3_protocol]     ||= 'https'
        else
          # For local Dev/Test envs, use the default filesystem, but separate the environments
          # into different folders, so you can delete test files without breaking dev files.
          options[:path]  ||= ":rails_root/public/system/attachments/#{Rails.env}/#{attachment_path}"
          options[:url]   ||= "/system/attachments/#{Rails.env}/#{attachment_path}"
        end

        # pass things off to paperclip.
        has_attached_file name, options
      end
    end
  end
end

(注:我使用一些自定义的回形针插值以上,如:uuid_partition:uuid:s3_authenticated_url你需要修改的东西根据需要为特定的应用程序。)

现在,对于每个具有回形针附件的模型,您只需要包括此共享模块并调用has_attachment方法(而不是回形针的has_attached_file)即可

模型文件示例app/models/user.rb

class User < ActiveRecord::Base
  include Shared::AttachmentHelper  
  has_attachment :avatar, :styles => { :thumbnail => "100x100>" }
end

放置此位置后,您将文件保存到以下位置,具体取决于您的环境:

发展:

RAILS_ROOT + public/attachments/development/user_avatars/aa/bb/cc/aabbccddeeff/thumbnail.jpg

测试:

RAILS_ROOT + public/attachments/test/user_avatars/aa/bb/cc/aabbccddeeff/thumbnail.jpg

生产:

https://s3.amazonaws.com/your-bucket-name/user_avatars/aa/bb/cc/aabbccddeeff/thumbnail.jpg

这正是我要寻找的,希望对其他人也有用。:)

-约翰


辛苦了 是的,需要比我提供的更多的抽象!:)
巴里·赫斯

我在使用上述常量/哈希方法时遇到了麻烦,但是这种方法效果很好,而且我喜欢如何将所有回形针逻辑放在一个地方。谢谢!
neezer 2011年

5

这个怎么样:

  1. 默认值在application.rb中建立。使用了:filesystem的默认存储,但已初始化s3的配置
  2. Production.rb启用:s3存储并更改默认路径

Application.rb

config.paperclip_defaults = 
{
  :hash_secret => "LongSecretString",
  :s3_protocol => "https",
  :s3_credentials => "#{Rails.root}/config/aws_config.yml",
  :styles => { 
    :original => "1024x1024>",
    :large => "600x600>", 
    :medium => "300x300>",
    :thumb => "100x100>" 
  }
}

Development.rb(取消注释以在开发模式下尝试使用s3)

# config.paperclip_defaults.merge!({
#   :storage => :s3,
#   :bucket => "mydevelopmentbucket",
#   :path => ":hash.:extension"
# })

Production.rb:

config.paperclip_defaults.merge!({
  :storage => :s3,
  :bucket => "myproductionbucket",
  :path => ":hash.:extension"
})

在您的模型中:

has_attached_file :avatar 

2

您不能只在production / test / development.rb中设置环境变量吗?

PAPERCLIP_STORAGE_MECHANISM = :s3

然后:

has_attached_file :image, :styles => {...},
                  :storage => PAPERCLIP_STORAGE_MECHANISM,
                  # ...etc...

1
嘿,巴里,这是一个很好的建议,但是“ ...等...”内部的各种选项都会引起麻烦。我发现:path和:url选项需要根据使用的是:s3还是:filesystem存储而有所不同。我将用一个更好的示例来更新问题。谢谢,
John

0

我的解决方案与@runesoerensen答案相同:

我在中创建一个模块PaperclipStorageOptionconfig/initializers/paperclip_storage_option.rb 代码非常简单:

module PaperclipStorageOption
  module ClassMethods
    def options
      Rails.env.production? ? production_options : default_options
    end

    private

    def production_options
      {
        storage: :dropbox,
        dropbox_credentials: Rails.root.join("config/dropbox.yml")
      }
    end

    def default_options
      {}
    end
  end

  extend ClassMethods
end

并在我们的模型中使用 has_attached_file :avatar, { :styles => { :medium => "1200x800>" } }.merge(PaperclipStorageOption.options)

就是这样,希望对您有所帮助


-4

定义附件路径时,使用:rails_env插值:

has_attached_file :attachment, :path => ":rails_root/storage/:rails_env/attachments/:id/:style/:basename.:extension"
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.