paperclip-globalize3 2.3.0 → 3.0.0

data/lib/{paperclip-globalize3.rb → paperclip/globalize3.rb}

@@ -1,8 +1,8 @@
-require "paperclip/globalize3/version"
-require "paperclip/globalize3/attachment"
+require 'paperclip/globalize3/version'
+require 'paperclip/globalize3/attachment'
 
-require "globalize"
-require "paperclip"
+require 'globalize'
+require 'paperclip'
 
 # Paperclip locale interpolation: if locale fallbacks are used, we need to determine & use the fallback locale
 Paperclip.interpolates(:locale) do |attachment, _style_name|
@@ -18,15 +18,11 @@ Paperclip.interpolates(:locale) do |attachment, _style_name|
       end
     else
       Rails.logger.warn(
-        "WARN You have used :locale in a paperclip url/path for an untranslated model (in #{record.class.to_s})."
+        "WARN You have used :locale in a paperclip url/path for an untranslated model (in #{record.class})."
       )
       nil
     end
   (attachment_locale || Globalize.locale).to_s
 end
 
-unless Paperclip::Attachment.instance_methods.include?(:assign_attributes)
-  Paperclip::Attachment.send(:include, Paperclip::Globalize3::Attachment::Compatibility::Paperclip41)
-end
-
-Paperclip::Attachment.send(:include, Paperclip::Globalize3::Attachment)
+Paperclip::Attachment.send(:prepend, Paperclip::Globalize3::Attachment)

data/paperclip-globalize3.gemspec

@@ -1,31 +1,37 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'paperclip/globalize3/version'
+require 'English'
 
 Gem::Specification.new do |spec|
-  spec.name          = "paperclip-globalize3"
+  spec.name          = 'paperclip-globalize3'
   spec.version       = Paperclip::Globalize3::VERSION
-  spec.authors       = ["Maximilian Herold"]
-  spec.email         = ["herold@emjot.de"]
-  spec.description   = %q{locale-specific attachments with paperclip and globalize}
-  spec.summary       = %q{locale-specific attachments with paperclip and globalize}
-  spec.homepage      = "https://github.com/emjot/paperclip-globalize3"
-  spec.license       = "MIT"
+  spec.authors       = ['Maximilian Herold']
+  spec.email         = ['herold@emjot.de']
+  spec.description   = 'locale-specific attachments with paperclip and globalize'
+  spec.summary       = 'locale-specific attachments with paperclip and globalize'
+  spec.homepage      = 'https://github.com/emjot/paperclip-globalize3'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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.require_paths = ['lib']
 
-  spec.add_dependency "activerecord", ['>= 4.0', '< 5.1']
-  spec.add_dependency "globalize", ">= 4.0.0"
-  spec.add_dependency "paperclip", "~> 4.1"
+  spec.required_ruby_version = '>= 2.2.2'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "appraisal", "~> 0.5.1"
-  spec.add_development_dependency "rspec-rails", ["~> 2.14.1", "< 2.99"]
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "rake", '< 12'
-  spec.add_development_dependency "wwtd", "~> 0.5"
+  spec.add_dependency 'activerecord', ['>= 4.2', '< 5.2']
+  spec.add_dependency 'globalize', '>= 5.0.0'
+  spec.add_dependency 'paperclip', ['>= 4.2', '< 5.3']
+
+  spec.add_development_dependency 'appraisal', '~> 2.2'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'wwtd', '~> 1.3'
+  spec.add_development_dependency 'yard'
 end

data/spec/data/models.rb

@@ -4,25 +4,24 @@ end
 
 class Post < BasePost
   has_attached_file :image,
-                    :url => "/system/:test_env_number/:class/:attachment/:id/:locale/:style-:fingerprint.:extension"
-  validates_attachment :image, :content_type => { :content_type => ['image/png'] }
+    url: '/system/:test_env_number/:class/:attachment/:id/:locale/:style-:fingerprint.:extension'
+  validates_attachment :image, content_type: {content_type: ['image/png']}
 
   translates :image_file_name, :image_content_type, :image_file_size, :image_updated_at, :image_fingerprint
 end
 
 class OnlyProcessPost < BasePost
   has_attached_file :image,
-                    :url => "/system/:test_env_number/:class/:attachment/:id/:locale/:style-:fingerprint.:extension",
-                    :styles => { :thumb => "10x10", :large => "40x40" },
-                    :only_process => [:thumb]
-  validates_attachment :image, :content_type => { :content_type => ['image/png'] }
+    url:          '/system/:test_env_number/:class/:attachment/:id/:locale/:style-:fingerprint.:extension',
+    styles:       {thumb: '10x10', large: '40x40'},
+    only_process: [:thumb]
+  validates_attachment :image, content_type: {content_type: ['image/png']}
 
   translates :image_file_name, :image_content_type, :image_file_size, :image_updated_at, :image_fingerprint
 end
 
 class Untranslated < ActiveRecord::Base
   has_attached_file :image,
-                    :url => "/system/:test_env_number/:class/:attachment/:id/:style-:fingerprint.:extension"
-  validates_attachment :image, :content_type => { :content_type => ['image/png'] }
+    url: '/system/:test_env_number/:class/:attachment/:id/:style-:fingerprint.:extension'
+  validates_attachment :image, content_type: {content_type: ['image/png']}
 end
-

data/spec/data/schema.rb

@@ -1,11 +1,11 @@
 ActiveRecord::Migration.verbose = false
 
 ActiveRecord::Schema.define do
-  create_table :posts, :force => true do |t|
+  create_table :posts, force: true do |t|
     t.integer    :rating
   end
 
-  create_table :post_translations, :force => true do |t|
+  create_table :post_translations, force: true do |t|
     t.string     :locale
     t.references :post
     t.string     :image_file_name
@@ -15,12 +15,11 @@ ActiveRecord::Schema.define do
     t.timestamp  :image_updated_at
   end
 
-  create_table :untranslateds, :force => true do |t|
+  create_table :untranslateds, force: true do |t|
     t.string     :image_file_name
     t.integer    :image_file_size
     t.string     :image_content_type
     t.string     :image_fingerprint
     t.timestamp  :image_updated_at
   end
-
-end
+end

data/spec/paperclip/globalize3/attachment_spec.rb

@@ -0,0 +1,198 @@
+require 'spec_helper'
+
+RSpec.describe Paperclip::Globalize3::Attachment do
+  def with_locale(*args, &block)
+    Globalize.with_locale(*args, &block)
+  end
+
+  def with_locales(*args, &block)
+    Globalize.with_locales(*args, &block)
+  end
+
+  before do
+    stub_const('Rails', double('Rails'))
+    allow(Rails).to receive(:root).and_return(ROOT.join('tmp'))
+    allow(Rails).to receive(:env).and_return('test')
+    allow(Rails).to receive(:const_defined?).with(:Railtie).and_return(false)
+  end
+
+  let(:test_image_dir) do
+    File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'data'))
+  end
+
+  let(:test_image_file) do
+    File.new(File.join(test_image_dir, 'test.png'))
+  end
+
+  let(:test_image_file2) do
+    File.new(File.join(test_image_dir, 'test2.png'))
+  end
+
+  let(:sample_post_with_en) do
+    Post.create!.tap do |post|
+      with_locale(:en) { post.update!(image: test_image_file) }
+    end
+  end
+
+  let(:sample_post_with_en_and_de) do
+    Post.create!.tap do |post|
+      with_locale(:en) { post.update!(image: test_image_file) }
+      with_locale(:de) { post.update!(image: test_image_file2) }
+    end
+  end
+
+  describe 'attachment assignment' do
+    context 'when attachment has been assigned in one locale' do
+      let!(:post) { sample_post_with_en }
+
+      it 'is present in that locale' do
+        expect(with_locale(:en) { post.image_file_name }).to eq('test.png')
+      end
+
+      it 'exists in the file system in that locale' do
+        expect(File).to be_exist(with_locale(:en) { post.image.path })
+      end
+
+      it 'is not present in another locale' do
+        expect(with_locale(:de) { post.image_file_name }).to be_nil
+      end
+
+      it('results in a model count of 1') do
+        expect(Post.count).to eq(1)
+      end
+
+      it('results in a model translations count of 1') do
+        expect(Post.translation_class.count).to eq(1)
+      end
+    end
+
+    context 'when another attachment gets assigned to a different locale' do
+      subject(:assign_to_different) { with_locale(:de) { post.update!(image: test_image_file2) } }
+
+      let!(:post) { sample_post_with_en }
+
+      it 'is present in that different locale' do
+        expect { assign_to_different }.to change { with_locale(:de) { post.image_file_name } }.
+          from(nil).to('test2.png')
+      end
+
+      it 'has a different file path than in the first locale' do
+        assign_to_different
+        expect(with_locale(:de) { post.image.path }).not_to eq(with_locale(:en) { post.image.path })
+      end
+
+      it 'exists in the file system in that different locale' do
+        assign_to_different
+        expect(File).to be_exist((with_locale(:de) { post.image.path }))
+      end
+
+      it 'does not change the attachment in the first locale' do
+        expect { assign_to_different }.not_to(change { with_locale(:en) { post.image_file_name } })
+      end
+
+      it 'does not delete the file in the first locale' do
+        expect { assign_to_different }.not_to(change { File.exist?(with_locale(:en) { post.image.path }) })
+      end
+
+      it('does not change the model count') { expect { assign_to_different }.not_to change(Post, :count) }
+
+      it 'changes the model translations count by 1' do
+        expect { assign_to_different }.to change(Post.translation_class, :count).by(1)
+      end
+    end
+
+    context 'when attachments have been assigned in multiple locales and one gets re-assigned' do
+      subject(:re_assign_en) { with_locale(:en) { post.update!(image: test_image_file2) } }
+
+      let!(:post)             { sample_post_with_en_and_de }
+      let!(:original_path_en) { with_locale(:en) { post.image.path } }
+      let!(:original_path_de) { with_locale(:de) { post.image.path } }
+
+      it 'changes the path in that locale' do
+        expect { re_assign_en }.to(change { with_locale(:en) { post.image.path } })
+      end
+
+      it 'deletes the old file in that locale' do
+        expect { re_assign_en }.to change { File.exist?(original_path_en) }.from(true).to(false)
+      end
+
+      it 'creates the new file in that locale' do
+        re_assign_en
+        expect(File).to be_exist(with_locale(:en) { post.image.path })
+      end
+
+      it 'does not delete the files of the other locales' do
+        re_assign_en
+        expect(File).to be_exist(original_path_de)
+      end
+    end
+
+    context 'when attachment defines :only_process' do
+      subject(:assign) { with_locale(:en) { post.update!(image: test_image_file) } }
+
+      let!(:post) { OnlyProcessPost.create }
+
+      it 'only clears the provided style in the current locale' do
+        expect(post.image).to receive(:queue_some_for_delete).with(:thumb, locales: :en)
+        expect(post.image).not_to receive(:queue_all_for_delete)
+        assign
+      end
+    end
+  end
+
+  describe 'model destroy' do
+    subject(:destroy) { post.destroy }
+
+    context 'when model has translations' do
+      let!(:post)             { sample_post_with_en_and_de }
+      let!(:original_path_en) { with_locale(:en) { post.image.path } }
+      let!(:original_path_de) { with_locale(:de) { post.image.path } }
+
+      it 'deletes all attachments in all locales' do
+        expect { destroy }.
+          to change { [File.exist?(original_path_en), File.exist?(original_path_de)] }.
+          from([true, true]).
+          to([false, false])
+      end
+    end
+
+    context 'when model does not have translations' do
+      let!(:post)           { Untranslated.create!(image: test_image_file) }
+      let!(:original_path)  { post.image.path }
+
+      it 'deletes attachment files' do
+        expect { destroy }.to change { File.exist?(original_path) }.from(true).to(false)
+      end
+    end
+  end
+
+  context 'when fallbacks are defined' do
+    around do |example|
+      old_fallbacks = Globalize.fallbacks
+      Globalize.fallbacks = {en: %i[en de], de: %i[de en]}
+      example.run
+      Globalize.fallbacks = old_fallbacks
+    end
+
+    describe 'reading the attachment url in a non-existent locale' do
+      let!(:post) { sample_post_with_en }
+
+      it 'returns the attachment url in the fallback locale' do
+        with_locale(:de) { expect(post.image.url).to match('/en/') }
+      end
+    end
+
+    describe 'attachment assignment' do
+      context 'when another attachment gets assigned to a different locale' do
+        subject(:assign_to_different) { with_locale(:de) { post.update!(image: test_image_file) } }
+
+        let!(:post) { sample_post_with_en }
+
+        it 'has files for all attachments in all locales' do
+          assign_to_different
+          expect(with_locales(:en, :de) { File.exist?(post.image.path) }).to be_all
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,22 +1,15 @@
-require 'pathname'
 require 'fileutils'
+require 'logger'
+require 'pathname'
+require 'rspec'
+require 'active_record'
+require 'active_support'
+require 'database_cleaner'
 
 ROOT = Pathname(File.expand_path(File.join(File.dirname(__FILE__), '..')))
 TEST_ASSETS_PATH = Pathname.new(ROOT).join('tmp', 'public')
 
-RSpec.configure do |config|
-  config.mock_with :rspec
-  config.after(:suite) do
-    FileUtils.rm_rf TEST_ASSETS_PATH if File.exist?(TEST_ASSETS_PATH)
-  end
-end
-
-require 'active_support'
-require 'action_pack'
-require 'action_view'
-require 'action_controller'
-require 'action_dispatch'
-require File.expand_path(File.join(File.dirname(__FILE__), '../lib/paperclip-globalize3'))
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/paperclip/globalize3'))
 
 ActiveRecord::Base.send(:include, Paperclip::Glue)
 
@@ -24,17 +17,56 @@ Paperclip.interpolates(:test_env_number) do |_, _|
   ENV['TEST_ENV_NUMBER'].presence || '0'
 end
 
-# set up globalize3 and models (borrowed from globalize3)
-require 'fileutils'
-require 'logger'
-tmpdir = File.join(File.dirname(__FILE__), "../tmp")
+tmpdir = File.join(File.dirname(__FILE__), '../tmp')
 FileUtils.mkdir(tmpdir) unless File.exist?(tmpdir)
-log = File.expand_path(File.join(tmpdir, "globalize3_test.log"))
-FileUtils.touch(log) unless File.exists?(log)
+log = File.expand_path(File.join(tmpdir, 'globalize3_test.log'))
+FileUtils.touch(log) unless File.exist?(log)
 ActiveRecord::Base.logger = Logger.new(log)
 ActiveRecord::LogSubscriber.attach_to(:active_record)
-ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+if ActiveRecord::VERSION::STRING >= '4.2' &&
+   ActiveRecord::VERSION::STRING < '5.0'
+  ActiveRecord::Base.raise_in_transactional_callbacks = true
+end
+Paperclip.options[:logger] = ActiveRecord::Base.logger
+
 require File.expand_path('../data/schema', __FILE__)
 require File.expand_path('../data/models', __FILE__)
-I18n.locale = I18n.default_locale = :en
-Globalize.locale = nil
+DatabaseCleaner.strategy = :truncation # we need to commit transactions so that after_commit callbacks are executed
+
+I18n.available_locales = %i[en de]
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+  config.disable_monkey_patching!
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.profile_examples = 2
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.before do
+    DatabaseCleaner.start
+    I18n.locale = I18n.default_locale = :en
+    Globalize.locale = nil
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+
+  config.after(:all) do
+    FileUtils.rm_rf TEST_ASSETS_PATH if File.exist?(TEST_ASSETS_PATH)
+  end
+end