shortcode 0.3.2 → 0.3.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shortcode (0.3.2)
+    shortcode (0.3.3)
       haml (~> 4.0)
       parslet (= 1.6.0)
 

data/lib/shortcode/configuration.rb

@@ -1,7 +1,20 @@
 class Shortcode::Configuration
+  # This stores if the parser has been set in a configuration block so that deprication
+  # warnings can be issued
+  attr_accessor :parser_set
+
+  def haml_deprecation_warning
+    "[DEPRECATION] HAML will no longer be the default template parser in version 0.4 of Shortcode. A HAML template has been used without explicitly specifying HAML as the template parser in a setup block. Please set config.template_parser = :haml to suppress this warning"
+  end
+
   # Sets the template parser to use, supports :erb, :haml, and :slim, default is :haml
   attr_accessor :template_parser
 
+  def template_parser=(parser)
+    @parser_set = true
+    @template_parser = parser
+  end
+
   # Sets the path to search for template files
   attr_accessor :template_path
 
@@ -24,5 +37,6 @@ class Shortcode::Configuration
     @block_tags         = []
     @self_closing_tags  = []
     @quotes             = '"'
+    @parser_set         = false
   end
 end

data/lib/shortcode/tag.rb

@@ -32,6 +32,7 @@ class Shortcode::Tag
       when :slim
         Slim::Template.new { markup }.render(self)
       when :haml
+        warn Shortcode.configuration.haml_deprecation_warning unless Shortcode.configuration.parser_set
         Haml::Engine.new(markup, ugly: true).render(binding)
       when :erb
         ERB.new(markup).result(binding)

data/lib/shortcode/version.rb

@@ -1,3 +1,3 @@
 module Shortcode
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/spec/rails_helpers_spec.rb

@@ -3,21 +3,22 @@ require 'spec_helper'
 describe "rails helpers" do
 
   let(:template)    { load_fixture :rails_helper }
-  let(:slim_output) { load_fixture :rails_helper_output_slim, :html }
+
+  let(:erb_output)  { load_fixture :rails_helper_output_erb,  :html }
   let(:haml_output) { load_fixture :rails_helper_output_haml, :html }
-  let(:erb_output)  { load_fixture :rails_helper_output_erb, :html }
+  let(:slim_output) { load_fixture :rails_helper_output_slim, :html }
 
-  describe "slim" do
+  describe "erb" do
 
     before(:each) do
       Shortcode.setup do |config|
-        config.template_parser = :slim
-        config.template_path = File.join File.dirname(__FILE__), "support/templates/slim"
+        config.template_parser = :erb
+        config.template_path = File.join File.dirname(__FILE__), "support/templates/erb"
       end
     end
 
-    it "are accessible within slim templates" do
-      Shortcode.process(template).gsub("\n",'').should == slim_output.gsub("\n",'')
+    it "are accessible within erb templates" do
+      Shortcode.process(template).gsub("\n",'').should == erb_output.gsub("\n",'')
     end
 
   end
@@ -30,17 +31,17 @@ describe "rails helpers" do
 
   end
 
-  describe "erb" do
+  describe "slim" do
 
     before(:each) do
       Shortcode.setup do |config|
-        config.template_parser = :erb
-        config.template_path = File.join File.dirname(__FILE__), "support/templates/erb"
+        config.template_parser = :slim
+        config.template_path = File.join File.dirname(__FILE__), "support/templates/slim"
       end
     end
 
-    it "are accessible within erb templates" do
-      Shortcode.process(template).gsub("\n",'').should == erb_output.gsub("\n",'')
+    it "are accessible within slim templates" do
+      Shortcode.process(template).gsub("\n",'').should == slim_output.gsub("\n",'')
     end
 
   end

data/spec/spec_helper.rb

@@ -8,6 +8,10 @@ require 'rails'
 require 'action_view'
 require 'shortcode'
 require 'support/fixtures'
+require 'support/custom_expectations/write_expectation'
+
+# Set slim's attribute quotes to use single quotes so it's the same as haml
+Slim::Engine.set_default_options attr_quote: "'"
 
 RSpec.configure do |config|
   config.order = "random"
@@ -16,6 +20,7 @@ RSpec.configure do |config|
     Shortcode.presenters = {}
     Shortcode.setup do |config|
       config.template_parser = :haml
+      config.parser_set = false
       config.template_path = File.join File.dirname(__FILE__), "support/templates/haml"
       config.templates = nil
       config.block_tags = [:quote, :collapsible_list, :item, :timeline_person, :rails_helper]

data/spec/support/custom_expectations/write_expectation.rb

@@ -0,0 +1,62 @@
+RSpec::Matchers.define :write do |message|
+
+  chain(:to) do |io|
+    @io = io
+  end
+
+  match do |block|
+    output =
+      case io
+      when :output then fake_stdout(&block)
+      when :error  then fake_stderr(&block)
+      else raise("Allowed values for `to` are :output and :error, got `#{io.inspect}`")
+      end
+    output.include? message
+  end
+
+  description do
+    "write \"#{message}\" #{io_name}"
+  end
+
+  failure_message_for_should do
+    "expected to #{description}"
+  end
+
+  failure_message_for_should_not do
+    "expected to not #{description}"
+  end
+
+  def supports_block_expectations?
+    true
+  end
+
+  # Fake STDERR and return a string written to it.
+  def fake_stderr
+    original_stderr = $stderr
+    $stderr = StringIO.new
+    yield
+    $stderr.string
+  ensure
+    $stderr = original_stderr
+  end
+
+  # Fake STDOUT and return a string written to it.
+  def fake_stdout
+    original_stdout = $stdout
+    $stdout = StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = original_stdout
+  end
+
+  # default IO is standard output
+  def io
+    @io ||= :output
+  end
+
+  # IO name is used for description message
+  def io_name
+    { output: "standard output", error: "standard error" }[io]
+  end
+end

data/spec/support/templates/slim/quote.html.slim

@@ -0,0 +1,8 @@
+blockquote
+  p.quotation = @content
+  -if @attributes[:author] || @attributes[:title]
+    p.citation
+      -if @attributes[:author]
+        span.author = @attributes[:author]
+      -if @attributes[:title]
+        span.position = @attributes[:title]

data/spec/template_parsers_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe "template parsers" do
+
+  let(:simple_quote)        { load_fixture :simple_quote }
+  let(:simple_quote_output) { load_fixture :simple_quote_output, :html }
+
+  context "erb" do
+
+    # TODO remove this before block as erb will eb the default at version 0.4
+    before(:each) do
+      Shortcode.setup do |config|
+        config.template_parser = :erb
+        config.template_path = File.join File.dirname(__FILE__), "support/templates/erb"
+      end
+    end
+
+    it "can render a template" do
+      Shortcode.process(simple_quote).gsub("\n",'').should == simple_quote_output.gsub("\n",'')
+    end
+
+  end
+
+  context "haml" do
+
+    it "can render a template" do
+      Shortcode.process(simple_quote).gsub("\n",'').should == simple_quote_output.gsub("\n",'')
+    end
+
+    context "when specified in the config" do
+
+      before(:each) do
+        Shortcode.setup do |config|
+          config.template_parser = :haml
+        end
+      end
+
+      it "does not show a deprecation warning" do
+        expect { Shortcode.process(simple_quote) }.not_to write(Shortcode.configuration.haml_deprecation_warning).to(:error)
+      end
+
+    end
+
+    context "when not specifed in the config" do
+
+      it "shows a deprecation warning" do
+        expect { Shortcode.process(simple_quote) }.to write(Shortcode.configuration.haml_deprecation_warning).to(:error)
+      end
+
+    end
+
+  end
+
+  context "slim" do
+
+    before(:each) do
+      Shortcode.setup do |config|
+        config.template_parser = :slim
+        config.template_path = File.join File.dirname(__FILE__), "support/templates/slim"
+      end
+    end
+
+    it "can render a template" do
+      Shortcode.process(simple_quote).gsub("\n",'').should == simple_quote_output.gsub("\n",'')
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortcode
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-30 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -161,6 +161,7 @@ files:
 - spec/rails_helpers_spec.rb
 - spec/shortcode_spec.rb
 - spec/spec_helper.rb
+- spec/support/custom_expectations/write_expectation.rb
 - spec/support/fixtures.rb
 - spec/support/fixtures/complex_snippet.txt
 - spec/support/fixtures/complex_snippet_output.html
@@ -194,8 +195,10 @@ files:
 - spec/support/templates/haml/timeline_event.html.haml
 - spec/support/templates/haml/timeline_info.html.haml
 - spec/support/templates/haml/timeline_person.html.haml
+- spec/support/templates/slim/quote.html.slim
 - spec/support/templates/slim/rails_helper.html.slim
 - spec/tag_spec.rb
+- spec/template_parsers_spec.rb
 - spec/transformer_spec.rb
 homepage: https://github.com/kernow/shortcode
 licenses:
@@ -229,6 +232,7 @@ test_files:
 - spec/rails_helpers_spec.rb
 - spec/shortcode_spec.rb
 - spec/spec_helper.rb
+- spec/support/custom_expectations/write_expectation.rb
 - spec/support/fixtures.rb
 - spec/support/fixtures/complex_snippet.txt
 - spec/support/fixtures/complex_snippet_output.html
@@ -262,6 +266,8 @@ test_files:
 - spec/support/templates/haml/timeline_event.html.haml
 - spec/support/templates/haml/timeline_info.html.haml
 - spec/support/templates/haml/timeline_person.html.haml
+- spec/support/templates/slim/quote.html.slim
 - spec/support/templates/slim/rails_helper.html.slim
 - spec/tag_spec.rb
+- spec/template_parsers_spec.rb
 - spec/transformer_spec.rb