has_media 0.2.5 → 0.2.6

data/README.rdoc

@@ -90,6 +90,9 @@ Configuration take place in config/initializers/has_media.rb
     require uploader
   end
 
+  # Change CarrierWave root path
+  CarrierWave.root = HasMedia.directory_path
+
 == Routes
 
 Add routes for media in your config/routes.rb

data/VERSION

@@ -1 +1 @@
-0.2.5
+0.2.6

data/app/helpers/has_media_helper.rb

@@ -1,5 +1,15 @@
 module HasMediaHelper
 
+  ## 
+  # Generate a unique uid used in forms
+  #
+  # @param [Hash]   available keys :
+  #   - context: the context to link medium
+  #   - object : the medium related object
+  #   - medium : the medium object
+  #
+  # @return [String]
+  #
   def generate_uid(*opts)
     opts = opts.first
     object = opts[:object]||nil
@@ -16,21 +26,61 @@ module HasMediaHelper
     end
   end
 
+  ##
+  # Create a link to add medium file field with ajax
+  #
+  # @params [Hash]    available keys :
+  #   - object : the meduim related object (mandatory)
+  #   - context: the context to link medium (mandatory)
+  #   - text: link test label (optional)
+  #
+  # @return [String]
+  #
   def add_medium_link(opts)
+    unless opts.keys.include?(:object) || 
+      opts.keys.include?(:context)
+      raise "Must give object and context" 
+    end
+    klass = opts[:object].class.to_s.underscore
+    opts[:text]||= I18n.t('add_link', 
+      :medium_label => I18n.t(opts[:context], :scope => [:activerecord, :attributes, klass]),
+      :scope => [:has_media, :form])
     link_to_function opts[:text] do |page| 
-      page.insert_html :bottom, generate_uid(:object => opts[:object], :context => opts[:context]), 
-        :partial => 'has_media/medium_field', 
-        :locals => {
-          :object => opts[:object], 
-          :context => opts[:context]
-        }
+      page.insert_html :bottom, generate_uid(
+        :object => opts[:object], 
+        :context => opts[:context]
+      ), 
+      :partial => 'has_media/medium_field', 
+      :locals => {
+        :object => opts[:object], 
+        :context => opts[:context]
+      }
     end 
   end
 
+  ##
+  # Create a remove medium link using Ajax
+  # Compatible with jQuery and Prototype
+  #
+  # @param [Hash]   available keys :
+  #   - medium : the medium to destroy
+  #   - text : link text label (optional)
+  #
+  # @return [String]
+  #
   def remove_medium_link(opts)
+    opts[:text] ||= I18n.t('remove_link', :scope => [:has_media, :form])
     link_to opts[:text], medium_url(opts[:medium]), :remote => true, :method => :delete
   end
 
+  ##
+  # Create a file field for a medium
+  #
+  # @param [Medium]   model, A medium object
+  # @param [String]   context, the context to link medium
+  #
+  # @return [String]
+  #
   def has_media_field(model, context)
     render :partial => "has_media/media_fields", :locals => {
       :object => model,

data/app/views/has_media/_media.html.erb

@@ -8,8 +8,7 @@
       <%= link_to medium.original_file_uri, medium.original_file_uri %>
 
       <%- if object.send(context).is_a?(Array) and !readonly %>
-        <%= remove_medium_link :text => "Remove", 
-          :object   => object, 
+        <%= remove_medium_link :object   => object, 
           :context  => context, 
           :medium   => medium %>
       <%- end %>

data/app/views/has_media/_media_fields.html.erb

@@ -14,9 +14,7 @@
 </div>
 <%- if object.send(context).is_a?(Array) %>
   <p>
-  <%= add_medium_link :text => "Add #{context}", 
-    :object => object, 
-    :context => context %>
+  <%= add_medium_link :object => object, :context => context %>
   </p>
 <%- end %>
 

data/app/views/has_media/_medium_field.html.erb

@@ -1,12 +1,14 @@
 <%- klass = object.class.to_s.underscore %>
 <%- if object.send(context).is_a?(Array) %>
   <p>
-    <%= label_tag "#{klass}[#{context}][]" %>
+    <%= label_tag "#{klass}[#{context}][]", 
+      t(context, :scope => [:activerecord, :attributes, klass]) %>
     <%= file_field_tag "#{klass}[#{context}][]" %>
   </p>
 <%- else %>
   <p>
-    <%= label_tag "#{klass}[#{context}]" %>
+    <%= label_tag "#{klass}[#{context}]",
+      t(context, :scope => [:activerecord, :attributes, klass]) %>
     <%= file_field_tag "#{klass}[#{context}]" %>
   </p>
 <%- end %>

data/app/views/has_media/destroy.js.erb

@@ -1 +1,5 @@
-$("#<%= generate_uid(:medium => @medium ) %>").remove();
+if (typeof jQuery == 'undefined') {  
+  $("<%= generate_uid(:medium => @medium ) %>").remove();
+} else {
+  $("#<%= generate_uid(:medium => @medium ) %>").remove();
+}

data/config/locales/en.yml

@@ -2,3 +2,6 @@ en:
   has_media:
     errors:
       type_error: "File type error"
+    form:
+      add_link: "Add %{medium_label}"
+      remove_link: "Remove"

data/has_media.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{has_media}
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["klacointe", "spk"]
-  s.date = %q{2010-11-23}
+  s.date = %q{2010-12-03}
   s.description = %q{Media Managment Library for ActiveRecord and Carrierwave}
   s.email = %q{kevinlacointe@gmail.com}
   s.extra_rdoc_files = [

data/lib/generators/templates/has_media.rb

@@ -24,3 +24,6 @@ HasMedia.directory_uri = "/media"
 Dir.glob(File.dirname(__FILE__) + '/../app/uploaders/*.rb').each do |uploader|
   require uploader
 end
+
+# Change CarrierWave root path
+CarrierWave.root = HasMedia.directory_path

data/lib/has_media.rb

@@ -24,30 +24,86 @@ module HasMedia
     :video => 'flv'
   }
 
+  ##
+  # medium_types
+  #
+  # Used to configure available medium types
+  #
+  # Each medium type id representing with its class name and contain an Array
+  # of possible mime types. An empty Array means no limitation on mime type
+  #
+  # Example : 
+  #  HasMedia.medium_types = {
+  #    "Image" => ["image/jpeg", "image/png"],
+  #    "Video" => ["video/mp4"],
+  #    "Audio" => ["audio/mp3"],
+  #    "Document" => []
+  #  }
+  #
   def self.medium_types=(value)
     @@medium_types = value
   end
   def self.medium_types
     @@medium_types
   end
+
+  ##
+  # encoded_extensions
+  #
+  # Used to configure output format if you use a custom encoder
+  #
+  # Example :
+  #  HasMedia.encoded_extensions = {
+  #    :image => 'png',
+  #    :audio => 'ogg',
+  #    :video => 'flv'
+  #  }
+  #
   def self.encoded_extensions=(value)
     @@encoded_extensions = value
   end
   def self.encoded_extensions
     @@encoded_extensions
   end
+
+  ##
+  # directory_path
+  #
+  # Used to configure directory_path to store media on filesystem
+  #
+  # Example :
+  #   HasMedia.directory_path = Rails.root + "media"
+  #
   def self.directory_path=(value)
     @@store_dir = value
   end
   def self.directory_path
     @@store_dir
   end
+
+  ##
+  # directory_uri
+  #
+  # Used to store www access to your media
+  #
+  # Example :
+  #   HasMedia.directory_path = Rails.root + "media"
+  #
   def self.directory_uri=(value)
     @@directory_uri = value
   end
   def self.directory_uri
     @@directory_uri
   end
+
+  ##
+  # errors_messages
+  #
+  # Used to store custom error messages
+  #
+  # Example :
+  #   HasMedia.errors_messages = {:type_error => "Le format du logo n'est pas correct"}
+  #
   def self.errors_messages
     @@errors_messages
   end
@@ -59,20 +115,54 @@ module HasMedia
     mod.extend ClassMethods
   end
 
+  ##
+  # Sanitize file name
+  # @param [String] name
+  # @return [String]
+  #
+  def self.sanitize_file_name(name)
+    name = name.gsub("\\", "/") # work-around for IE
+    name = File.basename(name)
+    name = name.gsub(/[^a-zA-Z0-9\.\-\+_]/,"_")
+    name = "_#{name}" if name =~ /\A\.+\z/
+    name = "unnamed" if name.size == 0
+    return name.downcase
+  end
+
+
   module ClassMethods
 
+    ##
+    # has_one_medium 
+    # Define a class method to link to a medium
+    #
+    # @param [String] context, the context (or accessor) to link medium
+    # @param [Hash]   options, can be one of : encode, only
+    #
     def has_one_medium(context, options = {})
       set_relations(context, :has_one)
       set_general_methods
       create_one_accessors(context, options)
     end
 
+    ##
+    # has_many_media
+    # Define a class method to link to several media
+    #
+    # @param [String] context, the context (or accessor) to link media
+    # @param [Hash]   options, can be one of : encode, only
+    #
     def has_many_media(context, options = {})
       set_relations(context, :has_many)
       set_general_methods
       create_many_accessors(context, options)
     end
 
+    ##
+    # set_general_methods
+    # Add generic methods for has_one_medium and has_many_media
+    # Including media_links relation, accessors, callbacks, validation ...
+    #
     def set_general_methods
       @methods_present ||= false
       unless @methods_present
@@ -84,6 +174,14 @@ module HasMedia
       @methods_present = true
     end
 
+    ##
+    # set_relations
+    # add relation on medium if not exists
+    # Also check if a class has a duplicate context
+    #
+    # @param [String] context
+    # @param [String] relation type, one of :has_many, :has_one
+    #
     def set_relations(context, relation)
       @contexts ||= {}
       @contexts[relation] ||= []
@@ -98,13 +196,30 @@ module HasMedia
       @media_relation_set << self
     end
 
+    ##
+    # set_callbacks
+    # Add callbacks to :
+    #   - merge medium errors to class related errors
+    #   - destroy medium
+    #
     def set_callbacks
       validate :merge_media_errors
       before_save :remove_old_media
     end
+
+    ##
+    # set_attributes
+    # Add media_errors attributes to store medium errors
+    #
     def set_attributes
       attr_accessor :media_errors
     end
+
+    ##
+    # set_validate_methods
+    # Define merge_media_errors to merge medium errors with errors given
+    # on master object.
+    #
     def set_validate_methods
       module_eval <<-"end;", __FILE__, __LINE__
         def merge_media_errors
@@ -115,15 +230,22 @@ module HasMedia
         end
       end;
     end
-
+    
+    ##
+    # set_media_links_relation
+    # Declare media_links relation 
     def set_media_links_relation
       has_many :media_links, :as => :mediated, :dependent => :destroy
     end
 
+    ##
+    # create_one_accessors
+    # Create needed accessors on master object for unique relation
+    #
+    # @param [String] context
+    # @param [Hash]   options
+    #
     def create_one_accessors(context, options)
-      #check_conditions = ''
-      #check_conditions << "return unless medium.is_a? #{options[:only].to_s.capitalize}" if options.has_key? :only
-
       define_method(context) do
         media.with_context(context.to_sym).first
       end
@@ -141,10 +263,14 @@ module HasMedia
       end;
     end
 
+    ##
+    # create_many_accessors
+    # Create needed accessors on master object for multiple relation
+    #
+    # @param [String] context
+    # @param [Hash]   options
+    #
     def create_many_accessors(context, options)
-      #check_conditions = ''
-      #check_conditions << "return unless medium.is_a? #{options[:only].to_s.capitalize}" if options.has_key? :only
-
       define_method(context.to_s.pluralize) do
         media.with_context(context.to_sym).uniq
       end
@@ -162,6 +288,9 @@ module HasMedia
     end
   end
 
+  ##
+  # Remove old media before saving
+  #
   def remove_old_media
     (@old_media || []).each do |medium|
       medium.destroy if medium
@@ -170,18 +299,22 @@ module HasMedia
 
 end
 
+# Include HasMedia in all ActiveRecord::Base Object
 class ActiveRecord::Base
   include HasMedia
 end
+# Include HasMediaHelper in all ActiveRecord::Base Object
 class ActionController::Base
   helper HasMediaHelper
 end
 
+# Require generic medium uploader
 require File.dirname(__FILE__) + '/has_media/uploaders/medium_uploader'
 Dir.glob(File.dirname(__FILE__) + '/has_media/uploaders/*.rb').each do |uploader|
   require uploader
 end
 
+# Require generic medium model
 require File.dirname(__FILE__) + '/has_media/models/medium'
 Dir.glob(File.dirname(__FILE__) + '/has_media/models/*.rb').each do |model|
   require model

data/lib/has_media/models/medium.rb

@@ -22,15 +22,6 @@ class Medium < ActiveRecord::Base
     { :conditions => { :context => context.to_s} }
   }
 
-  def self.sanitize(name)
-    name = name.gsub("\\", "/") # work-around for IE
-    name = File.basename(name)
-    name = name.gsub(/[^a-zA-Z0-9\.\-\+_]/,"_")
-    name = "_#{name}" if name =~ /\A\.+\z/
-    name = "unnamed" if name.size == 0
-    return name.downcase
-  end
-
   def self.new_from_value(object, value, context, encode, only)
     if value.respond_to?(:content_type)
       mime_type = value.content_type
@@ -51,9 +42,9 @@ class Medium < ActiveRecord::Base
     end
     medium = klass.new
     if value.respond_to?(:original_filename)
-      medium.filename = self.sanitize(value.original_filename)
+      medium.filename = HasMedia.sanitize_file_name(value.original_filename)
     else
-      medium.filename = self.sanitize(File.basename(value.path))
+      medium.filename = HasMedia.sanitize_file_name(File.basename(value.path))
     end
     medium.file = value
     medium.content_type = mime_type
@@ -116,6 +107,13 @@ class Medium < ActiveRecord::Base
     File.join(directory_uri, encoded_file_name(version))
   end
 
+  ##
+  # encoded_file_name
+  # Return the encoded file name for a medium
+  # This use the HasMedia.encoded_extensions configuration
+  # 
+  # @param [String] version, the string identifier for a specific encoded version
+  # FIXME duplicate with HasMedia::sanitize_file_name
   def encoded_file_name(version = nil)
     # remove original extension and add the encoded extension
     final_name = filename.gsub(/\.[^.]{1,4}$/, "") + '.' + file_extension
@@ -130,10 +128,25 @@ class Medium < ActiveRecord::Base
               self.id.to_s)
   end
 
+  ##
+  # file_exists?
+  # Is the medium for the current format exists
+  #
+  # @param [String] version to test
+  #
+  # @return [Boolean]
+  #
   def file_exists?(thumbnail = nil)
     File.exist?(File.join(Rails.root, 'public', file_uri(thumbnail)))
   end
 
+  ##
+  # file_extension
+  # Return the file extension for the current medium type
+  # This use the HasMedia.encoded_extensions configuration
+  #
+  # @return [String]
+  #
   def file_extension
     sym = type.underscore.to_sym
     unless HasMedia.encoded_extensions.keys.include?(sym)
@@ -145,14 +158,15 @@ class Medium < ActiveRecord::Base
 private
 
   ##
+  # set_default_encoding_status
   # Set encode_status value to notify the encoder of a new file
   def set_default_encoding_status
     self.encode_status = ENCODE_NOT_READY if filename_changed?
   end
 
   ##
+  # remove_file_from_fs
   # Unlink the folder containing the files
-  # TODO : remove all files, not only the original one
   def remove_file_from_fs
     require 'fileutils'
     FileUtils.rm_rf(self.directory_path)

data/spec/has_media_spec.rb

@@ -34,7 +34,7 @@ describe "HasMedia" do
     }
   end
 
-  describe "fonctionalities" do
+  describe "basic fonctionalities" do
 
     before :each do
       @medium = MediumRelatedTest.new
@@ -202,9 +202,73 @@ describe "HasMedia" do
       @medium.save.should be_false
       @medium.errors.full_messages.include?(HasMedia.errors_messages[:type_error])
     end
+
+    it "should sanitize filename" do
+      @pdf = stub_temp_file('Conversational_Capital _Explained.pdf', 'application/pdf')
+      @medium = MediumRelatedTest.new
+      @medium.pdf = @pdf
+      @medium.save
+      @medium.pdf.filename.should == "conversational_capital__explained.pdf"
+      @medium.pdf.original_file_uri.should == "/media/pdf/#{@medium.pdf.id}/conversational_capital__explained.pdf"
+    end
   end
 
   describe "Configuration" do
+
+    it "should configure medium_types" do
+      old_conf = HasMedia.medium_types
+      HasMedia.medium_types = {
+        "Image" => ["image/jpeg"]
+      }
+      HasMedia.medium_types.should == {
+        "Image" => ["image/jpeg"]
+      }
+      HasMedia.medium_types = old_conf
+    end
+
+    it "should configure encoded_extensions" do
+      old_conf = HasMedia.encoded_extensions
+      HasMedia.encoded_extensions = {
+        :image => "png"
+      }
+      HasMedia.encoded_extensions.should == {
+        :image => "png"
+      }
+      HasMedia.encoded_extensions = old_conf
+    end
+
+    it "should configure directory_path" do
+      old_conf = HasMedia.directory_path
+      HasMedia.directory_path = "/tmp"
+      HasMedia.directory_path.should == "/tmp"
+      HasMedia.directory_path = old_conf
+    end
+
+    it "should configure directory_uri" do
+      old_uri = HasMedia.directory_uri
+      HasMedia.directory_uri = "/tmp"
+      HasMedia.directory_uri.should == "/tmp"
+      HasMedia.directory_uri = old_uri
+    end
+
+    it "should configure/merge errors_messages" do
+      old_conf = HasMedia.errors_messages
+      HasMedia.errors_messages = {
+        :type_error => "wtf?"
+      }
+      HasMedia.errors_messages.should == {
+        :type_error => "wtf?"
+      }
+      HasMedia.errors_messages = {
+        :another_error => "warning!"
+      }
+      HasMedia.errors_messages.should == {
+        :type_error => "wtf?",
+        :another_error => "warning!"
+      }
+      HasMedia.errors_messages = old_conf
+    end
+
     it "should check allowed medium types if no :only option given" do
       HasMedia.medium_types = {
         "Image" => ["image/jpeg"],

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_media
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - klacointe
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-23 00:00:00 +01:00
+date: 2010-12-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency