mongoid-embedded-errors-messages 2.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-embedded-errors-messages.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bruno Milare
+
+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,73 @@
+# MongoidEmbeddedErrorsMessages
+
+Easiest way to bubble up your embedded documents errors messages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-embedded-errors-messages'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-embedded-errors-messages
+
+## Usage
+
+Imagine the following models, with some relations between them:
+
+```ruby
+class Foo
+  include Mongoid::Document
+  include MongoidEmbeddedErrorsMessages
+  embeds_many :bars
+  embeds_one :baz
+  field :foo_field
+end
+
+class Bar
+  include Mongoid::Document
+  include MongoidEmbeddedErrorsMessages
+  embeds_many :quxs
+  field :bar_field
+end
+
+class Qux
+  include Mongoid::Document
+  include MongoidEmbeddedErrorsMessages
+  field :qux_field
+end
+
+class Baz
+  include Mongoid::Document
+  include MongoidEmbeddedErrorsMessages
+  field :baz_field
+end
+```
+
+You are now able to retrieve the errors from the embedded documents.
+
+And the embedded errors messages will be:
+```ruby
+foo.embedded_errors_messages
+
+{
+  :foo_field=>["is invalid"], 
+  :baz=>{:baz_field=>["is invalid"]}, 
+  :bars=>[{:bar_field=>["is invalid"], 
+           :quxs=>[{:qux_field=>["is invalid"]}, nil, {:qux_field=>["is invalid"]}]
+         }]
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mongoid-embedded-errors-messages.rb

@@ -0,0 +1,37 @@
+require_relative 'mongoid-embedded-errors-messages/version'
+module MongoidEmbeddedErrorsMessages
+
+  def self.included(klass)
+    raise NotMongoidDocument unless klass.included_modules.include? Mongoid::Document
+  end
+
+  def embedded_errors_messages
+    merged_errors = errors.messages
+    embedded_relations.each do |relation, metadata|
+      if metadata[:relation] == Mongoid::Relations::Embedded::Many
+        errors = embedded_errors_for_embeds_many_relation(relation)
+        merged_errors.merge!(errors) if errors.present?
+      elsif metadata[:relation] == Mongoid::Relations::Embedded::One
+        errors = embedded_errors_for_embeds_one_relation(relation)
+        merged_errors.merge!(errors) if errors.present?
+      end
+    end
+    merged_errors.present? ? merged_errors : nil
+  end
+
+  class NotMongoidDocument < Exception; end
+  private
+  def embedded_errors_for_embeds_many_relation(relation)
+    errors_array = send(relation).map{|doc| doc.try(:embedded_errors_messages)}
+    if errors_array.compact.present?
+      children_errors = {relation.to_sym => errors_array}
+      children_errors.delete_if{|k,v| v.blank? }
+    end
+    children_errors
+  end
+
+  def embedded_errors_for_embeds_one_relation(relation)
+    relation_errors = send(relation).try(:embedded_errors_messages)
+    { relation.to_sym => relation_errors } if relation_errors.present?
+  end
+end

data/lib/mongoid-embedded-errors-messages/version.rb

@@ -0,0 +1,3 @@
+module MongoidEmbeddedErrorsMessages
+  VERSION = "2.0.1"
+end

data/mongoid-embedded-errors-messages.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid-embedded-errors-messages/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid-embedded-errors-messages"
+  spec.version       = MongoidEmbeddedErrorsMessages::VERSION
+  spec.authors       = ["Bruno Milare"]
+  spec.email         = ["milare@gmail.com"]
+  spec.description   = %q{Easiest way to bubble up your embedded documents errors messages.}
+  spec.summary       = %q{Easiest way to bubble up your embedded documents errors messages.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mongoid", ">=3.0.0"
+end

data/test/lib/mongoid_embedded_errors_messages_spec.rb

@@ -0,0 +1,124 @@
+require_relative '../test_helper'
+
+describe MongoidEmbeddedErrorsMessages do
+  describe 'mongoid document' do
+    it 'should raise error if Mongoid::Document is not included' do
+      lambda{
+        class Fuu
+          include MongoidEmbeddedErrorsMessages
+        end
+      }.must_raise(MongoidEmbeddedErrorsMessages::NotMongoidDocument)
+    end
+  end
+
+  describe 'concerning' do
+    it 'should has method embedded_errors_messages' do
+      Foo.new.must_respond_to :embedded_errors_messages
+    end
+  end
+
+  describe 'embedded_errors_messages' do
+    before do
+      @foo = Foo.new
+      @bar = Bar.new
+      @baz = Baz.new
+      @qux = Qux.new
+    end
+
+    describe 'error just on parent' do
+      it 'should have parent errors' do
+        @foo.errors.add(:foo)
+        @foo.embedded_errors_messages.must_equal ({foo: ['is invalid']})
+      end
+    end
+
+    describe 'errors just on 1st level relation' do
+      describe 'embeds_many relation' do
+        before do
+          @foo.bars << @bar
+          @foo.bars << @bar
+          @foo.bars << Bar.new
+          @bar.errors.add(:bar)
+        end
+
+        it 'should have children errors' do
+          @foo.embedded_errors_messages.must_equal ({bars: [{bar:['is invalid']}, {bar:['is invalid']}, nil]})
+        end
+      end
+
+      describe 'embeds_one relation' do
+        before do
+          @foo.qux = @qux
+          @qux.errors.add(:qux)
+        end
+
+        it 'should have child errors' do
+          @foo.embedded_errors_messages.must_equal ({qux: {qux:['is invalid']}})
+        end
+      end
+
+      describe 'embeds_one and embeds_many errors' do
+        before do
+          @foo.qux = @qux
+          @foo.bars << @bar
+          @foo.bars << Bar.new
+          @foo.bars << @bar
+          @qux.errors.add(:qux)
+          @bar.errors.add(:bar)
+        end
+
+        it 'should have child errors' do
+          @foo.embedded_errors_messages.must_equal ({bars: [{bar:['is invalid']}, nil, {bar:['is invalid']}], qux: {qux:['is invalid']}})
+        end
+      end
+    end
+
+    describe 'errors just on n-th level relation' do
+      describe 'embeds_many relation' do
+        before do
+          @bar.quxs << @qux
+          @bar.quxs << Qux.new
+          @bar.quxs << @qux
+          @foo.bars << @bar
+          @qux.errors.add(:qux)
+        end
+
+        it 'should have children errors' do
+          @foo.embedded_errors_messages.must_equal ({bars: [{quxs: [{qux: ["is invalid"]}, nil, {qux: ["is invalid"]}]}]})
+        end
+      end
+
+      describe 'embeds_one relation' do
+        before do
+          @bar.baz = @baz
+          @foo.bars << @bar
+          @baz.errors.add(:baz)
+        end
+
+        it 'should have child errors' do
+          @foo.embedded_errors_messages.must_equal ({bars: [{baz: {baz: ["is invalid"]}}]})
+        end
+      end
+
+      describe 'embeds_one and embeds_many relations' do
+        before do
+          @bar.baz = @baz
+          @foo.bars << @bar
+          @baz.errors.add(:baz)
+
+          @bar.quxs << @qux
+          @bar.quxs << Qux.new
+          @bar.quxs << @qux
+          @foo.bars << @bars
+          @qux.errors.add(:qux)
+        end
+
+        it 'should have child errors' do
+          @foo.embedded_errors_messages.must_equal ({bars: [{baz: {baz: ["is invalid"]}, quxs: [{qux: ["is invalid"]}, nil, {qux: ["is invalid"]}] }] })
+        end
+      end
+    end
+  end
+end
+
+

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+require 'minitest/autorun'
+require 'mongoid'
+require File.expand_path('../../lib/mongoid-embedded-errors-messages.rb', __FILE__)
+
+# Classes setup
+class Foo
+  include Mongoid::Document
+  include MongoidEmbeddedErrorsMessages
+  field :foo
+  embeds_many :bars
+  embeds_one :qux
+end
+
+class Bar
+  include Mongoid::Document
+  include MongoidEmbeddedErrorsMessages
+  field :bar
+  embeds_one :baz
+  embeds_many :quxs
+end
+
+class Baz
+  include Mongoid::Document
+  include MongoidEmbeddedErrorsMessages
+  field :baz
+end
+
+class Qux
+  include Mongoid::Document
+  include MongoidEmbeddedErrorsMessages
+  field :qux
+end
+

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-embedded-errors-messages
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bruno Milare
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Easiest way to bubble up your embedded documents errors messages.
+email:
+- milare@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid-embedded-errors-messages.rb
+- lib/mongoid-embedded-errors-messages/version.rb
+- mongoid-embedded-errors-messages.gemspec
+- test/lib/mongoid_embedded_errors_messages_spec.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2666713413803721691
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2666713413803721691
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Easiest way to bubble up your embedded documents errors messages.
+test_files:
+- test/lib/mongoid_embedded_errors_messages_spec.rb
+- test/test_helper.rb