fend 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5d13258d558a3a951a5b468994dd43d71e5146cb
-  data.tar.gz: 961c725b800fee07ed70e6f937fab1b8e97c42f3
+SHA256:
+  metadata.gz: d0f5edff32bf78090df43951c3a7aa95628ac4e2417566a51db60971bef24634
+  data.tar.gz: 201f363db87219f57403f6c665fdcad4e0f7e07a049604775503a68810ad015d
 SHA512:
-  metadata.gz: 78062b89d15fb139ef304be7764a1e0f3bba18f3f8f53d58a7ae70456c8740e2cbf284e36e5e2b3696cf4693db73a4219ec12bddf043b826b4333ff9ef3b037c
-  data.tar.gz: 4849a34a6212b5495a4cad9aa3d6635564164f820669136791cdc36b5f0c1f4fd194feaabe41a6849a171c66ac5c45afc75338cf496f6c9552de5d9af539bbaa
+  metadata.gz: d7c9f4ac50bf03c2c6f3ba5f97e2a241b7dcf8b7e49139d4e3d5d889e4f6da6608483cb1e95b078407d9abd4b20fb53ad141e9a5d30cb9188977dbff82e1eba9
+  data.tar.gz: 9f4f65a5fea0b112712a86d07be79bbf852040040400ee3f4af65b30e8d8bb04cce5668cd8001f2d023ecca96f905f29a1d392f90af451e7df6c0aa008f1e8e3

data/README.md

@@ -11,6 +11,7 @@ Fend is a small and extensible data validation toolkit.
 * [**Introduction**](#introduction)
     * [Core functionalities](#core-functionalities)
     * [Nested params](#nested-params)
+        * [Iterating over nested hash params](#iterating-over-nested-hash-params)
     * [Arrays](#arrays)
 * [**Plugins overview**](#plugins-overview)
     * [Value helpers](#value-helpers)
@@ -40,7 +41,7 @@ Some of the features include:
 
 ## Documentation
 
-For detailed documentation visit [fend.radunovic.io](http://fend.radunovic.io)
+For detailed documentation visit [aradunovic.github.io/fend](https://aradunovic.github.io/fend)
 
 ## Why?
 
@@ -82,11 +83,12 @@ require "fend"
 class UserValidation < Fend
   # define validation block
   validation do |i|
-    # specify :username param that needs to be validated
+    # specify username and email params that needs to be validated
     i.params(:username, :email) do |username, email|
       # append error if username value is not string
       username.add_error("must be string") unless username.value.is_a?(String)
 
+      # append error is email is invalid or already exists
       email.add_error("is not a valid email address") unless email.match?(EMAIL_REGEX)
       email.add_error("must be unique") if email.valid? && !unique?(email: email.value)
 
@@ -130,7 +132,7 @@ result.failure? #=> true
 result.input #=> { username: 1234, email: "invalid@email" }
 
 # get result output
-result.input #=> { username: 1234, email: "invalid@email" }
+result.output #=> { username: 1234, email: "invalid@email" }
 
 # get error messages
 result.messages #=> { username: ["must be string"], email: ["is not a valid email address"] }
@@ -161,14 +163,43 @@ result.failure? #=> true
 result.messages #=> { address: ["must be hash"] }
 ```
 
-As you can see, nested param validations are **not** executed when
-parent param is invalid.
+**NOTE:** Nested param(s) validations won't be run if parent param
+is invalid.
 
 ```ruby
 result = UserValidation.call(username: "test", address: {})
 result.messages #=> { address: { city: ["must be string"], street: ["must be string"] } }
 ```
 
+#### Iterating over nested hash params
+
+In order to iterate over nested hash params while ignoring the keys/names
+use `Param#each` method with `hash: true` option:
+
+```ruby
+i.params(:emails) do |emails|
+
+  emails.each(hash: true) do |email_address|
+    email_address.params(:email, :confirmed) do |email, confirmed|
+      email.add_error("must be provided") if email.nil?
+      email.add_error("must be confirmed") if email.valid? && confirmed == false
+    end
+  end
+end
+
+user_params = {
+  emails: {
+    "0" => { email: "love@ruby.com", confirmed: false },
+    "1" => { email: "", confirmed: "" },
+  }
+}
+
+result = UserValidation.call(user_params)
+
+result.messages
+#=> { emails: { "0" => { email: ["must be confirmed"] }, "1" => { email: ["must be provided"] } } }
+```
+
 ### Arrays
 
 Validating array members is done by passing a block to `Param#each` method:
@@ -188,7 +219,7 @@ result = UserValidation.call(tags: [1, 2])
 result.messages #=> { tags: { 0 => ["must be string"], 1 => ["must be string"] } }
 ```
 
-Needless to say, member validation won't be run if `tags` is not an array.
+**NOTE:** Member validations won't be run if `tags` is not an array.
 
 Fend makes it possible to validate specific array members, since `#each` method
 also provides an `index`:
@@ -205,7 +236,7 @@ end
 
 ## Plugins overview
 
-For complete plugins documentation, go to [fend.radunovic.io](http://fend.radunovic.io).
+For complete plugins documentation, go to [aradunovic.github.io/fend](https://aradunovic.github.io/fend).
 
 ### Value helpers
 
@@ -252,7 +283,7 @@ validation do |i|
 
     address.validate_type(Hash)
 
-    address.param(:city) do |city|
+    address.params(:city) do |city|
       city.validate_presence
       city.validate_type(String)
     end
@@ -362,14 +393,16 @@ class UserValidation < Fend
   end
 
   validate do |i|
-    i.param(:username) { |username| username.value #=> "john" }
-    i.param(:foo) { |foo| foo.value #=> "foo" }
+    i.params(:username, :foo) do |username, foo|
+      username.value #=>"john"
+      foo.value #=> "foo"
+    end
   end
 end
 
 result = UserValidation.call(username: "john")
 
-result.input #=> { username: "john" }
+result.input #=> { username: "john", foo: "foo" }
 result.output #=> { username: "john", timestamp: 2018-01-01 00:00:00 UTC }
 ```
 

data/fend.gemspec

@@ -4,11 +4,11 @@ Gem::Specification.new do |gem|
   gem.name         = "fend"
   gem.version      = Fend.version
   gem.authors      = ["Aleksandar Radunovic"]
-  gem.email        = ["aleksandar@radunovic.io"]
+  gem.email        = ["a.radunovic@pm.me"]
 
   gem.summary      = "Small and extensible data validation toolkit"
   gem.description  = gem.summary
-  gem.homepage     = "https://fend.radunovic.io"
+  gem.homepage     = "https://aradunovic.github.io/fend"
   gem.license      = "MIT"
 
   gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "fend.gemspec", "doc/*.md"]

data/lib/fend.rb

@@ -186,20 +186,6 @@ class Fend
           @value.fetch(name, nil) if @value.respond_to?(:fetch)
         end
 
-        # Define child param and execute validation block
-        def param(name, &block)
-          Fend.deprecation("Calling Param#param to specify params is deprecated and will not be supported in Fend 0.3.0. Use Param#params method instead.")
-
-          return if flat? && invalid?
-
-          value = self[name]
-          param = _build_param(name, value)
-
-          yield(param)
-
-          _nest_errors(name, param.errors) if param.invalid?
-        end
-
         # Define child params and execute validation block
         def params(*names, &block)
           return if flat? && invalid?
@@ -214,16 +200,21 @@ class Fend
           params.each { |name, param| _nest_errors(name, param.errors) if param.invalid? }
         end
 
-        # Define array member param and execute validation block
-        def each(&block)
+        # Define enumerable param member and execute validation block
+        def each(opts = {}, &block)
           return if (flat? && invalid?) || !@value.is_a?(Enumerable)
 
+          is_hash = opts[:hash].eql?(true)
+
+          return if is_hash && !@value.is_a?(Hash)
+
           @value.each_with_index do |value, index|
-            param = _build_param(index, value)
+            param_name, param_value = is_hash ? value : [index, value]
+            param = _build_param(param_name, param_value)
 
             yield(param, index)
 
-            _nest_errors(index, param.errors) if param.invalid?
+            _nest_errors(param.name, param.errors) if param.invalid?
           end
         end
 

data/lib/fend/plugins/base_errors.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class Fend
+  module Plugins
+    # `base_errors` plugin allows you to add validation errors which are
+    # not related to a specific param, but to validation input as a whole.
+    #
+    #     class AuthValidation < Fend
+    #       plugin :base_errors
+    #
+    #       validate do |i|
+    #         i.params(:email, :password) do |email, password|
+    #           # ...
+    #
+    #           if email.invalid? || password.invalid?
+    #             add_base_error("Invalid email or password")
+    #           end
+    #         end
+    #       end
+    #     end
+    #
+    # Messages are available under `:base` key by default.
+    #
+    #     AuthValidation.call(email: nil, password: nil).messages
+    #     #=> { base: ["Invalid email or password"] }
+    #
+    # You can specify custom key when loading the plugin:
+    #
+    #     plugin :base_errors, key: :general
+    module BaseErrors
+      DEFAULT_KEY = :base
+
+      def self.configure(validation, opts = {})
+        validation.opts[:base_errors_key] = opts[:key] || validation.opts[:base_errors_key] || DEFAULT_KEY
+      end
+
+      module InstanceMethods
+        def add_base_error(message)
+          messages = @_input_param.errors
+          key = self.class.opts[:base_errors_key]
+
+          if messages.is_a?(Hash) && messages.key?(key)
+            messages[key] << message
+          else
+            @_input_param.params(key) { |base| base.add_error(message) }
+          end
+        end
+      end
+    end
+
+    register_plugin(:base_errors, BaseErrors)
+  end
+end

data/lib/fend/plugins/dependencies.rb

@@ -9,15 +9,7 @@ class Fend
     #
     # ## Registering dependencies
     #
-    # There are two types of dependencies:
-    #
-    # 1. **Inheritable dependencies** - available in current validation class
-    #                                   and in subclasses
-    # 2. *[DEPRECATED] **Local dependencies** - available only in current validation class
-    #
-    # ### Inheritable dependencies
-    #
-    # Inheritable dependencies can be registered when plugin is loaded:
+    # Dependencies can be registered when plugin is loaded:
     #
     #     plugin :dependencies, user_class: User
     #
@@ -30,27 +22,6 @@ class Fend
     #
     # Now, all `Fend` subclasses will be able to resolve `address_checker`
     #
-    # ### Local dependencies *[DEPRECATED]
-    #
-    # Local dependencies can be registered in `deps` registry, on instance level.
-    # Recommended place to do this is the initializer.
-    #
-    #     class UserValidation < Fend
-    #       plugin :dependencies
-    #
-    #       def initialize(model)
-    #         # you can pass a dependency on initialization
-    #         deps[:model] = model
-    #
-    #         # or
-    #
-    #         # hardcode it yourself
-    #         deps[:address_checker] = AddressChecker.new
-    #       end
-    #     end
-    #
-    #     user_validation = UserValidation.new(User)
-    #
     # ## Resolving dependencies
     #
     # To resolve dependencies, `:inject` option needs to be provided to the
@@ -73,19 +44,13 @@ class Fend
     #       end
     #     end
     #
-    # ## Overriding inheritable dependencies
+    # ## Overriding dependencies
     #
-    # To override inheritable dependency, just load the plugin again in a
-    # subclass, or define local dependency with the same name.
+    # To override global dependency, just load the plugin again in a subclass
+    # and specify new dependecy value.
     #
     #     plugin :dependencies, user_model: SpecialUser
     #
-    #     # or
-    #
-    #     def initialize
-    #       deps[:user_model] = SpecialUser
-    #     end
-    #
     # ## Example usage
     #
     # Here's an example of email uniqueness validation:
@@ -115,16 +80,10 @@ class Fend
       end
 
       module InstanceMethods
-        def deps
-          Fend.deprecation("Local dependencies are deprecated and will not be supported in Fend 0.3.0. Instead, you can set attributes or define custom methods which will be available in validation block.")
-
-          @_deps ||= self.class.opts[:dependencies].dup
-        end
-
         def validate(&block)
           super if self.class.specified_dependencies.nil?
 
-          dependencies = deps.values_at(*self.class.specified_dependencies)
+          dependencies = self.class.opts[:dependencies].values_at(*self.class.specified_dependencies)
 
           yield(@_input_param, *dependencies) if block_given?
         end

data/lib/fend/plugins/full_messages.rb

@@ -3,7 +3,7 @@
 class Fend
   module Plugins
     # `full_messages` plugin adds `#full_messages` method to `Result` which
-    # returns error messages with prependend param name
+    # returns error messages with prependend param name.
     #
     #      class UserValidation < Fend
     #        plugin :full_messages
@@ -23,7 +23,7 @@ class Fend
     #      { tags: { 0 => ["0 must be string"] } }
     #
     # In order to make full messages nicer for array elements,
-    # pass `:array_memeber_names` option when loading the plugin:
+    # pass `:array_member_names` option when loading the plugin:
     #
     #      plugin :full_messages, array_member_names: { tags: :tag }
     #
@@ -35,30 +35,78 @@ class Fend
     #
     #     Fend.plugin :full_messages, array_member_names: { octopi: :octopus }
     #
+    # ## Base errors
+    #
+    # Full messages are **not** generated for errors added with `base_errors`
+    # plugin, since those messages are not connected to specific param(s).
     module FullMessages
       def self.configure(validation, opts = {})
         validation.opts[:full_messages_array_member_names] = (validation.opts[:full_messages_array_member_names] || {}).merge(opts[:array_member_names] || {})
+        validation.const_set(:FullMessagesGenerator, Generator) unless validation.const_defined?(:FullMessagesGenerator)
       end
 
       module ResultMethods
         def full_messages
-          @_full_messages ||= generate_full_messages(@errors)
+          @_full_messages ||= full_messages_generator.call(@errors)
         end
 
         private
 
-        def generate_full_messages(errors, array_param_name = nil)
-          errors.each_with_object({}) do |(param, messages), result|
-            result[param] = if messages.is_a?(Hash)
-                              param_is_array = messages.first[0].is_a?(Integer)
+        def full_messages_generator
+          self.fend_class::FullMessagesGenerator.new(
+            array_member_names: fend_class.opts[:full_messages_array_member_names],
+            skip: [fend_class.opts[:base_errors_key]]
+          )
+        end
+      end
+
+      class Generator
+        def initialize(opts = {})
+          @array_params = opts.fetch(:array_member_names, {})
+          @skip_list = opts[:skip]
+        end
+
+        def call(errors)
+          errors.each_with_object({}) do |(param_name, messages), result|
+            result[param_name] = if @skip_list.include?(param_name)
+                                   messages
+                                 else
+                                   messages_for(param_name, messages)
+                                 end
+          end
+        end
+
+        private
 
-                              generate_full_messages(messages, param_is_array ? param : nil)
-                            else
-                              param_name = fend_class.opts[:full_messages_array_member_names].fetch(array_param_name, param)
-                              messages.map { |message| "#{param_name} #{message}"}
-                            end
+        def messages_for(param, messages)
+          if messages.is_a?(Hash)
+            process_hash_messages(param, messages)
+          else
+            full_messages_for(param, messages)
           end
         end
+
+        def process_hash_messages(param, messages)
+          param_is_array = messages.first[0].is_a?(Integer)
+
+          messages.each_with_object({}) do |(_param, msgs), result|
+            param_name = if param_is_array
+                           @array_params.fetch(param, _param)
+                         else
+                           _param
+                         end
+
+            result[_param] = messages_for(param_name, msgs)
+          end
+        end
+
+        def full_messages_for(param_name, messages)
+          messages.map { |message| build_full_message(param_name, message) }
+        end
+
+        def build_full_message(param_name, message)
+          "#{param_name} #{message}"
+        end
       end
     end
 

data/lib/fend/version.rb

@@ -5,7 +5,7 @@ class Fend
 
   module VERSION
     MAJOR = 0
-    MINOR = 2
+    MINOR = 3
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].compact.join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fend
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aleksandar Radunovic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2018-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -40,7 +40,7 @@ dependencies:
         version: '0'
 description: Small and extensible data validation toolkit
 email:
-- aleksandar@radunovic.io
+- a.radunovic@pm.me
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -49,8 +49,8 @@ files:
 - README.md
 - fend.gemspec
 - lib/fend.rb
+- lib/fend/plugins/base_errors.rb
 - lib/fend/plugins/coercions.rb
-- lib/fend/plugins/collective_params.rb
 - lib/fend/plugins/contexts.rb
 - lib/fend/plugins/data_processing.rb
 - lib/fend/plugins/dependencies.rb
@@ -61,7 +61,7 @@ files:
 - lib/fend/plugins/validation_options.rb
 - lib/fend/plugins/value_helpers.rb
 - lib/fend/version.rb
-homepage: https://fend.radunovic.io
+homepage: https://aradunovic.github.io/fend
 licenses:
 - MIT
 metadata: {}
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Small and extensible data validation toolkit

data/lib/fend/plugins/collective_params.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-class Fend
-  module Plugins
-    # *[DEPRECATED] `collective_params` plugin allows you to specify multiple params at once,
-    # instead of defining each one separately.
-    #
-    # Example:
-    #
-    #     plugin :collective_params
-    #     plugin :validation_helpers # just to make the example more concise
-    #
-    #     validate do |i|
-    #       i.params(:name, :email, :address) do |name, email, address|
-    #         name.validate_presence
-    #
-    #         email.validate_format(EMAIL_REGEX)
-    #
-    #         address.params(:city, :street, :zip) do |city, street, zip|
-    #           # ...
-    #         end
-    #       end
-    #     end
-    #
-    # Since all params are then available in the same scope, you can add custom
-    # validations more easily:
-    #
-    #     validate do |i|
-    #       i.params(:started_at, :ended_at) do |started_at, ended_at|
-    #         started_at.validate_presence
-    #         started_at.validate_type(Time)
-    #
-    #         ended_at.validate_presence
-    #         ended_at.validate_type(Time)
-    #
-    #         if started_at.valid? && ended_at.valid? && started_at > ended_at
-    #           started_at.add_error("must happen before ended_at")
-    #         end
-    #       end
-    #     end
-    module CollectiveParams
-      module ParamMethods
-        warn("collective_params plugin is deprecated and will be removed in Fend 0.3.0. #params method is now provided out of the box.")
-
-        def params(*names, &block)
-          return if flat? && invalid?
-
-          params = names.each_with_object({}) do |name, result|
-            param = _build_param(name, self[name])
-            result[name] = param
-          end
-
-          yield(*params.values)
-
-          params.each { |name, param| _nest_errors(name, param.errors) if param.invalid? }
-        end
-      end
-    end
-
-    register_plugin(:collective_params, CollectiveParams)
-  end
-end