Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Finally decided not to keep attachment_fu (didn't managed to solve at…

…tachment_fu related errors..)
  • Loading branch information...
commit 7678b67bcc47a1544d25722c17e9d1e0e9a0d4e0 1 parent 3bb3dbb
Jean-Baptiste Barth jbbarth authored

Showing 44 changed files with 0 additions and 3,192 deletions. Show diff stats Hide diff stats

  1. +0 14 config/amazon_s3.yml
  2. +0 35 vendor/plugins/attachment_fu/CHANGELOG
  3. +0 162 vendor/plugins/attachment_fu/README
  4. +0 22 vendor/plugins/attachment_fu/Rakefile
  5. +0 14 vendor/plugins/attachment_fu/amazon_s3.yml.tpl
  6. +0 16 vendor/plugins/attachment_fu/init.rb
  7. +0 5 vendor/plugins/attachment_fu/install.rb
  8. +0 93 vendor/plugins/attachment_fu/lib/geometry.rb
  9. +0 465 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu.rb
  10. +0 39 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/db_file_backend.rb
  11. +0 97 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/file_system_backend.rb
  12. +0 303 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/s3_backend.rb
  13. +0 56 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/processors/core_image_processor.rb
  14. +0 54 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/processors/gd2_processor.rb
  15. +0 61 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/processors/image_science_processor.rb
  16. +0 59 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/processors/mini_magick_processor.rb
  17. +0 54 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/processors/rmagick_processor.rb
  18. +0 16 vendor/plugins/attachment_fu/test/backends/db_file_test.rb
  19. +0 80 vendor/plugins/attachment_fu/test/backends/file_system_test.rb
  20. +0 107 vendor/plugins/attachment_fu/test/backends/remote/s3_test.rb
  21. +0 57 vendor/plugins/attachment_fu/test/base_attachment_tests.rb
  22. +0 64 vendor/plugins/attachment_fu/test/basic_test.rb
  23. +0 18 vendor/plugins/attachment_fu/test/database.yml
  24. +0 57 vendor/plugins/attachment_fu/test/extra_attachment_test.rb
  25. +0 148 vendor/plugins/attachment_fu/test/fixtures/attachment.rb
  26. BIN  vendor/plugins/attachment_fu/test/fixtures/files/fake/rails.png
  27. +0 1  vendor/plugins/attachment_fu/test/fixtures/files/foo.txt
  28. BIN  vendor/plugins/attachment_fu/test/fixtures/files/rails.png
  29. +0 101 vendor/plugins/attachment_fu/test/geometry_test.rb
  30. +0 31 vendor/plugins/attachment_fu/test/processors/core_image_test.rb
  31. +0 31 vendor/plugins/attachment_fu/test/processors/gd2_test.rb
  32. +0 31 vendor/plugins/attachment_fu/test/processors/image_science_test.rb
  33. +0 31 vendor/plugins/attachment_fu/test/processors/mini_magick_test.rb
  34. +0 255 vendor/plugins/attachment_fu/test/processors/rmagick_test.rb
  35. +0 108 vendor/plugins/attachment_fu/test/schema.rb
  36. +0 142 vendor/plugins/attachment_fu/test/test_helper.rb
  37. +0 55 vendor/plugins/attachment_fu/test/validation_test.rb
  38. +0 27 vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/color.rb
  39. +0 31 vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/effects.rb
  40. +0 25 vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/perspective.rb
  41. +0 25 vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/quality.rb
  42. +0 47 vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/scale.rb
  43. +0 32 vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/watermark.rb
  44. +0 123 vendor/plugins/attachment_fu/vendor/red_artisan/core_image/processor.rb
14 config/amazon_s3.yml
... ... @@ -1,14 +0,0 @@
1   -development:
2   - bucket_name: appname_development
3   - access_key_id:
4   - secret_access_key:
5   -
6   -test:
7   - bucket_name: appname_test
8   - access_key_id:
9   - secret_access_key:
10   -
11   -production:
12   - bucket_name: appname
13   - access_key_id:
14   - secret_access_key:
35 vendor/plugins/attachment_fu/CHANGELOG
... ... @@ -1,35 +0,0 @@
1   -* Apr 17 2008 *
2   -* amazon_s3.yml is now passed through ERB before being passed to AWS::S3 [François Beausoleil]
3   -
4   -* Mar 22 2008 *
5   -* Some tweaks to support Rails 2.0 and Rails 2.1 due to ActiveSupport::Callback changes.
6   - Thanks to http://blog.methodmissing.com/2008/1/19/edge-callback-refactorings-attachment_fu/
7   -
8   -* Feb. 26, 2008 *
9   -* remove breakpoint from test_helper, makes test suite crazy (at least Rails 2+) [Rob Sanheim]
10   -* make S3 test really optional [Rob Sanheim]
11   -
12   -* Nov 27, 2007 *
13   -* Handle properly ImageScience thumbnails resized from a gif file [Matt Aimonetti]
14   -* Save thumbnails file size properly when using ImageScience [Matt Aimonetti]
15   -* fixed s3 config file loading with latest versions of Rails [Matt Aimonetti]
16   -
17   -* April 2, 2007 *
18   -
19   -* don't copy the #full_filename to the default #temp_paths array if it doesn't exist
20   -* add default ID partitioning for attachments
21   -* add #binmode call to Tempfile (note: ruby should be doing this!) [Eric Beland]
22   -* Check for current type of :thumbnails option.
23   -* allow customization of the S3 configuration file path with the :s3_config_path option.
24   -* Don't try to remove thumbnails if there aren't any. Closes #3 [ben stiglitz]
25   -
26   -* BC * (before changelog)
27   -
28   -* add default #temp_paths entry [mattly]
29   -* add MiniMagick support to attachment_fu [Isacc]
30   -* update #destroy_file to clear out any empty directories too [carlivar]
31   -* fix references to S3Backend module [Hunter Hillegas]
32   -* make #current_data public with db_file and s3 backends [ebryn]
33   -* oops, actually svn add the files for s3 backend. [Jeffrey Hardy]
34   -* experimental s3 support, egad, no tests.... [Jeffrey Hardy]
35   -* doh, fix a few bad references to ActsAsAttachment [sixty4bit]
162 vendor/plugins/attachment_fu/README
... ... @@ -1,162 +0,0 @@
1   -attachment-fu
2   -=============
3   -
4   -attachment_fu is a plugin by Rick Olson (aka technoweenie <http://techno-weenie.net>) and is the successor to acts_as_attachment. To get a basic run-through of its capabilities, check out Mike Clark's tutorial <http://clarkware.com/cgi/blosxom/2007/02/24#FileUploadFu>.
5   -
6   -
7   -attachment_fu functionality
8   -===========================
9   -
10   -attachment_fu facilitates file uploads in Ruby on Rails. There are a few storage options for the actual file data, but the plugin always at a minimum stores metadata for each file in the database.
11   -
12   -There are three storage options for files uploaded through attachment_fu:
13   - File system
14   - Database file
15   - Amazon S3
16   -
17   -Each method of storage many options associated with it that will be covered in the following section. Something to note, however, is that the Amazon S3 storage requires you to modify config/amazon_s3.yml and the Database file storage requires an extra table.
18   -
19   -
20   -attachment_fu models
21   -====================
22   -
23   -For all three of these storage options a table of metadata is required. This table will contain information about the file (hence the 'meta') and its location. This table has no restrictions on naming, unlike the extra table required for database storage, which must have a table name of db_files (and by convention a model of DbFile).
24   -
25   -In the model there are two methods made available by this plugins: has_attachment and validates_as_attachment.
26   -
27   -has_attachment(options = {})
28   - This method accepts the options in a hash:
29   - :content_type # Allowed content types.
30   - # Allows all by default. Use :image to allow all standard image types.
31   - :min_size # Minimum size allowed.
32   - # 1 byte is the default.
33   - :max_size # Maximum size allowed.
34   - # 1.megabyte is the default.
35   - :size # Range of sizes allowed.
36   - # (1..1.megabyte) is the default. This overrides the :min_size and :max_size options.
37   - :resize_to # Used by RMagick to resize images.
38   - # Pass either an array of width/height, or a geometry string.
39   - :thumbnails # Specifies a set of thumbnails to generate.
40   - # This accepts a hash of filename suffixes and RMagick resizing options.
41   - # This option need only be included if you want thumbnailing.
42   - :thumbnail_class # Set which model class to use for thumbnails.
43   - # This current attachment class is used by default.
44   - :path_prefix # path to store the uploaded files.
45   - # Uses public/#{table_name} by default for the filesystem, and just #{table_name} for the S3 backend.
46   - # Setting this sets the :storage to :file_system.
47   - :storage # Specifies the storage system to use..
48   - # Defaults to :db_file. Options are :file_system, :db_file, and :s3.
49   - :processor # Sets the image processor to use for resizing of the attached image.
50   - # Options include ImageScience, Rmagick, and MiniMagick. Default is whatever is installed.
51   -
52   -
53   - Examples:
54   - has_attachment :max_size => 1.kilobyte
55   - has_attachment :size => 1.megabyte..2.megabytes
56   - has_attachment :content_type => 'application/pdf'
57   - has_attachment :content_type => ['application/pdf', 'application/msword', 'text/plain']
58   - has_attachment :content_type => :image, :resize_to => [50,50]
59   - has_attachment :content_type => ['application/pdf', :image], :resize_to => 'x50'
60   - has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
61   - has_attachment :storage => :file_system, :path_prefix => 'public/files'
62   - has_attachment :storage => :file_system, :path_prefix => 'public/files',
63   - :content_type => :image, :resize_to => [50,50]
64   - has_attachment :storage => :file_system, :path_prefix => 'public/files',
65   - :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
66   - has_attachment :storage => :s3
67   -
68   -validates_as_attachment
69   - This method prevents files outside of the valid range (:min_size to :max_size, or the :size range) from being saved. It does not however, halt the upload of such files. They will be uploaded into memory regardless of size before validation.
70   -
71   - Example:
72   - validates_as_attachment
73   -
74   -
75   -attachment_fu migrations
76   -========================
77   -
78   -Fields for attachment_fu metadata tables...
79   - in general:
80   - size, :integer # file size in bytes
81   - content_type, :string # mime type, ex: application/mp3
82   - filename, :string # sanitized filename
83   - that reference images:
84   - height, :integer # in pixels
85   - width, :integer # in pixels
86   - that reference images that will be thumbnailed:
87   - parent_id, :integer # id of parent image (on the same table, a self-referencing foreign-key).
88   - # Only populated if the current object is a thumbnail.
89   - thumbnail, :string # the 'type' of thumbnail this attachment record describes.
90   - # Only populated if the current object is a thumbnail.
91   - # Usage:
92   - # [ In Model 'Avatar' ]
93   - # has_attachment :content_type => :image,
94   - # :storage => :file_system,
95   - # :max_size => 500.kilobytes,
96   - # :resize_to => '320x200>',
97   - # :thumbnails => { :small => '10x10>',
98   - # :thumb => '100x100>' }
99   - # [ Elsewhere ]
100   - # @user.avatar.thumbnails.first.thumbnail #=> 'small'
101   - that reference files stored in the database (:db_file):
102   - db_file_id, :integer # id of the file in the database (foreign key)
103   -
104   -Field for attachment_fu db_files table:
105   - data, :binary # binary file data, for use in database file storage
106   -
107   -
108   -attachment_fu views
109   -===================
110   -
111   -There are two main views tasks that will be directly affected by attachment_fu: upload forms and displaying uploaded images.
112   -
113   -There are two parts of the upload form that differ from typical usage.
114   - 1. Include ':multipart => true' in the html options of the form_for tag.
115   - Example:
116   - <% form_for(:attachment_metadata, :url => { :action => "create" }, :html => { :multipart => true }) do |form| %>
117   -
118   - 2. Use the file_field helper with :uploaded_data as the field name.
119   - Example:
120   - <%= form.file_field :uploaded_data %>
121   -
122   -Displaying uploaded images is made easy by the public_filename method of the ActiveRecord attachment objects using file system and s3 storage.
123   -
124   -public_filename(thumbnail = nil)
125   - Returns the public path to the file. If a thumbnail prefix is specified it will return the public file path to the corresponding thumbnail.
126   - Examples:
127   - attachment_obj.public_filename #=> /attachments/2/file.jpg
128   - attachment_obj.public_filename(:thumb) #=> /attachments/2/file_thumb.jpg
129   - attachment_obj.public_filename(:small) #=> /attachments/2/file_small.jpg
130   -
131   -When serving files from database storage, doing more than simply downloading the file is beyond the scope of this document.
132   -
133   -
134   -attachment_fu controllers
135   -=========================
136   -
137   -There are two considerations to take into account when using attachment_fu in controllers.
138   -
139   -The first is when the files have no publicly accessible path and need to be downloaded through an action.
140   -
141   -Example:
142   - def readme
143   - send_file '/path/to/readme.txt', :type => 'plain/text', :disposition => 'inline'
144   - end
145   -
146   -See the possible values for send_file for reference.
147   -
148   -
149   -The second is when saving the file when submitted from a form.
150   -Example in view:
151   - <%= form.file_field :attachable, :uploaded_data %>
152   -
153   -Example in controller:
154   - def create
155   - @attachable_file = AttachmentMetadataModel.new(params[:attachable])
156   - if @attachable_file.save
157   - flash[:notice] = 'Attachment was successfully created.'
158   - redirect_to attachable_url(@attachable_file)
159   - else
160   - render :action => :new
161   - end
162   - end
22 vendor/plugins/attachment_fu/Rakefile
... ... @@ -1,22 +0,0 @@
1   -require 'rake'
2   -require 'rake/testtask'
3   -require 'rake/rdoctask'
4   -
5   -desc 'Default: run unit tests.'
6   -task :default => :test
7   -
8   -desc 'Test the attachment_fu plugin.'
9   -Rake::TestTask.new(:test) do |t|
10   - t.libs << 'lib'
11   - t.pattern = 'test/**/*_test.rb'
12   - t.verbose = true
13   -end
14   -
15   -desc 'Generate documentation for the attachment_fu plugin.'
16   -Rake::RDocTask.new(:rdoc) do |rdoc|
17   - rdoc.rdoc_dir = 'rdoc'
18   - rdoc.title = 'ActsAsAttachment'
19   - rdoc.options << '--line-numbers --inline-source'
20   - rdoc.rdoc_files.include('README')
21   - rdoc.rdoc_files.include('lib/**/*.rb')
22   -end
14 vendor/plugins/attachment_fu/amazon_s3.yml.tpl
... ... @@ -1,14 +0,0 @@
1   -development:
2   - bucket_name: appname_development
3   - access_key_id:
4   - secret_access_key:
5   -
6   -test:
7   - bucket_name: appname_test
8   - access_key_id:
9   - secret_access_key:
10   -
11   -production:
12   - bucket_name: appname
13   - access_key_id:
14   - secret_access_key:
16 vendor/plugins/attachment_fu/init.rb
... ... @@ -1,16 +0,0 @@
1   -require 'tempfile'
2   -
3   -Tempfile.class_eval do
4   - # overwrite so tempfiles use the extension of the basename. important for rmagick and image science
5   - def make_tmpname(basename, n)
6   - ext = nil
7   - sprintf("%s%d-%d%s", basename.to_s.gsub(/\.\w+$/) { |s| ext = s; '' }, $$, n, ext)
8   - end
9   -end
10   -
11   -require 'geometry'
12   -ActiveRecord::Base.send(:extend, Technoweenie::AttachmentFu::ActMethods)
13   -Technoweenie::AttachmentFu.tempfile_path = ATTACHMENT_FU_TEMPFILE_PATH if Object.const_defined?(:ATTACHMENT_FU_TEMPFILE_PATH)
14   -FileUtils.mkdir_p Technoweenie::AttachmentFu.tempfile_path
15   -
16   -$:.unshift(File.dirname(__FILE__) + '/vendor')
5 vendor/plugins/attachment_fu/install.rb
... ... @@ -1,5 +0,0 @@
1   -require 'fileutils'
2   -
3   -s3_config = File.dirname(__FILE__) + '/../../../config/amazon_s3.yml'
4   -FileUtils.cp File.dirname(__FILE__) + '/amazon_s3.yml.tpl', s3_config unless File.exist?(s3_config)
5   -puts IO.read(File.join(File.dirname(__FILE__), 'README'))
93 vendor/plugins/attachment_fu/lib/geometry.rb
... ... @@ -1,93 +0,0 @@
1   -# This Geometry class was yanked from RMagick. However, it lets ImageMagick handle the actual change_geometry.
2   -# Use #new_dimensions_for to get new dimensons
3   -# Used so I can use spiffy RMagick geometry strings with ImageScience
4   -class Geometry
5   - # ! and @ are removed until support for them is added
6   - FLAGS = ['', '%', '<', '>']#, '!', '@']
7   - RFLAGS = { '%' => :percent,
8   - '!' => :aspect,
9   - '<' => :>,
10   - '>' => :<,
11   - '@' => :area }
12   -
13   - attr_accessor :width, :height, :x, :y, :flag
14   -
15   - def initialize(width=nil, height=nil, x=nil, y=nil, flag=nil)
16   - # Support floating-point width and height arguments so Geometry
17   - # objects can be used to specify Image#density= arguments.
18   - raise ArgumentError, "width must be >= 0: #{width}" if width < 0
19   - raise ArgumentError, "height must be >= 0: #{height}" if height < 0
20   - @width = width.to_f
21   - @height = height.to_f
22   - @x = x.to_i
23   - @y = y.to_i
24   - @flag = flag
25   - end
26   -
27   - # Construct an object from a geometry string
28   - RE = /\A(\d*)(?:x(\d+))?([-+]\d+)?([-+]\d+)?([%!<>@]?)\Z/
29   -
30   - def self.from_s(str)
31   - raise(ArgumentError, "no geometry string specified") unless str
32   -
33   - if m = RE.match(str)
34   - new(m[1].to_i, m[2].to_i, m[3].to_i, m[4].to_i, RFLAGS[m[5]])
35   - else
36   - raise ArgumentError, "invalid geometry format"
37   - end
38   - end
39   -
40   - # Convert object to a geometry string
41   - def to_s
42   - str = ''
43   - str << "%g" % @width if @width > 0
44   - str << 'x' if (@width > 0 || @height > 0)
45   - str << "%g" % @height if @height > 0
46   - str << "%+d%+d" % [@x, @y] if (@x != 0 || @y != 0)
47   - str << FLAGS[@flag.to_i]
48   - end
49   -
50   - # attempts to get new dimensions for the current geometry string given these old dimensions.
51   - # This doesn't implement the aspect flag (!) or the area flag (@). PDI
52   - def new_dimensions_for(orig_width, orig_height)
53   - new_width = orig_width
54   - new_height = orig_height
55   -
56   - case @flag
57   - when :percent
58   - scale_x = @width.zero? ? 100 : @width
59   - scale_y = @height.zero? ? @width : @height
60   - new_width = scale_x.to_f * (orig_width.to_f / 100.0)
61   - new_height = scale_y.to_f * (orig_height.to_f / 100.0)
62   - when :<, :>, nil
63   - scale_factor =
64   - if new_width.zero? || new_height.zero?
65   - 1.0
66   - else
67   - if @width.nonzero? && @height.nonzero?
68   - [@width.to_f / new_width.to_f, @height.to_f / new_height.to_f].min
69   - else
70   - @width.nonzero? ? (@width.to_f / new_width.to_f) : (@height.to_f / new_height.to_f)
71   - end
72   - end
73   - new_width = scale_factor * new_width.to_f
74   - new_height = scale_factor * new_height.to_f
75   - new_width = orig_width if @flag && orig_width.send(@flag, new_width)
76   - new_height = orig_height if @flag && orig_height.send(@flag, new_height)
77   - end
78   -
79   - [new_width, new_height].collect! { |v| v.round }
80   - end
81   -end
82   -
83   -class Array
84   - # allows you to get new dimensions for the current array of dimensions with a given geometry string
85   - #
86   - # [50, 64] / '40>' # => [40, 51]
87   - def /(geometry)
88   - raise ArgumentError, "Only works with a [width, height] pair" if size != 2
89   - raise ArgumentError, "Must pass a valid geometry string or object" unless geometry.is_a?(String) || geometry.is_a?(Geometry)
90   - geometry = Geometry.from_s(geometry) if geometry.is_a?(String)
91   - geometry.new_dimensions_for first, last
92   - end
93   -end
465 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu.rb
... ... @@ -1,465 +0,0 @@
1   -module Technoweenie # :nodoc:
2   - module AttachmentFu # :nodoc:
3   - @@default_processors = %w(ImageScience Rmagick MiniMagick Gd2 CoreImage)
4   - @@tempfile_path = File.join(RAILS_ROOT, 'tmp', 'attachment_fu')
5   - @@content_types = ['image/jpeg', 'image/pjpeg', 'image/gif', 'image/png', 'image/x-png', 'image/jpg']
6   - mattr_reader :content_types, :tempfile_path, :default_processors
7   - mattr_writer :tempfile_path
8   -
9   - class ThumbnailError < StandardError; end
10   - class AttachmentError < StandardError; end
11   -
12   - module ActMethods
13   - # Options:
14   - # * <tt>:content_type</tt> - Allowed content types. Allows all by default. Use :image to allow all standard image types.
15   - # * <tt>:min_size</tt> - Minimum size allowed. 1 byte is the default.
16   - # * <tt>:max_size</tt> - Maximum size allowed. 1.megabyte is the default.
17   - # * <tt>:size</tt> - Range of sizes allowed. (1..1.megabyte) is the default. This overrides the :min_size and :max_size options.
18   - # * <tt>:resize_to</tt> - Used by RMagick to resize images. Pass either an array of width/height, or a geometry string.
19   - # * <tt>:thumbnails</tt> - Specifies a set of thumbnails to generate. This accepts a hash of filename suffixes and RMagick resizing options.
20   - # * <tt>:thumbnail_class</tt> - Set what class to use for thumbnails. This attachment class is used by default.
21   - # * <tt>:path_prefix</tt> - path to store the uploaded files. Uses public/#{table_name} by default for the filesystem, and just #{table_name}
22   - # for the S3 backend. Setting this sets the :storage to :file_system.
23   - # * <tt>:storage</tt> - Use :file_system to specify the attachment data is stored with the file system. Defaults to :db_system.
24   -
25   - # * <tt>:keep_profile</tt> By default image EXIF data will be stripped to minimize image size. For small thumbnails this proivides important savings. Picture quality is not affected. Set to false if you want to keep the image profile as is. ImageScience will allways keep EXIF data.
26   - #
27   - # Examples:
28   - # has_attachment :max_size => 1.kilobyte
29   - # has_attachment :size => 1.megabyte..2.megabytes
30   - # has_attachment :content_type => 'application/pdf'
31   - # has_attachment :content_type => ['application/pdf', 'application/msword', 'text/plain']
32   - # has_attachment :content_type => :image, :resize_to => [50,50]
33   - # has_attachment :content_type => ['application/pdf', :image], :resize_to => 'x50'
34   - # has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
35   - # has_attachment :storage => :file_system, :path_prefix => 'public/files'
36   - # has_attachment :storage => :file_system, :path_prefix => 'public/files',
37   - # :content_type => :image, :resize_to => [50,50]
38   - # has_attachment :storage => :file_system, :path_prefix => 'public/files',
39   - # :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
40   - # has_attachment :storage => :s3
41   - def has_attachment(options = {})
42   - # this allows you to redefine the acts' options for each subclass, however
43   - options[:min_size] ||= 1
44   - options[:max_size] ||= 1.megabyte
45   - options[:size] ||= (options[:min_size]..options[:max_size])
46   - options[:thumbnails] ||= {}
47   - options[:thumbnail_class] ||= self
48   - options[:s3_access] ||= :public_read
49   - options[:content_type] = [options[:content_type]].flatten.collect! { |t| t == :image ? Technoweenie::AttachmentFu.content_types : t }.flatten unless options[:content_type].nil?
50   -
51   - unless options[:thumbnails].is_a?(Hash)
52   - raise ArgumentError, ":thumbnails option should be a hash: e.g. :thumbnails => { :foo => '50x50' }"
53   - end
54   -
55   - extend ClassMethods unless (class << self; included_modules; end).include?(ClassMethods)
56   - include InstanceMethods unless included_modules.include?(InstanceMethods)
57   -
58   - parent_options = attachment_options || {}
59   - # doing these shenanigans so that #attachment_options is available to processors and backends
60   - self.attachment_options = options
61   -
62   - attr_accessor :thumbnail_resize_options
63   -
64   - attachment_options[:storage] ||= (attachment_options[:file_system_path] || attachment_options[:path_prefix]) ? :file_system : :db_file
65   - attachment_options[:storage] ||= parent_options[:storage]
66   - attachment_options[:path_prefix] ||= attachment_options[:file_system_path]
67   - if attachment_options[:path_prefix].nil?
68   - attachment_options[:path_prefix] = attachment_options[:storage] == :s3 ? table_name : File.join("public", table_name)
69   - end
70   - attachment_options[:path_prefix] = attachment_options[:path_prefix][1..-1] if options[:path_prefix].first == '/'
71   -
72   - with_options :foreign_key => 'parent_id' do |m|
73   - m.has_many :thumbnails, :class_name => "::#{attachment_options[:thumbnail_class]}"
74   - m.belongs_to :parent, :class_name => "::#{base_class}" unless options[:thumbnails].empty?
75   - end
76   -
77   - storage_mod = Technoweenie::AttachmentFu::Backends.const_get("#{options[:storage].to_s.classify}Backend")
78   - include storage_mod unless included_modules.include?(storage_mod)
79   -
80   - case attachment_options[:processor]
81   - when :none, nil
82   - processors = Technoweenie::AttachmentFu.default_processors.dup
83   - begin
84   - if processors.any?
85   - attachment_options[:processor] = "#{processors.first}Processor"
86   - processor_mod = Technoweenie::AttachmentFu::Processors.const_get(attachment_options[:processor])
87   - include processor_mod unless included_modules.include?(processor_mod)
88   - end
89   - rescue Object, Exception
90   - raise unless load_related_exception?($!)
91   -
92   - processors.shift
93   - retry
94   - end
95   - else
96   - begin
97   - processor_mod = Technoweenie::AttachmentFu::Processors.const_get("#{attachment_options[:processor].to_s.classify}Processor")
98   - include processor_mod unless included_modules.include?(processor_mod)
99   - rescue Object, Exception
100   - raise unless load_related_exception?($!)
101   -
102   - puts "Problems loading #{options[:processor]}Processor: #{$!}"
103   - end
104   - end unless parent_options[:processor] # Don't let child override processor
105   - end
106   -
107   - def load_related_exception?(e) #:nodoc: implementation specific
108   - case
109   - when e.kind_of?(LoadError), e.kind_of?(MissingSourceFile), $!.class.name == "CompilationError"
110   - # We can't rescue CompilationError directly, as it is part of the RubyInline library.
111   - # We must instead rescue RuntimeError, and check the class' name.
112   - true
113   - else
114   - false
115   - end
116   - end
117   - private :load_related_exception?
118   - end
119   -
120   - module ClassMethods
121   - delegate :content_types, :to => Technoweenie::AttachmentFu
122   -
123   - # Performs common validations for attachment models.
124   - def validates_as_attachment
125   - validates_presence_of :size, :content_type, :filename
126   - validate :attachment_attributes_valid?
127   - end
128   -
129   - # Returns true or false if the given content type is recognized as an image.
130   - def image?(content_type)
131   - content_types.include?(content_type)
132   - end
133   -
134   - def self.extended(base)
135   - base.class_inheritable_accessor :attachment_options
136   - base.before_destroy :destroy_thumbnails
137   - base.before_validation :set_size_from_temp_path
138   - base.after_save :after_process_attachment
139   - base.after_destroy :destroy_file
140   - base.after_validation :process_attachment
141   - if defined?(::ActiveSupport::Callbacks)
142   - base.define_callbacks :after_resize, :after_attachment_saved, :before_thumbnail_saved
143   - end
144   - end
145   -
146   - unless defined?(::ActiveSupport::Callbacks)
147   - # Callback after an image has been resized.
148   - #
149   - # class Foo < ActiveRecord::Base
150   - # acts_as_attachment
151   - # after_resize do |record, img|
152   - # record.aspect_ratio = img.columns.to_f / img.rows.to_f
153   - # end
154   - # end
155   - def after_resize(&block)
156   - write_inheritable_array(:after_resize, [block])
157   - end
158   -
159   - # Callback after an attachment has been saved either to the file system or the DB.
160   - # Only called if the file has been changed, not necessarily if the record is updated.
161   - #
162   - # class Foo < ActiveRecord::Base
163   - # acts_as_attachment
164   - # after_attachment_saved do |record|
165   - # ...
166   - # end
167   - # end
168   - def after_attachment_saved(&block)
169   - write_inheritable_array(:after_attachment_saved, [block])
170   - end
171   -
172   - # Callback before a thumbnail is saved. Use this to pass any necessary extra attributes that may be required.
173   - #
174   - # class Foo < ActiveRecord::Base
175   - # acts_as_attachment
176   - # before_thumbnail_saved do |thumbnail|
177   - # record = thumbnail.parent
178   - # ...
179   - # end
180   - # end
181   - def before_thumbnail_saved(&block)
182   - write_inheritable_array(:before_thumbnail_saved, [block])
183   - end
184   - end
185   -
186   - # Get the thumbnail class, which is the current attachment class by default.
187   - # Configure this with the :thumbnail_class option.
188   - def thumbnail_class
189   - attachment_options[:thumbnail_class] = attachment_options[:thumbnail_class].constantize unless attachment_options[:thumbnail_class].is_a?(Class)
190   - attachment_options[:thumbnail_class]
191   - end
192   -
193   - # Copies the given file path to a new tempfile, returning the closed tempfile.
194   - def copy_to_temp_file(file, temp_base_name)
195   - returning Tempfile.new(temp_base_name, Technoweenie::AttachmentFu.tempfile_path) do |tmp|
196   - tmp.close
197   - FileUtils.cp file, tmp.path
198   - end
199   - end
200   -
201   - # Writes the given data to a new tempfile, returning the closed tempfile.
202   - def write_to_temp_file(data, temp_base_name)
203   - returning Tempfile.new(temp_base_name, Technoweenie::AttachmentFu.tempfile_path) do |tmp|
204   - tmp.binmode
205   - tmp.write data
206   - tmp.close
207   - end
208   - end
209   - end
210   -
211   - module InstanceMethods
212   - def self.included(base)
213   - base.define_callbacks *[:after_resize, :after_attachment_saved, :before_thumbnail_saved] if base.respond_to?(:define_callbacks)
214   - end
215   -
216   - # Checks whether the attachment's content type is an image content type
217   - def image?
218   - self.class.image?(content_type)
219   - end
220   -
221   - # Returns true/false if an attachment is thumbnailable. A thumbnailable attachment has an image content type and the parent_id attribute.
222   - def thumbnailable?
223   - image? && respond_to?(:parent_id) && parent_id.nil?
224   - end
225   -
226   - # Returns the class used to create new thumbnails for this attachment.
227   - def thumbnail_class
228   - self.class.thumbnail_class
229   - end
230   -
231   - # Gets the thumbnail name for a filename. 'foo.jpg' becomes 'foo_thumbnail.jpg'
232   - def thumbnail_name_for(thumbnail = nil)
233   - return filename if thumbnail.blank?
234   - ext = nil
235   - basename = filename.gsub /\.\w+$/ do |s|
236   - ext = s; ''
237   - end
238   - # ImageScience doesn't create gif thumbnails, only pngs
239   - ext.sub!(/gif$/, 'png') if attachment_options[:processor] == "ImageScience"
240   - "#{basename}_#{thumbnail}#{ext}"
241   - end
242   -
243   - # Creates or updates the thumbnail for the current attachment.
244   - def create_or_update_thumbnail(temp_file, file_name_suffix, *size)
245   - thumbnailable? || raise(ThumbnailError.new("Can't create a thumbnail if the content type is not an image or there is no parent_id column"))
246   - returning find_or_initialize_thumbnail(file_name_suffix) do |thumb|
247   - thumb.attributes = {
248   - :content_type => content_type,
249   - :filename => thumbnail_name_for(file_name_suffix),
250   - :temp_path => temp_file,
251   - :thumbnail_resize_options => size
252   - }
253   - callback_with_args :before_thumbnail_saved, thumb
254   - thumb.save!
255   - end
256   - end
257   -
258   - # Sets the content type.
259   - def content_type=(new_type)
260   - write_attribute :content_type, new_type.to_s.strip
261   - end
262   -
263   - # Sanitizes a filename.
264   - def filename=(new_name)
265   - write_attribute :filename, sanitize_filename(new_name)
266   - end
267   -
268   - # Returns the width/height in a suitable format for the image_tag helper: (100x100)
269   - def image_size
270   - [width.to_s, height.to_s] * 'x'
271   - end
272   -
273   - # Returns true if the attachment data will be written to the storage system on the next save
274   - def save_attachment?
275   - File.file?(temp_path.to_s)
276   - end
277   -
278   - # nil placeholder in case this field is used in a form.
279   - def uploaded_data() nil; end
280   -
281   - # This method handles the uploaded file object. If you set the field name to uploaded_data, you don't need
282   - # any special code in your controller.
283   - #
284   - # <% form_for :attachment, :html => { :multipart => true } do |f| -%>
285   - # <p><%= f.file_field :uploaded_data %></p>
286   - # <p><%= submit_tag :Save %>
287   - # <% end -%>
288   - #
289   - # @attachment = Attachment.create! params[:attachment]
290   - #
291   - # TODO: Allow it to work with Merb tempfiles too.
292   - def uploaded_data=(file_data)
293   - return nil if file_data.nil? || file_data.size == 0
294   - self.content_type = file_data.content_type
295   - self.filename = file_data.original_filename if respond_to?(:filename)
296   - if file_data.is_a?(StringIO)
297   - file_data.rewind
298   - self.temp_data = file_data.read
299   - else
300   - self.temp_path = file_data
301   - end
302   - end
303   -
304   - # Gets the latest temp path from the collection of temp paths. While working with an attachment,
305   - # multiple Tempfile objects may be created for various processing purposes (resizing, for example).
306   - # An array of all the tempfile objects is stored so that the Tempfile instance is held on to until
307   - # it's not needed anymore. The collection is cleared after saving the attachment.
308   - def temp_path
309   - p = temp_paths.first
310   - p.respond_to?(:path) ? p.path : p.to_s
311   - end
312   -
313   - # Gets an array of the currently used temp paths. Defaults to a copy of #full_filename.
314   - def temp_paths
315   - @temp_paths ||= (new_record? || !respond_to?(:full_filename) || !File.exist?(full_filename) ?
316   - [] : [copy_to_temp_file(full_filename)])
317   - end
318   -
319   - # Adds a new temp_path to the array. This should take a string or a Tempfile. This class makes no
320   - # attempt to remove the files, so Tempfiles should be used. Tempfiles remove themselves when they go out of scope.
321   - # You can also use string paths for temporary files, such as those used for uploaded files in a web server.
322   - def temp_path=(value)
323   - temp_paths.unshift value
324   - temp_path
325   - end
326   -
327   - # Gets the data from the latest temp file. This will read the file into memory.
328   - def temp_data
329   - save_attachment? ? File.read(temp_path) : nil
330   - end
331   -
332   - # Writes the given data to a Tempfile and adds it to the collection of temp files.
333   - def temp_data=(data)
334   - self.temp_path = write_to_temp_file data unless data.nil?
335   - end
336   -
337   - # Copies the given file to a randomly named Tempfile.
338   - def copy_to_temp_file(file)
339   - self.class.copy_to_temp_file file, random_tempfile_filename
340   - end
341   -
342   - # Writes the given file to a randomly named Tempfile.
343   - def write_to_temp_file(data)
344   - self.class.write_to_temp_file data, random_tempfile_filename
345   - end
346   -
347   - # Stub for creating a temp file from the attachment data. This should be defined in the backend module.
348   - def create_temp_file() end
349   -
350   - # Allows you to work with a processed representation (RMagick, ImageScience, etc) of the attachment in a block.
351   - #
352   - # @attachment.with_image do |img|
353   - # self.data = img.thumbnail(100, 100).to_blob
354   - # end
355   - #
356   - def with_image(&block)
357   - self.class.with_image(temp_path, &block)
358   - end
359   -
360   - protected
361   - # Generates a unique filename for a Tempfile.
362   - def random_tempfile_filename
363   - "#{rand Time.now.to_i}#{filename || 'attachment'}"
364   - end
365   -
366   - def sanitize_filename(filename)
367   - returning filename.strip do |name|
368   - # NOTE: File.basename doesn't work right with Windows paths on Unix
369   - # get only the filename, not the whole path
370   - name.gsub! /^.*(\\|\/)/, ''
371   -
372   - # Finally, replace all non alphanumeric, underscore or periods with underscore
373   - name.gsub! /[^\w\.\-]/, '_'
374   - end
375   - end
376   -
377   - # before_validation callback.
378   - def set_size_from_temp_path
379   - self.size = File.size(temp_path) if save_attachment?
380   - end
381   -
382   - # validates the size and content_type attributes according to the current model's options
383   - def attachment_attributes_valid?
384   - [:size, :content_type].each do |attr_name|
385   - enum = attachment_options[attr_name]
386   - errors.add attr_name, ActiveRecord::Errors.default_error_messages[:inclusion] unless enum.nil? || enum.include?(send(attr_name))
387   - end
388   - end
389   -
390   - # Initializes a new thumbnail with the given suffix.
391   - def find_or_initialize_thumbnail(file_name_suffix)
392   - respond_to?(:parent_id) ?
393   - thumbnail_class.find_or_initialize_by_thumbnail_and_parent_id(file_name_suffix.to_s, id) :
394   - thumbnail_class.find_or_initialize_by_thumbnail(file_name_suffix.to_s)
395   - end
396   -
397   - # Stub for a #process_attachment method in a processor
398   - def process_attachment
399   - @saved_attachment = save_attachment?
400   - end
401   -
402   - # Cleans up after processing. Thumbnails are created, the attachment is stored to the backend, and the temp_paths are cleared.
403   - def after_process_attachment
404   - if @saved_attachment
405   - if respond_to?(:process_attachment_with_processing) && thumbnailable? && !attachment_options[:thumbnails].blank? && parent_id.nil?
406   - temp_file = temp_path || create_temp_file
407   - attachment_options[:thumbnails].each { |suffix, size| create_or_update_thumbnail(temp_file, suffix, *size) }
408   - end
409   - save_to_storage
410   - @temp_paths.clear
411   - @saved_attachment = nil
412   - callback :after_attachment_saved
413   - end
414   - end
415   -
416   - # Resizes the given processed img object with either the attachment resize options or the thumbnail resize options.
417   - def resize_image_or_thumbnail!(img)
418   - if (!respond_to?(:parent_id) || parent_id.nil?) && attachment_options[:resize_to] # parent image
419   - resize_image(img, attachment_options[:resize_to])
420   - elsif thumbnail_resize_options # thumbnail
421   - resize_image(img, thumbnail_resize_options)
422   - end
423   - end
424   -
425   - # Yanked from ActiveRecord::Callbacks, modified so I can pass args to the callbacks besides self.
426   - # Only accept blocks, however
427   - if ActiveSupport.const_defined?(:Callbacks)
428   - # Rails 2.1 and beyond!
429   - def callback_with_args(method, arg = self)
430   - notify(method)
431   -
432   - result = run_callbacks(method, { :object => arg }) { |result, object| result == false }
433   -
434   - if result != false && respond_to_without_attributes?(method)
435   - result = send(method)
436   - end
437   -
438   - result
439   - end
440   -
441   - def run_callbacks(kind, options = {}, &block)
442   - options.reverse_merge!( :object => self )
443   - self.class.send("#{kind}_callback_chain").run(options[:object], options, &block)
444   - end
445   - else
446   - # Rails 2.0
447   - def callback_with_args(method, arg = self)
448   - notify(method)
449   -
450   - result = nil
451   - callbacks_for(method).each do |callback|
452   - result = callback.call(self, arg)
453   - return false if result == false
454   - end
455   - result
456   - end
457   - end
458   -
459   - # Removes the thumbnails for the attachment, if it has any
460   - def destroy_thumbnails
461   - self.thumbnails.each { |thumbnail| thumbnail.destroy } if thumbnailable?
462   - end
463   - end
464   - end
465   -end
39 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/db_file_backend.rb
... ... @@ -1,39 +0,0 @@
1   -module Technoweenie # :nodoc:
2   - module AttachmentFu # :nodoc:
3   - module Backends
4   - # Methods for DB backed attachments
5   - module DbFileBackend
6   - def self.included(base) #:nodoc:
7   - Object.const_set(:DbFile, Class.new(ActiveRecord::Base)) unless Object.const_defined?(:DbFile)
8   - base.belongs_to :db_file, :class_name => '::DbFile', :foreign_key => 'db_file_id'
9   - end
10   -
11   - # Creates a temp file with the current db data.
12   - def create_temp_file
13   - write_to_temp_file current_data
14   - end
15   -
16   - # Gets the current data from the database
17   - def current_data
18   - db_file.data
19   - end
20   -
21   - protected
22   - # Destroys the file. Called in the after_destroy callback
23   - def destroy_file
24   - db_file.destroy if db_file
25   - end
26   -
27   - # Saves the data to the DbFile model
28   - def save_to_storage
29   - if save_attachment?
30   - (db_file || build_db_file).data = temp_data
31   - db_file.save!
32   - self.class.update_all ['db_file_id = ?', self.db_file_id = db_file.id], ['id = ?', id]
33   - end
34   - true
35   - end
36   - end
37   - end
38   - end
39   -end
97 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/file_system_backend.rb
... ... @@ -1,97 +0,0 @@
1   -require 'ftools'
2   -module Technoweenie # :nodoc:
3   - module AttachmentFu # :nodoc:
4   - module Backends
5   - # Methods for file system backed attachments
6   - module FileSystemBackend
7   - def self.included(base) #:nodoc:
8   - base.before_update :rename_file
9   - end
10   -
11   - # Gets the full path to the filename in this format:
12   - #
13   - # # This assumes a model name like MyModel
14   - # # public/#{table_name} is the default filesystem path
15   - # RAILS_ROOT/public/my_models/5/blah.jpg
16   - #
17   - # Overwrite this method in your model to customize the filename.
18   - # The optional thumbnail argument will output the thumbnail's filename.
19   - def full_filename(thumbnail = nil)
20   - file_system_path = (thumbnail ? thumbnail_class : self).attachment_options[:path_prefix].to_s
21   - File.join(RAILS_ROOT, file_system_path, *partitioned_path(thumbnail_name_for(thumbnail)))
22   - end
23   -
24   - # Used as the base path that #public_filename strips off full_filename to create the public path
25   - def base_path
26   - @base_path ||= File.join(RAILS_ROOT, 'public')
27   - end
28   -
29   - # The attachment ID used in the full path of a file
30   - def attachment_path_id
31   - ((respond_to?(:parent_id) && parent_id) || id).to_i
32   - end
33   -
34   - # overrwrite this to do your own app-specific partitioning.
35   - # you can thank Jamis Buck for this: http://www.37signals.com/svn/archives2/id_partitioning.php
36   - def partitioned_path(*args)
37   - ("%08d" % attachment_path_id).scan(/..../) + args
38   - end
39   -
40   - # Gets the public path to the file
41   - # The optional thumbnail argument will output the thumbnail's filename.
42   - def public_filename(thumbnail = nil)
43   - full_filename(thumbnail).gsub %r(^#{Regexp.escape(base_path)}), ''
44   - end
45   -
46   - def filename=(value)
47   - @old_filename = full_filename unless filename.nil? || @old_filename
48   - write_attribute :filename, sanitize_filename(value)
49   - end
50   -
51   - # Creates a temp file from the currently saved file.
52   - def create_temp_file
53   - copy_to_temp_file full_filename
54   - end
55   -
56   - protected
57   - # Destroys the file. Called in the after_destroy callback
58   - def destroy_file
59   - FileUtils.rm full_filename
60   - # remove directory also if it is now empty
61   - Dir.rmdir(File.dirname(full_filename)) if (Dir.entries(File.dirname(full_filename))-['.','..']).empty?
62   - rescue
63   - logger.info "Exception destroying #{full_filename.inspect}: [#{$!.class.name}] #{$1.to_s}"
64   - logger.warn $!.backtrace.collect { |b| " > #{b}" }.join("\n")
65   - end
66   -
67   - # Renames the given file before saving
68   - def rename_file
69   - return unless @old_filename && @old_filename != full_filename
70   - if save_attachment? && File.exists?(@old_filename)
71   - FileUtils.rm @old_filename
72   - elsif File.exists?(@old_filename)
73   - FileUtils.mv @old_filename, full_filename
74   - end
75   - @old_filename = nil
76   - true
77   - end
78   -
79   - # Saves the file to the file system
80   - def save_to_storage
81   - if save_attachment?
82   - # TODO: This overwrites the file if it exists, maybe have an allow_overwrite option?
83   - FileUtils.mkdir_p(File.dirname(full_filename))
84   - File.cp(temp_path, full_filename)
85   - File.chmod(attachment_options[:chmod] || 0644, full_filename)
86   - end
87   - @old_filename = nil
88   - true
89   - end
90   -
91   - def current_data
92   - File.file?(full_filename) ? File.read(full_filename) : nil
93   - end
94   - end
95   - end
96   - end
97   -end
303 vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/s3_backend.rb
... ... @@ -1,303 +0,0 @@
1   -module Technoweenie # :nodoc:
2   - module AttachmentFu # :nodoc:
3   - module Backends
4   - # = AWS::S3 Storage Backend
5   - #
6   - # Enables use of {Amazon's Simple Storage Service}[http://aws.amazon.com/s3] as a storage mechanism
7   - #
8   - # == Requirements
9   - #
10   - # Requires the {AWS::S3 Library}[http://amazon.rubyforge.org] for S3 by Marcel Molina Jr. installed either
11   - # as a gem or a as a Rails plugin.
12   - #
13   - # == Configuration
14   - #
15   - # Configuration is done via <tt>RAILS_ROOT/config/amazon_s3.yml</tt> and is loaded according to the <tt>RAILS_ENV</tt>.
16   - # The minimum connection options that you must specify are a bucket name, your access key id and your secret access key.
17   - # If you don't already have your access keys, all you need to sign up for the S3 service is an account at Amazon.
18   - # You can sign up for S3 and get access keys by visiting http://aws.amazon.com/s3.
19   - #
20   - # Example configuration (RAILS_ROOT/config/amazon_s3.yml)
21   - #
22   - # development:
23   - # bucket_name: appname_development
24   - # access_key_id: <your key>
25   - # secret_access_key: <your key>
26   - #
27   - # test:
28   - # bucket_name: appname_test
29   - # access_key_id: <your key>
30   - # secret_access_key: <your key>
31   - #
32   - # production:
33   - # bucket_name: appname
34   - # access_key_id: <your key>
35   - # secret_access_key: <your key>
36   - #
37   - # You can change the location of the config path by passing a full path to the :s3_config_path option.
38   - #
39   - # has_attachment :storage => :s3, :s3_config_path => (RAILS_ROOT + '/config/s3.yml')
40   - #
41   - # === Required configuration parameters
42   - #
43   - # * <tt>:access_key_id</tt> - The access key id for your S3 account. Provided by Amazon.
44   - # * <tt>:secret_access_key</tt> - The secret access key for your S3 account. Provided by Amazon.
45   - # * <tt>:bucket_name</tt> - A unique bucket name (think of the bucket_name as being like a database name).
46   - #
47   - # If any of these required arguments is missing, a MissingAccessKey exception will be raised from AWS::S3.
48   - #
49   - # == About bucket names
50   - #
51   - # Bucket names have to be globaly unique across the S3 system. And you can only have up to 100 of them,
52   - # so it's a good idea to think of a bucket as being like a database, hence the correspondance in this
53   - # implementation to the development, test, and production environments.
54