shortcode 0.4.0 → 0.4.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shortcode (0.4.0)
+    shortcode (0.4.1)
       parslet (= 1.6.0)
 
 GEM

data/README.md

@@ -127,7 +127,7 @@ an exception will be raised.
 
 ### Presenters
 
-Sometimes the data passed to the template from the shortcode it not enough. Lets say you want to render a gallery of images using id numbers of images stored in a database, e.g. `[gallery ids="1,2,3,4"]`. This is where presenters can help, they allow you to modify the `@content` and `@attributes` variables before they are sent to the template for rendering. Presenters are simple classes that define four methods. The class method `for` should return the name of the shortcode (as a symbol) it should be applied to. The classes `initialize` method received the `attributes`, `content` and `additional_attributes` variables. Finally the class should define `content` and `attributes` methods.
+Sometimes the data passed to the template from the shortcode it not enough. Lets say you want to render a gallery of images using id numbers of images stored in a database, e.g. `[gallery ids="1,2,3,4"]`. This is where presenters can help, they allow you to modify the `@content` and `@attributes` variables before they are sent to the template for rendering. Presenters are simple classes that define four methods. The class method `for` should return the name of the shortcode (as a symbol) it should be applied to, the `for` method can also return an array of symbols if the presenter is to be used for multiple shortcodes. The classes `initialize` method received the `attributes`, `content` and `additional_attributes` variables. Finally the class should define `content` and `attributes` methods.
 
 In a rails app you could return image records to the template using something like this:
 
@@ -135,13 +135,13 @@ In a rails app you could return image records to the template using something li
 class GalleryPresenter
 
   def self.for
+    # An array can also be returned if the presenter should be applied
+    # to multiple shortcodes, e.g. [:gallery, :enhanced_gallery]
     :gallery
   end
 
   def initialize(attributes, content, additional_attributes)
-    @attributes = attributes
     @content = content
-    @additional_attributes = additional_attributes
   end
 
   def content
@@ -172,7 +172,6 @@ class GalleryPresenter
   end
 
   def initialize(attributes, content, additional_attributes)
-    @attributes = attributes
     @content = content
     @additional_attributes = additional_attributes
   end
@@ -192,7 +191,8 @@ class GalleryPresenter
     end
 end
 
-# The hash containing the images attribute is passed through to the presenter as the additional_attributes argument
+# The hash containing the images attribute is passed through to the presenter
+# as the additional_attributes argument
 Shortcode.process('[gallery]', { images: @post.images })
 
 ```

data/lib/shortcode.rb

@@ -24,7 +24,7 @@ module Shortcode
   end
 
   def self.register_presenter(presenter)
-    presenters[presenter.for.to_sym] = presenter
+    [*presenter.for].each { |k| presenters[k.to_sym] = presenter }
   end
 
   private

data/lib/shortcode/version.rb

@@ -1,3 +1,3 @@
 module Shortcode
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/spec/presenter_spec.rb

@@ -9,7 +9,26 @@ class MyPresenter
   end
 
   def initialize(attributes, content, additional_attributes)
-    @attributes = attributes
+    @content = content
+    @additional_attributes = additional_attributes
+  end
+
+  def content
+    @content
+  end
+
+  def attributes
+    @additional_attributes || { title: "my custom title" }
+  end
+end
+
+class MultiplePresenter
+
+  def self.for
+    [:quote, :item]
+  end
+
+  def initialize(attributes, content, additional_attributes)
     @content = content
     @additional_attributes = additional_attributes
   end
@@ -25,12 +44,14 @@ end
 
 describe Shortcode::Presenter do
 
-  let(:simple_quote)      { load_fixture :simple_quote }
-  let(:presenter_output)  { load_fixture :simple_quote_presenter_output, :html }
-  let(:attributes_output) { load_fixture :simple_quote_presenter_attributes_output, :html }
+  let(:simple_quote)  { load_fixture :simple_quote }
+  let(:item)          { load_fixture :item }
 
   describe "using a custom presenter" do
 
+    let(:presenter_output)  { load_fixture :simple_quote_presenter_output, :html }
+    let(:attributes_output) { load_fixture :simple_quote_presenter_attributes_output, :html }
+
     before do
       Shortcode.register_presenter MyPresenter
     end
@@ -45,4 +66,28 @@ describe Shortcode::Presenter do
 
   end
 
+  describe "using a single presenter for multiple shortcodes" do
+
+    let(:quote_presenter_output)  { load_fixture :simple_quote_presenter_output, :html }
+    let(:item_presenter_output)   { load_fixture :item_presenter_output,         :html }
+
+    let(:quote_attributes_output) { load_fixture :simple_quote_presenter_attributes_output, :html }
+    let(:item_attributes_output)  { load_fixture :item_presenter_attributes_output,         :html }
+
+    before do
+      Shortcode.register_presenter MultiplePresenter
+    end
+
+    it "uses the custom attributes" do
+      expect(Shortcode.process(simple_quote ).gsub("\n",'')).to eq(quote_presenter_output)
+      expect(Shortcode.process(item         ).gsub("\n",'')).to eq(item_presenter_output)
+    end
+
+    it "passes through additional attributes" do
+      expect(Shortcode.process(simple_quote, { title: 'Additional attribute title' }).gsub("\n",'')).to eq(quote_attributes_output)
+      expect(Shortcode.process(item,         { title: 'Additional attribute title' }).gsub("\n",'')).to eq(item_attributes_output)
+    end
+
+  end
+
 end

data/spec/support/fixtures/item.txt

@@ -0,0 +1 @@
+[item title="Example title 1"]Example content 1[/item]

data/spec/support/fixtures/item_presenter_attributes_output.html

@@ -0,0 +1,4 @@
+<section>
+<h5>Additional attribute title</h5>
+<div>Example content 1</div>
+</section>

data/spec/support/fixtures/item_presenter_output.html

@@ -0,0 +1,4 @@
+<section>
+<h5>my custom title</h5>
+<div>Example content 1</div>
+</section>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortcode
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -166,6 +166,9 @@ files:
 - spec/support/fixtures/complex_snippet_output.html
 - spec/support/fixtures/full_quote.txt
 - spec/support/fixtures/full_quote_output.html
+- spec/support/fixtures/item.txt
+- spec/support/fixtures/item_presenter_attributes_output.html
+- spec/support/fixtures/item_presenter_output.html
 - spec/support/fixtures/long_text.txt
 - spec/support/fixtures/quote_with_extras.txt
 - spec/support/fixtures/quote_with_extras_output.html
@@ -236,6 +239,9 @@ test_files:
 - spec/support/fixtures/complex_snippet_output.html
 - spec/support/fixtures/full_quote.txt
 - spec/support/fixtures/full_quote_output.html
+- spec/support/fixtures/item.txt
+- spec/support/fixtures/item_presenter_attributes_output.html
+- spec/support/fixtures/item_presenter_output.html
 - spec/support/fixtures/long_text.txt
 - spec/support/fixtures/quote_with_extras.txt
 - spec/support/fixtures/quote_with_extras_output.html