hanami-validations 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99ff96a9cb4892a83e5856bc634d177c66d6f37c
-  data.tar.gz: f0ecb809653141a79d11829105c67d9d1ed3df23
+  metadata.gz: 11ba5bd5d5dd82bd7d723d7bad916028703973d5
+  data.tar.gz: c721ce2fe3e43b0ce9871665067b1f1c8a63258f
 SHA512:
-  metadata.gz: c2290ef3644c39145c4c98278881acab876ba15ba73b85a5de6e597d111a9cd64cd27801067ddcfaa4c42922ccdd513e056d6181c8b8b296f0543e0e4b74c2d4
-  data.tar.gz: 4f5e9e1c02ed5565329c26f029984b02112b0744de1a21e5bdf96e4953ff410de916aff632721b5327ea33be8813b7b42d2fde4fed232839b1ff7ff7f792508d
+  metadata.gz: b9e0c5073c472ac6237c4a214f77164a0d717c7603c4fc545de6261b055cbf57e4c1f5bad7442920796c9e50ed955f4ff599e349fd718ee8813042256a2ef612
+  data.tar.gz: d27480a8a99a337a7673d303dfe70a2c36bd81555595f9938ab5360c813a1877fd5008ba6116636e226e4485c24e60758a2a4ba5ec5c7c320cd9728ff8a2a15c

data/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Hanami::Validations
 Validations mixin for Ruby objects
 
+## v1.0.0.beta2 - 2017-03-17
+
 ## v1.0.0.beta1 - 2017-02-14
 ### Added
 - [Luca Guidi] Official support for Ruby: MRI 2.4

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2016 Luca Guidi
+Copyright © 2014-2017 Luca Guidi
 
 MIT License
 

data/README.md

@@ -682,11 +682,11 @@ To be used like this:
 class SignupValidator
   include Hanami::Validations
   messages_path 'config/messages.yml'
-  
+
   predicate :email? do |current|
     # ...
   end
-  
+
   validations do
     required(:email).filled(:str?, :email?)
     required(:age).filled(:int?, gt?: 18)
@@ -798,6 +798,6 @@ Thanks to [dry-rb](http://dry-rb.org) Community for their priceless support. ❤
 
 ## Copyright
 
-Copyright © 2014-2016 Luca Guidi – Released under MIT License
+Copyright © 2014-2017 Luca Guidi – Released under MIT License
 
 This project was formerly known as Lotus (`lotus-validations`).

data/lib/hanami/validations.rb

@@ -11,6 +11,7 @@ Dry::Validation::Messages::Namespaced.configure do |config|
   ).freeze
 end
 
+# @since 0.1.0
 module Hanami
   # Hanami::Validations is a set of lightweight validations for Ruby objects.
   #
@@ -39,8 +40,7 @@ module Hanami
     # @api private
     #
     # @see http://www.ruby-doc.org/core/Module.html#method-i-included
-    # rubocop:disable Metrics/MethodLength
-    def self.included(base)
+    def self.included(base) # rubocop:disable Metrics/MethodLength
       base.class_eval do
         extend ClassMethods
 
@@ -55,7 +55,6 @@ module Hanami
         self._predicates = Set.new
       end
     end
-    # rubocop:enable Metrics/MethodLength
 
     # Validations DSL
     #
@@ -67,7 +66,9 @@ module Hanami
       #
       # @since 0.6.0
       #
-      # @example
+      # @see http://hanamirb.org/guides/validations/overview/
+      #
+      # @example Basic Example
       #   require 'hanami/validations'
       #
       #   class Signup
@@ -78,8 +79,18 @@ module Hanami
       #     end
       #   end
       #
-      # rubocop:disable Metrics/AbcSize
-      def validations(&blk)
+      #   result = Signup.new(name: "Luca").validate
+      #
+      #   result.success? # => true
+      #   result.messages # => []
+      #   result.output   # => {:name=>""}
+      #
+      #   result = Signup.new(name: "").validate
+      #
+      #   result.success? # => false
+      #   result.messages # => {:name=>["must be filled"]}
+      #   result.output   # => {:name=>""}
+      def validations(&blk) # rubocop:disable Metrics/AbcSize
         schema_predicates = _predicates_module || __predicates
 
         base   = _build(predicates: schema_predicates, &_base_rules)
@@ -90,7 +101,6 @@ module Hanami
 
         self.schema = schema.new
       end
-      # rubocop:enable Metrics/AbcSize
 
       # Define an inline predicate
       #
@@ -300,15 +310,16 @@ module Hanami
 
       # @since 0.6.0
       # @api private
-      # rubocop:disable Metrics/MethodLength
-      def __messages
+      def __messages # rubocop:disable Metrics/MethodLength
         result = _predicates.each_with_object({}) do |p, ret|
           ret[p.name] = p.message
         end
 
+        # @api private
         Module.new do
           @@__messages = result # rubocop:disable Style/ClassVars
 
+          # @api private
           def self.extended(base)
             base.instance_eval do
               def __messages
@@ -317,6 +328,7 @@ module Hanami
             end
           end
 
+          # @api private
           def messages
             engine = super
 
@@ -328,7 +340,6 @@ module Hanami
           end
         end
       end
-      # rubocop:enable Metrics/MethodLength
     end
 
     # Initialize a new instance of a validator

data/lib/hanami/validations/predicates.rb

@@ -9,7 +9,7 @@ module Hanami
     #
     # @see Hanami::Validations::ClassMethods#predicates
     #
-    # @example
+    # @example Inline Predicate
     #   require 'hanami/validations'
     #
     #   module MySharedPredicates

data/lib/hanami/validations/version.rb

@@ -1,6 +1,6 @@
 module Hanami
   module Validations
     # @since 0.1.0
-    VERSION = '1.0.0.beta1'.freeze
+    VERSION = '1.0.0.beta2'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-validations
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-14 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils