mordor 0.1.3 → 0.2.0

data/README.md

@@ -0,0 +1,19 @@
+## Introduction
+Small library to add DataMapper style resources for MongoDB.
+
+```ruby
+class ExampleResource
+  include Mordor::Resource
+
+  attribute :first, :index => true
+  attribute :second
+  attribute :third, :finder_method => :find_by_third_attribute
+end
+```
+
+This adds attr_accessors to the ExampleResource for each attribute, plus adds finder methods of the form 
+`find_by_{attribute}`. The naming convention can be overridden by using the optional `:finder_method` option,
+as can be seen with the third attribute.
+
+When the `:index => true` option is set, indices are ensured before each query on 
+the collection. Indices are descending by default, but this can be changed by also supplying a `:index_type => Mongo::ASCENDING` option.

data/lib/mordor/collection.rb

@@ -7,22 +7,6 @@ module Mordor
       @cursor = cursor
     end
 
-    def to_a
-      array = []
-      unless @cursor.is_a? Array
-        @cursor.each do |element|
-          if element.is_a? @klass
-            array << element
-          else
-            array << @klass.new(element)
-          end
-        end
-      else
-        array = @cursor.dup
-      end
-      array
-    end
-
     def each
       @cursor.each do |element|
         if element.is_a? @klass
@@ -31,21 +15,13 @@ module Mordor
           yield @klass.new(element)
         end
       end
+      @cursor.rewind! unless @cursor.is_a? Array
     end
 
-    def first
-      if @cursor.is_a? Array
-        @cursor.first ? @klass.new(@cursor.first) : nil
-      else
-        result = @cursor.first
-        @cursor.rewind!
-        result ? @klass.new(result) : nil
-      end
-    end
-
-    def size
-      @cursor.count
+    def size(regard_limits_and_offsets = true)
+      @cursor.is_a?(Array) ? @cursor.count : @cursor.count(regard_limits_and_offsets)
     end
+    alias :count :size
 
     def method_missing(method, *args, &block)
       if @cursor.respond_to?(method)
@@ -55,15 +31,8 @@ module Mordor
       end
     end
 
-    def to_json
-      collection_name = @klass.collection_name.to_sym
-      res = {
-        collection_name => []
-      }
-      each do |elem|
-        res[collection_name] << elem.to_hash
-      end
-      res.to_json
+    def to_json(*args)
+      to_a.to_json(*args)
     end
 
     def merge(other_collection)

data/lib/mordor/resource.rb

@@ -28,7 +28,9 @@ module Mordor
       when Hash
         value = replace_params(value)
       when Date, DateTime
-        value = value.to_time
+        value = value.to_time.getlocal
+      when Time
+        value = value.getlocal
       when BigDecimal
         value = value.to_f
       when Array
@@ -81,6 +83,10 @@ module Mordor
       result
     end
 
+    def to_json(*args)
+      to_hash.merge(:_id => _id).to_json(*args)
+    end
+
     module ClassMethods
       def create(attributes = {})
         resource = self.new(attributes)
@@ -89,7 +95,7 @@ module Mordor
       end
 
       def all(options = {})
-        Collection.new(self, collection.find({}, options).to_a)
+        Collection.new(self, perform_collection_find({}, options))
       end
 
       def collection
@@ -105,7 +111,7 @@ module Mordor
         if id.is_a?(String)
           id = BSON::ObjectId.from_string(id)
         end
-        if attributes = collection.find_one(:_id => id)
+        if attributes = perform_collection_find_one(:_id => id)
           new(attributes)
         else
           nil
@@ -116,12 +122,13 @@ module Mordor
         @connection ||= Mordor.connection
       end
 
+
       def find_by_id(id)
         get(id)
       end
 
       def find(query, options = {})
-        Collection.new(self, collection.find(query, options).to_a)
+        Collection.new(self, perform_collection_find(query, options))
       end
 
       def find_by_day(day, options = {})
@@ -137,17 +144,21 @@ module Mordor
           end_of_day = (day.to_date + 1).to_datetime.to_date.to_time
         end
         hash = {:at => {'$gte' => start, '$lt' => end_of_day}}
-        if options.keys.include?(:limit)
-          cursor = collection.find({:at => {'$gte' => start, '$lt' => end_of_day}}, options).to_a
-        else
-          cursor = collection.find({:at => {'$gte' => start, '$lt' => end_of_day}})
-        end
+        cursor = perform_collection_find({:at => {'$gte' => start, '$lt' => end_of_day}}, options)
         Collection.new(self, cursor)
       end
 
+
       def attribute(name, options = {})
-        @attributes ||= []
+        @attributes  ||= []
+        @indices     ||= []
+        @index_types ||= {}
+
         @attributes << name unless @attributes.include?(name)
+        if options[:index]
+          @indices    << name unless @indices.include?(name)
+          @index_types[name] = options[:index_type] ? options[:index_type] : Mongo::DESCENDING
+        end
 
         method_name = options.key?(:finder_method) ? options[:finder_method] : "find_by_#{name}"
 
@@ -156,15 +167,36 @@ module Mordor
           attr_accessor name
 
           def self.#{method_name}(value, options = {})
-            if options.keys.include?(:limit)
-              col = collection.find({:#{name} => value}, options).to_a
-            else
-              col = collection.find(:#{name} => value)
-            end
+            col = perform_collection_find({:#{name} => value}, options)
             Collection.new(self, col)
           end
         EOS
       end
+
+      private
+      def perform_collection_find(query, options = {})
+        ensure_indices
+        collection.find(query, options)
+      end
+
+      def perform_collection_find_one(query, options = {})
+        ensure_indices
+        collection.find_one(query, options)
+      end
+
+      def ensure_indices
+        indices.each do |index|
+          collection.ensure_index( [ [index.to_s, index_types[index]] ] )
+        end
+      end
+
+      def indices
+        @indices ||= []
+      end
+
+      def index_types
+        @index_types ||= {}
+      end
     end
   end
 end

data/mordor.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.name    = "mordor"
   
   # Do not set the version and date field manually, this is done by the release script
-  s.version = "0.1.3"
-  s.date    = "2011-11-15"
+  s.version = "0.2.0"
+  s.date    = "2011-12-23"
 
   s.summary     = "mordor"
   s.description = <<-eos
@@ -29,6 +29,6 @@ Gem::Specification.new do |s|
 
   # The files and test_files directives are set automatically by the release script.
   # Do not change them by hand, but make sure to add the files to the git repository.
-  s.files = %w(.gitignore Gemfile Gemfile.lock README Rakefile lib/mordor.rb lib/mordor/collection.rb lib/mordor/resource.rb lib/mordor/version.rb mordor.gemspec spec/mordor/collection_spec.rb spec/mordor/connection_spec.rb spec/mordor/resource_spec.rb spec/spec.opts spec/spec_helper.rb tasks/github-gem.rake)
+  s.files = %w(.gitignore Gemfile Gemfile.lock README.md Rakefile lib/mordor.rb lib/mordor/collection.rb lib/mordor/resource.rb lib/mordor/version.rb mordor.gemspec spec/mordor/collection_spec.rb spec/mordor/connection_spec.rb spec/mordor/resource_spec.rb spec/spec.opts spec/spec_helper.rb tasks/github-gem.rake)
 end
 

data/spec/mordor/collection_spec.rb

@@ -4,9 +4,9 @@ describe "with respect to collections" do
   class TestResource
     include Mordor::Resource
 
-    attribute :first
-    attribute :second
-    attribute :third, :finder_method => :find_by_third_attribute
+    attribute :first,  :index => true
+    attribute :second, :index => true, :index_type => Mongo::ASCENDING
+    attribute :third,  :finder_method => :find_by_third_attribute
   end
 
   describe "serialization" do
@@ -28,11 +28,82 @@ describe "with respect to collections" do
 
       json_collection = JSON.parse(json_collection)
 
-      collection_name = TestResource.collection_name.to_sym.to_s
-      json_collection.keys.should include collection_name
-      json_collection[collection_name].should_not be_nil
-      json_collection[collection_name].should be_a Array
-      json_collection[collection_name].size.should == 5
+      json_collection.size.should == 5
+    end
+  end
+
+  describe "converting to array" do
+    before :all do
+      clean_sheet
+
+      5.times do |index|
+        res = TestResource.new(:first => "#{index}_first", :second => "#{index}_second", :third => "#{index}_third")
+        res.save.should be_true
+      end
+    end
+
+    it "should be possible to convert a collection to an array" do
+      collection = TestResource.find_by_first("1_first")
+      collection.to_a.should be_a Array
+    end
+
+    it "should be possible to convert multiple times after iterating using each" do
+      collection = TestResource.find_by_first("1_first")
+      collection.each do |resource|
+        resource.first
+      end
+      array1 = collection.to_a
+      array2 = collection.to_a
+      array1.size.should == array2.size
+    end
+
+    it "should be possible to convert a collection to an array multiple times" do
+      collection = TestResource.find_by_first("1_first")
+      array1 = collection.to_a
+      array2 = collection.to_a
+      array1.size.should == array2.size
+    end
+
+    it "should convert the collection to an array with the same size" do
+      collection = TestResource.find_by_first("1_first")
+      collection_size = collection.size
+      collection.to_a.size.should == collection_size
+    end
+  end
+
+  describe "counting" do
+
+    before :all do
+      clean_sheet
+
+      5.times do |index|
+        res = TestResource.new(:first => "#{index}_first", :second => "#{index}_second", :third => "#{index}_third")
+        res.save.should be_true
+      end
+    end
+
+    it "should default to taking in account limits" do
+      TestResource.find({}, {:limit => 3}).count.should == 3
+    end
+
+    it "should not take in account limits when requested" do
+      TestResource.find({}, {:limit => 3}).count(false).should == 5
+    end
+
+    it "should not take in account skips when requested" do
+      TestResource.find({}, {:skip => 2}).count(false).should == 5
+    end
+
+    it "should not take in account skips and limits when requested" do
+      TestResource.find({}, {:skip => 1, :limit => 3}).count(false).should == 5
+    end
+
+    it "should take in account skips by defaults" do
+      TestResource.find({}, {:skip => 2}).count.should == 3
+    end
+
+    it "should take in account skips and limits by default" do
+      TestResource.find({}, {:skip => 1, :limit => 3}).count.should == 3
     end
   end
 

data/spec/mordor/resource_spec.rb

@@ -1,12 +1,22 @@
 require File.join(File.dirname(__FILE__), '..', '/spec_helper.rb')
 
 describe "with respect to resources" do
-  class TestResource
-    include Mordor::Resource
+  before :each do
+    class TestResource
+      include Mordor::Resource
+
+      attribute :first,  :index => true
+      attribute :second, :index => true, :index_type => Mongo::ASCENDING
+      attribute :third,  :finder_method => :find_by_third_attribute
+
+      # Put this in here again to ensure the original method is still here
+      class_eval do
+        def self.ensure_indices
+          collection.ensure_index( indices.map{|index| [index.to_s, Mongo::DESCENDING]} ) if indices.any?
+        end
 
-    attribute :first
-    attribute :second
-    attribute :third, :finder_method => :find_by_third_attribute
+      end
+    end
   end
 
   it "should create accessor methods for all attributes" do
@@ -23,6 +33,47 @@ describe "with respect to resources" do
     TestResource.methods.should include "find_by_third_attribute"
   end
 
+  it "should ensure indices when the option :index => true is given" do
+    TestResource.send(:indices).should include :first
+  end
+
+  it "should default to descending indices" do
+    TestResource.send(:index_types).keys.should include :first
+    TestResource.send(:index_types)[:first].should == Mongo::DESCENDING
+  end
+
+  it "should be possible to set index type using the 'index_type' option" do
+    TestResource.send(:index_types).keys.should include :second
+    TestResource.send(:index_types)[:second].should == Mongo::ASCENDING
+  end
+
+  it "should call ensure_index on the collection for each index when a query is performed" do
+    TestResource.class_eval do
+      def self.ensure_count
+        @count ||= 0
+      end
+
+      def self.ensure_count=(val)
+        @count = val
+      end
+
+      private
+      def self.do_ensure_indices
+        indices.each do |index|
+          collection.ensure_index( [ [index.to_s, index_types[index]] ] )
+        end
+      end
+
+      def self.ensure_indices
+        self.ensure_count = self.ensure_count + 1
+        self.do_ensure_indices
+      end
+    end
+    TestResource.create({:first => 'first', :second => 'second', :third => 'third'})
+    TestResource.all()
+    TestResource.ensure_count.should == 1
+  end
+
   context "with respect to replacing params" do
     before :each do
       clean_sheet

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mordor
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jan-Willem Koelewijn
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-15 00:00:00 +01:00
+date: 2011-12-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -174,7 +174,7 @@ files:
 - .gitignore
 - Gemfile
 - Gemfile.lock
-- README
+- README.md
 - Rakefile
 - lib/mordor.rb
 - lib/mordor/collection.rb

data/README

@@ -1,13 +0,0 @@
-Small library to add DataMapper style resources for MongoDB.
-
-class ExampleResource
-  include Mordor::Resource
-
-  attribute :first
-  attribute :second
-  attribute :third, :finder_method => :find_by_third_attribute
-end
-
-This adds attr_accessors to the ExampleResource for each attribute, plus adds finder methods of the form 
-find_by_{attribute}. The naming convention can be overridden by using the optional :finder_method option,
-as can be seen with the third attribute.