error_merger 0.3.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1dc0867bdb240f44bc025182673c85b9d489d13d
-  data.tar.gz: b4a2ea866f2f9226d9424c8eb1b6d4d2793ec22d
+SHA256:
+  metadata.gz: 205eda2c943d4f26c76a28bf4f477616f35d5978b75692f51c0955cba7cd2ab0
+  data.tar.gz: 39420e066d2b4185673fc7f2e6af385fd88461ae9f53a25acb620fb16ec4a1fb
 SHA512:
-  metadata.gz: 06ce9d7692a852ed593138f49024bebaece2c4b1619cbfcb4b72777664d7c95cc62a4a861200062828a4a8ccb70f5e39c0399e22bfca9b1a89fb4af5ac0cc5bb
-  data.tar.gz: c3f5202bd15d1920766624c8e9fd12030cad3a30cef4f6d046e3f81549b3a3457e9c968698d0541a44a019392efa0d84c1f27c8405a26757ebcab4408ecbeec5
+  metadata.gz: ffdebf8c8531d2935490a955ccefd5fea34697bb6f3209bf5c07a18e44aa84a000c4d018157257d588c15adc1a61340c12eec5e80c2c3d849c7009618dc30505
+  data.tar.gz: b71f83a4f941216ee71b1f47059b6445494c726c005486f3a0553de897ed7848e8bd50af6f34df70a577c21f57078bab73acd9dcbc7873f7b9b4a5ac95e9c737

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 Gemfile.lock
+Gemfile.*.lock
 InstalledFiles
 _yardoc
 coverage

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,41 @@
 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
+
+GEMFILES = {
+  '2.6@gem52' => 'Gemfile.rails52',
+  '2.6@gem60' => 'Gemfile.rails60',
+  '2.6@gem61' => 'Gemfile.rails61',
+}
+
+namespace :test do
+  task :install_all do
+    GEMFILES.each do |gemset, gemfile|
+      puts "\n\n========== Running 'bundle install' with #{gemfile} ==========\n"
+      puts `rvm #{gemset} --create do bundle install --gemfile=gemfiles/#{gemfile}`
+    end
+  end
+
+  desc 'test against all supported versions of rails'
+  task :all do
+    err = 0
+    cmd = ENV['RUN'] || 'rake test'
+    GEMFILES.each do |gemset, gemfile|
+      puts "\n\n========== Running '#{cmd}' with #{gemfile} ==========\n"
+      puts `rvm #{gemset} do bundle exec --gemfile=gemfiles/#{gemfile} #{cmd}`
+      err += 1 unless $?.success?
+    end
+    if err > 0
+      puts "\n>>> #{err} gemfiles failed"
+      exit err # exit code is # of failed runs
+    end
+  end
+end

data/error_merger.gemspec

@@ -18,8 +18,10 @@ 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_development_dependency 'bundler', '~> 1.3'
+  spec.add_dependency 'activemodel', '>= 5.2', '< 7.1'
+
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
 end

data/gemfiles/Gemfile.rails52

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activemodel', '~> 5.2.0'
+
+# Specify your gem's dependencies in error_merger.gemspec
+gemspec path: '..'

data/gemfiles/Gemfile.rails60

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activemodel', '~> 6.0.0'
+
+# Specify your gem's dependencies in error_merger.gemspec
+gemspec path: '..'

data/gemfiles/Gemfile.rails61

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activemodel', '~> 6.1.0'
+
+# Specify your gem's dependencies in error_merger.gemspec
+gemspec path: '..'

data/lib/error_merger/error_merger.rb

@@ -2,33 +2,55 @@ 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.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)
+    if assoc_or_errors.respond_to?(:errors) && assoc_or_errors.errors.is_a?(ActiveModel::Errors)
+      errors = assoc_or_errors.errors
     else
-      association.errors.each do |error|
-        add :base, error
-      end
+      errors = assoc_or_errors
+    end
+
+    if attribute == :base && prefix.nil? && errors.instance_variable_defined?(:@base)
+      prefix = "#{errors.instance_variable_get(:@base).class.model_name.human}: "
+    else
+      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
 
   def full_sentences
-    map{ |attr, m| full_sentence(attr, m) }
+    if defined?(ActiveModel::Error)
+      map do |error|
+        m = error.full_message
+        m =~ %r{[.?!。]$} ? m : "#{m}."
+      end
+    else
+      map{ |attr, m| full_sentence(attr, m) }
+    end
   end
 
   def full_sentence(attribute, message)
     m = full_message(attribute, message)
-    m.ends_with?('.') ? m : "#{m}."
+    m =~ %r{[.?!。]$} ? 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.2'
+  VERSION = '1.1.0'
 end

data/lib/error_merger.rb

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

data/test/error_merger_test.rb

@@ -0,0 +1,97 @@
+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.")
+    assert_equal "Name is invalid!", @author.errors.full_sentence(:name, "is invalid!")
+    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.2
+  version: 1.1.0
 platform: ruby
 authors:
 - thomas morgan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-13 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,34 +16,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,21 @@ files:
 - README.md
 - Rakefile
 - error_merger.gemspec
+- gemfiles/Gemfile.rails52
+- gemfiles/Gemfile.rails60
+- gemfiles/Gemfile.rails61
 - 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
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,16 +94,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.6.10
-signing_key: 
+rubygems_version: 3.2.22
+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