carrierwave_image_validate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d4e6687cb57405b03e4502457665c3def7191da03bdbe108f8c0d8741d1ca3d
+  data.tar.gz: cd6220b2222b442b73e37b48d2bd9a439d655653bd61b19da610645a172f116a
+SHA512:
+  metadata.gz: 5a323f1dd395a81a1755ba045f620c9f72e26ce91af7a25b2f523868dcb66391a31a3bcae46b8ef24ad475d580df09fe588e5fbab77050119659b76f73bf5764
+  data.tar.gz: d908b20c18110ea857c176fcd86e235e923150e979e58ee5809137ded7fb475222e6bb6da14cd320e7215135c1a363408139e588ec5bd743ae2de3147131a2a9

data/README.md

@@ -0,0 +1,62 @@
+# Carrierwave Image Validate
+
+[![Gem Version](http://img.shields.io/gem/v/gems.svg)][gem]
+[![Build Status](https://github.com/rubygems/gems/workflows/ubuntu/badge.svg)][gh-actions]
+[![Code Climate](https://api.codeclimate.com/v1/badges/45ff982a29d7a000ee84/maintainability)][codeclimate]
+
+[gem]: https://rubygems.org/gems/gems
+[gh-actions]: https://github.com/rubygems/gems/actions
+[codeclimate]: https://codeclimate.com/github/rubygems/gems/maintainability
+
+If you are using carrierwave gem to upload file and you want to add ratio validations for image
+In the future, we will add more validations
+
+
+## What it can do
+
+- Validate ratio image by range
+
+## Usage
+
+```ruby
+class User < ApplicationRecord
+  mount_uploader :avatar, AvatarUploader
+  validates :avatar, image: { ratio_range: 1..1 }
+end
+```
+
+- avatar is your field def
+- ratio_range is a option of validate.
+
+## Internationalization
+
+Carrierwave Image Validate uses I18n for error messages
+For this, add these keys in your translation file:
+
+```yml
+en:
+  errors:
+    messages:
+      aspect_ratio_is_not: "must have an aspect ratio of %{aspect_ratio}"
+      aspect_ratio_unknown: "has an unknown aspect ratio"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+// require to handle image
+gem 'mini_magick', '>= 4.9.5'
+// validate
+gem 'carrierwave_image_validate'
+```
+
+And then execute
+
+```sh
+$ bundle
+```
+
+## License
+Released under the MIT License. See the [LICENSE](https://github.com/rails/thor/blob/main/LICENSE.md) file for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/lupca/carrierwave_image_ratio_validation/matchers/#ratio_validator_matcher.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Big thank you to the paperclip validation matchers:
+# https://github.com/thoughtbot/paperclip/blob/v6.1.0/lib/paperclip/matchers/validate_attachment_size_matcher.rb
+module ActiveStorageValidations
+  module Matchers
+    def validate_size_of(name)
+      RatioValidatorMatcher.new(name)
+    end
+
+    class RatioValidatorMatcher
+      def initialize(attribute_name)
+        @attribute_name = attribute_name
+        @ratio_range = nil
+      end
+
+      def description
+        "validate image ratio of #{@attribute_name}"
+      end
+
+      def is_ratio_in range_ratio
+        @range_ratio = range_ratio
+        self
+      end
+
+      def matches?(subject)
+        @subject = subject.is_a?(Class) ? subject.new : subject
+        responds_to_methods && valid_ratio?
+      end
+
+      def failure_message
+        "is expected to validate file size of #{@attribute_name} to be between #{@low} and #{@high} bytes"
+      end
+
+      def failure_message_when_negated
+        "is expected to not validate file size of #{@attribute_name} to be between #{@low} and #{@high} bytes"
+      end
+
+      protected
+
+      def responds_to_methods
+        @subject.respond_to?(@attribute_name) &&
+          @subject.public_send(@attribute_name).respond_to?(:attach) &&
+          @subject.public_send(@attribute_name).respond_to?(:detach)
+      end
+
+      def valid_ratio?
+        @range_ratio.nil? || valid_with_ratio
+      end
+
+      def valid_with_ratio
+      end
+      # def lower_than_low?
+      #   @low.nil? || !passes_validation_with_size(@low - 1)
+      # end
+
+      # def higher_than_low?
+      #   @low.nil? || passes_validation_with_size(@low + 1)
+      # end
+
+      # def lower_than_high?
+      #   @high.nil? || @high == Float::INFINITY || passes_validation_with_size(@high - 1)
+      # end
+
+      # def higher_than_high?
+      #   @high.nil? || @high == Float::INFINITY || !passes_validation_with_size(@high + 1)
+      # end
+
+      def passes_validation_with_size(new_size)
+        io = Tempfile.new('Hello world!')
+        Matchers.stub_method(io, :size, new_size) do
+          @subject.public_send(@attribute_name).attach(io: io, filename: 'test.png', content_type: 'image/pg')
+          @subject.validate
+          @subject.errors.details[@attribute_name].all? { |error| error[:error] != :file_size_out_of_range }
+        end
+      end
+    end
+  end
+end

data/lib/lupca/carrierwave_image_validation.rb

@@ -0,0 +1,50 @@
+require 'active_model'
+require 'active_support/i18n'
+I18n.load_path += Dir[File.dirname(__FILE__) + "/locale/*.yml"]
+I18n.default_locale = :en
+
+module ActiveModel
+  module Validations
+    class ImageValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        @record = record
+        @attribute = attribute
+        @value = value
+        @options = options
+    
+        ratio_valid? if options[:ratio_range]
+      end
+
+      private
+
+      attr_reader :record, :attribute, :value, :options
+    
+      def ratio_valid?
+        return if value.blank?
+
+        if ratio_range = options[:ratio_range]
+          x = ratio_range.first
+          y = ratio_range.last
+
+          width = value.width
+          height = value.height
+          ratio = width.to_f / height
+
+          return if ratio_range.member?(ratio)
+      
+          add_error(record, attribute, :aspect_ratio_is_not, "#{x}x#{y}")
+        else
+          add_error(record, attribute, :aspect_ratio_unknown)
+        end
+      end
+
+
+      def add_error(record, attribute, type, interpolate = options[:with])
+        key = options[:message].presence || type
+        return if record.errors.added?(attribute, key)
+
+        record.errors.add(attribute, key, aspect_ratio: interpolate)
+      end
+    end    
+  end
+end

data/lib/lupca/locale/en.yml

@@ -0,0 +1,5 @@
+en:
+  errors:
+    messages:
+      aspect_ratio_is_not: "must have an aspect ratio of %{aspect_ratio}"
+      aspect_ratio_unknown: "has an unknown aspect ratio"

data/lib/lupca/locale/ja.yml

@@ -0,0 +1,5 @@
+ja:
+  errors:
+    messages:
+      aspect_ratio_is_not: "のアスペクト比は %{aspect_ratio} にしてください"
+      aspect_ratio_unknown: "のアスペクト比を取得できませんでした"

data/lib/lupca/locale/vi.yml

@@ -0,0 +1,5 @@
+vi:
+  errors:
+    messages:
+      aspect_ratio_is_not: "phải có tỉ lệ ảnh %{aspect_ratio}"
+      aspect_ratio_unknown: "tỉ lệ ảnh không xác định"

data/test/test_carrierwave_image_ratio_validation.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+require 'lupca/carrierwave_image_validation'
+
+class User::Test < ActiveSupport::TestCase
+  test 'aspect ratio valid' do
+    e = User.new
+    e.avatar = fixture_file_upload("image_150x150.png")
+    assert_equal e.valid?, true
+  end
+
+  test 'aspect ratio invalid width 600 x 800' do
+    e = User.new
+    e.avatar = fixture_file_upload('image_600x800.png')
+    assert !e.valid?
+    assert_equal e.errors.full_messages, ["Avatar must have an aspect ratio of 1x1"]
+  end
+
+  test 'aspect ratio invalid width 800 x 600' do
+    u = User.new
+    u.avatar = fixture_file_upload('image_800x600.png')
+    assert !u.valid?
+    assert_equal u.errors.full_messages, ["Avatar must have an aspect ratio of 1x1"]
+  end
+
+  # test 'aspect ratio invalid: not is image' do
+  #   e = User.new    
+  #   e.avatar = fixture_file_upload('test.html')
+  #   assert !e.valid?
+  #   assert_equal e.errors.full_messages, ["Avatar is not a valid image"]
+  # end
+end
+
+def image_150x150_file
+  { io: File.open(Rails.root.join('public', 'image_150x150.png')), filename: 'image_150x150_file.png', content_type: 'image/png' }
+end
+
+def image_800x600_file
+  { io: File.open(Rails.root.join('public', 'image_800x600.png')), filename: 'image_800x600_file.png', content_type: 'image/png' }
+end
+
+def image_600x800_file
+  { io: File.open(Rails.root.join('public', 'image_600x800.png')), filename: 'image_600x800_file.png', content_type: 'image/png' }
+end
+
+def html_file
+  { io: File.open(Rails.root.join('public', 'test.html')), filename: 'test.html', content_type: 'text/html' }
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: carrierwave_image_validate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dang Thanh Tung
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: combustion
+  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'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.9.5
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  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'
+- !ruby/object:Gem::Dependency
+  name: carrierwave
+  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'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  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: A validate image ratio gem for carrierwave
+email: dangthanhtung.open@gmail
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/lupca/carrierwave_image_ratio_validation/matchers/#ratio_validator_matcher.rb
+- lib/lupca/carrierwave_image_validation.rb
+- lib/lupca/locale/en.yml
+- lib/lupca/locale/ja.yml
+- lib/lupca/locale/vi.yml
+- test/test_carrierwave_image_ratio_validation.rb
+homepage: http://rubygems.org/gems/carrierwave_image_validate
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Image ratio validate!
+test_files:
+- test/test_carrierwave_image_ratio_validation.rb