mongoid-denormalize 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cecaa0d338d86451e2d2808712767f0e6862aed4
-  data.tar.gz: 53e285e91e43bd2cedce3430fcf49fed0f953a63
+SHA256:
+  metadata.gz: 7c7d7ab9d80881adaa4e262eee1326301f9e90d6e279447aef67beec3d65a0be
+  data.tar.gz: ad68e00030e827e28541cff160411f406dad2c69ea53ca54baf53758a16aa506
 SHA512:
-  metadata.gz: 4de17b1f7116ea41d2593dafa284e11a3c41058a8b35ea8a3dcbee2cf73f23a3732028f50764dd2703ac485165842de14634eab8cb14fb89a485dd538a680e5f
-  data.tar.gz: 6e944fc4822da56b58d2e7a582750e2a980d67dad51a194cc1898eb644fe336792ae49b9385b2d60b7d2ff96d6a513d27123fa879875e75c730802e6a6771a59
+  metadata.gz: 0f765af8e61525c9609afb0da02a3c90f9a2070f4056d35731f6977a81ff0f7305ace737a1f3a16dc792da8b58e6ba0f6ffc9e93d43d0c6306fd6347cfe44eba
+  data.tar.gz: 37a5efcf39b2618653331ae1b416a17730ec854372f708da1b4e742b51dd7ffe72f8190c2aea7f4a6f95fe9fbb5f932ffdf9c5fd8edffff591292089260bad6c

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -1,15 +1,13 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.4
-before_install: gem install bundler -v 1.15.4
+  - 2.7
+before_install: gem install bundler -v 2.2
+
+gemfile:
+  - Gemfile
+  - gemfiles/mongoid-6.0.gemfile
+  - gemfiles/mongoid-7.0.gemfile
 
 services:
   - mongodb
-
-addons:
-  apt:
-    sources:
-      - mongodb-3.4-precise
-    packages:
-      - mongodb-org-server

data/README.md

@@ -1,7 +1,9 @@
 # Mongoid::Denormalize
-![Build Status](https://travis-ci.org/rjurado01/mongoid-denormalize.svg?branch=master)
+![Build Status](https://travis-ci.org/nosolosoftware/mongoid-denormalize.svg?branch=master)
 
-Helper module for denormalizing association attributes in Mongoid models
+Helper module for denormalizing association attributes in Mongoid models.
+
+This gem is tested on mongoid 6.x and 7.x.
 
 ## Installation
 
@@ -31,7 +33,7 @@ include Mongoid::Denormalize
 denormalize :name, :email, from: :user
 ```
 
-You need to add `inverse_of` to `belongs_to` side if `has_many` target name is diferent from model:
+You need to add `inverse_of` to `belongs_to` side if relation name is diferent from model:
 
 ```ruby
 class Club
@@ -52,7 +54,6 @@ end
 ```ruby
 class User
   include Mongoid::Document
-  include Mongoid::Denormalize
 
   field :name
 
@@ -85,6 +86,45 @@ end
 "User2"
 ```
 
+## Options of denormalize
+
+### as
+
+Enables to customize the final field name
+
+```ruby
+  denormalize :name, from: :top, as: :custom_name
+```
+
+It will create the field `custom_name` with the content of `top.name`. Also support an array:
+
+```ruby
+  denormalize :name, :age, from: :top, as: [:custom_name, :custom_age]
+```
+
+### prefix
+
+In somes cases it could be interesting to customize the prefix of the final name, instead of using the basic `from_field`
+
+```ruby
+  denormalize :color, :name, from: :top, prefix: :ancestor
+```
+
+It will create the fields `ancestor_name` and `ancestor_color` with the content of `top.name` and `top.color`.
+
+### child_callback
+
+By default when a child is created the denormalization is executed into `before_save` hook.  
+This option let you change this callback by other, for example:
+
+```ruby
+  denormalize :name, from: :top, child_callback: :before_validation
+
+  validate :top_name, presence: true
+```
+
+It will denormalize field `name` into `before_validation` callback so that we can validate it.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -93,7 +133,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/rjurado01/mongoid-denormalize.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nosolosoftware/mongoid-denormalize.
 
 ## License
 

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/gemfiles/mongoid-5.0.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-normalize-strings.gemspec
+gemspec path: '../'
+
+gem 'rake'
+gem 'mongoid', "~> 5.0"

data/gemfiles/mongoid-6.0.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-normalize-strings.gemspec
+gemspec path: '../'
+
+gem 'rake'
+gem 'mongoid', "~> 6.0"

data/gemfiles/mongoid-7.0.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-normalize-strings.gemspec
+gemspec path: '../'
+
+gem 'rake'
+gem 'mongoid', "~> 7.0"

data/lib/mongoid-denormalize.rb

@@ -1,4 +1,4 @@
-require "mongoid-denormalize/version"
+require 'mongoid-denormalize/version'
 
 module Mongoid
   module Denormalize
@@ -8,40 +8,106 @@ module Mongoid
 
     module ClassMethods
       def denormalize(*args)
-        options = args.pop
+        *fields, options = args
 
-        unless options.is_a?(Hash) && (from = options[:from]&.to_s)
-          raise ArgumentError, 'Option :from is needed (e.g. delegate :name, from: :user).'
+        unless options.is_a?(Hash) && options[:from]
+          raise ArgumentError, 'Option :from is needed (e.g. denormalize :name, from: :user).'
         end
 
+        fields = Mongoid::Denormalize.get_fields_with_names(self, fields, options)
+
         # Add fields to model
-        args.each { |field| field "#{from}_#{field}" }
-
-        # Denormalize fields when model is saved and 'from' has changed
-        before_save do
-          if send(from) && send("#{from}_id_changed?")
-            args.each do |field|
-              send("#{from}_#{field}=", send(from).send(field))
-            end
-          end
+        fields.each { |field| field field[:as], type: field[:type] }
+
+        # Add hooks
+        Mongoid::Denormalize.add_hook_to_child(self, fields, options)
+        Mongoid::Denormalize.add_hook_to_parent(self, fields, options)
+      end
+    end
+
+    # Check options and return name for each field
+    def self.get_fields_with_names(child_class, fields, options)
+      parent = parent_class(child_class, options[:from].to_s)
+
+      if options.include?(:as)
+        options[:as] = [options[:as]] unless options[:as].is_a?(Array)
+
+        unless fields.size == options[:as].size
+          raise ArgumentError, 'When option :as is used you must pass a name for each field.'
         end
 
-        from_class = (relations[from].class_name || relations[from].name.capitalize).constantize
-        model_class = model_name.name
-        inverse_of = relations[from].inverse_of || model_name.route_key.pluralize
+        return fields.map.with_index do |field, index|
+          {name: field, as: options[:as][index], type: field_type(parent, field)}
+        end
+      elsif options.include?(:prefix)
+        return fields.map do |field|
+          {name: field, as: "#{options[:prefix]}_#{field}", type: field_type(parent, field)}
+        end
+      end
 
-        # When 'from' is updated, update all childs
-        from_class.send(:after_update) do
-          attributes = {}
-          args.each { |field| attributes["#{from}_#{field}"] = send(field) }
+      fields.map do |field|
+        {name: field, as: "#{options[:from]}_#{field}", type: field_type(parent, field)}
+      end
+    end
+
+    # Add hook to child class to denormalize fields when parent relation is changed
+    def self.add_hook_to_child(child_class, fields, options)
+      from = options[:from].to_s
 
-          unless relations[inverse_of.to_s]
-            raise "Option :inverse_of is needed for 'belongs_to :#{from}' into #{model_class}."
+      child_class.send(options[:child_callback] || 'before_save') do
+        if send("#{from}_id_changed?")
+          fields.each do |field|
+            send("#{field[:as]}=", send(from)&.send(field[:name]))
           end
+        end
+      end
+    end
+
+    # Add hook to parent class to denormalize fields when parent object is updated
+    def self.add_hook_to_parent(child_class, fields, options)
+      from = options[:from].to_s
+
+      parent = parent_class(child_class, from)
+
+      relation = parent.relations[child_class.relations[from].inverse_of.to_s] ||
+                 parent.relations[child_class.model_name.plural] ||
+                 parent.relations[child_class.model_name.singular]
+
+      unless relation
+        raise "Option :inverse_of is needed for 'belongs_to :#{from}' into #{child_class}."
+      end
 
-          send(inverse_of).update_all('$set' => attributes)
+      parent.after_update do
+        attributes = {}
+        fields.each do |field|
+          attributes[field[:as]] = send(field[:name]) if send("#{field[:name]}_changed?")
+        end
+        next if attributes.blank?
+
+        case relation.relation.to_s
+        when 'Mongoid::Relations::Referenced::One',
+             'Mongoid::Association::Referenced::HasOne::Proxy'
+          if (document = send(relation.name))
+            document.collection.update_one({_id: document._id}, {'$set' => attributes})
+          end
+        when 'Mongoid::Relations::Referenced::Many',
+             'Mongoid::Association::Referenced::HasMany::Proxy'
+          send(relation.name).update_all('$set' => attributes)
+        else
+          raise "Relation type unsupported: #{relation.relation}"
         end
       end
     end
+
+    # Retrieve parent class
+    def self.parent_class(child_class, from)
+      (child_class.relations[from].class_name || child_class.relations[from].name.capitalize)
+        .constantize
+    end
+
+    # Retreive the type of a field from the given class
+    def self.field_type(klass, field)
+      klass.fields[field.to_s].options[:type]
+    end
   end
 end

data/lib/mongoid-denormalize/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Denormalize
-    VERSION = "0.1.0"
+    VERSION = "0.4.0"
   end
 end

data/mongoid-denormalize.gemspec

@@ -22,8 +22,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'mongoid-compatibility', '~> 0.5.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_dependency 'mongoid'
+  spec.add_dependency 'mongoid', ['>= 6.0', '< 8.0']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-denormalize
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - rjurado01
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-15 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: mongoid-compatibility
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +72,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 description: Helper module for denormalizing relations attributes in Mongoid models
 email:
 - rjurado01@gmail.com
@@ -82,6 +102,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/mongoid-5.0.gemfile
+- gemfiles/mongoid-6.0.gemfile
+- gemfiles/mongoid-7.0.gemfile
 - lib/mongoid-denormalize.rb
 - lib/mongoid-denormalize/version.rb
 - mongoid-denormalize.gemspec
@@ -104,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Denormalize fields from relations