mongoid-nested-serialization 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+if ! rvm list | grep -q ruby-1.9.3-p194 ; then
+	rvm install 1.9.3-p194
+fi
+
+rvm 1.9.3-p194@ryantownsend_mongoid_nested_serialization --create
+
+if ! gem list | grep -q bundler ; then
+	gem install --no-ri --no-rdoc bundler
+	bundle install --without production
+fi

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+services:
+  - mongodb

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryan Townsend
+
+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/Procfile

@@ -0,0 +1 @@
+mongo: mongod --config /usr/local/etc/mongod.conf

data/README.md

@@ -0,0 +1,54 @@
+# MongoidNestedSerialization
+
+Loads nested Mongoid documents using JSON serialization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "mongoid-nested-serialization"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-nested-serialization
+
+## Usage
+
+The module will be automatically loaded into your `Mongoid::Document` objects:
+
+```ruby
+class User
+  include Mongoid::Document
+  # also performs:
+  # include Mongoid::NestedSerialization
+  
+  # objects may be embedded within others
+  embedded_in :account, inverse_of: :users
+end
+
+# find the root object
+account = Account.first
+# create a persisted object within it
+user = account.users.create # => <User id:123>
+# load the JSON needed to find the object
+json = user.finder_json
+# => { class_name: "Account", id: 456, embedded: { collection: "users", id: 123 } }
+User.find_by_json(json)
+# => <User id:123>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add your code and tests
+4. Run the full test suite (`bundle exec foreman start; bundle exec rake; bundle exec foreman stop`) and ensure it passes 100%
+5. Commit your changes (`git commit -am 'Added some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+desc "Runs all the specs"
+task default: %w(spec)
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end

data/lib/mongoid/nested_serialization/core_ext.rb

@@ -0,0 +1,8 @@
+module Mongoid
+  module Document
+    def self.included(base)
+      super
+      base.send(:include, Mongoid::NestedSerialization)
+    end
+  end
+end

data/lib/mongoid/nested_serialization/finder.rb

@@ -0,0 +1,41 @@
+require "multi_json"
+
+module Mongoid
+  module NestedSerialization
+    class Finder
+      def initialize(klass)
+        @klass = klass
+      end
+      
+      # parse the raw JSON data into a hash
+      def parse_input(json)
+        MultiJson.load(json)
+      end
+      
+      # load the top level object directly with the collection
+      def top_level_object(data)
+        data["class_name"].constantize.find(data["id"])
+      end
+      
+      # load an object nested within another, using the data
+      def nested_object(object, data)
+        object.send(data["association"]).find(data["id"])
+      end
+
+      def find(json)
+        data = parse_input(json)
+        # load the top level object
+        object = top_level_object(data)
+        # if we have embedded stuff
+        while data["embedded"]
+          # work on the next level down
+          data = data["embedded"]
+          # find the nested object
+          object = nested_object(object, data)
+        end
+        # once at the bottom, return the object
+        object
+      end
+    end
+  end
+end

data/lib/mongoid/nested_serialization/serializer.rb

@@ -0,0 +1,45 @@
+require "multi_json"
+
+module Mongoid
+  module NestedSerialization
+    class Serializer
+      def initialize(object)
+        @object = object
+      end
+      
+      # spits out a JSON hash which can be used to relocate
+      # the object in the collection tree
+      def to_json
+        # convert the result to JSON
+        MultiJson.dump(to_hash)
+      end
+
+      # spits out a hash which can be used to relocate
+      # the object in the collection tree
+      def to_hash(embedded_contents = nil)
+        if object.embedded?
+          # select the relation for the parent object
+          parent_relation = object.relations.select do |k,v|
+            v.macro == :embedded_in && v.class_name == object._parent.class.name
+          end.values.first
+          # embed this in the parent's hash
+          result = {
+            association: parent_relation.inverse_of,
+            id: object.id
+          }
+          result = result.merge(embedded: embedded_contents) if embedded_contents
+          self.class.new(object._parent).to_hash(result)
+        else # !embedded?
+          result = { class_name: object.class.name, id: object.id }
+          result[:embedded] = embedded_contents if embedded_contents
+          result
+        end
+      end
+      
+      private
+      def object
+        @object
+      end
+    end
+  end
+end

data/lib/mongoid/nested_serialization/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module NestedSerialization
+    VERSION = "0.0.1"
+  end
+end

data/lib/mongoid/nested_serialization.rb

@@ -0,0 +1,24 @@
+require "mongoid/nested_serialization/core_ext"
+require "mongoid/nested_serialization/finder"
+require "mongoid/nested_serialization/serializer"
+
+module Mongoid
+  module NestedSerialization
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+    
+    module ClassMethods
+      def find_by_json(json)
+        Mongoid::NestedSerialization::Finder.new(self).find(json)
+      end
+    end
+    
+    module InstanceMethods
+      def finder_json
+        Mongoid::NestedSerialization::Serializer.new(self).to_json
+      end
+    end
+  end
+end

data/lib/mongoid-nested-serialization.rb

@@ -0,0 +1,2 @@
+require "mongoid/nested_serialization/version"
+require "mongoid/nested_serialization"

data/mongoid_nested_serialization.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/mongoid/nested_serialization/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors       = ["Ryan Townsend"]
+  s.email         = ["ryan@ryantownsend.co.uk"]
+  s.description   = %q{Loads nested Mongoid documents using a JSON serialization}
+  s.summary       = s.description
+  s.homepage      = "https://github.com/ryantownsend/mongoid-nested-serialization"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(spec|features)/})
+  s.name          = "mongoid-nested-serialization"
+  s.require_paths = ["lib"]
+  s.version       = Mongoid::NestedSerialization::VERSION
+  
+  s.add_dependency "mongoid"
+  s.add_dependency "multi_json"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "foreman"
+end

data/spec/mongoid/nested_serialization/finder_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe Mongoid::NestedSerialization::Finder do
+  let(:account) { Mongoid::NestedSerialization::Test::Account.create }
+  let(:item) { account.items.create }
+  let(:photo) { item.photos.create }
+  
+  describe "#find" do
+    it "should find top-level objects" do
+      result = account.class.find_by_json(account.finder_json)
+      expect(result).to eq account
+    end
+    
+    it "should find second-level objects" do
+      result = item.class.find_by_json(item.finder_json)
+      expect(result).to eq item
+    end
+    
+    it "should find third-level objects" do
+      result = photo.class.find_by_json(photo.finder_json)
+      expect(result).to eq photo
+    end
+  end
+
+end

data/spec/mongoid/nested_serialization/serializer_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe Mongoid::NestedSerialization::Serializer do
+  let(:serialized) do
+    Mongoid::NestedSerialization::Serializer.new(object).to_hash
+  end
+  let(:account) { Mongoid::NestedSerialization::Test::Account.create }
+  let(:item) { account.items.create }
+  let(:photo) { item.photos.create }
+
+  describe "#to_hash" do
+    context "given a top-level object" do
+      let(:object) { account }
+      
+      it "should not have embedded data" do
+        expect(serialized.has_key?(:embedded)).to be_false
+      end
+    end
+    
+    context "given a second-level object" do
+      let(:object) { item }
+      
+      it "should have embedded data" do
+        expect(serialized.has_key?(:embedded)).to be_true
+      end
+      
+      it "should not have double embedded data" do
+        expect(serialized[:embedded].has_key?(:embedded)).to be_false
+      end
+    end
+    
+    context "given a third-level object" do
+      let(:object) { photo }
+      
+      it "should have embedded data" do
+        expect(serialized.has_key?(:embedded)).to be_true
+      end
+      
+      it "should have double embedded data" do
+        expect(serialized[:embedded].has_key?(:embedded)).to be_true
+      end
+    end
+  end
+end

data/spec/mongoid/nested_serialization_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Mongoid::NestedSerialization do
+  describe "::included" do
+    let(:document) do
+      Class.new do
+        include Mongoid::Document
+      end
+    end
+    
+    it "should be included in any Mongoid::Document models" do
+      expect(document.included_modules).to include Mongoid::NestedSerialization
+    end
+    
+    it "should provide a ::find_by_json method" do
+      expect(document).to respond_to :find_by_json
+    end
+    
+    it "should provide a #finder_json method" do
+      expect(document.new).to respond_to :finder_json
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "simplecov"
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+require "mongoid"
+require "mongoid-nested-serialization"
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }

data/spec/support/env.rb

@@ -0,0 +1,8 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.color_enabled = true
+  config.order = :random
+end

data/spec/support/models.rb

@@ -0,0 +1,27 @@
+module Mongoid
+  module NestedSerialization
+    module Test
+      # top level object
+      class Account
+        include ::Mongoid::Document
+        
+        embeds_many :items #, class_name: "Mongoid::NestedSerialization::Test::Item"
+      end
+      
+      # second level object
+      class Item
+        include ::Mongoid::Document
+        
+        embedded_in :account, inverse_of: :items
+        embeds_many :photos
+      end
+      
+      # third level object
+      class Photo
+        include ::Mongoid::Document
+      
+        embedded_in :item, inverse_of: :photos
+      end
+    end
+  end
+end

data/spec/support/mongoid.rb

@@ -0,0 +1,3 @@
+require "mongoid"
+
+Mongoid.load!(File.join(File.dirname(__FILE__), "mongoid.yml"), :test)

data/spec/support/mongoid.yml

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

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-nested-serialization
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Townsend
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-24 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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: foreman
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Loads nested Mongoid documents using a JSON serialization
+email:
+- ryan@ryantownsend.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE
+- Procfile
+- README.md
+- Rakefile
+- lib/mongoid-nested-serialization.rb
+- lib/mongoid/nested_serialization.rb
+- lib/mongoid/nested_serialization/core_ext.rb
+- lib/mongoid/nested_serialization/finder.rb
+- lib/mongoid/nested_serialization/serializer.rb
+- lib/mongoid/nested_serialization/version.rb
+- mongoid_nested_serialization.gemspec
+- spec/mongoid/nested_serialization/finder_spec.rb
+- spec/mongoid/nested_serialization/serializer_spec.rb
+- spec/mongoid/nested_serialization_spec.rb
+- spec/spec_helper.rb
+- spec/support/env.rb
+- spec/support/models.rb
+- spec/support/mongoid.rb
+- spec/support/mongoid.yml
+homepage: https://github.com/ryantownsend/mongoid-nested-serialization
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1142570094106982720
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1142570094106982720
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Loads nested Mongoid documents using a JSON serialization
+test_files:
+- spec/mongoid/nested_serialization/finder_spec.rb
+- spec/mongoid/nested_serialization/serializer_spec.rb
+- spec/mongoid/nested_serialization_spec.rb
+- spec/spec_helper.rb
+- spec/support/env.rb
+- spec/support/models.rb
+- spec/support/mongoid.rb
+- spec/support/mongoid.yml