snippr 0.15.19 → 0.15.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 566f9eaf54ec97f8798e00a5c6f39fd8025d70cf
-  data.tar.gz: dc5b9310b774e6867a160e5cccbceea2677f6430
+  metadata.gz: cd5e914f8d8ff99c134b3c0e3ae285bd4d7579c9
+  data.tar.gz: a4f5bb34d2ddf5b38704bdee282b5e2d92a9e21b
 SHA512:
-  metadata.gz: a77b2ea7277bfe2c8865730e08499886a805ac65c25bac36459778c14b817e27783a6d890aa951d45753f58efa6309d8980dbeb43c04b699975ef88d27632d89
-  data.tar.gz: 5a31458383d4c464f03ec25ff141f4839c878bd98124444a0fe0655f9ee61f38b172a0d493a5b7d351ca6fe31982e4bd05ed9a7c0b5871e487bcb7de3d36c016
+  metadata.gz: 4989ca6050828708d6dc54134185ead7e052913913a7b3f90586f3430f41d841bc9aa7f191ca1c3b05ea224ebfa25383876696ab7ba96d6e9ed4017d9174a899
+  data.tar.gz: 203ed4d06059918c6eea51c21b47f52e37ed0e5991650bf14b4cd01bc6d026fb331b51ee4ca341baeba00d54fc199dc738943202698a6c4508dfc4261e23238d

data/README.md

@@ -98,6 +98,9 @@ If that is not what you want and you want to force snippr to call the method on
 That would result in an ``NoMethodError``.
 This can be very useful if you call a method on a proxy object with dynamic method generation that isn't so polite as to implement a meaningful ``respond_to?`` or ``respond_to_missing?`` (eg. The Draper::HelperProxy)
 
+### Defaulting an empty {snippet_variable}
+You can use `{variable|default_value}` to default this snippet to a value, here it would result in `default_value`. This also works on method invocations.
+
 ### Meta Infos
 
 A snippet can not only hold content but also meta infos for this snippet.
@@ -127,12 +130,21 @@ Or with Segmentfilter:
 
 ### Including snippr files inside other files
 
+    {snip:absolute/path/from/snippr/path}
+    {snip:./relative/path/from/including/snippet}
+    {snip:../relative/path/from/including/snippet}
+
 A snippr file can include another snippr file:
 
     This snippr file includes another {snip:filepath/of/snip} file
 
 This will cause `filepath/of/snip.snip` to be included in place.
 
+You can also include relative to the including snippet. A snippet in `some/deep/path/deep.snip` containing `{snip:../../twoDown}` will include `some/twoDown.snip`.  
+Also `{snip:./further/we/go}` would include `some/deep/path/further/we/go.snip`.
+
+Note that it is not allowed to go outside of the designated `Snippr.path`: `{snip:../../../etc/password}` would then output `<!-- missing snippr: ./etc/password -->` wven if the file exists.
+
 Dynamic values of the parent snip will be accessable inside the included snip file.
 
 You can pass additional dynamic values when using `{snip}`. These will override any parent parameter.

data/lib/snippr/processor/dynamics.rb

@@ -9,20 +9,48 @@ module Snippr
     class Dynamics
 
       def process(content, opts = {})
-        opts.inject(content) do |c, pv|
-          placeholder, value = pv
-          c.gsub(/\{(!?)#{placeholder}(?:\.(.*?)\(["]?(.*?)["]?\))?\}/m) do |match|
-            if $2 && (value.respond_to?($2) || $1 == "!")
-              method = $2
-              params = ($3 || "").gsub(/[\t\r\n]/,"").split("\",\"")
-              value.send(method, *params).to_s
-            elsif $2
-              match
-            else
-              value.to_s
-            end
+        matches = []
+        # convert array of arrays to array of matchdata
+        content.scan(regex) { matches << $~ }
+
+        matches.each do |match_data|
+          replacement = match_data[:all]
+          value = opts[match_data[:placeholder].to_sym]
+          if match_data[:method] && (value.respond_to?(match_data[:method]) || match_data[:respond_to_check] == "!")
+            params = (match_data[:parameters] || "").gsub(/[\t\r\n]/,"").split("\",\"")
+            replacement = value.send(match_data[:method], *params).to_s
+          elsif match_data[:method]
+            replacement = match_data[:all]
+          else
+            replacement = value.to_s
           end
+
+          # default set?
+          replacement = match_data[:default_when_empty].strip if replacement.empty? && match_data[:default_when_empty]
+
+          content.gsub!(match_data[:all], replacement)
         end
+        content
+      end
+
+      private
+
+      def regex
+        %r{
+        (?<all>                           # group caputing all
+        \{                                # start of dynamic value
+        (?<respond_to_check>!?)           # use ! to call the method on an object even if :respond_to fails
+        (?<placeholder>.*?)               # variable holding value or object
+        (?:\.(?<method>.*?)               # about to call an method on the 'placeholder'
+        \(                                # non-optional bracket to merk method call
+        ["]?                              # optional opening double quote
+        (?<parameters>.*?)                # paramters for method call
+        ["]?                              # optional closing double quote
+        \))?                              # mandatory closing bracket and group end
+        (\|(?<default_when_empty>.*?))?   # optional default value when snippet content empty
+        \}                                # and thats it
+        )                                 # end all group
+        }xm
       end
 
     end

data/lib/snippr/processor/functions.rb

@@ -18,12 +18,13 @@ module Snippr
         content
       end
 
-    private
+      private
 
       # expand another snip
       # {snip:path/to/snippet}
       def cmd_snip(unprocessed_content, opts, original_options)
         path = opts[:default].split("/")
+        path = recursive_include_from_path(path, opts[:_parent]) if path.first.in? [".", ".."]
         snip_content = Snippr::Snip.new(*path + [opts]).content
         unprocessed_content.gsub("{snip:#{original_options}}", snip_content)
       end
@@ -52,6 +53,14 @@ module Snippr
         options
       end
 
+      def recursive_include_from_path(path, parent)
+        target_pathname = Pathname.new(parent.pathname + path.join(File::SEPARATOR))
+        if target_pathname.to_s =~ /^#{Snippr.path}/
+          target_pathname.to_s.gsub(/^#{Snippr.path}\//, "").split(File::SEPARATOR)
+        else
+          path
+        end
+      end
     end
 
   end

data/lib/snippr/processor.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 # = Snippr::Processor
 #
 # Provides methods to process snippr content.
@@ -10,7 +11,8 @@ module Snippr
     end
 
     # Sends the given content and opts to all the configured processors and returns the result.
-    def self.process(content, opts)
+    def self.process(content, opts, including_snippet)
+      opts[:_parent] = including_snippet
       @processors.inject(content) {|c, processor| processor.process c, opts}
     end
 

data/lib/snippr/snip.rb

@@ -2,26 +2,28 @@
 # = Snippr::Snip
 #
 # Represents a single snip and provides methods to read data.
+require 'pathname'
 
 module Snippr
   class Snip
 
+    attr_reader :name, :path, :opts, :unprocessed_content, :meta, :pathname
+
     FILE_EXTENSION = 'snip'
 
     def initialize(*names)
       names = strip_empty_values(names)
       @opts = names.last.kind_of?(Hash) ? names.pop : {}
       @opts.symbolize_keys!
-      @name = "#{Path.normalize_name(*names)}#{ I18n.locale(@opts[:i18n]) }"
+      @name = "#{Path.normalize_name(*names)}#{I18n.locale(@opts[:i18n])}"
       @path = Path.path_from_name @name, (@opts[:extension] || FILE_EXTENSION)
       @unprocessed_content = raw_content
       @meta = {}
+      @pathname = Pathname.new(@path).dirname
       content
       after_initialize
     end
 
-    attr_reader :name, :path, :opts, :unprocessed_content, :meta
-
     # Returns the processed and decorated content.
     def content
       @content ||= begin
@@ -30,7 +32,7 @@ module Snippr
         else
           content = SegmentParser.new(raw_content).content
           @unprocessed_content, @meta = MetaData.extract(name, content)
-          content = Processor.process @unprocessed_content, opts
+          content = Processor.process @unprocessed_content, opts, self
           "<!-- starting snippr: #{name} -->\n#{content}\n<!-- closing snippr: #{name} -->"
         end
       end

data/lib/snippr.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+require 'active_support'
 require 'active_support/core_ext'
 
 require 'snippr/snippr'

data/snippr.gemspec

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

data/spec/fixtures/snip/alsoInBase.snip

@@ -0,0 +1 @@
+ALSO IN BASE DIR

data/spec/fixtures/snip/base.snip

@@ -0,0 +1 @@
+Base includes {snip:./alsoInBase} and {snip:./subdir/snippet}

data/spec/fixtures/snip/subdir/snippet.snip

@@ -0,0 +1 @@
+IN SUBDIR

data/spec/fixtures/snip/subdir/subdir2/mixed.snip

@@ -0,0 +1 @@
+LIKE {snip:../././../base}

data/spec/fixtures/snip/subdir/subdir2/pastSnipprPath.snip

@@ -0,0 +1 @@
+ERROR {snip:../../../../base}

data/spec/fixtures/snip/subdir/subdir2/snippet.snip

@@ -0,0 +1 @@
+LIKE {snip:../../base}

data/spec/snippr/processor/dynamics_spec.rb

@@ -7,7 +7,8 @@ describe Snippr::Processor::Dynamics do
     def method; "METHOD"; end
     def method2(param); "METHOD WITH #{param}"; end
     def method3(param1, param2); "METHOD WITH #{param1} AND #{param2}"; end
-  end
+  def method4; ""; end
+end
 
   it "replaces placeholders with dynamic values" do
     today = Date.today
@@ -43,8 +44,7 @@ describe Snippr::Processor::Dynamics do
   end
 
   it "keeps the {snip} if calling a method but the method is not defined" do
-    tpl = "An instance {var.method_not_exist()}"
-    subject.process(tpl, :var => Klass.new).should == tpl
+  subject.process("An instance {var.method_not_exist()}", :var => Klass.new).should == "An instance {var.method_not_exist()}"
   end
 
   it "calls a bang(!) method even if the receiver does not respond_to the method" do
@@ -52,4 +52,14 @@ describe Snippr::Processor::Dynamics do
     lambda { subject.process(tpl, :var => Klass.new) }.should raise_error(NoMethodError)
   end
 
+  it "defaults the value if the content is empty" do
+    tpl = "{empty|default}"
+    expect(subject.process(tpl, empty: "")).to eq "default"
+  end
+
+  it "defaults the value if the content is  present" do
+    tpl = "{var.method4()|default2}"
+    expect(subject.process(tpl, var: Klass.new )).to eq "default2"
+  end
+
 end

data/spec/snippr/processor/functions_spec.rb

@@ -36,8 +36,35 @@ describe Snippr::Processor::Functions do
       }).should == "Include a <!-- starting snippr: topup/success -->\n<p>You're topup of A B C at 123 was successful.</p>\n<!-- closing snippr: topup/success --> inside a snip"
     end
 
-    context "for home/show/blauappOverviewBoxMobile (regression test)" do
+    context "relative inclusion via {snip:./name}" do
+      context "via {snip:../../name}" do
+        it "allows inclusion" do
+          snippet = Snippr.load(:snip, :subdir, :subdir2, :snippet)
+          expect(snippet.content).to eq "<!-- starting snippr: snip/subdir/subdir2/snippet -->\nLIKE <!-- starting snippr: snip/base -->\nBase includes <!-- starting snippr: snip/alsoInBase -->\nALSO IN BASE DIR\n<!-- closing snippr: snip/alsoInBase --> and <!-- starting snippr: snip/subdir/snippet -->\nIN SUBDIR\n<!-- closing snippr: snip/subdir/snippet -->\n<!-- closing snippr: snip/base -->\n<!-- closing snippr: snip/subdir/subdir2/snippet -->"
+        end
+
+        it "returns a missing snippet when the inclusion recurses past the Snippr.path" do
+          snippet = Snippr.load(:snip, :subdir, :subdir2, :past_snippr_path)
+          expect(snippet.content).to eq "<!-- starting snippr: snip/subdir/subdir2/pastSnipprPath -->\nERROR <!-- missing snippr: ../../../../base -->\n<!-- closing snippr: snip/subdir/subdir2/pastSnipprPath -->"
+        end
+      end
 
+      context "via {snip:./name}" do
+        it "allows relative inclusion via {snip:../name}" do
+          snippet = Snippr.load(:snip, :base)
+          expect(snippet.content).to eq "<!-- starting snippr: snip/base -->\nBase includes <!-- starting snippr: snip/alsoInBase -->\nALSO IN BASE DIR\n<!-- closing snippr: snip/alsoInBase --> and <!-- starting snippr: snip/subdir/snippet -->\nIN SUBDIR\n<!-- closing snippr: snip/subdir/snippet -->\n<!-- closing snippr: snip/base -->"
+        end
+      end
+
+      context "mixed {snip:../././../name}" do
+        it "allows inclusion" do
+          snippet = Snippr.load(:snip, :subdir, :subdir2, :mixed)
+          expect(snippet.content).to eq "<!-- starting snippr: snip/subdir/subdir2/mixed -->\nLIKE <!-- starting snippr: snip/base -->\nBase includes <!-- starting snippr: snip/alsoInBase -->\nALSO IN BASE DIR\n<!-- closing snippr: snip/alsoInBase --> and <!-- starting snippr: snip/subdir/snippet -->\nIN SUBDIR\n<!-- closing snippr: snip/subdir/snippet -->\n<!-- closing snippr: snip/base -->\n<!-- closing snippr: snip/subdir/subdir2/mixed -->"
+        end
+      end
+    end
+
+    context "for home/show/blauappOverviewBoxMobile (regression test)" do
       before do
         Snippr::Normalizer.normalizers << Snippr::Normalizer::DeRester.new # add a second normalizer to ensure chain behaviour
         Snippr::I18n.enabled = true
@@ -51,7 +78,6 @@ describe Snippr::Processor::Functions do
       it "works" do
         subject.process("{snip:home/show/blauappOverviewBoxMobile}").should == "<!-- missing snippr: home/show/blauappOverviewBoxMobile_de -->"
       end
-
     end
 
   end

data/spec/snippr/processor_spec.rb

@@ -24,11 +24,12 @@ describe Snippr::Processor do
   describe ".process" do
 
     it "calls process on all processors, passing the content between them and returning the last result" do
+      parent = Snippr::Snip.new
       subject.processors.each_with_index do |processor, i|
         processor.should respond_to(:process)
-        expect(processor).to receive(:process).with(i.to_s, {'1' => '2'}).and_return((i + 1).to_s)
+        expect(processor).to receive(:process).with(i.to_s, {'1' => '2', :_parent => parent}).and_return((i + 1).to_s)
       end
-      subject.process('0', {'1' => '2'}).should == subject.processors.size.to_s
+      subject.process('0', {'1' => '2'}, parent).should == subject.processors.size.to_s
     end
 
   end

data/spec/snippr/snip_spec.rb

@@ -127,12 +127,12 @@ describe Snippr::Snip do
   describe "content" do
 
     it "calls Snippr::Processor.process with opts and return decorated result" do
-      Snippr::Processor.should_receive(:process).with('<p>Home</p>', {:a => :b}).and_return('processed')
+      Snippr::Processor.should_receive(:process).with('<p>Home</p>', {:a => :b}, anything()).and_return('processed')
       Snippr::Snip.new(:home, :a => :b).content.should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
     end
 
     it "stores the processed data instead of processing it again" do
-      Snippr::Processor.should_receive(:process).with('<p>Home</p>', {:a => :b}).once.and_return('processed')
+      Snippr::Processor.should_receive(:process).with('<p>Home</p>', {:a => :b}, anything()).once.and_return('processed')
       snip = Snippr::Snip.new(:home, :a => :b)
       snip.content.should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
       snip.content.should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"

data/spec/snippr/view_helper_spec.rb

@@ -203,7 +203,7 @@ describe Snippr::ViewHelper do
       end
 
       it "camelizes controller and action names" do
-        snippr_with_path(:a_snippet).should == "<!-- starting snippr: withUnderscore/andUnderscore/aSnippet -->\nan underscored snippet with param {param}\n<!-- closing snippr: withUnderscore/andUnderscore/aSnippet -->"
+        snippr_with_path(:a_snippet).should == "<!-- starting snippr: withUnderscore/andUnderscore/aSnippet -->\nan underscored snippet with param \n<!-- closing snippr: withUnderscore/andUnderscore/aSnippet -->"
       end
 
       it "works with a given block" do

data/spec/spec_helper.rb

@@ -5,6 +5,8 @@ require 'snippr'
 
 Bundler.require(:default, :development)
 
+I18n.enforce_available_locales = false
+
 RSpec.configure do |config|
   config.before do
     Snippr::I18n.enabled = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snippr
 version: !ruby/object:Gem::Version
-  version: 0.15.19
+  version: 0.15.21
 platform: ruby
 authors:
 - Daniel Harrington
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -161,6 +161,12 @@ files:
 - spec/fixtures/meta/withContentAndSegmentfilter.snip
 - spec/fixtures/meta/withContentNoNewline.snip
 - spec/fixtures/meta/withNoContent.snip
+- spec/fixtures/snip/alsoInBase.snip
+- spec/fixtures/snip/base.snip
+- spec/fixtures/snip/subdir/snippet.snip
+- spec/fixtures/snip/subdir/subdir2/mixed.snip
+- spec/fixtures/snip/subdir/subdir2/pastSnipprPath.snip
+- spec/fixtures/snip/subdir/subdir2/snippet.snip
 - spec/fixtures/topup/someError.snip
 - spec/fixtures/topup/success.snip
 - spec/fixtures/withBlock.snip
@@ -230,6 +236,12 @@ test_files:
 - spec/fixtures/meta/withContentAndSegmentfilter.snip
 - spec/fixtures/meta/withContentNoNewline.snip
 - spec/fixtures/meta/withNoContent.snip
+- spec/fixtures/snip/alsoInBase.snip
+- spec/fixtures/snip/base.snip
+- spec/fixtures/snip/subdir/snippet.snip
+- spec/fixtures/snip/subdir/subdir2/mixed.snip
+- spec/fixtures/snip/subdir/subdir2/pastSnipprPath.snip
+- spec/fixtures/snip/subdir/subdir2/snippet.snip
 - spec/fixtures/topup/someError.snip
 - spec/fixtures/topup/success.snip
 - spec/fixtures/withBlock.snip