formeze 3.1.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b67d9270f16eb5af01a76ed46059e8c61b14c67753f7ad05303a687a2741d2f6
-  data.tar.gz: b1ea76abe102e3a554f66af48253de9497b8786742f01c7f124dd8187ccde593
+  metadata.gz: 966031b2657f2210d398a97d3c8dd6a1cc4e424e39972db1c3bad968cfe3bc8e
+  data.tar.gz: 140936f1897241dc7ee598fd8e63296d3d7918879dd263d825e68299897e1a1f
 SHA512:
-  metadata.gz: edc08ae4719627987bff853db4e82f021e1fb340aff32cf0cd1583d4943a6efb598addcf13223b8fcbb2d5d1c00728dd634f0be55b49daf40e2b63a6cc5f6214
-  data.tar.gz: 442b1da170d85a21b3c5c14b675802605275f6c0cd327cb007ba0f3009dcf6b010f7bc941051747f31aab9c0d7262f1e8ea307e287297e584b85eedbb6a94e28
+  metadata.gz: '092df6a16316cd7fb65f997e3e25e65622a1e8e112a5da8db6c56ca4146dc4485502fcc1ed7b9cb6a34e452878e3a6151a7c3c7c47e759ef7fe6349d35f5c1e4'
+  data.tar.gz: 0b4641a90d0d9e7e0cface189b699f12ebd60e94de2350a7dcbee537be6e22bd8b721587199ce3e24202ea5ccb8c1083438abd9bfa5d55538556825e08cbe0bc

data/CHANGES.md

@@ -1,3 +1,11 @@
+# 4.0.0
+
+* Removed support for older rubies. **Required ruby version is now 2.4.0**
+
+* Changed the code to use keyword arguments for options
+
+* Renamed the `when` validation option to `if`
+
 # 3.1.0
 
 * Added `'commit'` to the list of Rails form keys to ignore (#4)

data/README.md

@@ -3,7 +3,7 @@
 ![Gem Version](https://badge.fury.io/rb/formeze.svg)
 ![Build Status](https://github.com/readysteady/formeze/workflows/Test/badge.svg)
 
-A lightweight Ruby library for processing form data.
+Ruby gem for validating form data.
 
 
 ## Motivation
@@ -18,14 +18,18 @@ Formeze adopts the approach of being "strict by default", forcing the applicatio
 code to be explicit in what it accepts as input.
 
 
-## Installation
+## Install
 
-```
-$ gem install formeze
-```
+Using Bundler:
+
+    $ bundle add formeze
+
+Using RubyGems:
+
+    $ gem install formeze
 
 
-## Example usage
+## Usage
 
 Here is a minimal example, which defines a form with a single field:
 
@@ -254,16 +258,16 @@ class ExampleForm < Formeze::Form
 end
 ```
 
-Specify the `when` option with a proc to peform the validation conditionally.
+Specify the `if` option with a proc to peform the validation conditionally.
 Similar to the `defined_if` and `defined_unless` field options, the proc is
 evaluated in the scope of the form instance. For example:
 
 ```ruby
 class ExampleForm < Formeze::Form
-  field :business_name, :defined_if => :business_account?
-  field :vat_number, :defined_if => :business_account?
+  field :business_name, defined_if: :business_account?
+  field :vat_number, defined_if: :business_account?
 
-  validates :vat_number, :when => :business_account? do
+  validates :vat_number, if: :business_account? do
     # ...
   end
 
@@ -290,7 +294,7 @@ class ExampleForm < Formeze::Form
 
   validates :email, &EmailAddress.method(:valid?)
 
-  validates :password_confirmation, :error => :does_not_match do
+  validates :password_confirmation, error: :does_not_match do
     password_confirmation == password
   end
 end

data/formeze.gemspec

@@ -1,15 +1,15 @@
 Gem::Specification.new do |s|
   s.name = 'formeze'
-  s.version = '3.1.0'
+  s.version = '4.0.0'
   s.license = 'LGPL-3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
   s.homepage = 'https://github.com/readysteady/formeze'
-  s.description = 'A lightweight Ruby library for processing form data'
+  s.description = 'Ruby gem for validating form data'
   s.summary = 'See description'
   s.files = Dir.glob('lib/**/*.rb') + %w(CHANGES.md LICENSE.txt README.md formeze.gemspec)
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.4.0'
   s.require_path = 'lib'
   s.metadata = {
     'homepage' => 'https://github.com/readysteady/formeze',

data/lib/formeze.rb

@@ -21,7 +21,7 @@ module Formeze
 
     attr_reader :name
 
-    def initialize(name, options = {})
+    def initialize(name, **options)
       @name, @options = name, options
     end
 
@@ -80,7 +80,7 @@ module Formeze
     end
 
     def error(key, default)
-      Formeze.translate(key, :scope => [:formeze, :errors], :default => default)
+      Formeze.translate(key, scope: ERRORS_SCOPE, default: default)
     end
 
     def key
@@ -92,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?
@@ -167,20 +167,22 @@ module Formeze
   class Validation
     include Presence
 
-    def initialize(field, options, &block)
-      @field, @options, @block = field, options, block
-    end
+    def initialize(field, **kwargs, &block)
+      @field = field
+
+      @error = kwargs[:error] || :invalid
 
-    def error_key
-      @options.fetch(:error) { :invalid }
+      @precondition = kwargs[:if]
+
+      @block = block
     end
 
     def error_message
-      Formeze.translate(error_key, :scope => [:formeze, :errors], :default => 'is invalid')
+      Formeze.translate(@error, scope: ERRORS_SCOPE, default: 'is invalid')
     end
 
     def validates?(form)
-      @options.key?(:when) ? form.instance_eval(&@options[:when]) : true
+      @precondition ? form.instance_eval(&@precondition) : true
     end
 
     def field_value?(form)
@@ -209,8 +211,8 @@ module Formeze
       @fields ||= {}
     end
 
-    def field(*args)
-      field = Field.new(*args)
+    def field(name, **options)
+      field = Field.new(name, **options)
 
       fields[field.name] = field
 
@@ -221,8 +223,8 @@ module Formeze
       @validations ||= []
     end
 
-    def validates(field_name, options = {}, &block)
-      validations << Validation.new(fields[field_name], options, &block)
+    def validates(field_name, **options, &block)
+      validations << Validation.new(fields[field_name], **options, &block)
     end
   end
 
@@ -376,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,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: formeze
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Tim Craft
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies: []
-description: A lightweight Ruby library for processing form data
+description: Ruby gem for validating form data
 email:
 - mail@timcraft.com
 executables: []
@@ -30,7 +30,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -38,7 +38,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -46,7 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: See description
 test_files: []