document_file 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Ralph von der Heyden
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,49 @@
+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:
+
+!!!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
+end
+
+MyDocument.documents_dir = './documents'
+
+# 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!

data/Rakefile

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,105 @@
+require 'yaml'
+
+module DocumentFile
+  class Base
+    @@documents_dir = './documents'
+    @@documents = nil
+    attr_reader :content, :file_path
+
+    def initialize(new_file_path)
+      @file_path = new_file_path
+      define_attribute_finder('file_name')
+      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 = file_paths.map { |file_path| self.new File.join(Dir.getwd, 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 |method_name, value|
+        value = "'#{value}'" if value.is_a? String
+        instance_eval "def #{method_name}; #{value}; end"
+
+        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)
+        end
+
+        define_attribute_finder(method_name)
+      end
+      @@dynamic_methods_defined = true
+    end
+
+    def define_attribute_finder(method_name)
+      find_by_attribute_method = <<-eos
+        def self.find_by_#{method_name}(attribute)
+          all.detect {|document| document.#{method_name} == attribute}
+        end
+      eos
+      self.class.send(:module_eval, find_by_attribute_method)
+    end
+
+    def self.method_missing(method_name, *args)
+      self.all unless @@documents
+      super
+    end
+  end
+end

data/lib/document_file/version.rb

@@ -0,0 +1,3 @@
+module DocumentFile
+  VERSION = "0.0.1"
+end

data/lib/document_file.rb

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

data/test/document_file_test.rb

@@ -0,0 +1,202 @@
+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
+
+describe MyDocument do
+  before do
+    MyDocument.documents_dir = testdir + '/documents'
+  end
+
+  describe 'when finding all document_files' do
+    before do
+      @document_files = MyDocument.all
+    end
+
+    it 'should return an Array' do
+      assert_equal Array, @document_files.class
+    end
+  
+    it "should find all document_files" do
+      assert_equal 2, @document_files.size
+    end
+  end
+
+  describe 'when initializing a MyDocument' do
+    before do
+      @document_file = MyDocument.new(testdir + '/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
+      assert_equal String, @document_file.title.class
+      assert_equal 'The shizzle!', @document_file.title
+    end
+
+    it 'should intitialize strings from the front matter' do
+      assert_equal Array, @document_file.tags.class
+      assert_equal ['tag'], @document_file.tags
+    end
+
+    it 'should intitialize integers from the front matter' do
+      assert_equal Fixnum, @document_file.number_of_foos.class
+      assert_equal 42, @document_file.number_of_foos
+    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
+  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
+  end
+
+  describe 'when getting the file name or file path' do
+    it 'should show the right file name' do
+      document_file = MyDocument.new './test/documents/2010-08-08-test-document-file.textile'
+      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'
+      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'
+      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
+    end
+  end
+
+  describe 'when calling a method that was not defined dynamically' do
+    it 'should throw an error on the class level' do
+      assert_raises(NoMethodError) { MyDocument.hululu }
+    end
+
+    it 'should throw an error on the instance level' do
+      document_file = MyDocument.new('./test/documents/2010-08-08-test-document-file.textile')
+      assert_raises(NoMethodError) { document_file.hululu }
+    end
+  end
+
+  describe 'when reloading all document_files' do
+    before do
+      @default_dir = testdir + '/documents'
+      MyDocument.documents_dir = @default_dir
+      MyDocument.reload!
+      @document_files_before = MyDocument.all
+      @tmp_dir = "#{@default_dir}-#{Time.now.to_i}-#{rand(999999)}-test"
+      FileUtils.cp_r @default_dir, @tmp_dir
+    end
+
+    after do
+      FileUtils.rm_r(@tmp_dir) if Dir.exist?(@tmp_dir)
+    end
+
+    it 'should get updated document_files' do
+      updated_document_file = <<-eos
+---
+id: 1
+title: The shuzzle!
+tags: [tig]
+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
+
+      assert_equal @document_files_before.first.id, document_files_after.first.id
+      refute_equal @document_files_before.first.title, document_files_after.first.title
+      refute_equal @document_files_before.first.tags, document_files_after.first.tags
+      refute_equal @document_files_before.first.number_of_foos, document_files_after.first.number_of_foos
+      refute_equal @document_files_before.first.content, document_files_after.first.content
+    end
+
+    it 'should get new document_files' do
+      new_document_file = <<-eos
+---
+id: 3
+title: The shuzzle!
+tags: [tig]
+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
+
+      assert_equal @document_files_before.size + 1, document_files_after.size
+      assert_equal 'The shuzzle!', document_files_after.last.title
+      assert_equal "I like the cows.\n", document_files_after.last.content
+    end
+
+    it 'should not change if no document_files were changed' do
+      MyDocument.reload!
+      document_files_after = MyDocument.all
+      assert_equal @document_files_before.map(&:id), document_files_after.map(&:id)
+    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
+      MyDocument.reload!
+      document_files_after = MyDocument.all
+      refute_equal @document_files_before.map(&:id), document_files_after.map(&:id)
+    end
+  end
+end
+

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

@@ -0,0 +1,8 @@
+---
+id: 1
+title: The shizzle!
+tags: [tag]
+number_of_foos: 42
+---
+
+I like the flowers.

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

@@ -0,0 +1,7 @@
+---
+id: 2
+title: The big pink Oink!
+tags: [tag, tug]
+---
+
+I'm on a horse!

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: document_file
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ralph von der Heyden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-19 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: "  Makes your plain text files accessible in Ruby. Supports YAML front matter.\n"
+email: ralph@rvdh.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile
+- LICENSE
+- lib/document_file/base.rb
+- lib/document_file/version.rb
+- lib/document_file.rb
+- test/document_file_test.rb
+- test/documents/2010-08-08-test-document-file.textile
+- test/documents/2010-08-09-oink-post.textile
+has_rdoc: true
+homepage: http://github.com/ralph/document_file
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+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.
+test_files: []
+