snippr 0.16.2 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab3ac24a4943900527af0835dd4c75fcef4ff65e
-  data.tar.gz: c5e273b76fa6e7958816d4da9091d123f5439ebc
+  metadata.gz: 62a34d096d4e43ff626eb69835c161385d17286c
+  data.tar.gz: 9471aec2a2e21590e4510bc1b8d648d0494c5622
 SHA512:
-  metadata.gz: cd91728a4b090798135643c02244943f41f60aba1449629eaf1c20b98dad385631dc1c4c62fa1de229774b63939f084e28a33da57698d9176f94a1333562a8d7
-  data.tar.gz: c0a5d41e4f58b5375054400807b2a61995e96726e2cc99f4c0519430c79cd3b5c13aa9517843631298a324d6bd84c54cb7bda162135586771e7b65379c83a49d
+  metadata.gz: 429bbb9e104d98c08e81508c9475d7f5921ab20f4c10cd5e58792c63cd58c61181c08744ac632ca0211045d6027feb6f0b985920bfb3c68d6e45e9727df7811d
+  data.tar.gz: 23d835aea3caae6e78c520ab631019a3f99e74c2e57e0704da39d73c598e4f115a7aa436e626145d1883e47210f3bc42bbad0acb1a7aa471f69761493e447b5b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+Changelog:
+==========
+
+0.17.0:  
+- The _include YAML keyword merges two array by adding both together [potentially breaking]

data/README.md

@@ -140,8 +140,26 @@ If you have a snippet `a/path/snippet.snip`:
 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.
 
+This only works on the *first level* of yaml data.  
 Be aware that the `_include` key is *removed* from the metadata after including.
 
+If the YAML contains two arrays to be merged, both will be ADDED:
+
+    ---
+    key:
+      - a: 1
+    ---
+
+and
+
+    ---
+    key:
+      - b: 2
+    ---
+
+will result in:
+
+    {key: [{"a" => 1, "b" => 2}]}
 
 ### Including snippr files inside other files
 

data/lib/snippr/meta_data.rb

@@ -15,13 +15,15 @@ module Snippr
       if content =~ /^(---\s*\n.*?\n?)^(---\s*$?)/m
         content = Regexp.last_match.post_match.strip
         meta = yaml_load(name, $1)
-        if meta && meta.keys.include?(INCLUDE)
-          Array(meta[INCLUDE]).each do |include_path|
-            if (snippet && include_path.start_with?("./"))
-              include_path = snippet.name.gsub(/\/.*?$/,"") + "/" + include_path.gsub(/^\.\//, "")
+        if meta
+          if meta.keys.include?(INCLUDE)
+            Array(meta[INCLUDE]).each do |include_path|
+              if (snippet && include_path.start_with?("./"))
+                include_path = snippet.name.gsub(/\/.*?$/,"") + "/" + include_path.gsub(/^\.\//, "")
+              end
+              snippet = Snippr.load(include_path)
+              meta = deep_yaml_merge(snippet.meta, meta)
             end
-            snippet = Snippr.load(include_path)
-            meta = snippet.meta.deep_merge(meta)
           end
         end
       end
@@ -31,7 +33,22 @@ module Snippr
       [content, meta]
     end
 
-  private
+    private
+
+    def self.deep_yaml_merge(first_hash, other_hash)
+      other_hash.each_pair do |k,v|
+        tv = first_hash[k]
+        if tv.is_a?(Hash) && v.is_a?(Hash)
+          first_hash[k] = deep_yaml_merge(tv, v)
+        elsif tv.is_a?(Array) && v.is_a?(Array)
+          first_hash[k] = tv.concat(v)
+        else
+          first_hash[k] = v
+        end
+      end
+      first_hash
+    end
+
 
     def self.yaml_load(name, yml)
       YAML.load(yml)

data/snippr.gemspec

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

data/spec/fixtures/merge/array1.snip

@@ -0,0 +1,6 @@
+---
+tracking:
+  promotion:
+    -
+      a: 1
+---

data/spec/fixtures/merge/array2.snip

@@ -0,0 +1,6 @@
+---
+tracking:
+  promotion:
+    -
+      b: 2
+---

data/spec/snippr/meta_data_spec.rb

@@ -10,6 +10,8 @@ describe Snippr::MetaData do
   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---"
 
+  TEST_CONTENT_WITH_MERGE = "---\n_include:\n  - merge/array1\n  - merge/array2\n---"
+
   describe '.extract' do
     it 'returns an array with 2 elements [contentstring, metahash]' do
       result = Snippr::MetaData.extract([:content], TEST_CONTENT)
@@ -44,21 +46,47 @@ describe Snippr::MetaData do
       expect(result.second).to eq({})
     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
+    context "_include" do
+      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 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"]})
+      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
+
+      it "combines a hash containing an array into one" do
+        # this merges/adds an array to another array when the included hashes contain the same key:
+        # promotion:
+        #   - a: 1
+        #
+        # and
+        #
+        # promotion:
+        #   - b: 2
+        #
+        # will result in
+        # promotion:
+        #   - a: 1
+        #   - b: 2
+        #
+        # instead of letting the later argument win:
+        #
+        # promotion:
+        #   - b: 2
+        result = Snippr::MetaData.extract([:content], TEST_CONTENT_WITH_MERGE)
+        expect(result.second).to eq({"tracking"=>{"promotion"=>[{"b"=>2}, {"a"=>1}]}, "_include"=>["merge/array1", "merge/array2"]})
+      end
     end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snippr
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.17.0
 platform: ruby
 authors:
 - Daniel Harrington
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -109,6 +109,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -158,6 +159,8 @@ files:
 - spec/fixtures/include/main.snip
 - spec/fixtures/include/test.snip
 - spec/fixtures/include/test2.snip
+- spec/fixtures/merge/array1.snip
+- spec/fixtures/merge/array2.snip
 - spec/fixtures/meta/broken.snip
 - spec/fixtures/meta/onlyContent_de.snip
 - spec/fixtures/meta/withContent.snip
@@ -237,6 +240,8 @@ test_files:
 - spec/fixtures/include/main.snip
 - spec/fixtures/include/test.snip
 - spec/fixtures/include/test2.snip
+- spec/fixtures/merge/array1.snip
+- spec/fixtures/merge/array2.snip
 - spec/fixtures/meta/broken.snip
 - spec/fixtures/meta/onlyContent_de.snip
 - spec/fixtures/meta/withContent.snip