@@ -36,6 +36,8 @@ module Fleximage # * +output_image_jpg_quality+: (Integer, default 85) When rendering JPGs, this represents the amount of # compression. Valid values are 0-100, where 0 is very small and very ugly, and 100 is near lossless but # very large in filesize. + # * +default_image_path+: (String, nil default) If no image is present for this record, the image at this path will be + # used instead. Useful for a placeholder graphic for new content that may not have an image just yet. # * +preprocess_image+: (Block, no default) Call this class method just like you would call +operate+ in a view. # The image transoformation in the provided block will be run on every uploaded image before its saved as the # master image. @@ -50,6 +52,7 @@ module Fleximage # require_image true # missing_image_message 'is required' # invalid_image_message 'was not a readable image' + # default_image_path 'public/images/no_photo_yet.png' # output_image_jpg_quality 85 # # preprocess_image do |image| lib/fleximage/model.rb @@ -123,6 +123,11 @@ where 0 is very small and very ugly, and 100 is near lossless but very large in filesize. </li> +<li><tt>default_image_path</tt>: (String, nil default) If no image is present +for this record, the image at this path will be used instead. Useful for a +placeholder graphic for new content that may not have an image just yet. + +</li> <li><tt><a href="ClassMethods.html#M000002">preprocess_image</a></tt>: (Block, no default) Call this class method just like you would call <tt>operate</tt> in a view. The image transoformation in the provided block @@ -142,6 +147,7 @@ Example: require_image true missing_image_message 'is required' invalid_image_message 'was not a readable image' + default_image_path 'public/images/no_photo_yet.png' output_image_jpg_quality 85 preprocess_image do |image| @@ -210,12 +216,12 @@ Internal method to ask this class if it stores image in the DB. onclick="toggleCode('M000003-source');return false;">[Source]</a> <div class="method-source-code" id="M000003-source"> <pre> - # File lib/fleximage/model.rb, line 82 -82: def self.db_store? -83: columns.find do |col| -84: col.name == 'image_file_data' -85: end -86: end + # File lib/fleximage/model.rb, line 85 +85: def self.db_store? +86: columns.find do |col| +87: col.name == 'image_file_data' +88: end +89: end </pre> </div> </div> @@ -240,10 +246,10 @@ uploaded image before its saved as the master image. onclick="toggleCode('M000002-source');return false;">[Source]</a> <div class="method-source-code" id="M000002-source"> <pre> - # File lib/fleximage/model.rb, line 77 -77: def self.preprocess_image(&block) -78: preprocess_image_operation(block) -79: end + # File lib/fleximage/model.rb, line 80 +80: def self.preprocess_image(&block) +81: preprocess_image_operation(block) +82: end </pre> </div> </div> @@ -272,74 +278,74 @@ nice looking block. onclick="toggleCode('M000001-source');return false;">[Source]</a> <div class="method-source-code" id="M000001-source"> <pre> - # File lib/fleximage/model.rb, line 68 - 68: def acts_as_fleximage(options = {}) - 69: - 70: # Insert class methods - 71: class_eval do - 72: include Fleximage::Model::InstanceMethods - 73: - 74: # Call this class method just like you would call +operate+ in a view. - 75: # The image transoformation in the provided block will be run on every uploaded image before its saved as the - 76: # master image. - 77: def self.preprocess_image(&block) - 78: preprocess_image_operation(block) - 79: end - 80: - 81: # Internal method to ask this class if it stores image in the DB. - 82: def self.db_store? - 83: columns.find do |col| - 84: col.name == 'image_file_data' - 85: end - 86: end - 87: end - 88: - 89: # Where images get stored - 90: dsl_accessor :image_directory + # File lib/fleximage/model.rb, line 71 + 71: def acts_as_fleximage(options = {}) + 72: + 73: # Insert class methods + 74: class_eval do + 75: include Fleximage::Model::InstanceMethods + 76: + 77: # Call this class method just like you would call +operate+ in a view. + 78: # The image transoformation in the provided block will be run on every uploaded image before its saved as the + 79: # master image. + 80: def self.preprocess_image(&block) + 81: preprocess_image_operation(block) + 82: end + 83: + 84: # Internal method to ask this class if it stores image in the DB. + 85: def self.db_store? + 86: columns.find do |col| + 87: col.name == 'image_file_data' + 88: end + 89: end + 90: end 91: - 92: # Put uploads from different days into different subdirectories - 93: dsl_accessor :use_creation_date_based_directories, :default => true + 92: # Where images get stored + 93: dsl_accessor :image_directory 94: - 95: # The format are master images are stored in - 96: dsl_accessor :image_storage_format, :default => Proc.new { :png } + 95: # Put uploads from different days into different subdirectories + 96: dsl_accessor :use_creation_date_based_directories, :default => true 97: - 98: # Require a valid image. Defaults to true. Set to false if its ok to have no image for - 99: dsl_accessor :require_image, :default => true + 98: # The format are master images are stored in + 99: dsl_accessor :image_storage_format, :default => Proc.new { :png } 100: -101: # Missing image message -102: dsl_accessor :missing_image_message, :default => 'is required' +101: # Require a valid image. Defaults to true. Set to false if its ok to have no image for +102: dsl_accessor :require_image, :default => true 103: -104: # Invalid image message -105: dsl_accessor :invalid_image_message, :default => 'was not a readable image' +104: # Missing image message +105: dsl_accessor :missing_image_message, :default => 'is required' 106: -107: # Sets the quality of rendered JPGs -108: dsl_accessor :output_image_jpg_quality, :default => 85 +107: # Invalid image message +108: dsl_accessor :invalid_image_message, :default => 'was not a readable image' 109: -110: # Set a default image to use when no image has been assigned to this record -111: dsl_accessor :default_image_path +110: # Sets the quality of rendered JPGs +111: dsl_accessor :output_image_jpg_quality, :default => 85 112: -113: # A block that processes an image before it gets saved as the master image of a record. -114: # Can be helpful to resize potentially huge images to something more manageable. Set via -115: # the "preprocess_image { |image| ... }" class method. -116: dsl_accessor :preprocess_image_operation -117: -118: # Image related save and destroy callbacks -119: after_destroy :delete_image_file -120: before_save :pre_save -121: after_save :post_save -122: -123: # execute configuration block -124: yield if block_given? +113: # Set a default image to use when no image has been assigned to this record +114: dsl_accessor :default_image_path +115: +116: # A block that processes an image before it gets saved as the master image of a record. +117: # Can be helpful to resize potentially huge images to something more manageable. Set via +118: # the "preprocess_image { |image| ... }" class method. +119: dsl_accessor :preprocess_image_operation +120: +121: # Image related save and destroy callbacks +122: after_destroy :delete_image_file +123: before_save :pre_save +124: after_save :post_save 125: -126: # set the image directory from passed options -127: image_directory options[:image_directory] if options[:image_directory] +126: # execute configuration block +127: yield if block_given? 128: -129: # Require the declaration of a master image storage directory -130: if !image_directory && !db_store? -131: raise "No place to put images! Declare this via the :image_directory => 'path/to/directory' option\n"+ -132: "Or add a database column named image_file_data for DB storage" -133: end -134: end +129: # set the image directory from passed options +130: image_directory options[:image_directory] if options[:image_directory] +131: +132: # Require the declaration of a master image storage directory +133: if !image_directory && !db_store? +134: raise "No place to put images! Declare this via the :image_directory => 'path/to/directory' option\n"+ +135: "Or add a database column named image_file_data for DB storage" +136: end +137: end </pre> </div> </div> rdoc/classes/Fleximage/Model/ClassMethods.html @@ -134,10 +134,10 @@ the image from the record. onclick="toggleCode('M000011-source');return false;">[Source]</a> <div class="method-source-code" id="M000011-source"> <pre> - # File lib/fleximage/model.rb, line 324 -324: def delete_image_file -325: File.delete(file_path) if File.exists?(file_path) -326: end + # File lib/fleximage/model.rb, line 327 +327: def delete_image_file +328: File.delete(file_path) if File.exists?(file_path) +329: end </pre> </div> </div> @@ -171,21 +171,21 @@ number files in a directory. onclick="toggleCode('M000004-source');return false;">[Source]</a> <div class="method-source-code" id="M000004-source"> <pre> - # File lib/fleximage/model.rb, line 149 -149: def directory_path -150: raise 'No image directory was defined, cannot generate path' unless self.class.image_directory -151: -152: # base directory -153: directory = "#{RAILS_ROOT}/#{self.class.image_directory}" + # File lib/fleximage/model.rb, line 152 +152: def directory_path +153: raise 'No image directory was defined, cannot generate path' unless self.class.image_directory 154: -155: # specific creation date based directory suffix. -156: creation = self[:created_at] || self[:created_on] -157: if self.class.use_creation_date_based_directories && creation -158: "#{directory}/#{creation.year}/#{creation.month}/#{creation.day}" -159: else -160: directory -161: end -162: end +155: # base directory +156: directory = "#{RAILS_ROOT}/#{self.class.image_directory}" +157: +158: # specific creation date based directory suffix. +159: creation = self[:created_at] || self[:created_on] +160: if self.class.use_creation_date_based_directories && creation +161: "#{directory}/#{creation.year}/#{creation.month}/#{creation.day}" +162: else +163: directory +164: end +165: end </pre> </div> </div> @@ -211,10 +211,10 @@ Returns the path to the master image file for this record. onclick="toggleCode('M000005-source');return false;">[Source]</a> <div class="method-source-code" id="M000005-source"> <pre> - # File lib/fleximage/model.rb, line 167 -167: def file_path -168: "#{directory_path}/#{id}.#{self.class.image_storage_format}" -169: end + # File lib/fleximage/model.rb, line 170 +170: def file_path +171: "#{directory_path}/#{id}.#{self.class.image_storage_format}" +172: end </pre> </div> </div> @@ -237,10 +237,10 @@ Return true if this record has an image. onclick="toggleCode('M000009-source');return false;">[Source]</a> <div class="method-source-code" id="M000009-source"> <pre> - # File lib/fleximage/model.rb, line 261 -261: def has_image? -262: self.class.db_store? ? image_file_data : File.exists?(file_path) -263: end + # File lib/fleximage/model.rb, line 264 +264: def has_image? +265: self.class.db_store? ? image_file_data : File.exists?(file_path) +266: end </pre> </div> </div> @@ -285,37 +285,37 @@ situations you would expect it to. onclick="toggleCode('M000006-source');return false;">[Source]</a> <div class="method-source-code" id="M000006-source"> <pre> - # File lib/fleximage/model.rb, line 193 -193: def image_file=(file) -194: # Get the size of the file. file.size works for form-uploaded images, file.stat.size works -195: # for file object created by File.open('foo.jpg', 'rb') -196: file_size = file.respond_to?(:size) ? file.size : file.stat.size -197: -198: if file.respond_to?(:read) && file_size > 0 -199: # Create RMagick Image object from uploaded file -200: if file.path -201: @uploaded_image = Magick::Image.read(file.path).first -202: else -203: @uploaded_image = Magick::Image.from_blob(file.read).first -204: end -205: -206: set_magic_attributes(file) -207: -208: # Success, make sure everything is valid -209: @missing_image = false -210: @invalid_image = false -211: else -212: if self.class.require_image && !@uploaded_image -213: @missing_image = true -214: end -215: end -216: rescue Magick::ImageMagickError => e -217: if e.to_s =~ /no decode delegate for this image format/ -218: @invalid_image = true -219: else -220: raise e -221: end -222: end + # File lib/fleximage/model.rb, line 196 +196: def image_file=(file) +197: # Get the size of the file. file.size works for form-uploaded images, file.stat.size works +198: # for file object created by File.open('foo.jpg', 'rb') +199: file_size = file.respond_to?(:size) ? file.size : file.stat.size +200: +201: if file.respond_to?(:read) && file_size > 0 +202: # Create RMagick Image object from uploaded file +203: if file.path +204: @uploaded_image = Magick::Image.read(file.path).first +205: else +206: @uploaded_image = Magick::Image.from_blob(file.read).first +207: end +208: +209: set_magic_attributes(file) +210: +211: # Success, make sure everything is valid +212: @missing_image = false +213: @invalid_image = false +214: else +215: if self.class.require_image && !@uploaded_image +216: @missing_image = true +217: end +218: end +219: rescue Magick::ImageMagickError => e +220: if e.to_s =~ /no decode delegate for this image format/ +221: @invalid_image = true +222: else +223: raise e +224: end +225: end </pre> </div> </div> @@ -340,10 +340,10 @@ to make forms happy. onclick="toggleCode('M000008-source');return false;">[Source]</a> <div class="method-source-code" id="M000008-source"> <pre> - # File lib/fleximage/model.rb, line 256 -256: def image_file_url -257: @image_file_url -258: end + # File lib/fleximage/model.rb, line 259 +259: def image_file_url +260: @image_file_url +261: end </pre> </div> </div> @@ -373,22 +373,22 @@ machine, or pull from the internet. onclick="toggleCode('M000007-source');return false;">[Source]</a> <div class="method-source-code" id="M000007-source"> <pre> - # File lib/fleximage/model.rb, line 231 -231: def image_file_url=(file_url) -232: @image_file_url = file_url -233: if file_url =~ %r{^https?://} -234: file = open(file_url) -235: -236: # Force a URL based file to have an original_filename -237: eval "class << file\ndef original_filename\n\"\#{file_url}\"\nend\nend\n" + # File lib/fleximage/model.rb, line 234 +234: def image_file_url=(file_url) +235: @image_file_url = file_url +236: if file_url =~ %r{^https?://} +237: file = open(file_url) 238: -239: self.image_file = file -240: elsif file_url.empty? -241: @missing_image = true unless @uploaded_image -242: else -243: @invalid_image = true -244: end -245: end +239: # Force a URL based file to have an original_filename +240: eval "class << file\ndef original_filename\n\"\#{file_url}\"\nend\nend\n" +241: +242: self.image_file = file +243: elsif file_url.empty? +244: @missing_image = true unless @uploaded_image +245: else +246: @invalid_image = true +247: end +248: end </pre> </div> </div> @@ -420,14 +420,14 @@ code inside a block passed to this method. onclick="toggleCode('M000010-source');return false;">[Source]</a> <div class="method-source-code" id="M000010-source"> <pre> - # File lib/fleximage/model.rb, line 274 -274: def operate(&block) -275: returning self do -276: proxy = ImageProxy.new(load_image, self) -277: block.call(proxy) -278: @output_image = proxy.image -279: end -280: end + # File lib/fleximage/model.rb, line 277 +277: def operate(&block) +278: returning self do +279: proxy = ImageProxy.new(load_image, self) +280: block.call(proxy) +281: @output_image = proxy.image +282: end +283: end </pre> </div> </div> rdoc/classes/Fleximage/Model/InstanceMethods.html @@ -1 +1 @@ -Sat, 12 Apr 2008 13:20:45 -0700 +Sat, 12 Apr 2008 13:32:13 -0700 rdoc/created.rid @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Sat Apr 12 12:01:03 -0700 2008</td> + <td>Sat Apr 12 13:26:28 -0700 2008</td> </tr> </table> </div> rdoc/files/README_rdoc.html @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Sat Apr 12 13:17:52 -0700 2008</td> + <td>Sat Apr 12 13:32:05 -0700 2008</td> </tr> </table> </div> rdoc/files/lib/fleximage/model_rb.html @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Sat Apr 12 11:58:17 -0700 2008</td> + <td>Sat Apr 12 13:32:01 -0700 2008</td> </tr> </table> </div> rdoc/files/lib/fleximage/view_rb.html 94510c8e68e7e755fc889232cdc6a86cbb402dcd Alex Wayne alex@beautifulpixel.com http://github.com/Squeegy/fleximage/commit/aff901aec01ec23110b700cd1480f63420e8baad aff901aec01ec23110b700cd1480f63420e8baad

2008-04-12T13:32:36-07:00

rdoc update 291cef9e67f40561de984f7d058b2b9ad03641f7 Alex Wayne alex@beautifulpixel.com