consort 0.0.3 → 0.1.0.pre

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDJkNmNjYjhjODY0ZmM3M2M1YTg5ODFhZDU1NDJlODhiODY1Y2U2NQ==
+    OWQwYmI3YmJlN2E2OWU3NTkwZmUyZDM3NDE0M2UwMDViYzBjNjI0OA==
   data.tar.gz: !binary |-
-    OGY3MGYwYThlMGRmZjczMjY0ZTQ2MjFiZmZkYzY2NjNlOWM4YWM5Yw==
+    NzZmOTNmMmQ2Y2E3OTFjN2I4Yzk4MDg1ZmNiMmE2YTZkODIyNmEzZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YzRkNTA2ZmE5Yzc4ZmVkNTU5ZDE3ZmIzNTk4MmUwNmQwMDZkNDU0MmI4MjMx
-    NmZkMWYwMmQyM2Y3OWE5MjE4Y2JjMTY2ZGUzZTNiYjRiN2U5Y2I1YmZmNDdk
-    MjVjNmI2NDA4MzUyOTgzZmU5NTU0OGJhMjc1YWY2MWRlOWQyNTk=
+    ZmQwOTFlZDQxNzIzODM2MmVlNjYxZTk4MGFjM2U4M2MxOThkMmFkN2Y0OWVl
+    MWYzZTM2MzYyNzNiMGI2ODA4M2EyZmU4OWJkOTYzNzQ1ZTNjMWNmZjBhNmNj
+    Nzc4OWFjMWY4MjE5YTQyNDk5NjRmNDliYzJhOGNkM2Y2Y2U1NDk=
   data.tar.gz: !binary |-
-    MDkyYmU4MTk0ODc3OWYzZjk5NGM2ZGI4N2UxNTIwZGVlZmE1MWM4NTc2ZjA5
-    ZTZlOGI3Mzg5MzI0OWYwMDVkZWU3Yzg3MTY0ODE4ZDI2ZTIxMWRlZTczODhj
-    ODMyY2ZmNTc5ODMyZDkzOTk1NTU3OTMzMmU2YWIxYTA0YjAzYjA=
+    ZTU5ZTRiM2Q5MTExM2MzMWNhZDUxMWMyMGNmOTllYWJhYzU4ODAyZTY4MzI0
+    Njg0NWZjZjM0Y2Q4NTRkMTQ3YWEwNTAzMDEzNTcyMGRiMGVmY2NiNGFhMGVj
+    NjQ2Y2NkNzAyZDIzZTk1MTk5YmIwZDYzNGI5MWY2ZDAyZTFjMTQ=

data/CHANGELOG.md

@@ -1,6 +1,17 @@
+## master
+
+* Nothing yet!
+
+## 0.1.0pre1
+
+* Added support for Rails/ActiveSupport 3.1.
+* Added support for Rails/ActiveSupport 4.
+* Added MongoMapper support.
+* Removed dependencies on ActiveRecord and Mongoid. Bridges are now autoloaded based on what's available in the environment.
+
 ## 0.0.3
 
-* Restructured modules. Now in format `Consort::FromORM::ToORM`.
+* Restructured modules. Now in format `Consort::FromORM::ToORM`, e.g. `Consort::ActiveRecord::Mongoid`.
 * Travis now tests against Rails 3.1.12, 3.2.13, 4.0.0.
 
 ## 0.0.2

data/README.md

@@ -83,7 +83,7 @@ There are several things Consort doesn't (currently) do, either because I haven'
 seen them used when mixing object mappers, or because they may have horrible
 unintended consequences.
 
-This doesn't mean Consort **shouldn't** do them; if you have a use case for a
+This doesn't mean Consort *shouldn't* do them; if you have a use case for a
 missing feature, feel free to implement it and send a pull request, or create an
 issue with a feature request.
 

data/consort.gemspec

@@ -24,13 +24,15 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "activesupport",  "~> 3.2"
   spec.add_development_dependency "activerecord",   "~> 3.2"
   spec.add_development_dependency "mongoid",        "~> 3.1"
+  spec.add_development_dependency "mongo_mapper",   "~> 0.12"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "combustion"
+  spec.add_development_dependency "bson_ext"
 
-  spec.add_runtime_dependency     "activesupport",  "~> 3.2"
-  spec.add_runtime_dependency     "activerecord",   "~> 3.2"
-  spec.add_runtime_dependency     "mongoid",        "~> 3.1"
+  spec.add_runtime_dependency     "activesupport",  ['>= 3.1', '< 4.1']
+#  spec.add_runtime_dependency     "activerecord",   "~> 3.2"
+#  spec.add_runtime_dependency     "mongoid",        "~> 3.1"
 end

data/gemfiles/Gemfile.rails-3.1.x

@@ -6,6 +6,8 @@ gem "minitest",       "~> 4.7"
 gem "activesupport",  "~> 3.1.12"
 gem "activerecord",   "~> 3.1.12"
 gem "mongoid",        "~> 3.0.0"
+gem "mongo_mapper",   "~> 0.12.0"
+gem "bson_ext"
 gem "coveralls"
 gem "sqlite3"
 gem "pry"

data/gemfiles/Gemfile.rails-4.0.x

@@ -5,7 +5,9 @@ gem "rake"
 gem "minitest",       "~> 4.7"
 gem "activesupport",  "~> 4.0.0"
 gem "activerecord",   "~> 4.0.0"
-gem "mongoid",  :git => 'https://github.com/mongoid/mongoid.git'
+gem "mongoid",        :git => 'https://github.com/mongoid/mongoid.git'
+gem "mongo_mapper",   :git => 'https://github.com/jnunemaker/mongomapper.git'
+gem "bson_ext"
 gem "coveralls"
 gem "sqlite3"
 gem "pry"

data/lib/consort.rb

@@ -1,7 +1,16 @@
 require 'consort/version'
 
-require 'active_record'
-require 'mongoid'
+#require 'active_record'
+#require 'mongoid'
 
-require 'consort/active_record/mongoid'
-require 'consort/mongoid/active_record'
+if defined?(ActiveRecord::Base) && defined?(Mongoid::Document)
+  require 'consort/active_record/mongoid'
+  require 'consort/mongoid/active_record'
+end
+
+if defined?(ActiveRecord::Base) && defined?(MongoMapper::Document)
+  require 'consort/active_record/mongo_mapper'
+  require 'consort/mongo_mapper/active_record' 
+end
+
+#if defined?(ActiveRecord::Base) && defined?()

data/lib/consort/active_record/mongo_mapper.rb

@@ -0,0 +1,76 @@
+module Consort
+  ##
+  # Defines methods on ActiveRecord objects for creating MongoMapper
+  # relationships and accessing those related objects.
+  module ActiveRecord
+    module MongoMapper
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Defines a `has_one` relationship with a MongoMapper object.
+        # @param klass [Symbol]
+        # @example
+        #   has_one_mongo_mapper :dolphin
+        def has_one_mongo_mapper(klass)
+          class_eval <<-CODE
+            def #{klass}
+              #{klass.to_s.classify}.where(#{name.foreign_key}: id)
+            end
+          CODE
+        end
+
+        # Defines a `has_many` relationship with a MongoMapper object.
+        # @param klass [Symbol] 
+        # @example
+        #   has_many_mongo_mapper :unicorns
+        # @since 0.0.2
+        def has_many_mongo_mapper(klass)
+          class_eval <<-CODE
+            def #{klass}
+              #{klass.to_s.classify}.where(#{name.foreign_key}: id)
+            end
+          CODE
+        end
+
+        # @deprecated Use {#has_many_mongo_mapper} instead. Will be removed soon.
+        def has_many_mongo_mappers(klass)
+          ActiveSupport::Deprecation.warn 'This method will be removed in 3 releases. Please use the singular has_many_mongo_mapper instead.'
+          has_many_mongo_mapper(klass)
+        end
+
+        # Defines a `belongs_to` relationship with a MongoMapper object.
+        # An appropriate foreign key column (of type String) must exist on your model.
+        # @param klass [Symbol] 
+        # @example Migration
+        #   class AddMongoMapperFKeyToNarwhals < ActiveRecord::Migration
+        #     def change
+        #       add_column :narwhals, :pod_id, :string
+        #     end
+        #   end
+        # @example Model
+        #   class Narwhal < ActiveRecord::Base
+        #     belongs_to_mongo_mapper :pod
+        #   end
+        def belongs_to_mongo_mapper(klass)
+          class_eval <<-CODE
+            def #{klass}
+              #{klass.to_s.classify}.where(id: #{klass.to_s.foreign_key})
+            end
+          CODE
+        end
+      
+        # Allows easy validation of whether ActiveRecord to MongoMapper bridge is loaded.
+        # @return [Boolean] `true` if bridge is loaded
+        def active_record_consorts_with_mongo_mapper?
+          true
+        end
+      end
+    end
+  end
+end
+
+#if defined?(ActiveRecord::Base)
+class ActiveRecord::Base
+  include Consort::ActiveRecord::MongoMapper
+end
+#end

data/lib/consort/active_record/mongoid.rb

@@ -1,6 +1,6 @@
 module Consort
   ##
-  # Defines methods on ActiveRecord objects for creating NoSQL
+  # Defines methods on ActiveRecord objects for creating Mongoid
   # relationships and accessing those related objects.
   module ActiveRecord
     module Mongoid
@@ -32,9 +32,9 @@ module Consort
           CODE
         end
 
-        # @deprecated Use {#has_many_mongoid} instead. Will be removed in 1.0.0.
+        # @deprecated Use {#has_many_mongoid} instead. Will be removed soon.
         def has_many_mongoids(klass)
-          ActiveSupport::Deprecation.warn 'Please use the singular has_many_mongoid instead.'
+          ActiveSupport::Deprecation.warn 'This method will be removed in 3 releases. Please use the singular has_many_mongoid instead.'
           has_many_mongoid(klass)
         end
 

data/lib/consort/mongo_mapper/active_record.rb

@@ -0,0 +1,62 @@
+module Consort
+  module MongoMapper
+    module ActiveRecord
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Defines a `has_one` relationship with an ActiveRecord object.
+        # @param klass [Symbol]
+        # @example
+        #   has_one_active_record :dolphin
+        def has_one_active_record(klass)
+          class_eval <<-CODE
+            def #{klass}
+              #{klass.to_s.classify}.where(#{name.foreign_key}: id)
+            end
+          CODE
+        end
+
+        # Defines a `has_many` relationship with an ActiveRecord object.
+        # @param klass [Symbol] 
+        # @example
+        #   has_many_active_record :unicorns
+        # @since 0.0.2
+        def has_many_active_record(klass)
+          class_eval <<-CODE
+            def #{klass}
+              #{klass.to_s.classify}.where(#{name.foreign_key}: id)
+            end
+          CODE
+        end
+
+        # Defines a `belongs_to` relationship with an ActiveRecord object.
+        # An appropriate foreign key key must exist on your model.
+        # @param klass [Symbol] 
+        # @example
+        #   class Narwhal
+        #     include MongoMapper::Document
+        #
+        #     belongs_to_active_record :pod
+        #     key :pod_id, Integer
+        #   end
+        def belongs_to_active_record(klass)
+          class_eval <<-CODE
+            def #{klass}
+              #{klass.to_s.classify}.where(id: #{klass.to_s.foreign_key})
+            end
+          CODE
+        end
+
+        # Allows easy validation of whether MongoMapper to ActiveRecord bridge is loaded.
+        # @return [Boolean] `true` if bridge is loaded
+        def mongo_mapper_consorts_with_active_record?
+          true
+        end
+      end
+    end
+  end
+end
+
+module MongoMapper::Document
+  include Consort::MongoMapper::ActiveRecord
+end

data/lib/consort/mongoid/active_record.rb

@@ -29,9 +29,9 @@ module Consort
           CODE
         end
 
-        # @deprecated Use {#has_many_active_record} instead. Will be removed in 1.0.0.
+        # @deprecated Use {#has_many_active_record} instead. Will be removed soon.
         def has_many_active_records(klass)
-          ActiveSupport::Deprecation.warn 'Please use the singular has_many_active_record instead.'
+          ActiveSupport::Deprecation.warn 'This method will be removed in 3 releases. Please use the singular has_many_active_record instead.'
           has_many_active_record(klass)
         end
 

data/lib/consort/version.rb

@@ -1,3 +1,3 @@
 module Consort
-  VERSION = "0.0.3"
+  VERSION = "0.1.0.pre"
 end

data/test/db/schema.rb

@@ -20,5 +20,20 @@ ActiveRecord::Schema.define(:version => 0) do
     t.column :common_name, :string
     t.column :scientific_name, :string
   end
+  
+  create_table :pinnipeds, force: true do |t|
+    t.column :flippy_sea_creature_id, :integer
+  end
 
+  # 
+  create_table :liquids, force: true do |t|
+  end
+  
+  create_table :chemical_compositions, force: true do |t|
+    t.column :beverage_id, :integer
+  end
+  
+  create_table :flavors, force: true do |t|
+    t.column :beverage_id, :integer
+  end
 end

data/test/models.rb

@@ -1,4 +1,4 @@
-# Testing of AR bindings with light testing of reverses
+# Testing of AR bindings with light testing of Mongoid reverses
 class Ungulate < ActiveRecord::Base
   has_one_mongoid     :mango
   has_many_mongoid    :bongos
@@ -28,7 +28,69 @@ class Congo
   field :village_name, type: String
 end
 
+# -----------------------------------------------------------------------------
+# ActiveRecord <-> MongoMapper
+# -----------------------------------------------------------------------------
+
+class FlippySeaCreature
+  include MongoMapper::Document
+  has_many_active_record :pinnipeds
+  
+  key :flippers, Integer
+end
+
+class Pinniped < ActiveRecord::Base
+  has_many_mongo_mapper   :seals
+  has_one_mongo_mapper    :walrus
+  belongs_to_mongo_mapper :flippy_sea_creature
+end
+
+class Seal
+  include MongoMapper::Document
+  belongs_to_active_record :pinniped
+  key :pinniped_id, Integer
+  
+  key :name, String
+  key :hairiness, Integer
+end
+
+class SeaLion
+  include MongoMapper::Document
+  belongs_to_active_record :pinniped
+end
+  
+class Walrus
+  include MongoMapper::Document
+  belongs_to_active_record :pinniped
+  key :pinniped_id, Integer
+  
+  key :tusk_length, Integer
+end
+
+
+class Liquid < ActiveRecord::Base
+  has_many_mongo_mapper     :beverages
+end
+
+class Beverage
+  include MongoMapper::Document
+  belongs_to_active_record  :liquid
+  has_one_active_record     :chemical_composition
+  has_many_active_record    :flavors
+end
+
+class ChemicalComposition < ActiveRecord::Base
+  belongs_to_mongo_mapper   :beverage
+end
+
+class Flavor < ActiveRecord::Base
+  belongs_to_mongo_mapper   :beverage
+end
+
+
+# -----------------------------------------------------------------------------
 # Testing of Mongoid bindings with light testing of reverses
+# -----------------------------------------------------------------------------
 class Camel
   include Mongoid::Document
   has_one_active_record     :tongue

data/test/test_helper.rb

@@ -24,8 +24,9 @@ require 'minitest/spec'
 require 'minitest/pride'
 require 'minitest/benchmark' if ENV['BENCH']
 
-# require 'active_record'
-# require 'mongoid'
+require 'active_record'
+require 'mongoid'
+require 'mongo_mapper'
 
 require 'consort'
 

data/test/test_mongo_mapper.rb

@@ -0,0 +1,87 @@
+require 'minitest/autorun'
+
+class TestMongoMapper < MiniTest::Unit::TestCase
+  def setup
+#    MongoMapper.database = 'test_consort'
+  end
+
+  # ---------------------------------------------------------------------------
+  # MongoMapper object has ActiveRecord associations
+  # ---------------------------------------------------------------------------
+  def test_mongo_mapper_belongs_to_active_record_defined
+    assert Beverage.respond_to?(:has_one_active_record)
+  end
+  
+  def test_mongo_mapper_has_one_active_record_defined
+    assert Beverage.respond_to?(:has_one_active_record)
+  end
+  
+  def test_mongo_mapper_has_many_active_record_defined
+    assert Beverage.respond_to?(:has_many_active_record)
+  end
+  
+  def test_mongo_mapper_has_one_active_record
+    b = Beverage.new
+    assert b.respond_to? :chemical_composition
+    refute b.respond_to? :chemical_compositions
+  end
+  
+  def test_mongo_mapper_has_many_active_record
+    b = Beverage.new
+    assert b.respond_to? :flavors
+    refute b.respond_to? :flavor
+  end
+  
+  def test_mongo_mapper_belongs_to_active_record
+    b = Beverage.new
+    assert b.respond_to? :liquid
+    refute b.respond_to? :liquids
+  end
+  
+  def test_mongo_mapper_implements_consorts
+    assert Beverage.respond_to?('mongo_mapper_consorts_with_active_record?')
+    assert Beverage.mongo_mapper_consorts_with_active_record?
+  end
+
+  # ---------------------------------------------------------------------------
+  # ActiveRecord object has MongoMapper associations
+  # ---------------------------------------------------------------------------
+  
+  def test_active_record_has_one_mongo_mapper_defined
+    assert_equal 'method', defined? ActiveRecord::Base.has_one_mongo_mapper
+    assert_equal true, ActiveRecord::Base.respond_to?('has_one_mongo_mapper')
+  end
+
+  def test_active_record_has_many_mongo_mapper_defined
+    assert_equal 'method', defined? ActiveRecord::Base.has_many_mongo_mapper
+    assert_equal true, ActiveRecord::Base.respond_to?('has_many_mongo_mapper')
+  end
+
+  def test_active_record_belongs_to_mongo_mapper_defined
+    assert_equal 'method', defined? ActiveRecord::Base.belongs_to_mongo_mapper
+    assert_equal true, ActiveRecord::Base.respond_to?('belongs_to_mongo_mapper')
+  end
+
+  def test_active_record_has_one_mongo_mapper
+    p = Pinniped.new
+    assert p.respond_to? :walrus
+    refute p.respond_to? :walruses
+  end
+
+  def test_active_record_has_many_mongo_mapper
+    p = Pinniped.new
+    assert p.respond_to? :seals
+    refute p.respond_to? :seal
+  end
+
+  def test_active_record_belongs_to_mongo_mapper
+    p = Pinniped.new
+    assert p.respond_to? :flippy_sea_creature
+    refute p.respond_to? :flippy_sea_creatures
+  end
+  
+  def test_active_record_implements_consorts
+    assert ActiveRecord::Base.respond_to?('active_record_consorts_with_mongo_mapper?')
+    assert ActiveRecord::Base.active_record_consorts_with_mongo_mapper?
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consort
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0.pre
 platform: ruby
 authors:
 - Colin Mattson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-24 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -165,47 +179,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: activerecord
+  name: bson_ext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mongoid
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
 description: Consort allows you to define relationships between various ORM/ODMs and
   access them similarly to ActiveRecord associations.
 email:
@@ -226,7 +232,9 @@ files:
 - gemfiles/Gemfile.rails-3.1.x
 - gemfiles/Gemfile.rails-4.0.x
 - lib/consort.rb
+- lib/consort/active_record/mongo_mapper.rb
 - lib/consort/active_record/mongoid.rb
+- lib/consort/mongo_mapper/active_record.rb
 - lib/consort/mongoid/active_record.rb
 - lib/consort/version.rb
 - test/db/database.yml
@@ -234,6 +242,7 @@ files:
 - test/models.rb
 - test/test_active_record.rb
 - test/test_helper.rb
+- test/test_mongo_mapper.rb
 - test/test_mongoid.rb
 homepage: https://github.com/cmattson/consort
 licenses:
@@ -250,12 +259,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Ease integration between ActiveRecord and NoSQL solutions.
@@ -265,5 +274,6 @@ test_files:
 - test/models.rb
 - test/test_active_record.rb
 - test/test_helper.rb
+- test/test_mongo_mapper.rb
 - test/test_mongoid.rb
 has_rdoc: