mongoid-embedded-errors 2.1.1 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cf676fc1f240e90f81b9e544ab757298062d73ca
-  data.tar.gz: e6b81f36c32a1f8da79f99c248c69e9195cff91c
+SHA256:
+  metadata.gz: 129c9a68d1921837c6cd5942d64272049bbc8fd8f756c29b0a825faa4c1d1527
+  data.tar.gz: 57c35bcc8813866051d60d5139e5901169b8478ce4d5be291e862e0bb0604e17
 SHA512:
-  metadata.gz: d4278dd96bebd97e65cf8568f3856a84845edf20d75635686caa8b938fbf80b7e59f36ae49969c273850ee66fa1155b33ac68cb8a1e7eff5620871712fba5e7c
-  data.tar.gz: b3af8d97147572f1e1210d0f7f0442f93a6347b75fbf792c6d773fe7332e5c3a90b3f0c50009660d875b9d509a074e6f37375bf550b03aebc94416206130fb68
+  metadata.gz: 857c87ef479cc4eb0ea15462f9c6386d2eff11987d0a0f895bc3429f14ffd9242fcbce2292bb7de04f2588481fa76bbdc1d0d9874bd2b6a4bcffc02b5149f22a
+  data.tar.gz: 3935c4a3d82f9e343b21f2272c05d4e8cf642191d79be7b89e82116220c76ba73b56b1e24885824e5fe6c9f17312a4f083cf2714a8356cb2768c0f1b4b57b488

data/.codeclimate.yml

@@ -1,5 +1,7 @@
 ---
-engines:
+version: "2"
+
+plugins:
   rubocop:
     enabled: true
   bundler-audit:
@@ -8,10 +10,11 @@ engines:
     enabled: true
   duplication:
     enabled: true
+  reek:
+    enabled: true
+  git-legal:
+    enabled: true
+
     config:
       languages:
       - ruby
-      - javascript
-ratings:
-  paths:
-  - Gemfile.lock

data/.gitignore

@@ -17,3 +17,5 @@ profile
 .rake_tasks~
 *.log.lck
 solr/
+bin/
+*.lock

data/.rubocop.yml

@@ -9,17 +9,17 @@ AllCops:
   DisplayCopNames: true
   Exclude:
     - Guardfile
-    - gemfiles/*
+    - gemfiles/**/*
     - bin/*
+    - vendor/bundle/**/*
+    - tmp/**/*
+  NewCops: enable
 
-Rails:
-  Enabled: true
-
-Style/FileName:
+Naming/FileName:
   Exclude:
     - Appraisals
 
-Style/SpaceInsideHashLiteralBraces:
+Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
   EnforcedStyleForEmptyBraces: no_space
   SupportedStyles:
@@ -28,10 +28,16 @@ Style/SpaceInsideHashLiteralBraces:
 
 Metrics/MethodLength:
   CountComments: false  # count full line comments?
-  Max: 15
+  Max: 40
 
 Metrics/AbcSize:
-  Max: 20
+  Max: 40
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Max: 50
 
 Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
@@ -51,7 +57,7 @@ Style/MethodCalledOnDoEndBlock:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#single-line-blocks'
   Enabled: true
 
-Style/ExtraSpacing:
+Layout/ExtraSpacing:
   Description: 'Do not use unnecessary spacing.'
   Enabled: true
 

data/.semaphore/semaphore.yml

@@ -0,0 +1,46 @@
+version: v1.0
+name: mongoid-embedded-errors
+agent:
+  machine:
+    type: e1-standard-2
+    os_image: ubuntu1804
+
+blocks:
+  - name: Code Climate
+    task:
+      jobs:
+      - name: Code Climate
+        commands: 
+          - checkout 
+          - cache restore gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock),gems-$SEMAPHORE_GIT_BRANCH,gems-master
+          - bundle install --path vendor/bundle
+          - cache store gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock) vendor/bundle
+          - docker run   --interactive --tty --rm   --env CODECLIMATE_CODE="$PWD"  --volume "$PWD":/code   --volume /tmp/cc:/tmp/cc   --volume /var/run/docker.sock:/var/run/docker.sock   codeclimate/codeclimate analyze
+
+  - name: Unit tests
+    task:
+      jobs:
+      - name: Appraisal
+        commands:
+          - checkout 
+          - cache restore gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock),gems-$SEMAPHORE_GIT_BRANCH,gems-master
+          - bundle install --path vendor/bundle
+          - cache store gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock) vendor/bundle
+          - cache restore appraisal-$SEMAPHORE_GIT_BRANCH-$(checksum gemfiles/*.gemfile.lock),appraisal-$SEMAPHORE_GIT_BRANCH,appraisal-master
+          - bundle exec appraisal
+          - cache store appraisal-$SEMAPHORE_GIT_BRANCH-$(checksum gemfiles/*.gemfile.lock) vendor/bundle
+          - sem-service start mongodb
+          - bundle exec appraisal rake test
+
+  - name: Mutant
+    task:
+      jobs:
+      - name: Mutant
+        commands:
+          - checkout 
+          - cache restore gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock),gems-$SEMAPHORE_GIT_BRANCH,gems-master
+          - bundle install --path vendor/bundle
+          - cache store gems-$SEMAPHORE_GIT_BRANCH-$(checksum Gemfile.lock) vendor/bundle
+          - sem-service start mongodb
+          - MUTANT=true bundle exec mutant --since "$SEMAPHORE_GIT_SHA~1" --include lib --require mongoid --use rspec "Mongoid::EmbeddedErrors*"
+

data/Appraisals

@@ -1,7 +1,3 @@
-appraise 'mongoid-3' do
-  gem 'mongoid', '~> 3.0'
-end
-
 appraise 'mongoid-4' do
   gem 'mongoid', '~> 4.0'
 end
@@ -13,3 +9,7 @@ end
 appraise 'mongoid-6' do
   gem 'mongoid', '~> 6.0'
 end
+
+appraise 'mongoid-7' do
+  gem 'mongoid', '~> 7.0'
+end

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+- TODO
+
+## [v3.0.1] - 2020-09-29
+### Added
+- Started 🔎 tracking changes in a changelog!
+- Mongoid 7 support
+- Ruby 2.4 support by using `send` instead of `public_send` [#18]
+
+### Removed
+- Mongoid 3 support
+
+### Fixed
+- Updated style to fix Rubocop issues (as per included .rubocop.yml configuration file)
+- Removed .lock files as these are not supposed to be included with gem source code
+
+## [v3.0.0] - 2020-09-29 [YANKED]
+- Yanked due to wrong dependencies in gemspec.
+
+[Unreleased]: https://github.com/glooko/mongoid-embedded-errors/compare/v3.0.1...HEAD
+[v3.0.1]: https://github.com/glooko/mongoid-embedded-errors/compare/v3.0.0...v3.0.1
+[v3.0.0]: https://github.com/glooko/mongoid-embedded-errors/compare/f1ce0d8ed140de86c894b2fad7ad197504fefd5a...v3.0.0

data/Gemfile

@@ -3,9 +3,11 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in mongoid-embedded-errors.gemspec
 gemspec
 
-gem 'rspec'
-gem 'rake'
-gem 'database_cleaner'
-gem 'guard-rspec'
-gem 'appraisal'
-gem 'mutant-rspec'
+group :development do
+  gem 'appraisal'
+  gem 'database_cleaner'
+  gem 'guard-rspec'
+  gem 'mutant-rspec'
+  gem 'rake'
+  gem 'rspec'
+end

data/README.md

@@ -1,7 +1,7 @@
 # Mongoid::EmbeddedErrors
 [![Code Climate](https://codeclimate.com/github/glooko/mongoid-embedded-errors/badges/gpa.svg)](https://codeclimate.com/github/glooko/mongoid-embedded-errors)
 
-Easily bubble up errors from embedded documents in Mongoid 3 and newer.
+Easily bubble up errors from embedded documents in Mongoid and newer.
 
 ## Installation
 
@@ -62,7 +62,7 @@ If we were to create an invalid `Article` with an invalid `Page` and tried to va
 article = Article.new(pages: [Page.new])
 article.valid? # => false
 
-article.error.messages
+article.errors.messages
 # => {:name=>["can't be blank"], :summary=>["can't be blank"], :pages=>["is invalid"]}
 ```
 
@@ -84,7 +84,7 @@ end
 article = Article.new(pages: [Page.new(sections: [Section.new])])
 article.valid? # => false
 
-article.error.messages
+article.errors.messages
 {
   :name => ["can't be blank"],
   :summary => ["can't be blank"],

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler/setup'
 

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/mongoid_4.gemfile

@@ -2,10 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "rspec"
-gem "database_cleaner"
-gem "guard-rspec"
-gem "appraisal"
 gem "mongoid", "~> 4.0"
 
-gemspec :path => "../"
+group :development do
+  gem "appraisal"
+  gem "database_cleaner"
+  gem "guard-rspec"
+  gem "mutant-rspec"
+  gem "rake"
+  gem "rspec"
+end
+
+gemspec path: "../"

data/gemfiles/mongoid_5.gemfile

@@ -2,10 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "rspec"
-gem "database_cleaner"
-gem "guard-rspec"
-gem "appraisal"
 gem "mongoid", "~> 5.0"
 
-gemspec :path => "../"
+group :development do
+  gem "appraisal"
+  gem "database_cleaner"
+  gem "guard-rspec"
+  gem "mutant-rspec"
+  gem "rake"
+  gem "rspec"
+end
+
+gemspec path: "../"

data/gemfiles/mongoid_6.gemfile

@@ -2,10 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "rspec"
-gem "database_cleaner"
-gem "guard-rspec"
-gem "appraisal"
 gem "mongoid", "~> 6.0"
 
-gemspec :path => "../"
+group :development do
+  gem "appraisal"
+  gem "database_cleaner"
+  gem "guard-rspec"
+  gem "mutant-rspec"
+  gem "rake"
+  gem "rspec"
+end
+
+gemspec path: "../"

data/gemfiles/mongoid_7.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 7.0"
+
+group :development do
+  gem "appraisal"
+  gem "database_cleaner"
+  gem "guard-rspec"
+  gem "mutant-rspec"
+  gem "rake"
+  gem "rspec"
+end
+
+gemspec path: "../"

data/lib/mongoid-embedded-errors.rb

@@ -1,2 +1,3 @@
-# rubocop:disable Style/FileName
+# rubocop:disable Naming/FileName
 require 'mongoid/embedded_errors'
+# rubocop:enable Naming/FileName

data/lib/mongoid/embedded_errors.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require 'mongoid'
 require 'mongoid/embedded_errors/version'
 require 'mongoid/embedded_errors/embedded_in'
 
 module Mongoid::EmbeddedErrors
   def self.included(klass)
-    # make sure that the alias only happens once:
-    unless klass.instance_methods.include?(:errors_without_embedded_errors)
-      klass.alias_method_chain(:errors, :embedded_errors)
-    end
+    return if klass.instance_methods.include?(:errors_without_embedded_errors)
+
+    klass.send :alias_method, :errors_without_embedded_errors, :errors
+    klass.send :alias_method, :errors, :errors_with_embedded_errors
   end
 
   def errors_with_embedded_errors
@@ -16,18 +18,29 @@ module Mongoid::EmbeddedErrors
         # name is something like pages or sections
         # if there is an 'is invalid' message for the relation then let's work it:
         next unless Array(public_send(name)).any? { |doc| doc.errors.any? }
+
         # first delete the unless 'is invalid' error for the relation
         errs[name].delete 'is invalid'
         errs.delete name.to_sym if errs[name].empty?
+
         # next, loop through each of the relations (pages, sections, etc...)
-        [send(name)].flatten.reject(&:nil?).each_with_index do |rel, i|
-          # get each of their individual message and add them to the parent's errors:
+        [public_send(name)].flatten.reject(&:nil?).each_with_index do |rel, i|
           next unless rel.errors.any?
-          rel.errors.messages.each do |k, v|
-            key = (metadata.relation == Mongoid::Relations::Embedded::Many ? "#{name}[#{i}].#{k}" : "#{name}.#{k}").to_sym
+
+          # get each of their individual message and add them to the parent's errors:
+          rel.errors.each do |k, v|
+            relation = if Gem::Version.new(Mongoid::VERSION) >= Gem::Version.new('7.0.0')
+                         metadata.class
+                       else
+                         metadata.relation
+                       end
+            key = if relation.equal? EMBEDS_MANY
+                    "#{name}[#{i}].#{k}"
+                  else
+                    "#{name}.#{k}"
+                  end.to_sym
             errs.delete(key)
-            errs[key] = v
-            errs[key].flatten!
+            errs.add key, v if v.present?
           end
         end
       end

data/lib/mongoid/embedded_errors/embedded_in.rb

@@ -1,6 +1,14 @@
-require 'mongoid/relations/embedded/in'
+if Gem::Version.new(Mongoid::VERSION) >= Gem::Version.new('7.0.0')
+  require 'mongoid/association/embedded/embedded_in'
+  ASSOCIATION = Mongoid::Association::Macros::ClassMethods
+  EMBEDS_MANY = Mongoid::Association::Embedded::EmbedsMany
+else
+  require 'mongoid/relations/embedded/in'
+  ASSOCIATION = Mongoid::Relations::Macros::ClassMethods
+  EMBEDS_MANY = Mongoid::Relations::Embedded::Many
+end
 
-module Mongoid::Relations::Macros::ClassMethods
+module ASSOCIATION
   alias embedded_in_without_embedded_errors embedded_in
   def embedded_in(*args)
     relation = embedded_in_without_embedded_errors(*args)

data/lib/mongoid/embedded_errors/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Mongoid; end
 module Mongoid::EmbeddedErrors
-  VERSION = '2.1.1'.freeze
+  VERSION = '3.0.1'
 end

data/mongoid-embedded-errors.gemspec

@@ -1,23 +1,32 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $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.version       = Mongoid::EmbeddedErrors::VERSION.dup
   gem.authors       = ['Mark Bates', 'Kristijan Novoselić']
   gem.email         = ['mark@markbates.com', 'kristijan@glooko.com']
-  gem.description   = 'Easily bubble up errors from embedded '\
-                      'documents in Mongoid.'
+  gem.description   = 'Embedded documents in Mongoid can be really useful. '\
+                      'However, when one of those embedded documents is '\
+                      'invalid, Mongoid does not say which validation has '\
+                      'failed. Instead of just saying that an embedded '\
+                      'document is invalid, this gem modifies Mongoid '\
+                      'behavior so it explicitly provides validation errors '\
+                      'on a per-field basis for embedded documents, the '\
+                      'same way it does for parent documents.'
   gem.summary       = 'Easily bubble up errors from embedded '\
                       'documents in Mongoid.'
-  gem.homepage      = ''
-
+  gem.homepage      = 'https://github.com/glooko/mongoid-embedded-errors'
+  gem.licenses      = ['MIT']
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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')
+  gem.add_dependency             'mongoid', '>=4.0', '<8.0.0'
+  gem.add_development_dependency 'rubocop', '~> 0.92'
+  gem.add_development_dependency 'rubocop-rspec', '~> 1.43'
 end