carrierwave-validators 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d347172e4e6f3a5ede040d51c5a90b126d1fa2ce
+  data.tar.gz: 36f835afa6820a19ca127ad15012dbc8fa188acb
+SHA512:
+  metadata.gz: b5a5debf8b3d40c51c4adf2fe8ec3dacb37dac7eeb09a4a86dad85cfa73e6d5dd18f60b572585c91d9ea119174252754e4ef8732bbd63fc9bc73ec803c1108e3
+  data.tar.gz: 2d10dac72b8c6a35761ecbe10377300f641bac79d54cab248b764cf80ded5b6bb91a0d6c758bc7d93cefb38f6aa6ecbb3fc7cf808d1eb5700d2bc446201303cf

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+spec/dummy/.bundle
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp
+spec/dummy/public/uploads
+spec/dummy/Gemfile.lock
+spec/dummy/public/assets

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+ - 1.9.3
+ - 2.0.0
+ - 2.1.1
+ - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## CarrierWave-Validators v0.0.1 
+   * Initial commit
+   * Added `SizeValidator` - Validates the file size of uploaded file

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in carrierwave-validators.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 kirtithorat
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+# CarrierWave-Validators
+
+CarrierWave extension to validate uploaded files.
+
+## Installation
+
+Install the latest stable release:
+
+    $[sudo] gem install carrierwave-validators
+
+In Rails, add it to your Gemfile:
+
+    gem 'carrierwave-validators'
+
+And then execute:
+
+    $ bundle
+
+Finally, restart the server to apply the changes.
+
+## Getting Started
+
+`Carrierwave-Validators` supports following validators to validate your attachment:
+
+* `SizeValidator` - Validates the file size of uploaded file
+
+## SizeValidator
+
+SizeValidator validates the **file size** of files uploaded using `CarrierWave`.
+
+Example Usage, in the model `User` with Carrierwave attachment `avatar`:
+
+    class User < ActiveRecord::Base
+      mount_uploader :avatar, AvatarUploader
+      validates :avatar, :size => { :in => 0..50.kilobytes } ## Validates if uploaded file is within 0 Bytes to 50 KiloBytes
+    end
+
+Alternatively,
+
+     validates :avatar, :size => { :in => 0..50.kilobytes }
+
+can be specified as
+
+     validates_file_size :avatar, :in => 0..50.kilobytes  
+
+Available options:
+
+* *in* : in between a Range of bytes , for example 
+
+        ## uploaded file size is within 0 Bytes to 50 KiloBytes
+        validates :avatar, :size => { :in => 0..50.kilobytes } 
+
+* *less_than* : less than a number in bytes, for example  
+
+        ## uploaded file size is less than 5 MegaBytes
+        validates :avatar, :size => { :less_than => 5.megabytes } 
+
+* *greater_than* : greater than a number in bytes, for example 
+
+        ## uploaded file size is greater than 5 KiloBytes
+        validates :avatar, :size => { :greater_than => 5.kilobytes } 
+
+* *less_than_or_equal_to* : less than or equal to a number in bytes, for example  
+
+        ## uploaded file size is less than or equal to 1 MegaByte
+        validates :avatar, :size => { :less_than_or_equal_to => 1.megabytes } 
+
+* *greater_than_or_equal_to* : greater than or equal to a number in bytes, for example  
+
+        ## uploaded file size is greater than or equal to 5 KiloBytes
+        validates :avatar, :size => { :greater_than_or_equal_to => 5.kilobytes } 
+
+* *message* : error message to display, for example  
+
+         validates :avatar, :size => { :in => 0..50.kilobytes, :message => "Your custom error message" }   
+
+#i18n
+
+The Active Record validations use the Rails i18n framework. Include the following keys in your translation files:
+
+    en:
+      errors:
+        messages:
+          in: "file size must be in between %{min} %{min_unit} and %{max} %{max_unit}"
+          greater_than: "file size must be greater than %{count} %{unit}"
+          greater_than_or_equal_to: "file size must be greater than or equal to %{count} %{unit}"
+          less_than: "file size must be less than %{count} %{unit}"
+          less_than_or_equal_to: "file size must be less than or equal to %{count} %{unit}"
+
+      size:
+        units:
+        one: "Byte"
+        other: "Bytes"
+
+## TODO
+
+* Add content-type validation        
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/carrierwave-validators.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'carrierwave/validators/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "carrierwave-validators"
+  spec.version       = CarrierWave::Validators::VERSION
+  spec.authors       = ["Kirti Thorat"]
+  spec.email         = ["kirti.brenz@gmail.com"]
+  spec.summary       = %q{CarrierWave extension for validating uploaded files.}
+  spec.description   = %q{CarrierWave extension to validate files uploaded using carrierwave.}
+  spec.homepage      = "https://github.com/kirtithorat/carrierwave-validators"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_dependency "rails", ">= 3.2.0"
+  spec.add_dependency "carrierwave", [">= 0.8.0", "< 0.11.0"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.2.2"
+  spec.add_development_dependency "sqlite3", "~> 1.3.9"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "database_cleaner", "~> 1.2.0"
+end

data/lib/carrierwave/validators.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'carrierwave/validators/all'
+require 'active_support/concern'
+
+module CarrierWave
+  module Validators
+
+    extend ActiveSupport::Concern
+
+    included do
+      extend HelperMethods
+      include HelperMethods
+    end
+
+  end
+end

data/lib/carrierwave/validators/all.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require "carrierwave/validators/version"
+require "carrierwave/validators/error"
+
+if defined? Rails
+  require "carrierwave/validators/railtie"
+  require "carrierwave/validators/size_validator"
+end

data/lib/carrierwave/validators/error.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Validators
+    class InvalidAttributeError < StandardError; end
+    class InvalidOptionError < StandardError; end
+  end
+end

data/lib/carrierwave/validators/locales/en.yml

@@ -0,0 +1,13 @@
+en:
+  errors:
+    messages:
+      in: "file size must be in between %{min} %{min_unit} and %{max} %{max_unit}"
+      greater_than: "file size must be greater than %{count} %{unit}"
+      greater_than_or_equal_to: "file size must be greater than or equal to %{count} %{unit}"
+      less_than: "file size must be less than %{count} %{unit}"
+      less_than_or_equal_to: "file size must be less than or equal to %{count} %{unit}"
+
+  size:
+    units:
+      one: "Byte"
+      other: "Bytes"

data/lib/carrierwave/validators/railtie.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module CarrierWave
+  class Railtie < Rails::Railtie
+    initializer 'carrierwave.validators' do
+      ActiveSupport.on_load :active_record do
+        include Validators
+      end
+
+      locale_path = Dir.glob(File.dirname(__FILE__) + "/locales/*.{rb,yml}")
+      I18n.load_path += locale_path unless I18n.load_path.include?(locale_path)
+    end
+  end
+end

data/lib/carrierwave/validators/size_validator.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+require 'active_model/validations/numericality'
+
+module CarrierWave
+  module Validators
+
+    class SizeValidator < ActiveModel::Validations::NumericalityValidator
+      AVAILABLE_CHECKS = [:less_than, :less_than_or_equal_to, :greater_than, :greater_than_or_equal_to].freeze
+
+      def initialize(options)
+        extract_options(options)
+        super
+      end
+
+      def validate_each(record, attribute, value)
+        unless value.blank?
+          raise(CarrierWave::Validators::InvalidAttributeError, "A CarrierWave::Uploader::Base object was expected") unless value.kind_of? CarrierWave::Uploader::Base
+          value = value.respond_to?(:length) ? value.length : value.to_s.length
+
+          options.slice(*AVAILABLE_CHECKS).each do |option, option_value|
+            unless value.send(CHECKS[option], option_value)
+              error_message_key = options[:in] ? :in : option
+              record.errors.add(attribute, error_message_key, filtered_options(value).merge!(detect_error_options(option, option_value)))
+            end
+          end
+        end
+      end
+
+      def check_validity!
+        unless (AVAILABLE_CHECKS + [:in]).any? { |argument| options.has_key?(argument) }
+          raise CarrierWave::Validators::InvalidOptionError, "List of allowed options - [:in, :less_than, :greater_than, :less_than_or_equal_to, :greater_than_or_equal_to]"
+        end
+
+        options.slice(*AVAILABLE_CHECKS).each do |option, value|
+          isNumeric = value.is_a?(Numeric)
+
+          unless isNumeric && value >= 0
+            error_message = options[:in] ? ":in value must be in a non-negative Range" : ":#{option} value must be a non-negative Number"
+            raise CarrierWave::Validators::InvalidOptionError, error_message
+          end
+
+          if isNumeric && value == 0 && ([:less_than, :less_than_or_equal_to].include? option)
+            error_message = options[:in] ? "Invalid value for :in option. Lower bound must be greater than 0." : "Invalid value for :#{option} option. It must be greater than 0."
+            raise CarrierWave::Validators::InvalidOptionError, error_message
+          end
+
+        end
+      end
+
+      private
+
+      def extract_options(options)
+        if range = options[:in]
+          raise CarrierWave::Validators::InvalidOptionError, ":in must be a Range" unless range.is_a?(Range)
+          clear_options(options)
+          options[:less_than_or_equal_to], options[:greater_than_or_equal_to] = range.max, range.min
+        end
+      end
+
+      def clear_options(options)
+        AVAILABLE_CHECKS.each do |option|
+          options.delete(option)
+        end
+      end
+
+      def detect_error_options(option, option_value)
+        if options[:in]
+          max = options[:less_than_or_equal_to]
+          min =  options[:greater_than_or_equal_to]
+          error_options = { min: min, max: max, min_unit: detect_unit(min), max_unit: detect_unit(max) }
+        else
+          error_options = { count: option_value, unit: detect_unit(option_value) }
+        end
+      end
+
+      def detect_unit(option_value)
+        I18n.translate(:"size.units", count: option_value, :raise => true )
+      end
+
+    end
+
+    module HelperMethods
+      # Places ActiveModel validations on the size of the file assigned. The
+      # possible options are:
+      # * +in+: in between a Range of bytes 
+      # * +less_than+: less than a number in bytes 
+      # * +greater_than+: greater than a number in bytes 
+      # * +less_than_or_equal_to+: less than or equal to a number in bytes
+      # * +greater_than_or_equal_to+: greater than or equal to a number in bytes
+      # * +message+: error message to display, use :min and :max as replacements
+      def validates_file_size(*attr_names)
+        validates_with SizeValidator, _merge_attributes(attr_names)
+      end
+    end
+
+  end
+end

data/lib/carrierwave/validators/version.rb

@@ -0,0 +1,5 @@
+module CarrierWave
+  module Validators
+    VERSION = "0.0.1"
+  end
+end

data/spec/dummy/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/spec/dummy/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'rails', '4.0.2'
+gem 'sass-rails', '~> 4.0.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'coffee-rails', '~> 4.0.0'
+gem 'jquery-rails'
+gem 'turbolinks'
+gem 'jbuilder', '~> 1.2'
+gem 'carrierwave'
+gem 'carrierwave-validators', path: "../..", :require => 'carrierwave/validators'
+group :development, :test do
+  gem 'sqlite3', "~> 1.3.9"
+  gem 'rspec-rails', '~> 2.14.2'
+end

data/spec/dummy/README.md

@@ -0,0 +1,5 @@
+# Dummy
+
+"Dummy" web application to add image cropping and image preview feature to "CarrierWave Uploaded Images".
+
+by [Kirti Thorat]

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,17 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .
+