simple_document 0.1.0

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler"
+  gem "jeweler"
+  gem 'simplecov', :require => false
+  gem "ruby-debug19"
+  gem "timecop"
+  gem "redis"
+end
+

data/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.6)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    multi_json (1.2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redis (2.2.2)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    timecop (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler
+  redis
+  ruby-debug19
+  simplecov
+  timecop

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 radiospiel
+
+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.rdoc

@@ -0,0 +1,19 @@
+= simple_document
+
+Description goes here.
+
+== Contributing to simple_document
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 radiospiel. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "simple_document"
+  gem.homepage = "http://github.com/radiospiel/simple_document"
+  gem.license = "MIT"
+  gem.summary = %Q{Need some kind of document? Just throw me in.}
+  gem.description = %Q{Simplistic documents.}
+  gem.email = "eno@open-lab.org"
+  gem.authors = ["radiospiel"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "simple_document #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/abstract_method.rb

@@ -0,0 +1,24 @@
+class ImplementationMissing < NameError; end
+
+class Object
+  private
+
+  def implementation_missing!
+    calling_method_name = caller[1]
+    calling_method_name = $1 if calling_method_name =~ /.*in `(.*)'$/
+
+    raise ImplementationMissing, "Implementation missing: #{self.class.name}##{calling_method_name}"
+  end
+end
+
+module Kernel
+  private
+  
+  def abstract_method(*syms)
+    syms.each do |sym|
+      define_method sym do
+        raise ImplementationMissing, "#{self.class.name}##{sym}"
+      end
+    end
+  end
+end

data/lib/simple_document/file_store.rb

@@ -0,0 +1,105 @@
+class SimpleDocument::FileStore
+  class Document < SimpleDocument::Ostruct
+    def mtime
+      @ostruct.mtime ? Time.parse(@ostruct.mtime.to_s) : File.mtime(self.uri)
+    end
+  end
+
+  attr :url
+  alias :root :url
+
+  def initialize(url)
+    @url = url
+  end
+
+  # Fetches a document by name from a specific subset with a given
+  # locale (or no locale, if the locale parameter is set to nil.)
+  def fetch_with_locale(subset, name, locale = nil)
+    locale_ext = ".#{locale}" if locale
+    
+    pattern = "#{root}/#{subset}/#{name}#{locale_ext}.{#{FORMAT_BY_EXTENSION.keys.join(",")}}"
+    Dir.glob(pattern).sort.
+      map do |path| read_from_file(path) end.
+      detect(&:active?)
+  end
+  
+  # Return a Hash of all documents in a specific subset in this store. 
+  def all(subset)
+    Dir.glob("#{root}/#{subset}/*.{#{FORMAT_BY_EXTENSION.keys.join(",")}}").
+      map { |path| read_from_file(path) }.
+      select(&:active?).
+      group_by(&:name).
+      tap { |hash| hash.default = [] }
+  end
+  
+  private
+  
+  def dir(subset) 
+    dir = "#{root}/#{subset}"
+    FileUtils.mkdir_p(dir) unless File.directory?(dir)
+    dir
+  end
+  
+  public
+  
+  def store(subset, name, locale, data)
+    format, body = data.values_at "format", "body"
+    ext = FORMAT_BY_EXTENSION.key(format.to_sym) || raise(ArgumentError, "Unsupported format #{format.inspect}")
+    locale_ext = ".#{locale}" if locale
+    
+    path = "#{dir(subset)}/#{name}#{locale_ext}.#{ext}"
+    
+    File.open(path, "w") do |file|
+      file.write data.to_yaml unless data.empty?
+      file.write "---\n"
+      file.write body
+    end
+
+    fetch_with_locale(subset, name, locale)
+  end
+  
+  private
+  
+  FORMAT_BY_EXTENSION = {
+    "md"    => :markdown,
+    "html"  => :plain,
+    "erb"   => :erb
+  }
+
+  def header_and_body_from_document(path)
+    content = File.read(path).force_encoding('UTF-8')
+    lines = StringIO.new(content).readlines
+    lines.shift if lines.first =~ /^---/
+
+    header = []
+
+    while (line = lines.shift) && line !~ /^---/ do
+      header << line
+    end
+
+    if lines.empty?
+      [ nil, header.join ] 
+    else
+      [ header.join, lines.join ]
+    end
+  end
+
+  # read a simple document from a file
+  def read_from_file(path)
+    header, body = header_and_body_from_document(path)
+    header = header ? YAML::load(header) : {}
+
+    attributes = attributes_from_path(path) || raise("Cannot parse path: #{path.inspect}")
+
+    Document.new header.merge(attributes).merge(:body => body)
+  end
+  
+  def attributes_from_path(path)
+    return unless File.basename(path) =~ /^([^.]+)\.((\w\w)\.)?(\w+)$/
+
+    name, locale, ext = $1, $3, $4
+    return unless format = FORMAT_BY_EXTENSION[ext]
+
+    { :locale => locale, :name => name, :uri => path, :format => format }
+  end
+end

data/lib/simple_document/ostruct.rb

@@ -0,0 +1,20 @@
+require 'ostruct'
+require 'forwardable'
+
+class SimpleDocument::Ostruct < SimpleDocument
+  extend Forwardable
+  
+  def initialize(data)
+    @ostruct = OpenStruct.new(data)
+  end
+  
+  delegate [:header, :body, :name, :format, :uri] => :@ostruct
+  
+  def active?
+    true
+  end
+
+  def mtime
+    @ostruct.mtime && Time.parse(@ostruct.mtime)
+  end
+end

data/lib/simple_document.rb

@@ -0,0 +1,85 @@
+require_relative "abstract_method"
+
+class SimpleDocument
+  abstract_method :header
+  abstract_method :body
+  abstract_method :name
+  abstract_method :format
+  abstract_method :active?
+  abstract_method :mtime
+
+  singleton_class.class_eval do
+    def url
+      @store.url if @store
+    end
+    
+    def url=(url)
+      @store = FileStore.new(url)
+    end
+    
+    def store
+      @store || raise("Missing SimpleDocument.url setting")
+    end
+
+    def uncache
+      self.url = store.url if store
+    end
+    
+    # Return a Hash of all documents in a specific subset in this store. 
+    # The Hash keys are the document names, the hash values are an Array
+    # of documents for this name, with potentially different locales.
+    def all(subset)
+      store.all(subset)
+    end
+
+    # Stores a single document in a specific subset in this store.
+    def write(name, data)
+      subset, name = parse_name(name)
+
+      # stringify keys
+      data = data.inject({}) { |hash, (k,v)| hash.update(k.to_s => v) }
+      locale = data.delete "locale"
+
+      raise(ArgumentError, "Missing format entry") unless data.key?("format")
+      
+      store.store(subset, name, locale, data)
+    end
+
+    # Fetches a document by name from a specific subset. If a localize 
+    # is set it tries to load a localized variant of the document first. 
+    # If there is no such document, it then tries to load a non-localized 
+    # variant of the document.
+    # 
+    # The method returns nil if there is no such document.
+    def read(name, options = {})
+      subset, name = parse_name(name)
+      
+      # stringify keys
+      options = options.inject({}) { |hash, (k,v)| hash.update(k.to_s => v) }
+      locale = options.delete "locale"
+      
+      (locale && store.fetch_with_locale(subset, name, locale)) ||
+      store.fetch_with_locale(subset, name, nil)
+    end
+
+    # Fetches a document by name from a specific subset, using #fetch.
+    # In opposite to #fetch this method raises an Errno::ENOENT 
+    # exception if there is no such document.
+    def read!(name, options = {})
+      read(name, options) || raise(Errno::ENOENT, "SimpleDocument[#{url}]/#{name}")
+    end
+    
+    private
+    
+    def parse_name(name)
+      if name =~ /^([-a-zA-Z0-9]+)\/([-a-zA-Z0-9]+)$/
+        return [$1, $2]
+      end
+      
+      raise ArgumentError, "Invalid name #{name.inspect}"
+    end
+  end
+end
+
+require_relative "simple_document/ostruct"
+require_relative "simple_document/file_store"

data/test/file_store_test.rb

@@ -0,0 +1,147 @@
+require_relative 'test_helper'
+
+DIR = File.expand_path File.dirname(__FILE__)
+
+class SimpleDocument::FileStoreTest < Test::Unit::TestCase
+  def setup
+    SimpleDocument.url = "#{DIR}/fixtures"
+
+    # Clean writing directory
+    FileUtils.rm_rf("#{DIR}/fixtures/writing")
+  end
+  
+  def teardown
+    File.unlink @store.path if @store
+  end
+
+  # -- load single documents ------------------------------------------------
+  
+  def test_load_about
+    doc = SimpleDocument.read "folder/about"
+    
+    assert_equal "#{DIR}/fixtures/folder/about.md", doc.uri
+    assert_equal :markdown, doc.format
+    assert_equal "A english \"about\"\n", doc.body
+    
+    assert_equal nil, doc.header
+    assert_equal "about", doc.name
+    assert_equal true, doc.active?
+    assert_equal File.mtime(doc.uri), doc.mtime
+  end
+
+  # load document in a specific locale
+  def test_load_about_de
+    doc = SimpleDocument.read "folder/about", :locale => "de"
+    
+    assert_equal "#{DIR}/fixtures/folder/about.de.md", doc.uri
+    assert_equal :markdown, doc.format
+    assert_equal "Ein deutsches \"about\"\n", doc.body
+    
+    assert_equal nil, doc.header
+    assert_equal "about", doc.name
+    assert_equal true, doc.active?
+    assert_equal File.mtime(doc.uri), doc.mtime
+  end
+
+  # fallback to base document in a specific, but missing locale
+  def test_load_about_missing_locale
+    doc = SimpleDocument.read "folder/about", :locale => "fr"
+    
+    assert_equal "#{DIR}/fixtures/folder/about.md", doc.uri
+  end
+
+  # load document with headers
+  def test_load_headered
+    doc = SimpleDocument.read "folder/headered"
+    
+    assert_equal "#{DIR}/fixtures/folder/headered.md", doc.uri
+    assert_equal :markdown, doc.format
+    assert_equal "A document with a header.\n", doc.body
+    
+    assert_equal nil, doc.header
+    assert_equal "headered", doc.name
+    assert_equal true, doc.active?
+    assert_equal Time.parse("2012-01-01"), doc.mtime
+  end
+
+  # load missing document
+  def test_load_missing!
+    assert_raise(Errno::ENOENT) {  
+      SimpleDocument.read! "missing-folder/about"
+    }
+
+    assert_raise(Errno::ENOENT) {  
+      SimpleDocument.read! "folder/missing-about"
+    }
+  end
+
+  def test_load_missing
+    assert_nil SimpleDocument.read("missing-folder/about")
+    assert_nil SimpleDocument.read("folder/missing-about")
+  end
+
+  # -- fetch collections ------------------------------------------------
+  
+  # fetch collection
+  def test_missing_collection
+    docs = SimpleDocument.all "missing-folder"
+    assert_equal({}, docs)
+  end
+  
+  def test_collection
+    # Return a Hash of all documents in a specific subset in this store. 
+    # The Hash keys are the document names, the hash values are an Array
+    # of documents for this name, with potentially different locales.
+    
+    docs = SimpleDocument.all "folder"
+    assert_kind_of(Hash, docs)
+    assert_equal(%w(about headered), docs.keys.sort)
+    assert_equal(2, docs.count)
+    assert_equal([], docs["missing"])
+  end
+
+  # -- writing ------------------------------------------------
+  
+  def test_write_fails
+    # Make sure we are blank.
+    assert_raise(Errno::ENOENT) { SimpleDocument.read! "writing/foo" }
+    
+    # Missing format
+    assert_raise(ArgumentError) { SimpleDocument.write "writing/foo", :body => "The body" }
+
+    # Invalid format
+    assert_raise(ArgumentError) { SimpleDocument.write "writing/foo", :body => "The body", :format => "yahoo!" }
+
+    # Invalid names
+    assert_raise(ArgumentError) { SimpleDocument.write "wba/../dd", "12.kjsh", :body => "The body", :format => "markdown" }
+  end
+
+  def test_write
+    # Make sure we are blank.
+    assert_raise(Errno::ENOENT) { SimpleDocument.read! "writing/foo" }
+
+    doc = SimpleDocument.write "writing/foo", :body => "The body", :format => "markdown"
+    assert_equal("foo", doc.name)
+    assert_equal("The body", doc.body)
+    assert_equal(true, doc.active?)
+
+    doc = SimpleDocument.read! "writing/foo", :locale => "de"
+    assert_equal("foo", doc.name)
+    assert_equal("The body", doc.body)
+    assert_equal(true, doc.active?)
+  end
+
+  # -- uncache ------------------------------------------------
+  
+  def test_uncache
+    store_1 = SimpleDocument.store
+    store_2 = SimpleDocument.store
+    SimpleDocument.uncache
+    store_3 = SimpleDocument.store
+    
+    assert_equal(store_1.object_id, store_2.object_id)
+    assert_not_equal(store_1.object_id, store_3.object_id)
+
+    assert_equal(store_1.url, store_3.url)
+  end
+end

data/test/fixtures/folder/about.de.md

@@ -0,0 +1 @@
+Ein deutsches "about"

data/test/fixtures/folder/about.md

@@ -0,0 +1 @@
+A english "about"

data/test/fixtures/folder/headered.md

@@ -0,0 +1,3 @@
+mtime: 2012-01-01
+---
+A document with a header.

data/test/test_helper.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'ruby-debug'
+require 'simplecov'
+require 'timecop'
+require 'test/unit'
+SimpleCov.start do
+  add_filter "test/*.rb"
+  add_filter "lib/abstract_method.rb"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simple_document'
+
+module SimpleDocument::TestCase
+  def test_simple_document_kindof
+    assert store.kind_of?(SimpleDocument)
+  end
+  
+  # def test_simple_document
+  #   assert_equal(nil, simple_document.fetch("bar"))
+  # 
+  #   assert_equal("foo", simple_document.store("bar", "foo"))
+  #   assert_equal("foo", simple_document.fetch("bar"))
+  #   
+  #   done = 0
+  #   assert_equal "baz", simple_document.cached("key") { done += 1; "baz" }
+  #   assert_equal 1, done
+  #   assert_equal "baz", simple_document.cached("key") { done += 1; "baz" }
+  #   assert_equal 1, done
+  # 
+  #   assert_equal(nil, simple_document.store("bar", nil))
+  #   assert_equal(nil, simple_document.fetch("bar"))
+  # end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: simple_document
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- radiospiel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70336244947520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336244947520
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70336244946980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336244946980
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70336244946360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336244946360
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70336244940120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336244940120
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70336244939540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336244939540
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70336244938900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70336244938900
+description: Simplistic documents.
+email: eno@open-lab.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/abstract_method.rb
+- lib/simple_document.rb
+- lib/simple_document/file_store.rb
+- lib/simple_document/ostruct.rb
+- test/file_store_test.rb
+- test/fixtures/folder/about.de.md
+- test/fixtures/folder/about.md
+- test/fixtures/folder/headered.md
+- test/test_helper.rb
+homepage: http://github.com/radiospiel/simple_document
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2569138236874985957
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Need some kind of document? Just throw me in.
+test_files: []