formalism-r18n_errors 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcf5355aaae24c4d6f11fab3b1e12db6bfaf22787e796e86c04b1d55aba23a81
+  data.tar.gz: 6c1d095c383a63a90199be313376fec2aa181fe22ea3a740d37d69d23e20807d
+SHA512:
+  metadata.gz: 53838438aef5b7d043e828d45b6bd80ef9635aab86d9428afbccb13fb1d2e1d7f8bce096cf50fe818147d741c05f2f9574b25cb68ffe845283ac2c494a8a3e79
+  data.tar.gz: 12bd780ec37f522802138712980c2e2b93da72ed5ae604dd0d98803832105c56a273dd09744e5378b4b94c3d4f4c4d25cfc45f498abcd0882e4726ccf63dfa18

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## master (unreleased)
+
+## 0.2.0 (2020-09-24)
+
+## 0.1.3 (2020-09-23)
+
+*   Add specs for anything, especially for `ValidationHelpers`.
+    Make code coverage 100%.
+*   Add documentation about `ValidationHelpers`.
+
+## 0.1.2 (2020-09-22)
+
+*   Require `gorilla_patch/blank` before its usage.
+
+## 0.1.1 (2020-09-22)
+
+*   Fix the issue with unknown `Forwardable` constant.
+
+## 0.1.0 (2020-07-10)
+
+*   Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexander Popov
+
+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,153 @@
+# Formalism R18n Errors
+
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/formalism-r18n_errors?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/formalism-r18n_errors)
+[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/formalism-r18n_errors/master.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/formalism-r18n_errors)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/formalism-r18n_errors.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/formalism-r18n_errors)
+[![Depfu](https://img.shields.io/depfu/AlexWayfer/benchmark_toys?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/formalism-r18n_errors)
+[![Inline docs](https://inch-ci.org/github/AlexWayfer/formalism-r18n_errors.svg?branch=master)](https://inch-ci.org/github/AlexWayfer/formalism-r18n_errors)
+[![license](https://img.shields.io/github/license/AlexWayfer/formalism-r18n_errors.svg?style=flat-square)](LICENSE.txt)
+[![Gem](https://img.shields.io/gem/v/formalism-r18n_errors.svg?style=flat-square)](https://rubygems.org/gems/formalism-r18n_errors)
+
+Errors for [Formalism](https://github.com/AlexWayfer/formalism)
+via [R18n](https://github.com/r18n/r18n).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'formalism-r18n_errors'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install formalism-r18n_errors
+```
+
+## Usage
+
+```ruby
+require 'formalism/r18n_errors'
+
+module MyProject
+  module Forms
+    class Base < Formalism::Form
+      include Formalism::R18nErrors
+
+      def initialize(*)
+        ## This is an example, but some value is required
+        @errors_key = self.class.name.split('::')[2].underscore.to_sym
+
+        super
+      end
+    end
+
+    class GeoLocation < Base
+      field :address
+    end
+
+    class User < Base
+      field :name, String
+
+      ## `:errors_key` can be changed for nested forms
+      nested :location, GeoLocation, errors_key: :geolocation
+
+      private
+
+      def validate
+        ## `add_error` is the alias for `errors.add errors_key, *` (`:user` in this case)
+        add_error :name, :is_empty if name.to_s.empty?
+      end
+    end
+  end
+end
+```
+
+### Validation Helpers
+
+```ruby
+require 'formalism/r18n_errors/validation_helpers'
+
+module MyProject
+  module Forms
+    class Base < Formalism::Form
+      include Formalism::R18nErrors
+      include Formalism::R18nErrors::ValidationHelpers
+
+      # ...
+    end
+
+    class User < Base
+      field :name, String
+      field :country
+      field :city
+      field :score, Float
+      field :email, String
+
+      nested :location, GeoLocation
+
+      private
+
+      def validate
+        ## `errors.user.name.not_entered`
+        validate_entry :name
+
+        ## `errors.user.country.not_chosen`
+        ## `errors.user.city.not_chosen`
+        validate_choice %i[country city]
+
+        ## `errors.user.location.not_provided`
+        validate_provision :location
+
+        ## `errors.user.name.greater_than(20)`
+        validate_max_length :name, 20
+
+        ## `errors.user.name.less_than(3)`
+        validate_min_length :name, 3
+
+        ## `errors.user.score.greater_than(5)`
+        ## or
+        ## `errors.user.score.less_than(1)`
+        validate_range_entry :score, 1..5
+
+        ## Requires `email_address` gem
+        ## `errors.user.email.not_valid_email`
+        validate_email :email
+
+        ## Requires `formalism-model_form` gem
+        ## `errors.user.email.already_taken`
+        validate_uniqueness :email
+        ## `errors.user.itself.already_exists.country_and_city`
+        validate_uniqueness %i[country city]
+      end
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+Then, run `toys rspec` to run the tests.
+
+To install this gem onto your local machine, run `toys gem install`.
+
+To release a new version, run `toys gem release %version%`.
+See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/formalism-r18n_errors).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/lib/formalism/r18n_errors.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'formalism'
+
+require_relative 'r18n_errors/version'
+require_relative 'r18n_errors/errors'
+
+module Formalism
+	## Main module which should be included into base form
+	module R18nErrors
+		def initialize(*)
+			## `@errors_key` should be set in using form
+			@errors = Errors.new
+
+			super
+		end
+
+		protected
+
+		attr_accessor :errors_key
+		attr_reader :errors
+
+		private
+
+		def initialize_nested_form(name, options)
+			return unless (form = super)
+
+			form.errors_key = options.fetch(:errors_key, name)
+			form
+		end
+
+		def add_error(*args, **kwargs)
+			raise '`@errors_key` is required' unless errors_key
+
+			errors.add errors_key, *args, **kwargs
+		end
+
+		def merge_errors_of_nested_form(name, nested_form)
+			add_error name, nested_errors: nested_form.errors
+		end
+
+		def nested_form_to_params(_name_of_nested_form, nested_form)
+			return super if nested_form.errors_key
+
+			nested_form.to_params
+		end
+	end
+end

data/lib/formalism/r18n_errors/errors.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'r18n-core'
+
+module Formalism
+	module R18nErrors
+		## Class for errors collection
+		class Errors
+			extend Forwardable
+
+			def_delegators :@hash, :any?, :empty?, :clear, :to_json
+
+			include R18n::Helpers
+
+			## class for translation hash creation
+			class ErrorTranslator
+				def initialize(translations, form_errors)
+					@translations = translations
+					@form_errors = form_errors
+					@result = Hash.new { |hsh, key| hsh[key] = Hash.new(&hsh.default_proc) }
+				end
+
+				def translate(prefixes)
+					@form_errors.each do |model_key, errors|
+						errors.each do |error|
+							if error[:rest_keys]
+								insert_translation_in_result(error, model_key, prefixes)
+							else
+								merge_nested_translations_with_result(error, prefixes)
+							end
+						end
+					end
+					@result
+				end
+
+				private
+
+				def insert_translation_in_result(error, model_key, prefixes)
+					translation_keys = error[:rest_keys][0..-2].unshift(model_key)
+					edge_key = error[:rest_keys].last
+					args = error[:translation_args]
+
+					@result.dig(*translation_keys)[edge_key] =
+						@translations.dig(*prefixes + translation_keys)[edge_key, args]
+				end
+
+				def merge_nested_translations_with_result(error, prefixes)
+					nested_hash = error[:nested_errors].translations_hash(*prefixes)
+					nested_hash = nested_hash[nil] while nested_hash.key?(nil)
+					@result.merge! nested_hash
+				end
+			end
+
+			private_constant :ErrorTranslator
+
+			def initialize
+				@hash = Hash.new do |hash, model|
+					hash[model] = Hash.new do |model_hash, field|
+						model_hash[field] = []
+					end
+				end
+			end
+
+			def add(model_key, field_key, *rest_keys, args: nil, nested_errors: nil)
+				@hash[model_key][field_key].push(
+					if nested_errors
+						{ nested_errors: nested_errors }
+					else
+						{ rest_keys: rest_keys, translation_args: args }
+					end
+				)
+			end
+
+			def translations(*prefixes)
+				@hash.flat_map do |model_key, field_hash|
+					field_hash.flat_map do |field_key, errors_array|
+						errors_array.flat_map do |error|
+							translate prefixes, model_key, field_key, error
+						end
+					end
+				end
+			end
+
+			def translations_hash(*prefixes)
+				prefixes.push(@hash.keys.first) if @hash.keys.first
+				@hash.transform_values do |errors|
+					ErrorTranslator.new(t.error, errors).translate(prefixes)
+				end
+			end
+
+			private
+
+			def translate(prefixes, model_key, field_key, error)
+				if (nested_errors = error[:nested_errors])
+					return nested_errors.translations(*prefixes, model_key)
+				end
+
+				rest_keys = error.fetch(:rest_keys)
+				t.error
+					.dig(*[*prefixes, model_key, field_key].compact, *rest_keys[0..-2])
+					.public_send(rest_keys.last, error[:translation_args])
+			end
+		end
+
+		private_constant :Errors
+	end
+end

data/lib/formalism/r18n_errors/validation_helpers.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'gorilla_patch/blank'
+
+module Formalism
+	module R18nErrors
+		## Helper methods for validations
+		module ValidationHelpers
+			private
+
+			using GorillaPatch::Blank
+
+			def validate_provision(*validation_fields, error_key: :not_provided)
+				valid = true
+				validation_fields.flatten.each do |validation_field|
+					next unless field_changed?(validation_field)
+					next if field_valid?(validation_field)
+
+					valid = false
+					add_error validation_field, error_key
+				end
+				valid
+			end
+
+			def validate_entry(*validation_fields)
+				validate_provision(*validation_fields, error_key: :not_entered)
+			end
+
+			def validate_choice(*validation_fields)
+				validate_provision(*validation_fields, error_key: :not_chosen)
+			end
+
+			def validate_max_length(validation_field, max_length)
+				return unless field_changed?(validation_field)
+
+				value = public_send(validation_field)
+				return true if value && value.length <= max_length
+
+				add_error validation_field, :greater_than, args: max_length
+				false
+			end
+
+			def validate_min_length(validation_field, min_length)
+				return unless field_changed?(validation_field)
+
+				value = public_send(validation_field)
+				return true if value && value.length >= min_length
+
+				add_error validation_field, :less_than, args: min_length
+				false
+			end
+
+			def validate_range_entry(validation_field, range)
+				return unless field_changed?(validation_field)
+
+				value = public_send(validation_field).to_f
+
+				add_error validation_field, :less_than, args: range.begin if value < range.begin
+
+				return if value.public_send (range.exclude_end? ? :< : :<=), range.end
+
+				add_error validation_field, :greater_than, args: range.end
+			end
+
+			## Requires `email_address` gem
+			def validate_email(*validation_fields)
+				valid = true
+				validation_fields.flatten.each do |validation_field|
+					next unless field_changed?(validation_field)
+					next if EmailAddress.valid? public_send(validation_field)
+
+					valid = false
+					add_error validation_field, :not_valid_email
+				end
+				valid
+			end
+
+			## Requires `formalism-model_form` gem
+			def validate_uniqueness(*fields_combinations)
+				valid = true
+				fields_combinations.each do |*fields_combination|
+					fields_combination.flatten!
+
+					next if fields_combination.none? { |field| field_changed?(field) }
+
+					next if unique_by_fields_combination? fields_combination
+
+					valid = false
+					add_error_for_uniqueness_validation fields_combination
+				end
+				valid
+			end
+
+			## Private methods for this module
+
+			def field_valid?(field)
+				result = true
+				if (nested_form = nested_forms[field])
+					result = nested_form.valid?
+					return result unless result
+
+					nested_form.run
+				end
+				result && !public_send(field).blank?
+			end
+
+			def unique_by_fields_combination?(fields_combination)
+				dataset = model.where(
+					fields_combination
+						.map { |field| field_condition(field, send(field)) }
+						.reduce(:&)
+				)
+				dataset = dataset.exclude(instance.pk_hash) if instance&.pk_hash
+				dataset.empty?
+			end
+
+			def add_error_for_uniqueness_validation(fields)
+				if fields.count == 1
+					add_error fields.first, :already_taken
+				else
+					add_error :itself, :already_exists, fields.join('_and_')
+				end
+			end
+
+			def field_changed?(_field)
+				true ## can be redefined, for example, in update forms
+			end
+		end
+	end
+end

data/lib/formalism/r18n_errors/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Formalism
+	module R18nErrors
+		VERSION = '0.2.0'
+	end
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: formalism-r18n_errors
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Alexander Popov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: formalism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: gorilla_patch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: r18n-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gem_toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.91.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.91.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 'Errors for Formalism via R18n.
+
+  '
+email:
+- alex.wayfer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/formalism/r18n_errors.rb
+- lib/formalism/r18n_errors/errors.rb
+- lib/formalism/r18n_errors/validation_helpers.rb
+- lib/formalism/r18n_errors/version.rb
+homepage: https://github.com/AlexWayfer/formalism-r18n_errors
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/AlexWayfer/formalism-r18n_errors
+  homepage_uri: https://github.com/AlexWayfer/formalism-r18n_errors
+  changelog_uri: https://github.com/AlexWayfer/formalism-r18n_errors/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Errors for Formalism via R18n
+test_files: []