shortcode 0.4.1 → 0.4.2

data/Gemfile.lock

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

data/lib/shortcode.rb

@@ -12,7 +12,7 @@ rescue LoadError; end
 module Shortcode
 
   class << self
-    attr_writer :configuration, :presenters
+    attr_writer :configuration
   end
 
   def self.process(string, additional_attributes=nil)
@@ -24,15 +24,11 @@ module Shortcode
   end
 
   def self.register_presenter(presenter)
-    [*presenter.for].each { |k| presenters[k.to_sym] = presenter }
+    Shortcode::Presenter.register presenter
   end
 
   private
 
-    def self.presenters
-      @presenters ||= {}
-    end
-
     def self.configuration
       @configuration ||= Configuration.new
     end

data/lib/shortcode/presenter.rb

@@ -1,5 +1,26 @@
 class Shortcode::Presenter
 
+  class << self
+    attr_writer :presenters
+
+    def presenters
+      @presenters ||= {}
+    end
+
+    def register(presenter)
+      validate presenter
+      [*presenter.for].each { |k| presenters[k.to_sym] = presenter }
+    end
+
+    def validate(presenter)
+      raise ArgumentError, "The presenter must define the class method #for" unless presenter.respond_to?(:for)
+      raise ArgumentError, "The presenter must define an initialize method" unless presenter.private_instance_methods(false).include?(:initialize)
+      %w(content attributes).each do |method|
+        raise ArgumentError, "The presenter must define the method ##{method}" unless presenter.method_defined?(method.to_sym)
+      end
+    end
+  end
+
   def initialize(name, attributes, content, additional_attributes)
     @attributes = attributes
     @content = content
@@ -18,8 +39,8 @@ class Shortcode::Presenter
   private
 
     def initialize_custom_presenter(name)
-      if Shortcode.presenters.has_key? name.to_sym
-        presenter   = Shortcode.presenters[name.to_sym].new(@attributes, @content, @additional_attributes)
+      if Shortcode::Presenter.presenters.has_key? name.to_sym
+        presenter   = Shortcode::Presenter.presenters[name.to_sym].new(@attributes, @content, @additional_attributes)
         @attributes = presenter.attributes
         @content    = presenter.content
       end

data/lib/shortcode/version.rb

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

data/spec/presenter_spec.rb

@@ -2,45 +2,12 @@ require 'spec_helper'
 require 'parslet/rig/rspec'
 require 'pp'
 
-class MyPresenter
-
-  def self.for
-    :quote
-  end
-
-  def initialize(attributes, content, additional_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
-
-  def content
-    @content
-  end
-
-  def attributes
-    @additional_attributes || { title: "my custom title" }
-  end
-end
+require 'support/presenters/my_presenter'
+require 'support/presenters/multiple_presenter'
+require 'support/presenters/missing_for_presenter'
+require 'support/presenters/missing_initialize_presenter'
+require 'support/presenters/missing_content_presenter'
+require 'support/presenters/missing_attributes_presenter'
 
 describe Shortcode::Presenter do
 
@@ -90,4 +57,40 @@ describe Shortcode::Presenter do
 
   end
 
+  context "presenter validation" do
+
+    describe "missing #for class method" do
+
+      it "raises an exception" do
+        expect { Shortcode.register_presenter MissingForPresenter }.to raise_error(ArgumentError, "The presenter must define the class method #for")
+      end
+
+    end
+
+    describe "missing #initialize method" do
+
+      it "raises an exception" do
+        expect { Shortcode.register_presenter MissingInitializePresenter }.to raise_error(ArgumentError, "The presenter must define an initialize method")
+      end
+
+    end
+
+    describe "missing #content method" do
+
+      it "raises an exception" do
+        expect { Shortcode.register_presenter MissingContentPresenter }.to raise_error(ArgumentError, "The presenter must define the method #content")
+      end
+
+    end
+
+    describe "missing #attributes method" do
+
+      it "raises an exception" do
+        expect { Shortcode.register_presenter MissingAttributesPresenter }.to raise_error(ArgumentError, "The presenter must define the method #attributes")
+      end
+
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -18,7 +18,7 @@ RSpec.configure do |config|
   config.order = "random"
 
   config.before(:each) do
-    Shortcode.presenters = {}
+    Shortcode::Presenter.presenters = {}
     Shortcode.setup do |config|
       config.template_parser = :erb
       config.template_path = File.join File.dirname(__FILE__), "support/templates/erb"

data/spec/support/presenters/missing_attributes_presenter.rb

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

data/spec/support/presenters/missing_content_presenter.rb

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

data/spec/support/presenters/missing_for_presenter.rb

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

data/spec/support/presenters/missing_initialize_presenter.rb

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

data/spec/support/presenters/multiple_presenter.rb

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

data/spec/support/presenters/my_presenter.rb

@@ -0,0 +1,19 @@
+class MyPresenter
+
+  def self.for
+    :quote
+  end
+
+  def initialize(attributes, content, additional_attributes)
+    @content = content
+    @additional_attributes = additional_attributes
+  end
+
+  def content
+    @content
+  end
+
+  def attributes
+    @additional_attributes || { title: "my custom title" }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortcode
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -188,6 +188,12 @@ files:
 - spec/support/fixtures/timeline_info_output.html
 - spec/support/fixtures/timeline_person.txt
 - spec/support/fixtures/timeline_person_output.html
+- spec/support/presenters/missing_attributes_presenter.rb
+- spec/support/presenters/missing_content_presenter.rb
+- spec/support/presenters/missing_for_presenter.rb
+- spec/support/presenters/missing_initialize_presenter.rb
+- spec/support/presenters/multiple_presenter.rb
+- spec/support/presenters/my_presenter.rb
 - spec/support/templates/erb/collapsible_list.html.erb
 - spec/support/templates/erb/item.html.erb
 - spec/support/templates/erb/quote.html.erb
@@ -261,6 +267,12 @@ test_files:
 - spec/support/fixtures/timeline_info_output.html
 - spec/support/fixtures/timeline_person.txt
 - spec/support/fixtures/timeline_person_output.html
+- spec/support/presenters/missing_attributes_presenter.rb
+- spec/support/presenters/missing_content_presenter.rb
+- spec/support/presenters/missing_for_presenter.rb
+- spec/support/presenters/missing_initialize_presenter.rb
+- spec/support/presenters/multiple_presenter.rb
+- spec/support/presenters/my_presenter.rb
 - spec/support/templates/erb/collapsible_list.html.erb
 - spec/support/templates/erb/item.html.erb
 - spec/support/templates/erb/quote.html.erb