shortcode 0.1.2 → 0.2.0

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    shortcode (0.1.2)
+      haml (~> 4.0)
+      parslet (= 1.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (1.0.0.beta3)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    blankslate (2.1.2.4)
+    diff-lcs (1.2.4)
+    haml (4.0.5)
+      tilt
+    parslet (1.6.0)
+      blankslate (~> 2.0)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    thor (0.18.1)
+    tilt (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (= 1.0.0.beta3)
+  bundler (~> 1.3)
+  rake
+  rspec
+  shortcode!

data/README.md

@@ -28,23 +28,12 @@ $ gem install shortcode
 
 ### Example
 
-Shortcode can be used in one of two ways, the parser and transformer can be called seperatly or the `process` method can be used which performs both the parsing and transforming and returns the result.
-
-The shorthand wraps up the above code into a single method call for convenience
+Shortcode is very simple to use, simply call the `process` method and pass it a string containing shortcode markup.
 
 ```ruby
 Shortcode.process("[quote]Hello World[/quote]")
 ```
 
-The longer form is good if you want to work with the intemediary hash returned by the parser
-
-```ruby
-parser = Shortcode::Parser.new
-transformer = Shortcode::Transformer.new
-parsed_hash = parser.parse("[quote]Hello World[/quote]")
-transformer.apply(parsed_hash)
-```
-
 ### Configuration
 
 ```ruby
@@ -61,6 +50,9 @@ Shortcode.setup do |config|
 
   # a list of self closing tags to support e.g. [youtube id="12345"]
   config.self_closing_tags = [:youtube]
+
+  # the type of quotes to use for attribute values, default is double quotes (")
+  config.quotes = '"'
 end
 ```
 
@@ -96,20 +88,21 @@ Three templates would be required to support the above content, `[:collapsible_l
 
 ### 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` and `content` 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 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:
 
 ```ruby
-class CustomPresenter
+class GalleryPresenter
 
   def self.for
-    :quote
+    :gallery
   end
 
-  def initialize(attributes, content)
+  def initialize(attributes, content, additional_attributes)
     @attributes = attributes
     @content = content
+    @additional_attributes = additional_attributes
   end
 
   def content
@@ -128,6 +121,43 @@ class CustomPresenter
 end
 ```
 
+#### Using additional attributes
+
+At times you may want to pass through additional attributes to a presenter, for instance if you have a [gallery] shortcode tag and you want to pull out all images for a post, this can be achived using additional attributes with a presenter.
+
+```ruby
+class GalleryPresenter
+
+  def self.for
+    :gallery
+  end
+
+  def initialize(attributes, content, additional_attributes)
+    @attributes = attributes
+    @content = content
+    @additional_attributes = additional_attributes
+  end
+
+  def content
+    @content
+  end
+
+  def attributes
+    { images: images }
+  end
+
+  private
+
+    def images
+      @additional_attributes[:images].map &:url
+    end
+end
+
+# The hash containing the images attribute is passed through to the presenter as the additional_attributes argument
+Shortcode.process('[gallery]', { images: @post.images })
+
+```
+
 #### Registering presenters
 
 To register a presenter simply call `Shortcode.register_presenter` passing the presenter class e.g.

data/lib/shortcode/configuration.rb

@@ -11,10 +11,14 @@ class Shortcode::Configuration
   # Set the supported self_closing_tags
   attr_accessor :self_closing_tags
 
+  # Set the quotation sign used for attribute values. Defaults to double quote (")
+  attr_accessor :quotes
+
   def initialize
     @template_parser    = :haml
     @template_path      = "app/views/shortcode_templates"
     @block_tags         = []
     @self_closing_tags  = []
+    @quotes             = '"'
   end
 end

data/lib/shortcode/parser.rb

@@ -3,7 +3,7 @@ class Shortcode::Parser < Parslet::Parser
   rule(:block_tag)        { match_any_of Shortcode.configuration.block_tags }
   rule(:self_closing_tag) { match_any_of Shortcode.configuration.self_closing_tags }
 
-  rule(:quotes) { str('"') }
+  rule(:quotes) { str(Shortcode.configuration.quotes) }
 
   rule(:space)        { str(' ').repeat(1) }
   rule(:space?)       { space.maybe }

data/lib/shortcode/presenter.rb

@@ -1,8 +1,9 @@
 class Shortcode::Presenter
 
-  def initialize(name, attributes, content)
+  def initialize(name, attributes, content, additional_attributes)
     @attributes = attributes
     @content = content
+    @additional_attributes = additional_attributes
     initialize_custom_presenter(name)
   end
 
@@ -18,7 +19,7 @@ class Shortcode::Presenter
 
     def initialize_custom_presenter(name)
       if Shortcode.presenters.has_key? name.to_sym
-        presenter   = Shortcode.presenters[name.to_sym].new(@attributes, @content)
+        presenter   = Shortcode.presenters[name.to_sym].new(@attributes, @content, @additional_attributes)
         @attributes = presenter.attributes
         @content    = presenter.content
       end

data/lib/shortcode/processor.rb

@@ -0,0 +1,17 @@
+class Shortcode::Processor
+
+  def process(string, additional_attributes=nil)
+    transformer.apply parser.parse(string), additional_attributes: additional_attributes
+  end
+
+  private
+
+    def parser
+      @parser ||= Shortcode::Parser.new
+    end
+
+    def transformer
+      @transformer ||= Shortcode::Transformer.new
+    end
+
+end

data/lib/shortcode/tag.rb

@@ -1,8 +1,8 @@
 class Shortcode::Tag
 
-  def initialize(name, attributes=[], content='')
+  def initialize(name, attributes=[], content='', additional_attributes=nil)
     @name       = name.downcase
-    presenter   = Shortcode::Presenter.new name, set_attributes(attributes), content
+    presenter   = Shortcode::Presenter.new name, set_attributes(attributes), content, additional_attributes
     @attributes = presenter.attributes
     @content    = presenter.content
   end

data/lib/shortcode/transformer.rb

@@ -6,11 +6,12 @@ class Shortcode::Transformer < Parslet::Transform
     options:  subtree(:options),
     inner:    sequence(:inner),
     close:    simple(:name)
-  ) { Shortcode::Tag.new(name.to_s, options, inner.join).render }
+  ) { Shortcode::Tag.new(name.to_s, options, inner.join, additional_attributes).render }
   rule(
     open_close: simple(:name),
     options:    subtree(:options)
-  ) { Shortcode::Tag.new(name.to_s, options).render }
+  ) { Shortcode::Tag.new(name.to_s, options, '', additional_attributes).render }
 
   rule(body: sequence(:strings)) { strings.join }
+
 end

data/lib/shortcode/version.rb

@@ -1,3 +1,3 @@
 module Shortcode
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/shortcode.rb

@@ -3,32 +3,31 @@ require 'haml'
 require 'erb'
 
 module Shortcode
-  extend self
 
-  attr_accessor :configuration, :presenters
-  self.presenters = {}
+  class << self
+    attr_writer :configuration, :presenters
+  end
 
-  def setup
-    self.configuration ||= Configuration.new
-    yield configuration
+  def self.process(string, additional_attributes=nil)
+    Shortcode::Processor.new.process string, additional_attributes
   end
 
-  def process(code)
-    transformer.apply(parser.parse(code))
+  def self.setup
+    yield configuration
   end
 
-  def register_presenter(presenter)
-    self.presenters[presenter.for.to_sym] = presenter
+  def self.register_presenter(presenter)
+    presenters[presenter.for.to_sym] = presenter
   end
 
   private
 
-    def parser
-      @@parser = Shortcode::Parser.new
+    def self.presenters
+      @presenters ||= {}
     end
 
-    def transformer
-      @@transformer = Shortcode::Transformer.new
+    def self.configuration
+      @configuration ||= Configuration.new
     end
 
 end
@@ -37,6 +36,7 @@ require 'shortcode/version'
 require 'shortcode/configuration'
 require 'shortcode/parser'
 require 'shortcode/presenter'
+require 'shortcode/processor'
 require 'shortcode/transformer'
 require 'shortcode/tag'
 require 'shortcode/exceptions'

data/shortcode.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "parslet", "1.5.0"
+  spec.add_dependency "parslet", "1.6.0"
   spec.add_dependency "haml", "~> 4.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/spec/parser_spec.rb

@@ -25,6 +25,22 @@ describe Shortcode::Parser do
     end
   end
 
+  it "parses quotes using custom quotations" do
+    Shortcode.setup do |config|
+      config.quotes = "'"
+    end
+
+    quotes.each do |string|
+      # Change double quotes to single quotes in the fixture
+      parser.should parse(string.gsub '"', "'")
+    end
+
+    # Reset configuration to default
+    Shortcode.setup do |config|
+      config.quotes = '"'
+    end
+  end
+
   it "parses list shortcodes" do
     collapsible_lists.each do |string|
       parser.should parse(string)

data/spec/performance_spec.rb

@@ -32,7 +32,7 @@ require 'benchmark'
 
 #     it "runs quickly" do
 #       Benchmark.realtime {
-#         transformer.apply(parsed_hash)
+#         transformer.apply(parsed_hash, additional_attributes: nil)
 #       }.should < 0.1
 #     end
 

data/spec/presenter_spec.rb

@@ -2,15 +2,16 @@ require 'spec_helper'
 require 'parslet/rig/rspec'
 require 'pp'
 
-class MyPrsenter
+class MyPresenter
 
   def self.for
     :quote
   end
 
-  def initialize(attributes, content)
+  def initialize(attributes, content, additional_attributes)
     @attributes = attributes
     @content = content
+    @additional_attributes = additional_attributes
   end
 
   def content
@@ -18,23 +19,28 @@ class MyPrsenter
   end
 
   def attributes
-    { title: "my custom title" }
+    @additional_attributes || { title: "my custom title" }
   end
 end
 
 describe Shortcode::Presenter do
 
-  let(:simple_quote)        { load_fixture :simple_quote }
-  let(:simple_quote_output) { load_fixture :simple_quote_presenter_output, :html }
+  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 }
 
   describe "using a custom presenter" do
 
     before do
-      Shortcode.register_presenter MyPrsenter
+      Shortcode.register_presenter MyPresenter
     end
 
-    it "uses the custome attributes" do
-      Shortcode.process(simple_quote).gsub("\n",'').should == simple_quote_output.gsub("\n",'')
+    it "uses the custom attributes" do
+      Shortcode.process(simple_quote).gsub("\n",'').should == presenter_output.gsub("\n",'')
+    end
+
+    it "passes through additional attributes" do
+      Shortcode.process(simple_quote, { title: 'Additional attribute title' }).gsub("\n",'').should == attributes_output.gsub("\n",'')
     end
 
   end

data/spec/support/fixtures/simple_quote_presenter_attributes_output.html

@@ -0,0 +1,6 @@
+<blockquote>
+<p class='quotation'>hello</p>
+<p class='citation'>
+<span class='position'>Additional attribute title</span>
+</p>
+</blockquote>

data/spec/transformer_spec.rb

@@ -33,7 +33,7 @@ describe Shortcode do
 
     it "converts into html" do
       obj = parser.parse(simple_quote)
-      html = transformer.apply obj
+      html = transformer.apply obj, additional_attributes: nil
       html.should == simple_quote_output
     end
 
@@ -42,7 +42,7 @@ describe Shortcode do
   context "full_quote" do
 
     it "converts into html" do
-      html = transformer.apply(parser.parse(full_quote))
+      html = transformer.apply(parser.parse(full_quote), additional_attributes: nil)
       html.should == full_quote_output
     end
 
@@ -51,7 +51,7 @@ describe Shortcode do
   context "quote_with_extras" do
 
     it "converts into html" do
-      html = transformer.apply(parser.parse(quote_with_extras))
+      html = transformer.apply(parser.parse(quote_with_extras), additional_attributes: nil)
       html.should == quote_with_extras_output
     end
 
@@ -60,7 +60,7 @@ describe Shortcode do
   context "simple_list" do
 
     it "converts into html" do
-      html = transformer.apply(parser.parse(simple_list))
+      html = transformer.apply(parser.parse(simple_list), additional_attributes: nil)
       html.should == simple_list_output
     end
 
@@ -69,7 +69,7 @@ describe Shortcode do
   context "timeline_event" do
 
     it "converts into html" do
-      html = transformer.apply(parser.parse(timeline_event))
+      html = transformer.apply(parser.parse(timeline_event), additional_attributes: nil)
       html.should == timeline_event_output
     end
 
@@ -78,7 +78,7 @@ describe Shortcode do
   context "timeline_info" do
 
     it "converts into html" do
-      html = transformer.apply(parser.parse(timeline_info))
+      html = transformer.apply(parser.parse(timeline_info), additional_attributes: nil)
       html.should == timeline_info_output
     end
 
@@ -87,7 +87,7 @@ describe Shortcode do
   context "timeline_person" do
 
     it "converts into html" do
-      html = transformer.apply(parser.parse(timeline_person))
+      html = transformer.apply(parser.parse(timeline_person), additional_attributes: nil)
       html.should == timeline_person_output
     end
 
@@ -96,7 +96,7 @@ describe Shortcode do
   context "complex_snippet" do
 
     it "converts into html" do
-      html = transformer.apply(parser.parse(complex_snippet))
+      html = transformer.apply(parser.parse(complex_snippet), additional_attributes: nil)
       html.should == complex_snippet_output
     end
   end
@@ -111,7 +111,7 @@ describe Shortcode do
     end
 
     it "converts into html" do
-      html = transformer.apply(parser.parse(simple_quote))
+      html = transformer.apply(parser.parse(simple_quote), additional_attributes: nil)
       html.gsub("\n",'').should == simple_quote_output.gsub("\n",'')
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortcode
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-18 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +103,7 @@ files:
 - .travis.yml
 - Appraisals
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -115,6 +116,7 @@ files:
 - lib/shortcode/exceptions.rb
 - lib/shortcode/parser.rb
 - lib/shortcode/presenter.rb
+- lib/shortcode/processor.rb
 - lib/shortcode/railtie.rb
 - lib/shortcode/tag.rb
 - lib/shortcode/transformer.rb
@@ -141,6 +143,7 @@ files:
 - spec/support/fixtures/simple_list_output.html
 - spec/support/fixtures/simple_quote.txt
 - spec/support/fixtures/simple_quote_output.html
+- spec/support/fixtures/simple_quote_presenter_attributes_output.html
 - spec/support/fixtures/simple_quote_presenter_output.html
 - spec/support/fixtures/timeline_event.txt
 - spec/support/fixtures/timeline_event_output.html
@@ -206,6 +209,7 @@ test_files:
 - spec/support/fixtures/simple_list_output.html
 - spec/support/fixtures/simple_quote.txt
 - spec/support/fixtures/simple_quote_output.html
+- spec/support/fixtures/simple_quote_presenter_attributes_output.html
 - spec/support/fixtures/simple_quote_presenter_output.html
 - spec/support/fixtures/timeline_event.txt
 - spec/support/fixtures/timeline_event_output.html