document_file 0.0.2 → 0.0.3

data/lib/document_file/base.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'active_support/inflector'
 
 module DocumentFile
   class Base
@@ -59,44 +60,75 @@ module DocumentFile
     end
 
     def define_dynamic_methods
-      @data.each do |method_name, value|
-        value = "'#{value}'" if value.is_a? String
-        instance_eval "def #{method_name}; #{value}; end"
+      @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
-          by_attribute_method = <<-eos
-            def self.by_#{method_name}
-              documents = self.all
-              #{method_name} = {}
-              documents.each do |document|
-                document.#{method_name}.each do |single_item|
-                  if #{method_name}.has_key? single_item
-                    #{method_name}[single_item] << document
-                  else
-                    #{method_name}[single_item] = [document]
-                  end
-                end
-              end
-              #{method_name}
-            end
-          eos
-          self.class.send(:module_eval, by_attribute_method)
+          define_by_attribute_finder(attribute_name)
+          define_find_all_by_attribute_finder(attribute_name)
         end
 
-        define_attribute_finder(method_name)
+        define_attribute_finder(attribute_name)
       end
       @@dynamic_methods_defined = true
     end
 
-    def define_attribute_finder(method_name)
+    # 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_#{method_name}(attribute)
-          all.detect {|document| document.#{method_name} == attribute}
+        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

data/lib/document_file/version.rb

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

data/test/document_file_test.rb

@@ -56,7 +56,7 @@ describe MyDocument do
     end
   end
 
-  describe 'when listing document_files by an array attribute' do
+  describe 'when listing document_files by an Array attribute' do
     it 'should return a Hash' do
       assert_equal Hash, MyDocument.by_tags.class
     end
@@ -70,6 +70,29 @@ describe MyDocument do
       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 document_files by an Array attribute value' do
+    it 'should return an Array' do
+      assert_equal Array, MyDocument.find_all_by_tag('tag').class
+    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 a document_file' do
@@ -84,6 +107,11 @@ describe MyDocument do
       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

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

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

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

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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Ralph von der Heyden
@@ -14,10 +14,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-19 00:00:00 +02:00
+date: 2010-08-23 00:00:00 +02:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
 description: "  Makes your plain text files accessible in Ruby. Supports YAML front matter.\n"
 email: ralph@rvdh.de
 executables: []