formeze 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b7bf0599d8a5997c77dafb5da086aa3cbd8f7f72
-  data.tar.gz: 72ce1f27ad4d9d694eb95cd1b2b7837d1e33d86a
+SHA256:
+  metadata.gz: b67d9270f16eb5af01a76ed46059e8c61b14c67753f7ad05303a687a2741d2f6
+  data.tar.gz: b1ea76abe102e3a554f66af48253de9497b8786742f01c7f124dd8187ccde593
 SHA512:
-  metadata.gz: a42a9f27f6ba27c3aa42a7640bd703294d594e87dff8d6d6750d9c024ef5f15c28d1bc8d96e6d16181f904f78d24bc31a0f4d6af9a048f9de454964896ff5496
-  data.tar.gz: 39846f79aa0a5e5f5319d0e8c9ded0b50fc308e031ed988263ebcbff24e38e3b79a7778bfdf1549a1bbcb107a820285cc15142a30fc8e050ca9d69b08367c60a
+  metadata.gz: edc08ae4719627987bff853db4e82f021e1fb340aff32cf0cd1583d4943a6efb598addcf13223b8fcbb2d5d1c00728dd634f0be55b49daf40e2b63a6cc5f6214
+  data.tar.gz: 442b1da170d85a21b3c5c14b675802605275f6c0cd327cb007ba0f3009dcf6b010f7bc941051747f31aab9c0d7262f1e8ea307e287297e584b85eedbb6a94e28

data/CHANGES.md

@@ -0,0 +1,156 @@
+# 3.1.0
+
+* Added `'commit'` to the list of Rails form keys to ignore (#4)
+
+* Added frozen string literal comment
+
+* Extracted private constants to reduce memory allocations
+
+* Removed spec file from gem
+
+# 3.0.0
+
+* Added functionality for handling multipart form data. For example:
+
+      class ExampleForm < Formeze::Form
+        field :image, accept: 'image/jpg,image/png', maxsize: 1000
+      end
+
+  For this to work the request needs to be passed to the parse method:
+
+      ExampleForm.new.parse(request)
+
+* Removed the deprecated parse class method
+
+* Removed Ruby 1.8.7 compatibility
+
+# 2.2.0
+
+* The #fill and #parse instance methods now return self. So instead of this:
+
+      form = ExampleForm.new
+      form.parse(request.raw_post)
+
+  You can now do this:
+
+      form = ExampleForm.new.parse(request.raw_post)
+
+* Deprecated the parse class method
+
+# 2.1.1
+
+* Fixed that custom validation should not execute for optional fields with blank values
+
+# 2.1.0
+
+* Fixed that custom validation should only execute when there are no existing errors on the associated field
+
+* Removed `:word_limit` field option
+
+# 2.0.0
+
+* Added new custom validation functionality
+
+* Removed existing (undocumented) custom validation functionality
+
+* KeyError now includes an error message when raised for unexpected keys
+
+* Added #to_h form instance method
+
+* Removed `:char_limit` field option
+
+* Deprecated `:word_limit` field option (use custom validation instead)
+
+# 1.9.1
+
+* Added `:minlength` field option
+
+* Added `:maxlength` field option
+
+* Deprecated `:char_limit` field option (use `:maxlength` instead)
+
+# 1.9.0
+
+* Added `:blank` field option for specifying a null object to be used in place of blank input
+
+# 1.8.0
+
+* Added #fill instance method
+
+* Improved handling of Rails utf8/authenticity_token parameters
+
+# 1.7.0
+
+* Ruby 1.8.7 compatibility
+
+* Renamed `Formeze::UserError` to `Formeze::ValidationError`
+
+* Added #to_hash instance method
+
+# 1.6.0
+
+* Added #errors_on? instance method for checking if there are errors on a specific field
+
+* Added #errors_on instance method for accessing the errors on a specific field
+
+* Added parse class method, so instead of this:
+
+      form = ExampleForm.new
+      form.parse(request.raw_post)
+
+  You can now do this:
+
+      form = ExampleForm.parse(request.raw_post)
+
+# 1.5.1
+
+* Added `Formeze::Form` class, so forms can now be defined like this:
+
+      class ExampleForm < Formeze::Form
+      end
+
+  The previous style of setup is still supported:
+
+      class ExampleForm < SomeAncestorClass
+        Formeze.setup(self)
+      end
+
+# 1.5.0
+
+* Added #errors? instance method
+
+* Added `Formeze.scrub` method so that the scrub methods can be re-used outside field validation
+
+# 1.4.0
+
+* Added `:scrub` field option for cleaning up input data before validation
+
+# 1.3.0
+
+* Added functionality for overriding error messages via i18n
+
+* Added functionality for setting field labels globally via i18n
+
+# 1.2.0
+
+* Replaced experimental guard/halting functionality with `:defined_if` and `:defined_unless` field options
+
+# 1.1.3
+
+* Fixed early return from guard/halting conditions
+
+# 1.1.2
+
+* Fixed validation so that additional checks are skipped if the input is blank
+
+# 1.1.1
+
+* Added an error message for `Formeze::KeyError` exceptions
+
+# 1.1.0
+
+* Changed behaviour of experimental guard conditions and added halting conditions with opposite behaviour
+
+# 1.0.0
+
+* First version!

data/LICENSE.txt

@@ -1,9 +1,4 @@
-Copyright (c) TIMCRAFT <http://timcraft.com>
+Copyright (c) 2012-2020 TIMCRAFT
 
 This is an Open Source project licensed under the terms of the LGPLv3 license.
 Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.
-
-This code is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU Lesser General Public License for more details.

data/README.md

@@ -1,12 +1,12 @@
-formeze
-=======
+# formeze
 
+![Gem Version](https://badge.fury.io/rb/formeze.svg)
+![Build Status](https://github.com/readysteady/formeze/workflows/Test/badge.svg)
 
-A little Ruby library for handling form data/input.
+A lightweight Ruby library for processing form data.
 
 
-Motivation
-----------
+## Motivation
 
 Most web apps built for end users will need to process url-encoded form data.
 Registration forms, profile forms, checkout forms, contact forms, and forms
@@ -18,16 +18,14 @@ Formeze adopts the approach of being "strict by default", forcing the applicatio
 code to be explicit in what it accepts as input.
 
 
-Installation
-------------
+## Installation
 
 ```
 $ gem install formeze
 ```
 
 
-Example usage
--------------
+## Example usage
 
 Here is a minimal example, which defines a form with a single field:
 
@@ -69,8 +67,7 @@ methods but will otherwise leave the object untouched (i.e. you can define
 your own initialization logic).
 
 
-Validation errors
------------------
+## Validation errors
 
 Formeze distinguishes between validation errors (which are expected in the
 normal running of your application), and key/value errors (which most likely
@@ -86,8 +83,7 @@ use the `errors_on?` and `errors_on` methods to check for and select error
 messages specific to a single field.
 
 
-Field options
--------------
+## Field options
 
 By default fields cannot be blank, they are limited to 64 characters,
 and they cannot contain newlines. These restrictions can be overridden
@@ -211,8 +207,7 @@ Custom scrub methods can be defined by adding a symbol/proc entry to the
 `Formeze.scrub_methods` hash.
 
 
-Multipart form data
--------------------
+## Multipart form data
 
 For file fields you can specify the `accept` and `maxsize` options, for example:
 
@@ -227,8 +222,7 @@ For this to work you need to make sure your application includes the
 form is submitted with the multipart/form-data mime type.
 
 
-Custom validation
------------------
+## Custom validation
 
 You may need additional validation logic beyond what the field options
 described above provide, such as validating the format of a field without
@@ -308,8 +302,7 @@ key does not exist. The error for the password_confirmation field validation
 would include the value of the `formeze.errors.does_not_match` I18n key.
 
 
-I18n integration
-----------------
+## I18n integration
 
 Formeze integrates with [I18n](http://edgeguides.rubyonrails.org/i18n.html)
 so that you can define custom error messages and field labels within your

data/formeze.gemspec

@@ -1,18 +1,20 @@
 Gem::Specification.new do |s|
   s.name = 'formeze'
-  s.version = '3.0.0'
+  s.version = '3.1.0'
   s.license = 'LGPL-3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
-  s.homepage = 'http://github.com/timcraft/formeze'
-  s.description = 'A little Ruby library for handling form data/input'
+  s.homepage = 'https://github.com/readysteady/formeze'
+  s.description = 'A lightweight Ruby library for processing form data'
   s.summary = 'See description'
-  s.files = Dir.glob('{lib,spec}/**/*') + %w(LICENSE.txt README.md Rakefile.rb formeze.gemspec)
+  s.files = Dir.glob('lib/**/*.rb') + %w(CHANGES.md LICENSE.txt README.md formeze.gemspec)
   s.required_ruby_version = '>= 1.9.3'
-  s.add_development_dependency('rake', '~> 10')
-  s.add_development_dependency('i18n', '~> 0.6')
-  s.add_development_dependency('minitest', '~> 5')
-  s.add_development_dependency('mime-types', '~> 2')
   s.require_path = 'lib'
+  s.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'
+  }
 end

data/lib/formeze.rb

@@ -1,7 +1,24 @@
+# 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 = {})
@@ -27,7 +44,7 @@ module Formeze
     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?
 
         value = blank_value if blank_value?
@@ -91,7 +108,7 @@ module Formeze
     end
 
     def maxsize?
-      @options.has_key?(:maxsize)
+      @options.key?(:maxsize)
     end
 
     def maxsize
@@ -107,15 +124,15 @@ module Formeze
     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
@@ -123,7 +140,7 @@ module Formeze
     end
 
     def values?
-      @options.has_key?(:values)
+      @options.key?(:values)
     end
 
     def values
@@ -131,7 +148,7 @@ module Formeze
     end
 
     def defined_if?
-      @options.has_key?(:defined_if)
+      @options.key?(:defined_if)
     end
 
     def defined_if
@@ -139,7 +156,7 @@ module Formeze
     end
 
     def defined_unless?
-      @options.has_key?(:defined_unless)
+      @options.key?(:defined_unless)
     end
 
     def defined_unless
@@ -148,6 +165,8 @@ module Formeze
   end
 
   class Validation
+    include Presence
+
     def initialize(field, options, &block)
       @field, @options, @block = field, options, block
     end
@@ -161,11 +180,11 @@ module Formeze
     end
 
     def validates?(form)
-      @options.has_key?(:when) ? form.instance_eval(&@options[:when]) : true
+      @options.key?(:when) ? form.instance_eval(&@options[:when]) : true
     end
 
     def field_value?(form)
-      form.send(@field.name) =~ /\S/
+      present?(form.send(@field.name))
     end
 
     def field_errors?(form)
@@ -223,10 +242,16 @@ module Formeze
     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_value do |field|
-        if Hash === object && object.has_key?(field.name)
+        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))
@@ -246,7 +271,7 @@ module Formeze
       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}"
@@ -262,7 +287,7 @@ module Formeze
       end
 
       if defined?(Rails)
-        %w(utf8 authenticity_token).each do |key|
+        RAILS_FORM_KEYS.each do |key|
           form_data.delete(key)
         end
       end

metadata

@@ -1,88 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: formeze
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-21 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10'
-- !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5'
-- !ruby/object:Gem::Dependency
-  name: mime-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-description: A little Ruby library for handling form data/input
+date: 2020-04-09 00:00:00.000000000 Z
+dependencies: []
+description: A lightweight Ruby library for processing form data
 email:
 - mail@timcraft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.md
 - LICENSE.txt
 - README.md
-- Rakefile.rb
 - formeze.gemspec
 - lib/formeze.rb
-- spec/formeze_spec.rb
-homepage: http://github.com/timcraft/formeze
+homepage: https://github.com/readysteady/formeze
 licenses:
 - LGPL-3.0
-metadata: {}
+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:
@@ -98,8 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: See description