preambular 0.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in preamble.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,60 @@
+Preamble
+========
+
+Introduction
+------------
+
+The preamble gem lets you add a yaml preamble to your files, much like the Jekyll static site generator
+
+
+Example
+-------
+
+    ---
+    key1: value1
+    key2: [1, 2, 3]
+    ---
+
+    Your body content goes here.
+
+
+Usage
+-----
+
+    # load file with metadata and content
+    Preamble.load("./file.xyz") 
+
+    # load multiple files with metadata and content
+    Preamble.load_multiple("./file.xyz", "./file.abc") 
+
+    # save metadata and content
+    file = Preamble.new({"author" => "Lucky", "year" => 2014}, "My lucky diary.")
+    file.save("diary.txt")
+
+    # load, modify metadata, then save
+    file = Preamble.load('./file.xyz')
+    file.metadata["new_key"] = "factoid"
+    file.save('./file.xyz')
+
+Output
+------
+
+The Preamble.load function returns a Preamble object. Your data will be in preamble.metadata, and the rest of the content will be in preamble.content.
+
+`preamble.metadata`
+
+    { "key1" => "value1", "key2" => [1, 2, 3] }
+
+`preamble.content`
+
+    "\nYour body content goes here"
+
+
+Notes
+-----
+
+1. The preamble must begin and end with three dashes '---'
+2. Whitespace can go above the preamble, but no content
+3. This gem is template-agnostic. It doesn't care what your body content is. It just gives it to you as a string.
+
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/preambular.rb

@@ -0,0 +1,85 @@
+require 'preambular/version'
+require 'yaml'
+
+class Preambular
+  
+  DEFAULTS = {
+    :external_encoding => Encoding.default_external
+  }
+
+  attr_accessor :metadata, :content
+
+  def initialize(metadata, content)
+    @metadata = metadata
+    @content = content
+  end
+
+  def metadata_with_content
+    @metadata.to_yaml + "---\n" + @content
+  end
+
+  def save(path, options = {})
+    options = DEFAULTS.merge(options)
+
+    open(path, "w:#{options[:external_encoding]}") do |f|
+      f.write metadata_with_content
+    end
+  end
+  
+  def self.load(path, options = {})
+    preamble_lines = String.new
+    content_lines = String.new
+    options = DEFAULTS.merge(options)
+    
+    state = :before_preamble
+    
+    open(path, "r:#{options[:external_encoding]}") do |f|
+      f.each do |line|
+
+        stripped = line.strip
+
+        case state
+
+          when :before_preamble
+
+            new_state = case stripped
+              when "---"
+                :preamble
+              when ""
+                :before_preamble
+              else
+                raise "First line must begin with ---"
+            end
+
+          when :preamble
+
+            new_state = case stripped
+              when "---"
+                :after_preamble
+              else
+                preamble_lines << line
+                :preamble
+            end
+
+          when :after_preamble
+            new_state = :after_preamble
+            content_lines << line
+
+          else
+            raise "Invalid State: #{ state }"
+
+        end
+
+        state = new_state
+      end
+    end
+
+    return new(YAML::load(preamble_lines), content_lines)
+  end
+
+  def self.load_multiple(*paths)
+    options = paths.last.is_a?(Hash) ? paths.pop : {}
+    paths.map{ |path| Preambular.load(path, options) }
+  end
+
+end

data/lib/preambular/version.rb

@@ -0,0 +1,3 @@
+class Preambular
+  VERSION = "0.3"
+end

data/preambular.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "preambular/version"
+
+Gem::Specification.new do |s|
+  s.name        = "preambular"
+  s.version     = Preambular::VERSION
+  s.authors     = ["Starr Horne", "Duane Johnson"]
+  s.email       = ["starr@chromahq.com", "duane.johnson@gmail.com"]
+  s.homepage    = "https://github.com/wordtreefoundation/preambular"
+  s.summary     = %q{Use and save yaml preambles in your documents & templates}
+  s.description = %q{Allows you to add YAML front matter to your templates. Useful for adding metadata to static pages}
+
+  s.rubyforge_project = "preambular"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/**`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency 'rspec'
+end

data/spec/preambular/preambular_spec.rb

@@ -0,0 +1,77 @@
+require_relative '../spec_helper'
+require 'tempfile'
+
+describe Preambular do
+  
+  describe "#load" do
+    
+    it "should parse the preamble of a single file" do
+      result = Preambular.load(standard)    
+    end
+    
+    it "should return the result as a Preambular object" do
+      result = Preambular.load(standard)
+      expect(result).to be_a Preambular
+    end
+        
+    it "should return a Preambular object with metadata as a Hash" do
+      result = Preambular.load(standard)
+      expect(result.metadata).to be_a Hash      
+    end
+    
+    it "should return a Preambular object with content as a String" do
+      result = Preambular.load(standard)
+      expect(result.content).to be_a String      
+    end
+
+    it "should accept leading whitespace" do
+      Preambular.load(leading_whitespace)
+    end
+    
+    it "should accept an options hash" do
+      Preambular.load(standard, {})
+    end
+    
+    it "should accept an encoding option" do
+      Preambular.load(standard, {:external_encoding => 'UTF-8'})
+    end
+    
+    it "should read a UTF-8 character" do
+      result = Preambular.load(unicode, {:external_encoding => 'UTF-8'})
+      expect(result.metadata['unicode_tm']).to eq "\u2122" # "TM"
+    end
+    
+  end
+
+  describe "#metadata_with_content" do
+    it "should be the same as the source file" do
+      result = Preambular.load(standard)
+      expect(File.read(standard)).to eq(result.metadata_with_content)
+    end
+  end
+
+  describe "#save" do
+    it "should save a modified file" do
+      result = Preambular.load(standard)
+      output_file = Tempfile.new('preamble').path
+      result.metadata["key1"] += "!"
+      result.save(output_file)
+
+      result = Preambular.load(output_file)
+      expect(result.metadata["key1"]).to eq("value1!")
+    end
+  end
+  
+  describe "#load_multiple" do
+    
+    it "should load multiple files" do
+      Preambular.load_multiple(standard, leading_whitespace, unicode)
+    end
+    
+    it "should accept options as tail arguments" do
+      Preambular.load_multiple(standard, leading_whitespace, unicode, external_encoding: 'UTF-8')
+    end
+    
+  end
+  
+end

data/spec/sample_files.rb

@@ -0,0 +1,17 @@
+module SampleFiles
+
+  SAMPLE_FILES = {
+    standard: "standard.txt",
+    leading_whitespace: "leading_whitespace.txt",
+    unicode: "unicode.txt"
+  }
+  
+  SAMPLE_FILES.each do |method, filename|
+    define_method(method) { full_path filename }
+  end
+
+  def full_path filename
+    "#{File.dirname(__FILE__)}/sample_files/#{filename}"
+  end
+
+end

data/spec/sample_files/leading_whitespace.txt

@@ -0,0 +1,6 @@
+
+---
+key1: value1
+---
+
+Your body content goes here.

data/spec/sample_files/standard.txt

@@ -0,0 +1,5 @@
+---
+key1: value1
+---
+
+Your body content goes here.

data/spec/sample_files/unicode.txt

@@ -0,0 +1,5 @@
+---
+unicode_tm: ™
+---
+
+Your body content goes here.

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require_relative '../lib/preambular'
+require_relative 'sample_files'
+
+RSpec.configure do |c|
+  c.include SampleFiles
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: preambular
+version: !ruby/object:Gem::Version
+  version: '0.3'
+  prerelease: 
+platform: ruby
+authors:
+- Starr Horne
+- Duane Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows you to add YAML front matter to your templates. Useful for adding
+  metadata to static pages
+email:
+- starr@chromahq.com
+- duane.johnson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/preambular.rb
+- lib/preambular/version.rb
+- preambular.gemspec
+- spec/preambular/preambular_spec.rb
+- spec/sample_files.rb
+- spec/sample_files/leading_whitespace.txt
+- spec/sample_files/standard.txt
+- spec/sample_files/unicode.txt
+- spec/spec_helper.rb
+homepage: https://github.com/wordtreefoundation/preambular
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: preambular
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Use and save yaml preambles in your documents & templates
+test_files:
+- spec/preambular/preambular_spec.rb
+- spec/sample_files.rb
+- spec/sample_files/leading_whitespace.txt
+- spec/sample_files/standard.txt
+- spec/sample_files/unicode.txt
+- spec/spec_helper.rb
+has_rdoc: