has_images 0.1.94 → 0.2

data/README.md

@@ -49,20 +49,52 @@ add the following to your config/enviroment.rb
   
 ## Examples & usage
 
-### Create image by URL
+### Imageupload via form
+  
+  in your view (uses [formtastic](http://github.com/justinfrench/formtastic))
+  
+    -semantic_form_for @image, :html => { :multipart => true } do |f|
+      -f.inputs do
+        =f.input :gallery_id, :as => :select, :collection => parent.galleries.all(:order=>'name')
+  	    =f.input :gallery_name
+        =f.input :name
+        =f.input :text  
+        =f.file_field :file, :input_html => { :size => 22 }
+      =f.buttons
+  
+  in your controller:
     
-    image = user.create_image_by_url("http://image.url/file.png")
-
-### Images with galleries
+    class ImagesController
     
-    gallery = user.galleries.create(:name => "gallery name")
+      def new 
+        @image = User.first.images.new
+      end
+      
+      def create
+        .....
+        @image = User.first.images.create(params[:image])
+        
+        .....
+      end
     
-    gallery.images.create(params[:image])
-    gallery.create_image_by_url("http://image.url/file.png")
+    end  
   
-### Imageupload via form
 
-### enabling Counter-Cache (since version 0.1.7)
+### Create image by URL
+  has_images supports an easy method to create images from URLs:
+  
+    user  = User.first
+    image = user.create_image_by_url("http://image.url/file.png")
+    
+  Of course you can also create the image manually with more arguments
+  
+  	user = User.first
+  	user.images.create(:file_url => "http://image.url/file.png", :name => "my image")
+
+  
+
+
+### enabling Counter-Cache
 
     class User < ActiveRecord::Base  
       has_images :styles => {
@@ -75,6 +107,54 @@ add the following to your config/enviroment.rb
     
     This enables the counter_cache for the user-model. CounterCache is saved in the field "images_count"
 
+## Galleries
+  
+  has_images also supports image galleries to group images
+    
+### Images with galleries
+    
+    gallery = user.galleries.create(:name => "gallery name")
+    
+    gallery.images.create(params[:image])
+    gallery.create_image_by_url("http://image.url/file.png")
+    
+### Create image gallery on the fly
+  
+  You can also create image galleries on the fly with the attr_accessor gallery_name:
+   
+	user  = User.find(1)
+    image = user.images.create(:name => 'my cool image', :file_url => "http://image.url/image.jpg", :gallery_name => "my images")
+
+## Image Types
+
+  Sometimes you also have to group your images by specific image types. For example you could use the types "logo", "screenshot" and "banner" 
+  
+###  creating image types:
+  
+  You can easily create ImageType like this:
+  
+    Digineo::ImageType.create(:name => 'logo')
+    Digineo::ImageType.create(:name => 'screenshot')
+    Digineo::ImageType.create(:name => 'banner')
+    
+  another possibility is to create image types on the fly like this
+  
+    user = User.first
+    user.images.create(:name => 'my cool image', :file_url => "http://image.url/image.jpg", :image_type_name => 'logo')
+  
+  in this case the ImageType "logo" will eiter be created or the id of an existing ImageType will be set
+
+###  finding images of a specific type
+
+    user = User.first    
+    logos = user.images.image_type('logo')
+    
+  invalid image types will raise an Digineo::ImageType::Exception
+  
+    user = User.first
+    invalid = user.images.image_type('invalid image type') 
+      => Digineo::ImageType::Exception: Could not find ImageType with name invalid image type
+      
 
 Copyright (c) 2010 Dennis Meise [Digineo GmbH](http://www.digineo.de/ "Digineo GmbH") , released under the MIT license
 

data/lib/digineo/image.rb

@@ -8,64 +8,80 @@ class Digineo::Image < ActiveRecord::Base
   belongs_to :image_type, :class_name => "Digineo::ImageType"  
   attr_accessor :file_url
   attr_accessor :gallery_name
-
+  attr_accessor :image_type_name
+  
   before_create :should_be_avatar?
   before_destroy :unset_avatar if :avatar
   
   named_scope :not_avatar, :conditions => "avatar=0"
   named_scope :without_gallery, :conditions => "gallery_id IS NULL"
   
-  has_attached_file :file
-  
-  after_save :set_gallery
-  
   
-  validates_attachment_presence :file, :unless => :file_url_provided?, :on => :create
-  validates_presence_of :parentmodel
-  before_validation :download_remote_file, :if => :file_url_provided?
- 
-  validates_presence_of :file_remote_url, :if => :file_url_provided?, :message => 'is invalid or inaccessible'
-  
-  def set_avatar
-    parentmodel.avatar.unset_avatar if parentmodel.avatar
-    update_attribute(:avatar, true)
+  named_scope :image_type, lambda { |*types|
+    { :conditions => "image_type_id IN (" + types.collect do |type|
+        begin
+          Digineo::ImageType.find_by_name(type).id 
+        rescue 
+          raise Digineo::ImageType::Exception, "Could not find ImageType with name #{type}"
+        end
+        end.compact.join(",") + ")"}
+    }
+    
+    has_attached_file :file
+    
+    after_save :set_gallery, :set_image_type
+    
+    
+    validates_attachment_presence :file, :unless => :file_url_provided?, :on => :create
+    validates_presence_of :parentmodel
+    before_validation :download_remote_file, :if => :file_url_provided?
+    
+    validates_presence_of :file_remote_url, :if => :file_url_provided?, :message => 'is invalid or inaccessible'
+    
+    # sets the avatar flag on this image
+    def set_avatar
+      parentmodel.avatar.unset_avatar if parentmodel.avatar
+      update_attribute(:avatar, true)
+    end
+    
+    # removes avatar flag
+    def unset_avatar
+      update_attribute(:avatar, false)
+    end
+    
+    def set_gallery    
+      return if gallery_id or gallery_name.to_s.empty?
+      self.gallery_id = parentmodel.find_or_create_gallery(gallery_name).id
+      save
+    end
+    
+    def set_image_type    
+      return if image_type_id or image_type_name.to_s.empty?
+      self.image_type_id = ImageType.find_or_create_by_name(image_type_name).id
+      save
+    end
+    
+    private
+    
+    def should_be_avatar?
+      self.avatar = !parentmodel.avatar
+      true # returns true because it's called by before_create
+    end
+    
+    def file_url_provided?
+      !self.file_url.blank?
+    end
+    
+    def download_remote_file
+      self.file = do_download_remote_file
+      self.file_remote_url = file_url
+    end
+    
+    def do_download_remote_file
+      io = open(URI.parse(file_url))
+      def io.original_filename; base_uri.path.split('/').last; end
+      io.original_filename.blank? ? nil : io
+    rescue # TODO catch url errors with validations instead of exceptions (Errno::ENOENT, OpenURI::HTTPError, etc...)
+    end
+    
   end
-  
-  def unset_avatar
-    update_attribute(:avatar, false)
-  end
-  
-  def set_gallery    
-    return if gallery_id or gallery_name.to_s.empty?
-    self.gallery_id = parentmodel.find_or_create_gallery(gallery_name).id
-    save
-  end
-  
-  private
-  
-  def should_be_avatar?
-    self.avatar = !parentmodel.avatar
-    true # returns true because it's called by before_create
-  end
-  
-  def file_url_provided?
-    !self.file_url.blank?
-  end
-
-  def file_url_provided?
-    !self.file_url.blank?
-  end
- 
-  def download_remote_file
-    self.file = do_download_remote_file
-    self.file_remote_url = file_url
-  end
- 
-  def do_download_remote_file
-    io = open(URI.parse(file_url))
-    def io.original_filename; base_uri.path.split('/').last; end
-    io.original_filename.blank? ? nil : io
-    rescue # catch url errors with validations instead of exceptions (Errno::ENOENT, OpenURI::HTTPError, etc...)
-  end
-  
-end

data/lib/digineo/image_type.rb

@@ -7,3 +7,8 @@ class Digineo::ImageType < ActiveRecord::Base
   validates_uniqueness_of :name
   
 end
+
+
+class Digineo::ImageType::Exception < Exception
+  
+end

data/lib/has_images.rb

@@ -8,7 +8,7 @@ module HasImages
   module ClassMethods
     # adds has_images to model
     def has_images(options={})
-      counter_cache = options.delete(:couter_cache) || false
+      counter_cache = options.delete(:counter_cache) || false
       # eval is not always evil ;)
       # we generate a Digineo::Model::Image clase to store the given paperclip configuration in it  
       eval <<-EOF
@@ -32,15 +32,17 @@ module HasImages
 
   module InstanceMethods
     
-     ## gibt alle Bilder zurück die nicht avatar sind
+    # returns all images that are not set as avatar
     def more_images
        images.not_avatar
     end
     
+    # returns all images without gallery
     def images_without_gallery
       images.without_gallery
     end
     
+    # does this model have any images,  that are not set as avatar?
     def has_more_images?
       images.not_avatar.any?
     end
@@ -53,6 +55,7 @@ module HasImages
       galleries.find_or_create_by_name(name)
     end
     
+    
     def create_image_by_url(url, image_type = nil)
       images.create!(:file_url => url, :image_type => image_type)
     end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: has_images
 version: !ruby/object:Gem::Version 
-  version: 0.1.94
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - Dennis Meise
@@ -9,19 +14,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-06 00:00:00 +02:00
+date: 2010-08-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: paperclip
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
         version: "2.3"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: github@digineo.de
 executables: []
@@ -43,6 +53,11 @@ files:
 - lib/digineo/image_type.rb
 - lib/digineo/image.rb
 - rails/init.rb
+- test/unit/digineo/image_gallery_test.rb
+- test/unit/digineo/image_type_test.rb
+- test/unit/digineo/image_test.rb
+- test/has_images_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/digineo/has_images
 licenses: []
@@ -54,21 +69,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: HasImages adds images and galleries to your ActiveRecord models.