shortcode 1.2.1 → 2.0.0.pre

data/spec/shortcode_spec.rb

@@ -1,82 +1,85 @@
-require 'spec_helper'
-require 'parslet/rig/rspec'
-require 'pp'
+require "spec_helper"
+require "parslet/rig/rspec"
+require "pp"
 
 describe Shortcode do
-
   let(:simple_quote)        { load_fixture :simple_quote }
   let(:simple_quote_output) { load_fixture :simple_quote_output, :html }
 
+  let(:shortcode) { described_class.new }
+  let(:configuration) { shortcode.configuration }
+
+  before do
+    configuration.template_path = File.join File.dirname(__FILE__), "support/templates/erb"
+  end
+
   context "simple_quote" do
+    before do
+      configuration.block_tags = [:quote]
+    end
 
     it "converts into html" do
-      expect(Shortcode.process(simple_quote).gsub("\n",'')).to eq(simple_quote_output)
+      expect(shortcode.process(simple_quote).delete("\n")).to eq(simple_quote_output)
     end
-
   end
 
   context "erb templates" do
+    before do
+      configuration.block_tags = [:quote]
+    end
 
     it "converts into html" do
-      expect(Shortcode.process(simple_quote).gsub("\n",'')).to eq(simple_quote_output)
+      expect(shortcode.process(simple_quote).delete("\n")).to eq(simple_quote_output)
     end
   end
 
   context "configuration" do
-
     describe "block_tags" do
-
       before do
-        Shortcode.setup do |config|
-          config.block_tags = []
-        end
+        configuration.block_tags = []
       end
 
       it "handles an empty array" do
-        expect { Shortcode.process(simple_quote) }.to_not raise_error
+        expect { shortcode.process(simple_quote) }.not_to raise_error
       end
-
     end
 
     describe "self_closing_tags" do
-
       before do
-        Shortcode.setup do |config|
-          config.self_closing_tags = []
-        end
+        configuration.self_closing_tags = []
       end
 
       it "handles an empty array" do
-        expect { Shortcode.process(simple_quote) }.to_not raise_error
+        expect { shortcode.process(simple_quote) }.not_to raise_error
       end
-
     end
-
   end
 
   context "multiple instances" do
-    let(:shortcode1) { Shortcode.new }
-    let(:shortcode2) { Shortcode.new }
-
     it "allows having multiple Shortcode instances that have independent configurations" do
-      expect(shortcode1.send(:configuration)).to_not be(shortcode2.send(:configuration))
+      expect(described_class.new.configuration).not_to be(described_class.new.configuration)
     end
 
-    it "uses the shortcode instance's configuration to process shortcodes" do
-      shortcode1.setup do |config|
-        config.self_closing_tags << :quote
-        config.templates = { quote: 'i am from shortcode 1' }
-      end
+    context "configuration" do
+      let(:shortcode1) { described_class.new }
+      let(:shortcode2) { described_class.new }
+
+      before do
+        shortcode1.setup do |config|
+          config.self_closing_tags << :quote
+          config.templates = { quote: "i am from shortcode 1" }
+        end
 
-      shortcode2.setup do |config|
-        config.self_closing_tags << :quote
-        config.templates = { quote: 'i am from shortcode 2' }
+        shortcode2.setup do |config|
+          config.self_closing_tags << :quote
+          config.templates = { quote: "i am from shortcode 2" }
+        end
       end
 
-      expect(shortcode1.process('[quote]')).to eq('i am from shortcode 1')
-      expect(shortcode2.process('[quote]')).to eq('i am from shortcode 2')
+      it "uses the shortcode instance's configuration to process shortcodes" do
+        expect(shortcode1.process("[quote]")).to eq("i am from shortcode 1")
+        expect(shortcode2.process("[quote]")).to eq("i am from shortcode 2")
+      end
     end
-
   end
-
 end

data/spec/spec_helper.rb

@@ -1,15 +1,15 @@
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
 if ENV["CI"]
-  require 'coveralls'
+  require "coveralls"
   Coveralls.wear!
 end
 
-require 'rspec'
-require 'rails'
-require 'action_view'
-require 'shortcode'
-require 'support/fixtures'
+require "rspec"
+require "rails"
+require "action_view"
+require "shortcode"
+require "support/fixtures"
 
 # Set slim's attribute quotes to use single quotes so it's the same as haml
 Slim::Engine.set_options attr_quote: "'"
@@ -17,18 +17,4 @@ Slim::Engine.set_options attr_quote: "'"
 RSpec.configure do |config|
   config.order = "random"
   config.color = true
-
-  config.before(:each) do
-    Shortcode.setup do |config|
-      config.template_parser = :erb
-      config.template_path = File.join File.dirname(__FILE__), "support/templates/erb"
-      config.templates = {}
-      config.check_config_templates_first = true
-      config.block_tags = [:quote, :collapsible_list, :item, :timeline_person, :rails_helper, :custom_helper]
-      config.self_closing_tags = [:timeline_event, :timeline_info]
-      config.attribute_quote_type = '"'
-      config.use_attribute_quotes = true
-      config.presenters = {}
-    end
-  end
 end

data/spec/support/fixtures.rb

@@ -1,9 +1,7 @@
-RSpec.configure do |config|
-
-  def load_fixture(name, type='txt')
+RSpec.configure do |_config|
+  def load_fixture(name, type="txt")
     type = type.to_s
-    string = File.read(File.join(File.dirname(__FILE__), 'fixtures', "#{name}.#{type}"))
-    type == 'txt' ? string : string.gsub("\n",'')
+    string = File.read(File.join(File.dirname(__FILE__), "fixtures", "#{name}.#{type}"))
+    type == "txt" ? string : string.delete("\n")
   end
-
 end

data/spec/support/presenters/missing_attributes_presenter.rb

@@ -1,12 +1,9 @@
 class MissingAttributesPresenter
 
-  def initialize
-  end
+  def initialize; end
 
-  def self.for
-  end
+  def self.for; end
 
-  def content
-  end
+  def content; end
 
 end

data/spec/support/presenters/missing_content_presenter.rb

@@ -1,12 +1,9 @@
 class MissingContentPresenter
 
-  def initialize
-  end
+  def initialize; end
 
-  def self.for
-  end
+  def self.for; end
 
-  def attributes
-  end
+  def attributes; end
 
 end

data/spec/support/presenters/missing_for_presenter.rb

@@ -1,12 +1,9 @@
 class MissingForPresenter
 
-  def initialize
-  end
+  def initialize; end
 
-  def content
-  end
+  def content; end
 
-  def attributes
-  end
+  def attributes; end
 
 end

data/spec/support/presenters/missing_initialize_presenter.rb

@@ -1,12 +1,9 @@
 class MissingInitializePresenter
 
-  def self.for
-  end
+  def self.for; end
 
-  def content
-  end
+  def content; end
 
-  def attributes
-  end
+  def attributes; end
 
 end

data/spec/support/presenters/multiple_presenter.rb

@@ -1,19 +1,18 @@
 class MultiplePresenter
 
   def self.for
-    [:quote, :item]
+    %i[quote item]
   end
 
-  def initialize(attributes, content, additional_attributes)
+  def initialize(_attributes, content, additional_attributes)
     @content = content
     @additional_attributes = additional_attributes
   end
 
-  def content
-    @content
-  end
+  attr_reader :content
 
   def attributes
     @additional_attributes || { title: "my custom title" }
   end
+
 end

data/spec/support/presenters/my_presenter.rb

@@ -4,16 +4,15 @@ class MyPresenter
     :quote
   end
 
-  def initialize(attributes, content, additional_attributes)
+  def initialize(_attributes, content, additional_attributes)
     @content = content
     @additional_attributes = additional_attributes
   end
 
-  def content
-    @content
-  end
+  attr_reader :content
 
   def attributes
     @additional_attributes || { title: "my custom title" }
   end
+
 end

data/spec/support/presenters/other_presenter.rb

@@ -4,16 +4,15 @@ class OtherPresenter
     :other
   end
 
-  def initialize(attributes, content, additional_attributes)
+  def initialize(_attributes, content, additional_attributes)
     @content = content
     @additional_attributes = additional_attributes
   end
 
-  def content
-    @content
-  end
+  attr_reader :content
 
   def attributes
     @additional_attributes || { title: "my custom title" }
   end
+
 end

data/spec/template_parsers_spec.rb

@@ -1,46 +1,45 @@
-require 'spec_helper'
-
-describe "template parsers" do
+require "spec_helper"
 
+describe "template parsers", type: :feature do
   let(:simple_quote)        { load_fixture :simple_quote }
   let(:simple_quote_output) { load_fixture :simple_quote_output, :html }
 
+  let(:shortcode) { Shortcode.new }
+  let(:configuration) { shortcode.configuration }
+
   context "erb" do
+    before do
+      configuration.block_tags = [:quote]
+      configuration.template_parser = :erb
+      configuration.template_path = File.join File.dirname(__FILE__), "support/templates/erb"
+    end
 
     it "can render a template" do
-      expect(Shortcode.process(simple_quote).gsub("\n",'')).to eq(simple_quote_output)
+      expect(shortcode.process(simple_quote).delete("\n")).to eq(simple_quote_output)
     end
-
   end
 
   context "haml" do
-
-    before(:each) do
-      Shortcode.setup do |config|
-        config.template_parser = :haml
-        config.template_path = File.join File.dirname(__FILE__), "support/templates/haml"
-      end
+    before do
+      configuration.block_tags = [:quote]
+      configuration.template_parser = :haml
+      configuration.template_path = File.join File.dirname(__FILE__), "support/templates/haml"
     end
 
     it "can render a template" do
-      expect(Shortcode.process(simple_quote).gsub("\n",'').gsub('>  <', '><')).to eq(simple_quote_output)
+      expect(shortcode.process(simple_quote).delete("\n").gsub(">  <", "><")).to eq(simple_quote_output)
     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
+    before do
+      configuration.block_tags = [:quote]
+      configuration.template_parser = :slim
+      configuration.template_path = File.join File.dirname(__FILE__), "support/templates/slim"
     end
 
     it "can render a template" do
-      expect(Shortcode.process(simple_quote).gsub("\n",'')).to eq(simple_quote_output)
+      expect(shortcode.process(simple_quote).delete("\n")).to eq(simple_quote_output)
     end
-
   end
-
 end

data/spec/transformer_spec.rb

@@ -1,11 +1,19 @@
-require 'spec_helper'
-require 'parslet/rig/rspec'
-require 'pp'
+require "spec_helper"
+require "parslet/rig/rspec"
+require "pp"
 
 describe Shortcode do
-  configuration = Shortcode.singleton.send(:configuration)
-  let(:parser)      { Shortcode::Parser.new(configuration) }
-  let(:transformer) { Shortcode::Transformer.new(configuration) }
+  let(:configuration) {
+    described_class.new.tap { |s|
+      s.setup do |config|
+        config.template_path = File.join File.dirname(__FILE__), "support/templates/erb"
+        config.block_tags = %i[quote collapsible_list item timeline_person rails_helper]
+        config.self_closing_tags = %i[timeline_event timeline_info]
+      end
+    }.configuration
+  }
+  let(:parser)        { Shortcode::Parser.new(configuration) }
+  let(:transformer)   { Shortcode::Transformer.new(configuration) }
 
   let(:simple_quote)          { load_fixture :simple_quote }
   let(:full_quote)            { load_fixture :full_quote }
@@ -32,91 +40,73 @@ describe Shortcode do
   let(:block_with_whitespace_output) { load_fixture :block_with_whitespace_output, :html }
 
   context "simple_quote" do
-
     it "converts into html" do
       obj = parser.parse(simple_quote)
       html = transformer.apply obj, additional_attributes: nil
-      expect(html.gsub("\n", '')).to eq(simple_quote_output)
+      expect(html.delete("\n")).to eq(simple_quote_output)
     end
-
   end
 
   context "full_quote" do
-
     it "converts into html" do
       html = transformer.apply(parser.parse(full_quote), additional_attributes: nil)
-      expect(html.gsub("\n", '')).to eq(full_quote_output)
+      expect(html.delete("\n")).to eq(full_quote_output)
     end
-
   end
 
   context "quote_with_extras" do
-
     it "converts into html" do
       html = transformer.apply(parser.parse(quote_with_extras), additional_attributes: nil)
-      expect(html.gsub("\n", '')).to eq(quote_with_extras_output)
+      expect(html.delete("\n")).to eq(quote_with_extras_output)
     end
-
   end
 
   context "simple_list" do
-
     it "converts into html" do
       html = transformer.apply(parser.parse(simple_list), additional_attributes: nil)
-      expect(html.gsub("\n", '')).to eq(simple_list_output)
+      expect(html.delete("\n")).to eq(simple_list_output)
     end
-
   end
 
   context "timeline_event" do
-
     it "converts into html" do
       html = transformer.apply(parser.parse(timeline_event), additional_attributes: nil)
-      expect(html.gsub("\n", '')).to eq(timeline_event_output)
+      expect(html.delete("\n")).to eq(timeline_event_output)
     end
-
   end
 
   context "timeline_info" do
-
     it "converts into html" do
       html = transformer.apply(parser.parse(timeline_info), additional_attributes: nil)
-      expect(html.gsub("\n", '')).to eq(timeline_info_output)
+      expect(html.delete("\n")).to eq(timeline_info_output)
     end
-
   end
 
   context "timeline_person" do
-
     it "converts into html" do
       html = transformer.apply(parser.parse(timeline_person), additional_attributes: nil)
-      expect(html.gsub("\n", '')).to eq(timeline_person_output)
+      expect(html.delete("\n")).to eq(timeline_person_output)
     end
-
   end
 
   context "complex_snippet" do
-
     it "converts into html" do
       html = transformer.apply(parser.parse(complex_snippet), additional_attributes: nil)
-      expect(html.gsub("\n", '')).to eq(complex_snippet_output)
+      expect(html.delete("\n")).to eq(complex_snippet_output)
     end
   end
 
   context "erb templates" do
-
     it "converts into html" do
       html = transformer.apply(parser.parse(simple_quote), additional_attributes: nil)
-      expect(html.gsub("\n",'')).to eq(simple_quote_output)
+      expect(html.delete("\n")).to eq(simple_quote_output)
     end
   end
 
-  context 'whitespace' do
-
-    it 'is preserved after a block tag' do
+  context "whitespace" do
+    it "is preserved after a block tag" do
       html = transformer.apply(parser.parse(block_with_whitespace), additional_attributes: nil)
-      expect(html.gsub("\n",'')).to eq(block_with_whitespace_output)
+      expect(html.delete("\n")).to eq(block_with_whitespace_output)
     end
-
   end
 end