document_file 0.0.6 → 0.0.7

data/README.textile

@@ -40,12 +40,14 @@ h2. Available functionality
 
 h3. Dynamic finders
 
-<pre><code>doc = MyDocument.find_by_title("Ruby is great")              # => returns the document
-doc = MyDocument.find_by_number_of_foos(42)                  # => returns the document
-doc = MyDocument.find_by_file_name("2010-09-13-ruby-stuff")  # => returns the document
-
-docs = MyDocument.find_all_by_status("published") # => [doc_1, doc_2, ...]
-docs = MyDocument.find_all_by_tag("programming")  # => [doc_1, doc_2, ...]
+<pre><code>doc = MyDocument.find_by_title("Ruby is great")                # => returns the document
+doc = MyDocument.find_by_number_of_foos(42)                    # => returns the document
+doc = MyDocument.find_by_file_name("2010-09-13-ruby-stuff")    # => returns the document
+
+docs = MyDocument.find_all_by_status("published")              # => [doc_1, doc_2, ...]
+docs = MyDocument.find_all_by_tag("programming")               # => [doc_1, doc_2, ...]
+docs = MyDocument.find_all_by_tag("programming", :offset => 1) # => [doc_2, ...]
+docs = MyDocument.find_all_by_tag("programming", :limit => 2)  # => [doc_1, doc_2]
 </code></pre>
 
 
@@ -60,9 +62,13 @@ h3. Listing documents by the date attribute
 
 Document file tries to parse the filename of your documents to create a date attribute. In order to use the automatic parsing, the filenames have to start with a date string, e.g. @2010-09-13-ruby-stuff.textile@. If you don't want to set the date in the filename, you can still do it in the YAML front matter with e.g. @date: 2010-09-10@.
 
-<pre><code>docs = MyDocument.find_all_by_date(2010)        # => returns all documents from 2010
-docs = MyDocument.find_all_by_date(2010, 9)     # => returns all documents from Sep., 2010
-docs = MyDocument.find_all_by_date(2010, 9, 13) # => returns all documents from Sep. 13th, 2010
+<pre><code>docs = MyDocument.find_all_by_date(2010)          # => returns all documents from 2010
+docs = MyDocument.find_all_by_date(2010, 9)       # => returns all documents from Sep., 2010
+docs = MyDocument.find_all_by_date(2010, 9, 13)   # => returns all documents from Sep. 13th, 2010
+docs = MyDocument.find_all_by_date('*', 9, 13)    # => returns all documents from any Sep. 13th
+docs = MyDocument.find_all_by_date(2010, '*', 13) # => returns all documents from any 13th of 2010
+docs = MyDocument.find_all_by_date('*', '*', 13)  # => returns all documents from any 13th
+docs = MyDocument.find_all_by_date('*', 9)        # => returns all documents from any Sep.
 </code></pre>
 
 h3. Chaining

data/lib/document_file/collection.rb

@@ -2,6 +2,12 @@ require 'active_support/inflector'
 
 module DocumentFile
   class Collection < Array
+    attr_writer :total
+
+    def total
+      @total || length
+    end
+
     def <<(document)
       self.class.ensure_document(document)
       define_dynamic_finders document.data
@@ -34,6 +40,7 @@ module DocumentFile
       date_parts = %w(year month day)
       docs = self
       args.size.times do |i|
+        next if args[i] == '*'
         docs = docs.select { |doc| doc.date.send(date_parts[i]) == args[i] }
       end
       self.class.new docs
@@ -86,19 +93,20 @@ module DocumentFile
         singular_attribute = attribute
       end
       find_all_by_attribute = <<-eos
-        def find_all_by_#{singular_attribute}(attribute)
-          if respond_to? :by_#{attribute}
+        def find_all_by_#{singular_attribute}(attribute, options = {})
+          documents = if respond_to?(:by_#{attribute})
             by_#{attribute}[attribute]
           else
-            documents = select do |document|
+            select do |document|
               if document.respond_to? :#{attribute}
                 document.#{attribute} == attribute
               else
                 false
               end
             end
-            Collection.new documents
           end
+
+          self.class.new(documents).offset_and_limitize(options[:offset], options[:limit])
         end
       eos
       instance_eval find_all_by_attribute
@@ -115,5 +123,19 @@ module DocumentFile
       eos
       instance_eval find_by_attribute
     end
+
+    def offset_and_limitize(offset, limit)
+      documents = self
+      total_size = documents.length
+      if offset
+        documents = documents.last(length - offset)
+      end
+      if limit
+        documents = documents.first(limit)
+      end
+      self.class.new(documents).tap do |col|
+        col.total = total_size
+      end
+    end
   end
 end

data/lib/document_file/version.rb

@@ -1,3 +1,3 @@
 module DocumentFile
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/test/document_file_collection_test.rb

@@ -87,9 +87,131 @@ describe DocumentFile::Collection do
       assert_equal 1, documents.size
     end
 
+    it 'should return all documents with the year and day specified' do
+      documents = MyDocument.find_all_by_date 2010, '*', 8
+      assert_equal 1, documents.size
+    end
+
+    it 'should return all documents with the month and day specified' do
+      documents = MyDocument.find_all_by_date '*', 8, 8
+      assert_equal 1, documents.size
+    end
+
+    it 'should return all documents with the day specified' do
+      documents = MyDocument.find_all_by_date '*', '*', 8
+      assert_equal 1, documents.size
+    end
+
+    it 'should return all documents with the month specified' do
+      documents = MyDocument.find_all_by_date '*', 8, '*'
+      assert_equal 2, documents.size
+    end
+
     it 'should return the first match' do
       document = MyDocument.find_by_date 2010, 8
       assert_equal 1, document.id
     end
   end
+
+  describe 'when listing document_files by an Array attribute' do
+    it 'should return a Hash' do
+      assert_equal Hash, MyDocument.by_tags.class
+    end
+
+    it 'should use the tags as Hash keys' do
+      assert_equal Set.new(['tag', 'tug']), MyDocument.by_tags.keys.to_set
+    end
+
+    it 'should use the document_files as Hash values' do
+      document_files = MyDocument.by_tags
+      assert_equal Set.new([1, 2]), document_files['tag'].map(&:id).to_set
+      assert_equal Set.new([2]), document_files['tug'].map(&:id).to_set
+    end
+
+    it 'should not be confused by attributes that only some documents have' do
+      document_files_by_authors = MyDocument.by_authors
+      assert_equal 1, document_files_by_authors['Frank'].first.id
+
+      document_files_by_friends = MyDocument.by_friends
+      assert_equal 2, document_files_by_friends['Anton'].first.id
+    end
+  end
+
+  describe 'when finding all document_files by an Array attribute value' do
+    it 'should return a DocumentFile::Collection' do
+      klass = MyDocument.find_all_by_tag('tag').class
+      assert_equal DocumentFile::Collection, klass
+    end
+
+    it 'should containt documents' do
+      assert_equal MyDocument, MyDocument.find_all_by_tag('tag').first.class
+    end
+
+    it 'should return the right documents' do
+      assert_equal [1, 2], MyDocument.find_all_by_tag('tag').map(&:id)
+      assert_equal [2], MyDocument.find_all_by_tag('tug').map(&:id)
+    end
+  end
+
+  describe 'when finding all document_files by an attribute value' do
+    before do
+      @collection = MyDocument.find_all_by_status(:published)
+    end
+
+    it 'should return a DocumentFile::Collection' do
+      assert_equal DocumentFile::Collection, @collection.class
+    end
+
+    it 'should containt documents' do
+      assert_equal MyDocument, @collection.first.class
+    end
+
+    it 'should return the right documents' do
+      assert_equal [1, 2], @collection.map(&:id)
+    end
+
+    it 'should return an empty collection if the document was not found' do
+      empty_collection = MyDocument.find_all_by_status(:draft)
+      assert_equal [], empty_collection.map(&:id)
+    end
+  end
+
+  describe 'when finding a document_file' do
+    it 'should find the right document_file by an attribute' do
+      title = 'The shizzle!'
+      document_file = MyDocument.find_by_title(title)
+      assert_equal title, document_file.title
+    end
+
+    it 'should find the right document_file by file_name' do
+      file_name = '2010-08-08-test-document-file'
+      document_file = MyDocument.find_by_file_name file_name
+      assert_equal document_file.file_name, file_name
+    end
+
+    it 'should not be confused by attributes that only some dcuments have' do
+      document_file = MyDocument.find_by_special_attribute 'Yes!'
+      assert_equal 'Yes!', document_file.special_attribute
+    end
+  end
+
+  describe 'when using a finder with offset or limit' do
+    it 'should respect the offset' do
+      document_files = MyDocument.find_all_by_tag 'tag', :offset => 1
+      assert_equal 1, document_files.size
+      assert_equal 2, document_files.first.id
+    end
+
+    it 'should respect the limit' do
+      document_files = MyDocument.find_all_by_tag 'tag', :limit => 1
+      assert_equal 1, document_files.size
+      assert_equal 1, document_files.first.id
+    end
+
+    it 'should still deliver the total number of documents' do
+      document_files = MyDocument.find_all_by_tag 'tag', :offset => 1
+      assert_equal 1, document_files.size
+      assert_equal 2, document_files.total
+    end
+  end
 end

data/test/document_file_test.rb

@@ -106,88 +106,6 @@ eos
     end
   end
 
-  describe 'when listing document_files by an Array attribute' do
-    it 'should return a Hash' do
-      assert_equal Hash, MyDocument.by_tags.class
-    end
-
-    it 'should use the tags as Hash keys' do
-      assert_equal Set.new(['tag', 'tug']), MyDocument.by_tags.keys.to_set
-    end
-
-    it 'should use the document_files as Hash values' do
-      document_files = MyDocument.by_tags
-      assert_equal Set.new([1, 2]), document_files['tag'].map(&:id).to_set
-      assert_equal Set.new([2]), document_files['tug'].map(&:id).to_set
-    end
-
-    it 'should not be confused by attributes that only some documents have' do
-      document_files_by_authors = MyDocument.by_authors
-      assert_equal 1, document_files_by_authors['Frank'].first.id
-
-      document_files_by_friends = MyDocument.by_friends
-      assert_equal 2, document_files_by_friends['Anton'].first.id
-    end
-  end
-
-  describe 'when finding all document_files by an Array attribute value' do
-    it 'should return a DocumentFile::Collection' do
-      klass = MyDocument.find_all_by_tag('tag').class
-      assert_equal DocumentFile::Collection, klass
-    end
-
-    it 'should containt documents' do
-      assert_equal MyDocument, MyDocument.find_all_by_tag('tag').first.class
-    end
-
-    it 'should return the right documents' do
-      assert_equal [1, 2], MyDocument.find_all_by_tag('tag').map(&:id)
-      assert_equal [2], MyDocument.find_all_by_tag('tug').map(&:id)
-    end
-  end
-
-  describe 'when finding all document_files by an attribute value' do
-    before do
-      @collection = MyDocument.find_all_by_status(:published)
-    end
-
-    it 'should return a DocumentFile::Collection' do
-      assert_equal DocumentFile::Collection, @collection.class
-    end
-
-    it 'should containt documents' do
-      assert_equal MyDocument, @collection.first.class
-    end
-
-    it 'should return the right documents' do
-      assert_equal [1, 2], @collection.map(&:id)
-    end
-
-    it 'should return an empty collection if the document was not found' do
-      empty_collection = MyDocument.find_all_by_status(:draft)
-      assert_equal [], empty_collection.map(&:id)
-    end
-  end
-
-  describe 'when finding a document_file' do
-    it 'should find the right document_file by an attribute' do
-      title = 'The shizzle!'
-      document_file = MyDocument.find_by_title(title)
-      assert_equal title, document_file.title
-    end
-
-    it 'should find the right document_file by file_name' do
-      file_name = '2010-08-08-test-document-file'
-      document_file = MyDocument.find_by_file_name file_name
-      assert_equal document_file.file_name, file_name
-    end
-
-    it 'should not be confused by attributes that only some dcuments have' do
-      document_file = MyDocument.find_by_special_attribute 'Yes!'
-      assert_equal 'Yes!', document_file.special_attribute
-    end
-  end
-
   describe 'when getting the file name or file path' do
     before do
       @file_name = '2010-08-08-test-document-file.textile'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Ralph von der Heyden
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-08 00:00:00 +02:00
+date: 2010-09-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency