consort 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Nzk4NGRkZDVhOTRjNjA5Nzk3NGJhODhiYTI1NGIzOGNiZWY1MzUwOA==
+    NDJkNmNjYjhjODY0ZmM3M2M1YTg5ODFhZDU1NDJlODhiODY1Y2U2NQ==
   data.tar.gz: !binary |-
-    NWY0NDFkNjIwY2VhNTI4MzIwMzM4YzU2MWNmNGE2MDI0ZDM0MjE5MQ==
+    OGY3MGYwYThlMGRmZjczMjY0ZTQ2MjFiZmZkYzY2NjNlOWM4YWM5Yw==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZjE4OGViYzAwZTRiYjE4MzQxOWZhMDVjYTcyMjhhNjcwYWUxZDk0ZGU4OTVl
-    YzRlZDBmNDQzZTU2NjUyNzg1MWZiZjU0MzQ1ZmQzNDFjM2RlNWJjYjY0NzEz
-    ZmIzMDc0ZmI5ZDI4ZjI5ZWRiZjY4ODA0OWMyZDg2OTExZTBlMzE=
+    YzRkNTA2ZmE5Yzc4ZmVkNTU5ZDE3ZmIzNTk4MmUwNmQwMDZkNDU0MmI4MjMx
+    NmZkMWYwMmQyM2Y3OWE5MjE4Y2JjMTY2ZGUzZTNiYjRiN2U5Y2I1YmZmNDdk
+    MjVjNmI2NDA4MzUyOTgzZmU5NTU0OGJhMjc1YWY2MWRlOWQyNTk=
   data.tar.gz: !binary |-
-    MTdjNGRkYTYyZjdjNjIwZGY5OWVkZjczY2I4ZGVkMDdiNGQ5NjhkODQ5ZTE0
-    M2ZjMWEyMDg3N2NjZjI5YjM5Y2RiOTYzMjRhMzllNjhkNmUxODMxNjk0OTQ1
-    M2QwNWUwZDk1NWZkNmJjYzk1ZGMwMGI3OTI2MTkzZmY2NDk5ZjI=
+    MDkyYmU4MTk0ODc3OWYzZjk5NGM2ZGI4N2UxNTIwZGVlZmE1MWM4NTc2ZjA5
+    ZTZlOGI3Mzg5MzI0OWYwMDVkZWU3Yzg3MTY0ODE4ZDI2ZTIxMWRlZTczODhj
+    ODMyY2ZmNTc5ODMyZDkzOTk1NTU3OTMzMmU2YWIxYTA0YjAzYjA=

data/.travis.yml

@@ -4,4 +4,8 @@ rvm:
   - 2.0.0
 #  - jruby-19mode
 #  - rbx-19mode
-#  - ruby-head
+#  - ruby-head
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile.rails-3.1.x
+  - gemfiles/Gemfile.rails-4.0.x

data/.yardopts

@@ -0,0 +1,2 @@
+--markup markdown
+

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.0.3
+
+* Restructured modules. Now in format `Consort::FromORM::ToORM`.
+* Travis now tests against Rails 3.1.12, 3.2.13, 4.0.0.
+
 ## 0.0.2
 
 * Improved readability of macros. `has_many_*` methods are now singular.

data/README.md

@@ -9,11 +9,11 @@ Mixing ActiveRecord and other ORMs like Mongoid? Need relationships between thos
 
 Use Consort! Built around a simple modification to standard ActiveRecord association syntax, Consort allows you to more easily retrieve data from cross-ORM single-to-single and single-to-many associations without writing or recycling code.
 
-##### Once More, With 50% Less Jargon
+## Once More, With 50% Less Jargon
 
 If you have a Rails app using both ActiveRecord and Mongoid, you've probably discovered you can't create associations between the two.
 
-Consort allows you to define has_one, has_many, and belongs_to associations between ActiveRecord and Mongoid object classes. (And it can be extended to support nearly any combination of ORM adapters, but ActiveRecord <-> Mongoid is what's written today.)
+Consort allows you to define `has_one`, `has_many`, and `belongs_to` associations between ActiveRecord and Mongoid object classes. (And it can be extended to support nearly any combination of ORM and ODM adapters, but ActiveRecord <-> Mongoid is what's written today.)
 
 ## Installation
 
@@ -33,14 +33,18 @@ Or install it yourself as:
 
 Ruby 1.9.3 or 2.0.0. Alternate VMs compatible with these versions should also work.
 
-Ruby 1.8 is not supported.
+Ruby 1.8 is not supported. Let the dead rest in peace!
 
 ### Rails Compatibility
 
-Consort currently targets Rails 3.2. Mongoid and several other ORM layers have not yet been updated for Rails 4, and most projects are continuing to use Rails 3.2 for now. Consort has not been tested against earlier Rails 3 versions; if you're stuck on an earlier version, let me know how it works for you.
+Consort currently targets Rails 3.2 (or, more accurately, ActiveSupport and ActiveRecord 3.2). Mongoid and several other ORM/ODM layers have not yet been updated for Rails 4, and most new and existing projects are continuing to use Rails 3.2 for now.
 
 Rails 4 support is planned.
 
+### Continuous Integration
+
+Automated CI testing is performed against Ruby 1.9.3 and 2.0.0 using ActiveRecord and ActiveSupport 3.1, 3.2, and 4.0. 
+
 ## Usage
 
 Consort allows basic relationships to be defined between ActiveRecord and other ORM layers. Simply add `_[ORM_TYPE]` to what you'd normally use. `active_record` and `mongoid` are currently supported.
@@ -51,6 +55,7 @@ The relationship macros are designed to read cleanly:
 * Airframe has many Mongoid variants
 
 On an ActiveRecord model, you can define relationships with Mongoid:
+
 ```ruby
 class Airframe < ActiveRecord::Base
   belongs_to_mongoid  :manufacturer
@@ -60,22 +65,50 @@ end
 ```
 
 On a Mongoid model, you can define relationships with ActiveRecord:
+
 ```ruby
 class Airframe
   include Mongoid::Document
   belongs_to_active_record  :manufacturer
   has_one_active_record     :powerplant
   has_many_active_record    :variants
+  
+  # Consort expects a foreign key field
+  field :manufacturer_id,   type: Integer
 end
 ```
 
-*Nota bene:* Consort currently provides only basic association accessors.  It does not implement callbacks. Consort also does not currently implement many-to-many associations. I've rarely run into a situation where cross-ORM many-to-many associations make sense, and implementing them would require making opinionated decisions I don't care to make without community input. If this is something you find yourself needing immediately, you'll have to implement it yourself. (Pull requests and feedback are welcome.)
+### Unimplemented Features
+There are several things Consort doesn't (currently) do, either because I haven't
+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
+missing feature, feel free to implement it and send a pull request, or create an
+issue with a feature request.
+
+#### Many-to-Many Relationships
+Consort doesn't support many-to-many relationships. I've rarely run into a
+situation where they make sense in cross-ORM applications, and implementing them
+would require making decisions like "where do we store them?". 
+
+#### Polymorphism
+Also low on the list of use cases. 
+
+#### Callbacks
+This falls into the potential horrible unintended consequences group.
+
+Consort *does not* currently implement automatic callbacks (e.g. destroying a
+Mongoid object automatically when its parent ActiveRecord object is destroyed). If
+creating/altering/deleting an object from one object mapper should
+create/alter/delete an associated object from a different object mapper, you
+currently need to take care of this yourself.
 
 ## Contributing
 
 1. [Fork it](https://github.com/cmattson/consort/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. No, seriously, create a branch. Call it `ravenous-monkey` for all I care, but create a branch.
+3. No, seriously, create a branch. Please. Call it `ravenous-monkey` for all I care, but create a branch.
 4. Commit your changes (`git commit -am 'Add some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request

data/consort.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Consort::VERSION
   spec.authors       = ["Colin Mattson"]
   spec.email         = ["colinm@pixelcloud.us"]
-  spec.description   = %q{Consort allows you to define relationships between various ORMs and access them similarly to ActiveRecord associations.}
+  spec.description   = %q{Consort allows you to define relationships between various ORM/ODMs and access them similarly to ActiveRecord associations.}
   spec.summary       = %q{Ease integration between ActiveRecord and NoSQL solutions.}
   spec.homepage      = "https://github.com/cmattson/consort"
   spec.license       = "MIT"
@@ -18,18 +18,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",      "~> 1.3"
+  spec.add_development_dependency "bundler",        "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "activerecord", "~> 3.2"
-  spec.add_development_dependency "activesupport","~> 3.2"
-  spec.add_development_dependency "mongoid",      "~> 3.1"
+  spec.add_development_dependency "minitest",       "~> 4.7"
+  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 "simplecov"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "combustion"
 
-  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.2"
+  spec.add_runtime_dependency     "activerecord",   "~> 3.2"
+  spec.add_runtime_dependency     "mongoid",        "~> 3.1"
 end

data/gemfiles/Gemfile.rails-3.1.x

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem "bundler",        "~> 1.3"
+gem "rake"
+gem "minitest",       "~> 4.7"
+gem "activesupport",  "~> 3.1.12"
+gem "activerecord",   "~> 3.1.12"
+gem "mongoid",        "~> 3.0.0"
+gem "coveralls"
+gem "sqlite3"
+gem "pry"
+gem "combustion"

data/gemfiles/Gemfile.rails-4.0.x

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem "bundler",        "~> 1.3"
+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 "coveralls"
+gem "sqlite3"
+gem "pry"
+gem "combustion"

data/lib/consort.rb

@@ -1,6 +1,7 @@
 require 'consort/version'
 
 require 'active_record'
+require 'mongoid'
 
-require 'consort/active_record'
-require 'consort/mongoid'
+require 'consort/active_record/mongoid'
+require 'consort/mongoid/active_record'

data/lib/consort/active_record/mongoid.rb

@@ -0,0 +1,74 @@
+module Consort
+  ##
+  # Defines methods on ActiveRecord objects for creating NoSQL
+  # relationships and accessing those related objects.
+  module ActiveRecord
+    module Mongoid
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Defines a `has_one` relationship with a Mongoid object.
+        # @param klass [Symbol]
+        # @example
+        #   has_one_mongoid :dolphin
+        def has_one_mongoid(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 Mongoid object.
+        # @param klass [Symbol] 
+        # @example
+        #   has_many_mongoid :unicorns
+        # @since 0.0.2
+        def has_many_mongoid(klass)
+          class_eval <<-CODE
+            def #{klass}
+              #{klass.to_s.classify}.where(#{name.foreign_key}: id)
+            end
+          CODE
+        end
+
+        # @deprecated Use {#has_many_mongoid} instead. Will be removed in 1.0.0.
+        def has_many_mongoids(klass)
+          ActiveSupport::Deprecation.warn 'Please use the singular has_many_mongoid instead.'
+          has_many_mongoid(klass)
+        end
+
+        # Defines a `belongs_to` relationship with a Mongoid object.
+        # An appropriate foreign key column (of type String) must exist on your model.
+        # @param klass [Symbol] 
+        # @example Migration
+        #   class AddMongoidFKeyToNarwhals < ActiveRecord::Migration
+        #     def change
+        #       add_column :narwhals, :pod_id, :string
+        #     end
+        #   end
+        # @example Model
+        #   class Narwhal < ActiveRecord::Base
+        #     belongs_to_mongoid :pod
+        #   end
+        def belongs_to_mongoid(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 Mongoid bridge is loaded.
+        # @return [Boolean] `true` if bridge is loaded
+        def active_record_consorts_with_mongoid?
+          true
+        end
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include Consort::ActiveRecord::Mongoid
+end

data/lib/consort/mongoid/active_record.rb

@@ -0,0 +1,68 @@
+module Consort
+  module Mongoid
+    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
+
+        # @deprecated Use {#has_many_active_record} instead. Will be removed in 1.0.0.
+        def has_many_active_records(klass)
+          ActiveSupport::Deprecation.warn 'Please use the singular has_many_active_record instead.'
+          has_many_active_record(klass)
+        end
+
+        # Defines a `belongs_to` relationship with an ActiveRecord object.
+        # An appropriate foreign key field must exist on your model.
+        # @param klass [Symbol] 
+        # @example
+        #   class Narwhal
+        #     include Mongoid::Document
+        #
+        #     belongs_to_active_record :pod
+        #     field :pod_id, type: 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 Mongoid to ActiveRecord bridge is loaded.
+        # @return [Boolean] `true` if bridge is loaded
+        def mongoid_consorts_with_active_record?
+          true
+        end
+      end
+    end
+  end
+end
+
+module Mongoid::Document
+  include Consort::Mongoid::ActiveRecord
+end

data/lib/consort/version.rb

@@ -1,3 +1,3 @@
 module Consort
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/test_active_record.rb

@@ -1,6 +1,6 @@
 require 'minitest/autorun'
 
-class TestActiveRecord < Minitest::Test
+class TestActiveRecord < MiniTest::Unit::TestCase
   def setup
   end
 
@@ -43,4 +43,9 @@ class TestActiveRecord < Minitest::Test
     assert_equal true, @u.respond_to?('congo')
     assert_equal false, @u.respond_to?('congos')
   end
+  
+  def test_implements_consorts
+    assert ActiveRecord::Base.respond_to?('active_record_consorts_with_mongoid?')
+    assert ActiveRecord::Base.active_record_consorts_with_mongoid?
+  end
 end

data/test/test_helper.rb

@@ -2,8 +2,16 @@ plugin_test_dir = File.dirname(__FILE__)
 
 require 'rubygems'
 
+require 'simplecov'
 require 'coveralls'
-Coveralls.wear!
+
+if ENV["TRAVIS"]
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+end
+
+SimpleCov.start do
+  add_filter '/test'
+end
 
 require 'bundler/setup'
 require 'pry'
@@ -16,8 +24,8 @@ require 'minitest/spec'
 require 'minitest/pride'
 require 'minitest/benchmark' if ENV['BENCH']
 
-require 'active_record'
-require 'mongoid'
+# require 'active_record'
+# require 'mongoid'
 
 require 'consort'
 
@@ -31,4 +39,4 @@ require 'combustion/database'
 Combustion::Database.create_database(ActiveRecord::Base.configurations[ENV["DB"]])
 load(File.join(plugin_test_dir, 'db', 'schema.rb'))
 
-require 'models'
+require 'models'

data/test/test_mongoid.rb

@@ -1,6 +1,6 @@
 require 'minitest/autorun'
 
-class TestMongoid < Minitest::Test
+class TestMongoid < MiniTest::Unit::TestCase
   def setup
   end
 
@@ -36,5 +36,10 @@ class TestMongoid < Minitest::Test
     @c = Camel.new
     assert_equal true,  @c.respond_to?('species')
   end
+  
+  def test_implements_consorts
+    assert Camel.respond_to?('mongoid_consorts_with_active_record?')
+    assert Camel.mongoid_consorts_with_active_record?
+  end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consort
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Colin Mattson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,18 +42,18 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -94,6 +94,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -192,8 +206,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.1'
-description: Consort allows you to define relationships between various ORMs and access
-  them similarly to ActiveRecord associations.
+description: Consort allows you to define relationships between various ORM/ODMs and
+  access them similarly to ActiveRecord associations.
 email:
 - colinm@pixelcloud.us
 executables: []
@@ -202,15 +216,18 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - consort.gemspec
+- gemfiles/Gemfile.rails-3.1.x
+- gemfiles/Gemfile.rails-4.0.x
 - lib/consort.rb
-- lib/consort/active_record.rb
-- lib/consort/mongoid.rb
+- lib/consort/active_record/mongoid.rb
+- lib/consort/mongoid/active_record.rb
 - lib/consort/version.rb
 - test/db/database.yml
 - test/db/schema.rb
@@ -249,3 +266,4 @@ test_files:
 - test/test_active_record.rb
 - test/test_helper.rb
 - test/test_mongoid.rb
+has_rdoc: 

data/lib/consort/active_record.rb

@@ -1,49 +0,0 @@
-module Consort
-  ##
-  # Defines instance methods on ActiveRecord objects for defining NoSQL
-  # relationships and accessing those related objects.
-  module ActiveRecord
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      def has_one_mongoid(klass)
-        class_eval <<-CODE
-          def #{klass}
-            #{klass.to_s.classify}.where(#{name.foreign_key}: id)
-          end
-        CODE
-      end
-
-      def has_many_mongoid(klass)
-        class_eval <<-CODE
-          def #{klass}
-            #{klass.to_s.classify}.where(#{name.foreign_key}: id)
-          end
-        CODE
-      end
-
-      # DEPRECATED. Pass through for now. Removed in 1.0.0.
-      def has_many_mongoids(klass)
-        ActiveSupport::Deprecation.warn 'Please use the singular has_many_mongoid instead.'
-        has_many_mongoid(klass)
-      end
-
-      def belongs_to_mongoid(klass)
-        class_eval <<-CODE
-          def #{klass}
-            #{klass.to_s.classify}.where(id: #{klass.to_s.foreign_key})
-          end
-        CODE
-      end
-
-      def active_record_consorts_with_mongoid?
-        true
-      end
-    end
-
-  end
-end
-
-class ActiveRecord::Base
-  include Consort::ActiveRecord
-end

data/lib/consort/mongoid.rb

@@ -1,46 +0,0 @@
-module Consort
-  module Mongoid
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      def has_one_active_record(klass)
-        class_eval <<-CODE
-          def #{klass}
-            #{klass.to_s.classify}.where(#{name.foreign_key}: id)
-          end
-        CODE
-      end
-
-      def has_many_active_record(klass)
-        class_eval <<-CODE
-          def #{klass}
-            #{klass.to_s.classify}.where(#{name.foreign_key}: id)
-          end
-        CODE
-      end
-
-      # DEPRECATED. Will be removed in 1.0.0.
-      def has_many_active_records(klass)
-        ActiveSupport::Deprecation.warn 'Please use the singular has_many_active_record instead.'
-        has_many_active_record(klass)
-      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
-
-      def mongoid_consorts_with_active_record?
-        true
-      end
-    end
-
-  end
-end
-
-module Mongoid::Document
-  include Consort::Mongoid
-end