mongoid-denormalize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cecaa0d338d86451e2d2808712767f0e6862aed4
+  data.tar.gz: 53e285e91e43bd2cedce3430fcf49fed0f953a63
+SHA512:
+  metadata.gz: 4de17b1f7116ea41d2593dafa284e11a3c41058a8b35ea8a3dcbee2cf73f23a3732028f50764dd2703ac485165842de14634eab8cb14fb89a485dd538a680e5f
+  data.tar.gz: 6e944fc4822da56b58d2e7a582750e2a980d67dad51a194cc1898eb644fe336792ae49b9385b2d60b7d2ff96d6a513d27123fa879875e75c730802e6a6771a59

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.15.4
+
+services:
+  - mongodb
+
+addons:
+  apt:
+    sources:
+      - mongodb-3.4-precise
+    packages:
+      - mongodb-org-server

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mongoid-denormalize.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 rjurado
+
+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,100 @@
+# Mongoid::Denormalize
+![Build Status](https://travis-ci.org/rjurado01/mongoid-denormalize.svg?branch=master)
+
+Helper module for denormalizing association attributes in Mongoid models
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid-denormalize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-denormalize
+
+## Usage
+
+In your model:
+
+```ruby
+# Include the helper method
+include Mongoid::Denormalize
+
+# Define your denormalized fields
+denormalize :name, :email, from: :user
+```
+
+You need to add `inverse_of` to `belongs_to` side if `has_many` target name is diferent from model:
+
+```ruby
+class Club
+  ...
+  has_many :members, class_name: 'User'
+end
+
+class User
+  ...
+  belogns_to club, inverse_of: :members
+
+  denormalize :name, from: :club
+end
+```
+
+## Example
+
+```ruby
+class User
+  include Mongoid::Document
+  include Mongoid::Denormalize
+
+  field :name
+
+  has_many :books
+end
+
+class Book
+  include Mongoid::Document
+  include Mongoid::Denormalize
+
+  field :title
+
+  belongs_to :author
+
+  denormalize :name, from: :author
+end
+
+>> user = User.create(name: 'User1')
+>> book = Book.create(title: 'Title', author: user)
+>> book.author_name
+"User1"
+
+>> user.update_attributes(name: 'User1.1')
+>> book.reload.author_name
+"User1.1"
+
+>> new_user = User.create(name: 'User2')
+>> book.update_attributes(author: new_user)
+>> book.reload.author_name
+"User2"
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rjurado01/mongoid-denormalize.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid/denormalize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mongoid-denormalize.rb

@@ -0,0 +1,47 @@
+require "mongoid-denormalize/version"
+
+module Mongoid
+  module Denormalize
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def denormalize(*args)
+        options = args.pop
+
+        unless options.is_a?(Hash) && (from = options[:from]&.to_s)
+          raise ArgumentError, 'Option :from is needed (e.g. delegate :name, from: :user).'
+        end
+
+        # 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
+        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
+
+        # When 'from' is updated, update all childs
+        from_class.send(:after_update) do
+          attributes = {}
+          args.each { |field| attributes["#{from}_#{field}"] = send(field) }
+
+          unless relations[inverse_of.to_s]
+            raise "Option :inverse_of is needed for 'belongs_to :#{from}' into #{model_class}."
+          end
+
+          send(inverse_of).update_all('$set' => attributes)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid-denormalize/version.rb

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

data/mongoid-denormalize.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid-denormalize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mongoid-denormalize'
+  spec.version       = Mongoid::Denormalize::VERSION
+  spec.authors       = ['rjurado01']
+  spec.email         = ['rjurado01@gmail.com']
+
+  spec.summary       = 'Denormalize fields from relations'
+  spec.description   = 'Helper module for denormalizing relations attributes in Mongoid models'
+  spec.homepage      = 'https://github.com/rjurado01/mongoid-denormalize'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  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 'rspec', '~> 3.0'
+  spec.add_dependency 'mongoid'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-denormalize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rjurado01
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helper module for denormalizing relations attributes in Mongoid models
+email:
+- rjurado01@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongoid-denormalize.rb
+- lib/mongoid-denormalize/version.rb
+- mongoid-denormalize.gemspec
+homepage: https://github.com/rjurado01/mongoid-denormalize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Denormalize fields from relations
+test_files: []