document_mapper 0.1.1 → 0.1.2

data/README.textile

@@ -97,6 +97,13 @@ MyDocument.where(:year.lt => 2010)        # year < 2010
 MyDocument.where(:year.lte => 2010)       # year <= 2010
 </code></pre>
 
+While retrieving documents, you can also define the way the documents should be ordered. By default, the documents will be returned in the order they were loaded from the file system, which usually means by file name ascending. If you define an ordering, the documents that don't own the ordering attribute will be excluded.
+
+<pre><code>MyDocument.order_by(:title => :asc).all  # Order by title attribute, ascending
+MyDocument.order_by(:title).all          # Same as order_by(:title => :asc)
+MyDocument.order_by(:title => :desc).all # Order by title attribute, descending
+</code></pre>
+
 
 h3. Chaining
 

data/lib/document_mapper/document.rb

@@ -61,6 +61,17 @@ module DocumentMapper
             document_value.send operator, selector_value
           end
         end
+
+        if options[:order_by].present?
+          order_attribute = options[:order_by].keys.first
+          asc_or_desc = options[:order_by].values.first
+          documents.select! do |document|
+            document.attributes.include? order_attribute
+          end
+          documents.sort_by! { |document| document.send order_attribute }
+          documents.reverse! if asc_or_desc == :desc
+        end
+
         documents
       end
 
@@ -68,8 +79,8 @@ module DocumentMapper
         Query.new(self).where(hash)
       end
 
-      def sort(field)
-        Query.new(self).sort(field)
+      def order_by(field)
+        Query.new(self).order_by(field)
       end
 
       def offset(number)

data/lib/document_mapper/query.rb

@@ -17,8 +17,8 @@ module DocumentMapper
       self
     end
 
-    def sort(field)
-      @sort = field
+    def order_by(field)
+      @order_by = field.is_a?(Symbol) ? {field => :asc} : field
       self
     end
 
@@ -41,7 +41,7 @@ module DocumentMapper
     end
 
     def all
-      result = @model.select(:where => @where, :sort => @sort)
+      result = @model.select(:where => @where, :order_by => @order_by)
       if @offset.present?
         result = result.last(result.size - @offset)
       end

data/lib/document_mapper/version.rb

@@ -1,3 +1,3 @@
 module DocumentMapper
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/test/document_mapper/document_mapper_test.rb

@@ -241,6 +241,32 @@ describe MyDocument do
     end
   end
 
+  describe 'sorting the documents' do
+    before do
+      MyDocument.directory = 'test/documents'
+    end
+
+    it 'should support ordering by attribute ascending' do
+      found_documents = MyDocument.order_by(:title => :asc).all
+      assert_equal [2,3,1,4], found_documents.map(&:id)
+    end
+
+    it 'should support ordering by attribute descending' do
+      found_documents = MyDocument.order_by(:title => :desc).all
+      assert_equal [4,1,3,2], found_documents.map(&:id)
+    end
+
+    it 'should order by attribute ascending by default' do
+      found_documents = MyDocument.order_by(:title).all
+      assert_equal [2,3,1,4], found_documents.map(&:id)
+    end
+
+    it 'should exclude documents that do not own the attribute' do
+      found_documents = MyDocument.order_by(:status).all
+      assert_equal [1,2], found_documents.map(&:id)
+    end
+  end
+
   describe 'reloading the Document class' do
     it 'should discover new documents' do
       @file_path = 'test/documents/2011-04-26-new-stuff.textile'

metadata

@@ -2,7 +2,7 @@
 name: document_mapper
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Ralph von der Heyden
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 Z
+date: 2011-05-16 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: DocumentMapper is an object mapper for plain text documents.