preamble 0.0.2 → 0.0.3

data/.rspec

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

data/README.markdown

@@ -21,16 +21,33 @@ Example
 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 an array. The first part is your data, the second is the body conent.
+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`
 
-    [ { "key1" => "value1", "key2" => [1, 2, 3] }, "\nYour body content goes here"]
+    "\nYour body content goes here"
 
 
 Notes

data/lib/preamble.rb

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

data/lib/preamble/version.rb

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

data/preamble.gemspec

@@ -14,7 +14,8 @@ Gem::Specification.new do |s|
   s.rubyforge_project = "preamble"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.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/preamble/preamble_spec.rb

@@ -0,0 +1,77 @@
+require_relative '../spec_helper'
+require 'tempfile'
+
+describe Preamble do
+  
+  describe "#load" do
+    
+    it "should parse the preamble of a single file" do
+      result = Preamble.load(standard)    
+    end
+    
+    it "should return the result as a Preamble object" do
+      result = Preamble.load(standard)
+      expect(result).to be_a Preamble
+    end
+        
+    it "should return a Preamble object with metadata as a Hash" do
+      result = Preamble.load(standard)
+      expect(result.metadata).to be_a Hash      
+    end
+    
+    it "should return a Preamble object with content as a String" do
+      result = Preamble.load(standard)
+      expect(result.content).to be_a String      
+    end
+
+    it "should accept leading whitespace" do
+      Preamble.load(leading_whitespace)
+    end
+    
+    it "should accept an options hash" do
+      Preamble.load(standard, {})
+    end
+    
+    it "should accept an encoding option" do
+      Preamble.load(standard, {:external_encoding => 'UTF-8'})
+    end
+    
+    it "should read a UTF-8 character" do
+      result = Preamble.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 = Preamble.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 = Preamble.load(standard)
+      output_file = Tempfile.new('preamble').path
+      result.metadata["key1"] += "!"
+      result.save(output_file)
+
+      result = Preamble.load(output_file)
+      expect(result.metadata["key1"]).to eq("value1!")
+    end
+  end
+  
+  describe "#load_multiple" do
+    
+    it "should load multiple files" do
+      Preamble.load_multiple(standard, leading_whitespace, unicode)
+    end
+    
+    it "should accept options as tail arguments" do
+      Preamble.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/preamble'
+require_relative 'sample_files'
+
+RSpec.configure do |c|
+  c.include SampleFiles
+end

metadata

@@ -1,63 +1,88 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: preamble
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.3
   prerelease: 
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Starr Horne
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-26 00:00:00 -05:00
-default_executable: 
-dependencies: []
-
-description: Allows you to add YAML front matter to your templates. Useful for adding metadata to static pages
-email: 
+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
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .rspec
 - Gemfile
 - README.markdown
 - Rakefile
 - lib/preamble.rb
 - lib/preamble/version.rb
 - preamble.gemspec
-has_rdoc: true
+- spec/preamble/preamble_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/starrhorne/preamble
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3440432532881689500
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3440432532881689500
 requirements: []
-
 rubyforge_project: preamble
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Use yaml preambles in your documents & templates
-test_files: []
-
+test_files:
+- spec/preamble/preamble_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