document_file 0.0.5 → 0.0.6

data/README.textile

@@ -1,6 +1,6 @@
 h1. Document File
 
-Document file is an object mapper for plain text documents. The documents look like the ones used in "jekyll":http://github.com/mojombo/jekyll. They consist of a preambel written in YAML (also called YAML front matter), and some content in the format you prefer, e.g. Textile.
+Document file is an object mapper for plain text documents. The documents look like the ones used in "jekyll":http://github.com/mojombo/jekyll, "toto":http://github.com/cloudhead/toto or "Serious":http://github.com/colszowka/serious. They consist of a preambel written in YAML (also called YAML front matter), and some content in the format you prefer, e.g. Textile. This enables you to write documents in your favorite editor and access the content and metadata in your Ruby scripts.
 
 
 h2. Example
@@ -16,19 +16,20 @@ Documents look somehow like this. The part between the @---@s is the YAML front
 
 <pre><code>---
 id: 1
-title: The shizzle!
-tags: [tag]
+title: Ruby is great
+tags: [programming, software]
 number_of_foos: 42
 status: published
 ---
 
-I like the flowers.
+I like Ruby.
 </code></pre>
 
 
-In order to access the documents in the folder, you have to create a document class that inherits from @DocumentFile::Base@. Inside the class definition, you must set the @documents_dir@ class variable in order to tell Document File where to look for files. In our little example, we will do the following:
+In order to access the documents in the folder, you have to create a document class that includes @DocumentFile@. Inside the class definition, you must set the @documents_dir@ class variable in order to tell Document File where to look for files. In our little example, we will do the following and assume the above file has been saved as @./documents/2010-09-13-ruby-stuff.textile@:
 
-<pre><code>class MyDocument
+<pre><code>require 'document_file'
+class MyDocument
   include DocumentFile
   self.documents_dir = './documents'
 end
@@ -39,38 +40,47 @@ h2. Available functionality
 
 h3. Dynamic finders
 
-<pre><code>doc = MyDocument.find_by_title("The shizzle!")    # => returns the document
-doc = MyDocument.find_by_number_of_foos(42)       # => returns the document
-doc = MyDocument.find_by_file_name("foo.textile") # => returns the document
+<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("tag")          # => [doc_1, doc_2, ...]
+docs = MyDocument.find_all_by_tag("programming")  # => [doc_1, doc_2, ...]
 </code></pre>
 
 
 h3. Listing documents by Array attributes
 
 <pre><code>docs = MyDocument.by_tags
-# => Returns {"tag" => [doc_1, doc_2, ...], "tag_2" => [doc_1, doc_3, ...],  ...}
+# => Returns {"programming" => [doc_1, doc_2, ...], "software" => [doc_1, doc_3, ...],  ...}
 </code></pre>
 
 
+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
+</code></pre>
+
 h3. Chaining
 
 <pre><code>docs = MyDocument.find_all_by_status("published").by_tags
-#   => Returns {"tag" => [doc_1, doc_2, ...], ...}
-docs = MyDocument.find_all_by_status("published").find_all_by_tag("tag")
+#   => Returns {"programming" => [doc_1, doc_2, ...], ...}
+docs = MyDocument.find_all_by_status("published").find_all_by_tag("programming")
 #   => Returns [doc_1, doc_2, ...]
 </code></pre>
 
 
 h3. Accessing the attributes of single documents
 
-<pre><code>doc.title                    # => "The shizzle!"
-doc.tags                     # => ["tag"]
-doc.content                  # => "I like the flowers."
-doc.filename                 # => "foo"
-doc.file_name_with_extension # => "foo.textile"
+<pre><code>doc.title                    # => "Ruby is great"
+doc.tags                     # => ["programming", "software"]
+doc.content                  # => "I like Ruby."
+doc.file_name                # => "2010-08-12-my-post"
+doc.file_name_with_extension # => "2010-08-12-my-post.textile"
 doc.file_extension           # => ".textile"
 </code></pre>
 
@@ -91,4 +101,4 @@ If any of the files change, you must manually reload them:
 h2. Author
 
 Written by "Ralph von der Heyden":http://rvdh.de. Don't hesitate to contact me if you have any further questions.
-Follow me on "Twitter":http://twitter.com/ralph.
+Follow me on "Twitter":http://twitter.com/ralph!

data/lib/document_file/collection.rb

@@ -14,6 +14,7 @@ module DocumentFile
         collection.each do |document|
           self.ensure_document(document)
           attributes_hash = document.data.merge({'file_name' => document.file_name})
+          attributes_hash.delete 'date'
           collection.define_dynamic_finders attributes_hash
         end
         collection
@@ -27,6 +28,21 @@ module DocumentFile
       raise ArgumentError unless document.class.include? DocumentFile
     end
 
+    def find_all_by_date(*args)
+      return if args.size == 0
+
+      date_parts = %w(year month day)
+      docs = self
+      args.size.times do |i|
+        docs = docs.select { |doc| doc.date.send(date_parts[i]) == args[i] }
+      end
+      self.class.new docs
+    end
+
+    def find_by_date(*args)
+      find_all_by_date(*args).first
+    end
+
     def define_dynamic_finders(attributes_hash)
       attributes_hash.each do |attribute, value|
         define_find_all_by attribute, value

data/lib/document_file/version.rb

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

data/lib/document_file.rb

@@ -15,7 +15,11 @@ module DocumentFile
   attr_reader :content, :file_path, :data
 
   def initialize(new_file_path)
-    @file_path = new_file_path
+    @file_path = if File.exist? new_file_path
+                   new_file_path
+                 else
+                   [self.documents_dir, new_file_path].join('/')
+                 end
     read_yaml
   end
 
@@ -40,12 +44,19 @@ private
       @data = YAML.load($1)
     end
     @data ||= {}
+    if !@data.has_key? 'date'
+      begin
+        match = File.basename(@file_path).match(/(\d{4})-(\d{1,2})-(\d{1,2}).*/)
+        @data['date'] = Date.new(match[1].to_i, match[2].to_i, match[3].to_i)
+      rescue NoMethodError => err
+      end
+    end
     define_dynamic_methods
   end
 
   def define_dynamic_methods
-    @data.each do |attribute_name, value|
-      attribute_reader = "def #{attribute_name}; @data['#{attribute_name}']; end"
+    @data.each do |attribute, value|
+      attribute_reader = "def #{attribute}; @data['#{attribute}']; end"
       self.class.module_eval attribute_reader
     end
   end
@@ -61,7 +72,7 @@ private
     def reload!
       if File.directory?(documents_dir)
         file_paths = Dir.glob("#{documents_dir}/*.*")
-        @@documents = Collection.new file_paths.map { |file_path| self.new file_path }
+        @@documents = Collection.new file_paths.map { |fp| self.new fp }
       else
         []
       end

data/test/document_file_collection_test.rb

@@ -4,9 +4,7 @@ describe DocumentFile::Collection do
   describe 'when adding documents to the collection' do
     before do
       @collection = DocumentFile::Collection.new
-      @document = MyDocument.new(
-        TEST_DIR + '/documents/2010-08-08-test-document-file.textile'
-      )
+      @document = MyDocument.new('2010-08-08-test-document-file.textile')
     end
 
     it 'should not accept non-documents' do
@@ -62,11 +60,36 @@ describe DocumentFile::Collection do
     end
 
     it 'should accept documents' do
-      document = MyDocument.new(
-        TEST_DIR + '/documents/2010-08-08-test-document-file.textile'
-      )
+      document = MyDocument.new '2010-08-08-test-document-file.textile'
       collection = DocumentFile::Collection.new [document]
       assert document, collection.first
     end
   end
+
+  describe 'when finding documents by date' do
+    it 'should return a collection' do
+      documents = MyDocument.find_all_by_date 2010
+      assert_equal documents.class, DocumentFile::Collection
+    end
+
+    it 'should return all documents with the year specified' do
+      documents = MyDocument.find_all_by_date 2010
+      assert_equal 2, documents.size
+    end
+
+    it 'should return all documents with the year and month specified' do
+      documents = MyDocument.find_all_by_date 2010, 8
+      assert_equal 2, documents.size
+    end
+
+    it 'should return all documents with the year, month and day specified' do
+      documents = MyDocument.find_all_by_date 2010, 8, 8
+      assert_equal 1, documents.size
+    end
+
+    it 'should return the first match' do
+      document = MyDocument.find_by_date 2010, 8
+      assert_equal 1, document.id
+    end
+  end
 end

data/test/document_file_test.rb

@@ -17,9 +17,7 @@ describe MyDocument do
 
   describe 'when initializing a MyDocument' do
     before do
-      @document_file = MyDocument.new(
-        TEST_DIR + '/documents/2010-08-08-test-document-file.textile'
-      )
+      @document_file = MyDocument.new('2010-08-08-test-document-file.textile')
     end
 
     it 'should know the documents_dir' do
@@ -44,6 +42,68 @@ describe MyDocument do
       assert_equal Fixnum, @document_file.number_of_foos.class
       assert_equal 42, @document_file.number_of_foos
     end
+
+    it 'should work with absolute path' do
+      document_file = MyDocument.new(
+        TEST_DIR + '/documents/2010-08-08-test-document-file.textile'
+      )
+      assert_equal MyDocument, document_file.class
+    end
+  end
+
+  describe 'when initializing the date' do
+    after do
+      remove_document @file_name if @file_name
+    end
+
+    it 'should initialize the date from the filename' do
+      document_file = MyDocument.new '2010-08-08-test-document-file.textile'
+      assert_equal Date.new(2010, 8, 8), document_file.date
+    end
+
+    it 'should initialize the date from the YAML front matter' do
+      @file_name = 'date-test-1.textile'
+      add_document @file_name, <<-eos
+---
+id: 5
+title: Date test 1
+date: 2010-09-10
+---
+
+I like the dates.
+eos
+      document_file = MyDocument.new @file_name
+      assert_equal Date.new(2010, 9, 10), document_file.date
+    end
+
+    it 'should prefer the date from the YAML front matter' do
+      @file_name = '2010-08-15-date-test-1.textile'
+      add_document @file_name, <<-eos
+---
+id: 5
+title: Date test 2
+date: 2010-08-20
+---
+
+I like the dates.
+eos
+      document_file = MyDocument.new @file_name
+      assert_equal Date.new(2010, 8, 20), document_file.date
+    end
+
+    it 'should not set a date if neither filename nor YAML date is set' do
+      @file_name = 'date-test-1.textile'
+      add_document @file_name, <<-eos
+---
+id: 5
+title: Date test 3
+---
+
+I like the dates.
+eos
+      document_file = MyDocument.new @file_name
+      assert_nil document_file.date
+    end
   end
 
   describe 'when listing document_files by an Array attribute' do
@@ -130,30 +190,31 @@ describe MyDocument do
 
   describe 'when getting the file name or file path' do
     before do
-      @file_path = './test/documents/2010-08-08-test-document-file.textile'
+      @file_name = '2010-08-08-test-document-file.textile'
     end
 
     it 'should show the right file name' do
-      document_file = MyDocument.new @file_path
+      document_file = MyDocument.new @file_name
       file_name = '2010-08-08-test-document-file'
       assert_equal file_name, document_file.file_name
     end
 
     it 'should show the right file name with extension' do
-      document_file = MyDocument.new @file_path
+      document_file = MyDocument.new @file_name
       file_name = '2010-08-08-test-document-file.textile'
       assert_equal file_name, document_file.file_name_with_extension
     end
 
     it 'should show the right extension' do
-      document_file = MyDocument.new @file_path
+      document_file = MyDocument.new @file_name
       extension = '.textile'
       assert_equal extension, document_file.file_extension
     end
 
     it 'should show the right file path' do
-      document_file = MyDocument.new @file_path
-      assert_equal @file_path, document_file.file_path
+      document_file = MyDocument.new @file_name
+      expected_path = [MyDocument.documents_dir, @file_name].join('/')
+      assert_equal expected_path, document_file.file_path
     end
   end
 
@@ -177,6 +238,7 @@ describe MyDocument do
       @document_files_before = MyDocument.all
       @tmp_dir = "#{@default_dir}-#{Time.now.to_i}-#{rand(999999)}-test"
       FileUtils.cp_r @default_dir, @tmp_dir
+      MyDocument.documents_dir = @tmp_dir
     end
 
     after do
@@ -184,7 +246,7 @@ describe MyDocument do
     end
 
     it 'should get updated document_files' do
-      updated_document_file = <<-eos
+      add_document '2010-08-08-test-document-file.textile', <<-eos
 ---
 id: 1
 title: The shuzzle!
@@ -194,9 +256,6 @@ number_of_foos: 48
 
 I like the foos.
 eos
-      document_file_file_name = "#{@tmp_dir}/2010-08-08-test-document-file.textile"
-      File.open(document_file_file_name, 'w') {|f| f.write(updated_document_file) }
-      MyDocument.documents_dir = @tmp_dir
       MyDocument.reload!
       document_files_after = MyDocument.all
 
@@ -208,7 +267,7 @@ eos
     end
 
     it 'should get new document_files' do
-      new_document_file = <<-eos
+      add_document '2010-08-15-new-test-document_file.textile', <<-eos
 ---
 id: 3
 title: The shuzzle!
@@ -218,9 +277,6 @@ number_of_foos: 48
 
 I like the cows.
 eos
-      document_file_file_name = "#{@tmp_dir}/2010-08-15-new-test-document_file.textile"
-      File.open(document_file_file_name, 'w') {|f| f.write(new_document_file) }
-      MyDocument.documents_dir = @tmp_dir
       MyDocument.reload!
       document_files_after = MyDocument.all
 
@@ -236,13 +292,21 @@ eos
     end
 
     it 'should not show deleted document_files' do
-      document_file_file_name = "#{@tmp_dir}/2010-08-08-test-document-file.textile"
-      FileUtils.rm document_file_file_name
-      MyDocument.documents_dir = @tmp_dir
+      remove_document '2010-08-08-test-document-file.textile' # has id 1
       MyDocument.reload!
       document_files_after = MyDocument.all
-      refute_equal @document_files_before.map(&:id), document_files_after.map(&:id)
+      refute document_files_after.map(&:id).include? 1
     end
   end
+
+  def add_document(file_name, content)
+    complete_file_name = [MyDocument.documents_dir, file_name].join('/')
+    File.open(complete_file_name, 'w') {|f| f.write(content) }
+  end
+
+  def remove_document(file_name)
+    complete_file_name = [MyDocument.documents_dir, file_name].join('/')
+    FileUtils.rm complete_file_name if File.exist? complete_file_name
+  end
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Ralph von der Heyden
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-01 00:00:00 +02:00
+date: 2010-09-08 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
         version: 3.0.0
   type: :runtime
   version_requirements: *id001
-description: "  Makes your plain text files accessible in Ruby. Supports YAML front matter.\n"
+description: "  Document file is an object mapper for plain text documents. The documents look like the ones used in jekyll (http://github.com/mojombo/jekyll). They consist of a preambel written in YAML (also called YAML front matter), and some content in the format you prefer, e.g. Textile. This enables you to write documents in your favorite editor and access the content and metadata of these in your Ruby scripts.\n"
 email: ralph@rvdh.de
 executables: []
 
@@ -82,6 +82,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Write documents in your fav editor. Read them in your Ruby app.
+summary: Document file is an object mapper for plain text documents.
 test_files: []