validation-messages-for-hanami 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 778aab5e99b47bfd45eec10616c2e21b9ef34df5
+  data.tar.gz: c2d495c08841a73a2ad34450347dad68ad20c96f
+SHA512:
+  metadata.gz: fcc8c220e7f4f669a57c89cdb84d14162b5acd0a2a1c523dc02c9b95e43c2ecc00aa1a48090decc4bace33b66bbe0a57597ab0d7c0035c8fcaa5b30e9e254576
+  data.tar.gz: ca02a4a9ea105c691acaf1e27ec6c1c943d9d46ec56891a1ed8b66ef803e4e9e47320b5cfc4111d163798adeb93f95a44799311e26af4db612e422b89ae9d846

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--require spec-helper
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+   - "2.2"
+
+before_install: gem install bundler
+
+script: bundle exec rspec
+
+git:
+   submodules: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rspec', require: false
+gem 'simplecov', require: false
+gem 'coveralls', require: false
+gem 'hanami-validations', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 mrubi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,267 @@
+# Validation messages for Hanami
+
+A helper to customize the validation messages in [Hanami](http://hanamirb.org/) application views.
+
+Sometimes you need to customize a validation message based not only on the validation type and value, but also on the rendering context. That is, you may want the same validation on the same attribute with the same value to show different messages depending on the view you are rendering it. This helper allows you to do that nicely.
+
+Actually this helper does not depend on [Hanami::View](https://github.com/hanami/view) at all (only on [Hanami::Validations](https://github.com/hanami/validations), and even that could be easily tweaked using a different [DisplayableError](lib/validation-messages/displayable-error.rb) adaptor), so it also could be used with other frameworks different than [Hanami](http://hanamirb.org/), but since [Hanami](http://hanamirb.org/) is the framework that makes me feel good, the one that I love and choose, I don't give a shit about that.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/validation-messages-for-hanami.svg)](https://badge.fury.io/rb/validation-messages-for-hanami)
+[![Build Status](https://travis-ci.org/cabeza-de-termo/validation-messages-for-hanami.svg?branch=master)](https://travis-ci.org/cabeza-de-termo/validation-messages-for-hanami)
+[![Coverage Status](https://coveralls.io/repos/github/cabeza-de-termo/validation-messages-for-hanami/badge.svg?branch=master)](https://coveralls.io/github/cabeza-de-termo/validation-messages-for-hanami?branch=master)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validation-messages-for-hanami', '~> 0.1'
+```
+
+And then execute:
+
+    $ bundle install
+
+
+## Usage
+
+### Configuration
+
+If you want to customize the messages only in a particular view, do
+
+```ruby
+require 'validation-messages-for-hanami'
+
+module Web::Views::Person
+	class Create
+		include Web::View
+		include CabezaDeTermo::ValidationsMessages::Behaviour
+
+		validation_messages do
+			at :presence, on: 'person.address.street' do |error| 
+				"Please, fill in some contact address street."
+			end
+
+			at :presence, on: 'person.address.country' do |error| 
+				"Please, choose a country from the list."
+			end
+		end
+	end
+end
+```
+
+If you want to include the helper in all the views in the application, in your `application.rb` include
+
+```ruby
+require 'validation-messages-for-hanami'
+```
+
+and then
+
+```ruby
+# Configure the code that will yield each time Web::View is included
+# This is useful for sharing common functionality
+#
+# See: http://www.rubydoc.info/gems/hanami-view#Configuration
+view.prepare do
+	include Hanami::Helpers
+	include Web::Assets::Helpers
+
+	include CabezaDeTermo::ValidationsMessages::Behaviour
+	# If you want to customize the default messages for this application
+	# uncomment the next line and set your own validation messages library
+	# use_validation_messages_library WebValidationMessages.library
+```
+
+and now you can just use it in your views like
+
+```ruby
+module Web::Views::Person
+	class Create
+		include Web::View
+
+		validation_messages do
+			at :presence, on: 'person.address.street' do |error| 
+				"Please, fill in some contact address."
+			end
+
+			at :presence, on: 'person.address.country' do |error| 
+				"Please, choose a country from the list."
+			end
+		end
+	end
+end
+```
+
+### Customizing the validation messages
+
+To customize a validation message based on the validation type do
+
+```ruby
+module Web::Views::Person
+	class Create
+		include Web::View
+
+		validation_messages do
+			at :presence do |error| 
+				"#{error.attribute_name} must be present"
+			end
+		end
+	end
+end
+```
+
+To customize a validation message for a particular attribute do
+
+```ruby
+module Web::Views::Person
+	class Create
+		include Web::View
+
+		validation_messages do
+			at :presence, on: 'person.address.country' do |error| 
+				"Please, choose a country from the list."
+			end
+		end
+	end
+end
+```
+
+To customize the displayable name of an attribute in all the validation messages do
+
+```ruby
+module Web::Views::Person
+	class Create
+		include Web::View
+
+		validation_messages do
+			display :street, as: 'contact street address'
+
+			at :presence do |error| 
+				"#{error.attribute_name} must be present"
+			end
+		end
+	end
+end
+```
+
+and now `error.attribute_name` for `:street` attribute instead of displaying `'street'` will display `'contact street address'` in all the validation occurrences.
+
+### Customizing the default validations messages globally
+
+If you want to change the default validation messages globally in all your applications do 
+
+```ruby
+CabezaDeTermo::ValidationMessages::Library.default.configure do
+	message_for :presence do |error|
+		"can not be left blank"
+	end
+
+	message_for :acceptance do |error|
+		"must be accepted"
+	end
+
+	message_for :confirmation do |error|
+		"doesn't match"
+	end
+
+	message_for :inclusion do |error|
+		"isn't included"
+	end
+
+	message_for :exclusion do |error|
+		"shouldn't belong to #{ Array(error.expected).join(', ') }"
+	end
+
+	message_for :format do |error|
+		"doesn't match expected format"
+	end
+
+	message_for :size do |error|
+		"doesn't match expected size"
+	end
+end
+```
+
+### Customizing the default validation messages for a single application
+
+If you want to customize the validation messages only for an application, in the `application.rb` file do
+
+```ruby
+# Configure the code that will yield each time Web::View is included
+# This is useful for sharing common functionality
+#
+# See: http://www.rubydoc.info/gems/hanami-view#Configuration
+view.prepare do
+	include Hanami::Helpers
+	include Web::Assets::Helpers
+
+	include CabezaDeTermo::ValidationsMessages::Behaviour
+	use_validation_messages_library WebValidationMessages.library
+```
+
+and define
+
+```ruby
+class WebValidationMessages
+	def self.library
+		CabezaDeTermo::Validations::Messages::Library.new do
+			message_for :presence do |error|
+				"can not be left blank"
+			end
+
+			message_for :acceptance do |error|
+				"must be accepted"
+			end
+
+			message_for :confirmation do |error|
+				"doesn't match"
+			end
+
+			message_for :inclusion do |error|
+				"isn't included"
+			end
+
+			message_for :exclusion do |error|
+				"shouldn't belong to #{ Array(error.expected).join(', ') }"
+			end
+
+			message_for :format do |error|
+				"doesn't match expected format"
+			end
+
+			message_for :size do |error|
+				"doesn't match expected size"
+			end
+		end
+	end
+end
+```
+
+### Customizing the default validation messages for a single view
+
+If you want to customize the validation messages only for a view, in the view do
+
+```ruby
+module Web::Views::Person
+	class Create
+		include Web::View
+
+		validation_messages do
+			use_validation_messages_library SomeValidationMessages.library
+		end
+	end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cabeza-de-termo/validation-messages-for-hanami.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/validation-messages-for-hanami.rb

@@ -0,0 +1,9 @@
+require 'cdt/utilities'
+require 'validation-messages/version'
+require 'validation-messages/dictionary'
+require 'validation-messages/displayable-error'
+require 'validation-messages/library-configuration-dsl'
+require 'validation-messages/library'
+require 'validation-messages/behaviour'
+require 'validation-messages/default-validation-messages'
+

data/lib/validation-messages/behaviour.rb

@@ -0,0 +1,42 @@
+module CabezaDeTermo::ValidationMessages
+	module Behaviour
+		def self.included(base)
+			base.class_eval do
+				extend ClassMethods
+
+				use_validation_messages_library CabezaDeTermo::ValidationMessages::Library.default
+			end
+		end
+
+		module ClassMethods
+			def use_validation_messages_library(validation_messages_library)
+				@validation_messages_library = validation_messages_library
+			end
+
+			def validation_messages_library()
+				@validation_messages_library
+			end
+
+			def validation_messages_dictionary()
+				@validation_messages_dictionary ||= new_validation_messages_dictionary
+			end
+
+			def validation_messages(&block)
+				@validation_messages_dictionary = new_validation_messages_dictionary
+				CdT.bind_block_evaluation_to(@validation_messages_dictionary, &block)
+			end
+
+			def new_validation_messages_dictionary()
+				Dictionary.new(validation_messages_library)
+			end
+		end
+
+		def validation_messages_dictionary(&block)
+			self.class.validation_messages_dictionary(&block)
+		end
+
+		def validation_message_for(error)
+			validation_messages_dictionary.message_for error
+		end
+	end
+end

data/lib/validation-messages/default-validation-messages.rb

@@ -0,0 +1,29 @@
+CabezaDeTermo::ValidationMessages::Library.default.configure do
+	message_for :presence do |error|
+		"can not be left blank"
+	end
+
+	message_for :acceptance do |error|
+		"must be accepted"
+	end
+
+	message_for :confirmation do |error|
+		"doesn't match"
+	end
+
+	message_for :inclusion do |error|
+		"isn't included"
+	end
+
+	message_for :exclusion do |error|
+		"shouldn't belong to #{ Array(error.expected).join(', ') }"
+	end
+
+	message_for :format do |error|
+		"doesn't match expected format"
+	end
+
+	message_for :size do |error|
+		"doesn't match expected size"
+	end
+end

data/lib/validation-messages/dictionary.rb

@@ -0,0 +1,54 @@
+module CabezaDeTermo::ValidationMessages
+	class Dictionary
+		attr_reader :library
+
+		def initialize(library)
+			@messages = Hash.new { |hash, key| hash[key] = Hash[] }
+			@parameters_display_strings = Hash[]
+			@library = library
+		end
+
+		def use_validation_messages_library(library)
+			@library = library
+		end
+
+		def at(validation_name, on: nil, &block)
+			attribute = on.nil? ? CdT.undefined : on.to_sym
+			@messages[validation_name][attribute] = block
+		end
+
+		def display(parameter, as:)
+			@parameters_display_strings[parameter.to_sym] = as
+		end
+
+		def message_for(error)
+			CdT.object message_block_for(error),
+				if_not_nil: proc { |message_block| message_block.call(displayable_error_on(error)) },
+				if_nil: proc { library.message_for(displayable_error_on(error)) }
+		end
+
+		def display_string_for(error)
+			@parameters_display_strings[error.attribute_name.to_sym]
+		end
+
+		def displayable_error_on(error)
+			DisplayableError.on error, display_string: display_string_for(error)
+		end
+
+		protected
+
+		def message_block_for(error)
+			message_block_for_validation(error.validation, attribute: error.attribute)
+		end
+
+		def message_block_for_validation(validation, attribute:)
+			@messages
+				.fetch(validation, Hash[])
+				.fetch(attribute.to_sym, default_message_for_validation(validation))
+		end
+
+		def default_message_for_validation(validation)
+			@messages.fetch(validation, Hash[])[CdT.undefined]
+		end
+	end
+end

data/lib/validation-messages/displayable-error.rb

@@ -0,0 +1,24 @@
+module CabezaDeTermo::ValidationMessages
+	class DisplayableError
+		def self.on(validation_error, display_string: nil)
+			self.new(validation_error, display_string: display_string)
+		end
+
+		def initialize(validation_error, display_string: nil)
+			@validation_error = validation_error
+			@attribute_display_string = display_string
+		end
+
+		def attribute_name
+			no_attribute_display_string? ? @validation_error.attribute_name : @attribute_display_string
+		end
+
+		def method_missing(method_name, *args, &block)
+			@validation_error.send(method_name, *args, &block)
+		end
+
+		def no_attribute_display_string?()
+			@attribute_display_string.nil?
+		end
+	end
+end

data/lib/validation-messages/library-configuration-dsl.rb

@@ -0,0 +1,15 @@
+require 'lunfardo'
+
+module CabezaDeTermo::ValidationMessages
+	class LibraryConfigurationDSL
+		include CabezaDeTermo::Lunfardo::Behaviour
+
+		dsl do
+			on :message_for do |validation_message_name, &message_block|
+				perform do |validation_message_name, &message_block|
+					context.message_at(validation_message_name, &message_block)
+				end
+			end
+		end
+	end
+end

data/lib/validation-messages/library.rb

@@ -0,0 +1,36 @@
+module CabezaDeTermo::ValidationMessages
+	class Library
+		def self.default(library = nil)
+			@default_library = library unless library.nil?
+			@default_library
+		end
+
+		default self.new
+
+		def initialize(&block)
+			configure(&block) unless block.nil?
+		end
+
+		def configure(&block)
+			LibraryConfigurationDSL.evaluate_on(self, &block)
+		end
+
+		def message_at(validation_name, &block)
+			messages[validation_name] = block
+		end
+
+		def message_block_for(validation_name)
+			messages.fetch(validation_name)
+		end
+
+		def message_for(error)
+			message_block_for(error.validation).call(error)
+		end
+
+		protected
+
+		def messages
+			@messages ||= Hash[]
+		end
+	end
+end

data/lib/validation-messages/version.rb

@@ -0,0 +1,5 @@
+module CabezaDeTermo
+	module ValidationMessages
+		VERSION = "0.1.0"
+	end
+end

data/validation-messages-for-hanami.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'validation-messages/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "validation-messages-for-hanami"
+  spec.version       = CabezaDeTermo::ValidationMessages::VERSION
+  spec.authors       = ["Martin Rubi"]
+  spec.email         = ["martinrubi@gmail.com"]
+
+  spec.summary       = %q{Helper to customize the validation messages in Hanami application views.}
+  spec.homepage      = "https://github.com/cabeza-de-termo/validation-messages-for-hanami"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "cdt-utilities", "~> 0.4"
+  spec.add_dependency "lunfardo", "~> 0.1"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: validation-messages-for-hanami
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Rubi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cdt-utilities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: lunfardo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- martinrubi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/validation-messages-for-hanami.rb
+- lib/validation-messages/behaviour.rb
+- lib/validation-messages/default-validation-messages.rb
+- lib/validation-messages/dictionary.rb
+- lib/validation-messages/displayable-error.rb
+- lib/validation-messages/library-configuration-dsl.rb
+- lib/validation-messages/library.rb
+- lib/validation-messages/version.rb
+- validation-messages-for-hanami.gemspec
+homepage: https://github.com/cabeza-de-termo/validation-messages-for-hanami
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Helper to customize the validation messages in Hanami application views.
+test_files: []