hanami-controller 1.1.0.beta1 → 1.1.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79d8fab970716e6c18ccce8a0e594ab23ff0e611
-  data.tar.gz: 1f7d27447cb47de7188bceae96aef46d32e48fb9
+  metadata.gz: 158fe86057c438e5d32d4deafa0913972f98db7a
+  data.tar.gz: e2b1ab0f2a7edbc8ac0ccac2cc53a8bd13971c6a
 SHA512:
-  metadata.gz: fbd7ab49602fc8f4d7639eb4c59a8629b2eb1f32d35585e71fa21d5c1ec698509efe1511a4aa1cfe1273161ad63da75948c8ccb69d6abdda3e1bb6a8417b4daa
-  data.tar.gz: 6b4580064f085f43cff37b4a94b273241e633b98a4f452d8e8655ba2fad6654c4dcc4807d16bb777ee88a0755c5f31fe002d2525babe08ce8c113284f110d0bc
+  metadata.gz: 89839ef85004ad52c5ca5a4318b8bae4e95bee858d6f6c15b72a7031440600ebc8f00669c1bf3aac0073834d08e24983ba18e47404ef8dc565933e10da308d6b
+  data.tar.gz: d2851a8b925d3c22a59b0469bcd61edead0d977af5a8713931d90b4060f8d44090741a10caeda8a749db22b4f6c63ac9ed390197c90f645c726587a6d1372ee0

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Hanami::Controller
 Complete, fast and testable actions for Rack
 
+## v1.1.0.beta2 - 2017-10-03
+### Added
+- [Luca Guidi] Introduce `Hanami::Action::Params::Errors#add` to add errors not generated by params validations
+
 ## v1.1.0.beta1 - 2017-08-11
 
 ## v1.0.1 - 2017-07-10

data/hanami-controller.gemspec

@@ -20,10 +20,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_dependency 'rack',         '~> 2.0'
-  spec.add_dependency 'hanami-utils', '1.1.0.beta1'
+  spec.add_dependency 'hanami-utils', '1.1.0.beta2'
 
   spec.add_development_dependency 'bundler',   '~> 1.6'
   spec.add_development_dependency 'rack-test', '~> 0.6'
-  spec.add_development_dependency 'rake',      '~> 11'
-  spec.add_development_dependency 'rspec',     '~> 3.5'
+  spec.add_development_dependency 'rake',      '~> 12'
+  spec.add_development_dependency 'rspec',     '~> 3.6'
 end

data/lib/hanami/action/params.rb

@@ -16,6 +16,100 @@ module Hanami
     class Params < BaseParams
       include Hanami::Validations::Form
 
+      # Params errors
+      #
+      # @since 1.1.0
+      class Errors < SimpleDelegator
+        # @since 1.1.0
+        # @api private
+        def initialize(errors = {})
+          super(errors)
+        end
+
+        # Add an error to the param validations
+        #
+        # This has a semantic similar to `Hash#dig` where you use a set of keys
+        # to get a nested value, here you use a set of keys to set a nested
+        # value.
+        #
+        # @param args [Array<Symbol, String>] an array of arguments: the last
+        #   one is the message to add (String), while the beginning of the array
+        #   is made of keys to reach the attribute.
+        #
+        # @raise [ArgumentError] when try to add a message for a key that is
+        #   already filled with incompatible message type.
+        #   This usually happens with nested attributes: if you have a `:book`
+        #   schema and the input doesn't include data for `:book`, the messages
+        #   will be `["is missing"]`. In that case you can't add an error for a
+        #   key nested under `:book`.
+        #
+        # @since 1.1.0
+        #
+        # @example Basic usage
+        #   require "hanami/controller"
+        #
+        #   class MyAction
+        #     include Hanami::Action
+        #
+        #     params do
+        #       required(:book).schema do
+        #         required(:isbn).filled(:str?)
+        #       end
+        #     end
+        #
+        #     def call(params)
+        #       # 1. Don't try to save the record if the params aren't valid
+        #       return unless params.valid?
+        #
+        #       BookRepository.new.create(params[:book])
+        #     rescue Hanami::Model::UniqueConstraintViolationError
+        #       # 2. Add an error in case the record wasn't unique
+        #       params.errors.add(:book, :isbn, "is not unique")
+        #     end
+        #   end
+        #
+        # @example Invalid argument
+        #   require "hanami/controller"
+        #
+        #   class MyAction
+        #     include Hanami::Action
+        #
+        #     params do
+        #       required(:book).schema do
+        #         required(:title).filled(:str?)
+        #       end
+        #     end
+        #
+        #     def call(params)
+        #       puts params.to_h   # => {}
+        #       puts params.valid? # => false
+        #       puts params.error_messages # => ["Book is missing"]
+        #       puts params.errors         # => {:book=>["is missing"]}
+        #
+        #       params.errors.add(:book, :isbn, "is not unique") # => ArgumentError
+        #     end
+        #   end
+        def add(*args)
+          *keys, key, error = args
+          _nested_attribute(keys, key) << error
+        rescue TypeError
+          raise ArgumentError.new("Can't add #{args.map(&:inspect).join(', ')} to #{inspect}")
+        end
+
+        private
+
+        # @since 1.1.0
+        # @api private
+        def _nested_attribute(keys, key)
+          if keys.empty?
+            self
+          else
+            keys.inject(self) { |result, k| result[k] ||= {} }
+            dig(*keys)
+          end[key] ||= []
+        end
+      end
+
       # This is a Hanami::Validations extension point
       #
       # @since 0.7.0
@@ -71,6 +165,7 @@ module Hanami
         super(_extract_params)
         @result = validate
         @params = _params
+        @errors = Errors.new(@result.messages)
         freeze
       end
 
@@ -92,9 +187,7 @@ module Hanami
       # @example
       #   params.errors
       #     # => {:email=>["is missing", "is in invalid format"], :name=>["is missing"], :tos=>["is missing"], :age=>["is missing"], :address=>["is missing"]}
-      def errors
-        @result.messages
-      end
+      attr_reader :errors
 
       # Returns flat collection of full error messages
       #
@@ -129,7 +222,7 @@ module Hanami
       # @example
       #   params.valid? # => true
       def valid?
-        @result.success?
+        errors.empty?
       end
 
       # Serialize params to Hash

data/lib/hanami/controller/version.rb

@@ -3,6 +3,6 @@ module Hanami
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '1.1.0.beta1'.freeze
+    VERSION = '1.1.0.beta2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-controller
 version: !ruby/object:Gem::Version
-  version: 1.1.0.beta1
+  version: 1.1.0.beta2
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2017-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0.beta1
+        version: 1.1.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0.beta1
+        version: 1.1.0.beta2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 description: Complete, fast and testable actions for Rack
 email:
 - me@lucaguidi.com
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Complete, fast and testable actions for Rack and Hanami