PaperclipAttachmentRemover 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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,42 @@
+= PaperclipAttachmentRemover
+
+This plugin used for delete attachment created by paperclip.
+It provides two methods for this:
+
++attachment_remover_observe+::
+used for to point out that attachment attributes needs to be observed for removing. You can point out multiple attributes with paperclip attachment
+
++attachment_remover_name_for+::
+used for getting correct form field name (usually checkbox) that should trigger attachment removing
+
+== Installation
+
+  sudo gem install paperclip_attachment_remover
+
+== Usage
+
+In your model:
+
+  SomeThing << ActiveRecord::Base
+
+    has_attachment :icon
+  
+    attachment_remover_observe :icon
+  
+  end
+
+In your update form:
+
+  form_for @something do |f|
+    
+    f.label :icon, 'Icon picture'
+    f.file_field :icon
+    
+    f.label attachment_remover_name_for(:icon), 'Remove existing icon picture'
+    f.check_box attachment_remover_name_for(:icon)
+    
+  end
+
+
+
+Copyright (c) 2010 v.valgis, released under the MIT license

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the paperclip_attachment_remover plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the paperclip_attachment_remover plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PaperclipAttachmentRemover'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/init.rb

@@ -0,0 +1,2 @@
+require 'paperclip_attachment_remover'
+ActiveRecord::Base.send(:include, PaperclipAttachmentRemover)

data/lib/paperclip_attachment_remover.rb

@@ -0,0 +1,51 @@
+module PaperclipAttachmentRemover #:nodoc:
+  
+  def self.included(base) #:nodoc:
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    # list of attributes for observing by remover
+    attr_reader :attributes_for_removal_observation
+    
+    # prefix for remover attribute
+    attr_reader :remove_name_prefix
+    
+    # Set list of attributes for observing by remover
+    def attachment_remover_observe *attribute_names
+      send :include, InstanceMethods
+
+      options = attribute_names.extract_options!
+      @remove_name_prefix = options.fetch(:remove_name_prefix, 'remove')
+      
+      existing_columns = column_names.select { |cn| cn.match('_file_name')  }
+      attribute_names.map{|a| "#{a}_file_name"}.each do |attribute_name|
+        raise ActiveRecord::UnknownAttributeError unless existing_columns.include? attribute_name
+      end
+      
+      attr_accessor *(attribute_names.map { |an| "#{@remove_name_prefix}_#{an}".to_sym })
+      before_save :paperclip_attachment_remover_proceed
+      
+      @attributes_for_removal_observation = attribute_names
+    end
+  end
+
+  module InstanceMethods
+    # return name of form field that trigger deletion of attachment
+    def attachment_remover_name_for attribute
+      "#{self.class.remove_name_prefix}_#{attribute}"
+    end
+    
+    private
+
+      def paperclip_attachment_remover_proceed #:nodoc:
+        unless self.class.attributes_for_removal_observation.empty?
+          self.class.attributes_for_removal_observation.each do |attribute|
+            self.send("#{attribute}=", nil) if self.send("#{self.class.remove_name_prefix}_#{attribute}") == "1" && !self.send(attribute).dirty? 
+          end
+        end
+        true
+      end
+    
+  end
+end

data/test/paperclip_attachment_remover_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+require File.expand_path(File.dirname(__FILE__) +  '/../init')
+
+# stub for paperclip
+class Attachment
+  attr_accessor :dirty
+  def dirty?; @dirty; end 
+end
+
+class ExampleModelWithAttachment < ActiveRecord::Base
+  attr_accessor :attachment
+  attachment_remover_observe :attachment
+end
+
+class PaperclipAttachmentRemoverTest < Test::Unit::TestCase
+  
+  def setup
+    a = Attachment.new
+    a.dirty = true
+    @emwa = ExampleModelWithAttachment.new(:attachment_file_name => 'test.txt', :attachment => a)
+  end
+  
+  def test_return_remover_field_name
+    assert_equal 'remove_attachment', @emwa.attachment_remover_name_for(:attachment)
+    assert_equal 'remove_attachment', @emwa.attachment_remover_name_for('attachment')
+    assert_not_equal 'remove_attachment', @emwa.attachment_remover_name_for('rose')
+  end
+  
+  def test_return_remover_field_name_with_prefix_option
+    @emwa.class.send(:attachment_remover_observe, :attachment, :remove_name_prefix => :delete)
+    assert_equal 'delete_attachment', @emwa.attachment_remover_name_for(:attachment)
+  end
+  
+  def test_setting_attribute_to_list_for_observation
+    assert @emwa.class.attributes_for_removal_observation.include?(:attachment)
+  end
+  
+  def test_removing_attachment_when_remover_field_set_to_1_and_attachment_is_not_new
+    check false
+  end
+  
+  def test_removing_attachment_when_remover_field_set_to_1_and_attachment_is_new
+    check true
+  end
+  
+  def check(dirtyness)
+    @emwa.attachment.dirty = dirtyness
+    assert_not_nil @emwa.attachment
+    @emwa.update_attributes({:remove_attachment => "1"})
+    if dirtyness
+      assert_not_nil @emwa.attachment
+    else
+      assert_nil @emwa.attachment
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+
+
+ActiveRecord::Base.establish_connection({
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+})
+
+ActiveRecord::Schema.define do
+  create_table "example_model_with_attachments", :force => true do |t|
+    t.string :attachment_file_name
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: PaperclipAttachmentRemover
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- v.valgis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-20 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: vladimir.valgis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- MIT-LICENSE
+- Rakefile
+- init.rb
+- lib/paperclip_attachment_remover.rb
+- test/paperclip_attachment_remover_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/vvalgis/paperclip_attachment_remover
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: Plugin that observe attachments and delete them when you trigger deletion by checking box in update form
+test_files: 
+- test/paperclip_attachment_remover_test.rb