active_mongoid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ff0adb96c96346c33a8bcaadc937cb1ea88fc3d
+  data.tar.gz: 31756fa2b770746578c5b7141793a5f773dd1926
+SHA512:
+  metadata.gz: 3af1c4a4648a01fd468d1af6dffdea2ea8c59c05c5a294b5809145c2e95e03060d3ef8c811202324d669a12b181d9a068edae0db434c1a295f5fb54701e5226a
+  data.tar.gz: 4778b1b9d42cc5726b50cf34c200ab8ca4fa0fb824e270da203fa118ae0c4d921ede75aa181ede0cf31a9773fd02220f9b92aec8f56454f5523ea4d415884446

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.ruby_gemset

@@ -0,0 +1 @@
+active_mongoid

data/.ruby_version

@@ -0,0 +1 @@
+2.0.0

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+services:
+  - mongodb
+script: bundle exec rspec
+gemfile:
+  - gemfiles/mongoid_2.8.gemfile
+  - gemfiles/mongoid_3.1.gemfile

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "mongoid-2.8" do
+  gem "mongoid", "~> 2.8.1"
+end
+
+appraise "mongoid-3.1" do
+  gem "mongoid", "~> 3.1.0"
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bryce Schmidt
+
+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/README.md

@@ -0,0 +1,198 @@
+# ActiveMongoid
+[![Build Status][build_status_image]][build_status]
+[![Coverage Status][coverage_status_image]][coverage_status]
+
+ActiveMongoid facilitates usage of both ActiveRecord and Mongoid in a single rails application by providing an ActiveRecord-like interface for inter-ORM relations. It was written to replace select Mongoid models with ActiveRecord versions so it tries to adhere to the Mongoid API as closely as possible. To accomplish this compatibility, much of the logic and structure of this lib are either directly inspired by or straight up ripped off the Mongoid source.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_mongoid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_mongoid
+
+## Usage by Example
+
+### ActiveMongoid::Associations
+
+To add ActiveMongoid associations, simply add the `ActiveMongoid::Associations` module in both models and define the relations using the provided macros as you would with either ActiveRecord or Mongoid.
+
+#### ActiveRecord
+```ruby
+class Player < ActiveRecord::Base
+  include ActiveMongoid::Associations
+
+  belongs_to_document :team
+  has_one_document :stat, as: :target, autosave: true, dependent: :destroy
+end
+```
+
+#### Mongoid
+```ruby
+class Team
+  include Mongoid::Document
+  include ActiveMongoid::Associations
+
+  has_many_records :players, autosave: true, order: "name asc"
+  belongs_to_record :division
+end
+```
+
+Then you can interact with the models and relations just as you would with either ActiveRecord or Mongoid.
+```ruby
+> team = Team.create
+=> #<Team _id: 5453d55cb736b692ab000001, name: nil>
+> player = team.players.build(name: "foo") # create will call save
+=> #<Player id: nil, name: "foo", team_id: "5453d55cb736b692ab000001">
+> team.player << Player.new(name: "foo1")
+=> #<Player id: nil, name: "foo1", team_id: "5453d55cb736b692ab000001">
+> team.players
+=> [#<Player id: nil, name: "foo", team_id: "5453d55cb736b692ab000001">, #<Player id: nil, name: "foo1", team_id: "5453d55cb736b692ab000001">] 
+> player.team # binds the inverse
+=> #<Team _id: 5453d55cb736b692ab000001, name: nil>
+> team.save
+=> true
+> team.players
+=> [#<Player id: 1, name: "foo", team_id: "5453d55cb736b692ab000001">, #<Player id: 2, name: "foo1", team_id: "5453d55cb736b692ab000001">] 
+> team.players.where(name: "foo") # returns relation so chaining is possible
+=> [#<Player id: 1, name: "foo", team_id: "5453d55cb736b692ab000001">]
+> team.players.where(name: "foo").where(id: 1)
+=> [#<Player id: 1, name: "foo", team_id: "5453d55cb736b692ab000001">]  
+> player = Player.create(name: "baz")
+=> #<Player id: 3, name: "baz", team_id: nil>
+> team = player.build_team(name: "bar")  # create_ will call save
+=> #<Team _id: 5453d55cb736b692ab000002, name: "bar">
+> team.players
+=> [#<Player id: 3, name: "foo", team_id: "5453d55cb736b692ab000002">] 
+> player.team(true) # forces reload from database
+=> nil 
+```
+
+## API Documentation
+
+### ActiveMongoid::Associations
+
+#### Record/Document Association HasMany Class Methods
+* ```has_many_records :players``` 
+* ```has_many_documents :stats``` 
+
+Options:
+  - ```order``` Needs to be formated according to ActiveRecord/Mongoid spec respectively
+  - ```dependent``` Accepts: `:destroy, :delete`
+  - ```as``` Polymorphic relation
+  - ```foreign_key``` Foreign key for relation
+  - ```primary_key``` Primary key for relation
+  - ```class_name``` Association class name
+  - ```autosave``` Accepts `:true`
+  
+#### Record/Document Association HasOne and BelongsTo Class Methods
+* ```has_one_record :player``` 
+* ```belongs_to_record :player```
+* ```has_one_record :stat``` 
+* ```belongs_to_record :stat``` 
+
+Options:
+  - ```dependent``` Accepts: `:destroy, :delete`
+  - ```as``` Polymorphic relation
+  - ```foreign_key``` Foreign key for relation
+  - ```primary_key``` Primary key for relation
+  - ```class_name``` Association class name
+  - ```autosave``` Accepts `:true`
+
+#### Record/Document Association HasMany Instance Methods
+* ```team.players``` Returns the relation
+* ```team.players(true)``` Forces reload from database and returns relation
+* ```team.players = [player]``` Assigns objects and calls dependent method on old values
+* ```team.players << player``` Appends object and will save if base is persisted
+* ```team.players.build({player.attributes})``` Builds and binds object from attributes and binds relation
+* ```team.players.concat([player_1, player_2]``` Appends and binds array of objects. Will save if base is persisted
+* ```team.players.purge``` Removes all objects from relation and calls dependent method on objects
+* ```team.players.delete(player)``` Removes object and calls dependent method on object
+* ```team.players.delete_all(optional_criteria)``` Calls delete on all objects
+* ```team.players.destroy_all(optional_criteria)``` Calls destroy on all objects
+* ```team.players.each``` Iterates on on objects
+* ```team.players.exists?``` Calls exists? on relation
+* ```team.players.find(params)``` Returns relation with criteria added
+* ```team.players.nullify``` Clears loaded relation 
+* ```team.players.blank?``` Returns `true` if empty
+* ```team.players.create({player.attributes})``` Creates and binds from attributes
+* ```team.players.create!({player.attributes})``` Creates and binds form attributes and raises an exception if fails
+* ```team.players.find_or_create_by({player.attributes})``` Finds or creates a record from attributes
+* ```team.players.find_or_initialize_by({player.attributes})``` Finds or initializes a record from attributes
+* ```team.players.nil?``` returns `false`
+
+All other methods will defer to the ActiveRecord/Mongoid relation respectively.
+
+#### Record/Document Association HasOne and BelongsTo Instance Methods
+* ```player.stat``` Returns the relation
+* ```player.stat(true)``` Forces reload from database and returns relation
+* ```player.stat = stat``` Assigns object as relation. Will substitute old value and call dependent method
+* ```player.build_stat({})``` Builds and binds new object from attributes 
+* ```player.create_stat({})``` Creates and binds new object from attributes
+
+All other methods called on relation will defer to the object.
+
+### ActiveMongoid::BsonId
+
+The BsonId module faciliates the useage of `BSON::ObjectId`'s on ActiveRecord objects. This module is especially helpful if you are migrating a model from a Mongoid object to an ActiveRecord object and want to carry over the old id.
+
+```ruby
+class Division < ActiveRecord::Base
+  include ActiveMongoid::BsonId
+  bsonify_attr :_id, initialize: true
+end
+```
+
+```ruby
+> division._id
+=> BSON::ObjectId('545289a7b736b6586a000001')
+> division._id = BSON::ObjectId('545289a7b736b6586a000002')
+=> BSON::ObjectId('545289a7b736b6586a000002')
+> division._id = '545289a7b736b6586a000002'
+=> BSON::ObjectId('545289a7b736b6586a000002')
+```
+
+### ActiveMongoid::Finders
+
+This module proxies the existing ActiveRecord `find` and `where` to perform casting of `BSON::ObjectId`'s to string for queries. Additionally it'll default to the `_id` field if the object is a valid `BSON::ObjectId` and the `_id` field is present on the model. 
+
+```ruby
+class Division < ActiveRecord::Base
+  include ActiveMongoid::BsonId
+  include ActiveMongoid::Finders
+  bsonify_attr :_id, initialize: true
+end
+```
+
+```ruby
+> Division.find(1)
+=> #<Tournament id: 1, _id: "545289a7b736b6586a000001", name: "new tournament">
+> Division.find(BSON::ObjectId('545289a7b736b6586a000001')
+=> #<Tournament id: 1, _id: "545289a7b736b6586a000001", name: "new tournament">
+> Division.where(_id: BSON::ObjectId('545289a7b736b6586a000001')
+=> [#<Tournament id: 1, _id: "545289a7b736b6586a000001", name: "new tournament">]
+> Division.where(id: BSON::ObjectId('545289a7b736b6586a000001')
+=> [#<Tournament id: 1, _id: "545289a7b736b6586a000001", name: "new tournament">]
+```
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/active_mongoid/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
+
+[build_status]: https://travis-ci.org/sportngin/active_mongoid
+[build_status_image]: https://travis-ci.org/sportngin/active_mongoid.svg?branch=master
+[coverage_status]: https://coveralls.io/r/sportngin/active_mongoid
+[coverage_status_image]: https://img.shields.io/coveralls/sportngin/active_mongoid.svg

data/Rakefile

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler/setup"
+require "bundler/gem_tasks"
+
+task :test do
+  system "rspec -b"
+end

data/active_mongoid.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_mongoid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_mongoid"
+  spec.version       = ActiveMongoid::VERSION
+  spec.authors       = ["Bryce Schmidt"]
+  spec.email         = ["bryce.schmidt@sportngin.com"]
+  spec.summary       = %q{ActiveMongoid provides a relational interface between ActiveRecord and Mongoid objects.}
+  spec.description   = %q{ActiveMongoid facilitates usage of both ActiveRecord and Mongoid in a single app by providing an inteface for inter-ORM relations.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "activerecord"
+  spec.add_dependency "mongo"
+  spec.add_dependency "bson_ext"
+  spec.add_dependency "mongoid"
+  spec.add_dependency "after_do"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-gem-adapter"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "appraisal"
+end

data/gemfiles/mongoid_2.8.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mongoid", "~> 2.8.1"
+
+gemspec :path => "../"

data/gemfiles/mongoid_2.8.gemfile.lock

@@ -0,0 +1,105 @@
+PATH
+  remote: ../
+  specs:
+    active_mongoid (0.0.1)
+      activerecord
+      activesupport
+      after_do
+      bson_ext
+      mongo
+      mongoid
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.19)
+      activesupport (= 3.2.19)
+      builder (~> 3.0.0)
+    activerecord (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.19)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    after_do (0.3.1)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (3.0.3)
+    bson (1.9.2)
+    bson_ext (1.9.2)
+      bson (~> 1.9.2)
+    builder (3.0.4)
+    coderay (1.1.0)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    database_cleaner (1.3.0)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    i18n (0.6.11)
+    method_source (0.8.2)
+    mime-types (2.3)
+    mongo (1.9.2)
+      bson (~> 1.9.2)
+    mongoid (2.8.1)
+      activemodel (~> 3.1)
+      mongo (~> 1.9)
+      tzinfo (~> 0.3.22)
+    multi_json (1.10.1)
+    netrc (0.7.7)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-gem-adapter (1.0.1)
+      simplecov
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+    sqlite3 (1.3.9)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.3.2)
+    tzinfo (0.3.41)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_mongoid!
+  appraisal
+  coveralls
+  database_cleaner
+  mongoid (~> 2.8.1)
+  pry
+  rspec
+  simplecov
+  simplecov-gem-adapter
+  sqlite3