snippr 0.3.0 → 0.13.1

data/spec/snippr/processor/links_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe Snippr::Processor::Links do
+
+  it "should call Snippr::Links.adjust_link with the links found and return the results" do
+    seq = sequence 'links'
+    Snippr::Links.expects(:adjust_link).with('<a href="http://www.blaulabs.de" onclick="return true;">here</a>').in_sequence(seq).returns('--here--')
+    Snippr::Links.expects(:adjust_link).with('<A class=\'link\' href="internal.html">or here</A>').in_sequence(seq).returns('--or here--')
+    subject.process('click <a href="http://www.blaulabs.de" onclick="return true;">here</a> <A class=\'link\' href="internal.html">or here</A>').should == 'click --here-- --or here--'
+  end
+
+end

data/spec/snippr/processor/wikilinks_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe Snippr::Processor::Wikilinks do
+
+  it "should call Snippr::Links.adjust_link with the links found and return the results" do
+    seq = sequence 'wikilinks'
+    Snippr::Links.expects(:adjust_link).with('<a href="http://www.blaulabs.de">here</a>').in_sequence(seq).returns('--here--')
+    Snippr::Links.expects(:adjust_link).with('<a href="internal.html">or here</a>').in_sequence(seq).returns('--or here--')
+    subject.process('click [[http://www.blaulabs.de|here]] [[internal.html|or here]]').should == 'click --here-- --or here--'
+  end
+
+end

data/spec/snippr/processor_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Snippr::Processor do
+
+  describe ".processors" do
+
+    it "should be an array" do
+      subject.processors.should be_an(Array)
+    end
+
+    it "should have a set of default processors" do
+      processors = subject.processors
+      processors.size.should == 4
+      processors[0].should be_a(Snippr::Processor::Functions)
+      processors[1].should be_a(Snippr::Processor::Dynamics)
+      processors[2].should be_a(Snippr::Processor::Links)
+      processors[3].should be_a(Snippr::Processor::Wikilinks)
+    end
+
+  end
+
+  describe ".process" do
+
+    it "should call process on all processors, passing the content between them and returning the last result" do
+      seq = sequence 'processors'
+      subject.processors.each_with_index do |processor, i|
+        processor.should respond_to(:process)
+        processor.expects(:process).with(i.to_s, {'1' => '2'}).returns((i + 1).to_s).in_sequence(seq)
+      end
+      subject.process('0', {'1' => '2'}).should == subject.processors.size.to_s
+    end
+
+  end
+
+end

data/spec/snippr/snip_spec.rb

@@ -0,0 +1,179 @@
+# -*- encoding : utf-8 -*-
+require "spec_helper"
+
+describe Snippr::Snip do
+
+  describe "initializer" do
+
+    before do
+      Snippr::Path.path = 'path'
+    end
+
+    context "without I18n" do
+
+      before do
+        Snippr::I18n.enabled = false
+      end
+
+      it "initializes name, path and opts without opts" do
+        snip = Snippr::Snip.new(:path_to_snips, :file)
+        snip.name.should == 'pathToSnips/file'
+        snip.path.should == 'path/pathToSnips/file.snip'
+        snip.opts.should == {}
+      end
+
+      it "initializes name, path and opts with opts" do
+        snip = Snippr::Snip.new(:path_to_snips, :file, :key => :value)
+        snip.name.should == 'pathToSnips/file'
+        snip.path.should == 'path/pathToSnips/file.snip'
+        snip.opts.should == {:key => :value}
+      end
+
+      it "initializes name, path and opts with given extension" do
+        snip = Snippr::Snip.new(:path_to_snips, :file, :extension => :yml)
+        snip.name.should == "pathToSnips/file"
+        snip.path.should == "path/pathToSnips/file.yml"
+        snip.opts.should == { :extension => :yml }
+      end
+
+      it "initializes name, path and opts with given i18n deactivation" do
+        snip = Snippr::Snip.new(:path_to_snips, :file, :i18n => true)
+        snip.name.should == "pathToSnips/file_#{::I18n.locale}"
+        snip.path.should == "path/pathToSnips/file_#{::I18n.locale}.snip"
+        snip.opts.should == { :i18n => true }
+      end
+
+      it "returns no double slahes in the path for nil value" do
+        snip = Snippr::Snip.new(:path_to_snips, nil ,:file)
+        snip.name.should == 'pathToSnips/file'
+        snip.path.should == 'path/pathToSnips/file.snip'
+      end
+
+      it "returns no double slahes in the path for empty string value" do
+        snip = Snippr::Snip.new(:path_to_snips, "" ,:file)
+        snip.name.should == 'pathToSnips/file'
+        snip.path.should == 'path/pathToSnips/file.snip'
+      end
+
+    end
+
+    context "with I18n" do
+
+      before do
+        Snippr::I18n.enabled = true
+      end
+
+      it "initializes name, path and opts without opts" do
+        snip = Snippr::Snip.new(:path_to_snips, :file)
+        snip.name.should == "pathToSnips/file_#{::I18n.locale}"
+        snip.path.should == "path/pathToSnips/file_#{::I18n.locale}.snip"
+        snip.opts.should == {}
+      end
+
+      it "initializes name, path and opts with opts" do
+        snip = Snippr::Snip.new(:path_to_snips, :file, :key => :value)
+        snip.name.should == "pathToSnips/file_#{::I18n.locale}"
+        snip.path.should == "path/pathToSnips/file_#{::I18n.locale}.snip"
+        snip.opts.should == {:key => :value}
+      end
+
+      it "initializes name, path and opts with given extension" do
+        snip = Snippr::Snip.new(:path_to_snips, :file, :extension => :yml)
+        snip.name.should == "pathToSnips/file_#{::I18n.locale}"
+        snip.path.should == "path/pathToSnips/file_#{::I18n.locale}.yml"
+        snip.opts.should == { :extension => :yml }
+      end
+
+      it "initializes name, path and opts with given i18n deactivation" do
+        snip = Snippr::Snip.new(:path_to_snips, :file, :i18n => false)
+        snip.name.should == "pathToSnips/file"
+        snip.path.should == "path/pathToSnips/file.snip"
+        snip.opts.should == { :i18n => false }
+      end
+    end
+
+
+  end
+
+  describe "#unprocessed_content" do
+
+    it "reads an existing snip" do
+      Snippr::Snip.new(:home).unprocessed_content.should == '<p>Home</p>'
+    end
+
+    it "stores the read data instead of reading it again" do
+      File.expects(:read).once.returns('data')
+      snip = Snippr::Snip.new(:home)
+      snip.unprocessed_content.should == 'data'
+      snip.unprocessed_content.should == 'data'
+    end
+
+    it "returns an empty string on missing snips" do
+      File.expects(:read).never
+      Snippr::Snip.new(:doesnotexist).unprocessed_content.should == ''
+    end
+
+    it "strips the read content" do
+      Snippr::Snip.new(:empty).unprocessed_content.should == ''
+    end
+
+  end
+
+  [:content, :to_s].each do |method|
+
+    describe "##{method}" do
+
+      it "calls Snippr::Processor.process with opts and return decorated result" do
+        Snippr::Processor.expects(:process).with('<p>Home</p>', {:a => :b}).returns('processed')
+        Snippr::Snip.new(:home, :a => :b).send(method).should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
+      end
+
+      it "stores the processed data instead of processing it again" do
+        Snippr::Processor.expects(:process).with('<p>Home</p>', {:a => :b}).once.returns('processed')
+        snip = Snippr::Snip.new(:home, :a => :b)
+        snip.send(method).should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
+        snip.send(method).should == "<!-- starting snippr: home -->\nprocessed\n<!-- closing snippr: home -->"
+      end
+
+      it "doesn't call Snippr::Processor.process and return missing string" do
+        Snippr::Processor.expects(:process).never
+        Snippr::Snip.new(:doesnotexist, :a => :b).send(method).should == '<!-- missing snippr: doesnotexist -->'
+      end
+
+    end
+
+  end
+
+  describe "#missing?" do
+
+    it "returns true when the snip isn't there" do
+      Snippr::Snip.new(:doesnotexist).should be_missing
+    end
+
+    it "returns false when the snip is there but empty" do
+      Snippr::Snip.new(:empty).should_not be_missing
+    end
+
+    it "returns false when the snip is there and has content" do
+      Snippr::Snip.new(:home).should_not be_missing
+    end
+
+  end
+
+  describe "#empty?" do
+
+    it "returns true when the snip isn't there" do
+      Snippr::Snip.new(:doesnotexist).should be_empty
+    end
+
+    it "returns false when the snip is there but empty" do
+      Snippr::Snip.new(:empty).should be_empty
+    end
+
+    it "returns false when the snip is there and has content" do
+      Snippr::Snip.new(:home).should_not be_empty
+    end
+
+  end
+
+end

data/spec/snippr/snippr_spec.rb

@@ -1,79 +1,84 @@
 require "spec_helper"
 
 describe Snippr do
-  before :all do
-    snippr_path = File.join File.dirname(__FILE__), "..", "fixtures"
-    
-    if RUBY_PLATFORM =~ /java/
-      Snippr::Path::JavaLang::System.set_property Snippr::Path::JVMProperty, snippr_path
-    else
-      Snippr.path = snippr_path
-    end
-    Snippr.i18n = false
-  end
 
-  it "should return the content of a snippr" do
-    Snippr.load(:home).should include("<p>Home</p>")
+  it "should delegate path to Snippr::Path.path" do
+    Snippr::Path.should respond_to(:path)
+    Snippr::Path.expects(:path).returns('path')
+    subject.path.should == 'path'
   end
 
-  it "should return the content a snippr from a subfolder" do
-    Snippr.load("tariff/einheit").should include("<p>tariff: einheit</p>")
+  it "should delegate path= to Snippr::Path.path=" do
+    Snippr::Path.should respond_to(:path=)
+    Snippr::Path.expects(:path=).with('path')
+    subject.path = 'path'
   end
 
-  it "should return the content a snippr from a subfolder specified via multiple arguments" do
-    Snippr.load(:tariff, :einheit).should include("<p>tariff: einheit</p>")
+  it "should delegate i18n? to Snippr::I18n.enabled?" do
+    Snippr::I18n.should respond_to(:enabled?)
+    Snippr::I18n.expects(:enabled?).returns(true)
+    subject.i18n?.should == true
   end
 
-  it "should convert snake_case Symbols to lowerCamelCase Strings" do
-    Snippr.load(:topup, :some_error).should include("<p>Some error occurred.</p>")
+  it "should delegate i18n= to Snippr::I18n.enabled=" do
+    Snippr::I18n.should respond_to(:enabled=)
+    Snippr::I18n.expects(:enabled=).with(true)
+    subject.i18n = true
   end
 
-  it "should wrap the snippr in descriptive comments" do
-    Snippr.load(:home).should ==
-      "<!-- starting snippr: home -->\n" <<
-      "<p>Home</p>\n" <<
-      "<!-- closing snippr: home -->"
+  it "should delegate adjust_urls_except? to Snippr::Links.adjust_urls_except" do
+    Snippr::Links.should respond_to(:adjust_urls_except)
+    Snippr::Links.expects(:adjust_urls_except).returns([1])
+    subject.adjust_urls_except.should == [1]
   end
 
-  it "should replace placeholders with dynamic values" do
-    snippr = Snippr.load :topup, :success, :topup_amount => "15,00 &euro;", :date_today => Date.today
-    snippr.should include("<p>You're topup of 15,00 &euro; at #{Date.today} was successful.</p>")
+  it "should delegate adjust_urls_except= to Snippr::Links.adjust_urls_except=" do
+    Snippr::Links.should respond_to(:adjust_urls_except=)
+    Snippr::Links.expects(:adjust_urls_except=).with([2])
+    subject.adjust_urls_except = [2]
   end
 
-  it "should return a fallback wrapped in descriptive comments for missing snipprs" do
-    Snippr.load(:doesnotexist).should ==
-      "<!-- starting snippr: doesnotexist -->\n" <<
-      "<samp class=\"missing snippr\" />\n" <<
-      "<!-- closing snippr: doesnotexist -->"
-  end
-  
-  it "should convert wiki links to html links" do
-    Snippr.load(:wiki).should == 
-      "<!-- starting snippr: wiki -->\n" <<
-      "<p>Click <a href=\"http://www.blaulabs.de\">here with blanks</a>.</p>\n" <<
-      "<!-- closing snippr: wiki -->"
-  end
+  context "the logger" do
 
-  describe "I18n" do
-    before { Snippr.i18n = true }
+    after do
+      Snippr.logger = nil
+    end
+
+    it "can be configured" do
+      Snippr.logger = :logger
+      Snippr.logger.should == :logger
+    end
 
-    it "should prepend the current locale prefixed with a '_' to a snippr file" do
-      I18n.locale = :de
-      
-      Snippr.load(:i18n, :shop).should ==
-        "<!-- starting snippr: i18n/shop_de -->\n" <<
-        "<p>Willkommen in unserem Shop.</p>\n" <<
-        "<!-- closing snippr: i18n/shop_de -->"
+    it "defaults to a custom logger" do
+      Snippr.logger.should be_a(Logger)
     end
 
-    it "should also work for other locales" do
-      I18n.locale = :en
-      
-      Snippr.load(:i18n, :shop).should ==
-        "<!-- starting snippr: i18n/shop_en -->\n" <<
-        "<p>Welcome to our shop.</p>\n" <<
-        "<!-- closing snippr: i18n/shop_en -->"
+    context "in a Rails app" do
+
+      before do
+        Rails = Class.new { def self.logger; :rails_logger end }
+      end
+
+      after do
+        Object.send(:remove_const, :Rails)
+      end
+
+      it "uses the Rails logger" do
+        Snippr.logger.should == :rails_logger
+      end
+
     end
+
+  end
+
+  it "should delegate load to Snippr::Snip.new" do
+    Snippr::Snip.expects(:new).with(:a, :b).returns('snip')
+    subject.load(:a, :b).should == 'snip'
+  end
+
+  it "should delegate list to Snippr::Path.list" do
+    Snippr::Path.expects(:list).with(:c, :d).returns([:snip])
+    subject.list(:c, :d).should == [:snip]
   end
 
 end

data/spec/snippr/view_helper_spec.rb

@@ -0,0 +1,221 @@
+# -*- encoding : utf-8 -*-
+require "spec_helper"
+
+describe Snippr::ViewHelper do
+  include Snippr::ViewHelper
+
+  describe "snippr" do
+
+    def helper_method(param)
+      "wrapppppp #{param.upcase} ppppppparw"
+    end
+
+    it "should allow calling of methods on a Rails view" do
+      snippr(:with_view_helper_method).should == "<!-- starting snippr: withViewHelperMethod -->\nwith helper *wrapppppp TEST ppppppparw*\n<!-- closing snippr: withViewHelperMethod -->"
+    end
+
+    context "existance check on string returned by snippr" do
+
+      context "existing snippet" do
+
+        it "returns true when calling .exists?" do
+          snippr(:home).exists?.should be_true
+        end
+
+        it "returns false when calling .missing?" do
+          snippr(:home).missing?.should be_false
+        end
+
+      end
+
+      context "missing snippet" do
+        it "returns false when calling .exists?" do
+          snippr(:missing).exists?.should be_false
+        end
+
+        it "returns true when calling .missing?" do
+          snippr(:missing).missing?.should be_true
+        end
+      end
+
+    end
+
+    context "snippr with meta data" do
+
+      context "and content" do
+
+        it "returns a Hash of meta information" do
+          snippr(:meta, :with_content).meta.should == {
+            "description" => "Die mit dem Fluegli",
+            "keywords" => "blau Mobilfunk GmbH, blau.de, blauworld, handy, sim"
+          }
+        end
+
+        it "returns a hash ofmeta information even if the YAML Fron Matter BLock ends without newline" do
+          snippr(:meta, :with_content_no_newline).meta.should == {
+            "description" => "Die mit dem Fluegli",
+            "keywords" => "blau Mobilfunk GmbH, blau.de, blauworld, handy, sim"
+          }
+
+        end
+
+        it "accepts a key to search for" do
+          snippr(:meta, :with_content).meta("description").should == "Die mit dem Fluegli"
+        end
+
+        it "returns the content without meta information" do
+          snippr(:meta, :with_content).to_s.should == "<!-- starting snippr: meta/withContent -->\n<p>So meta!</p>\n<!-- closing snippr: meta/withContent -->"
+        end
+
+      end
+
+      context "and no content" do
+
+        it "still returns a Hash of meta information" do
+          snippr(:meta, :with_no_content).meta.should == {
+            "description" => "Die mit dem Fluegli",
+            "keywords" => "blau Mobilfunk GmbH, blau.de, blauworld, handy, sim"
+          }
+        end
+
+      end
+
+    end
+
+    context "snippr with broken meta data" do
+
+      it "logs a warning and acts as if no meta information exist" do
+        Snippr.logger.expects(:warn).with do |msg|
+          msg =~ /Unable to extract meta data from Snip \[:meta, :broken\]/
+        end
+
+        snip = snippr(:meta, :broken)
+        snip.meta.should == {}
+        snip.to_s.should == "<!-- starting snippr: meta/broken -->\n<p>Broken!</p>\n<!-- closing snippr: meta/broken -->"
+      end
+
+    end
+
+    context "existing snippr" do
+
+      it "should call html_safe and return html safe value" do
+        content = snippr(:home)
+        content.should == "<!-- starting snippr: home -->\n<p>Home</p>\n<!-- closing snippr: home -->"
+        content.should be_html_safe
+      end
+
+      it "should pass html_safe snippr to block" do
+        lambda {
+          snippr(:home) do |snippr|
+            snippr.should be_html_safe
+            raise StandardError.new('block should be called')
+          end
+        }.should raise_error StandardError, 'block should be called'
+      end
+
+      it "should return 0 with block" do
+        snippr(:home) do; end.should == 0
+      end
+
+    end
+
+    context "empty snippr" do
+
+      it "should call html_safe return html save value" do
+        content = snippr(:empty)
+        content.should == "<!-- starting snippr: empty -->\n\n<!-- closing snippr: empty -->"
+        content.should be_html_safe
+      end
+
+      it "should not pass snippr to block but concat snippr and return 0" do
+        expects(:concat).with("<!-- starting snippr: empty -->\n\n<!-- closing snippr: empty -->")
+        lambda {
+          snippr(:empty) do
+            raise StandardError.new('block should not be called')
+          end.should == 0
+        }.should_not raise_error
+      end
+
+    end
+
+    context "missing snippr" do
+
+      it "should call html_safe return html save value" do
+        content = snippr(:doesnotexist)
+        content.should == '<!-- missing snippr: doesnotexist -->'
+        content.should be_html_safe
+      end
+
+      it "should not pass snippr to block but concat snippr and return 0" do
+        expects(:concat).with('<!-- missing snippr: doesnotexist -->')
+        lambda {
+          snippr(:doesnotexist) do
+            raise StandardError.new('block should not be called')
+          end.should == 0
+        }.should_not raise_error
+      end
+
+    end
+
+  end
+
+  describe "#snippr_with_path" do
+
+    context "on pages controller (special case)" do
+
+      before do
+        stubs(:controller_name).returns("pages")
+        stubs(:params).returns(:id => "a/path", :action => :view)
+      end
+
+      it "uses the path given in 'id' param" do
+        snippr_with_path(:a_snippet).should == "<!-- starting snippr: a/path/aSnippet -->\na snippet\n<!-- closing snippr: a/path/aSnippet -->"
+      end
+
+      it "works with a given block" do
+        lambda {
+          snippr_with_path(:a_snippet) do |snippr|
+            snippr.should be_html_safe
+            raise StandardError.new('block should be called')
+          end
+        }.should raise_error StandardError, 'block should be called'
+      end
+
+      it "works with parameters hash" do
+        snippr_with_path(:a_snippet_with_param, :param => "value").should == "<!-- starting snippr: a/path/aSnippetWithParam -->\na snippet with param value\n<!-- closing snippr: a/path/aSnippetWithParam -->"
+      end
+
+    end
+
+    context "on standard controllers" do
+
+      before do
+        stubs(:controller_name).returns("with_underscore")
+        stubs(:params).returns(:action => :and_underscore)
+      end
+
+      it "should camelize 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 -->"
+      end
+
+      it "works with a given block" do
+        lambda {
+          snippr_with_path(:a_snippet) do |snippr|
+            snippr.should be_html_safe
+            raise StandardError.new('block should be called')
+          end
+        }.should raise_error StandardError, 'block should be called'
+      end
+
+      it "works with parameters hash" do
+        snippr_with_path(:a_snippet, :param => "value").should == "<!-- starting snippr: withUnderscore/andUnderscore/aSnippet -->\nan underscored snippet with param value\n<!-- closing snippr: withUnderscore/andUnderscore/aSnippet -->"
+      end
+
+      it "should allow multiple arguments" do
+        snippr_with_path(:deeper, :nested, :snippet).should == "<!-- missing snippr: withUnderscore/andUnderscore/deeper/nested/snippet -->"
+      end
+    end
+
+  end
+
+end