error_merger 0.3.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c35e4e2ae8eef848df65fefdfcb904d9445d339c8fb6d60eb19d4160aefd701
-  data.tar.gz: 1b93fb6bfd6263a46d0f6c80541c52f490f8725da258fa44b7829a2ee2819591
+  metadata.gz: 87170e6fd3bc27364650b6f827e45f66f9d0d3c5396510db4818bb617db82c55
+  data.tar.gz: fa46155a9ce06b76259446361a70c8551691307bc39f818ad45c8da8517cd9fb
 SHA512:
-  metadata.gz: df19dc0542f489bbcba21ebb799aee4f4b2ed9a690b1b2890a4ba676717d0bf7e8b980583cf0d0a9306c92980973f227e8d2f696bf72f54fabd5e0f6454a4a40
-  data.tar.gz: acae8c5ea6186c23053aa80e9ed3c34070f4ba4d253a37f97f4206de29816fb80b7668e30c19c7759ca9b3dba57c60000ba86ea0f864349ab4c9a5c1d3a82c19
+  metadata.gz: cb16d0e6e035dd9a178484caee3b2c4ad89f549190d97bc9df76288d1c47c2e8579c6dca8844f26286f08323c5d578d224bd809101b75996fc57e48a6a7d0dd2
+  data.tar.gz: 244ec7c85feca9165e8293a09742a95d3003cafa85551fcabab2167d032f7d9ef7eaa81236fa2a8738e29b877e0bf8efd8353881b1f9ba559d96e42f7bb94290

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 thomas morgan
+Copyright (c) 2014-2019 thomas morgan
 
 MIT License
 

data/README.md

@@ -11,40 +11,80 @@ message always ends with a period.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+In your Gemfile, add:
 
     gem 'error_merger'
 
-And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install error_merger
+## Usage
 
+#### Merging
 
-## Usage
+```
+@user = User.new name: nil
+@user.valid? # => false
+@account = Account.new group: 'invalid'
+@account.valid? # => false
+
+## By default, will prefix with the merged model's name:
+@account.errors.merge @user
+@account.errors.full_messages  # will include errors for both Account and User
+# => ["Group is invalid", "User: Name can't be blank"]
+
+## Disable the prefix:
+@account.errors.merge @user, ''
+# @account.errors.merge @user, false  # equivalent to ''
+@account.errors.full_messages
+# => ["Group is invalid", "Name can't be blank"]
+
+## Or change it:
+@account.errors.merge @user, 'Member'
+@account.errors.full_messages
+# => ["Group is invalid", "Member Name can't be blank"]
+
+## By default, merged errors are associated with the model, not an association
+## (by adding the errors to :base). An attribute may be specified. Since the
+## standard rendering of the error message will use the attribute name as part
+## of the error message, auto-prefixing is disabled.
+@account.errors.merge @user, attribute: :user
+@account.errors.messages
+# => {group: ["is invalid"], user: ["Name can't be blank"]}
+@account.errors.full_messages
+# => ["Group is invalid", "User Name can't be blank"]
+
+## A prefix can still be added, however:
+@account.errors.merge @user, 'Member', attribute: :user
+@account.errors.full_messages
+# => ["Group is invalid", "User Member Name can't be blank"]
+```
 
+_Hint: to merge the actual attributes directly, use the built-in `merge!` method instead._
+```
+## This may cause weird behavior if both models have the same attribute (eg: both
+## have a :name attribute).
+@account.errors.merge! @user.errors
+@account.errors.messages
+# => {group: ["is invalid"], name: ["can't be blank"]}
+@account.errors.full_messages
+# => ["Group is invalid", "Name can't be blank"]
 ```
-  @user = User.new user_params
-  @user.valid? # => false
-  @account = Account.new account_params
-  @account.valid? # => false
-  @account.errors.merge @user
 
-  @account.errors.full_messages # => will include errors for both Account and User
 
-  @user.errors.full_messages # => ["Username can't be blank"]
-  @user.errors.full_sentences # => ["Username can't be blank."]
-  @user.errors.as_sentences # => "First name can't be blank. Last name can't be blank."
-```
+### Sentences
 
-By default merged errors are prefixed with the model name. In the above example, an error on User might look like: "User: First name must not be blank".
+```
+## Rails default behavior:
+@user.errors.full_messages
+# => ["Name can't be blank"]
 
-The default behavior is the equivalent to: `@account.errors.merge @user, 'User: '`
+## Make errors nicer for display to users:
+@user.errors.full_sentences
+# => ["Name can't be blank."]
 
-To skip prefixing, pass an empty string: `''`.
+## Combine sentences into a single string:
+@user.errors.join_sentences
+# => "First name can't be blank. Last name can't be blank."
+```
 
 
 ## Contributing

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/error_merger.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activemodel', '>= 4', '< 6'
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_dependency 'activemodel', '>= 5', '< 6.1'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

data/lib/error_merger.rb

@@ -1,2 +1,4 @@
+require 'active_model'
+
 require 'error_merger/version'
 require 'error_merger/error_merger'

data/lib/error_merger/error_merger.rb

@@ -2,17 +2,26 @@ module ErrorMerger
 
   # merges an association's Errors set into the current set
   # eg: @user.errors.merge @account
-  #     @user.errors.merge @account, "Account ##{@account.id}: "
-  def merge(association, prefix=nil)
-    if association.errors.respond_to? :full_message
-      prefix ||= "#{association.errors.instance_variable_get(:@base).class.model_name.human}: "
-      association.errors.each do |attr, error|
-        add :base, "#{prefix}#{association.errors.full_message(attr, error)}"
-      end
+  #     @user.errors.merge @account, "Account ##{@account.id}:"
+  #     @user.errors.merge @account, attribute: :account
+  def merge(assoc_or_errors, prefix=nil, attribute: :base)
+    errors = assoc_or_errors.respond_to?(:errors) ? assoc_or_errors.errors : assoc_or_errors
+
+    if attribute == :base && prefix.nil? && errors.instance_variable_defined?(:@base)
+      prefix = "#{errors.instance_variable_get(:@base).class.model_name.human}: "
     else
-      association.errors.each do |error|
-        add :base, error
-      end
+      prefix ||= nil
+    end
+    prefix = "#{prefix} " if prefix =~ /[a-z0-9]$/i
+
+    if errors.respond_to? :full_messages
+      errors = errors.full_messages
+    elsif errors.is_a? Hash
+      errors = errors.values.flatten
+    end
+
+    errors.each do |error|
+      add attribute, "#{prefix}#{error}"
     end
   end
 
@@ -22,13 +31,15 @@ module ErrorMerger
 
   def full_sentence(attribute, message)
     m = full_message(attribute, message)
-    m.ends_with?('.') ? m : "#{m}."
+    m.end_with?('.') ? m : "#{m}."
   end
 
-  def as_sentences
+  def join_sentences
     full_sentences.join ' '
   end
 
+  alias_method :as_sentences, :join_sentences
+
 end
 
-ActiveModel::Errors.send :include, ErrorMerger
+ActiveModel::Errors.include ErrorMerger

data/lib/error_merger/version.rb

@@ -1,3 +1,3 @@
 module ErrorMerger
-  VERSION = '0.3.3'
+  VERSION = '1.0.0'
 end

data/test/error_merger_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+
+class ErrorMergerTest < ActiveSupport::TestCase
+
+  setup do
+    @author = Author.new
+    @author.errors.add :name, :blank
+  end
+
+
+  test "merge Model" do
+    @book = Book.new
+    @book.errors.merge @author
+    assert_equal({base: ["Author: Name can't be blank"]}, @book.errors.messages)
+    assert_equal ["Author: Name can't be blank"], @book.errors.full_messages
+
+    @book = Book.new
+    @book.errors.merge @author, ''
+    assert_equal({base: ["Name can't be blank"]}, @book.errors.messages)
+    assert_equal ["Name can't be blank"], @book.errors.full_messages
+
+    @book = Book.new
+    @book.errors.merge @author, false
+    assert_equal({base: ["Name can't be blank"]}, @book.errors.messages)
+    assert_equal ["Name can't be blank"], @book.errors.full_messages
+
+    @book = Book.new
+    @book.errors.merge @author, attribute: :author
+    assert_equal({author: ["Name can't be blank"]}, @book.errors.messages)
+    assert_equal ["Author Name can't be blank"], @book.errors.full_messages
+
+    @book = Book.new
+    @book.errors.merge @author, '- ', attribute: :author
+    assert_equal({author: ["- Name can't be blank"]}, @book.errors.messages)
+    assert_equal ["Author - Name can't be blank"], @book.errors.full_messages
+  end
+
+  test "merge AM::Errors" do
+    @book = Book.new
+    @book.errors.merge @author.errors
+    assert_equal({base: ["Author: Name can't be blank"]}, @book.errors.messages)
+
+    @book = Book.new
+    @book.errors.merge @author.errors, ''
+    assert_equal({base: ["Name can't be blank"]}, @book.errors.messages)
+  end
+
+  test "merge Array" do
+    @error_array = ["Something is invalid"]
+
+    @book = Book.new
+    @book.errors.merge @error_array
+    assert_equal({base: ["Something is invalid"]}, @book.errors.messages)
+
+    @book = Book.new
+    @book.errors.merge @error_array, 'Prefix', attribute: :whatev
+    assert_equal({whatev: ["Prefix Something is invalid"]}, @book.errors.messages)
+    assert_equal ["Whatev Prefix Something is invalid"], @book.errors.full_messages
+  end
+
+  test "merge Hash" do
+    @error_hash   = {something: "Something is invalid"}
+    @error_hash_2 = {something: ["Something is invalid"]}
+
+    @book = Book.new
+    @book.errors.merge @error_hash, ''
+    assert_equal({base: ["Something is invalid"]}, @book.errors.messages)
+
+    @book = Book.new
+    @book.errors.merge @error_hash_2, ''
+    assert_equal({base: ["Something is invalid"]}, @book.errors.messages)
+  end
+
+  test "merge Errors-like" do
+    e1 = ["Not valid"]
+    e1.instance_variable_set :@base, Author.new
+
+    @book = Book.new
+    @book.errors.merge e1
+    assert_equal({base: ["Author: Not valid"]}, @book.errors.messages)
+  end
+
+
+  test "sentences" do
+    assert_equal "Name is invalid.", @author.errors.full_sentence(:name, "is invalid")
+    assert_equal "Name is invalid.", @author.errors.full_sentence(:name, "is invalid.")
+
+    @author.errors.add :name, :invalid
+    assert_equal ["Name can't be blank.", "Name is invalid."], @author.errors.full_sentences
+    assert_equal "Name can't be blank. Name is invalid.", @author.errors.join_sentences
+    assert_equal "Name can't be blank. Name is invalid.", @author.errors.as_sentences
+  end
+
+end

data/test/models/author.rb

@@ -0,0 +1,6 @@
+class Author
+  include ActiveModel::Model
+
+  attr_accessor :name
+
+end

data/test/models/book.rb

@@ -0,0 +1,6 @@
+class Book
+  include ActiveModel::Model
+
+  attr_accessor :author, :title
+
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'error_merger'
+require 'active_support/test_case'
+require 'active_support/testing/autorun'
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+%w(author book).each do |f|
+  require "models/#{f}"
+end
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("fixtures", __dir__)
+  ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
+  ActiveSupport::TestCase.file_fixture_path = ActiveSupport::TestCase.fixture_path + "/files"
+  ActiveSupport::TestCase.fixtures :all
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: error_merger
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 1.0.0
 platform: ruby
 authors:
 - thomas morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2019-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,10 @@ files:
 - lib/error_merger.rb
 - lib/error_merger/error_merger.rb
 - lib/error_merger/version.rb
+- test/error_merger_test.rb
+- test/models/author.rb
+- test/models/book.rb
+- test/test_helper.rb
 homepage: https://github.com/zarqman/error_merger
 licenses:
 - MIT
@@ -87,16 +91,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Enhances the Error class on ActiveModel-compliant models
-test_files: []
+test_files:
+- test/error_merger_test.rb
+- test/models/author.rb
+- test/models/book.rb
+- test/test_helper.rb