formeze 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 797956c11fea269806464fd4a0ea221b74f0a54db569c5d73f3277737e7d6e27
-  data.tar.gz: b095c29110d1bed615009b469258eba3acb33930bd8d0a434658fc70daf7fd91
+  metadata.gz: 959c1584612e08ca4e490f77a71bef8e2f2be9c1db827dc2903335a7f8a340b2
+  data.tar.gz: 60d9b150269c308824e72282e5ea55b5bdb369f04cfe7120dec8f9a7764157bd
 SHA512:
-  metadata.gz: b02c13c677e38ab17d1db9557499d579431b7f33a72c3c3e0f49766bf4fa21daf04af7ff60f2740db92bbcb610e1b11792df90d55cd7a8e1776e3ad2efd6b785
-  data.tar.gz: 5cdb99967751d382b3e40ee8207c170494fed281c33ea779fa5fcc5b41a090514749f41d004c5bdeb8501e665124c888487cf75c36ab0851645e3c2a529a0458
+  metadata.gz: d19f682f89a2222e8043d9a4a3569ef8e977cf33070723e655a4e6268b2bce45e5b410608db0a8648731a4be55774fe7d89ca15d63da2ac7c7247bdba23c4e9d
+  data.tar.gz: fe373bbd667d964054c625e7d188721222f02d384de318184296a3fef6ed85da96443c1834649349792f33a6320e69ac29ad933b2b6e3d1a013233f6a067b30d

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 4.2.0
+
+* Fixed file validation for e.g. `.md` files sent as application/octet-stream
+
+* Fixed file validation for e.g. `.rtf` files sent as text/rtf
+
 # 4.1.0
 
 * Fixed compatibility with rack 3+

data/formeze.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'formeze'
-  s.version = '4.1.0'
+  s.version = '4.2.0'
   s.license = 'LGPL-3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']

data/lib/formeze/errors.rb

@@ -0,0 +1,11 @@
+module Formeze::Errors
+  SCOPE = [:formeze, :errors].freeze
+
+  def self.translate(error, default)
+    if defined?(I18n)
+      return I18n.translate(error, scope: SCOPE, default: default)
+    end
+
+    default
+  end
+end

data/lib/formeze/field.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+class Formeze::Field
+  include Formeze::Presence
+
+  attr_reader :name
+
+  def initialize(name, **options)
+    @name, @options = name, options
+  end
+
+  def validate_all(values, form)
+    size = 0
+
+    values.each do |value|
+      if String === value
+        validate(value, form)
+      else
+        validate_file(value, form)
+
+        size += value.size
+      end
+    end
+
+    form.add_error(self, :too_large, 'is too large') if maxsize? && size > maxsize
+  end
+
+  def validate(value, form)
+    value = Formeze.scrub(value, @options[:scrub])
+
+    if blank?(value)
+      form.add_error(self, :required, 'is required') if required?
+
+      value = blank_value if blank_value?
+    else
+      form.add_error(self, :not_multiline, 'cannot contain newlines') if !multiline? && value.lines.count > 1
+
+      form.add_error(self, :too_long, 'is too long') if too_long?(value)
+
+      form.add_error(self, :too_short, 'is too short') if too_short?(value)
+
+      form.add_error(self, :no_match, 'is invalid') if no_match?(value)
+
+      form.add_error(self, :bad_value, 'is invalid') if values? && !values.include?(value)
+    end
+
+    value = Array(form.send(name)).push(value) if multiple?
+
+    form.send(:"#{name}=", value)
+  end
+
+  def validate_file(object, form)
+    unless acceptable_file?(object)
+      form.add_error(self, :not_accepted, 'is not an accepted file type')
+    end
+
+    object = Array(form.send(name)).push(object) if multiple?
+
+    form.send(:"#{name}=", object)
+  end
+
+  BINARY = MIME::Types['application/octet-stream'].first
+
+  def acceptable_file?(object)
+    type = MIME::Types[object.content_type].first
+
+    types = MIME::Types.type_for(object.original_filename)
+
+    if type == BINARY
+      types.any? { |type| accept.include?(type) }
+    else
+      accept.include?(type) && types.include?(type)
+    end
+  end
+
+  def key
+    @key ||= @name.to_s
+  end
+
+  def key_required?
+    @options.fetch(:key_required) { true }
+  end
+
+  def label
+    @options.fetch(:label) { Formeze::Labels.translate(name) }
+  end
+
+  def required?
+    @options.fetch(:required) { true }
+  end
+
+  def multiline?
+    @options.fetch(:multiline) { false }
+  end
+
+  def multiple?
+    @options.fetch(:multiple) { false }
+  end
+
+  def maxsize?
+    @options.key?(:maxsize)
+  end
+
+  def maxsize
+    @options.fetch(:maxsize)
+  end
+
+  def accept
+    @accept ||= @options.fetch(:accept).split(',').flat_map { |type| MIME::Types[type] }
+  end
+
+  def too_long?(value)
+    value.chars.count > @options.fetch(:maxlength) { 64 }
+  end
+
+  def too_short?(value)
+    @options.key?(:minlength) && value.chars.count < @options.fetch(:minlength)
+  end
+
+  def no_match?(value)
+    @options.key?(:pattern) && value !~ @options[:pattern]
+  end
+
+  def blank_value?
+    @options.key?(:blank)
+  end
+
+  def blank_value
+    @options.fetch(:blank)
+  end
+
+  def values?
+    @options.key?(:values)
+  end
+
+  def values
+    @options.fetch(:values)
+  end
+
+  def defined_if?
+    @options.key?(:defined_if)
+  end
+
+  def defined_if
+    @options.fetch(:defined_if)
+  end
+
+  def defined_unless?
+    @options.key?(:defined_unless)
+  end
+
+  def defined_unless
+    @options.fetch(:defined_unless)
+  end
+end

data/lib/formeze/form.rb

@@ -0,0 +1,5 @@
+class Formeze::Form
+  def self.inherited(subclass)
+    Formeze.setup(subclass)
+  end
+end

data/lib/formeze/form_data.rb

@@ -0,0 +1,23 @@
+require 'cgi'
+
+module Formeze::FormData
+  class CGI < ::CGI
+    def env_table
+      @options[:request].env
+    end
+
+    def stdinput
+      @options[:request].body.tap do |body|
+        body.rewind if body.respond_to?(:rewind)
+      end
+    end
+  end
+
+  def self.parse(input)
+    if input.is_a?(String)
+      CGI.parse(input)
+    else
+      CGI.new(request: input).params
+    end
+  end
+end

data/lib/formeze/labels.rb

@@ -0,0 +1,13 @@
+module Formeze::Labels
+  SCOPE = [:formeze, :labels].freeze
+
+  def self.translate(name)
+    default = Formeze.label(name)
+
+    if defined?(I18n)
+      return I18n.translate(name, scope: SCOPE, default: default)
+    end
+
+    default
+  end
+end

data/lib/formeze/presence.rb

@@ -0,0 +1,11 @@
+module Formeze::Presence
+  REGEXP = /\S/
+
+  def present?(string)
+    string =~ REGEXP
+  end
+
+  def blank?(string)
+    string !~ REGEXP
+  end
+end

data/lib/formeze/validation.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class Formeze::Validation
+  include Formeze::Presence
+
+  def initialize(field, **kwargs, &block)
+    @field = field
+
+    @error = kwargs[:error] || :invalid
+
+    @precondition = kwargs[:if]
+
+    @block = block
+  end
+
+  def validates?(form)
+    @precondition ? form.instance_eval(&@precondition) : true
+  end
+
+  def field_value?(form)
+    present?(form.send(@field.name))
+  end
+
+  def field_errors?(form)
+    form.errors_on?(@field.name)
+  end
+
+  def validate(form)
+    if validates?(form) && field_value?(form) && !field_errors?(form)
+      return_value = if @block.arity == 1
+        @block.call(form.send(@field.name))
+      else
+        form.instance_eval(&@block)
+      end
+
+      form.add_error(@field, @error, 'is invalid') unless return_value
+    end
+  end
+end

data/lib/formeze.rb

@@ -1,210 +1,13 @@
 # frozen_string_literal: true
-require 'cgi'
 
 module Formeze
-  module Presence
-    REGEXP = /\S/
-
-    def present?(string)
-      string =~ REGEXP
-    end
-
-    def blank?(string)
-      string !~ REGEXP
-    end
-  end
-
-  private_constant :Presence
-
-  class Field
-    include Presence
-
-    attr_reader :name
-
-    def initialize(name, **options)
-      @name, @options = name, options
-    end
-
-    def validate_all(values, form)
-      size = 0
-
-      values.each do |value|
-        if String === value
-          validate(value, form)
-        else
-          validate_file(value, form)
-
-          size += value.size
-        end
-      end
-
-      form.add_error(self, error(:too_large, 'is too large')) if maxsize? && size > maxsize
-    end
-
-    def validate(value, form)
-      value = Formeze.scrub(value, @options[:scrub])
-
-      if blank?(value)
-        form.add_error(self, error(:required, 'is required')) if required?
-
-        value = blank_value if blank_value?
-      else
-        form.add_error(self, error(:not_multiline, 'cannot contain newlines')) if !multiline? && value.lines.count > 1
-
-        form.add_error(self, error(:too_long, 'is too long')) if too_long?(value)
-
-        form.add_error(self, error(:too_short, 'is too short')) if too_short?(value)
-
-        form.add_error(self, error(:no_match, 'is invalid')) if no_match?(value)
-
-        form.add_error(self, error(:bad_value, 'is invalid')) if values? && !values.include?(value)
-      end
-
-      value = Array(form.send(name)).push(value) if multiple?
-
-      form.send(:"#{name}=", value)
-    end
-
-    def validate_file(object, form)
-      type = MIME::Types[object.content_type].first
-
-      filename_type = MIME::Types.type_for(object.original_filename).first
-
-      if type.nil? || type != filename_type || !accept.include?(type)
-        form.add_error(self, error(:not_accepted, 'is not an accepted file type'))
-      end
-
-      object = Array(form.send(name)).push(object) if multiple?
-
-      form.send(:"#{name}=", object)
-    end
-
-    def error(key, default)
-      Formeze.translate(key, scope: ERRORS_SCOPE, default: default)
-    end
-
-    def key
-      @key ||= @name.to_s
-    end
-
-    def key_required?
-      @options.fetch(:key_required) { true }
-    end
-
-    def label
-      @options.fetch(:label) { Formeze.translate(name, scope: LABELS_SCOPE, default: Formeze.label(name)) }
-    end
-
-    def required?
-      @options.fetch(:required) { true }
-    end
-
-    def multiline?
-      @options.fetch(:multiline) { false }
-    end
-
-    def multiple?
-      @options.fetch(:multiple) { false }
-    end
-
-    def maxsize?
-      @options.key?(:maxsize)
-    end
-
-    def maxsize
-      @options.fetch(:maxsize)
-    end
-
-    def accept
-      @accept ||= @options.fetch(:accept).split(',').flat_map { |type| MIME::Types[type] }
-    end
-
-    def too_long?(value)
-      value.chars.count > @options.fetch(:maxlength) { 64 }
-    end
-
-    def too_short?(value)
-      @options.key?(:minlength) && value.chars.count < @options.fetch(:minlength)
-    end
-
-    def no_match?(value)
-      @options.key?(:pattern) && value !~ @options[:pattern]
-    end
-
-    def blank_value?
-      @options.key?(:blank)
-    end
-
-    def blank_value
-      @options.fetch(:blank)
-    end
-
-    def values?
-      @options.key?(:values)
-    end
-
-    def values
-      @options.fetch(:values)
-    end
-
-    def defined_if?
-      @options.key?(:defined_if)
-    end
-
-    def defined_if
-      @options.fetch(:defined_if)
-    end
-
-    def defined_unless?
-      @options.key?(:defined_unless)
-    end
-
-    def defined_unless
-      @options.fetch(:defined_unless)
-    end
-  end
-
-  class Validation
-    include Presence
-
-    def initialize(field, **kwargs, &block)
-      @field = field
-
-      @error = kwargs[:error] || :invalid
-
-      @precondition = kwargs[:if]
-
-      @block = block
-    end
-
-    def error_message
-      Formeze.translate(@error, scope: ERRORS_SCOPE, default: 'is invalid')
-    end
-
-    def validates?(form)
-      @precondition ? form.instance_eval(&@precondition) : true
-    end
-
-    def field_value?(form)
-      present?(form.send(@field.name))
-    end
-
-    def field_errors?(form)
-      form.errors_on?(@field.name)
-    end
-
-    def validate(form)
-      if validates?(form) && field_value?(form) && !field_errors?(form)
-        return_value = if @block.arity == 1
-          @block.call(form.send(@field.name))
-        else
-          form.instance_eval(&@block)
-        end
-
-        form.add_error(@field, error_message) unless return_value
-      end
-    end
-  end
+  autoload :Errors, 'formeze/errors'
+  autoload :Field, 'formeze/field'
+  autoload :Form, 'formeze/form'
+  autoload :FormData, 'formeze/form_data'
+  autoload :Labels, 'formeze/labels'
+  autoload :Presence, 'formeze/presence'
+  autoload :Validation, 'formeze/validation'
 
   module ClassMethods
     def fields
@@ -234,20 +37,6 @@ module Formeze
 
   class ValidationError < StandardError; end
 
-  class RequestCGI < CGI
-    def env_table
-      @options[:request].env
-    end
-
-    def stdinput
-      @options[:request].body.tap do |body|
-        body.rewind if body.respond_to?(:rewind)
-      end
-    end
-  end
-
-  private_constant :RequestCGI
-
   RAILS_FORM_KEYS = %w[utf8 authenticity_token commit]
 
   private_constant :RAILS_FORM_KEYS
@@ -266,11 +55,7 @@ module Formeze
     end
 
     def parse(input)
-      form_data = if String === input
-        CGI.parse(input)
-      else
-        RequestCGI.new(request: input).params
-      end
+      form_data = FormData.parse(input)
 
       self.class.fields.each_value do |field|
         next unless field_defined?(field)
@@ -307,7 +92,9 @@ module Formeze
       return self
     end
 
-    def add_error(field, message)
+    def add_error(field, message, default = nil)
+      message = Formeze::Errors.translate(message, default) unless default.nil?
+
       error = ValidationError.new("#{field.label} #{message}")
 
       errors << error
@@ -380,27 +167,9 @@ module Formeze
     end
   end
 
-  ERRORS_SCOPE = [:formeze, :errors].freeze
-
-  private_constant :ERRORS_SCOPE
-
-  LABELS_SCOPE = [:formeze, :labels].freeze
-
-  private_constant :LABELS_SCOPE
-
-  def self.translate(key, **options)
-    defined?(I18n) ? I18n.translate(key, **options) : options.fetch(:default)
-  end
-
   def self.setup(form)
     form.send :include, InstanceMethods
 
     form.extend ClassMethods
   end
-
-  class Form
-    def self.inherited(subclass)
-      Formeze.setup(subclass)
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formeze
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-11 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies: []
 description: Ruby gem for validating form data
 email:
@@ -22,6 +22,13 @@ files:
 - README.md
 - formeze.gemspec
 - lib/formeze.rb
+- lib/formeze/errors.rb
+- lib/formeze/field.rb
+- lib/formeze/form.rb
+- lib/formeze/form_data.rb
+- lib/formeze/labels.rb
+- lib/formeze/presence.rb
+- lib/formeze/validation.rb
 homepage: https://github.com/readysteady/formeze
 licenses:
 - LGPL-3.0
@@ -45,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: See description