document_file 0.0.4 → 0.0.5

data/README.textile

@@ -1,22 +1,20 @@
 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.
+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.
 
 
 h2. Example
 
 As an example let's assume we have a directory called "documents" containing the following files:
 
-<pre><code>
-documents/
+<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>
----
+<pre><code>---
 id: 1
 title: The shizzle!
 tags: [tag]
@@ -30,8 +28,8 @@ I like the flowers.
 
 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
+<pre><code>class MyDocument
+  include DocumentFile
   self.documents_dir = './documents'
 end
 </code></pre>
@@ -41,36 +39,34 @@ h2. Available functionality
 
 h3. Dynamic finders
 
-<pre><code>
-doc = MyDocument.find_by_title("The shizzle!")    # => returns the document
+<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, ...]
+docs = MyDocument.find_all_by_status("published") # => [doc_1, doc_2, ...]
+docs = MyDocument.find_all_by_tag("tag")          # => [doc_1, doc_2, ...]
 </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, ...],  ...}
+<pre><code>docs = MyDocument.by_tags
+# => Returns {"tag" => [doc_1, doc_2, ...], "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, ...], ...}
+<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 [doc_1, doc2, ...]
+#   => Returns [doc_1, doc_2, ...]
 </code></pre>
 
 
 h3. Accessing the attributes of single documents
 
-<pre><code>
-doc.title                    # => "The shizzle!"
+<pre><code>doc.title                    # => "The shizzle!"
 doc.tags                     # => ["tag"]
 doc.content                  # => "I like the flowers."
 doc.filename                 # => "foo"
@@ -82,15 +78,13 @@ h3. Initializing single documents
 
 This will even work without setting the @documents_dir@ class variable.
 
-<pre><code>
-doc = MyDocument.new('./documents/document-file.textile')
+<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!
+<pre><code>MyDocument.reload!
 </code></pre>
 
 

data/lib/document_file.rb

@@ -1,3 +1,76 @@
-require 'document_file/base'
+require 'active_support/core_ext/class'
+require 'active_support/concern.rb'
 require 'document_file/collection'
 require 'document_file/version'
+require 'yaml'
+
+module DocumentFile
+  extend ActiveSupport::Concern
+
+  included do
+    class_inheritable_accessor :documents_dir
+    self.documents_dir = './documents'
+  end
+
+  attr_reader :content, :file_path, :data
+
+  def initialize(new_file_path)
+    @file_path = new_file_path
+    read_yaml
+  end
+
+  def file_name
+    File.basename file_name_with_extension, file_extension
+  end
+
+  def file_name_with_extension
+    self.file_path.split('/').last
+  end
+
+  def file_extension
+    File.extname file_name_with_extension
+  end
+
+private
+  def read_yaml
+    @content = File.read(@file_path)
+
+    if @content =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
+      @content = @content[($1.size + $2.size)..-1]
+      @data = YAML.load($1)
+    end
+    @data ||= {}
+    define_dynamic_methods
+  end
+
+  def define_dynamic_methods
+    @data.each do |attribute_name, value|
+      attribute_reader = "def #{attribute_name}; @data['#{attribute_name}']; end"
+      self.class.module_eval attribute_reader
+    end
+  end
+
+  module ClassMethods
+    @@documents = nil
+
+    def all
+      return @@documents if @@documents
+      reload!
+    end
+
+    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 }
+      else
+        []
+      end
+    end
+
+  private
+    def method_missing(method_name, *args)
+      all.respond_to?(method_name) ? self.all.send(method_name, *args) : super
+    end
+  end
+end
+

data/lib/document_file/collection.rb

@@ -24,7 +24,7 @@ module DocumentFile
     end
 
     def self.ensure_document(document)
-      raise ArgumentError unless document.is_a? DocumentFile::Base
+      raise ArgumentError unless document.class.include? DocumentFile
     end
 
     def define_dynamic_finders(attributes_hash)

data/lib/document_file/version.rb

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

data/test/document_file_test.rb

@@ -1,10 +1,6 @@
 require './test/test_base'
 
 describe MyDocument do
-  before do
-    MyDocument.documents_dir = TEST_DIR + '/documents'
-  end
-
   describe 'when finding all document_files' do
     before do
       @document_files = MyDocument.all
@@ -26,6 +22,10 @@ describe MyDocument do
       )
     end
 
+    it 'should know the documents_dir' do
+      assert_equal MyDocument.documents_dir, @document_file.documents_dir
+    end
+
     it 'should initialize the content' do
       assert_equal "I like the flowers.\n", @document_file.content
     end

data/test/test_base.rb

@@ -8,5 +8,7 @@ $LOAD_PATH.unshift lib_dir unless $LOAD_PATH.include?(lib_dir)
 require 'document_file'
 TEST_DIR = File.dirname(__FILE__)
 
-class MyDocument < DocumentFile::Base
+class MyDocument
+  include DocumentFile
+  self.documents_dir = (TEST_DIR + '/documents')
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Ralph von der Heyden
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-26 00:00:00 +02:00
+date: 2010-09-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,12 +41,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- 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

data/Gemfile

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

data/Gemfile.lock

@@ -1,16 +0,0 @@
-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/Rakefile

@@ -1,5 +0,0 @@
-require 'rake/testtask'
-task :default => :test
-Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList['test/*_test.rb']
-end

data/lib/document_file/base.rb

@@ -1,71 +0,0 @@
-require 'yaml'
-
-module DocumentFile
-  class Base
-    @@documents_dir = './documents'
-    @@documents = nil
-    attr_reader :content, :file_path, :data
-
-    def initialize(new_file_path)
-      @file_path = new_file_path
-      read_yaml
-    end
-
-    def file_name
-      File.basename file_name_with_extension, file_extension
-    end
-
-    def file_name_with_extension
-      self.file_path.split('/').last
-    end
-
-    def file_extension
-      File.extname file_name_with_extension
-    end
-
-    def self.all
-      return @@documents if @@documents
-      self.reload!
-    end
-
-    def self.reload!
-      if File.directory?(@@documents_dir)
-        file_paths = Dir.glob("#{@@documents_dir}/*.*")
-        @@documents = Collection.new file_paths.map { |file_path| self.new file_path }
-      else
-        []
-      end
-    end
-
-    def self.documents_dir
-      @@documents_dir
-    end
-
-    def self.documents_dir=(new_dir)
-      @@documents_dir = new_dir
-    end
-
-  private
-    def read_yaml
-      @content = File.read(@file_path)
-
-      if @content =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
-        @content = @content[($1.size + $2.size)..-1]
-        @data = YAML.load($1)
-      end
-      @data ||= {}
-      define_dynamic_methods
-    end
-
-    def define_dynamic_methods
-      @data.each do |attribute_name, value|
-        attribute_reader = "def #{attribute_name}; @data['#{attribute_name}']; end"
-        self.class.module_eval attribute_reader
-      end
-    end
-
-    def self.method_missing(method_name, *args)
-      self.all.respond_to?(method_name) ? self.all.send(method_name, *args) : super
-    end
-  end
-end