mongoid-embedded-errors 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.log
+.DS_Store
+doc
+tmp
+pkg
+*.gem
+*.pid
+coverage
+coverage.data
+build/*
+*.pbxuser
+*.mode1v3
+.svn
+profile
+.console_history
+.sass-cache/*
+.rake_tasks~
+*.log.lck
+solr/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_delorean.gemspec
+gemspec
+
+gem "rspec"
+gem 'database_cleaner'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    mongoid-embedded-errors (1.0.0)
+      mongoid (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    database_cleaner (0.9.1)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    mongoid (3.0.9)
+      activemodel (~> 3.1)
+      moped (~> 1.1)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.2.7)
+    multi_json (1.3.6)
+    origin (1.0.9)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  database_cleaner
+  mongoid-embedded-errors!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Bates
+
+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,98 @@
+# Mongoid::EmbeddedErrors
+
+Easily bubble up errors from embedded documents in Mongoid.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-embedded-errors'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-embedded-errors
+
+## Usage
+
+Embedded documents in Mongoid can be really useful. However, when one of those embedded documents is invalid, Mongoid spits up completely useless errors.
+
+Let's look an example. Here we have an `Article` which `embeds_many :pages`. A `Page` `embeds_many :sections`.
+
+```ruby
+class Article
+  include Mongoid::Document
+
+  field :name, type: String
+  field :summary, type: String
+  validates :name, presence: true
+  validates :summary, presence: true
+
+  embeds_many :pages
+end
+
+class Page
+  include Mongoid::Document
+
+  field :title, type: String
+  validates :title, presence: true
+
+  embedded_in :article, inverse_of: :pages
+  embeds_many :sections
+end
+
+class Section
+  include Mongoid::Document
+
+  field :header, type: String
+  field :body, type: String
+  validates :header, presence: true
+
+  embedded_in :page, inverse_of: :sections
+end
+```
+
+If we were to create an invalid `Article` with an invalid `Page` and tried to validate it the errors we see would not be very helpful:
+
+```ruby
+article = Article.new(pages: [Page.new])
+article.valid? # => false
+
+article.error.messages
+# => {:name=>["can't be blank"], :summary=>["can't be blank"], :pages=>["is invalid"]}
+```
+
+Why was the `Page` invalid? Who knows! But, if we include the `Mongoid::EmbeddedErrors` module we get much better error messaging:
+
+```ruby
+class Article
+  include Mongoid::Document
+  include Mongoid::EmbeddedErrors
+
+  field :name, type: String
+  field :summary, type: String
+  validates :name, presence: true
+  validates :summary, presence: true
+
+  embeds_many :pages
+end
+
+article = Article.new(pages: [Page.new(sections: [Section.new])])
+article.valid? # => false
+
+article.error.messages
+# => {:name=>["can't be blank"], :summary=>["can't be blank"], :pages=>[{"5086ec0d421aa94f0f000002"=>{:title=>["can't be blank"], :sections=>[{"5086ec0d421aa94f0f000001"=>{:header=>["can't be blank"]}}]}}]}
+```
+
+Now, isn't that much nicer? Yeah, I think so to.
+
+## 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,9 @@
+require 'bundler'  
+Bundler::GemHelper.install_tasks
+
+desc "Run tests"
+task :default => [:ruby]
+
+task :ruby do
+  system "bundle exec rspec"
+end

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

@@ -0,0 +1,16 @@
+require "mongoid/relations/embedded/in"
+
+module Mongoid
+  module Relations
+    module Macros
+      module ClassMethods
+        alias :embedded_in_without_embedded_errors :embedded_in
+        def embedded_in(*args)
+          relation = embedded_in_without_embedded_errors(*args)
+          self.send(:include, Mongoid::EmbeddedErrors)
+          return relation
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Mongoid
+  module EmbeddedErrors
+    VERSION = "1.0.0"
+  end
+end

data/lib/mongoid-embedded-errors.rb

@@ -0,0 +1,26 @@
+require 'mongoid'
+require "mongoid-embedded-errors/version"
+require "mongoid-embedded-errors/embedded_in"
+
+module Mongoid
+  module EmbeddedErrors
+
+    def self.included(klass)
+      klass.alias_method_chain(:errors, :embedded_errors)
+    end
+
+    def errors_with_embedded_errors
+      errs = errors_without_embedded_errors
+      self.embedded_relations.each do |name, metadata|
+        if errs[name]
+          errs.delete(name.to_sym)
+          self.send(name).each do |rel|
+            errs[name] = {rel.id.to_s => rel.errors.messages} if rel.errors.any?
+          end
+        end
+      end
+      return errs
+    end
+
+  end
+end

data/mongoid-embedded-errors.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid-embedded-errors/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mongoid-embedded-errors"
+  gem.version       = Mongoid::EmbeddedErrors::VERSION
+  gem.authors       = ["Mark Bates"]
+  gem.email         = ["mark@markbates.com"]
+  gem.description   = %q{Easily bubble up errors from embedded documents in Mongoid.}
+  gem.summary       = %q{Easily bubble up errors from embedded documents in Mongoid.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("mongoid", ">=3.0.0")
+end

data/spec/config.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: mongoid_embedded_errors_test
+      hosts:
+        - localhost:27017

data/spec/embedded_errors_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Mongoid::EmbeddedErrors do
+
+  let(:article) { Article.new }
+  let(:invalid_page) { Page.new }
+  let(:invalid_section) { Section.new }
+  let(:valid_section) { Section.new(header: "My Header") }
+
+  describe "errors" do
+  
+    it "bubbles up errors from embedded documents" do
+      invalid_page.sections << invalid_section
+      article.pages << invalid_page
+      article.should_not be_valid
+      puts article.errors.messages
+      article.errors.messages.should eql({
+        name: ["can't be blank"], 
+        summary: ["can't be blank"],
+        pages: [{
+          invalid_page.id.to_s => {
+            title: ["can't be blank"],
+            sections: [{
+              invalid_section.id.to_s => {
+                header: ["can't be blank"]
+              }
+            }]
+          }
+        }]
+      })
+    end
+
+    it "save works as before" do
+      article.save.should be_false
+      article.should_not be_persisted
+      article.errors.messages.should eql(name: ["can't be blank"], summary: ["can't be blank"])
+    end
+
+    it "handles errors on the main object" do
+      article.should_not be_valid
+      article.errors.messages.should eql(name: ["can't be blank"], summary: ["can't be blank"])
+    end
+  
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+
+require 'mongoid-embedded-errors' # and any other gems you need
+
+require 'database_cleaner'
+
+Mongoid.load!(File.join(File.dirname(__FILE__), "config.yml"), :test)
+require File.join(File.dirname(__FILE__), "support", "models")
+
+DatabaseCleaner[:mongoid].strategy = :truncation
+
+RSpec.configure do |config|
+
+  config.before(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

data/spec/support/models.rb

@@ -0,0 +1,37 @@
+class Article
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::EmbeddedErrors
+
+  field :name, type: String
+  field :summary, type: String
+
+  validates :name, presence: true
+  validates :summary, presence: true
+
+  embeds_many :pages
+end
+
+class Page
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :title, type: String
+
+  validates :title, presence: true
+
+  embedded_in :article, inverse_of: :pages
+  embeds_many :sections
+end
+
+class Section
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :header, type: String
+  field :body, type: String
+
+  validates :header, presence: true
+
+  embedded_in :page, inverse_of: :sections
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-embedded-errors
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Mark Bates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Easily bubble up errors from embedded documents in Mongoid.
+email:
+- mark@markbates.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid-embedded-errors.rb
+- lib/mongoid-embedded-errors/embedded_in.rb
+- lib/mongoid-embedded-errors/version.rb
+- mongoid-embedded-errors.gemspec
+- spec/config.yml
+- spec/embedded_errors_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easily bubble up errors from embedded documents in Mongoid.
+test_files:
+- spec/config.yml
+- spec/embedded_errors_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb