consort 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZGMxYWFhZGUyYTA3OGYyMGYxMTUzZjJhOGQ2MTY4ZDY2ZmJkNmQyYg==
+    Nzk4NGRkZDVhOTRjNjA5Nzk3NGJhODhiYTI1NGIzOGNiZWY1MzUwOA==
   data.tar.gz: !binary |-
-    NDQ1YTE1YWY5NTE5YTI2YmZmNGFjZDVmNWEzZGQ5ZjlhZGFkMmRmMg==
+    NWY0NDFkNjIwY2VhNTI4MzIwMzM4YzU2MWNmNGE2MDI0ZDM0MjE5MQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NWY3MjMzNWFjZmQ2ZDQ2ZjQ0ZjdiODY4MzIxNmEyN2QxODU4YmM0NzFmNGZl
-    ZmVlNWVhNjgyNmYxZDliYzEzNmZjYTI0OGM3YWE1YWVlNTYwZWU0NTliMWIz
-    MTA5YWZhMWU4NTE4YTAyOWE5NGQ3YzNmOWU2MjU2YWQ4NWJkNmI=
+    ZjE4OGViYzAwZTRiYjE4MzQxOWZhMDVjYTcyMjhhNjcwYWUxZDk0ZGU4OTVl
+    YzRlZDBmNDQzZTU2NjUyNzg1MWZiZjU0MzQ1ZmQzNDFjM2RlNWJjYjY0NzEz
+    ZmIzMDc0ZmI5ZDI4ZjI5ZWRiZjY4ODA0OWMyZDg2OTExZTBlMzE=
   data.tar.gz: !binary |-
-    NmY5N2JlODYyNzc2ZWYzZDZjZWFmNDRiNWQ3MmNkMDllOTEyMTBmMTljZTAw
-    MDNhMDFiNzU2ZTkwNTI1ZDk2ZThmOTE5ZGY4NTc3MGFlYmEzNTczNDU2ZjEz
-    YmRjYThlOWRhYTg5NWZlNzI2ODAwZjdiMjg2NWViODk1NzRiNmY=
+    MTdjNGRkYTYyZjdjNjIwZGY5OWVkZjczY2I4ZGVkMDdiNGQ5NjhkODQ5ZTE0
+    M2ZjMWEyMDg3N2NjZjI5YjM5Y2RiOTYzMjRhMzllNjhkNmUxODMxNjk0OTQ1
+    M2QwNWUwZDk1NWZkNmJjYzk1ZGMwMGI3OTI2MTkzZmY2NDk5ZjI=

data/.travis.yml

@@ -3,5 +3,5 @@ rvm:
   - 1.9.3
   - 2.0.0
 #  - jruby-19mode
-  - rbx-19mode
+#  - rbx-19mode
 #  - ruby-head

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-# Changelog
+## 0.0.2
+
+* Improved readability of macros. `has_many_*` methods are now singular.
+* `has_many_mongoids` and `has_many_active_records` flagged for deprecation.
 
 ## 0.0.1
 

data/LICENSE

@@ -1,7 +1,7 @@
-The MIT License (MIT)
-
 Copyright (c) 2013 Colin Mattson
 
+The MIT License (MIT)
+
 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

data/README.md

@@ -3,11 +3,18 @@
 [![Build Status](https://travis-ci.org/cmattson/consort.png?branch=master)](https://travis-ci.org/cmattson/consort)
 [![Coverage Status](https://coveralls.io/repos/cmattson/consort/badge.png)](https://coveralls.io/r/cmattson/consort)
 [![Code Climate](https://codeclimate.com/github/cmattson/consort.png)](https://codeclimate.com/github/cmattson/consort)
+[![Gem Version](https://badge.fury.io/rb/consort.png)](http://badge.fury.io/rb/consort)
 
 Mixing ActiveRecord and other ORMs like Mongoid? Need relationships between those data layers? Really hate either implementing a bunch of accessors or copy-pasting the same metaprogramming over and over again?
 
 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
+
+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.)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,7 +37,7 @@ Ruby 1.8 is not supported.
 
 ### Rails Compatibility
 
-As Mongoid, most other NoSQL adapters, and many other gems are tied to Rails 3.2, master and version 1.0 are targeting Rails 3.2. 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. 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.
 
 Rails 4 support is planned.
 
@@ -38,12 +45,17 @@ Rails 4 support is planned.
 
 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.
 
+The relationship macros are designed to read cleanly:
+
+* Airframe has one ActiveRecord powerplant
+* Airframe has many Mongoid variants
+
 On an ActiveRecord model, you can define relationships with Mongoid:
 ```ruby
 class Airframe < ActiveRecord::Base
   belongs_to_mongoid  :manufacturer
-  has_one_mongoid   :powerplant
-  has_many_mongoids :variants
+  has_one_mongoid     :powerplant
+  has_many_mongoid    :variants
 end
 ```
 
@@ -53,15 +65,15 @@ class Airframe
   include Mongoid::Document
   belongs_to_active_record  :manufacturer
   has_one_active_record     :powerplant
-  has_many_active_records   :variants
+  has_many_active_record    :variants
 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 frequently find yourself needing, you'll have to implement it yourself. (Pull requests and feedback are welcome.)
+*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.)
 
 ## Contributing
 
-1. Fork it
+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.
 4. Commit your changes (`git commit -am 'Add some feature'`)
@@ -72,7 +84,6 @@ Make sure you include tests! Tests are good. Tests are required. All hail tests.
 
 Consort tests are built with Minitest; beyond that, I'm flexible. `Minitest::Unit` and `Minitest::Spec` are both fine.
 
-For more details, see CONTRIBUTING.md.
 
 ## Author
 

data/consort.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency 'combustion'
+  spec.add_development_dependency "combustion"
 
   spec.add_runtime_dependency "activesupport",  "~> 3.2"
   spec.add_runtime_dependency "activerecord",   "~> 3.2"

data/lib/consort/active_record.rb

@@ -14,7 +14,7 @@ module Consort
         CODE
       end
 
-      def has_many_mongoids(klass)
+      def has_many_mongoid(klass)
         class_eval <<-CODE
           def #{klass}
             #{klass.to_s.classify}.where(#{name.foreign_key}: id)
@@ -22,6 +22,12 @@ module Consort
         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}

data/lib/consort/mongoid.rb

@@ -11,14 +11,20 @@ module Consort
         CODE
       end
 
-      def has_many_active_records(klass)
+      def has_many_active_record(klass)
         class_eval <<-CODE
           def #{klass}
-            #{klass.to_s.classify}.where(#{name.foreign_key}: id)  
+            #{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}

data/lib/consort/version.rb

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

data/test/db/schema.rb

@@ -1,22 +1,22 @@
 ActiveRecord::Schema.define(:version => 0) do
 
-  create_table :ungulates, :force => true do |t|
+  create_table :ungulates, force: true do |t|
     t.column :name, :string
     t.column :congo_id, :string
   end
 
-  create_table :tongues, :force => true do |t|
+  create_table :tongues, force: true do |t|
     t.column :camel_id, :string
     t.column :slimy, :boolean
   end
 
-  create_table :humps, :force => true do |t|
+  create_table :humps, force: true do |t|
     t.column :camel_id, :string
     t.column :number, :integer
     t.column :size_mm, :integer
   end
 
-  create_table :species, :force => true do |t|
+  create_table :species, force: true do |t|
     t.column :common_name, :string
     t.column :scientific_name, :string
   end

data/test/models.rb

@@ -1,24 +1,24 @@
 # Testing of AR bindings with light testing of reverses
 class Ungulate < ActiveRecord::Base
-  has_one_mongoid :mango
-  has_many_mongoids :bongos
-  belongs_to_mongoid :congo
+  has_one_mongoid     :mango
+  has_many_mongoid    :bongos
+  belongs_to_mongoid  :congo
 end
 
 class Mango
   include Mongoid::Document
   belongs_to_active_record :ungulate
 
-  field :ripeness, type: Integer
-  field :ar_instance_id, type: Integer
+  field :ripeness,        type: Integer
+  field :ar_instance_id,  type: Integer
 end
 
 class Bongo
   include Mongoid::Document
   belongs_to_active_record :ungulate
 
-  field :diameter, type: Integer
-  field :number, type: Integer
+  field :diameter,  type: Integer
+  field :number,    type: Integer
 end
 
 class Congo
@@ -32,7 +32,7 @@ end
 class Camel
   include Mongoid::Document
   has_one_active_record     :tongue
-  has_many_active_records   :humps
+  has_many_active_record    :humps
   belongs_to_active_record  :species
 
   field :name, type: String
@@ -47,5 +47,5 @@ class Hump < ActiveRecord::Base
 end
 
 class Species < ActiveRecord::Base
-  has_many_mongoids :camels
+  has_many_mongoid :camels
 end

data/test/test_active_record.rb

@@ -2,21 +2,27 @@ require 'minitest/autorun'
 
 class TestActiveRecord < Minitest::Test
   def setup
-    #@ungulate = Ungulate.new
   end
 
   def test_active_record_has_one_mongoid_defined
-    assert_equal "method", defined? ActiveRecord::Base.has_one_mongoid
+    assert_equal 'method', defined? ActiveRecord::Base.has_one_mongoid
     assert_equal true, ActiveRecord::Base.respond_to?('has_one_mongoid')
   end
 
+  # New form going forward.
+  def test_active_record_has_many_mongoid_defined
+    assert_equal 'method', defined? ActiveRecord::Base.has_many_mongoid
+    assert_equal true, ActiveRecord::Base.respond_to?('has_many_mongoid')
+  end
+
+  # Deprecated form still available.
   def test_active_record_has_many_mongoids_defined
-    assert_equal "method", defined? ActiveRecord::Base.has_many_mongoids
+    assert_equal 'method', defined? ActiveRecord::Base.has_many_mongoids
     assert_equal true, ActiveRecord::Base.respond_to?('has_many_mongoids')
   end
 
   def test_active_record_belongs_to_mongoid_defined
-    assert_equal "method", defined? ActiveRecord::Base.belongs_to_mongoid
+    assert_equal 'method', defined? ActiveRecord::Base.belongs_to_mongoid
     assert_equal true, ActiveRecord::Base.respond_to?('belongs_to_mongoid')
   end
 
@@ -26,7 +32,7 @@ class TestActiveRecord < Minitest::Test
     assert_equal false, @u.respond_to?('mangos')
   end
 
-  def test_has_many_mongoids
+  def test_has_many_mongoid
     @u = Ungulate.new
     assert_equal true, @u.respond_to?('bongos')
     assert_equal false, @u.respond_to?('bongo')

data/test/test_helper.rb

@@ -1,6 +1,10 @@
 plugin_test_dir = File.dirname(__FILE__)
 
 require 'rubygems'
+
+require 'coveralls'
+Coveralls.wear!
+
 require 'bundler/setup'
 require 'pry'
 
@@ -12,9 +16,6 @@ require 'minitest/spec'
 require 'minitest/pride'
 require 'minitest/benchmark' if ENV['BENCH']
 
-require 'coveralls'
-Coveralls.wear!
-
 require 'active_record'
 require 'mongoid'
 
@@ -22,14 +23,12 @@ require 'consort'
 
 require 'yaml'
 require 'erb'
-ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(plugin_test_dir + "/db/database.yml")).result)
-ActiveRecord::Base.establish_connection(ENV["DB"] ||= "sqlite3mem")
+ActiveRecord::Base.configurations = YAML.load(ERB.new(IO.read(plugin_test_dir + '/db/database.yml')).result)
+ActiveRecord::Base.establish_connection(ENV['DB'] ||= 'sqlite3mem')
 ActiveRecord::Migration.verbose = false
 
 require 'combustion/database'
 Combustion::Database.create_database(ActiveRecord::Base.configurations[ENV["DB"]])
-load(File.join(plugin_test_dir, "db", "schema.rb"))
- 
-
-require 'models'
+load(File.join(plugin_test_dir, 'db', 'schema.rb'))
 
+require 'models'

data/test/test_mongoid.rb

@@ -8,6 +8,10 @@ class TestMongoid < Minitest::Test
     assert_equal true, Camel.respond_to?(:has_one_active_record)
   end
 
+  def test_mongoid_has_many_active_record_defined
+    assert_equal true, Camel.respond_to?(:has_many_active_record)
+  end
+
   def test_mongoid_has_many_active_records_defined
     assert_equal true, Camel.respond_to?(:has_many_active_records)
   end
@@ -22,7 +26,7 @@ class TestMongoid < Minitest::Test
     assert_equal false, @c.respond_to?('tongues')
   end
 
-  def test_has_many_active_records
+  def test_has_many_active_record
     @c = Camel.new
     assert_equal true,  @c.respond_to?('humps')
     assert_equal false, @c.respond_to?('hump')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consort
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Colin Mattson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+date: 2013-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -205,7 +205,6 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - consort.gemspec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Colin Mattson
-
-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.