paperclip-globalize3 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 291f0de36becd34c190f413e9a6fd1e428032a28
-  data.tar.gz: 35ae076aa0f3d691c4d4739ceb276b10b8612248
+  metadata.gz: ab76787f50ea1fc671e86d2a88514adaac3d15ba
+  data.tar.gz: 8831d59aaa2b52741be85a7561b2bce68a9c8a77
 SHA512:
-  metadata.gz: 8cb9228fae277bcc58ce1985fee261419ae9361183caa9b9e83e5f3552898eeb38a5c142abdf25cc408c93017394a2341dc440483bdf1aa58cd0cf607f903ceb
-  data.tar.gz: af489e4213a7dc6512fb624a52dad35d5a664c3355284df8c9fd29407c7b837415bdbc5235f481f6fa71a65fbd3f57b5ba0e88c7226a14cea7cd61db5261e3ac
+  metadata.gz: 8d5c3cd80b86f608871bfdf9d1ff6d69e6b987b37d133c65106fdc2c65f0789dd72c2878cb2f9d16b822b2c488d1c93c5d0b1cbcad834a2ef9a34df5f52fba8c
+  data.tar.gz: d466da7201f9421f8f3f4263e7557aab42cb4d06c26fb4ca66158b7875826ca6d84b6c1212cda9af525167ae511b5d80639c0377643face3132177b4da2b901e

data/.gitignore

@@ -13,6 +13,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/examples.txt
 test/tmp
 test/version_tmp
 tmp

data/.rubocop.yml

@@ -0,0 +1,44 @@
+require: rubocop-rspec
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Include:
+    - 'Appraisals'
+    - '**/*.gemspec'
+    - '**/*.rake'
+    - '**/*.gemfile'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - '**/Capfile'
+  TargetRubyVersion: 2.2
+
+Layout/AlignHash:
+  EnforcedColonStyle: 'table'
+
+Layout/AlignParameters:
+  EnforcedStyle: 'with_fixed_indentation'
+
+Layout/DotPosition:
+  EnforcedStyle: 'trailing'
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: 'no_space'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/paperclip/globalize3/attachment.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/paperclip/globalize3/attachment.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Naming/VariableNumber:
+  EnforcedStyle: 'snake_case'
+
+Style/EmptyElse:
+  Exclude:
+    - 'lib/paperclip/globalize3/attachment.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,35 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-02-07 16:16:24 +0100 using RuboCop version 0.52.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 152
+
+# Offense count: 2
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 1
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 1
+# Configuration parameters: Max.
+RSpec/NestedGroups:
+  Exclude:
+    - 'spec/paperclip/globalize3/attachment_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/paperclip/globalize3/attachment_spec.rb'

data/.travis.yml

@@ -1,12 +1,18 @@
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.5
-  - 2.2.0
-before_install: gem install bundler -v '~> 1.7.13'
+  - 2.2.2
+  - 2.3.5
+  - 2.4.3
+before_install: gem install bundler -v '>= 1.13'
 script: "bundle exec rake spec"
 gemfile:
-  - gemfiles/rails_4.0_pc_4_1.gemfile
-  - gemfiles/rails_4.0_pc_4_2.gemfile
-  - gemfiles/rails_4.2_pc_4_1.gemfile
   - gemfiles/rails_4.2_pc_4_2.gemfile
+  - gemfiles/rails_4.2_pc_4_3.gemfile
+  - gemfiles/rails_4.2_pc_5_0.gemfile
+  - gemfiles/rails_4.2_pc_5_2.gemfile
+  - gemfiles/rails_5.0_pc_4_2.gemfile
+  - gemfiles/rails_5.0_pc_5_0.gemfile
+  - gemfiles/rails_5.0_pc_5_2.gemfile
+  - gemfiles/rails_5.1_pc_4_2.gemfile
+  - gemfiles/rails_5.1_pc_5_0.gemfile
+  - gemfiles/rails_5.1_pc_5_2.gemfile

data/.yardopts

@@ -0,0 +1,5 @@
+lib/**/*.rb
+--output-dir doc
+--no-private
+--readme README.md
+- CHANGELOG.md

data/Appraisals

@@ -1,23 +1,55 @@
-# Rails 4.0
-
-appraise 'rails-4.0-pc-4-1' do
-  gem 'rails',      '~> 4.0.0'
-  gem 'paperclip',  '~> 4.1.0'
-end
+# Rails 4.2
 
-appraise 'rails-4.0-pc-4-2' do
-  gem 'rails',      '~> 4.0.0'
+appraise 'rails-4.2-pc-4-2' do
+  gem 'rails',      '~> 4.2.0'
   gem 'paperclip',  '~> 4.2.0'
 end
 
-# Rails 4.2
+appraise 'rails-4.2-pc-4-3' do
+  gem 'rails',      '~> 4.2.0'
+  gem 'paperclip',  '~> 4.3.0'
+end
 
-appraise 'rails-4.2-pc-4-1' do
+appraise 'rails-4.2-pc-5-0' do
   gem 'rails',      '~> 4.2.0'
-  gem 'paperclip',  '~> 4.1.0'
+  gem 'paperclip',  '~> 5.0.0'
 end
 
-appraise 'rails-4.2-pc-4-2' do
+appraise 'rails-4.2-pc-5-2' do
   gem 'rails',      '~> 4.2.0'
+  gem 'paperclip',  '~> 5.2.0'
+end
+
+# Rails 5.0
+
+appraise 'rails-5.0-pc-4-2' do
+  gem 'rails',      '~> 5.0.0'
   gem 'paperclip',  '~> 4.2.0'
 end
+
+appraise 'rails-5.0-pc-5-0' do
+  gem 'rails',      '~> 5.0.0'
+  gem 'paperclip',  '~> 5.0.0'
+end
+
+appraise 'rails-5.0-pc-5-2' do
+  gem 'rails',      '~> 5.0.0'
+  gem 'paperclip',  '~> 5.2.0'
+end
+
+# Rails 5.1
+
+appraise 'rails-5.1-pc-4-2' do
+  gem 'rails',      '~> 5.1.0'
+  gem 'paperclip',  '~> 4.2.0'
+end
+
+appraise 'rails-5.1-pc-5-0' do
+  gem 'rails',      '~> 5.1.0'
+  gem 'paperclip',  '~> 5.0.0'
+end
+
+appraise 'rails-5.1-pc-5-2' do
+  gem 'rails',      '~> 5.1.0'
+  gem 'paperclip',  '~> 5.2.0'
+end

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# (unreleased)
+
+* Bugfixes
+    * (none)
+* Enhancements
+    * (none)
+
+# 3.0.0 (2018-02-07)
+
+* Breaking changes 
+    * Drop support for ruby < 2.2.2
+    * Drop support for rails < 4.2
+    * Drop support for paperclip < 4.2
+    * Drop support for globalize < 5.0
+    * Move paperclip-globalize3.rb to paperclip/globalize3.rb 
+      (if you manually require 'paperclip-globalize3', change it to 'paperclip/globalize3')
+* Bugfixes
+    * (none)
+* Enhancements
+    * Support ruby 2.3 and 2.4
+    * Test with paperclip 4.3
+    * Support paperclip 5.0/5.1/5.2
+    * Support rails 5.1
+* Internal / development
+    * Bump dependencies 
+    * Add rubocop
+    * Add yard
+
+# 2.x and before
+
+(Sorry, there was no CHANGELOG before, so please refer to github commits.)

data/README.md

@@ -1,6 +1,6 @@
 # Paperclip::Globalize3
 
-[![Build Status](https://travis-ci.org/emjot/paperclip-globalize3.png?branch=2.x-stable)](https://travis-ci.org/emjot/paperclip-globalize3)
+[![Build Status](https://travis-ci.org/emjot/paperclip-globalize3.png?branch=master)](https://travis-ci.org/emjot/paperclip-globalize3)
 
 Use locale-specific attachments in your Rails app with [paperclip](https://github.com/thoughtbot/paperclip) and
 [globalize](https://github.com/globalize/globalize).
@@ -11,17 +11,17 @@ Note that this implementation patches some methods in the `Paperclip::Attachment
 
 ## Compatibility
 
-This is a maintenance branch for previous (2.x) versions. 
+* paperclip 4.2 - 5.2
+* globalize 5.x
+* Rails 4.2/5.0/5.1
 
-Here, paperclip 4.1/4.2 and globalize 4.0/5.0 and rails 4.x are supported.
-
-For paperclip 3.x with globalize3 support please use the 1.x versions of this gem.
+For support of previous paperclip / globalize / rails versions please refer to the 2.x versions of this gem.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'paperclip-globalize3', '~> 2.3'
+    gem 'paperclip-globalize3'
 
 And then execute:
 
@@ -29,7 +29,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install paperclip-globalize3 -v '~> 2.3'
+    $ gem install paperclip-globalize3
 
 ## Usage
 

data/Rakefile

@@ -5,14 +5,14 @@ require 'rspec/core/rake_task'
 require 'wwtd/tasks'
 
 desc 'Default: run all tests with all supported versions'
-task :default => :all
+task default: :all
 
 desc 'Run tests with all supported Rails versions.'
-task :all => ["appraisal:install"] do
+task all: ['appraisal:install'] do
   exec('rake appraisal spec')
 end
 
-task :local => "wwtd:local" # run all gemfiles with local ruby
+task local: 'wwtd:local' # run all gemfiles with local ruby
 
 desc 'Run all tests'
 RSpec::Core::RakeTask.new('spec') do |t|

data/gemfiles/rails_4.2_pc_4_2.gemfile

@@ -1,8 +1,8 @@
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "rails", "~> 4.2.0"
-gem "paperclip", "~> 4.2.0"
+gem 'rails', '~> 4.2.0'
+gem 'paperclip', '~> 4.2.0'
 
-gemspec :path=>"../"
+gemspec path: '../'

data/gemfiles/rails_4.2_pc_4_3.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.2.0'
+gem 'paperclip', '~> 4.3.0'
+
+gemspec path: '../'

data/gemfiles/rails_4.2_pc_5_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.2.0'
+gem 'paperclip', '~> 5.0.0'
+
+gemspec path: '../'

data/gemfiles/rails_4.2_pc_5_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.2.0'
+gem 'paperclip', '~> 5.2.0'
+
+gemspec path: '../'

data/gemfiles/rails_5.0_pc_4_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0'
+gem 'paperclip', '~> 4.2.0'
+
+gemspec path: '../'

data/gemfiles/rails_5.0_pc_5_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0'
+gem 'paperclip', '~> 5.0.0'
+
+gemspec path: '../'

data/gemfiles/rails_5.0_pc_5_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0'
+gem 'paperclip', '~> 5.2.0'
+
+gemspec path: '../'

data/gemfiles/rails_5.1_pc_4_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.1.0'
+gem 'paperclip', '~> 4.2.0'
+
+gemspec path: '../'

data/gemfiles/rails_5.1_pc_5_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.1.0'
+gem 'paperclip', '~> 5.0.0'
+
+gemspec path: '../'

data/gemfiles/rails_5.1_pc_5_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.1.0'
+gem 'paperclip', '~> 5.2.0'
+
+gemspec path: '../'

data/lib/paperclip/globalize3/attachment.rb

@@ -1,143 +1,98 @@
 module Paperclip
   module Globalize3
+    # Prepend to the paperclip `Attachment` class to transparently read and write
+    # your attachments in context of the current locale using globalize.
+    #
+    # E.g. `my_model.my_attachment` returns a different attachment when your
+    # current locale is 'en' compared to when your current locale is 'de'.
+    #
+    # Requires a :locale interpolation for your paperclip attachment(s) and the
+    # respective columns to be translated.
     module Attachment
+      def assign(uploaded_file)
+        @file =
+          if Paperclip::Attachment.default_options.key?(:adapter_options) # paperclip >= 5.2.0
+            Paperclip.io_adapters.for(uploaded_file, @options[:adapter_options])
+          else # paperclip < 5.2.0
+            Paperclip.io_adapters.for(uploaded_file)
+          end
+        ensure_required_accessors!
+        ensure_required_validations!
 
-      def self.included(base)
-        base.send :include, InstanceMethods
-        base.send :alias_method_chain, :assign, :globalize3
-        base.send :alias_method_chain, :clear, :globalize3
-        base.send :alias_method_chain, :queue_all_for_delete, :globalize3
-        base.send :alias_method_chain, :queue_some_for_delete, :globalize3
-      end
-
-      module InstanceMethods
-        def assign_with_globalize3(uploaded_file)
-          @file = Paperclip.io_adapters.for(uploaded_file)
-          ensure_required_accessors!
-          ensure_required_validations!
-
-          if @file.assignment?
-            clear(*only_process, :locales => Globalize.locale) # [paperclip-globalize3] only clear current locale
-            if @file.nil?
-              nil
-            else
-              assign_attributes
-              post_process_file
-              reset_file_if_original_reprocessed
-            end
-          else
+        if @file.assignment?
+          clear(*only_process, locales: Globalize.locale) # [paperclip-globalize3] only clear current locale
+          if @file.nil?
             nil
+          else
+            assign_attributes
+            post_process_file
+            reset_file_if_original_reprocessed
           end
+        else
+          nil
         end
+      end
 
-        def clear_with_globalize3(*args)
-          options = args.extract_options!
-          styles_to_clear = args
-          if styles_to_clear.any?
-            queue_some_for_delete(*styles_to_clear, options)
-          else
-            queue_all_for_delete(options)
-            @queued_for_write  = {}
-            @errors            = {}
-          end
+      def clear(*args)
+        options = args.extract_options!
+        styles_to_clear = args
+        if styles_to_clear.any?
+          queue_some_for_delete(*styles_to_clear, options)
+        else
+          queue_all_for_delete(options)
+          @queued_for_write  = {}
+          @errors            = {}
         end
+      end
 
-        private
+      private
 
-        def queue_all_for_delete_with_globalize3(options = {}) #:nodoc:
-          with_locales_if_translated(options[:locales]) do
-            queue_all_for_delete_without_globalize3
-          end
+      def queue_all_for_delete(options = {}) #:nodoc:
+        with_locales_if_translated(options[:locales]) do
+          super()
         end
+      end
 
-        def queue_some_for_delete_with_globalize3(*args)
-          options = args.extract_options!
-          styles  = args
-          with_locales_if_translated(options[:locales]) do
-            queue_some_for_delete_without_globalize3(styles)
-          end
+      def queue_some_for_delete(*args)
+        options = args.extract_options!
+        styles  = args
+        with_locales_if_translated(options[:locales]) do
+          super(styles)
         end
+      end
 
-        # If translated, execute the block for the given locales only (or for all translated locales if none are given).
-        # If any locales are given, only those for which a translation exists are used.
-        # If attachment is untranslated, simply execute the block.
-        def with_locales_if_translated(with_locales = nil, &block)
-          if instance.respond_to?(:translated_locales) && instance.translated?(:"#{name}_file_name")
-            # TODO translated_locales are not present any more when this is called via destroy callback (unless 'translates' is defined AFTER 'has_attached_file' in the model class)
-            with_locales =
-              if with_locales.nil?
-                [*instance.translated_locales]
-              else
-                [*with_locales] & instance.translated_locales
-              end
-            Globalize.with_locales(with_locales) { yield }
-          else
-            yield
-          end
+      # Yields the given block in context of Globalize#with_locales, but handles these situations gracefully:
+      #
+      # * if it is not translated (=> then don't use Globalize)
+      # * if there are no locales given (=> then use all translated locales)
+      # * if there are `with_locales` requested for which there are no translations (=> then skip those)
+      #
+      # @param [Symbol, Array[Symbol], nil] with_locales only yield block for these translated locales
+      def with_locales_if_translated(with_locales = nil)
+        if translated?
+          locales = with_locales.nil? ? translated_locales : [*with_locales] & translated_locales
+          Globalize.with_locales(locales) { yield }
+        else
+          yield
         end
       end
 
-      module Compatibility
-        # The paperclip-globalize3 patches are based on paperclip 4.2 code;
-        # this module needs to be included when trying to use with paperclip 4.1.
-        module Paperclip41
-          def assign_attributes
-            @queued_for_write[:original] = @file
-            assign_file_information
-            assign_fingerprint(@file.fingerprint)
-            assign_timestamps
-          end
-
-          def assign_file_information
-            instance_write(:file_name, cleanup_filename(@file.original_filename))
-            instance_write(:content_type, @file.content_type.to_s.strip)
-            instance_write(:file_size, @file.size)
-          end
-
-          def assign_fingerprint(fingerprint)
-            if instance_respond_to?(:fingerprint)
-              instance_write(:fingerprint, fingerprint)
-            end
-          end
-
-          def assign_timestamps
-            if has_enabled_but_unset_created_at?
-              instance_write(:created_at, Time.now)
-            end
-
-            instance_write(:updated_at, Time.now)
-          end
-
-          def post_process_file
-            dirty!
-
-            if post_processing
-              post_process(*only_process)
-            end
-          end
+      # Whether both the model and the attachment are translated
+      def translated?
+        instance.respond_to?(:translated_locales) && instance.translated?(:"#{name}_file_name")
+      end
 
-          def dirty!
-            @dirty = true
-          end
+      # Returns the locales for which there are translations for the model instance, if applicable
+      # (nil if the model or the attachment is not translated).
+      #
+      # @return [Array[Symbol], nil]
+      def translated_locales
+        return unless translated?
 
-          def reset_file_if_original_reprocessed
-            instance_write(:file_size, @queued_for_write[:original].size)
-            assign_fingerprint(@queued_for_write[:original].fingerprint)
-            reset_updater
-          end
-
-          def reset_updater
-            if instance.respond_to?(updater)
-              instance.send(updater)
-            end
-          end
-
-          def updater
-            :"#{name}_file_name_will_change!"
-          end
-        end
+        # TODO: translated_locales are not present any more when this is called via destroy callback
+        #   (unless 'translates' is defined AFTER 'has_attached_file' in the model class)
+        instance.translated_locales
       end
-
     end
   end
 end

data/lib/paperclip/globalize3/gem_helper.rb

@@ -1,15 +1,12 @@
 module Paperclip
   module Globalize3
-
     # Like Bundler::GemHelper, but tags versions without the 'v' prefix (e.g. '1.0.0' instead of 'v1.0.0')
     class GemHelper < Bundler::GemHelper
-
       protected
 
       def version_tag
-        "#{version}"
+        version.to_s
       end
-
     end
   end
 end

data/lib/paperclip/globalize3/version.rb

@@ -1,5 +1,5 @@
 module Paperclip
   module Globalize3
-    VERSION = "2.3.0"
+    VERSION = '3.0.0'.freeze
   end
 end