file_validators 2.3.0 → 3.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0353fd8c53123663ec484c7172c2df4d572f95dd
-  data.tar.gz: b1eb811cfea7257288ff5e588621f78aeff39896
+  metadata.gz: 6738e978bc3966d2acd83590b2e77b240e005bed
+  data.tar.gz: 9fccf7c9b07a08f867582ed3c65aee9606018bd7
 SHA512:
-  metadata.gz: 002f91a5243bf85650572ecb80a5283a25aafd6cdda3d4e9fe19bba988f597f3db228e583dc113bb54fb1c7973bc0caa9fc409592f10ff1c75c075438959fcf7
-  data.tar.gz: a1860e71ee7054624f2cf368802e1af2ee302886ecfca99c0ff43b948c6cf3af3d9264e62b1c877220fb465c18a5df6e11b507d42dbe03c29612e0e2f8513dd7
+  metadata.gz: 59033aade86b442a9bd3eb3f8cbc61cf38c66452af71ba58471998e3c015a8b0ead2eba3275fd23a988c61f5cc8719b0dee7af0b099c0c25f7322d2be7775616
+  data.tar.gz: 90e211e12d9f5b3d9dc6aebecb4b3b84b853538d61eeb6ae8c014c9618d06fae927d0af7509aa5e616598034a54995e45a6e10fee8c03ad88c401e4a231c01bb

data/.rubocop.yml

@@ -0,0 +1,32 @@
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/MissingRespondToMissing:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 110
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'activemodel-3.2' do
   gem 'activemodel', '3.2.22.5'
   gem 'rack', '1.6.5'

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 3.0.0.beta1
+
+* [#29](https://github.com/musaffa/file_validators/pull/29) Upgrade cocaine to terrapin
+* Rubocop style guide
+
+# 2.3.0
+
+* [#19](https://github.com/musaffa/file_validators/pull/19) Return false with blank size
+* [#27](https://github.com/musaffa/file_validators/pull/27) Fix file size validator for ActiveStorage
+
 # 2.2.0-beta.1
 
 * [#17](https://github.com/musaffa/file_validators/pull/17) Now Supports multiple file uploads

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Declare your gem's dependencies in file_validators.gemspec.

data/README.md

@@ -39,7 +39,7 @@ class Profile
 
   attr_accessor :avatar
   validates :avatar, file_size: { less_than_or_equal_to: 100.kilobytes },
-                     file_content_type: { allow: ['image/jpeg', 'image/png'] } 
+                     file_content_type: { allow: ['image/jpeg', 'image/png'] }
 end
 ```
 ActiveRecord example:
@@ -67,23 +67,23 @@ validates :avatar, file_size: { less_than: 2.gigabytes }
 ```
 * `less_than_or_equal_to`: Less than or equal to a number in bytes or a proc that returns a number
 ```ruby
-validates :avatar, file_size: { less_than_or_equal_to: 50.bytes } 
+validates :avatar, file_size: { less_than_or_equal_to: 50.bytes }
 ```
 * `greater_than`: greater than a number in bytes or a proc that returns a number
 ```ruby
-validates :avatar, file_size: { greater_than: 1.byte } 
+validates :avatar, file_size: { greater_than: 1.byte }
 ```
 * `greater_than_or_equal_to`: Greater than or equal to a number in bytes or a proc that returns a number
 ```ruby
-validates :avatar, file_size: { greater_than_or_equal_to: 50.bytes } 
+validates :avatar, file_size: { greater_than_or_equal_to: 50.bytes }
 ```
-* `message`: Error message to display. With all the options above except `:in`, you will get `count` as a replacement. 
-With `:in` you will get `min` and `max` as replacements. 
+* `message`: Error message to display. With all the options above except `:in`, you will get `count` as a replacement.
+With `:in` you will get `min` and `max` as replacements.
 `count`, `min` and `max` each will have its value and unit together.
 You can write error messages without using any replacement.
 ```ruby
 validates :avatar, file_size: { less_than: 100.kilobytes,
-                                message: 'avatar should be less than %{count}' } 
+                                message: 'avatar should be less than %{count}' }
 ```
 ```ruby
 validates :document, file_size: { in: 1.kilobyte..1.megabyte,
@@ -172,7 +172,7 @@ validates :avatar, file_content_type: { allow: /^image\/.*/, exclude: ['image/pn
 This gem can use Unix file command to get the content type based on the content of the file rather
 than the extension. This prevents fake content types inserted in the request header.
 
-It also prevents file media type spoofing. For example, user may upload a .html document as 
+It also prevents file media type spoofing. For example, user may upload a .html document as
 a part of the EXIF header of a valid JPEG file. Content type validator will identify its content type
 as `image/jpeg` and, without spoof detection, it may pass the validation and be saved as .html document
 thus exposing your application to a security vulnerability. Media type spoof detector wont let that happen.
@@ -180,7 +180,7 @@ It will not allow a file having `image/jpeg` content type to be saved as `text/p
 type mismatch, for example `text` of `text/plain` and `image` of `image/jpeg`. So it will not prevent
 `image/jpeg` from saving as `image/png` as both have the same `image` media type.
 
-**note**: This security feature is disabled by default. To enable it, first add `cocaine` gem in
+**note**: This security feature is disabled by default. To enable it, first add `terrapin` gem in
 your Gemfile and then add `mode: :strict` option in [content type validations](#file-content-type-validator).
 `:strict` mode may not work in direct file uploading systems as the file is not passed along with the form.
 
@@ -254,6 +254,7 @@ uploaders start processing a file immediately after its assignment (even before
 $ rake
 $ rake test:unit
 $ rake test:integration
+$ rubocop
 
 # test different active model versions
 $ bundle exec appraisal install

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -16,7 +18,7 @@ namespace :test do
   end
 end
 
-task :default => ['test:unit', 'test:integration']
+task default: ['test:unit', 'test:integration']
 
 # require 'rdoc/task'
 

data/file_validators.gemspec

@@ -1,4 +1,6 @@
-$:.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 require 'file_validators/version'
 
@@ -12,17 +14,18 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/musaffa/file_validators'
   s.license     = 'MIT'
 
-  s.files         = `git ls-files`.split($/)
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files    = s.files.grep(%r{^spec/})
-  s.require_paths  = ['lib']
+  s.require_paths = ['lib']
 
   s.add_dependency 'activemodel', '>= 3.2'
   s.add_dependency 'mime-types', '>= 1.0'
 
-  s.add_development_dependency 'cocaine', '~> 0.5.4'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '~> 3.5.0'
   s.add_development_dependency 'coveralls'
   s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 3.5.0'
+  s.add_development_dependency 'rubocop', '~> 0.58.2'
+  s.add_development_dependency 'terrapin', '~> 0.6'
 end

data/gemfiles/activemodel_3.2.gemfile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "appraisal"
-gem "activemodel", "3.2.22.5"
-gem "rack", "1.6.5"
+gem 'appraisal'
+gem 'activemodel', '3.2.22.5'
+gem 'rack', '1.6.5'
 
-gemspec :path => "../"
+gemspec path: '../'

data/gemfiles/activemodel_4.0.gemfile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "appraisal"
-gem "activemodel", "4.0.13"
-gem "rack", "1.6.5"
+gem 'appraisal'
+gem 'activemodel', '4.0.13'
+gem 'rack', '1.6.5'
 
-gemspec :path => "../"
+gemspec path: '../'

data/gemfiles/activemodel_4.1.gemfile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "appraisal"
-gem "activemodel", "4.1.6"
-gem "rack", "1.6.5"
+gem 'appraisal'
+gem 'activemodel', '4.1.6'
+gem 'rack', '1.6.5'
 
-gemspec :path => "../"
+gemspec path: '../'

data/gemfiles/activemodel_4.2.gemfile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "appraisal"
-gem "activemodel", "4.2.7.1"
-gem "rack", "1.6.5"
+gem 'appraisal'
+gem 'activemodel', '4.2.7.1'
+gem 'rack', '1.6.5'
 
-gemspec :path => "../"
+gemspec path: '../'

data/gemfiles/activemodel_5.0.gemfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # This file was generated by Appraisal
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem "appraisal"
-gem "activemodel", "5.0.1"
+gem 'appraisal'
+gem 'activemodel', '5.0.1'
 
-gemspec :path => "../"
+gemspec path: '../'

data/lib/file_validators.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_model'
 require 'ostruct'
 
@@ -10,7 +12,7 @@ module FileValidators
   end
 end
 
-Dir[File.dirname(__FILE__) + "/file_validators/validators/*.rb"].each { |file| require file }
+Dir[File.dirname(__FILE__) + '/file_validators/validators/*.rb'].each { |file| require file }
 
 locale_path = Dir.glob(File.dirname(__FILE__) + '/file_validators/locale/*.yml')
 I18n.load_path += locale_path unless I18n.load_path.include?(locale_path)

data/lib/file_validators/utils/content_type_detector.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 begin
-  require 'cocaine'
+  require 'terrapin'
 rescue LoadError
-  puts "file_validators requires 'cocaine' gem as you are using file content type validations in strict mode"
+  puts "file_validators requires 'terrapin' gem as you are using" \
+       ' file content type validations in strict mode'
 end
 
 module FileValidators
   module Utils
-
     class ContentTypeDetector
       EMPTY_CONTENT_TYPE = 'inode/x-empty'
       DEFAULT_CONTENT_TYPE = 'application/octet-stream'
@@ -50,18 +52,15 @@ module FileValidators
       end
 
       def type_from_file_command
-        begin
-          Cocaine::CommandLine.new('file', '-b --mime-type :file').run(file: @file_path).strip
-        rescue Cocaine::CommandLineError => e
-          logger.info(e.message)
-          DEFAULT_CONTENT_TYPE
-        end
+        Terrapin::CommandLine.new('file', '-b --mime-type :file').run(file: @file_path).strip
+      rescue Terrapin::CommandLineError => e
+        logger.info(e.message)
+        DEFAULT_CONTENT_TYPE
       end
 
       def logger
         Logger.new(STDOUT)
       end
     end
-
   end
 end

data/lib/file_validators/utils/media_type_spoof_detector.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'mime/types'
 
 module FileValidators
   module Utils
-
     class MediaTypeSpoofDetector
       def initialize(content_type, file_name)
         @content_type = content_type
@@ -18,12 +19,12 @@ module FileValidators
       # for `image` of `image/png` match with `image` of `image/jpeg`.
 
       def spoofed?
-        has_extension? and media_type_mismatch?
+        extension? && media_type_mismatch?
       end
 
       private
 
-      def has_extension?
+      def extension?
         # the following code replaced File.extname(@file_name).present? because it cannot
         # return the extension of a extension-only file names, e.g. '.html', '.jpg' etc
         @file_name.split('.').length > 1
@@ -41,6 +42,5 @@ module FileValidators
         @content_type.split('/').first
       end
     end
-
   end
 end

data/lib/file_validators/validators/file_content_type_validator.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module ActiveModel
   module Validations
-
     class FileContentTypeValidator < ActiveModel::EachValidator
-      CHECKS = [:allow, :exclude].freeze
+      CHECKS = %i[allow exclude].freeze
 
       def self.helper_method_name
         :validates_file_content_type
@@ -10,16 +11,16 @@ module ActiveModel
 
       def validate_each(record, attribute, value)
         values = parse_values(value)
-        unless values.empty?
-          mode = option_value(record, :mode)
-          allowed_types = option_content_types(record, :allow)
-          forbidden_types = option_content_types(record, :exclude)
-
-          values.each do |value|
-            content_type = get_content_type(value, mode)
-            validate_whitelist(record, attribute, content_type, allowed_types)
-            validate_blacklist(record, attribute, content_type, forbidden_types)
-          end
+        return if values.empty?
+
+        mode = option_value(record, :mode)
+        allowed_types = option_content_types(record, :allow)
+        forbidden_types = option_content_types(record, :exclude)
+
+        values.each do |val|
+          content_type = get_content_type(val, mode)
+          validate_whitelist(record, attribute, content_type, allowed_types)
+          validate_blacklist(record, attribute, content_type, forbidden_types)
         end
       end
 
@@ -42,7 +43,7 @@ module ActiveModel
 
         value = JSON.parse(value) if value.is_a?(String)
 
-        Array.wrap(value).reject { |value| value.blank? }
+        Array.wrap(value).reject(&:blank?)
       end
 
       def get_file_path(value)
@@ -85,7 +86,7 @@ module ActiveModel
       end
 
       def validate_whitelist(record, attribute, content_type, allowed_types)
-        if allowed_types.present? and allowed_types.none? { |type| type === content_type }
+        if allowed_types.present? && allowed_types.none? { |type| type === content_type }
           mark_invalid record, attribute, :allowed_file_content_types, allowed_types
         end
       end
@@ -130,6 +131,5 @@ module ActiveModel
         validates_with FileContentTypeValidator, _merge_attributes(attr_names)
       end
     end
-
   end
 end

data/lib/file_validators/validators/file_size_validator.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module ActiveModel
   module Validations
-
     class FileSizeValidator < ActiveModel::EachValidator
       CHECKS = { in: :===,
                  less_than: :<,
@@ -14,22 +15,18 @@ module ActiveModel
 
       def validate_each(record, attribute, value)
         values = parse_values(value)
-        unless values.empty?
-          options.slice(*CHECKS.keys).each do |option, option_value|
-            option_value = option_value.call(record) if option_value.is_a?(Proc)
-            if values.any? { |v| not valid_size?(value_byte_size(v), option, option_value) }
-              record.errors.add(attribute,
-                                "file_size_is_#{option}".to_sym,
-                                filtered_options(values).merge!(detect_error_options(option_value)))
-            end
-          end
+        return if values.empty?
+
+        options.slice(*CHECKS.keys).each do |option, option_value|
+          check_errors(record, attribute, values, option, option_value)
         end
       end
 
       def check_validity!
         unless (CHECKS.keys & options.keys).present?
-          raise ArgumentError, 'You must at least pass in one of these options - :in, :less_than,
-                                :less_than_or_equal_to, :greater_than and :greater_than_or_equal_to'
+          raise ArgumentError, 'You must at least pass in one of these options' \
+                               ' - :in, :less_than, :less_than_or_equal_to,' \
+                               ' :greater_than and :greater_than_or_equal_to'
         end
 
         check_options(Numeric, options.slice(*(CHECKS.keys - [:in])))
@@ -46,7 +43,7 @@ module ActiveModel
 
         value = OpenStruct.new(value) if value.is_a?(Hash)
 
-        Array.wrap(value).reject { |value| value.blank? }
+        Array.wrap(value).reject(&:blank?)
       end
 
       def check_options(klass, options)
@@ -57,6 +54,18 @@ module ActiveModel
         end
       end
 
+      def check_errors(record, attribute, values, option, option_value)
+        option_value = option_value.call(record) if option_value.is_a?(Proc)
+        has_invalid_size = values.any? { |v| !valid_size?(value_byte_size(v), option, option_value) }
+        if has_invalid_size
+          record.errors.add(
+            attribute,
+            "file_size_is_#{option}".to_sym,
+            filtered_options(values).merge!(detect_error_options(option_value))
+          )
+        end
+      end
+
       def value_byte_size(value)
         if value.respond_to?(:byte_size)
           value.byte_size
@@ -82,7 +91,7 @@ module ActiveModel
 
       def detect_error_options(option_value)
         if option_value.is_a?(Range)
-          { min: human_size(option_value.min), max: human_size(option_value.max)  }
+          { min: human_size(option_value.min), max: human_size(option_value.max) }
         else
           { count: human_size(option_value) }
         end
@@ -92,12 +101,22 @@ module ActiveModel
         if defined?(ActiveSupport::NumberHelper) # Rails 4.0+
           ActiveSupport::NumberHelper.number_to_human_size(size)
         else
-          storage_units_format = I18n.translate(:'number.human.storage_units.format', :locale => options[:locale], :raise => true)
-          unit = I18n.translate(:'number.human.storage_units.units.byte', :locale => options[:locale], :count => size.to_i, :raise => true)
+          storage_units_format = I18n.translate(
+            :'number.human.storage_units.format',
+            locale: options[:locale],
+            raise: true
+          )
+
+          unit = I18n.translate(
+            :'number.human.storage_units.units.byte',
+            locale: options[:locale],
+            count: size.to_i,
+            raise: true
+          )
+
           storage_units_format.gsub(/%n/, size.to_i.to_s).gsub(/%u/, unit).html_safe
         end
       end
-
     end
 
     module HelperMethods
@@ -116,6 +135,5 @@ module ActiveModel
         validates_with FileSizeValidator, _merge_attributes(attr_names)
       end
     end
-
   end
 end