carrierwave-base64 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d46d2f9f96d23a40a168aa3a25f1d79475cac873e7b1e004153199aa12c11962
-  data.tar.gz: 77d81babfb99831edae4fc362010c13639a957b0ff56377420744f56de5eb029
+  metadata.gz: c9da0e56ae6151c3068b895309bd70f9bfba959b28785b8fafde064bfecc9047
+  data.tar.gz: b723fcc95905b624fdc54394129bd9629b8bc1aa781061fc992f6f2ec3405d6f
 SHA512:
-  metadata.gz: 8707ca4f1b52279e6c1f6a8eec3b576029fd1fd4641ecdf656e824afd697d7e04d94e54e9fc796df648f8626711d3f2a53cb3758f5cd04d8305f1bc20696114b
-  data.tar.gz: 856803d525d0d2b614ae21688e424de5c9f98ecad8dd1d39feb9509bed63d7f2fa3b68a80377bd0fbdb790f1f4c39a000bba5629aed6cded3f39fd523862988b
+  metadata.gz: ccb2e7e949025a1eb37ba1bea875219ea269b561f6783f44203ba3085f9e2455913f9e01eb540e54165d0f4e5cc371cae4009dc367a2a278d9f65b6d26c01dc0
+  data.tar.gz: a429b36e280b49ac842bcf26ccf73c096cce0a3a67129ee97a3c92fd391a38ffb3486220c947a9a243e8d7db7a4997b81cfad9b36d0e3c974ad451d6f1b71286

data/.rubocop.yml

@@ -4,3 +4,4 @@ Documentation:
 Metrics/BlockLength:
   Exclude:
     - "spec/**/*"
+    - "*.gemspec"

data/.travis.yml

@@ -1,16 +1,17 @@
 language: ruby
 
 rvm:
- - 2.1.10
  - 2.2.10
- - 2.3.7
- - 2.4.4
- - 2.5.1
+ - 2.3.8
+ - 2.4.5
+ - 2.5.2
  - ruby-head
+ - jruby-head
 
 matrix:
   allow_failures:
     - rvm: ruby-head
+    - rvm: jruby-head
 
 gemfile:
   - Gemfile

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # carrierwave-base64 changelog
 
+## 2.8.0
+
+ - Mime Type is now detected from file contents, falling back to the type, specified by the user. (#73, @justisb)
+
 ## 2.7.0
 
  - Railtie is not required by default, so the gem can be used in non Rails app (@sleepingstu)

data/README.md

@@ -1,8 +1,9 @@
 # Carrierwave::Base64
 
 [![Gem Version](https://badge.fury.io/rb/carrierwave-base64.svg)](http://badge.fury.io/rb/carrierwave-base64)
-[![Build Status](https://travis-ci.org/lebedev-yury/carrierwave-base64.svg?branch=master)](https://travis-ci.org/lebedev-yury/carrierwave-base64)
-[![Code Climate](https://codeclimate.com/github/lebedev-yury/carrierwave-base64/badges/gpa.svg)](https://codeclimate.com/github/lebedev-yury/carrierwave-base64)
+[![Build Status](https://travis-ci.org/y9v/carrierwave-base64.svg?branch=master)](https://travis-ci.org/y9v/carrierwave-base64)
+[![Code Climate](https://codeclimate.com/github/y9v/carrierwave-base64/badges/gpa.svg)](https://codeclimate.com/github/y9v/carrierwave-base64)
+[![Inch CI](https://inch-ci.org/github/y9v/carrierwave-base64.svg?branch=master)](https://inch-ci.org/github/y9v/carrierwave-base64)
 
 Upload files encoded as base64 to carrierwave.
 

data/carrierwave-base64.gemspec

@@ -21,15 +21,17 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'carrierwave', '>= 0.8.0'
   spec.add_dependency 'mime-types', '~> 3.0'
+  spec.add_dependency 'mimemagic', '~> 0.3.2'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'carrierwave-mongoid'
   spec.add_development_dependency 'mongoid'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rails', '~> 4'
+  spec.add_development_dependency 'rails', '~> 5'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 2.14'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'sham_rack'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'yard'
 end

data/lib/carrierwave/base64.rb

@@ -2,6 +2,7 @@ require 'mime/types/full'
 require 'carrierwave/base64/version'
 require 'carrierwave/base64/exceptions'
 require 'carrierwave/base64/base64_string_io'
+require 'carrierwave/base64/mounting_helper'
 require 'carrierwave/base64/adapter'
 require 'carrierwave/base64/railtie' if defined?(Rails)
 

data/lib/carrierwave/base64/adapter.rb

@@ -1,42 +1,32 @@
 module Carrierwave
   module Base64
+    # Module with .mount_base64_uploader method, that is mixed in to
+    # ActiveRecord::Base or Mongoid::Document::ClassMethods
     module Adapter
-      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/PerceivedComplexity
+      # Mounts the carrierwave uploader that can accept a base64 encoded
+      # string as input. It also accepts regular file uploads.
+      #
+      # @param attribute [Symbol] the attribute to mount this uploader on
+      # @param uploader_class [Carrierwave::Uploader] the uploader class to
+      #   mount
+      # @param options [Hash{Symbol => Object}] a set of options
+      # @option options [Proc] :file_name Proc that must return a file name
+      #   without extension
+      #
+      # @example Mount the uploader and specify the file name
+      #   mount_base64_uploader :image, ImageUploader,
+      #     file_name: -> (u) { u.username }
+      #
+      # @return [Symbol] the defined writer method name
       def mount_base64_uploader(attribute, uploader_class, options = {})
         mount_uploader attribute, uploader_class, options
         options[:file_name] ||= proc { attribute }
 
-        if options[:file_name].is_a?(String)
-          warn(
-            '[Deprecation warning] Setting `file_name` option to a string is '\
-            'deprecated and will be removed in 3.0.0. If you want to keep the '\
-            'existing behaviour, wrap the string in a Proc'
-          )
-        end
+        Carrierwave::Base64::MountingHelper.check_for_deprecations(options)
 
-        define_method "#{attribute}=" do |data|
-          return if data == send(attribute).to_s
-
-          if respond_to?("#{attribute}_will_change!") && data.present?
-            send "#{attribute}_will_change!"
-          end
-
-          return super(data) unless data.is_a?(String) &&
-                                    data.strip.start_with?('data')
-
-          filename = if options[:file_name].respond_to?(:call)
-                       options[:file_name].call(self)
-                     else
-                       options[:file_name]
-                     end.to_s
-
-          super Carrierwave::Base64::Base64StringIO.new(data.strip, filename)
-        end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
-        # rubocop:enable Metrics/CyclomaticComplexity
-        # rubocop:enable Metrics/PerceivedComplexity
+        Carrierwave::Base64::MountingHelper.define_writer(
+          self, attribute, options
+        )
       end
     end
   end

data/lib/carrierwave/base64/base64_string_io.rb

@@ -1,8 +1,28 @@
+require 'mimemagic'
+require 'mimemagic/overlay'
+
 module Carrierwave
   module Base64
+    # Class that decodes a base64 string, builds a StringIO for the
+    # decoded bytes, and extracts the file MIME type to build a file
+    # name with extension.
     class Base64StringIO < StringIO
-      attr_accessor :file_extension, :file_name
+      # @return [String] the file name without extension
+      attr_reader :file_name
+
+      # @return [String] the file extension for the uploaded file
+      attr_reader :file_extension
 
+      # Returns a StringIO with decoded bytes from the base64 encoded
+      # string and builds a file name with extension for the uploaded file,
+      # based on the MIME type specified in the base64 encoded string.
+      #
+      # @param encoded_file [String] the base64 encoded file contents
+      # @param file_name [String] the file name without extention
+      #
+      # @raise [ArgumentError] If the base64 encoded string is empty
+      #
+      # @return [StringIO] StringIO with decoded bytes
       def initialize(encoded_file, file_name)
         description, encoded_bytes = encoded_file.split(',')
 
@@ -10,21 +30,28 @@ module Carrierwave
         raise ArgumentError if encoded_bytes.eql?('(null)')
 
         @file_name = file_name
-        @file_extension = get_file_extension description
         bytes = ::Base64.decode64 encoded_bytes
+        @file_extension = get_file_extension description, bytes
 
         super bytes
       end
 
+      # Returns a file name with extension, based on the MIME type specified
+      # in the base64 encoded string.
+      #
+      # @return [String] File name with extention
       def original_filename
         File.basename("#{@file_name}.#{@file_extension}")
       end
 
       private
 
-      def get_file_extension(description)
-        content_type = description.split(';base64').first
-        mime_type = MIME::Types[content_type].first
+      # Determine content type from input, with provided type as fallback
+      def get_file_extension(description, bytes)
+        detected_type = MimeMagic.by_magic(bytes)
+        content_type = (detected_type && detected_type.type) ||
+                       description.split(';base64').first
+        mime_type = MIME::Types[content_type].last
         unless mime_type
           raise Carrierwave::Base64::UnknownMimeTypeError,
                 "Unknown MIME type: #{content_type}"

data/lib/carrierwave/base64/exceptions.rb

@@ -1,5 +1,7 @@
 module Carrierwave
   module Base64
+    # Exception that gets raised when base64 encoded string
+    # is of unknown MIME type
     class UnknownMimeTypeError < ::ArgumentError; end
   end
 end

data/lib/carrierwave/base64/mounting_helper.rb

@@ -0,0 +1,63 @@
+module Carrierwave
+  module Base64
+    # Module with helper functions for mounting uploaders
+    module MountingHelper
+      module_function
+
+      # Checks for deprecations and prints a warning if found any.
+      # @private
+      #
+      # @param options [Hash{Symbol => Object}] the uploader options
+      # @return [void]
+      def check_for_deprecations(options)
+        return unless options[:file_name].is_a?(String)
+
+        warn(
+          '[Deprecation warning] Setting `file_name` option to a string is '\
+          'deprecated and will be removed in 3.0.0. If you want to keep the '\
+          'existing behaviour, wrap the string in a Proc'
+        )
+      end
+
+      # Returns a file name for the uploaded file.
+      # @private
+      #
+      # @param model_instance [Object] the model instance object
+      # @param options [Hash{Symbol => Object}] the uploader options
+      # @return [String] File name without extension
+      def file_name(model_instance, options)
+        if options[:file_name].respond_to?(:call)
+          options[:file_name].call(model_instance)
+        else
+          options[:file_name]
+        end.to_s
+      end
+
+      # Defines an attribute writer method on the class with mounted uploader.
+      # @private
+      #
+      # @param klass [Class] the class with mounted uploader
+      # @param attr [Symbol] the attribute for which the writer will be defined
+      # @param options [Hash{Symbol => Object}] a set of options
+      # @return [Symbol] the defined writer method name
+      def define_writer(klass, attr, options)
+        klass.send(:define_method, "#{attr}=") do |data|
+          # rubocop:disable Lint/NonLocalExitFromIterator
+          return if data.to_s.empty? || data == send(attr).to_s
+
+          # rubocop:enable Lint/NonLocalExitFromIterator
+
+          send("#{attr}_will_change!") if respond_to?("#{attr}_will_change!")
+
+          return super(data) unless data.is_a?(String) &&
+                                    data.strip.start_with?('data')
+
+          super Carrierwave::Base64::Base64StringIO.new(
+            data.strip,
+            Carrierwave::Base64::MountingHelper.file_name(self, options)
+          )
+        end
+      end
+    end
+  end
+end

data/lib/carrierwave/base64/railtie.rb

@@ -1,5 +1,7 @@
 module Carrierwave
   module Base64
+    # Railtie class to load the carrierwave-base64 adapters
+    # Loads adapters for ActiveRecord and Mongoid
     class Railtie < Rails::Railtie
       ActiveSupport.on_load :active_record do
         ActiveRecord::Base.extend Carrierwave::Base64::Adapter

data/lib/carrierwave/base64/version.rb

@@ -1,5 +1,5 @@
 module Carrierwave
   module Base64
-    VERSION = '2.7.0'.freeze
+    VERSION = '2.8.0'.freeze
   end
 end

data/spec/adapter_spec.rb

@@ -30,11 +30,10 @@ RSpec.describe Carrierwave::Base64::Adapter do
 
         it 'creates a file' do
           subject.save!
-          subject.reload
 
           expect(
             subject.image.current_path
-          ).to eq file_path('../uploads', 'image.jpeg')
+          ).to eq file_path('../uploads', 'image.png')
         end
       end
     end
@@ -86,7 +85,6 @@ RSpec.describe Carrierwave::Base64::Adapter do
 
         it 'saves the file' do
           subject.save!
-          subject.reload
 
           expect(
             subject.image.current_path
@@ -103,11 +101,10 @@ RSpec.describe Carrierwave::Base64::Adapter do
 
         it 'creates a file' do
           subject.save!
-          subject.reload
 
           expect(
             subject.image.current_path
-          ).to eq file_path('../uploads', 'batman.jpeg')
+          ).to eq file_path('../uploads', 'batman.png')
         end
 
         it 'sets will_change for the attribute' do
@@ -126,10 +123,9 @@ RSpec.describe Carrierwave::Base64::Adapter do
           it 'should invoke the file_name proc upon each upload' do
             subject.save!
             another_subject.save!
-            another_subject.reload
             expect(
               another_subject.image.current_path
-            ).to eq file_path('../uploads', 'robin.jpeg')
+            ).to eq file_path('../uploads', 'robin.png')
           end
         end
       end
@@ -140,21 +136,39 @@ RSpec.describe Carrierwave::Base64::Adapter do
             file_path('fixtures', 'base64_image.fixture')
           ).strip
           subject.save!
-          subject.reload
         end
 
         it 'keeps the file when setting the attribute to existing value' do
-          expect(File.exist?(subject.reload.image.file.file)).to be_truthy
+          expect(File.exist?(subject.image.file.file)).to be_truthy
           subject.update!(image: subject.image.to_s)
-          expect(File.exist?(subject.reload.image.file.file)).to be_truthy
+          expect(File.exist?(subject.image.file.file)).to be_truthy
         end
 
         it 'removes files when remove_* is set to true' do
           subject.remove_image = true
           subject.save!
-          expect(subject.reload.image.file).to be_nil
+          expect(subject.image.file).to be_nil
         end
       end
     end
+
+    context 'models with presence validation on attribute with uploader' do
+      subject do
+        User.validates(:image, presence: true)
+        User.mount_base64_uploader(:image, uploader)
+        User.new
+      end
+
+      before(:each) do
+        subject.image = File.read(
+          file_path('fixtures', 'base64_image.fixture')
+        ).strip
+        subject.save!
+      end
+
+      it 'gives no false positive on presence validation' do
+        expect { subject.update!(username: 'new-username') }.not_to raise_error
+      end
+    end
   end
 end

data/spec/base64_string_io_spec.rb

@@ -2,17 +2,19 @@ RSpec.describe Carrierwave::Base64::Base64StringIO do
   %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_extension) do
         MIME::Types[content_type].last.preferred_extension
       end
 
+      let(:data) do
+        file_name = "test.#{file_extension}"
+        bytes = File.read(file_path('fixtures', file_name))
+        "data:#{content_type};base64,#{::Base64.encode64(bytes)}"
+      end
+
       subject { described_class.new data, 'file' }
 
-      it 'determines the file format from the Data URI content type' do
+      it 'determines the file format from the content type' do
         expect(subject.file_extension).to eql(file_extension)
       end
 

data/spec/fixtures/base64_image.fixture

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

data/spec/spec_helper.rb

@@ -14,7 +14,6 @@ require 'carrierwave/mongoid'
 
 require 'carrierwave/base64'
 
-ActiveRecord::Base.raise_in_transactional_callbacks = true
 ActiveRecord::Base.establish_connection(
   adapter: 'sqlite3',
   database: ':memory:'
@@ -29,3 +28,15 @@ def file_path(*paths)
 end
 
 CarrierWave.root = ''
+
+# Add preferred file types similar to how users would implement custom types
+content_types = {
+  'audio/mpeg' => 'mp3'
+}
+content_types.each do |content_type, extension|
+  MIME::Types.add(
+    MIME::Type.new(content_type).tap do |type|
+      type.preferred_extension = extension
+    end
+  )
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-base64
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Yury Lebedev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: This gem can be useful, if you need to upload files to your API from
   mobile devises.
 email:
@@ -200,12 +228,17 @@ files:
 - lib/carrierwave/base64/adapter.rb
 - lib/carrierwave/base64/base64_string_io.rb
 - lib/carrierwave/base64/exceptions.rb
+- lib/carrierwave/base64/mounting_helper.rb
 - lib/carrierwave/base64/railtie.rb
 - lib/carrierwave/base64/version.rb
 - spec/adapter_spec.rb
 - spec/base64_string_io_spec.rb
 - spec/fixtures/base64_image.fixture
-- spec/fixtures/test.jpg
+- spec/fixtures/test.docx
+- spec/fixtures/test.jpeg
+- spec/fixtures/test.mp3
+- spec/fixtures/test.pdf
+- spec/fixtures/test.png
 - spec/spec_helper.rb
 - spec/support/custom_expectations/warn_expectation.rb
 - spec/support/models.rb
@@ -230,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Upload images encoded as base64 to carrierwave.
@@ -238,7 +271,11 @@ test_files:
 - spec/adapter_spec.rb
 - spec/base64_string_io_spec.rb
 - spec/fixtures/base64_image.fixture
-- spec/fixtures/test.jpg
+- spec/fixtures/test.docx
+- spec/fixtures/test.jpeg
+- spec/fixtures/test.mp3
+- spec/fixtures/test.pdf
+- spec/fixtures/test.png
 - spec/spec_helper.rb
 - spec/support/custom_expectations/warn_expectation.rb
 - spec/support/models.rb