mongoid_extended_dirty_trackable 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 913f8c7ecec74560dba0dd1eeabfd2e1851a742e
+  data.tar.gz: 8b724dca2a098edce9f7f95b5e981cc98deafb32
+SHA512:
+  metadata.gz: afda3e2dc4e579511ecc1a46f7f3b9f6648f5c7e3037ba88c661977c7ba5b36c32df26874becd2e564f4d8da7e50c1bc832220e7d27a7c2ed3c162dd7dcae453
+  data.tar.gz: 1789a15154df9771ced0e97910578ec2584e27d0f83e259f8c8cca28ff7a939146f4c2c273dcf3eb9223419d29f18afe958f5cfb9cbc8a5c06cf88f4e2bc6630

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,15 @@
+script: "bundle exec rspec spec"
+
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+  - jruby-19mode
+  - rbx-2
+
+services:
+  - mongodb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Thomas Graves
+
+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,87 @@
+[![Build Status](https://travis-ci.org/graves/mongoid_extended_dirty_trackable.svg?branch=master)](https://travis-ci.org/graves/mongoid_extended_dirty_trackable)
+
+# Mongoid::ExtendedDirtyTrackable
+
+A Mongoid Extension that gives you the ability to track changes to embedded and related documents through a parent.
+
+It was born from a need in a production app I work on from which it was extracted. If you'd like a pretty detailed run down of what exactly the code is doing you can find it on [my blog.](http://blog.ooo.pm/dirty-tracking-embedded-documents-with-mongoid/)
+
+I don't consider this Gem production ready. Mostly because I ran into some issues when writing the specs after Gemifying the original Concern. None of these problems exist in my production app so I'm lead to believe they are the result of the _hack_ job I did setting up and tearing down mongo for the tests. I plan on working these issues out in the near future and if you'd like to know more check out my [blog post that covers them.](http://blog.ooo.pm/post-im-gonna-write-tomorrow-morning)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_extended_dirty_trackable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install mongoid_extended_dirty_trackable
+
+## Usage
+
+I tried to make the specs work as documentation but for those of you averse to reading them I'll make it easy for you.
+
+```ruby
+class Account
+  include Mongoid::Document
+  include Mongoid::ExtendedDirtyTrackable
+
+  field :name
+
+  embeds_one :address
+  embeds_many :invoices
+  has_many :offices
+end
+
+account = Account.create(name: "Prestige Worldwide")
+account.name = "Umbrella Corp"
+account.changed?                             #=> true
+account.changes["name"]                      #=> ["Prestige Worldwide", "Umbrella Corp"]
+
+account.create_address(zipcode: "90210")
+account.address.zipcode = "1000 AS"
+account.changed?                             #=> true
+account.changes["zipcode"]                   #=> ["90210", "1000 AS"]
+
+account.invoices.create(total: 420.00)
+account.invoices.first.total = 69.69
+account.changed?                             #=> true
+account.changes["total"]                     #=> [420.00, 69.69]
+
+office = account.offices.create(number: 666)
+office.number = 5446
+
+account.changed?                             #=> true
+account.changes["number"]                    #=> [666, 5446]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+All pull requests are met with open arms and gratitude.
+
+Check the TODO file or the Github Issue tracker for suggestions on where to begin.
+
+Please be sure your pull request includes descriptive commit messages and tests that cover your feature, change, or bug.
+
+1. Fork it ( https://github.com/graves/mongoid_extended_dirty_trackable/fork )
+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 a new Pull Request
+
+## Similar Projects
+
+[versative/mongoid_relations_dirty_tracking](https://github.com/versative/mongoid_relations_dirty_tracking) - This is a little more full featured and much more in the direction I plan on taking but I feel like it can be done in a more simple manner with less code.
+
+[millisami/gist:721466](https://gist.github.com/millisami/721466) - The code in this Gist no longer works or maybe it never did but it served as the inspiration for my Gem. Thanks [millisami!](https://github.com/millisami)

data/Rakefile

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

data/TODO

@@ -0,0 +1,9 @@
+- lib/mongoid/extended_dirty_trackable.rb could use some refactoring, at least a few method extractions
+- change @associated_changes and @embedded_changes back to being conditional assignments
+- doing the above should fix the infinite recursion bug that happens when two related classes both include the mixin
+- figure out why and fix #associated_changes and #embedded_changes returning only empty hashes when their instance variables set by conditional assignment
+- REMEMBER: ^ empty hashes are not falsey
+- setup a proper mongo instance (using the yaml config file) for tests
+- use DatabaseCleaner to clear out the db before each test
+- the above 2 might be the fix the empty hash on conditional assignment bug mentioned above
+- maybe include object id and relationship name in the changes hash or implement in seperate methods

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid"
+require "mongoid_extended_dirty_trackable"
+
+# 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.
+
+require "pry"
+Pry.start

data/bin/setup

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

data/lib/mongoid/extended_dirty_trackable.rb

@@ -0,0 +1,55 @@
+require 'mongoid'
+require 'active_support/concern'
+
+module Mongoid
+  module ExtendedDirtyTrackable
+    extend ActiveSupport::Concern
+
+    included do
+      attr_writer :embedded_changes, :associated_changes
+    end
+
+    def associated_changes
+      @associated_changes = begin
+        self.associations.keys.inject({}) do |memo, association|
+          _changes = msg_relative(association)
+          memo.merge!(_changes)
+          memo
+        end
+      end
+    end
+
+    def msg_relative(relationship)
+      relative = self.send(relationship)
+
+      if relative && !relative.is_a?(Array) && relative.changed?
+        _changes = relative.changes
+      elsif relative && relative.is_a?(Array) && relative.any?(&:changed)
+        _changes = relative.inject({}) do |memo, obj|
+          memo.merge!(obj.changes) if obj.changed?
+        end
+      end
+
+      _changes || {}
+    end
+
+    def embedded_changes
+      @embedded_changes = begin
+        self.collect_children.inject({}) do |memo, child|
+          memo.merge!(child.changes) if child.changed?
+          memo
+        end
+      end
+    end
+
+    def changes
+      from_super = super
+      from_super.merge!(associated_changes)
+      from_super.merge!(embedded_changes)
+    end
+
+    def changed?
+      super || self._children.any?(&:changed?)
+    end
+  end
+end

data/lib/mongoid/extended_dirty_trackable/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module ExtendedDirtyTrackable
+    VERSION = "0.2.0"
+  end
+end

data/lib/mongoid_extended_dirty_trackable.rb

@@ -0,0 +1,2 @@
+require 'mongoid/extended_dirty_trackable'
+require 'mongoid/extended_dirty_trackable/version'

data/mongoid_extended_dirty_trackable.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid/extended_dirty_trackable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_extended_dirty_trackable"
+  spec.version       = Mongoid::ExtendedDirtyTrackable::VERSION
+  spec.authors       = ["Thomas Graves"]
+  spec.email         = ["thomas@ooo.pm"]
+
+  spec.summary       = "Mongoid extension for tracking changes to embedded and related documents"
+  spec.description   = <<-EOS
+    An ActiveSupport::Concern that extends Mongoid to give you a mixin for tracking changes to embedded and related documents
+  EOS
+  spec.homepage      = "https://github.com/graves/mongoid_extended_dirty_trackable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activesupport', '~> 3.0'
+  spec.add_runtime_dependency 'mongoid', '>= 3.1.0', '< 4.0'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_extended_dirty_trackable
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Thomas Graves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  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: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      An ActiveSupport::Concern that extends Mongoid to give you a mixin for tracking changes to embedded and related documents
+email:
+- thomas@ooo.pm
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- bin/console
+- bin/setup
+- lib/mongoid/extended_dirty_trackable.rb
+- lib/mongoid/extended_dirty_trackable/version.rb
+- lib/mongoid_extended_dirty_trackable.rb
+- mongoid_extended_dirty_trackable.gemspec
+homepage: https://github.com/graves/mongoid_extended_dirty_trackable
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Mongoid extension for tracking changes to embedded and related documents
+test_files: []