paperclip-staging 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTlkZDYzOTkwYzFiMDU3YTdjZjRlZjhkZWQ0MjNhNGE4ODVlZTNhOA==
+  data.tar.gz: !binary |-
+    MGZiYTRiNzUxMTY2NGRjNzYzYjVlYjJhZTRhNWY4ZWVmZDRhOWY5NA==
+SHA512:
+  metadata.gz: !binary |-
+    MWVmOWE4Mjc4ZmY5MWM2YmE0YzJkYjY1NWM5ODM1ZjVjMDY5MzI4MjY1NWFj
+    NGI4NGM3YWFjYWVlODg0MmE2ZWM2NTQ5ZWNhZjQ3MDUxZjgzNmQwMTdhYjJi
+    ZDE0NjllYTRlNzk4OTQyZDI3MjA4ODdhNjNiMGQwYmU2ZjY1YjU=
+  data.tar.gz: !binary |-
+    MDQ3MjY4OTNiYWQzMmVkNDk5ZjI4ZjIwY2UwYWMxZTNjMTcyY2MwYTI1NTNk
+    MzNhMzk1YWM3OGI4ZjM3YjlmN2MxYzU0NjdiYmM2YWJkNjgzNzY2MzZlYWUx
+    MGNjN2Y4ZGM0YWFkMzlkZjgxNGQ2YzY0MGUwYWUwMmM0MTVjMDU=

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+/.ruby-*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paperclip-staging.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tomasz Dąbrowski
+
+MIT License
+
+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.md

@@ -0,0 +1,53 @@
+# Paperclip::Staging
+
+Allow [Paperclip](https://github.com/thoughtbot/paperclip) to pass attachments as data-uri on unsaved records. Useful when dealing with forms and validation errors.
+
+Imagine you have two fields on a model - `name` and `attachment`. Let's say that `name` has a validation. If you edit an object and change both `name` and `attachment`, but the new name doesn't meet the validation, then you lose the new `attachment`.
+
+With paperclip-staging, the attachment is preserved using a hidden field. It is also available with `staged_url(style_name)` (instead of regular `url(style_name)`) calls, using data-uri encoding - which is useful if you want to display current value for the attachment/image.
+
+You can check the [example project](https://github.com/dabroz/paperclip-staging-example).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'paperclip-staging'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paperclip-staging
+
+## Usage
+
+1. Add a new hidden field in the form, named `<attachment_name>_staging`.
+
+    `f.hidden_field :file_staging`
+    
+    or
+    
+    `f.input :file_staging, as: :hidden` for `simple_form`
+
+2. Add this field as a valid form param:
+
+    `attr_accessible :file_staging`
+
+    or
+
+    `params.require(xxx).permit(xxx, :file_staging)` for Rails 4
+
+3. That's it!
+
+## Contributing
+
+1. Fork it ( https://github.com/dabroz/paperclip-staging/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/paperclip/staging.rb

@@ -0,0 +1,92 @@
+require "paperclip/staging/version"
+
+module Paperclip
+  module Staging
+  end
+end
+
+class NamedStringIO < StringIO
+  attr_accessor :original_filename
+  attr_accessor :content_type
+
+  def initialize(text, filename, type)
+    super(text)
+    self.original_filename = filename
+    self.content_type = type
+  end
+end
+
+# module UrlGeneratorExtensions
+#   def for(style_name, options)
+#   end
+# end
+
+module AttachmentExtensions
+  def staged_url(style_name = default_style, options = {})
+    queued = queued_for_write[style_name]
+    if queued
+      data = Base64.strict_encode64(File.read(queued.path))
+      "data:#{queued.content_type};base64,#{data}"
+    else
+      url(style_name, options)
+    end
+  end
+end
+
+module HasAttachedFileExtensions
+  def define
+    super
+    define_accessor_staging
+  end
+
+  def define_accessor_staging
+    name = @name
+    staging_getter_name = "#{name.to_s}_staging".to_sym
+    staging_setter_name = "#{name.to_s}_staging=".to_sym
+
+    already_updated_ivar = "@attachment_#{name}_already_updated".to_sym
+
+    @klass.send :define_method, staging_getter_name do
+      ivar = "@attachment_#{name}"
+      attachment = instance_variable_get(ivar)
+      return nil unless attachment
+      queued = attachment.queued_for_write[:original]
+      if queued
+        filename = attachment.original_filename
+        type = attachment.content_type
+        body = File.read(queued.path)
+        [filename, type, body].map{|text|Base64.strict_encode64(text)}.join('|')
+      end
+    end
+
+    old_attachment_setter = "#{name.to_s}_original_setter".to_sym
+    @klass.send :alias_method, old_attachment_setter, "#{@name}="
+
+    @klass.send :define_method, "#{@name}=" do |file|
+      instance_variable_set(already_updated_ivar, true)
+      send(old_attachment_setter, file)
+    end
+
+    @klass.send :define_method, staging_setter_name do |value|
+      return if value.blank?
+      already_updated = instance_variable_get(already_updated_ivar)
+      return if already_updated
+      filename, type, body = value.split('|').map{|text|Base64.strict_decode64(text)}
+      send(name).assign(NamedStringIO.new(body, filename, type))
+    end
+  end
+end
+
+module Paperclip
+  class Attachment
+    prepend AttachmentExtensions
+  end
+
+  # class UrlGenerator
+  #   prepend UrlGeneratorExtensions
+  # end
+
+  class HasAttachedFile
+    prepend HasAttachedFileExtensions
+  end
+end

data/lib/paperclip/staging/version.rb

@@ -0,0 +1,5 @@
+module Paperclip
+  module Staging
+    VERSION = "0.1.0"
+  end
+end

data/paperclip-staging.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paperclip/staging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "paperclip-staging"
+  spec.version       = Paperclip::Staging::VERSION
+  spec.authors       = ["Tomasz Dąbrowski"]
+  spec.email         = ["t.dabrowski@rock-hard.eu"]
+  spec.summary       = %q{Allow Paperclip to pass attachments as data-uri on unsaved records.}
+  spec.description   = %q{Allow Paperclip to pass attachments as data-uri on unsaved records. Useful when dealing with forms and validation errors.}
+  spec.homepage      = "https://github.com/dabroz/paperclip-staging"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'paperclip', '~> 4.2'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: paperclip-staging
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomasz Dąbrowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paperclip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Allow Paperclip to pass attachments as data-uri on unsaved records. Useful
+  when dealing with forms and validation errors.
+email:
+- t.dabrowski@rock-hard.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paperclip/staging.rb
+- lib/paperclip/staging/version.rb
+- paperclip-staging.gemspec
+homepage: https://github.com/dabroz/paperclip-staging
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Allow Paperclip to pass attachments as data-uri on unsaved records.
+test_files: []