carrierwave-base64 2.3.5 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43ded0d0612bfca0092a8f69bf75f2cea936c1d2
-  data.tar.gz: 4ade936bbe6f44cc7e25e5aac7f34cc11a6866fe
+  metadata.gz: 39e8fd07baef760e5937db3b05ed6ce369369e52
+  data.tar.gz: ed5d91745c21ac7d8642a0d9ee9edaed2e559466
 SHA512:
-  metadata.gz: 502a3d71f3829b95dd92f47b1079e338976189ecf448a1c1c5a680b927f267006a3bc084a376d27f9deb7910a0971f29c3e2ab32a8464a389e70144129b3fdef
-  data.tar.gz: 7c18f72082d986903560a01c20ff51e6e04fb5afc6e03054e7e3535e3e0a806d7e7158063c1509d5a54f30f13b71a34a3c2fef99d63f04a1b46defada8cc54a4
+  metadata.gz: 3471e8152f7431832ff5cf1e9e09fd8e4ef3dcc1659532da9702f884be8c32e10201e1a241335d738be8aed6dfcbc017564fa566868a6b1ec9ba9afbfd2eeab3
+  data.tar.gz: d339ff54885830de362f14a82dd8dc3adf57c83c5ec961d7f731187d67dbf4436d4d2905d403d35fdb281d36d58f998d345da5b558c5aa300d32838d48838f9d

data/.rubocop.yml

@@ -1,2 +1,6 @@
 Documentation:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 
 rvm:
- - 2.0.0
  - 2.1.9
  - 2.2.5
  - 2.3.1

data/CHANGELOG.md

@@ -1,9 +1,19 @@
 # carrierwave-base64 changelog
 
+## 2.4.0
+
+  - The `:file_name` option accepts a lambda with an argument, to which the model instance would be passed. This allows you to set the filename based on some model attribute (@lebedev-yury).
+  - The file extension for the uploaded base64 string is identified automatically, using `MIME::Types`. In case if the mime type for your upload is not identified, you need to add it, using `MIME::Types.add` (@lebedev-yury, @Quintasan, @adamcrown).
+  - **Deprecation**: Setting the `:file_name` option for the uploader to a string is deprecated. It has to be set to a Proc or lambda that returns a string instead (@lebedev-yury).
+
 ## 2.3.5
 
   - Fixed issue with mongoid models, when `attribute_will_change!` method was called, that wasn't defined in Mongoid models (credits to @cuongnm53)
 
+## 2.3.4
+
+  - Installation on the windows platform is fixed.
+
 ## 2.3.3
 
   - Added proc support for the `:file_name` option for the `mount_base64_uploader` method. (credits to @hendricius)

data/README.md

@@ -8,7 +8,7 @@ Upload files encoded as base64 to carrierwave.
 
 This small gem can be useful for API's that interact with mobile devices.
 
-As of version 2.3.0, this gem requires Ruby 2.0 or higher
+This gem requires Ruby 2.0 or higher.
 
 ## Installation
 
@@ -34,18 +34,28 @@ mount_base64_uploader :image, ImageUploader
 
 Now you can also upload files by passing an encoded base64 string to the attribute.
 
+## Upload file extension
+
+The file extension for the uploaded base64 string is identified automatically using the [mime-types](https://github.com/mime-types/ruby-mime-types/) gem and `content_type` from the uploaded string.
+
+If the required MIME type is not registered, you can add it, using [MIME::Types#add](http://www.rubydoc.info/gems/mime-types/MIME/Types#add-class_method).
+
 ## Setting the file name
 
-To set the file name for the uploaded files, use the `:file_name` option (without extention):
+You can set the `file_name` option to a lambda, that will return a filename without an extension, using the model instance:
 
 ```ruby
-mount_base64_uploader :image, ImageUploader, file_name: 'userpic'
+mount_base64_uploader :image, ImageUploader, file_name: -> (u) { u.username }
 ```
 
-You can also pass a Proc for the file-name to allow dynamic filenames.
+**[DEPRECATED: Settings this option to a string is deprecated, if you still want to set the filename to a fixed string, wrap it in a Proc]** To set the file name for the uploaded files, use the `:file_name` option (without extention):
 
 ```ruby
-mount_base64_uploader :image, ImageUploader, file_name: -> { "file-#{DateTime.now.to_i}" }
+# Deprecated way:
+mount_base64_uploader :image, ImageUploader, file_name: 'userpic'
+
+# New way
+mount_base64_uploader :image, ImageUploader, file_name: -> { 'userpic' }
 ```
 
 ## Data format

data/carrierwave-base64.gemspec

@@ -20,15 +20,16 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'carrierwave', ['>= 0.8.0']
+  spec.add_dependency 'carrierwave', '>= 0.8.0'
+  spec.add_dependency 'mime-types', '~> 3.0'
 
   spec.add_development_dependency 'rails', '>= 3.2.0'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'mongoid'
   spec.add_development_dependency 'carrierwave-mongoid'
   spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', ['~> 10.0']
-  spec.add_development_dependency 'rspec', ['~> 2.14']
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 2.14'
   spec.add_development_dependency 'sham_rack'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rubocop'

data/lib/carrierwave/base64.rb

@@ -1,3 +1,4 @@
+require 'mime/types/full'
 require 'carrierwave/base64/version'
 require 'carrierwave/base64/base64_string_io'
 require 'carrierwave/base64/adapter'

data/lib/carrierwave/base64/adapter.rb

@@ -1,7 +1,8 @@
 module Carrierwave
   module Base64
     module Adapter
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
       def mount_base64_uploader(attribute, uploader_class, options = {})
         mount_uploader attribute, uploader_class, options
 
@@ -13,11 +14,16 @@ module Carrierwave
           return super(data) unless data.is_a?(String) &&
                                     data.strip.start_with?('data')
 
+          options[:file_name] ||= -> { attribute }
+          if options[:file_name].is_a?(Proc) && options[:file_name].arity == 1
+            options[:file_name] = options[:file_name].curry[self]
+          end
           super(Carrierwave::Base64::Base64StringIO.new(
-            data.strip, options[:file_name] || 'file'
+            data.strip, options[:file_name]
           ))
         end
-        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+        # rubocop:enable Metrics/CyclomaticComplexity
       end
     end
   end

data/lib/carrierwave/base64/base64_string_io.rb

@@ -3,37 +3,46 @@ module Carrierwave
     class Base64StringIO < StringIO
       class ArgumentError < StandardError; end
 
-      attr_accessor :file_format, :file_name
+      attr_accessor :file_extension, :file_name
 
-      def initialize(encoded_file, file_name_method_or_string)
+      def initialize(encoded_file, file_name_proc_or_string)
         description, encoded_bytes = encoded_file.split(',')
 
         raise ArgumentError unless encoded_bytes
         raise ArgumentError if encoded_bytes.eql?('(null)')
 
-        @file_name = extract_file_name(file_name_method_or_string)
-        @file_format = get_file_format description
+        @file_name = extract_file_name(file_name_proc_or_string)
+        @file_extension = get_file_extension description
         bytes = ::Base64.decode64 encoded_bytes
 
         super bytes
       end
 
       def original_filename
-        File.basename("#{@file_name}.#{@file_format}")
+        File.basename("#{@file_name}.#{@file_extension}")
       end
 
       private
 
-      def get_file_format(description)
-        regex = /([a-z0-9]+);base64\z/
-        regex.match(description).try(:[], 1)
+      def get_file_extension(description)
+        content_type = description.split(';base64').first
+        mime_type = MIME::Types[content_type].first
+        unless mime_type
+          raise ArgumentError, "Unknown MIME type: #{content_type}"
+        end
+        mime_type.preferred_extension
       end
 
-      def extract_file_name(method_or_string)
-        if method_or_string.is_a?(Proc)
-          method_or_string.call
+      def extract_file_name(proc_or_string)
+        if proc_or_string.is_a?(Proc)
+          proc_or_string.call
         else
-          method_or_string
+          warn(
+            '[Deprecation warning] Setting `file_name` option to a string is '\
+            'deprecated and will be removed in 2.5.0. If you want to keep the '\
+            'existing behaviour, wrap the string in a Proc'
+          )
+          proc_or_string
         end
       end
     end

data/lib/carrierwave/base64/version.rb

@@ -1,5 +1,5 @@
 module Carrierwave
   module Base64
-    VERSION = '2.3.5'.freeze
+    VERSION = '2.4.0'.freeze
   end
 end

data/spec/adapter_spec.rb

@@ -3,8 +3,10 @@ RSpec.describe Carrierwave::Base64::Adapter do
     let(:uploader) { Class.new CarrierWave::Uploader::Base }
 
     subject do
-      Post.mount_base64_uploader(:image, uploader)
-      Post.new
+      User.mount_base64_uploader(
+        :image, uploader, file_name: ->(u) { u.username }
+      )
+      User.new
     end
 
     let(:mongoid_model) do
@@ -52,7 +54,7 @@ RSpec.describe Carrierwave::Base64::Adapter do
 
         expect(
           subject.image.current_path
-        ).to eq file_path('../uploads', 'file.jpg')
+        ).to eq file_path('../uploads', 'batman.jpeg')
       end
 
       it 'sets will_change for the attribute' do

data/spec/base64_string_io_spec.rb

@@ -1,26 +1,29 @@
 RSpec.describe Carrierwave::Base64::Base64StringIO do
-  %w(image/jpg application/pdf audio/mp3).each do |content_type|
+  %w(application/vnd.openxmlformats-officedocument.wordprocessingml.document
+     image/jpeg application/pdf audio/mpeg).each do |content_type|
     context "correct #{content_type} data" do
       let(:data) do
         "data:#{content_type};base64,/9j/4AAQSkZJRgABAQEASABKdhH//2Q=="
       end
 
-      let(:file_format) { content_type.split('/').last }
+      let(:file_extension) do
+        MIME::Types[content_type].last.preferred_extension
+      end
 
       subject { described_class.new data, 'file' }
 
       it 'determines the file format from the Data URI content type' do
-        expect(subject.file_format).to eql(file_format)
+        expect(subject.file_extension).to eql(file_extension)
       end
 
       it 'should respond to :original_filename' do
-        expect(subject.original_filename).to eql("file.#{file_format}")
+        expect(subject.original_filename).to eql("file.#{file_extension}")
       end
 
       it 'calls a function that returns the file_name' do
-        method = -> { 'file-name-through-method' }
-        model = described_class.new data, method
-        expect(model.file_name).to eql('file-name-through-method')
+        method = ->(u) { u.username }
+        base64_string_io = described_class.new data, method.curry[User.new]
+        expect(base64_string_io.file_name).to eql('batman')
       end
 
       it 'accepts a string as the file name as well' do
@@ -39,7 +42,7 @@ RSpec.describe Carrierwave::Base64::Base64StringIO do
 
     it 'raises ArgumentError if base64 data eql (null)' do
       expect do
-        described_class.new('data:image/jpg;base64,(null)', 'file')
+        described_class.new('data:image/jpeg;base64,(null)', 'file')
       end.to raise_error(Carrierwave::Base64::Base64StringIO::ArgumentError)
     end
   end

data/spec/fixtures/base64_image.fixture

@@ -1 +1 @@
-data:image/jpg;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==
+data:image/jpeg;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==

data/spec/support/models.rb

@@ -1,4 +1,7 @@
-class Post < ActiveRecord::Base
+class User < ActiveRecord::Base
+  def username
+    'batman'
+  end
 end
 
 class MongoidModel

data/spec/support/schema.rb

@@ -1,7 +1,7 @@
 ActiveRecord::Schema.define do
   self.verbose = false
 
-  create_table 'posts', force: :cascade do |t|
+  create_table 'users', force: :cascade do |t|
     t.string   'image'
     t.datetime 'created_at', null: false
     t.datetime 'updated_at', null: false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-base64
 version: !ruby/object:Gem::Version
-  version: 2.3.5
+  version: 2.4.0
 platform: ruby
 authors:
 - Yury Lebedev
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement