snippr 0.15.24 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eae2d0b5629b7140a0d8b124a4e16299c0b9ded4
-  data.tar.gz: 8b6c014d9e147e85f0243a1b76ef4d2e33a6c0d2
+  metadata.gz: 04987e98947b0190ff1c5d80e54f0f10d5261c79
+  data.tar.gz: a901855ac7e59a75c478b9d5fdd26f7efe7a55fe
 SHA512:
-  metadata.gz: d4ad49375b5ab78a91a1a626769f30911289050a616cbb9b74fb2d039b8201e37cd763bc0bf8c681ad6db511305ffeeac058042ddefb3b2f38f9e47b9817a8cb
-  data.tar.gz: d5f6b0fd8c8c939a70f61f9991ebefa25f2e666ad8d5532ae5a1854b86f472e3a152399bee0752831b18967d3c2c3aedc2d2153e861aa786ce305153f4ff8497
+  metadata.gz: 726583051abb204696a534c43e9eed5d4e6ed59af7e1f88b9f2bd871747b6594c66defd52070e64001bd8ef6d25bfd6bd81f58165c296e15909ceeb370317f64
+  data.tar.gz: b2df93eef30d90fe05410c9e95f6aef81b22f5c4fbad7cb7cfc63440689168c239761a4e7a8749a8c1baa7cea571afbdcc2e46792479e8d036b488d381805b14

data/README.md

@@ -119,14 +119,29 @@ The data itself is parsed as YAML:
 Or with Segmentfilter:
 
     ---
-	a_yaml: old
-	---
-	old snippet content comes here until before segment filter
-	==== valid_from: 2013-05-17 13:15:00 ====
-	---
-	a_yaml: new
-	---
-	new snippet content after segment filter
+    a_yaml: old
+    ---
+    old snippet content comes here until before segment filter
+    ==== valid_from: 2013-05-17 13:15:00 ====
+    ---
+    a_yaml: new
+    ---
+    new snippet content after segment filter
+
+You call also include other front matter blocks from another snippet with the magic `_include` YAML construct.  
+If you have a snippet `a/path/snippet.snip`: 
+
+    ---
+    _include:
+      - path/from/root/to/snippet
+      - ./relative/to/this/snippet
+    ---
+
+This would merge the metadata from `path/from/root/to/snippet.snip` and `a/path/relative/to/this/snippet.snip` into the containing snippets metadata.  
+If there are duplicate keys the metadata in the main/base snippet is chosen.
+
+Be aware that the `_include` key is *removed* from the metadata after including.
+
 
 ### Including snippr files inside other files
 

data/lib/snippr/meta_data.rb

@@ -9,10 +9,21 @@ module Snippr
 
   class MetaData
 
-    def self.extract(name, content)
+    INCLUDE = "_include"
+
+    def self.extract(name, content, snippet=nil)
       if content =~ /^(---\s*\n.*?\n?)^(---\s*$?)/m
         content = Regexp.last_match.post_match.strip
         meta = yaml_load(name, $1)
+        if meta.keys.include?(INCLUDE)
+          Array(meta[INCLUDE]).each do |includePath|
+            if (snippet && includePath.start_with?("./"))
+              includePath = snippet.name.gsub(/\/.*?$/,"") + "/" + includePath.gsub(/^\.\//, "")
+            end
+            snippet = Snippr.load(includePath)
+            meta = snippet.meta.merge(meta)
+          end
+        end
       end
 
       meta = meta ? meta : {}

data/lib/snippr/snip.rb

@@ -31,7 +31,8 @@ module Snippr
           "<!-- missing snippr: #{name} -->"
         else
           content = SegmentParser.new(raw_content).content
-          @unprocessed_content, @meta = MetaData.extract(name, content)
+          @unprocessed_content, @meta = MetaData.extract(name, content, self)
+          @meta = @meta.reject { |key_from_meta| key_from_meta == MetaData::INCLUDE }
           content = Processor.process @unprocessed_content, opts, self
           "<!-- starting snippr: #{name} -->\n#{content}\n<!-- closing snippr: #{name} -->"
         end

data/snippr.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "snippr"
-  s.version     = '0.15.24'
+  s.version     = '0.16.0'
   s.date        = Time.now
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Daniel Harrington", "Thomas Jachmann", "Frank Schumacher"]

data/spec/fixtures/include/main.snip

@@ -0,0 +1,6 @@
+---
+_include:
+  - include/test
+  - include/test2
+---
+This tests the inclusion of yaml fron matter blocks

data/spec/fixtures/include/test.snip

@@ -0,0 +1,4 @@
+---
+this_is: included_from_include_test_snippet
+test: include
+---

data/spec/fixtures/include/test2.snip

@@ -0,0 +1,4 @@
+---
+this_is_also: included_from_include_test2_snippet
+test: include2
+---

data/spec/snippr/meta_data_spec.rb

@@ -6,6 +6,8 @@ describe Snippr::MetaData do
 
   TEST_CONTENT = 'Hier ist jede Menge Content.'
   TEST_CONTENT_WITH_METABLOCK = "---\nyml_key: yml_value\n---\n#{TEST_CONTENT}"
+  TEST_CONTENT_WITH_INCLUDE = "---\n_include:\n  - include/test\n  - include/test2\ntest: main\n---"
+  TEST_CONTENT_WITH_RELATIVE_INCLUDE = "---\n_include:\n  - ./test\n  - ./test2\ntest: main\n---"
 
   describe '.extract' do
     it 'returns an array with 2 elements [contentstring, metahash]' do
@@ -35,6 +37,22 @@ describe Snippr::MetaData do
       result = Snippr::MetaData.extract([:content], TEST_CONTENT_WITH_METABLOCK)
       expect(result.first).to eq TEST_CONTENT
     end
+
+    it "includes other front matter via the _include key" do
+      result = Snippr::MetaData.extract([:content], TEST_CONTENT_WITH_INCLUDE)
+      expect(result.second).to eq({"this_is_also"=>"included_from_include_test2_snippet", "test"=>"main", "this_is"=>"included_from_include_test_snippet", "_include"=>["include/test", "include/test2"]})
+    end
+
+    it "includes metadata from relative include paths" do
+      snippet = Snippr.load("include/main")
+      result = Snippr::MetaData.extract([:content], TEST_CONTENT_WITH_RELATIVE_INCLUDE, snippet)
+      expect(result.second).to eq({"this_is_also"=>"included_from_include_test2_snippet", "test"=>"main", "this_is"=>"included_from_include_test_snippet", "_include"=>["./test", "./test2"]})
+    end
+
+    it "includes other front matter blocks but lets the main block win" do
+      result = Snippr::MetaData.extract([:content], TEST_CONTENT_WITH_INCLUDE)
+      expect(result.second).to eq({"this_is_also"=>"included_from_include_test2_snippet", "test"=>"main", "this_is"=>"included_from_include_test_snippet", "_include"=>["include/test", "include/test2"]})
+    end
   end
 
 end

data/spec/snippr/snip_spec.rb

@@ -142,6 +142,11 @@ describe Snippr::Snip do
       expect(Snippr::Processor).to receive(:process).never
       expect(Snippr::Snip.new(:doesnotexist, :a => :b).content).to eq('<!-- missing snippr: doesnotexist -->')
     end
+
+    it "removes the _include key from the metadata" do
+      snip = Snippr::Snip.new(:include, :main)
+      expect(snip.meta).to_not have_key("_include")
+    end
   end
 
   describe "#missing?" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snippr
 version: !ruby/object:Gem::Version
-  version: 0.15.24
+  version: 0.16.0
 platform: ruby
 authors:
 - Daniel Harrington
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -155,6 +155,9 @@ files:
 - spec/fixtures/i18n/list_de.snip
 - spec/fixtures/i18n/shop_de.snip
 - spec/fixtures/i18n/shop_en.snip
+- spec/fixtures/include/main.snip
+- spec/fixtures/include/test.snip
+- spec/fixtures/include/test2.snip
 - spec/fixtures/meta/broken.snip
 - spec/fixtures/meta/onlyContent_de.snip
 - spec/fixtures/meta/withContent.snip
@@ -218,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: snippr
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: File based content management
@@ -231,6 +234,9 @@ test_files:
 - spec/fixtures/i18n/list_de.snip
 - spec/fixtures/i18n/shop_de.snip
 - spec/fixtures/i18n/shop_en.snip
+- spec/fixtures/include/main.snip
+- spec/fixtures/include/test.snip
+- spec/fixtures/include/test2.snip
 - spec/fixtures/meta/broken.snip
 - spec/fixtures/meta/onlyContent_de.snip
 - spec/fixtures/meta/withContent.snip