mongoid-sorted-relations 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mongoid-sorted-relations.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 De Marque inc.
+
+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,69 @@
+Mongoid Sorted Relations [![Build Status](https://secure.travis-ci.org/demarque/mongoid-sorted-relations.png?branch=master)](http://travis-ci.org/demarque/mongoid-sorted-relations)
+===============
+
+Problem
+-------
+
+In Mongoid, the HABTM relations return docs in the wrong order.
+This gem will give your document the ability to retrieve it's relations in the same order it was placed in.
+
+For more details about this issue, see [#1548](https://github.com/mongoid/mongoid/issues/1548)
+
+Install
+-------
+
+```
+gem install mongoid-sorted-relations
+```
+
+Rails 3
+-------
+
+In your Gemfile:
+
+```ruby
+gem 'mongoid-sorted-relations'
+```
+
+Usage
+-----
+
+#### Model integration
+
+```ruby
+class Book
+  include Mongoid::Document
+  include Mongoid::SortedRelations
+
+  has_many :chapters
+  has_and_belongs_to_many :authors
+
+  init_sorted_relations
+end
+```
+
+It's important to place the ```init_sorted_relations``` after the declaration of your relations.
+
+
+### Getting the relations in the right order
+
+Mongoid::SortedRelations will add a ```sorted_``` methods to all the has_many and habtm relationships.
+
+```ruby
+book = Book.new title: 'The Art of War'
+book.authors << Author.create name: "Sun Tzu"
+book.authors << Author.create name: "Sun Wu"
+book.authors << Author.create name: "Lao Zi"
+
+book.sorted_authors.map(&:name)
+#=> ['Sun Tzu', 'Sun Wu', 'Lao Zi']
+
+book.sorted_authors.limit(2).map(&:name)
+#=> ['Sun Tzu', 'Sun Wu']
+```
+
+
+Copyright
+---------
+
+Copyright (c) 2012 De Marque inc. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/mongoid-sorted-relations.rb

@@ -0,0 +1,2 @@
+require 'mongoid/fake_criteria'
+require 'mongoid/sorted_relations'

data/lib/mongoid/fake_criteria.rb

@@ -0,0 +1,19 @@
+module Mongoid
+  class FakeCriteria
+    def initialize(documents)
+      @documents = documents
+    end
+
+    def limit(quantity)
+      Mongoid::FakeCriteria.new(@documents[0..quantity-1])
+    end
+
+    def raw
+      @documents
+    end
+
+    def method_missing(*args, &block)
+      @documents.send(*args, &block)
+    end
+  end
+end

data/lib/mongoid/sorted_relations.rb

@@ -0,0 +1,27 @@
+module Mongoid
+  module SortedRelations
+    extend ActiveSupport::Concern
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def init_sorted_relations
+        self.relations.each do |k,v|
+          if [:references_many, :references_and_referenced_in_many].include? v.macro
+            send(:define_method, "sorted_#{v.name}") { sorted_relation v }
+          end
+        end
+      end
+    end
+
+    def sorted_relation(relation)
+      ids = self.send(relation.key).map{ |rid| rid.to_s }
+
+      documents = self.send(relation.name).sort_by { |x| ids.index(x.id.to_s) }
+
+      return Mongoid::FakeCriteria.new(documents)
+    end
+  end
+end

data/spec/mongoid/fake_criteria_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Mongoid::FakeCriteria do
+
+  context "with the books ['book 1', 'book 2', 'book 3', 'book 4']" do
+    let(:books) { Mongoid::FakeCriteria.new(['book 1', 'book 2', 'book 3', 'book 4']) }
+
+    describe "#limit" do
+      the ("books.limit(2).raw") { should eql ['book 1', 'book 2'] }
+      the ("books.limit(0).raw") { should eql ['book 1', 'book 2', 'book 3', 'book 4'] }
+      the ("books.limit(6).raw") { should eql ['book 1', 'book 2', 'book 3', 'book 4'] }
+    end
+
+    context "#count" do
+      the ("books.count") { should eql 4 }
+    end
+  end
+
+end

data/spec/mongoid/sorted_relations_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Mongoid::SortedRelations do
+  context "having the book The Art of War" do
+    let(:book) { Book.new(:title => 'The Art of War') }
+
+    context "written by the authors Sun Tzu, Sun Wu and Lao Zi" do
+      before { book.author_ids = [Author.create(:name => 'Sun Tzu').id, Author.create(:name => 'Sun Wu').id, Author.create(:name => 'Lao Zi').id] }
+      before { book.save and book.reload }
+
+      the("book.sorted_authors.map(&:name)") { should eql ['Sun Tzu', 'Sun Wu', 'Lao Zi'] }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require "rubygems"
+require "bundler/setup"
+
+require 'rspec'
+require 'rspec-aspic'
+
+require 'mongoid'
+require File.expand_path('../../lib/mongoid-sorted-relations', __FILE__)
+
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db('mongoid_sortable_relations_test')
+  config.allow_dynamic_fields = false
+end
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.include RSpecAspic
+  config.after :each do
+    Mongoid.master.collections.reject { |c| c.name =~ /^system\./ }.each(&:drop)
+  end
+end

data/spec/support/models/author.rb

@@ -0,0 +1,9 @@
+class Author
+  include Mongoid::Document
+
+  field :name
+
+  attr_accessible :name
+
+  has_and_belongs_to_many :books
+end

data/spec/support/models/book.rb

@@ -0,0 +1,13 @@
+class Book
+  include Mongoid::Document
+  include Mongoid::SortedRelations
+
+  field :title
+
+  attr_accessible :title
+
+  has_many :chapters
+  has_and_belongs_to_many :authors
+
+  init_sorted_relations
+end

data/spec/support/models/chapter.rb

@@ -0,0 +1,9 @@
+class Chapter
+  include Mongoid::Document
+
+  field :title
+
+  attr_accessible :title
+
+  belongs_to :book
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-sorted-relations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sebastien Rosa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &2168955220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2168955220
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &2168680680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: *2168680680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2168678240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *2168678240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2168675460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168675460
+- !ruby/object:Gem::Dependency
+  name: rspec-aspic
+  requirement: &2168674340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :development
+  prerelease: false
+  version_requirements: *2168674340
+description: Preserve the order of the mongoid documents in a referenced one-to-many
+  or many-to-many relationship.
+email:
+- sebastien@demarque.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- lib/mongoid/fake_criteria.rb
+- lib/mongoid/sorted_relations.rb
+- lib/mongoid-sorted-relations.rb
+- spec/mongoid/fake_criteria_spec.rb
+- spec/mongoid/sorted_relations_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/author.rb
+- spec/support/models/book.rb
+- spec/support/models/chapter.rb
+- LICENSE
+- README.md
+- Rakefile
+- Gemfile
+homepage: https://github.com/demarque/mongoid-sorted-relations
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mongoid-sorted-relations
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Preserve the order of the mongoid documents in a referenced one-to-many or
+  many-to-many relationship.
+test_files: []