snippr 0.3.0 → 0.13.1

data/spec/fixtures/meta/withContentNoNewline.snip

@@ -0,0 +1,4 @@
+---
+description: Die mit dem Fluegli
+keywords: blau Mobilfunk GmbH, blau.de, blauworld, handy, sim
+--- <p>So meta!</p>

data/spec/fixtures/meta/withNoContent.snip

@@ -0,0 +1,4 @@
+---
+description: Die mit dem Fluegli
+keywords: blau Mobilfunk GmbH, blau.de, blauworld, handy, sim
+---

data/spec/fixtures/withUnderscore/andUnderscore/aSnippet.snip

@@ -0,0 +1 @@
+an underscored snippet with param {param}

data/spec/fixtures/withViewHelperMethod.snip

@@ -0,0 +1 @@
+with helper *{view.helper_method("TEST")}*

data/spec/snippr/i18n_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe Snippr::I18n do
+
+  describe "enabled" do
+
+    it "should store the enabled state" do
+      subject.enabled = nil
+      subject.enabled?.should == false
+      subject.enabled = true
+      subject.enabled?.should == true
+    end
+
+  end
+
+  describe "locale" do
+
+    it "should return an empty string when I18n is not enabled" do
+      subject.enabled = false
+      subject.locale.should == ''
+    end
+
+    it "should return the locale string when I18n is enabled" do
+      subject.enabled = true
+      subject.locale.should == "_#{I18n.locale}"
+    end
+
+  end
+
+end

data/spec/snippr/links_spec.rb

@@ -0,0 +1,137 @@
+require "spec_helper"
+
+describe Snippr::Links do
+
+  describe "adjust_urls_except" do
+
+    it "should default to [/^#/, /^[a-z]+:/i]" do
+      subject.adjust_urls_except = nil
+      subject.adjust_urls_except.should == [/^#/, /^[a-z]+:/i]
+    end
+
+    it "should store exceptions" do
+      subject.adjust_urls_except = [/^cms.*/]
+      subject.adjust_urls_except.should == [/^cms.*/]
+    end
+
+  end
+
+  describe ".adjust_link" do
+
+    it "should return an a without href unchanged" do
+      subject.adjust_link('<a name="headline"/>').should == '<a name="headline"/>'
+    end
+
+    it "should adjust the href to the adjustd_url" do
+      subject.expects(:adjust_url).with('url').returns('adjustd_url')
+      subject.adjust_link('<a onclick="return true;" href="url" class="link">test</a>').should == '<a onclick="return true;" href="adjustd_url" class="link">test</a>'
+    end
+
+    it "should add an onclick when href starts with popup:" do
+      subject.expects(:adjust_url).with('popup_url').returns('adjustd_url')
+      subject.adjust_link('<a href="popup:popup_url" class="link">test</a>').should == '<a href="adjustd_url" class="link" onclick="if (typeof popup == \'undefined\') { return true; } else { popup(this); return false; }">test</a>'
+    end
+
+    it "should replace an existing onclick when href starts with popup:" do
+      subject.expects(:adjust_url).with('url').returns('adjustd_url')
+      subject.adjust_link('<a onclick="return true;" href="popup://url" class="link">test</a>').should == '<a onclick="if (typeof popup == \'undefined\') { return true; } else { popup(this); return false; }" href="adjustd_url" class="link">test</a>'
+    end
+
+  end
+
+  describe ".adjust_url" do
+
+    before do
+      subject.stubs(:relative_url_root).returns('/root/')
+    end
+
+    it "should leave absolute links (http) as is" do
+      subject.adjust_url('http://www.blaulabs.de').should == 'http://www.blaulabs.de'
+    end
+
+    it "should leave absolute links (https) as is" do
+      subject.adjust_url('https://www.blaulabs.de').should == 'https://www.blaulabs.de'
+    end
+
+    it "should leave special links (mailto) as is" do
+      subject.adjust_url('mailto:info@blau.de').should == 'mailto:info@blau.de'
+    end
+
+    it "should convert relative links to server absolute links" do
+      subject.adjust_url('relative.html').should == '/root/relative.html'
+    end
+
+    it "should convert app absolute links to server absolute links" do
+      subject.adjust_url('/absolute.html').should == '/root/absolute.html'
+    end
+
+    it "should leave internal links (#) as is" do
+      subject.adjust_url('#aname').should == '#aname'
+    end
+
+    it "should convert links excepted in next test to server absolute links" do
+      subject.adjust_url('/cms/excepted.html').should == '/root/cms/excepted.html'
+    end
+
+    it "should leave server absolute links as is" do
+      subject.adjust_url('/root/bla/absolute.html').should == '/root/bla/absolute.html'
+    end
+
+    it "should leave excepted links as is" do
+      subject.adjust_urls_except << /^\/cms\//
+      subject.adjust_url('/cms/excepted.html').should == '/cms/excepted.html'
+    end
+
+  end
+
+  describe ".relative_url_root" do
+
+    it "should return / without rails" do
+      subject.relative_url_root.should == '/'
+    end
+
+    context "with rails" do
+
+      before do
+        module ::ActionController; class Base; end; end
+      end
+
+      after do
+        Object.send :remove_const, :ActionController
+      end
+
+      it "should return / with relative_url_root set to nil" do
+        ActionController::Base.stubs(:config).returns(stub :relative_url_root => nil)
+        subject.relative_url_root.should == '/'
+      end
+
+      it "should return / with relative_url_root set to empty string" do
+        ActionController::Base.stubs(:config).returns(stub :relative_url_root => '')
+        subject.relative_url_root.should == '/'
+      end
+
+      it "should return / with relative_url_root set to /" do
+        ActionController::Base.stubs(:config).returns(stub :relative_url_root => '/')
+        subject.relative_url_root.should == '/'
+      end
+
+      it "should return /root/ with relative_url_root set to root" do
+        ActionController::Base.stubs(:config).returns(stub :relative_url_root => 'root')
+        subject.relative_url_root.should == '/root/'
+      end
+
+      it "should return /root/ with relative_url_root set to /root" do
+        ActionController::Base.stubs(:config).returns(stub :relative_url_root => '/root')
+        subject.relative_url_root.should == '/root/'
+      end
+
+      it "should return /root/ with relative_url_root set to /root/" do
+        ActionController::Base.stubs(:config).returns(stub :relative_url_root => '/root/')
+        subject.relative_url_root.should == '/root/'
+      end
+
+    end
+
+  end
+
+end

data/spec/snippr/normalizer/camelizer_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe Snippr::Normalizer::Camelizer do
+
+  it "should leave a string as is" do
+    subject.normalize("blaHui_ja").should == "blaHui_ja"
+  end
+
+  it "should lower camelize a symbol" do
+    subject.normalize(:symbol_with_separators).should == "symbolWithSeparators"
+  end
+
+end

data/spec/snippr/normalizer/de_rester_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe Snippr::Normalizer::DeRester do
+
+  {
+    "show" => "show",
+    "destroy" => "show",
+    "new" => "new",
+    "create" => "new",
+    "edit" => "edit",
+    "update" => "edit",
+    :show => "show",
+    :destroy => "show",
+    :new => "new",
+    :create => "new",
+    :edit => "edit",
+    :update => "edit"
+  }.each do |replace, with|
+    it "should replace #{replace.inspect} in a path with #{with.inspect}" do
+      subject.normalize(replace).should == with
+    end
+  end
+
+end

data/spec/snippr/normalizer_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Snippr::Normalizer do
+
+  describe ".normalizers" do
+
+    it "should be an array" do
+      subject.normalizers.should be_an(Array)
+    end
+
+    it "should have a set of default normalizers" do
+      normalizers = subject.normalizers
+      normalizers.size.should == 1
+      normalizers[0].should be_a(Snippr::Normalizer::Camelizer)
+    end
+
+  end
+
+  describe ".normalize" do
+
+    before do
+      subject.normalizers << Snippr::Normalizer::DeRester.new # add a second normalizer to ensure chain behaviour
+    end
+
+    after do
+      subject.normalizers.pop # remove second normalizer
+    end
+
+    it "should call normalize on all normalizers, passing the path element between them and returning the last result" do
+      seq = sequence "normalizers"
+      subject.normalizers.each_with_index do |normalizer, i|
+        normalizer.should respond_to(:normalize)
+        normalizer.expects(:normalize).with(i.to_s).returns((i + 1).to_s).in_sequence(seq)
+      end
+      subject.normalize('0').should == subject.normalizers.size.to_s
+    end
+
+  end
+
+end

data/spec/snippr/path_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+describe Snippr::Path do
+
+  describe "path" do
+
+    it "should store the path" do
+      subject.path = nil
+      subject.path.should == ''
+      subject.path = 'path'
+      subject.path.should == 'path'
+    end
+
+    # TODO test JVM path? [thomas, 2010-08-26]
+
+  end
+
+  describe ".normalize_name" do
+
+    it "should call Snippr::Normalizer.normalize with all names and return normalized result" do
+      seq = sequence "normalizers"
+      Snippr::Normalizer.expects(:normalize).with("a").in_sequence(seq).returns("AA")
+      Snippr::Normalizer.expects(:normalize).with(:b).in_sequence(seq).returns("BB")
+      subject.normalize_name("a", :b).should == "AA/BB"
+    end
+
+  end
+
+  describe ".path_from_name" do
+
+    before do
+      subject.path = 'path'
+    end
+
+    it "should join path and name (with extension)" do
+      subject.path_from_name('name', 'snip').should == 'path/name.snip'
+    end
+
+    it "should join path and name (without extension)" do
+      subject.path_from_name('file').should == 'path/file'
+    end
+
+  end
+
+  describe ".list" do
+
+    context "without I18n" do
+
+      before do
+        Snippr::I18n.enabled = false
+      end
+
+      it "should return a list of all snippr names" do
+        subject.list(:topup).should == [:some_error, :success]
+      end
+
+      it "should return an empty array for non existant dirs" do
+        subject.list(:doesnotexist).should == []
+      end
+
+    end
+
+    context "with I18n" do
+
+      before do
+        Snippr::I18n.enabled = true
+      end
+
+      it "should return a list of all snippr names of the current locale (de)" do
+        I18n.locale = :de
+        subject.list(:i18n).should == [:list, :shop]
+      end
+
+      it "should return a list of all snippr names of the current locale (en)" do
+        I18n.locale = :en
+        subject.list(:i18n).should == [:shop]
+      end
+
+      it "should return an empty array for non existant dirs" do
+        subject.list(:doesnotexist).should == []
+      end
+
+    end
+
+  end
+
+end

data/spec/snippr/processor/dynamics_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Snippr::Processor::Dynamics do
+
+  class Klass
+    def method; "METHOD"; end
+    def method2(param); "METHOD WITH #{param}"; end
+    def method3(param1, param2); "METHOD WITH #{param1} AND #{param2}"; end
+  end
+
+  it "should replace placeholders with dynamic values" do
+    today = Date.today
+    subject.process('Your topup of {topup_amount} at {date_today} was successful.', {
+      :topup_amount => "15,00 €",
+      :date_today   => today
+    }).should == "Your topup of 15,00 € at #{today} was successful."
+  end
+
+  it "parses multi-line parameters" do
+    tpl = "An instance {var.method2(\"PARAM\t\nETER\")}"
+    subject.process(tpl, :var => Klass.new).should == "An instance METHOD WITH PARAMETER"
+  end
+
+  it "Does not kill all whitespace" do
+    tpl = "An instance {var.method2(\"PART1\t\n SPACE PART2\")}"
+    subject.process(tpl, :var => Klass.new).should == "An instance METHOD WITH PART1 SPACE PART2"
+  end
+
+  it "should allow calling methods on placeholders" do
+    tpl = "An instance {var.method()}"
+    subject.process(tpl, :var => Klass.new).should == "An instance METHOD"
+  end
+
+  it "should allow calling methods with parameters on placeholders" do
+    tpl = 'An instance {var.method2("PARAMETER")}'
+    subject.process(tpl, :var => Klass.new).should == "An instance METHOD WITH PARAMETER"
+  end
+
+  it "should allow calling methods with multiple parameters on placeholders" do
+    tpl = 'An instance {var.method3("PARAMETER1","PARAMETER2")}'
+    subject.process(tpl, :var => Klass.new).should == "An instance METHOD WITH PARAMETER1 AND PARAMETER2"
+  end
+
+  it "should keep 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
+  end
+
+end

data/spec/snippr/processor/functions_spec.rb

@@ -0,0 +1,72 @@
+require "spec_helper"
+
+describe Snippr::Processor::Functions do
+
+  describe "#cmd_snip" do
+
+    it "should include snips inside of snips" do
+      subject.process('Include a {snip:home} inside a snip').should == "Include a <!-- starting snippr: home -->\n<p>Home</p>\n<!-- closing snippr: home --> inside a snip"
+    end
+
+
+    it "should pass parameters to the include" do
+      subject.process('Include a {snip:topup/success} inside a snip', {
+        :topup_amount => '10',
+        :date_today => '123'
+      }).should == "Include a <!-- starting snippr: topup/success -->\n<p>You're topup of 10 at 123 was successful.</p>\n<!-- closing snippr: topup/success --> inside a snip"
+    end
+
+    it "should allow additional parameters to be passed to the included snippet" do
+      subject.process('Include a {snip:topup/success,topup_amount=99} inside a snip', {
+        :date_today => '123'
+      }).should == "Include a <!-- starting snippr: topup/success -->\n<p>You're topup of 99 at 123 was successful.</p>\n<!-- closing snippr: topup/success --> inside a snip"
+    end
+
+    it "should allow additional parameters of the snip call to override parent options" do
+      subject.process('Include a {snip:topup/success,topup_amount=99} inside a snip', {
+        :date_today => '123',
+        :topup_amount => '1'
+      }).should == "Include a <!-- starting snippr: topup/success -->\n<p>You're topup of 99 at 123 was successful.</p>\n<!-- closing snippr: topup/success --> inside a snip"
+    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
+        I18n.locale = :de
+      end
+
+      after do
+        Snippr::Normalizer.normalizers.pop # remove second normalizer
+      end
+
+      it "should work" do
+        subject.process("{snip:home/show/blauappOverviewBoxMobile}").should == "<!-- missing snippr: home/show/blauappOverviewBoxMobile_de -->"
+      end
+
+    end
+
+  end
+
+  describe "#hashify" do
+
+    it "should process a single argument with no value as default" do
+      subject.send(:hashify, "test").should == { :default => "test" }
+    end
+
+    it "should process a single argument with key and value" do
+      subject.send(:hashify, "key=value").should == { :key => "value" }
+    end
+
+    it "should process multiple arguments delimited by comma" do
+      subject.send(:hashify, "key=value,key2=value2").should == { :key => "value", :key2 => "value2" }
+    end
+
+    it "should process a combination of all arguments" do
+      subject.send(:hashify, "default,key=value,key2=value2").should == { :default => 'default', :key => "value", :key2 => "value2" }
+    end
+
+  end
+
+end