copy_carrierwave_file 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: caa9347179a5352c6a262d62a95ca3b06de71de2
+  data.tar.gz: c8aa2af194cd3048d0163dd6274393e814b6d8f5
+SHA512:
+  metadata.gz: fd24f51d96cece94dc37113f5e6aac680b32ad3b9824dc7fd778f0573630f291e84b8deb92abe4d2d846451385638adb4ac4e8473d72368198a0d5d2b1c562e4
+  data.tar.gz: 0231a474da06baad11cc7da34f66a06403424ad1ffc7286de9b67a645a7a2d51f5c3866fd351245651417eccf4525fc667b9ecc621e0212de7e9a90c52578c42

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test/tmp
+.ruby-version
+.ruby-gemset

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tomas Valent
+
+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,56 @@
+# CopyCarrierwaveFile
+
+
+Simple gem for copying [CarrierWave](https://github.com/carrierwaveuploader/carrierwave) files between resources.
+It's solving issues with local and remote storage discussed
+[here](http://stackoverflow.com/questions/9921085/whats-the-proper-way-to-copy-a-carrierwave-file-from-one-record-to-another)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'copy_carrierwave_file', github: 'equivalent/copy_carrierwave_file'
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+You can use service class directly: 
+
+    original_resource = User.last
+    new_resource      = User.new
+
+    CopyCarrierwaveFile::CopyFileService.new(original_resource, new_resource, :avatar).set_file
+      # :avatar represents mount point
+   
+    new_resource.save
+
+or you can include `CopyCarrierwaveFile` module and call `copy_carrierwave_file` :
+
+
+    class Document
+      include CopyCarrierwaveFile  
+      mount_uplader :content_file, MyUploader
+
+      def duplicate_file(original)
+        copy_carrierwave_file(original, self, :content_file)
+        self.save!
+      end
+    end
+
+    document = Document.new
+    document.duplicate_file(Document.last) 
+
+Functionality is the same
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/copy_carrierwave_file.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'copy_carrierwave_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "copy_carrierwave_file"
+  spec.version       = CopyCarrierwaveFile::VERSION
+  spec.authors       = ["Tomas Valent"]
+  spec.email         = ["equivalent@eq8.eu"]
+  spec.description   = %q{Gems main responsibility is to provide service for copying Carrierwave files between records }
+  spec.summary       = %q{Copy Carrierwave files between records}
+  spec.homepage      = "http://eq8.eu"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "rake"
+  spec.add_dependency "carrierwave", "~> 0.9"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "activerecord", "~> 3.2"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "mocha", "~> 0.14"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/copy_carrierwave_file.rb

@@ -0,0 +1,8 @@
+require "copy_carrierwave_file/version"
+require "copy_carrierwave_file/copy_file_service"
+
+module CopyCarrierwaveFile
+  def copy_carrierwave_file(original_resource, destination_resource, mount_point)
+    CopyCarrierwaveFile::CopyFileService.new(original_resource, destination_resource, mount_point).set_file
+  end
+end

data/lib/copy_carrierwave_file/copy_file_service.rb

@@ -0,0 +1,68 @@
+module CopyCarrierwaveFile
+  class CopyFileService
+    attr_reader :original_resource, :resource, :mount_point
+
+    def initialize(original_resource, resource, mount_point)
+      @mount_point       = mount_point.to_sym
+
+      raise "#{original_resource} is not a resource with uploader" unless original_resource.class.respond_to? :uploaders
+      raise "#{original_resource} doesn't have mount point #{mount_point}" unless original_resource.class.uploaders[@mount_point]
+
+      raise "#{resource} is not a resource with uploader" unless resource.class.respond_to? :uploaders
+      raise "#{resource} doesn't have mount point #{mount_point}" unless resource.class.uploaders[@mount_point]
+
+      @original_resource = original_resource
+      @resource          = resource
+    end
+
+    # Set file from original resource
+    #
+    # Founded originally at http://bit.ly/ROGtPR
+    #
+    def set_file
+      if have_file?
+        begin
+          set_file_for_remote_storage
+        rescue Errno::ENOENT
+          set_file_for_local_storage
+        rescue NoMethodError
+          raise "Original resource has no File"
+        end
+      else
+        raise "Original resource has no File"
+      end
+    end
+
+    def have_file?
+      original_resource_mounter.file.present?
+    end
+
+    # Set file when you use remote storage for your files (like S3)
+    #
+    # will try to fetch full remote path of a file with `open-uri`
+    #
+    # If you use local storage, `doc.avatar.url` will return relative path, therefor
+    # this will fail with Errno::ENOENT
+    #
+    # If you have issues with code try alternative code:
+    #
+    #    resource.remote_file_url = original_resource.avatar.url
+    #
+    def set_file_for_remote_storage
+      set_resource_mounter_file open(original_resource_mounter.url)
+    end
+
+    def set_file_for_local_storage
+      set_resource_mounter_file File.open(original_resource_mounter.file.file)
+    end
+
+    def original_resource_mounter
+      original_resource.send(mount_point)
+    end
+
+    def set_resource_mounter_file(file)
+      resource.send( :"#{mount_point.to_s}=", file)
+    end
+
+  end
+end

data/lib/copy_carrierwave_file/version.rb

@@ -0,0 +1,3 @@
+module CopyCarrierwaveFile
+  VERSION = "1.0.1"
+end

data/test/copy_carrierwave_file_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+describe 'CopyCarrierwaveFile', 'included module' do
+
+  before do
+    Document.send :include, CopyCarrierwaveFile
+  end
+
+  it do
+    file_service_object = mock()
+    file_service_object.expects(:set_file).at_least_once.returns(true)
+
+    CopyCarrierwaveFile::CopyFileService.expects(:new).with('one', 'two', :file).returns(file_service_object)
+    Document.new.copy_carrierwave_file('one','two', :file)
+  end
+  
+end

data/test/copy_file_service_wrong_initialization_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+
+class User
+  # has no uploader
+end
+
+describe CopyCarrierwaveFile::CopyFileService, 'initialization' do
+
+  context 'with resources with uploader and right mount point' do
+    it "should not raise an error" do
+      CopyCarrierwaveFile::CopyFileService.new(Document.new, Document.new, :file)
+    end
+  end
+
+  context 'when original resources without uploader' do
+    it "should raise an error" do
+      proc{ CopyCarrierwaveFile::CopyFileService.new(User.new, Document.new, :file) }.
+        must_raise RuntimeError
+    end
+  end
+
+
+  context 'when resources without uploader' do
+    it "should raise an error" do
+      proc{ CopyCarrierwaveFile::CopyFileService.new(Document.new, User.new, :file) }.
+        must_raise RuntimeError
+    end
+  end
+
+  context 'with resources with uploader but wrong mount point' do
+    it do
+      proc{ CopyCarrierwaveFile::CopyFileService.new(Document.new, Document.new, :foo) }.
+        must_raise RuntimeError
+    end
+  end
+
+
+end

data/test/copy_local_storage_file_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+describe 'CopyCarrierwaveFile', 'copying local storage file' do
+  include UploadedFileMacros
+
+  def remove_uploaded_test_files
+    FileUtils.rm_rf(Dir.glob(TEST_DIR+"/tmp/uploads/*"))
+  end
+
+  let(:document)    { Document.new }
+  let(:copy_service){ CopyCarrierwaveFile::CopyFileService.new(original_document, document, :file)}
+  let(:original_document) do
+    doc = Document.new
+    doc.file = test_file1
+    doc.save
+    doc
+  end
+
+  after(:all){ remove_uploaded_test_files }
+
+  subject{ FileUtils.identical?(original_document.file.file.file, document.file.file.file) }
+
+  before do
+    copy_service.set_file
+    document.save
+  end
+
+  it 'Document file must be identical to Original document file' do
+    subject.must_equal true
+  end
+end

data/test/copy_remote_storage_file_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+describe CopyCarrierwaveFile::CopyFileService, 'copying remote storage file' do
+  include UploadedFileMacros
+
+  let(:document)    { Document.new }
+  let(:copy_service){ CopyCarrierwaveFile::CopyFileService.new(original_document, document, :file)}
+  let(:original_document){ Document.create }
+
+  after(:all){ remove_uploaded_test_files }
+
+  subject{ FileUtils.identical?(test_file1, document.file.file.file) }
+
+
+  it 'Document file must be identical to Original document file' do
+    mock_file = mock()
+    mock_file.expects(:file).at_least_once.returns('a_file_mock')
+    mock_file.expects(:url).at_least_once.returns('http://foo')
+
+    original_document.stubs(:file).returns(mock_file)
+    CopyCarrierwaveFile::CopyFileService.any_instance.expects(:open).with('http://foo').returns(test_file1)
+
+    copy_service.set_file
+    document.save
+
+    subject.must_equal true
+  end
+end

data/test/fixtures/uploads/test_file1.txt

@@ -0,0 +1 @@
+this is test file

data/test/fixtures/uploads/test_file2.txt

@@ -0,0 +1 @@
+this is different test file

data/test/support/upload_file_macros.rb

@@ -0,0 +1,32 @@
+require 'carrierwave/test/matchers'
+
+# UploadedFileMacros
+#
+# set of file upload helpers for CarrierWave
+#
+# If you want to lern more read my scrap on CarrierWave 
+# https://github.com/equivalent/scrapbook2/blob/master/carrierwave.md
+#
+module UploadedFileMacros
+
+  def uploaded_test_file1
+    ActionDispatch::Http::UploadedFile.new({
+      :filename => 'test_file1',
+      :content_type => 'txt',
+      :tempfile => test_file1
+    })
+  end
+
+  # For comparing the upladed file match
+  #
+  #    document.file.file.file.should be_identical_to file_for_upload
+  #
+  def test_file1
+    File.new("#{TEST_DIR}/fixtures/uploads/test_file1.txt")
+  end
+
+  def test_file2
+    File.new("#{TEST_DIR}/fixtures/uploads/test_file2.txt")
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,40 @@
+require 'bundler/setup'
+require 'copy_carrierwave_file'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'active_record'
+require 'carrierwave'
+require 'carrierwave/orm/activerecord'
+
+TEST_DIR = File.dirname(__FILE__)
+#require './test/support/upload_file_macros.rb'
+Dir[TEST_DIR+"/support/**/*.rb"].each{|f| require  f}
+
+class Minitest::Spec
+  class << self
+    alias :context :describe
+  end
+end
+
+ActiveRecord::Base::establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.connection.execute(%{CREATE TABLE documents (id INTEGER PRIMARY KEY, file STRING );})
+
+
+class FileUploader < CarrierWave::Uploader::Base
+  storage :file
+
+  def root
+    "#{TEST_DIR}/tmp/" # 
+  end
+end
+
+
+class Document < ActiveRecord::Base
+  mount_uploader :file, FileUploader
+end
+
+def remove_uploaded_test_files
+  FileUtils.rm_rf(Dir.glob(TEST_DIR+"/tmp/uploads/*"))
+end
+
+

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: copy_carrierwave_file
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Tomas Valent
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Gems main responsibility is to provide service for copying Carrierwave
+  files between records '
+email:
+- equivalent@eq8.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- copy_carrierwave_file.gemspec
+- lib/copy_carrierwave_file.rb
+- lib/copy_carrierwave_file/copy_file_service.rb
+- lib/copy_carrierwave_file/version.rb
+- test/copy_carrierwave_file_test.rb
+- test/copy_file_service_wrong_initialization_test.rb
+- test/copy_local_storage_file_test.rb
+- test/copy_remote_storage_file_test.rb
+- test/fixtures/uploads/test_file1.txt
+- test/fixtures/uploads/test_file2.txt
+- test/support/upload_file_macros.rb
+- test/test_helper.rb
+homepage: http://eq8.eu
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Copy Carrierwave files between records
+test_files:
+- test/copy_carrierwave_file_test.rb
+- test/copy_file_service_wrong_initialization_test.rb
+- test/copy_local_storage_file_test.rb
+- test/copy_remote_storage_file_test.rb
+- test/fixtures/uploads/test_file1.txt
+- test/fixtures/uploads/test_file2.txt
+- test/support/upload_file_macros.rb
+- test/test_helper.rb