document_file 0.0.3 → 0.0.4

data/Gemfile

@@ -0,0 +1 @@
+gemspec :path => '.'

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    document_file (0.0.4)
+      activesupport (~> 3.0.0)
+
+GEM
+  specs:
+    activesupport (3.0.0.rc)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0.0)
+  document_file!

data/README.textile

@@ -0,0 +1,100 @@
+h1. Document File
+
+An attempt to create a simple model layer that abstracts flat text files. Text files 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.
+
+
+h2. Example
+
+As an example let's assume we have a directory called "documents" containing the following files:
+
+<pre><code>
+documents/
+|-foo.textile
+|-bar.textile
+</code></pre>
+
+Documents look somehow like this. The part between the @---@s is the YAML front matter. After the second @---@, there is one blank line, followed by the content of the file. All items in the YAML front matter and the content are accessible by Document File.
+
+<pre><code>
+---
+id: 1
+title: The shizzle!
+tags: [tag]
+number_of_foos: 42
+status: published
+---
+
+I like the flowers.
+</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:
+
+<pre><code>
+class MyDocument < DocumentFile::Base
+  self.documents_dir = './documents'
+end
+</code></pre>
+
+
+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
+
+docs = MyDocument.find_all_by_status("published") # => [doc_1, doc2, ...]
+docs = MyDocument.find_all_by_tag("tag")          # => [doc_1, doc2, ...]
+</code></pre>
+
+h3. Listing documents by Array attributes
+
+<pre><code>
+docs = MyDocument.by_tags
+# => Returns {"tag" => [doc_1, doc2, ...], "tag_2" => [doc_1, doc_3, ...],  ...}
+</code></pre>
+
+h3. Chaining
+
+<pre><code>
+docs = MyDocument.find_all_by_status("published").by_tags
+#   => Returns {"tag" => [doc_1, doc2, ...], ...}
+docs = MyDocument.find_all_by_status("published").find_all_by_tag("tag")
+#   => Returns [doc_1, doc2, ...]
+</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"
+doc.file_extension           # => ".textile"
+</code></pre>
+
+h3. Initializing single documents
+
+This will even work without setting the @documents_dir@ class variable.
+
+<pre><code>
+doc = MyDocument.new('./documents/document-file.textile')
+</code></pre>
+
+h3. Reloading
+
+If any of the files change, you must manually reload them:
+<pre><code>
+MyDocument.reload!
+</code></pre>
+
+
+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.

data/lib/document_file/base.rb

@@ -1,15 +1,13 @@
 require 'yaml'
-require 'active_support/inflector'
 
 module DocumentFile
   class Base
     @@documents_dir = './documents'
     @@documents = nil
-    attr_reader :content, :file_path
+    attr_reader :content, :file_path, :data
 
     def initialize(new_file_path)
       @file_path = new_file_path
-      define_attribute_finder('file_name')
       read_yaml
     end
 
@@ -33,7 +31,7 @@ module DocumentFile
     def self.reload!
       if File.directory?(@@documents_dir)
         file_paths = Dir.glob("#{@@documents_dir}/*.*")
-        @@documents = file_paths.map { |file_path| self.new file_path }
+        @@documents = Collection.new file_paths.map { |file_path| self.new file_path }
       else
         []
       end
@@ -61,77 +59,13 @@ module DocumentFile
 
     def define_dynamic_methods
       @data.each do |attribute_name, value|
-        instance_variable_set("@#{attribute_name}", value)
-        self.class.instance_eval "attr_reader :#{attribute_name}"
-
-        if value.is_a? Array
-          define_by_attribute_finder(attribute_name)
-          define_find_all_by_attribute_finder(attribute_name)
-        end
-
-        define_attribute_finder(attribute_name)
+        attribute_reader = "def #{attribute_name}; @data['#{attribute_name}']; end"
+        self.class.module_eval attribute_reader
       end
-      @@dynamic_methods_defined = true
-    end
-
-    # Defines an attribute finder, e.g.
-    # MyDocument.find_by_title('some_title') => some_document
-    def define_attribute_finder(attribute_name)
-      find_by_attribute_method = <<-eos
-        def self.find_by_#{attribute_name}(attribute)
-          all.detect do |document|
-            if document.respond_to?('#{attribute_name}')
-              document.#{attribute_name} == attribute
-            else
-              false
-            end
-          end
-        end
-      eos
-      self.class.send(:module_eval, find_by_attribute_method)
-    end
-
-    # Defines a by attribute finder for Array attributes, e.g.
-    # MyDocument.by_tags
-    #   => {
-    #        "tag_1" => [document_1, document_3],
-    #        "tag_2" => [document_2]
-    #      }
-    def define_by_attribute_finder(array_attribute)
-      by_attribute_method = <<-eos
-        def self.by_#{array_attribute}
-          documents = self.all
-          #{array_attribute}_items = {}
-          documents.each do |document|
-            document.#{array_attribute}.each do |single_item|
-              if #{array_attribute}_items.has_key? single_item
-                #{array_attribute}_items[single_item] << document
-              else
-                #{array_attribute}_items[single_item] = [document]
-              end
-            end if document.#{array_attribute}
-          end
-          #{array_attribute}_items
-        end
-      eos
-      self.class.send(:module_eval, by_attribute_method)
-    end
-
-    # Finds documents by a specific Array attribute value , e.g.
-    # MyDocument.find_all_by_tag('my_tag') => [document_1, document_2, ...]
-    def define_find_all_by_attribute_finder(array_attribute)
-      singular_array_attribute = ActiveSupport::Inflector.singularize array_attribute
-      find_all_by_attribute_method = <<-eos
-        def self.find_all_by_#{singular_array_attribute}(singular_array_attribute)
-          self.by_#{array_attribute}[singular_array_attribute]
-        end
-      eos
-      self.class.send(:module_eval, find_all_by_attribute_method)
     end
 
     def self.method_missing(method_name, *args)
-      self.all unless @@documents
-      respond_to?(method_name) ? self.send(method_name, *args) : super
+      self.all.respond_to?(method_name) ? self.all.send(method_name, *args) : super
     end
   end
 end

data/lib/document_file/collection.rb

@@ -0,0 +1,103 @@
+require 'active_support/inflector'
+
+module DocumentFile
+  class Collection < Array
+    def <<(document)
+      self.class.ensure_document(document)
+      define_dynamic_finders document.data
+      super
+    end
+
+    class << self
+      def new_with_finders(*args)
+        collection = new_without_finders(*args)
+        collection.each do |document|
+          self.ensure_document(document)
+          attributes_hash = document.data.merge({'file_name' => document.file_name})
+          collection.define_dynamic_finders attributes_hash
+        end
+        collection
+      end
+
+      alias_method :new_without_finders, :new
+      alias_method :new, :new_with_finders
+    end
+
+    def self.ensure_document(document)
+      raise ArgumentError unless document.is_a? DocumentFile::Base
+    end
+
+    def define_dynamic_finders(attributes_hash)
+      attributes_hash.each do |attribute, value|
+        define_find_all_by attribute, value
+        define_find_by attribute
+
+        define_by_array_attribute(attribute) if value.is_a? Array
+      end
+    end
+
+    # Defines a by attribute finder for Array attributes, e.g.
+    # MyDocument.by_tags
+    #   => {
+    #        "tag_1" => [document_1, document_3],
+    #        "tag_2" => [document_2]
+    #      }
+    def define_by_array_attribute(array_attribute)
+      by_attribute = <<-eos
+        def by_#{array_attribute}
+          #{array_attribute}_items = {}
+          each do |document|
+            document.#{array_attribute}.each do |single_item|
+              if #{array_attribute}_items.has_key? single_item
+                #{array_attribute}_items[single_item] << document
+              else
+                #{array_attribute}_items[single_item] = Collection.new [document]
+              end
+            end if document.#{array_attribute}
+          end
+          #{array_attribute}_items
+        end
+      eos
+      instance_eval by_attribute
+    end
+
+    # Finds documents by a specific Array attribute value , e.g.
+    # MyDocument.find_all_by_tag('my_tag') => [document_1, document_2, ...]
+    def define_find_all_by(attribute, value)
+      if value.is_a? Array
+        singular_attribute = ActiveSupport::Inflector.singularize attribute
+      else
+        singular_attribute = attribute
+      end
+      find_all_by_attribute = <<-eos
+        def find_all_by_#{singular_attribute}(attribute)
+          if respond_to? :by_#{attribute}
+            by_#{attribute}[attribute]
+          else
+            documents = select do |document|
+              if document.respond_to? :#{attribute}
+                document.#{attribute} == attribute
+              else
+                false
+              end
+            end
+            Collection.new documents
+          end
+        end
+      eos
+      instance_eval find_all_by_attribute
+    end
+
+    # Defines an attribute finder for one document, e.g.
+    # MyDocument.find_by_title('some_title') => some_document
+    def define_find_by(attribute)
+      find_by_attribute = <<-eos
+        def find_by_#{attribute}(attribute)
+          documents = find_all_by_#{attribute}(attribute)
+          documents.any? ? documents.first : nil
+        end
+      eos
+      instance_eval find_by_attribute
+    end
+  end
+end

data/lib/document_file/version.rb

@@ -1,3 +1,3 @@
 module DocumentFile
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/document_file.rb

@@ -1,2 +1,3 @@
 require 'document_file/base'
+require 'document_file/collection'
 require 'document_file/version'

data/test/document_file_collection_test.rb

@@ -0,0 +1,72 @@
+require './test/test_base'
+
+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'
+      )
+    end
+
+    it 'should not accept non-documents' do
+      begin
+        @collection << 'some string'
+      rescue ArgumentError
+        assert true
+        return
+      end
+      assert false, 'collection falsely accepted a non DocumentFile datatype'
+    end
+
+    it 'should accept documents' do
+      @collection << @document
+      assert_equal @document, @collection.first
+    end
+
+    it 'should define find_by_attribute finders' do
+      @collection << @document
+      attr = :find_by_title
+      assert @collection.respond_to?(attr), fail_msg(attr)
+    end
+
+    it 'should define find_all_by_attribute finders' do
+      @collection << @document
+      attr = :find_all_by_status
+      assert @collection.respond_to?(attr), fail_msg(attr)
+    end
+
+    it 'should define by_attribute finders for Array attributes' do
+      @collection << @document
+      attr = :by_tags
+      assert @collection.respond_to?(attr), fail_msg(attr)
+    end
+
+    it 'should define find_all_by_attribute finders for Array attributes' do
+      @collection << @document
+      attr = :find_all_by_tag
+      assert @collection.respond_to?(attr), fail_msg(attr)
+    end
+
+    private
+    def fail_msg(failed_attribute)
+      "collection does not respond to #{failed_attribute}"
+    end
+  end
+
+  describe 'when creating a collection from an Array' do
+    it 'should not accept non-documents' do
+      assert_raises ArgumentError do
+        DocumentFile::Collection.new ['a string', 'some more']
+      end
+    end
+
+    it 'should accept documents' do
+      document = MyDocument.new(
+        TEST_DIR + '/documents/2010-08-08-test-document-file.textile'
+      )
+      collection = DocumentFile::Collection.new [document]
+      assert document, collection.first
+    end
+  end
+end

data/test/document_file_test.rb

@@ -1,20 +1,8 @@
-require 'minitest/spec'
-MiniTest::Unit.autorun
-require 'set'
-require 'fileutils'
-
-testdir = File.dirname(__FILE__)
-libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
-$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
-
-require 'document_file'
-
-class MyDocument < DocumentFile::Base
-end
+require './test/test_base'
 
 describe MyDocument do
   before do
-    MyDocument.documents_dir = testdir + '/documents'
+    MyDocument.documents_dir = TEST_DIR + '/documents'
   end
 
   describe 'when finding all document_files' do
@@ -22,8 +10,8 @@ describe MyDocument do
       @document_files = MyDocument.all
     end
 
-    it 'should return an Array' do
-      assert_equal Array, @document_files.class
+    it 'should return a DocumentFile::Collection' do
+      assert_equal DocumentFile::Collection, @document_files.class
     end
   
     it "should find all document_files" do
@@ -33,19 +21,21 @@ describe MyDocument do
 
   describe 'when initializing a MyDocument' do
     before do
-      @document_file = MyDocument.new(testdir + '/documents/2010-08-08-test-document-file.textile')
+      @document_file = MyDocument.new(
+        TEST_DIR + '/documents/2010-08-08-test-document-file.textile'
+      )
     end
 
     it 'should initialize the content' do
       assert_equal "I like the flowers.\n", @document_file.content
     end
 
-    it 'should intitialize strings from the front matter' do
+    it 'should intitialize Strings from the front matter' do
       assert_equal String, @document_file.title.class
       assert_equal 'The shizzle!', @document_file.title
     end
 
-    it 'should intitialize strings from the front matter' do
+    it 'should intitialize Arrays from the front matter' do
       assert_equal Array, @document_file.tags.class
       assert_equal ['tag'], @document_file.tags
     end
@@ -80,9 +70,10 @@ describe MyDocument do
     end
   end
 
-  describe 'when finding document_files by an Array attribute value' do
-    it 'should return an Array' do
-      assert_equal Array, MyDocument.find_all_by_tag('tag').class
+  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
@@ -95,6 +86,29 @@ describe MyDocument do
     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!'
@@ -115,28 +129,31 @@ describe MyDocument do
   end
 
   describe 'when getting the file name or file path' do
+    before do
+      @file_path = './test/documents/2010-08-08-test-document-file.textile'
+    end
+
     it 'should show the right file name' do
-      document_file = MyDocument.new './test/documents/2010-08-08-test-document-file.textile'
+      document_file = MyDocument.new @file_path
       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 './test/documents/2010-08-08-test-document-file.textile'
+      document_file = MyDocument.new @file_path
       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 './test/documents/2010-08-08-test-document-file.textile'
+      document_file = MyDocument.new @file_path
       extension = '.textile'
       assert_equal extension, document_file.file_extension
     end
 
     it 'should show the right file path' do
-      file_path = './test/documents/2010-08-08-test-document-file.textile'
-      document_file = MyDocument.new file_path
-      assert_equal file_path, document_file.file_path
+      document_file = MyDocument.new @file_path
+      assert_equal @file_path, document_file.file_path
     end
   end
 
@@ -146,14 +163,15 @@ describe MyDocument do
     end
 
     it 'should throw an error on the instance level' do
-      document_file = MyDocument.new('./test/documents/2010-08-08-test-document-file.textile')
+      file_path = './test/documents/2010-08-08-test-document-file.textile'
+      document_file = MyDocument.new file_path
       assert_raises(NoMethodError) { document_file.hululu }
     end
   end
 
   describe 'when reloading all document_files' do
     before do
-      @default_dir = testdir + '/documents'
+      @default_dir = TEST_DIR + '/documents'
       MyDocument.documents_dir = @default_dir
       MyDocument.reload!
       @document_files_before = MyDocument.all

data/test/documents/2010-08-08-test-document-file.textile

@@ -4,6 +4,7 @@ title: The shizzle!
 tags: [tag]
 number_of_foos: 42
 authors: [Frank, Bertha]
+status: :published
 ---
 
 I like the flowers.

data/test/documents/2010-08-09-oink-post.textile

@@ -4,6 +4,7 @@ title: The big pink Oink!
 tags: [tag, tug]
 special_attribute: Yes!
 friends: [Anton, Paul]
+status: :published
 ---
 
 I'm on a horse!

data/test/test_base.rb

@@ -0,0 +1,12 @@
+require 'minitest/spec'
+MiniTest::Unit.autorun
+require 'set'
+require 'fileutils'
+
+lib_dir = File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift lib_dir unless $LOAD_PATH.include?(lib_dir)
+require 'document_file'
+TEST_DIR = File.dirname(__FILE__)
+
+class MyDocument < DocumentFile::Base
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Ralph von der Heyden
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-23 00:00:00 +02:00
+date: 2010-08-26 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,15 +41,20 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
-- Rakefile
+- Gemfile
+- Gemfile.lock
 - LICENSE
+- README.textile
+- Rakefile
 - lib/document_file/base.rb
+- lib/document_file/collection.rb
 - lib/document_file/version.rb
 - lib/document_file.rb
+- test/document_file_collection_test.rb
 - test/document_file_test.rb
 - test/documents/2010-08-08-test-document-file.textile
 - test/documents/2010-08-09-oink-post.textile
+- test/test_base.rb
 has_rdoc: true
 homepage: http://github.com/ralph/document_file
 licenses: []

data/README

@@ -1,52 +0,0 @@
-Document File
--------------
-
-An attempt to create a simple model layer that abstracts flat text files.
-
-Text files look like the ones used by jekyll (see 
-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. Example:
-
-documents/
-|-foo.textile
-|-bar.textile
-
-!!!document starts in the following line.
----
-id: 1
-title: The shizzle!
-tags: [tag]
-number_of_foos: 42
----
-
-I like the flowers.
-!!!document ends in the previous line.
-
-Can be abstracted like this:
-
-class MyDocument < DocumentFile::Base
-  self.documents_dir = './documents'
-end
-
-# You now have dynamic finders:
-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
-
-# You can list documents by Array attributes
-docs = MyDocument.by_tags # => Returns {"tag" => [doc_1, doc2, ...], ...}
-
-# You can access the attributes of single documents:
-doc.title                    # => "The shizzle!"
-doc.tags                     # => ["tag"]
-doc.content                  # => "I like the flowers."
-doc.filename                 # => returns the filename without extension
-doc.file_name_with_extension # => does what it says
-doc.file_extension           # => does what it says
-
-# You can initialize single documents, too:
-doc = MyDocument.new('./documents/document-file.textile')
-
-# If any of the files change, you must manually reload them:
-MyDocument.reload!