formeze 2.1.0 → 4.0.0

data/lib/formeze.rb

@@ -1,20 +1,53 @@
+# 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 = {})
+    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 value !~ /\S/
+      if blank?(value)
         form.add_error(self, error(:required, 'is required')) if required?
 
-        form.send(:"#{name}=", blank_value? ? blank_value : value)
+        value = blank_value if blank_value?
       else
         form.add_error(self, error(:not_multiline, 'cannot contain newlines')) if !multiline? && value.lines.count > 1
 
@@ -25,13 +58,29 @@ module Formeze
         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
 
-        form.send(:"#{name}=", value)
+      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 => [:formeze, :errors], :default => default)
+      Formeze.translate(key, scope: ERRORS_SCOPE, default: default)
     end
 
     def key
@@ -43,7 +92,7 @@ module Formeze
     end
 
     def label
-      @options.fetch(:label) { Formeze.translate(name, :scope => [:formeze, :labels], :default => Formeze.label(name)) }
+      @options.fetch(:label) { Formeze.translate(name, scope: LABELS_SCOPE, default: Formeze.label(name)) }
     end
 
     def required?
@@ -58,20 +107,32 @@ module Formeze
       @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.has_key?(:minlength) && value.chars.count < @options.fetch(:minlength)
+      @options.key?(:minlength) && value.chars.count < @options.fetch(:minlength)
     end
 
     def no_match?(value)
-      @options.has_key?(:pattern) && value !~ @options[:pattern]
+      @options.key?(:pattern) && value !~ @options[:pattern]
     end
 
     def blank_value?
-      @options.has_key?(:blank)
+      @options.key?(:blank)
     end
 
     def blank_value
@@ -79,7 +140,7 @@ module Formeze
     end
 
     def values?
-      @options.has_key?(:values)
+      @options.key?(:values)
     end
 
     def values
@@ -87,7 +148,7 @@ module Formeze
     end
 
     def defined_if?
-      @options.has_key?(:defined_if)
+      @options.key?(:defined_if)
     end
 
     def defined_if
@@ -95,7 +156,7 @@ module Formeze
     end
 
     def defined_unless?
-      @options.has_key?(:defined_unless)
+      @options.key?(:defined_unless)
     end
 
     def defined_unless
@@ -103,47 +164,37 @@ module Formeze
     end
   end
 
-  class FieldSet
-    include Enumerable
+  class Validation
+    include Presence
 
-    def initialize
-      @fields, @index = [], {}
-    end
+    def initialize(field, **kwargs, &block)
+      @field = field
 
-    def each(&block)
-      @fields.each(&block)
-    end
+      @error = kwargs[:error] || :invalid
 
-    def <<(field)
-      @fields << field
+      @precondition = kwargs[:if]
 
-      @index[field.name] = field
+      @block = block
     end
 
-    def [](field_name)
-      @index.fetch(field_name)
-    end
-  end
-
-  class Validation
-    def initialize(field, options, &block)
-      @field, @options, @block = field, options, block
+    def error_message
+      Formeze.translate(@error, scope: ERRORS_SCOPE, default: 'is invalid')
     end
 
-    def error_key
-      @options.fetch(:error) { :invalid }
+    def validates?(form)
+      @precondition ? form.instance_eval(&@precondition) : true
     end
 
-    def error_message
-      Formeze.translate(error_key, :scope => [:formeze, :errors], :default => 'is invalid')
+    def field_value?(form)
+      present?(form.send(@field.name))
     end
 
-    def validates?(form)
-      @options.has_key?(:when) ? form.instance_eval(&@options[:when]) : true
+    def field_errors?(form)
+      form.errors_on?(@field.name)
     end
 
     def validate(form)
-      if validates?(form) && !form.errors_on?(@field.name)
+      if validates?(form) && field_value?(form) && !field_errors?(form)
         return_value = if @block.arity == 1
           @block.call(form.send(@field.name))
         else
@@ -155,58 +206,25 @@ module Formeze
     end
   end
 
-  module ArrayAttrAccessor
-    def array_attr_reader(name)
-      define_method(name) do
-        ivar = :"@#{name}"
-
-        instance_variable_defined?(ivar) ? Array(instance_variable_get(ivar)) : []
-      end
-    end
-
-    def array_attr_writer(name)
-      define_method(:"#{name}=") do |value|
-        ivar = :"@#{name}"
-
-        instance_variable_set(ivar, send(name) + [value])
-      end
-    end
-
-    def array_attr_accessor(name)
-      array_attr_reader(name)
-      array_attr_writer(name)
-    end
-  end
-
   module ClassMethods
-    include ArrayAttrAccessor
-
     def fields
-      @fields ||= FieldSet.new
+      @fields ||= {}
     end
 
-    def field(*args)
-      field = Field.new(*args)
+    def field(name, **options)
+      field = Field.new(name, **options)
 
-      fields << field
+      fields[field.name] = field
 
-      if field.multiple?
-        array_attr_accessor field.name
-      else
-        attr_accessor field.name
-      end
+      attr_accessor field.name
     end
 
     def validations
       @validations ||= []
     end
 
-    def validates(field_name, options = {}, &block)
-      validations << Validation.new(fields[field_name], options, &block)
-    end
-
-    def parse(encoded_form_data)
-      new.tap { |form| form.parse(encoded_form_data) }
+    def validates(field_name, **options, &block)
+      validations << Validation.new(fields[field_name], **options, &block)
     end
   end
 
@@ -216,24 +234,46 @@ module Formeze
 
   class ValidationError < StandardError; end
 
+  class RequestCGI < CGI
+    def env_table
+      @options[:request].env
+    end
+
+    def stdinput
+      @options[:request].body
+    end
+  end
+
+  private_constant :RequestCGI
+
+  RAILS_FORM_KEYS = %w[utf8 authenticity_token commit]
+
+  private_constant :RAILS_FORM_KEYS
+
   module InstanceMethods
     def fill(object)
-      self.class.fields.each do |field|
-        if Hash === object && object.has_key?(field.name)
+      self.class.fields.each_value do |field|
+        if Hash === object && object.key?(field.name)
           send(:"#{field.name}=", object[field.name])
         elsif object.respond_to?(field.name)
           send(:"#{field.name}=", object.send(field.name))
         end
       end
+
+      return self
     end
 
-    def parse(encoded_form_data)
-      form_data = CGI.parse(encoded_form_data)
+    def parse(input)
+      form_data = if String === input
+        CGI.parse(input)
+      else
+        RequestCGI.new(request: input).params
+      end
 
-      self.class.fields.each do |field|
+      self.class.fields.each_value do |field|
         next unless field_defined?(field)
 
-        unless form_data.has_key?(field.key)
+        unless form_data.key?(field.key)
           next if field.multiple? || !field.key_required?
 
           raise KeyError, "missing form key: #{field.key}"
@@ -245,13 +285,11 @@ module Formeze
           raise ValueError unless field.multiple?
         end
 
-        values.each do |value|
-          field.validate(value, self)
-        end
+        field.validate_all(values, self)
       end
 
       if defined?(Rails)
-        %w(utf8 authenticity_token).each do |key|
+        RAILS_FORM_KEYS.each do |key|
           form_data.delete(key)
         end
       end
@@ -263,6 +301,8 @@ module Formeze
       self.class.validations.each do |validation|
         validation.validate(self)
       end
+
+      return self
     end
 
     def add_error(field, message)
@@ -294,9 +334,8 @@ module Formeze
     end
 
     def to_h
-      self.class.fields.inject({}) do |hash, field|
+      self.class.fields.values.each_with_object({}) do |field, hash|
         hash[field.name] = send(field.name)
-        hash
       end
     end
 
@@ -339,8 +378,16 @@ module Formeze
     end
   end
 
-  def self.translate(key, options)
-    defined?(I18n) ? I18n.translate(key, options) : options.fetch(:default)
+  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)

metadata

@@ -1,82 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: formeze
 version: !ruby/object:Gem::Version
-  version: 2.1.0
-  prerelease: 
+  version: 4.0.0
 platform: ruby
 authors:
 - Tim Craft
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.9.3
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-description: A little library for handling form data/input
+date: 2020-07-13 00:00:00.000000000 Z
+dependencies: []
+description: Ruby gem for validating form data
 email:
 - mail@timcraft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/formeze.rb
-- spec/formeze_spec.rb
+- CHANGES.md
+- LICENSE.txt
 - README.md
-- Rakefile.rb
 - formeze.gemspec
-homepage: http://github.com/timcraft/formeze
-licenses: []
-post_install_message: 
+- lib/formeze.rb
+homepage: https://github.com/readysteady/formeze
+licenses:
+- LGPL-3.0
+metadata:
+  homepage: https://github.com/readysteady/formeze
+  source_code_uri: https://github.com/readysteady/formeze
+  bug_tracker_uri: https://github.com/readysteady/formeze/issues
+  changelog_uri: https://github.com/readysteady/formeze/blob/master/CHANGES.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
 summary: See description
 test_files: []