paperclip_i18n 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source('http://rubygems.org')
+
+# Specify your gem's dependencies in paperclip_i18n.gemspec
+gemspec

data/README.md

@@ -0,0 +1,3 @@
+# Paperclip I18n
+
+Is an extension for the [thoughtbot paperclip](https://github.com/thoughtbot/paperclip) plugin to i18n support to file upload. For each language a separate file can be uploaded.

data/Rakefile

@@ -0,0 +1,2 @@
+require('bundler')
+Bundler::GemHelper.install_tasks

data/lib/paperclip_i18n/acts_as_attachment.rb

@@ -0,0 +1,64 @@
+module PaperclipI18n
+  module ActsAsAttachment
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Extends the model to afford the ability to associate other records with the receiving record.
+      #
+      # This module needs the paperclip plugin to work
+      # http://www.thoughtbot.com/projects/paperclip
+      def acts_as_attachment(options = {})
+        default_options = { :url => "/uploads/#{Rails.env}/assets/:id_partition/:basename.:style.:extension",
+                            :path => "#{Rails.root}/public/uploads/#{Rails.env}/assets/:id_partition/:basename.:style.:extension" }.merge(options)
+
+        has_attached_file(:upload, default_options)
+        belongs_to(:attachable, :polymorphic => true)
+        scope(:i18ns, lambda { where(:upload_language => ::I18n.locale) })
+        include(::PaperclipI18n::ActsAsAttachment::InstanceMethods)
+      end
+    end
+    
+    module InstanceMethods
+      def url(*args)
+        upload.url(*args)
+      end
+
+      def name
+        upload_file_name
+      end
+
+      def content_type
+        upload_content_type
+      end
+
+      def size
+        upload_file_size
+      end
+
+      def browser_safe?
+        %w(jpg gif png).include?(url.split('.').last.sub(/\?.+/, '').downcase)
+      end
+      alias_method(:web_safe?, :browser_safe?)
+
+      # This method assumes you have images that corespond to the filetypes.
+      # For example "image/png" becomes "image-png.png"
+      def icon
+        "#{upload_content_type.gsub(/[\/\.]/,'-')}.png"
+      end
+
+      def detach(attached)
+        a = attachings.find(:first, :conditions => ['attachable_id = ? AND attachable_type = ?', attached, attached.class.to_s])
+        raise(::ActiveRecord::RecordNotFound) unless a
+        a.destroy
+      end
+
+      # Rails doc says: Using polymorphic assocs with STI can be a little tricky
+      # --> read more @ http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html
+      def attachable_type=(sType)
+        super(sType.to_s.classify.constantize.base_class.to_s)
+      end
+    end
+  end
+end

data/lib/paperclip_i18n/generators/paperclip_i18n/USAGE

@@ -0,0 +1,18 @@
+Description:
+    This generator creates the migrations needed to use paperclip_i18n
+
+Requirements:
+    paperclip
+    authlogic (http://agilewebdevelopment.com/plugins/authgasm, with a working "UserSession" Model)
+    UserSession.current_lang: must return the current language identifier string
+
+Important:
+    Add "resources :assets, :only=>[:show]" to your routes.rb file and modify according to your needs.
+
+Example:
+    rails g paperclip_i18n
+
+    This will create:
+      - A migration, which adds an assets and attachings table.
+      - A controller (assets_controller.rb)
+      - A model (asset.rb)

data/lib/paperclip_i18n/generators/paperclip_i18n/paperclip_i18n_generator.rb

@@ -0,0 +1,19 @@
+class PaperclipI18nGenerator < Rails::Generators::Base
+  include(Rails::Generators::Migration)
+  source_root(File.expand_path('../templates', __FILE__))
+
+  # taken from: http://www.themodestrubyist.com/2010/03/16/rails-3-plugins---part-3---rake-tasks-generators-initializers-oh-my/
+  def self.next_migration_number(dirname)
+    if ::ActiveRecord::Base.timestamped_migrations
+      ::Time.now.utc.strftime('%Y%m%d%H%M%S')
+    else
+      '%.3d' % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_paperclip_i18n_migration
+    migration_template('migration.rb', 'db/migrate/paperclip_i18n_tables.rb')
+    copy_file('assets_controller.rb', 'app/controllers/assets_controller.rb')
+    copy_file('asset.rb', 'app/models/asset.rb')
+  end
+end

data/lib/paperclip_i18n/generators/paperclip_i18n/templates/asset.rb

@@ -0,0 +1,3 @@
+class Asset < ActiveRecord::Base
+  acts_as_attachment
+end

data/lib/paperclip_i18n/generators/paperclip_i18n/templates/assets_controller.rb

@@ -0,0 +1,7 @@
+class AssetsController < ApplicationController
+  def show
+    asset = ::Asset.find(params[:id])
+    # do security check here
+    send_file(asset.data.path, :type => asset.data_content_type)
+  end
+end

data/lib/paperclip_i18n/generators/paperclip_i18n/templates/migration.rb

@@ -0,0 +1,21 @@
+class PaperclipI18nTables < ActiveRecord::Migration
+  def self.up
+    create_table('assets') do |t|
+      t.string('attachable_type')
+      t.integer('attachable_id')
+      t.string('upload_file_name')
+      t.string('upload_content_type')
+      t.integer('upload_file_size')
+      t.string('upload_language', :limit => 6, :default => 'en')
+      t.datetime('created_at')
+      t.datetime('updated_at')
+      t.datetime('upload_updated_at')
+    end
+
+    add_index('assets', ['attachable_id', 'attachable_type'], :name => 'index_assets_on_attachable_id_and_type')
+  end
+
+  def self.down
+    drop_table(:assets)
+  end
+end

data/lib/paperclip_i18n/has_many_attached_files.rb

@@ -0,0 +1,81 @@
+module PaperclipI18n
+  module HasManyAttachedFiles
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Extends the model to afford the ability to associate other records with the receiving record.
+      #
+      # This module needs the paperclip plugin to work
+      # http://www.thoughtbot.com/projects/paperclip
+      def has_many_attached_files(options = {})
+        write_inheritable_attribute(:has_many_attached_files_options, { :counter_cache => options[:counter_cache], :styles => options[:styles] })
+        class_inheritable_reader(:has_many_attached_files_options)
+        
+        attr_accessor(:upload)
+        attr_accessor(:current_file_language)
+        after_save(:save_attached_files)
+        has_many(:assets, :as => :attachable, :dependent => :destroy)
+        include(::PaperclipI18n::HasManyAttachedFiles::InstanceMethods)
+      end
+    end
+    
+    module InstanceMethods
+      def save_attached_files
+        ::Asset.transaction do
+          if upload.is_a?(Array)
+            upload.each do |data_item|
+              create_or_update_asset(data_item) unless data_item.nil? || data_item.blank?
+            end
+          else
+            create_or_update_asset(upload)
+          end
+        end unless upload.nil? || upload.blank?
+      end
+
+      def create_or_update_asset(data_item)
+        override_default_styles, normalised_styles = override_default_styles?(data_item.original_filename)
+        asset = assets.where(:upload_language => current_language).first || Asset.new # is there an attachment, then delete the old
+        asset.upload.instance_variable_set('@styles', normalised_styles) if override_default_styles
+        asset.upload = data_item
+        asset.upload_language = current_language
+
+        if asset.new_record?
+          asset.save
+          assets << asset # store the asset ...
+        else
+          asset.save
+        end
+        assets(true) # reload implicitly
+      end
+
+      def override_default_styles?(filename)
+        if !has_many_attached_files_options[:styles].nil?
+          normalised_styles = {}
+          
+          has_many_attached_files_options[:styles].each do |name, args|
+            dimensions, format = [args, nil].flatten[0..1]
+            format = nil if format.blank?
+            
+            if filename.match(/\.pdf$/) # remove crop commands if file is a PDF (this fails with Imagemagick)
+              args.gsub!(/#/ , '')
+              format = 'png'
+            end
+            
+            normalised_styles[name] = { :processors => [:thumbnail], :geometry => dimensions, :format => format }
+          end
+          
+          return true, normalised_styles
+        else
+          return(false)
+        end
+      end
+      
+      # based on the Authlogic plugin (http://agilewebdevelopment.com/plugins/authgasm)
+      def current_language
+        @current_file_language || ::I18n.locale
+      end
+    end
+  end
+end

data/lib/paperclip_i18n/upload_file_validator.rb

@@ -0,0 +1,28 @@
+class UploadFileValidator < ActiveModel::EachValidator
+  DEFAULT_OPTIONS = { :content_type => nil,
+                      :less_then => nil,
+                      :presence => true,
+                      :skip_on_versioning => false }
+
+  def initialize(options)
+    super(options)
+    @options = DEFAULT_OPTIONS.merge(@options)
+  end
+
+  def validate_each(record, attribute, value)
+    return if options[:skip_on_versioning] && !record.record_timestamps # due to the versioning, which is copied through jbackend
+    less_then = options[:less_then]
+    content_type = options[:content_type]
+    return unless options[:presence]
+    record.errors[attribute] << 'must be provided' if options[:presence] and !asset_available?(record, value)
+    
+    if !value.nil?
+      record.errors[attribute] << "must be smaller then #{less_then}" if not less_then.nil? and value.size > less_then
+      record.errors[attribute] << "must be of a file valid type: #{content_type}" if not content_type.nil? and not value.content_type =~ content_type
+    end
+  end
+
+  def asset_available?(record, value)
+    !record.assets.i18ns.first.nil? || !value.nil?
+  end
+end

data/lib/paperclip_i18n/version.rb

@@ -0,0 +1,3 @@
+module PaperclipI18n
+  VERSION = '0.0.1'
+end

data/lib/paperclip_i18n.rb

@@ -0,0 +1,6 @@
+require('paperclip_i18n/has_many_attached_files')
+require('paperclip_i18n/acts_as_attachment')
+require('paperclip_i18n/upload_file_validator')
+
+ActiveRecord::Base.send(:include, ::PaperclipI18n::ActsAsAttachment)
+ActiveRecord::Base.send(:include, ::PaperclipI18n::HasManyAttachedFiles)

data/paperclip_i18n.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push(File.expand_path('../lib', __FILE__))
+require('paperclip_i18n/version')
+
+Gem::Specification.new do |s|
+  s.name        = 'paperclip_i18n'
+  s.version     = PaperclipI18n::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Rene Gross', 'Philipp Ullmann']
+  s.email       = ["rg@create.at", 'philipp.ullmann@create.at']
+  s.homepage    = ""
+  s.summary     = 'Adding I18n image upload support to paperclip plugin'
+  s.description = "This gem depends on the paperclip gem. A separate file can be uploaded for each language."
+
+  s.rubyforge_project = 'paperclip_i18n'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+  
+  s.add_dependency('paperclip', ['>= 2.3.8'])
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: paperclip_i18n
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rene Gross
+- Philipp Ullmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: paperclip
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id001
+description: This gem depends on the paperclip gem. A separate file can be uploaded for each language.
+email: 
+- rg@create.at
+- philipp.ullmann@create.at
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/paperclip_i18n.rb
+- lib/paperclip_i18n/acts_as_attachment.rb
+- lib/paperclip_i18n/generators/paperclip_i18n/USAGE
+- lib/paperclip_i18n/generators/paperclip_i18n/paperclip_i18n_generator.rb
+- lib/paperclip_i18n/generators/paperclip_i18n/templates/asset.rb
+- lib/paperclip_i18n/generators/paperclip_i18n/templates/assets_controller.rb
+- lib/paperclip_i18n/generators/paperclip_i18n/templates/migration.rb
+- lib/paperclip_i18n/has_many_attached_files.rb
+- lib/paperclip_i18n/upload_file_validator.rb
+- lib/paperclip_i18n/version.rb
+- paperclip_i18n.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: paperclip_i18n
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 3
+summary: Adding I18n image upload support to paperclip plugin
+test_files: []
+