active_model-errors_details 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73354179ee7bcde3fc9788714870cd06981c32ec
+  data.tar.gz: 21b27aa4a7b13a411c780fd2b7af3316686a5843
+SHA512:
+  metadata.gz: 0ff23f9ae379f31dc5728421dd8caa798067b95719cda49182f1fc3a261d184d137bc13873371eb6365f3b6af285c58a51464fa31fc8a922c96754ebdf4380bd
+  data.tar.gz: 5014f82de304d637c761b7033f0d55b471743cba24e57807995193ed3a09c7040bf1346eb88d2ae40194bfd16ef6b64528cd8824bc30657338bb3875a62ee122

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+cache: bundler
+notifications:
+  disabled: true
+rvm:
+  - 2.2

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Wojciech Wnętrzak
+
+MIT License
+
+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,64 @@
+# ActiveModel::Errors#details
+
+Feature backported from Rails 5.0 to use with Rails 4.x apps.
+
+Background: https://github.com/rails/rails/pull/18322
+
+## Installation
+
+```
+gem install "active_model-errors_details"
+```
+
+## Usage
+
+To check what validator type was used on invalid attribute, you can use
+`errors.details[:attribute]`. It returns array of hashes where under `:error`
+ key you will find symbol of used validator.
+
+```ruby
+class Person < ActiveRecord::Base
+  validates :name, presence: true
+end
+
+person = Person.new
+person.valid?
+person.errors.details[:name]
+# => [{error: :blank}]
+```
+
+You can add validator type to details hash when using `errors.add` method.
+
+```ruby
+class Person < ActiveRecord::Base
+  def a_method_used_for_validation_purposes
+    errors.add(:name, :invalid_characters)
+  end
+end
+
+person = Person.create(name: "!@#")
+
+person.errors.details[:name]
+# => [{error: :invalid_characters}]
+```
+
+To improve error details to contain not allowed characters set, you can
+pass additional options to `errors.add` method.
+
+```ruby
+class Person < ActiveRecord::Base
+  def a_method_used_for_validation_purposes
+    errors.add(:name, :invalid_characters, not_allowed: "!@#%*()_-+=")
+  end
+end
+
+person = Person.create(name: "John!")
+
+person.errors.details[:name]
+# => [{error: :invalid_characters, not_allowed: "!@#%*()_-+="}]
+```
+
+All built in Rails validators populate details hash with corresponding
+validator types.
+
+[![Build Status](https://travis-ci.org/cowbell/active_model-email_confirmation.svg)](https://travis-ci.org/cowbell/active_model-email_confirmation)

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task default: :test

data/active_model-errors_details.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model/errors_details/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model-errors_details"
+  spec.version       = ActiveModel::ErrorsDetails::VERSION
+  spec.authors       = ["Wojciech Wnętrzak"]
+  spec.email         = ["w.wnetrzak@gmail.com"]
+  spec.summary       = %q{Adds ActiveModel::Errors#details to return type of used validator}
+  spec.description   = %q{Backported from Rails 5.0 to use with 4.x versions}
+  spec.homepage      = "https://github.com/cowbell/active_model-errors_details"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel", ">= 4.0", "< 5.0.0.alpha"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/active_model/errors_details/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  module ErrorsDetails
+    VERSION = "1.0.0"
+  end
+end

data/lib/active_model/errors_details.rb

@@ -0,0 +1,61 @@
+require "active_model/errors_details/version"
+require "active_model/errors"
+
+module ActiveModel
+  module ErrorsDetails
+    MESSAGE_OPTIONS = [:message]
+
+    def self.included(base)
+      base.class_eval do
+        alias_method :initialize_without_details, :initialize
+        alias_method :initialize, :initialize_with_details
+
+        # alias_method :initialize_dup_without_details, :initialize_dup
+        # alias_method :initialize_dup, :initialize_dup_with_details
+
+        alias_method :delete_without_details, :delete
+        alias_method :delete, :delete_with_details
+
+        alias_method :clear_without_details, :clear
+        alias_method :clear, :clear_with_details
+
+        alias_method :add_without_details, :add
+        alias_method :add, :add_with_details
+      end
+    end
+
+    # def initialize_dup_with_details(other)
+    #   @details = other.details.dup
+    #   initialize_dup_without_details(other)
+    # end
+
+    def details
+      @details
+    end
+
+    def initialize_with_details(base)
+      @details = Hash.new { |details, attribute| details[attribute] = [] }
+      initialize_without_details(base)
+    end
+
+    def delete_with_details(key)
+      details.delete(key)
+      delete_without_details(key)
+    end
+
+    def clear_with_details
+      details.clear
+      clear_without_details
+    end
+
+    def add_with_details(attribute, message = :invalid, options = {})
+      message = message.call if message.respond_to?(:call)
+
+      error = {error: message}.merge(options.except(*::ActiveModel::Errors::CALLBACKS_OPTIONS + MESSAGE_OPTIONS))
+      details[attribute.to_sym] << error
+      add_without_details(attribute, message, options)
+    end
+  end
+end
+
+ActiveModel::Errors.include(ActiveModel::ErrorsDetails)

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "active_model/errors_details"
+
+require "minitest/autorun"

data/test/test_errors_details.rb

@@ -0,0 +1,93 @@
+require "minitest_helper"
+# Bug in rails dependencies
+# https://github.com/rails/rails/pull/18619
+require "active_support/core_ext/module/remove_method"
+require "active_model/naming"
+
+class TestErrorsDetails < MiniTest::Unit::TestCase
+  class Person
+    extend ActiveModel::Naming
+
+    def initialize
+      @errors = ActiveModel::Errors.new(self)
+    end
+
+    attr_accessor :name, :age
+    attr_reader   :errors
+
+    def validate
+      errors.add(:name, :blank) if name == nil
+      errors.add(:age, :too_young, years: 20) if age && age < 20
+    end
+
+    def read_attribute_for_validation(attr)
+      send(attr)
+    end
+
+    def self.human_attribute_name(attr, options = {})
+      attr
+    end
+
+    def self.lookup_ancestors
+      []
+    end
+  end
+
+  def test_returns_empty_array_when_no_errors
+    person = Person.new
+    person.name = "John"
+    person.validate
+
+    assert_empty person.errors.details[:name]
+  end
+
+  def test_adds_details
+    person = Person.new
+    person.validate
+
+    assert_equal({name: [{error: :blank}]}, person.errors.details)
+  end
+
+  def test_adds_details_with_custom_value
+    person = Person.new
+    person.age  = 18
+    person.validate
+
+    assert_equal [{error: :too_young, years: 20}], person.errors.details[:age]
+  end
+
+  def test_do_not_include_message_option
+    person = Person.new
+    person.errors.add(:name, :invalid, message: "is bad")
+
+    assert_equal({name: [{error: :invalid}] }, person.errors.details)
+  end
+
+  # TODO: investigate why it doesn't work
+  # def test_dup_duplicates_details
+  #   errors = ActiveModel::Errors.new(Person.new)
+  #   errors.add(:name, :invalid)
+  #   errors_dup = errors.dup
+  #   errors_dup.add(:name, :taken)
+
+  #   refute_equal errors_dup.details, errors.details
+  # end
+
+  def test_delete_removes_details_on_given_attribute
+    errors = ActiveModel::Errors.new(Person.new)
+    errors.add(:name, :invalid)
+    errors.delete(:name)
+
+    assert_empty errors.details[:name]
+  end
+
+  def test_clear_removes_details
+    person = Person.new
+    person.errors.add(:name, :invalid)
+
+    assert_equal 1, person.errors.details.count
+    person.errors.clear
+
+    assert_empty person.errors.details
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: active_model-errors_details
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Wojciech Wnętrzak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.alpha
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.alpha
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: Backported from Rails 5.0 to use with 4.x versions
+email:
+- w.wnetrzak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_model-errors_details.gemspec
+- lib/active_model/errors_details.rb
+- lib/active_model/errors_details/version.rb
+- test/minitest_helper.rb
+- test/test_errors_details.rb
+homepage: https://github.com/cowbell/active_model-errors_details
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Adds ActiveModel::Errors#details to return type of used validator
+test_files:
+- test/minitest_helper.rb
+- test/test_errors_details.rb
+has_rdoc: