sga_paperclippolymorph 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 tim.teng
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= sga_paperclippolymorph
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 tim.teng. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sga_paperclippolymorph"
+    gem.summary = %Q{gem version of paperclippolymorph for sga company}
+    gem.description = %Q{gem version of paperclippolymorph for sga company}
+    gem.email = "tim.rubist@gmail.com"
+    gem.homepage = "http://github.com/tteng/sga_paperclippolymorph"
+    gem.authors = ["tim.teng"]
+    #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_runtime_dependency "paperclip", ">= 2.3.1.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sga_paperclippolymorph #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/generators/polymorphic_paperclip/USAGE

@@ -0,0 +1,8 @@
+Description:
+    This generator creates the migrations needed to use polymorphic paperclip
+
+Example:
+    ./script/generate polymorphic_paperclip
+
+    This will create:
+      - A migration, which adds an assets and attachings table.

data/generators/polymorphic_paperclip/polymorphic_paperclip_generator.rb

@@ -0,0 +1,52 @@
+class PolymorphicPaperclipGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+  end
+  
+  def manifest
+    recorded_session = record do |m|
+     
+      unless has_rspec?
+        puts " All test for PolymorphicPaperclip are written in rSpec."
+        puts " Consider installing rSpec and the rSpec on rails plugin."
+      end
+     
+      unless options[:skip_migration]
+        m.migration_template 'migration.rb', 'db/migrate', 
+         :assigns => { :migration_name => "PolymorphicPaperclipMigration" },
+         :migration_file_name => "polymorphic_paperclip_migration"
+      end
+    end
+    
+    action = nil
+    action = $0.split("/")[1]
+    case action
+      when "generate" 
+        puts
+        puts ("-" * 70)
+        puts "Success!"
+        puts
+        puts "Dont't Forget to:"
+        puts "  - Add the acts_as_polymorphic_paperclip to the model that accepts assets"
+        puts " You will no longer need the has_attached_file argument in your model once you"
+        puts " add this plugin."
+        puts
+        unless options[:skip_migration]
+        puts "  - Run the migration."
+        puts "      rake db:migrate"
+        end
+        puts
+        puts
+        puts ("-" * 70)
+        puts
+      else
+        puts
+    end
+
+    recorded_session  end
+  
+  def has_rspec?
+    options[:rspec] || (File.exist?('spec') && File.directory?('spec'))
+  end
+  
+end

data/generators/polymorphic_paperclip/templates/migration.rb

@@ -0,0 +1,28 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table "assets" do |t|
+      t.string   "data_file_name"
+      t.string   "data_content_type"
+      t.integer  "data_file_size"
+      t.integer  "attachings_count", :default => 0
+      t.datetime "created_at"
+      t.datetime "data_updated_at"
+    end
+    
+    create_table "attachings" do |t|
+      t.integer  "attachable_id"
+      t.integer  "asset_id"
+      t.string   "attachable_type"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+    end
+    
+    add_index "attachings", ["asset_id"], :name => "index_attachings_on_asset_id"
+    add_index "attachings", ["attachable_id"], :name => "index_attachings_on_attachable_id"
+  end
+  
+  def self.down
+    drop_table :assets
+    drop_table :attachings
+  end
+end

data/lib/sga/acts_as_polymorphic_paperclip.rb

@@ -0,0 +1,113 @@
+module LocusFocus
+  module Acts #:nodoc: all
+    module PolymorphicPaperclip
+      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_polymorphic_paperclip(options = {})
+          write_inheritable_attribute(:acts_as_polymorphic_paperclip_options, {
+            :counter_cache => options[:counter_cache],
+            :styles => options[:styles]
+          })
+          class_inheritable_reader :acts_as_polymorphic_paperclip_options
+
+          has_many :attachings, :as => :attachable, :dependent => :destroy
+          has_many :assets, :through => :attachings do
+            def attach(asset_id)
+              asset_id = extract_id(asset_id)
+              asset = Asset.find(asset_id)
+              @owner.assets << asset
+              @owner.assets(true)
+            end
+            
+            def detach(asset_id, delete_if_no_attachings = false)
+              asset_id = extract_id(asset_id)
+              attaching = @owner.attachings.find(:first, :conditions => ['asset_id = ?', asset_id])
+              attachable = attaching.attachable
+              raise ActiveRecord::RecordNotFound unless attaching
+              result = attaching.destroy
+              
+              asset = Asset.find(asset_id)
+              if asset.attachings.empty? && delete_if_no_attachings# delete if no longer attached to anything
+                override_default_styles, normalised_styles = attachable.override_default_styles?(asset.name)
+                asset.data.instance_variable_set("@styles", normalised_styles) if override_default_styles
+                asset.data.send(:queue_existing_for_delete)
+                asset.data.send(:flush_deletes)
+                asset.save # needed to permanently remove file name and urls 
+              end
+              result
+            end
+            
+            protected
+            def extract_id(obj)
+              return obj.id unless obj.class == Fixnum || obj.class == String
+              obj.to_i if obj.to_i > 0
+            end
+          end
+
+          # Virtual attribute for the ActionController::UploadedStringIO
+          # which consists of these attributes "content_type", "original_filename" & "original_path"
+          # content_type: image/png
+          # original_filename: 64x16.png
+          # original_path: 64x16.png
+          attr_accessor :data
+            
+          include LocusFocus::Acts::PolymorphicPaperclip::InstanceMethods
+        end
+      end
+      module InstanceMethods
+        def after_save
+          super
+          Asset.transaction do
+            if data.is_a?(Array)
+              data.each do |data_item|
+                create_and_save_asset(data_item) unless data_item.nil? || data_item.blank?
+              end
+            else
+              create_and_save_asset(data)
+            end
+          end unless data.nil? || data.blank?
+        end
+        
+        def create_and_save_asset(data_item)
+          the_asset = Asset.find_or_initialize_by_data_file_name(data_item.original_filename)
+          override_default_styles, normalised_styles = override_default_styles?(data_item.original_filename)
+          the_asset.data.instance_variable_set("@styles", normalised_styles) if override_default_styles
+          the_asset.data = data_item
+          if the_asset.save
+  
+            # This association may be saved more than once within the same request / response 
+            # cycle, which leads to needless DB calls. Now we'll clear out the data attribute
+            # once the record is successfully saved any subsequent calls will be ignored.
+            data_item = nil
+            Attaching.find_or_create_by_asset_id_and_attachable_type_and_attachable_id(:asset_id => the_asset.id, :attachable_type => self.class.to_s, :attachable_id => self.id)
+            assets(true) # implicit reloading
+          end
+        end
+        def override_default_styles?(filename)
+          if !acts_as_polymorphic_paperclip_options[:styles].nil?
+            normalised_styles = {}
+            acts_as_polymorphic_paperclip_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
+      end
+    end
+  end
+end

data/lib/sga/asset.rb

@@ -0,0 +1,67 @@
+gem 'paperclip', ">=2.3.1.1"
+require 'paperclip'
+require 'digest/md5'
+
+class Asset < ActiveRecord::Base
+  has_many :attachings, :dependent => :destroy
+
+  has_attached_file :data,
+                    :styles => {
+                                 :tiny => "64x64>",
+                                 :small => "176x112>",
+                                 :medium => "630x630>",
+                                 :large => "1024x1024>"
+                               } 
+
+  def url(*args)
+    data.url(*args)
+  end
+  
+  def name
+    data_file_name
+  end
+  
+  def content_type
+    data_content_type
+  end
+  
+  def browser_safe?
+    %w(jpg gif png).include?(url.split('.').last.sub(/\?.+/, "").downcase)
+  end
+  alias_method :web_safe?, :browser_safe?
+  
+  # This method will replace one of the existing thumbnails with an file provided.
+  def replace_style(style, file)
+    style = style.downcase.to_sym
+    if data.styles.keys.include?(style)
+      if File.exist?(RAILS_ROOT + '/public' + a.data(style))
+      end
+    end
+  end
+  
+  # This method assumes you have images that corespond to the filetypes.
+  # For example "image/png" becomes "image-png.png"
+  def icon
+    "#{data_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
+
+  def path
+    File.join RAILS_ROOT, 'public', self.url_without_random
+  end
+
+  def file_md5sum
+    #path = File.join RAILS_ROOT, 'public', self.url_without_random
+    IO.popen("md5sum #{path} | awk '{print $1}'"){|f| f.gets.strip}       
+  end
+
+  def url_without_random format=:original
+    self.url(format) =~ /^(.*)\?\d*$/ ? $1 : self.url(format)
+  end
+
+end

data/lib/sga/attaching.rb

@@ -0,0 +1,16 @@
+class Attaching < ActiveRecord::Base
+  belongs_to :asset, :counter_cache => true
+  belongs_to :attachable, :polymorphic => true
+  
+  def after_create
+    if self.attachable.acts_as_polymorphic_paperclip_options[:counter_cache]
+      self.attachable.class.increment_counter(:assets_count, self.attachable.id)
+    end
+  end
+  
+  def after_destroy
+    if self.attachable.acts_as_polymorphic_paperclip_options[:counter_cache]
+      self.attachable.class.decrement_counter(:assets_count, self.attachable.id)
+    end
+  end
+end

data/lib/sga_paperclippolymorph.rb

@@ -0,0 +1,4 @@
+require 'sga/acts_as_polymorphic_paperclip'
+ActiveRecord::Base.send(:include, LocusFocus::Acts::PolymorphicPaperclip)
+require 'sga/asset'
+require 'sga/attaching'

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sga_paperclippolymorph'
+
+class Test::Unit::TestCase
+end

data/test/test_sga_paperclippolymorph.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSgaPaperclippolymorph < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: sga_paperclippolymorph
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- tim.teng
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-07 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: paperclip
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 1
+        - 1
+        version: 2.3.1.1
+  type: :runtime
+  version_requirements: *id001
+description: gem version of paperclippolymorph for sga company
+email: tim.rubist@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- generators/polymorphic_paperclip/USAGE
+- generators/polymorphic_paperclip/polymorphic_paperclip_generator.rb
+- generators/polymorphic_paperclip/templates/migration.rb
+- lib/sga/acts_as_polymorphic_paperclip.rb
+- lib/sga/asset.rb
+- lib/sga/attaching.rb
+- lib/sga_paperclippolymorph.rb
+- test/helper.rb
+- test/test_sga_paperclippolymorph.rb
+has_rdoc: true
+homepage: http://github.com/tteng/sga_paperclippolymorph
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: gem version of paperclippolymorph for sga company
+test_files: 
+- test/test_sga_paperclippolymorph.rb
+- test/helper.rb