test/fixtures/100x1.jpg test/fixtures/100x100.jpg test/fixtures/1x1.jpg test/fixtures/1x100.jpg test/rails_root/tmp/fleximage/1x1.jpg test/rails_root/tmp/fleximage/1x100.jpg test/unit/minimum_image_size_test.rb @@ -11,6 +11,7 @@ While they still can be set by using the 'missing_image_message' and 'invalid_im messages: missing_image: is really required invalid_image: seems to be broken + image_too_small: "seems to be too small, it needs to be {{minimum}} pixels" They can also be set on a model level: @@ -21,9 +22,24 @@ They can also be set on a model level: photo: missing_image: needs to be attached invalid_image: is broken + image_too_small: "is too small (should be >= {{minimum}})" If no message is set in your locale, the default one of the original plugin will be shown. +== Model class accessor minimum_image_size + +If this option is set, the model validates that the image is bigger than or equal to a minimum size. + + minimum_image_size [800, 600] + +You can set one integer to 1 if you just want one dimension be checked. (E.g. [800, 1] for images wider than 799 px) + +The corresponding error message can be set either via + + image_too_small_message "too small image (min {{minimum}})" + +or as shown above via I18n. + == Installation Using git: README.rdoc @@ -119,7 +119,6 @@ module Fleximage # Missing image message #dsl_accessor :missing_image_message, :default => 'is required' - def self.missing_image_message(str = nil) fb = 'is required' if str.nil? @@ -139,7 +138,6 @@ module Fleximage # Invalid image message #dsl_accessor :invalid_image_message, :default => 'was not a readable image' - def self.invalid_image_message(str = nil) fb = 'was not a readable image' if str.nil? @@ -155,6 +153,30 @@ module Fleximage end end + # Image too small message + # Should include {{minimum}} + def self.image_too_small_message(str = nil) + fb = "is too small (Minimum: #{minimum_image_size_to_s})" + if str.nil? + if @image_too_small_message + @image_too_small_message + else + translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.image_too_small", :minimum => minimum_image_size_to_s + translation = I18n.translate "activerecord.errors.messages.image_too_small", :minimum => minimum_image_size_to_s, :default => fb.gsub("{{minimum}}", minimum_image_size_to_s) if translation.match /translation missing:/ + translation + end + else + @image_too_small_message = str + end + end + + def self.minimum_image_size_to_s + if minimum_image_size.is_a?(Array) && minimum_image_size.size == 2 + #if minimum_image_size[0] > 0 && minimum_image_size[1] > 0 + "#{minimum_image_size[0]}x#{minimum_image_size[1]}" + end + end + # Sets the quality of rendered JPGs dsl_accessor :output_image_jpg_quality, :default => 85 @@ -169,6 +191,11 @@ module Fleximage # the "preprocess_image { |image| ... }" class method. dsl_accessor :preprocess_image_operation + # Set a minimum size ([x, y] e.g. [800, 600]) + # Set [0, 600] to just enforce y size or + # [800, 0] to just validate x size. + dsl_accessor :minimum_image_size + # Image related save and destroy callbacks after_destroy :delete_image_file before_save :pre_save @@ -446,6 +473,13 @@ module Fleximage errors.add field_name, self.class.invalid_image_message elsif self.class.require_image && !has_image? errors.add field_name, self.class.missing_image_message + elsif self.class.minimum_image_size.is_a?(Array) && + self.class.minimum_image_size.size == 2 && + !@uploaded_image.nil? + if @uploaded_image.columns < self.class.minimum_image_size[0] || + @uploaded_image.rows < self.class.minimum_image_size[1] + errors.add field_name, self.class.image_too_small_message + end end end lib/fleximage/model.rb @@ -80,7 +80,7 @@ <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000019">embedded_image_tag</a>   + <a href="#M000021">embedded_image_tag</a>   </div> </div> @@ -102,19 +102,19 @@ <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000019" class="method-detail"> - <a name="M000019"></a> + <div id="method-M000021" class="method-detail"> + <a name="M000021"></a> <div class="method-heading"> - <a href="#M000019" class="method-signature"> + <a href="#M000021" class="method-signature"> embedded_image_tag(model_object, options = {}) </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000019-source');return false;">[Source]</a> - <div class="method-source-code" id="M000019-source"> + onclick="toggleCode('M000021-source');return false;">[Source]</a> + <div class="method-source-code" id="M000021-source"> <pre> # File lib/fleximage/helper.rb, line 3 3: def embedded_image_tag(model_object, options = {}) rdoc/classes/Fleximage/Helper.html @@ -104,8 +104,8 @@ href="ImageProxy.html">ImageProxy</a> <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000037">method_missing</a>   - <a href="#M000036">new</a>   + <a href="#M000039">method_missing</a>   + <a href="#M000038">new</a>   </div> </div> @@ -143,22 +143,22 @@ The image to be manipulated by operators. <div id="methods"> <h3 class="section-bar">Public Class methods</h3> - <div id="method-M000036" class="method-detail"> - <a name="M000036"></a> + <div id="method-M000038" class="method-detail"> + <a name="M000038"></a> <div class="method-heading"> - <a href="#M000036" class="method-signature"> + <a href="#M000038" class="method-signature"> new(image, model_obj) </a> </div> <div class="method-description"> -Create a <a href="ImageProxy.html#M000036">new</a> image operator proxy. +Create a <a href="ImageProxy.html#M000038">new</a> image operator proxy. <a class="source-toggle" href="#" - onclick="toggleCode('M000036-source');return false;">[Source]</a> - <div class="method-source-code" id="M000036-source"> + onclick="toggleCode('M000038-source');return false;">[Source]</a> + <div class="method-source-code" id="M000038-source"> <pre> # File lib/fleximage/image_proxy.rb, line 21 21: def initialize(image, model_obj) @@ -172,11 +172,11 @@ Create a <a href="ImageProxy.html#M000036">new</a> image operator proxy. <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000037" class="method-detail"> - <a name="M000037"></a> + <div id="method-M000039" class="method-detail"> + <a name="M000039"></a> <div class="method-heading"> - <a href="#M000037" class="method-signature"> + <a href="#M000039" class="method-signature"> method_missing(method_name, *args) </a> </div> @@ -188,8 +188,8 @@ href="Operator.html">Operator</a> by that method‘s name. If it finds one, it will execute that operator. <a class="source-toggle" href="#" - onclick="toggleCode('M000037-source');return false;">[Source]</a> - <div class="method-source-code" id="M000037-source"> + onclick="toggleCode('M000039-source');return false;">[Source]</a> + <div class="method-source-code" id="M000039-source"> <pre> # File lib/fleximage/image_proxy.rb, line 28 28: def method_missing(method_name, *args) rdoc/classes/Fleximage/ImageProxy.html @@ -181,8 +181,10 @@ Example: <a href="#M000002">acts_as_fleximage</a>   <a href="#M000004">db_store?</a>   <a href="#M000005">has_store?</a>   - <a href="#M000008">image_file_exists</a>   + <a href="#M000010">image_file_exists</a>   + <a href="#M000008">image_too_small_message</a>   <a href="#M000007">invalid_image_message</a>   + <a href="#M000009">minimum_image_size_to_s</a>   <a href="#M000006">missing_image_message</a>   <a href="#M000003">preprocess_image</a>   </div> @@ -264,6 +266,43 @@ Internal method to ask this class if it stores image in the DB. </div> </div> + <div id="method-M000008" class="method-detail"> + <a name="M000008"></a> + + <div class="method-heading"> + <a href="#M000008" class="method-signature"> + image_too_small_message(str = nil) + </a> + </div> + + <div class="method-description"> + +Image too small message Should include {{minimum}} + + <a class="source-toggle" href="#" + onclick="toggleCode('M000008-source');return false;">[Source]</a> + <div class="method-source-code" id="M000008-source"> +<pre> + # File lib/fleximage/model.rb, line 158 +158: def self.image_too_small_message(str = nil) +159: fb = "is too small (Minimum: #{minimum_image_size_to_s})" +160: if str.nil? +161: if @image_too_small_message +162: @image_too_small_message +163: else +164: translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.image_too_small", :minimum => minimum_image_size_to_s +165: translation = I18n.translate "activerecord.errors.messages.image_too_small", :minimum => minimum_image_size_to_s, :default => fb.gsub("{{minimum}}", minimum_image_size_to_s) if translation.match /translation missing:/ +166: translation +167: end +168: else +169: @image_too_small_message = str +170: end +171: end +</pre> + </div> + </div> + </div> + <div id="method-M000007" class="method-detail"> <a name="M000007"></a> @@ -286,21 +325,47 @@ href="ClassMethods.html#M000007">invalid_image_message</a>, :default => onclick="toggleCode('M000007-source');return false;">[Source]</a> <div class="method-source-code" id="M000007-source"> <pre> - # File lib/fleximage/model.rb, line 143 -143: def self.invalid_image_message(str = nil) -144: fb = 'was not a readable image' -145: if str.nil? -146: if @invalid_image_message -147: @invalid_image_message -148: else -149: translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.invalid_image" -150: translation = I18n.translate "activerecord.errors.messages.invalid_image", :default => fb if translation.match /translation missing:/ -151: translation -152: end -153: else -154: @invalid_image_message = str -155: end -156: end + # File lib/fleximage/model.rb, line 141 +141: def self.invalid_image_message(str = nil) +142: fb = 'was not a readable image' +143: if str.nil? +144: if @invalid_image_message +145: @invalid_image_message +146: else +147: translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.invalid_image" +148: translation = I18n.translate "activerecord.errors.messages.invalid_image", :default => fb if translation.match /translation missing:/ +149: translation +150: end +151: else +152: @invalid_image_message = str +153: end +154: end +</pre> + </div> + </div> + </div> + + <div id="method-M000009" class="method-detail"> + <a name="M000009"></a> + + <div class="method-heading"> + <a href="#M000009" class="method-signature"> + minimum_image_size_to_s() + </a> + </div> + + <div class="method-description"> + <a class="source-toggle" href="#" + onclick="toggleCode('M000009-source');return false;">[Source]</a> + <div class="method-source-code" id="M000009-source"> +<pre> + # File lib/fleximage/model.rb, line 173 +173: def self.minimum_image_size_to_s +174: if minimum_image_size.is_a?(Array) && minimum_image_size.size == 2 +175: #if minimum_image_size[0] > 0 && minimum_image_size[1] > 0 +176: "#{minimum_image_size[0]}x#{minimum_image_size[1]}" +177: end +178: end </pre> </div> </div> @@ -328,22 +393,22 @@ href="ClassMethods.html#M000006">missing_image_message</a>, :default => onclick="toggleCode('M000006-source');return false;">[Source]</a> <div class="method-source-code" id="M000006-source"> <pre> - # File lib/fleximage/model.rb, line 123 -123: def self.missing_image_message(str = nil) -124: fb = 'is required' -125: if str.nil? -126: if @missing_image_message -127: @missing_image_message -128: else -129: translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.missing_image" -130: translation = I18n.translate "activerecord.errors.messages.missing_image", :default => fb if translation.match /translation missing:/ -131: translation -132: end -133: -134: else -135: @missing_image_message = str -136: end -137: end + # File lib/fleximage/model.rb, line 122 +122: def self.missing_image_message(str = nil) +123: fb = 'is required' +124: if str.nil? +125: if @missing_image_message +126: @missing_image_message +127: else +128: translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.missing_image" +129: translation = I18n.translate "activerecord.errors.messages.missing_image", :default => fb if translation.match /translation missing:/ +130: translation +131: end +132: +133: else +134: @missing_image_message = str +135: end +136: end </pre> </div> </div> @@ -448,107 +513,134 @@ nice looking block. 119: 120: # Missing image message 121: #dsl_accessor :missing_image_message, :default => 'is required' -122: -123: def self.missing_image_message(str = nil) -124: fb = 'is required' -125: if str.nil? -126: if @missing_image_message -127: @missing_image_message -128: else -129: translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.missing_image" -130: translation = I18n.translate "activerecord.errors.messages.missing_image", :default => fb if translation.match /translation missing:/ -131: translation -132: end -133: -134: else -135: @missing_image_message = str -136: end -137: end +122: def self.missing_image_message(str = nil) +123: fb = 'is required' +124: if str.nil? +125: if @missing_image_message +126: @missing_image_message +127: else +128: translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.missing_image" +129: translation = I18n.translate "activerecord.errors.messages.missing_image", :default => fb if translation.match /translation missing:/ +130: translation +131: end +132: +133: else +134: @missing_image_message = str +135: end +136: end +137: 138: -139: -140: # Invalid image message -141: #dsl_accessor :invalid_image_message, :default => 'was not a readable image' -142: -143: def self.invalid_image_message(str = nil) -144: fb = 'was not a readable image' -145: if str.nil? -146: if @invalid_image_message -147: @invalid_image_message -148: else -149: translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.invalid_image" -150: translation = I18n.translate "activerecord.errors.messages.invalid_image", :default => fb if translation.match /translation missing:/ -151: translation -152: end -153: else -154: @invalid_image_message = str -155: end -156: end -157: -158: # Sets the quality of rendered JPGs -159: dsl_accessor :output_image_jpg_quality, :default => 85 -160: -161: # Set a default image to use when no image has been assigned to this record -162: dsl_accessor :default_image_path -163: -164: # Set a default image based on a a size and fill -165: dsl_accessor :default_image -166: -167: # A block that processes an image before it gets saved as the master image of a record. -168: # Can be helpful to resize potentially huge images to something more manageable. Set via -169: # the "preprocess_image { |image| ... }" class method. -170: dsl_accessor :preprocess_image_operation -171: -172: # Image related save and destroy callbacks -173: after_destroy :delete_image_file -174: before_save :pre_save -175: after_save :post_save -176: -177: # execute configuration block -178: yield if block_given? +139: # Invalid image message +140: #dsl_accessor :invalid_image_message, :default => 'was not a readable image' +141: def self.invalid_image_message(str = nil) +142: fb = 'was not a readable image' +143: if str.nil? +144: if @invalid_image_message +145: @invalid_image_message +146: else +147: translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.invalid_image" +148: translation = I18n.translate "activerecord.errors.messages.invalid_image", :default => fb if translation.match /translation missing:/ +149: translation +150: end +151: else +152: @invalid_image_message = str +153: end +154: end +155: +156: # Image too small message +157: # Should include {{minimum}} +158: def self.image_too_small_message(str = nil) +159: fb = "is too small (Minimum: #{minimum_image_size_to_s})" +160: if str.nil? +161: if @image_too_small_message +162: @image_too_small_message +163: else +164: translation = I18n.translate "activerecord.errors.models.#{self.model_name.underscore}.image_too_small", :minimum => minimum_image_size_to_s +165: translation = I18n.translate "activerecord.errors.messages.image_too_small", :minimum => minimum_image_size_to_s, :default => fb.gsub("{{minimum}}", minimum_image_size_to_s) if translation.match /translation missing:/ +166: translation +167: end +168: else +169: @image_too_small_message = str +170: end +171: end +172: +173: def self.minimum_image_size_to_s +174: if minimum_image_size.is_a?(Array) && minimum_image_size.size == 2 +175: #if minimum_image_size[0] > 0 && minimum_image_size[1] > 0 +176: "#{minimum_image_size[0]}x#{minimum_image_size[1]}" +177: end +178: end 179: -180: # set the image directory from passed options -181: image_directory options[:image_directory] if options[:image_directory] +180: # Sets the quality of rendered JPGs +181: dsl_accessor :output_image_jpg_quality, :default => 85 182: -183: # Require the declaration of a master image storage directory -184: if !image_directory && !db_store? && !default_image && !default_image_path -185: raise "No place to put images! Declare this via the :image_directory => 'path/to/directory' option\n"+ -186: "Or add a database column named image_file_data for DB storage" -187: end -188: end +183: # Set a default image to use when no image has been assigned to this record +184: dsl_accessor :default_image_path +185: +186: # Set a default image based on a a size and fill +187: dsl_accessor :default_image +188: +189: # A block that processes an image before it gets saved as the master image of a record. +190: # Can be helpful to resize potentially huge images to something more manageable. Set via +191: # the "preprocess_image { |image| ... }" class method. +192: dsl_accessor :preprocess_image_operation +193: +194: # Set a minimum size ([x, y] e.g. [800, 600]) +195: # Set [0, 600] to just enforce y size or +196: # [800, 0] to just validate x size. +197: dsl_accessor :minimum_image_size +198: +199: # Image related save and destroy callbacks +200: after_destroy :delete_image_file +201: before_save :pre_save +202: after_save :post_save +203: +204: # execute configuration block +205: yield if block_given? +206: +207: # set the image directory from passed options +208: image_directory options[:image_directory] if options[:image_directory] +209: +210: # Require the declaration of a master image storage directory +211: if !image_directory && !db_store? && !default_image && !default_image_path +212: raise "No place to put images! Declare this via the :image_directory => 'path/to/directory' option\n"+ +213: "Or add a database column named image_file_data for DB storage" +214: end +215: end </pre> </div> </div> </div> - <div id="method-M000008" class="method-detail"> - <a name="M000008"></a> + <div id="method-M000010" class="method-detail"> + <a name="M000010"></a> <div class="method-heading"> - <a href="#M000008" class="method-signature"> + <a href="#M000010" class="method-signature"> image_file_exists(file) </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000008-source');return false;">[Source]</a> - <div class="method-source-code" id="M000008-source"> + onclick="toggleCode('M000010-source');return false;">[Source]</a> + <div class="method-source-code" id="M000010-source"> <pre> - # File lib/fleximage/model.rb, line 190 -190: def image_file_exists(file) -191: # File must be a valid object -192: return false if file.nil? -193: -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'). It must have a size > 0. -196: return false if (file.respond_to?(:size) ? file.size : file.stat.size) <= 0 -197: -198: # object must respond to the read method to fetch its contents. -199: return false if !file.respond_to?(:read) -200: -201: # file validation passed, return true -202: true -203: end + # File lib/fleximage/model.rb, line 217 +217: def image_file_exists(file) +218: # File must be a valid object +219: return false if file.nil? +220: +221: # Get the size of the file. file.size works for form-uploaded images, file.stat.size works +222: # for file object created by File.open('foo.jpg', 'rb'). It must have a size > 0. +223: return false if (file.respond_to?(:size) ? file.size : file.stat.size) <= 0 +224: +225: # object must respond to the read method to fetch its contents. +226: return false if !file.respond_to?(:read) +227: +228: # file validation passed, return true +229: true +230: end </pre> </div> </div> rdoc/classes/Fleximage/Model/ClassMethods.html @@ -86,16 +86,16 @@ Provides methods that every model instance that acts_as_fleximage needs. <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000018">delete_image_file</a>   - <a href="#M000009">directory_path</a>   - <a href="#M000010">file_path</a>   - <a href="#M000015">has_image?</a>   - <a href="#M000016">has_saved_image?</a>   - <a href="#M000011">image_file=</a>   - <a href="#M000013">image_file_temp=</a>   - <a href="#M000014">image_file_url</a>   - <a href="#M000012">image_file_url=</a>   - <a href="#M000017">operate</a>   + <a href="#M000020">delete_image_file</a>   + <a href="#M000011">directory_path</a>   + <a href="#M000012">file_path</a>   + <a href="#M000017">has_image?</a>   + <a href="#M000018">has_saved_image?</a>   + <a href="#M000013">image_file=</a>   + <a href="#M000015">image_file_temp=</a>   + <a href="#M000016">image_file_url</a>   + <a href="#M000014">image_file_url=</a>   + <a href="#M000019">operate</a>   </div> </div> @@ -117,11 +117,11 @@ Provides methods that every model instance that acts_as_fleximage needs. <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000018" class="method-detail"> - <a name="M000018"></a> + <div id="method-M000020" class="method-detail"> + <a name="M000020"></a> <div class="method-heading"> - <a href="#M000018" class="method-signature"> + <a href="#M000020" class="method-signature"> delete_image_file() </a> </div> @@ -133,33 +133,33 @@ record gets destroyed, but you can call it manually if you want to remove the image from the record. <a class="source-toggle" href="#" - onclick="toggleCode('M000018-source');return false;">[Source]</a> - <div class="method-source-code" id="M000018-source"> + onclick="toggleCode('M000020-source');return false;">[Source]</a> + <div class="method-source-code" id="M000020-source"> <pre> - # File lib/fleximage/model.rb, line 428 -428: def delete_image_file -429: return unless self.class.has_store? -430: -431: if self.class.db_store? -432: update_attribute :image_file_data, nil unless frozen? -433: else -434: File.delete(file_path) if File.exists?(file_path) -435: end -436: -437: clear_magic_attributes -438: -439: self -440: end + # File lib/fleximage/model.rb, line 455 +455: def delete_image_file +456: return unless self.class.has_store? +457: +458: if self.class.db_store? +459: update_attribute :image_file_data, nil unless frozen? +460: else +461: File.delete(file_path) if File.exists?(file_path) +462: end +463: +464: clear_magic_attributes +465: +466: self +467: end </pre> </div> </div> </div> - <div id="method-M000009" class="method-detail"> - <a name="M000009"></a> + <div id="method-M000011" class="method-detail"> + <a name="M000011"></a> <div class="method-heading"> - <a href="#M000009" class="method-signature"> + <a href="#M000011" class="method-signature"> directory_path() </a> </div> @@ -180,34 +180,34 @@ number files in a directory. @some_image.directory_path #=> /var/www/myapp/uploaded_images/2008/3/30 </pre> <a class="source-toggle" href="#" - onclick="toggleCode('M000009-source');return false;">[Source]</a> - <div class="method-source-code" id="M000009-source"> + onclick="toggleCode('M000011-source');return false;">[Source]</a> + <div class="method-source-code" id="M000011-source"> <pre> - # File lib/fleximage/model.rb, line 218 -218: def directory_path -219: raise 'No image directory was defined, cannot generate path' unless self.class.image_directory -220: -221: # base directory -222: directory = "#{RAILS_ROOT}/#{self.class.image_directory}" -223: -224: # specific creation date based directory suffix. -225: creation = self[:created_at] || self[:created_on] -226: if self.class.use_creation_date_based_directories && creation -227: "#{directory}/#{creation.year}/#{creation.month}/#{creation.day}" -228: else -229: directory -230: end -231: end + # File lib/fleximage/model.rb, line 245 +245: def directory_path +246: raise 'No image directory was defined, cannot generate path' unless self.class.image_directory +247: +248: # base directory +249: directory = "#{RAILS_ROOT}/#{self.class.image_directory}" +250: +251: # specific creation date based directory suffix. +252: creation = self[:created_at] || self[:created_on] +253: if self.class.use_creation_date_based_directories && creation +254: "#{directory}/#{creation.year}/#{creation.month}/#{creation.day}" +255: else +256: directory +257: end +258: end </pre> </div> </div> </div> - <div id="method-M000010" class="method-detail"> - <a name="M000010"></a> + <div id="method-M000012" class="method-detail"> + <a name="M000012"></a> <div class="method-heading"> - <a href="#M000010" class="method-signature"> + <a href="#M000012" class="method-signature"> file_path() </a> </div> @@ -220,23 +220,23 @@ Returns the path to the master image file for this record. @some_image.file_path #=> /var/www/myapp/uploaded_images/123.png </pre> <a class="source-toggle" href="#" - onclick="toggleCode('M000010-source');return false;">[Source]</a> - <div class="method-source-code" id="M000010-source"> + onclick="toggleCode('M000012-source');return false;">[Source]</a> + <div class="method-source-code" id="M000012-source"> <pre> - # File lib/fleximage/model.rb, line 236 -236: def file_path -237: "#{directory_path}/#{id}.#{self.class.image_storage_format}" -238: end + # File lib/fleximage/model.rb, line 263 +263: def file_path +264: "#{directory_path}/#{id}.#{self.class.image_storage_format}" +265: end </pre> </div> </div> </div> - <div id="method-M000015" class="method-detail"> - <a name="M000015"></a> + <div id="method-M000017" class="method-detail"> + <a name="M000017"></a> <div class="method-heading"> - <a href="#M000015" class="method-signature"> + <a href="#M000017" class="method-signature"> has_image?() </a> </div> @@ -246,46 +246,46 @@ Returns the path to the master image file for this record. Return true if this record has an image. <a class="source-toggle" href="#" - onclick="toggleCode('M000015-source');return false;">[Source]</a> - <div class="method-source-code" id="M000015-source"> + onclick="toggleCode('M000017-source');return false;">[Source]</a> + <div class="method-source-code" id="M000017-source"> <pre> - # File lib/fleximage/model.rb, line 352 -352: def has_image? -353: @uploaded_image || @output_image || has_saved_image? -354: end + # File lib/fleximage/model.rb, line 379 +379: def has_image? +380: @uploaded_image || @output_image || has_saved_image? +381: end </pre> </div> </div> </div> - <div id="method-M000016" class="method-detail"> - <a name="M000016"></a> + <div id="method-M000018" class="method-detail"> + <a name="M000018"></a> <div class="method-heading"> - <a href="#M000016" class="method-signature"> + <a href="#M000018" class="method-signature"> has_saved_image?() </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000016-source');return false;">[Source]</a> - <div class="method-source-code" id="M000016-source"> + onclick="toggleCode('M000018-source');return false;">[Source]</a> + <div class="method-source-code" id="M000018-source"> <pre> - # File lib/fleximage/model.rb, line 356 -356: def has_saved_image? -357: self.class.db_store? ? !!image_file_data : File.exists?(file_path) -358: end + # File lib/fleximage/model.rb, line 383 +383: def has_saved_image? +384: self.class.db_store? ? !!image_file_data : File.exists?(file_path) +385: end </pre> </div> </div> </div> - <div id="method-M000011" class="method-detail"> - <a name="M000011"></a> + <div id="method-M000013" class="method-detail"> + <a name="M000013"></a> <div class="method-heading"> - <a href="#M000011" class="method-signature"> + <a href="#M000013" class="method-signature"> image_file=(file) </a> </div> @@ -317,53 +317,53 @@ situations you would expect it to. p.images.create(params[:photo]) </pre> <a class="source-toggle" href="#" - onclick="toggleCode('M000011-source');return false;">[Source]</a> - <div class="method-source-code" id="M000011-source"> + onclick="toggleCode('M000013-source');return false;">[Source]</a> + <div class="method-source-code" id="M000013-source"> <pre> - # File lib/fleximage/model.rb, line 262 -262: def image_file=(file) -263: if self.class.image_file_exists(file) -264: -265: # Create RMagick Image object from uploaded file -266: if file.path -267: @uploaded_image = Magick::Image.read(file.path).first -268: else -269: @uploaded_image = Magick::Image.from_blob(file.read).first -270: end -271: -272: # Sanitize image data -273: @uploaded_image.colorspace = Magick::RGBColorspace -274: @uploaded_image.density = '72' -275: -276: # Save meta data to database -277: set_magic_attributes(file) -278: -279: # Success, make sure everything is valid -280: @invalid_image = false -281: save_temp_image(file) unless @dont_save_temp -282: end -283: rescue Magick::ImageMagickError => e -284: error_strings = [ -285: 'Improper image header', -286: 'no decode delegate for this image format', -287: 'UnableToOpenBlob' -288: ] -289: if e.to_s =~ /#{error_strings.join('|')}/ -290: @invalid_image = true -291: else -292: raise e -293: end -294: end + # File lib/fleximage/model.rb, line 289 +289: def image_file=(file) +290: if self.class.image_file_exists(file) +291: +292: # Create RMagick Image object from uploaded file +293: if file.path +294: @uploaded_image = Magick::Image.read(file.path).first +295: else +296: @uploaded_image = Magick::Image.from_blob(file.read).first +297: end +298: +299: # Sanitize image data +300: @uploaded_image.colorspace = Magick::RGBColorspace +301: @uploaded_image.density = '72' +302: +303: # Save meta data to database +304: set_magic_attributes(file) +305: +306: # Success, make sure everything is valid +307: @invalid_image = false +308: save_temp_image(file) unless @dont_save_temp +309: end +310: rescue Magick::ImageMagickError => e +311: error_strings = [ +312: 'Improper image header', +313: 'no decode delegate for this image format', +314: 'UnableToOpenBlob' +315: ] +316: if e.to_s =~ /#{error_strings.join('|')}/ +317: @invalid_image = true +318: else +319: raise e +320: end +321: end </pre> </div> </div> </div> - <div id="method-M000013" class="method-detail"> - <a name="M000013"></a> + <div id="method-M000015" class="method-detail"> + <a name="M000015"></a> <div class="method-heading"> - <a href="#M000013" class="method-signature"> + <a href="#M000015" class="method-signature"> image_file_temp=(file_name) </a> </div> @@ -375,62 +375,62 @@ just uploaded. Use as a hidden field in your forms to keep an uploaded image when validation fails and the form needs to be redisplayed <a class="source-toggle" href="#" - onclick="toggleCode('M000013-source');return false;">[Source]</a> - <div class="method-source-code" id="M000013-source"> + onclick="toggleCode('M000015-source');return false;">[Source]</a> + <div class="method-source-code" id="M000015-source"> <pre> - # File lib/fleximage/model.rb, line 330 -330: def image_file_temp=(file_name) -331: if !@uploaded_image && file_name && file_name.any? -332: @image_file_temp = file_name -333: file_path = "#{RAILS_ROOT}/tmp/fleximage/#{file_name}" -334: -335: @dont_save_temp = true -336: if File.exists?(file_path) -337: File.open(file_path, 'rb') do |f| -338: self.image_file = f -339: end -340: end -341: @dont_save_temp = false -342: end -343: end + # File lib/fleximage/model.rb, line 357 +357: def image_file_temp=(file_name) +358: if !@uploaded_image && file_name && file_name.any? +359: @image_file_temp = file_name +360: file_path = "#{RAILS_ROOT}/tmp/fleximage/#{file_name}" +361: +362: @dont_save_temp = true +363: if File.exists?(file_path) +364: File.open(file_path, 'rb') do |f| +365: self.image_file = f +366: end +367: end +368: @dont_save_temp = false +369: end +370: end </pre> </div> </div> </div> - <div id="method-M000014" class="method-detail"> - <a name="M000014"></a> + <div id="method-M000016" class="method-detail"> + <a name="M000016"></a> <div class="method-heading"> - <a href="#M000014" class="method-signature"> + <a href="#M000016" class="method-signature"> image_file_url() </a> </div> <div class="method-description"> -Return the @<a href="InstanceMethods.html#M000014">image_file_url</a> that +Return the @<a href="InstanceMethods.html#M000016">image_file_url</a> that was previously assigned. This is not saved in the database, and only exists to make forms happy. <a class="source-toggle" href="#" - onclick="toggleCode('M000014-source');return false;">[Source]</a> - <div class="method-source-code" id="M000014-source"> + onclick="toggleCode('M000016-source');return false;">[Source]</a> + <div class="method-source-code" id="M000016-source"> <pre> - # File lib/fleximage/model.rb, line 347 -347: def image_file_url -348: @image_file_url -349: end + # File lib/fleximage/model.rb, line 374 +374: def image_file_url +375: @image_file_url +376: end </pre> </div> </div> </div> - <div id="method-M000012" class="method-detail"> - <a name="M000012"></a> + <div id="method-M000014" class="method-detail"> + <a name="M000014"></a> <div class="method-heading"> - <a href="#M000012" class="method-signature"> + <a href="#M000014" class="method-signature"> image_file_url=(file_url) </a> </div> @@ -447,38 +447,38 @@ machine, or pull from the internet. @photo.image_file_url = 'http://foo.com/bar.jpg' </pre> <a class="source-toggle" href="#" - onclick="toggleCode('M000012-source');return false;">[Source]</a> - <div class="method-source-code" id="M000012-source"> + onclick="toggleCode('M000014-source');return false;">[Source]</a> + <div class="method-source-code" id="M000014-source"> <pre> - # File lib/fleximage/model.rb, line 303 -303: def image_file_url=(file_url) -304: @image_file_url = file_url -305: if file_url =~ %r{^https?://} -306: file = open(file_url) -307: -308: # Force a URL based file to have an original_filename -309: eval "def file.original_filename\n\"\#{file_url}\"\nend\n" -310: -311: self.image_file = file -312: -313: elsif file_url.empty? -314: # Nothing to process, move along -315: -316: else -317: # invalid URL, raise invalid image validation error -318: @invalid_image = true -319: end -320: end + # File lib/fleximage/model.rb, line 330 +330: def image_file_url=(file_url) +331: @image_file_url = file_url +332: if file_url =~ %r{^https?://} +333: file = open(file_url) +334: +335: # Force a URL based file to have an original_filename +336: eval "def file.original_filename\n\"\#{file_url}\"\nend\n" +337: +338: self.image_file = file +339: +340: elsif file_url.empty? +341: # Nothing to process, move along +342: +343: else +344: # invalid URL, raise invalid image validation error +345: @invalid_image = true +346: end +347: end </pre> </div> </div> </div> - <div id="method-M000017" class="method-detail"> - <a name="M000017"></a> + <div id="method-M000019" class="method-detail"> + <a name="M000019"></a> <div class="method-heading"> - <a href="#M000017" class="method-signature"> + <a href="#M000019" class="method-signature"> operate(&block) </a> </div> @@ -497,17 +497,17 @@ code inside a block passed to this method. end </pre> <a class="source-toggle" href="#" - onclick="toggleCode('M000017-source');return false;">[Source]</a> - <div class="method-source-code" id="M000017-source"> + onclick="toggleCode('M000019-source');return false;">[Source]</a> + <div class="method-source-code" id="M000019-source"> <pre> - # File lib/fleximage/model.rb, line 369 -369: def operate(&block) -370: returning self do -371: proxy = ImageProxy.new(load_image, self) -372: block.call(proxy) -373: @output_image = proxy.image -374: end -375: end + # File lib/fleximage/model.rb, line 396 +396: def operate(&block) +397: returning self do +398: proxy = ImageProxy.new(load_image, self) +399: block.call(proxy) +400: @output_image = proxy.image +401: end +402: end </pre> </div> </div> rdoc/classes/Fleximage/Model/InstanceMethods.html @@ -83,13 +83,13 @@ The <a href="Base.html">Operator::Base</a> class is what all other <a href="../Operator.html">Operator</a> classes inherit from. To write your own <a href="../Operator.html">Operator</a> class, simply inherit from this -class, and implement your own <a href="Base.html#M000025">operate</a> +class, and implement your own <a href="Base.html#M000027">operate</a> methods, with your own arguments. Just return a new RMagick image object that represents the new image, and the model will be updated automatically. You have access to a few instance variables in the <a -href="Base.html#M000025">operate</a> method: +href="Base.html#M000027">operate</a> method: <ul> <li>@image : The current image from the model. Use this is a starting point for @@ -111,14 +111,14 @@ in. Use it to get data out of your model for display in your image. <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000025">operate</a>   - <a href="#M000028">scale</a>   - <a href="#M000029">scale_and_crop</a>   - <a href="#M000027">size_to_xy</a>   - <a href="#M000026">size_to_xy</a>   - <a href="#M000030">stretch</a>   - <a href="#M000031">symbol_to_blending_mode</a>   - <a href="#M000032">symbol_to_gravity</a>   + <a href="#M000027">operate</a>   + <a href="#M000030">scale</a>   + <a href="#M000031">scale_and_crop</a>   + <a href="#M000029">size_to_xy</a>   + <a href="#M000028">size_to_xy</a>   + <a href="#M000032">stretch</a>   + <a href="#M000033">symbol_to_blending_mode</a>   + <a href="#M000034">symbol_to_gravity</a>   </div> </div> @@ -140,11 +140,11 @@ in. Use it to get data out of your model for display in your image. <div id="methods"> <h3 class="section-bar">Public Class methods</h3> - <div id="method-M000026" class="method-detail"> - <a name="M000026"></a> + <div id="method-M000028" class="method-detail"> + <a name="M000028"></a> <div class="method-heading"> - <a href="#M000026" class="method-signature"> + <a href="#M000028" class="method-signature"> size_to_xy(size) </a> </div> @@ -152,11 +152,11 @@ in. Use it to get data out of your model for display in your image. <div class="method-description"> Allows access to size conversion globally. See <a -href="Base.html#M000026">size_to_xy</a> for a more detailed explanation +href="Base.html#M000028">size_to_xy</a> for a more detailed explanation <a class="source-toggle" href="#" - onclick="toggleCode('M000026-source');return false;">[Source]</a> - <div class="method-source-code" id="M000026-source"> + onclick="toggleCode('M000028-source');return false;">[Source]</a> + <div class="method-source-code" id="M000028-source"> <pre> # File lib/fleximage/operator/base.rb, line 56 56: def self.size_to_xy(size) @@ -179,11 +179,11 @@ href="Base.html#M000026">size_to_xy</a> for a more detailed explanation <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000025" class="method-detail"> - <a name="M000025"></a> + <div id="method-M000027" class="method-detail"> + <a name="M000027"></a> <div class="method-heading"> - <a href="#M000025" class="method-signature"> + <a href="#M000027" class="method-signature"> operate(*args) </a> </div> @@ -195,8 +195,8 @@ href="Base.html">Operator::Base</a> subclasses in order to write your own image operators. <a class="source-toggle" href="#" - onclick="toggleCode('M000025-source');return false;">[Source]</a> - <div class="method-source-code" id="M000025-source"> + onclick="toggleCode('M000027-source');return false;">[Source]</a> + <div class="method-source-code" id="M000027-source"> <pre> # File lib/fleximage/operator/base.rb, line 47 47: def operate(*args) @@ -207,11 +207,11 @@ image operators. </div> </div> - <div id="method-M000028" class="method-detail"> - <a name="M000028"></a> + <div id="method-M000030" class="method-detail"> + <a name="M000030"></a> <div class="method-heading"> - <a href="#M000028" class="method-signature"> + <a href="#M000030" class="method-signature"> scale(size, img = @image) </a> </div> @@ -220,11 +220,11 @@ image operators. Scale the image, respecting aspect ratio. Operation will happen in the main <tt>@image</tt> unless you supply the <tt>img</tt> argument to <a -href="Base.html#M000025">operate</a> on instead. +href="Base.html#M000027">operate</a> on instead. <a class="source-toggle" href="#" - onclick="toggleCode('M000028-source');return false;">[Source]</a> - <div class="method-source-code" id="M000028-source"> + onclick="toggleCode('M000030-source');return false;">[Source]</a> + <div class="method-source-code" id="M000030-source"> <pre> # File lib/fleximage/operator/base.rb, line 87 87: def scale(size, img = @image) @@ -239,11 +239,11 @@ href="Base.html#M000025">operate</a> on instead. </div> </div> - <div id="method-M000029" class="method-detail"> - <a name="M000029"></a> + <div id="method-M000031" class="method-detail"> + <a name="M000031"></a> <div class="method-heading"> - <a href="#M000029" class="method-signature"> + <a href="#M000031" class="method-signature"> scale_and_crop(size, img = @image) </a> </div> @@ -252,12 +252,12 @@ href="Base.html#M000025">operate</a> on instead. Scale to the desired size and crop edges off to get the exact dimensions needed. Operation will happen in the main <tt>@image</tt> unless you supply -the <tt>img</tt> argument to <a href="Base.html#M000025">operate</a> on +the <tt>img</tt> argument to <a href="Base.html#M000027">operate</a> on instead. <a class="source-toggle" href="#" - onclick="toggleCode('M000029-source');return false;">[Source]</a> - <div class="method-source-code" id="M000029-source"> + onclick="toggleCode('M000031-source');return false;">[Source]</a> + <div class="method-source-code" id="M000031-source"> <pre> # File lib/fleximage/operator/base.rb, line 98 98: def scale_and_crop(size, img = @image) @@ -268,11 +268,11 @@ instead. </div> </div> - <div id="method-M000027" class="method-detail"> - <a name="M000027"></a> + <div id="method-M000029" class="method-detail"> + <a name="M000029"></a> <div class="method-heading"> - <a href="#M000027" class="method-signature"> + <a href="#M000029" class="method-signature"> size_to_xy(size) </a> </div> @@ -302,8 +302,8 @@ Usage: x, y = size_to_xy("10x20") </pre> <a class="source-toggle" href="#" - onclick="toggleCode('M000027-source');return false;">[Source]</a> - <div class="method-source-code" id="M000027-source"> + onclick="toggleCode('M000029-source');return false;">[Source]</a> + <div class="method-source-code" id="M000029-source"> <pre> # File lib/fleximage/operator/base.rb, line 80 80: def size_to_xy(size) @@ -314,11 +314,11 @@ Usage: </div> </div> - <div id="method-M000030" class="method-detail"> - <a name="M000030"></a> + <div id="method-M000032" class="method-detail"> + <a name="M000032"></a> <div class="method-heading"> - <a href="#M000030" class="method-signature"> + <a href="#M000032" class="method-signature"> stretch(size, img = @image) </a> </div> @@ -327,12 +327,12 @@ Usage: <a href="Resize.html">Resize</a> the image, with no respect to aspect ratio. Operation will happen in the main <tt>@image</tt> unless you supply -the <tt>img</tt> argument to <a href="Base.html#M000025">operate</a> on +the <tt>img</tt> argument to <a href="Base.html#M000027">operate</a> on instead. <a class="source-toggle" href="#" - onclick="toggleCode('M000030-source');return false;">[Source]</a> - <div class="method-source-code" id="M000030-source"> + onclick="toggleCode('M000032-source');return false;">[Source]</a> + <div class="method-source-code" id="M000032-source"> <pre> # File lib/fleximage/operator/base.rb, line 105 105: def stretch(size, img = @image) @@ -343,11 +343,11 @@ instead. </div> </div> - <div id="method-M000031" class="method-detail"> - <a name="M000031"></a> + <div id="method-M000033" class="method-detail"> + <a name="M000033"></a> <div class="method-heading"> - <a href="#M000031" class="method-signature"> + <a href="#M000033" class="method-signature"> symbol_to_blending_mode(mode) </a> </div> @@ -368,8 +368,8 @@ To use a blend mode remove the <tt>CompositeOp</tt> form the name and <tt>CopyBlackCompositeOp</tt> becomes :<tt>copy_black</tt>. <a class="source-toggle" href="#" - onclick="toggleCode('M000031-source');return false;">[Source]</a> - <div class="method-source-code" id="M000031-source"> + onclick="toggleCode('M000033-source');return false;">[Source]</a> + <div class="method-source-code" id="M000033-source"> <pre> # File lib/fleximage/operator/base.rb, line 116 116: def symbol_to_blending_mode(mode) @@ -382,19 +382,19 @@ To use a blend mode remove the <tt>CompositeOp</tt> form the name and </div> </div> - <div id="method-M000032" class="method-detail"> - <a name="M000032"></a> + <div id="method-M000034" class="method-detail"> + <a name="M000034"></a> <div class="method-heading"> - <a href="#M000032" class="method-signature"> + <a href="#M000034" class="method-signature"> symbol_to_gravity(gravity_name) </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000032-source');return false;">[Source]</a> - <div class="method-source-code" id="M000032-source"> + onclick="toggleCode('M000034-source');return false;">[Source]</a> + <div class="method-source-code" id="M000034-source"> <pre> # File lib/fleximage/operator/base.rb, line 122 122: def symbol_to_gravity(gravity_name) rdoc/classes/Fleximage/Operator/Base.html @@ -129,7 +129,7 @@ Example: <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000021">operate</a>   + <a href="#M000023">operate</a>   </div> </div> @@ -151,19 +151,19 @@ Example: <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000021" class="method-detail"> - <a name="M000021"></a> + <div id="method-M000023" class="method-detail"> + <a name="M000023"></a> <div class="method-heading"> - <a href="#M000021" class="method-signature"> + <a href="#M000023" class="method-signature"> operate(options = {}) </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000021-source');return false;">[Source]</a> - <div class="method-source-code" id="M000021-source"> + onclick="toggleCode('M000023-source');return false;">[Source]</a> + <div class="method-source-code" id="M000023-source"> <pre> # File lib/fleximage/operator/border.rb, line 33 33: def operate(options = {}) rdoc/classes/Fleximage/Operator/Border.html @@ -140,7 +140,7 @@ or <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000033">operate</a>   + <a href="#M000035">operate</a>   </div> </div> @@ -162,19 +162,19 @@ or <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000033" class="method-detail"> - <a name="M000033"></a> + <div id="method-M000035" class="method-detail"> + <a name="M000035"></a> <div class="method-heading"> - <a href="#M000033" class="method-signature"> + <a href="#M000035" class="method-signature"> operate(options = {}) </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000033-source');return false;">[Source]</a> - <div class="method-source-code" id="M000033-source"> + onclick="toggleCode('M000035-source');return false;">[Source]</a> + <div class="method-source-code" id="M000035-source"> <pre> # File lib/fleximage/operator/crop.rb, line 37 37: def operate(options = {}) rdoc/classes/Fleximage/Operator/Crop.html @@ -159,7 +159,7 @@ Example: <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000023">operate</a>   + <a href="#M000025">operate</a>   </div> </div> @@ -181,19 +181,19 @@ Example: <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000023" class="method-detail"> - <a name="M000023"></a> + <div id="method-M000025" class="method-detail"> + <a name="M000025"></a> <div class="method-heading"> - <a href="#M000023" class="method-signature"> + <a href="#M000025" class="method-signature"> operate(image_overlay_path, options = {}) </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000023-source');return false;">[Source]</a> - <div class="method-source-code" id="M000023-source"> + onclick="toggleCode('M000025-source');return false;">[Source]</a> + <div class="method-source-code" id="M000025-source"> <pre> # File lib/fleximage/operator/image_overlay.rb, line 52 52: def operate(image_overlay_path, options = {}) rdoc/classes/Fleximage/Operator/ImageOverlay.html @@ -142,7 +142,7 @@ Example: <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000034">operate</a>   + <a href="#M000036">operate</a>   </div> </div> @@ -164,19 +164,19 @@ Example: <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000034" class="method-detail"> - <a name="M000034"></a> + <div id="method-M000036" class="method-detail"> + <a name="M000036"></a> <div class="method-heading"> - <a href="#M000034" class="method-signature"> + <a href="#M000036" class="method-signature"> operate(size, options = {}) </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000034-source');return false;">[Source]</a> - <div class="method-source-code" id="M000034-source"> + onclick="toggleCode('M000036-source');return false;">[Source]</a> + <div class="method-source-code" id="M000036-source"> <pre> # File lib/fleximage/operator/resize.rb, line 39 39: def operate(size, options = {}) rdoc/classes/Fleximage/Operator/Resize.html @@ -147,7 +147,7 @@ Example: <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000022">operate</a>   + <a href="#M000024">operate</a>   </div> </div> @@ -169,19 +169,19 @@ Example: <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000022" class="method-detail"> - <a name="M000022"></a> + <div id="method-M000024" class="method-detail"> + <a name="M000024"></a> <div class="method-heading"> - <a href="#M000022" class="method-signature"> + <a href="#M000024" class="method-signature"> operate(options = {}) </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000022-source');return false;">[Source]</a> - <div class="method-source-code" id="M000022-source"> + onclick="toggleCode('M000024-source');return false;">[Source]</a> + <div class="method-source-code" id="M000024-source"> <pre> # File lib/fleximage/operator/shadow.rb, line 48 48: def operate(options = {}) rdoc/classes/Fleximage/Operator/Shadow.html @@ -146,7 +146,7 @@ Example: <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000024">operate</a>   + <a href="#M000026">operate</a>   </div> </div> @@ -168,19 +168,19 @@ Example: <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000024" class="method-detail"> - <a name="M000024"></a> + <div id="method-M000026" class="method-detail"> + <a name="M000026"></a> <div class="method-heading"> - <a href="#M000024" class="method-signature"> + <a href="#M000026" class="method-signature"> operate(string_to_write, options = {}) </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000024-source');return false;">[Source]</a> - <div class="method-source-code" id="M000024-source"> + onclick="toggleCode('M000026-source');return false;">[Source]</a> + <div class="method-source-code" id="M000026-source"> <pre> # File lib/fleximage/operator/text.rb, line 37 37: def operate(string_to_write, options = {}) rdoc/classes/Fleximage/Operator/Text.html @@ -96,7 +96,7 @@ that have the same color. <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000020">operate</a>   + <a href="#M000022">operate</a>   </div> </div> @@ -118,19 +118,19 @@ that have the same color. <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000020" class="method-detail"> - <a name="M000020"></a> + <div id="method-M000022" class="method-detail"> + <a name="M000022"></a> <div class="method-heading"> - <a href="#M000020" class="method-signature"> + <a href="#M000022" class="method-signature"> operate() </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000020-source');return false;">[Source]</a> - <div class="method-source-code" id="M000020-source"> + onclick="toggleCode('M000022-source');return false;">[Source]</a> + <div class="method-source-code" id="M000022-source"> <pre> # File lib/fleximage/operator/trim.rb, line 8 8: def operate() rdoc/classes/Fleximage/Operator/Trim.html @@ -125,7 +125,7 @@ Example: <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000035">operate</a>   + <a href="#M000037">operate</a>   </div> </div> @@ -147,19 +147,19 @@ Example: <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000035" class="method-detail"> - <a name="M000035"></a> + <div id="method-M000037" class="method-detail"> + <a name="M000037"></a> <div class="method-heading"> - <a href="#M000035" class="method-signature"> + <a href="#M000037" class="method-signature"> operate(options = {}) </a> </div> <div class="method-description"> <a class="source-toggle" href="#" - onclick="toggleCode('M000035-source');return false;">[Source]</a> - <div class="method-source-code" id="M000035-source"> + onclick="toggleCode('M000037-source');return false;">[Source]</a> + <div class="method-source-code" id="M000037-source"> <pre> # File lib/fleximage/operator/unsharp_mask.rb, line 21 21: def operate(options = {}) rdoc/classes/Fleximage/Operator/UnsharpMask.html @@ -1 +1 @@ -Sat, 28 Feb 2009 14:11:43 +0100 +Tue, 17 Mar 2009 15:29:02 +0100 rdoc/created.rid @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Sat Feb 28 14:11:40 +0100 2009</td> + <td>Tue Mar 17 15:28:58 +0100 2009</td> </tr> </table> </div> @@ -84,6 +84,7 @@ configure them in your locale: messages: missing_image: is really required invalid_image: seems to be broken + image_too_small: "seems to be too small, it needs to be {{minimum}} pixels" </pre> They can also be set on a model level: @@ -96,11 +97,33 @@ They can also be set on a model level: photo: missing_image: needs to be attached invalid_image: is broken + image_too_small: "is too small (should be >= {{minimum}})" </pre> If no message is set in your locale, the default one of the original plugin will be shown. +<h2>ModelClassAccessor minimum_image_size</h2> + +If this option is set, the model validates that the image is bigger than or +equal to a minimum size. + +<pre> + minimum_image_size [800, 600] +</pre> + +You can set one integer to 1 if you just want one dimension be checked. +(E.g. [800, 1] for images wider than 799 px) + + +The corresponding error message can be set either via + +<pre> + image_too_small_message "too small image (min {{minimum}})" +</pre> + +or as shown above via I18n. + <h2>Installation</h2> Using git: rdoc/files/README_rdoc.html @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Sat Feb 28 13:36:18 +0100 2009</td> + <td>Tue Mar 17 15:04:31 +0100 2009</td> </tr> </table> </div> rdoc/files/lib/fleximage/model_rb.html @@ -22,41 +22,43 @@ <div id="index-entries"> <a href="classes/Fleximage/Model/ClassMethods.html#M000002">acts_as_fleximage (Fleximage::Model::ClassMethods)</a> <a href="classes/Fleximage/Model/ClassMethods.html#M000004">db_store? (Fleximage::Model::ClassMethods)</a> - <a href="classes/Fleximage/Model/InstanceMethods.html#M000018">delete_image_file (Fleximage::Model::InstanceMethods)</a> - <a href="classes/Fleximage/Model/InstanceMethods.html#M000009">directory_path (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Model/InstanceMethods.html#M000020">delete_image_file (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Model/InstanceMethods.html#M000011">directory_path (Fleximage::Model::InstanceMethods)</a> <a href="classes/Class.html#M000001">dsl_accessor (Class)</a> - <a href="classes/Fleximage/Helper.html#M000019">embedded_image_tag (Fleximage::Helper)</a> - <a href="classes/Fleximage/Model/InstanceMethods.html#M000010">file_path (Fleximage::Model::InstanceMethods)</a> - <a href="classes/Fleximage/Model/InstanceMethods.html#M000015">has_image? (Fleximage::Model::InstanceMethods)</a> - <a href="classes/Fleximage/Model/InstanceMethods.html#M000016">has_saved_image? (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Helper.html#M000021">embedded_image_tag (Fleximage::Helper)</a> + <a href="classes/Fleximage/Model/InstanceMethods.html#M000012">file_path (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Model/InstanceMethods.html#M000017">has_image? (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Model/InstanceMethods.html#M000018">has_saved_image? (Fleximage::Model::InstanceMethods)</a> <a href="classes/Fleximage/Model/ClassMethods.html#M000005">has_store? (Fleximage::Model::ClassMethods)</a> - <a href="classes/Fleximage/Model/InstanceMethods.html#M000011">image_file= (Fleximage::Model::InstanceMethods)</a> - <a href="classes/Fleximage/Model/ClassMethods.html#M000008">image_file_exists (Fleximage::Model::ClassMethods)</a> - <a href="classes/Fleximage/Model/InstanceMethods.html#M000013">image_file_temp= (Fleximage::Model::InstanceMethods)</a> - <a href="classes/Fleximage/Model/InstanceMethods.html#M000014">image_file_url (Fleximage::Model::InstanceMethods)</a> - <a href="classes/Fleximage/Model/InstanceMethods.html#M000012">image_file_url= (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Model/InstanceMethods.html#M000013">image_file= (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Model/ClassMethods.html#M000010">image_file_exists (Fleximage::Model::ClassMethods)</a> + <a href="classes/Fleximage/Model/InstanceMethods.html#M000015">image_file_temp= (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Model/InstanceMethods.html#M000016">image_file_url (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Model/InstanceMethods.html#M000014">image_file_url= (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Model/ClassMethods.html#M000008">image_too_small_message (Fleximage::Model::ClassMethods)</a> <a href="classes/Fleximage/Model/ClassMethods.html#M000007">invalid_image_message (Fleximage::Model::ClassMethods)</a> - <a href="classes/Fleximage/ImageProxy.html#M000037">method_missing (Fleximage::ImageProxy)</a> + <a href="classes/Fleximage/ImageProxy.html#M000039">method_missing (Fleximage::ImageProxy)</a> + <a href="classes/Fleximage/Model/ClassMethods.html#M000009">minimum_image_size_to_s (Fleximage::Model::ClassMethods)</a> <a href="classes/Fleximage/Model/ClassMethods.html#M000006">missing_image_message (Fleximage::Model::ClassMethods)</a> - <a href="classes/Fleximage/ImageProxy.html#M000036">new (Fleximage::ImageProxy)</a> - <a href="classes/Fleximage/Operator/ImageOverlay.html#M000023">operate (Fleximage::Operator::ImageOverlay)</a> - <a href="classes/Fleximage/Operator/Border.html#M000021">operate (Fleximage::Operator::Border)</a> - <a href="classes/Fleximage/Model/InstanceMethods.html#M000017">operate (Fleximage::Model::InstanceMethods)</a> - <a href="classes/Fleximage/Operator/Trim.html#M000020">operate (Fleximage::Operator::Trim)</a> - <a href="classes/Fleximage/Operator/Text.html#M000024">operate (Fleximage::Operator::Text)</a> - <a href="classes/Fleximage/Operator/Base.html#M000025">operate (Fleximage::Operator::Base)</a> - <a href="classes/Fleximage/Operator/UnsharpMask.html#M000035">operate (Fleximage::Operator::UnsharpMask)</a> - <a href="classes/Fleximage/Operator/Resize.html#M000034">operate (Fleximage::Operator::Resize)</a> - <a href="classes/Fleximage/Operator/Crop.html#M000033">operate (Fleximage::Operator::Crop)</a> - <a href="classes/Fleximage/Operator/Shadow.html#M000022">operate (Fleximage::Operator::Shadow)</a> + <a href="classes/Fleximage/ImageProxy.html#M000038">new (Fleximage::ImageProxy)</a> + <a href="classes/Fleximage/Operator/Text.html#M000026">operate (Fleximage::Operator::Text)</a> + <a href="classes/Fleximage/Model/InstanceMethods.html#M000019">operate (Fleximage::Model::InstanceMethods)</a> + <a href="classes/Fleximage/Operator/Shadow.html#M000024">operate (Fleximage::Operator::Shadow)</a> + <a href="classes/Fleximage/Operator/ImageOverlay.html#M000025">operate (Fleximage::Operator::ImageOverlay)</a> + <a href="classes/Fleximage/Operator/Trim.html#M000022">operate (Fleximage::Operator::Trim)</a> + <a href="classes/Fleximage/Operator/Base.html#M000027">operate (Fleximage::Operator::Base)</a> + <a href="classes/Fleximage/Operator/UnsharpMask.html#M000037">operate (Fleximage::Operator::UnsharpMask)</a> + <a href="classes/Fleximage/Operator/Resize.html#M000036">operate (Fleximage::Operator::Resize)</a> + <a href="classes/Fleximage/Operator/Crop.html#M000035">operate (Fleximage::Operator::Crop)</a> + <a href="classes/Fleximage/Operator/Border.html#M000023">operate (Fleximage::Operator::Border)</a> <a href="classes/Fleximage/Model/ClassMethods.html#M000003">preprocess_image (Fleximage::Model::ClassMethods)</a> - <a href="classes/Fleximage/Operator/Base.html#M000028">scale (Fleximage::Operator::Base)</a> - <a href="classes/Fleximage/Operator/Base.html#M000029">scale_and_crop (Fleximage::Operator::Base)</a> - <a href="classes/Fleximage/Operator/Base.html#M000026">size_to_xy (Fleximage::Operator::Base)</a> - <a href="classes/Fleximage/Operator/Base.html#M000027">size_to_xy (Fleximage::Operator::Base)</a> - <a href="classes/Fleximage/Operator/Base.html#M000030">stretch (Fleximage::Operator::Base)</a> - <a href="classes/Fleximage/Operator/Base.html#M000031">symbol_to_blending_mode (Fleximage::Operator::Base)</a> - <a href="classes/Fleximage/Operator/Base.html#M000032">symbol_to_gravity (Fleximage::Operator::Base)</a> + <a href="classes/Fleximage/Operator/Base.html#M000030">scale (Fleximage::Operator::Base)</a> + <a href="classes/Fleximage/Operator/Base.html#M000031">scale_and_crop (Fleximage::Operator::Base)</a> + <a href="classes/Fleximage/Operator/Base.html#M000028">size_to_xy (Fleximage::Operator::Base)</a> + <a href="classes/Fleximage/Operator/Base.html#M000029">size_to_xy (Fleximage::Operator::Base)</a> + <a href="classes/Fleximage/Operator/Base.html#M000032">stretch (Fleximage::Operator::Base)</a> + <a href="classes/Fleximage/Operator/Base.html#M000033">symbol_to_blending_mode (Fleximage::Operator::Base)</a> + <a href="classes/Fleximage/Operator/Base.html#M000034">symbol_to_gravity (Fleximage::Operator::Base)</a> </div> </div> </body> rdoc/fr_method_index.html @@ -4,3 +4,4 @@ de: messages: missing_image: ist erforderlich invalid_image: war nicht lesbar + image_too_small: "ist zu klein (Minimalgröße: {{minimum}})" test/rails_root/app/locales/de.yml @@ -5,3 +5,4 @@ en: photo_custom_error: missing_image: needs to be attached invalid_image: seems to be broken + image_too_small: "must be bigger (min. size: {{minimum}})" test/rails_root/app/locales/en.yml @@ -1,3 +1,6 @@ class PhotoBare < ActiveRecord::Base - acts_as_fleximage :image_directory => 'public/uploads' + acts_as_fleximage do + image_directory 'public/uploads' + minimum_image_size [2, 2] + end end test/rails_root/app/models/photo_bare.rb @@ -1,4 +1,7 @@ class PhotoCustomError < ActiveRecord::Base set_table_name :photo_dbs - acts_as_fleximage :image_directory => 'public/uploads' + acts_as_fleximage do + image_directory 'public/uploads' + minimum_image_size [2, 2] + end end test/rails_root/app/models/photo_custom_error.rb @@ -42,6 +42,18 @@ class Test::Unit::TestCase #:nodoc: when :cmyk MockFile.new("#{RAILS_ROOT}/../fixtures/cmyk.jpg") + when :i100x100 + MockFile.new("#{RAILS_ROOT}/../fixtures/100x100.jpg") + + when :i1x100 + MockFile.new("#{RAILS_ROOT}/../fixtures/1x100.jpg") + + when :i100x1 + MockFile.new("#{RAILS_ROOT}/../fixtures/100x1.jpg") + + when :i1x1 + MockFile.new("#{RAILS_ROOT}/../fixtures/1x1.jpg") + end end test/test_helper.rb @@ -9,6 +9,9 @@ class I18nMessagesTest < Test::Unit::TestCase p = PhotoBare.new(:image_file => files(:not_a_photo)) p.save assert_equal "was not a readable image", p.errors["image_file"] + p = PhotoBare.new(:image_file => files(:i1x1)) + p.save + assert_equal "is too small (Minimum: 2x2)", p.errors["image_file"] end def test_should_have_german_message @@ -19,6 +22,9 @@ class I18nMessagesTest < Test::Unit::TestCase p = PhotoBare.new(:image_file => files(:not_a_photo)) p.save assert_equal "war nicht lesbar", p.errors["image_file"] + p = PhotoBare.new(:image_file => files(:i1x1)) + p.save + assert_equal "ist zu klein (Minimalgröße: 2x2)", p.errors["image_file"] ensure I18n.locale = "en" end @@ -30,5 +36,8 @@ class I18nMessagesTest < Test::Unit::TestCase p = PhotoCustomError.new(:image_file => files(:not_a_photo)) p.save assert_equal "seems to be broken", p.errors["image_file"] + p = PhotoCustomError.new(:image_file => files(:i1x1)) + p.save + assert_equal "must be bigger (min. size: 2x2)", p.errors["image_file"] end end test/unit/i18n_messages_test.rb 3e2e2af89c25082c4808919b19efe662ad35e492 Martin Vielsmaier martin.vielsmaier@gmail.com http://github.com/Squeegy/fleximage/commit/602660bfadfa475ae55d4835a224458e70d29c5b 602660bfadfa475ae55d4835a224458e70d29c5b

2009-03-17T07:30:56-07:00

Added minimum_image_size model class accessor + validation logic Added image_too_small_message model class accessor 8072b945427858e54346a4b3dd1e81cfc82f1c95 Martin Vielsmaier martin.vielsmaier@gmail.com