shortcode 0.4.2 → 0.4.3

data/Appraisals

@@ -7,13 +7,13 @@ appraise "rails-3.1" do
 end
 
 appraise "rails-3.2" do
-  gem "rails", "~> 3.2.18"
+  gem "rails", "~> 3.2.19"
 end
 
 appraise "rails-4.0" do
-  gem "rails", "~> 4.0.5"
+  gem "rails", "~> 4.0.8"
 end
 
 appraise "rails-4.1" do
-  gem "rails", "~> 4.1.1"
+  gem "rails", "~> 4.1.4"
 end

data/CHANGELOG.md

@@ -0,0 +1,123 @@
+## 0.4.3 (July 16, 2014)
+
+Features:
+
+  - Adds support for custom helpers in templates
+
+
+## 0.4.2 (July 1, 2014)
+
+Features:
+
+  - Adds presenter class method validation
+
+
+## 0.4.1 (June 18, 2014)
+
+Features:
+
+  - Adds support to apply a single presenter to multiple short code snippets
+
+Misc:
+
+  - Prevent coveralls from running locally
+  - Updated to rspec 3
+
+
+## 0.4.0 (June 16, 2014)
+
+Features:
+
+  - Switched to erb as the default template language and removed dependency on haml
+
+
+## 0.3.3 (June 3, 2014)
+
+Misc:
+
+  - Added haml default template parser deprecation message
+
+
+## 0.3.1 (May 30, 2014)
+
+Features:
+
+  - Added support for slim templates (@keichan34)
+  - Updated rails versions to test against and updated read me with tested versions of ruby/rails
+
+
+## 0.3.0 (May 13, 2014)
+
+Features:
+
+  - Added config option to support loading templates from strings
+
+
+## 0.2.0 (May 9, 2014)
+
+Features:
+
+  - Presenters now support additional attributes
+  - Updated parslet gem to 1.6.0 for performance improvements
+  - Add config option for quotation sign (@lenart)
+
+
+## 0.1.2 (March 18, 2014)
+
+Features:
+
+  - Test suite runs against multiple version of ruby and rails
+
+Bugfixes:
+
+  - Presenters are now initialised correctly, allow gem to be used without needing to call Shortcode.setup (fixes #6)
+  - Only include rails helpers in rails version 3 or higher
+
+Misc:
+
+  - Simplify presenter image lookup in README (@chrsgrrtt)
+
+
+## 0.1.1 (February 23, 2014)
+
+Features:
+
+  - Support rails helpers in templates when used within a rails project
+
+
+## 0.1.0 (February 23, 2014)
+
+Features:
+
+  - Presenters added
+
+
+## 0.0.4 (February 23, 2014)
+
+Bugfixes:
+
+  - Support configurations with empty tag arrays (fixes #1)
+
+
+## 0.0.3 (August 23, 2013)
+
+Misc:
+
+  - Relaxed haml version requirement
+  - Removed dependency on the facets gem
+
+
+## 0.0.2 (August 7, 2013)
+
+Features:
+
+  - Added a convenience method to parse and transform at the same time
+  - Added examples to README
+  - Changed default tags in config
+  - Changed @options variable to @attributes in templates to better describe what it is
+  - Change the @text variable to @content in templates
+
+
+## 0.0.1 (August 5, 2013)
+
+Initial Release

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,6 @@
 # Shortcode
 
-A ruby gem for parsing Wordpress style shortcodes. The gem uses a [PEG](http://en.wikipedia.org/wiki/Parsing_expression_grammar) (Parsing Expression Grammar) parser rather than using regular expressions so its easier to understand, test and extend.
+Shortcode is a ruby gem for parsing Wordpress style shortcodes, I created it while building a CMS for a client through [my ruby consultancy, Kernow Soul](http://kernowsoul.com). The gem uses a [PEG](http://en.wikipedia.org/wiki/Parsing_expression_grammar) (Parsing Expression Grammar) parser rather than using regular expressions so its easier to understand, test and extend.
 
 [![Gem Version](https://badge.fury.io/rb/shortcode.svg)](http://badge.fury.io/rb/shortcode)
 [![Build Status](https://travis-ci.org/kernow/shortcode.png?branch=master)](https://travis-ci.org/kernow/shortcode)
@@ -40,32 +40,6 @@ Shortcode is very simple to use, simply call the `process` method and pass it a
 Shortcode.process("[quote]Hello World[/quote]")
 ```
 
-### Configuration
-
-```ruby
-Shortcode.setup do |config|
-
-  # the template parser to use
-  config.template_parser = :erb # :erb, :haml, :slim supported, :erb is default
-
-   # location of the template files, default is "app/views/shortcode_templates"
-  config.template_path = "support/templates/erb"
-
-   # a hash of templates passed as strings, if this is set it overrides the
-   # above template_path option. The default is nil
-  config.templates = { gallery: 'template code' }
-
-  # a list of block tags to support e.g. [quote]Hello World[/quote]
-  config.block_tags = [:quote]
-
-  # 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
-```
-
 ### Templates
 
 Each shortcode tag needs a template in order to translate the shortcode into html (or other output). Templates can be written in erb, haml or slim and work in
@@ -125,6 +99,15 @@ end
 If the `templates` config option is set all templates will be loaded from this hash, if a shortcode is encountered without a matching key in the `templates` config option
 an exception will be raised.
 
+### Custom Helpers
+
+If you wish to use custom helper modules in templates you can do so by specifying the helpers in a setup block which should be an array. Methods in the helper modules will then become available within all tempaltes.
+
+```ruby
+Shortcode.setup do |config|
+  config.helpers = [CustomHelper, AnotherCustomHelper]
+end
+
 ### 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 `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.
@@ -205,6 +188,36 @@ To register a presenter simply call `Shortcode.register_presenter` passing the p
 Shortcode.register_presenter(CustomPresenter)
 ```
 
+### Configuration
+
+```ruby
+Shortcode.setup do |config|
+
+  # the template parser to use
+  config.template_parser = :erb # :erb, :haml, :slim supported, :erb is default
+
+  # location of the template files, default is "app/views/shortcode_templates"
+  config.template_path = "support/templates/erb"
+
+  # a hash of templates passed as strings, if this is set it overrides the
+  # above template_path option. The default is nil
+  config.templates = { gallery: 'template code' }
+
+  # an array of helper modules to make available within tempaltes
+  config.helpers = [CustomerHelper]
+
+  # a list of block tags to support e.g. [quote]Hello World[/quote]
+  config.block_tags = [:quote]
+
+  # 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
+```
+
+
 ## Contributing
 
 1. Fork it

data/gemfiles/rails_3.2.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal", "1.0.0.beta3"
-gem "rails", "~> 3.2.18"
+gem "rails", "~> 3.2.19"
 
 gemspec :path=>".././"

data/gemfiles/rails_4.0.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal", "1.0.0.beta3"
-gem "rails", "~> 4.0.5"
+gem "rails", "~> 4.0.8"
 
 gemspec :path=>".././"

data/gemfiles/rails_4.1.gemfile

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal", "1.0.0.beta3"
-gem "rails", "~> 4.1.1"
+gem "rails", "~> 4.1.4"
 
 gemspec :path=>".././"

data/lib/shortcode/configuration.rb

@@ -8,6 +8,9 @@ class Shortcode::Configuration
   # Allows templates to be set from strings rather than read from the filesystem
   attr_accessor :templates
 
+  # Assigns helper modules to be included in templates
+  attr_accessor :helpers
+
   # Set the supported block_tags
   attr_accessor :block_tags
 
@@ -21,6 +24,7 @@ class Shortcode::Configuration
     @template_parser    = :erb
     @template_path      = "app/views/shortcode_templates"
     @templates          = nil
+    @helpers            = []
     @block_tags         = []
     @self_closing_tags  = []
     @quotes             = '"'

data/lib/shortcode/tag.rb

@@ -1,6 +1,7 @@
 class Shortcode::Tag
 
   def initialize(name, attributes=[], content='', additional_attributes=nil)
+    include_helper_modules
     @name       = name.downcase
     presenter   = Shortcode::Presenter.new name, set_attributes(attributes), content, additional_attributes
     @attributes = presenter.attributes
@@ -27,6 +28,15 @@ class Shortcode::Tag
 
   private
 
+    def include_helper_modules
+      return unless Shortcode.configuration.helpers.any?
+      class << self
+        Shortcode.configuration.helpers.each do |helper|
+          include helper
+        end
+      end
+    end
+
     def render_template
       case Shortcode.configuration.template_parser
       when :erb

data/lib/shortcode/version.rb

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

data/spec/rails_helpers_spec.rb

@@ -1,5 +1,11 @@
 require 'spec_helper'
 
+module ShortcodeSpecViewHelper
+  def wrap_in_p(content)
+    content_tag :p, content
+  end
+end
+
 describe "rails helpers" do
 
   let(:template)    { load_fixture :rails_helper }
@@ -46,4 +52,21 @@ describe "rails helpers" do
 
   end
 
+  describe "using a custom helper module" do
+
+    let(:template) { load_fixture :custom_helper }
+    let(:output)   { load_fixture :custom_helper_output,  :html }
+
+    before(:each) do
+      Shortcode.setup do |config|
+        config.helpers = [ShortcodeSpecViewHelper]
+      end
+    end
+
+    it "is accessible within templates" do
+      expect(Shortcode.process(template).gsub("\n",'')).to eq(output)
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -23,7 +23,7 @@ RSpec.configure do |config|
       config.template_parser = :erb
       config.template_path = File.join File.dirname(__FILE__), "support/templates/erb"
       config.templates = nil
-      config.block_tags = [:quote, :collapsible_list, :item, :timeline_person, :rails_helper]
+      config.block_tags = [:quote, :collapsible_list, :item, :timeline_person, :rails_helper, :custom_helper]
       config.self_closing_tags = [:timeline_event, :timeline_info]
       config.quotes = '"'
     end

data/spec/support/fixtures/custom_helper.txt

@@ -0,0 +1 @@
+[custom_helper]something[/custom_helper]

data/spec/support/fixtures/custom_helper_output.html

@@ -0,0 +1 @@
+<p>something</p>

data/spec/support/templates/erb/custom_helper.html.erb

@@ -0,0 +1 @@
+<%= wrap_in_p(@content) %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortcode
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -134,6 +134,7 @@ files:
 - .rbenv-version
 - .travis.yml
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -164,6 +165,8 @@ files:
 - spec/support/fixtures.rb
 - spec/support/fixtures/complex_snippet.txt
 - spec/support/fixtures/complex_snippet_output.html
+- spec/support/fixtures/custom_helper.txt
+- spec/support/fixtures/custom_helper_output.html
 - spec/support/fixtures/full_quote.txt
 - spec/support/fixtures/full_quote_output.html
 - spec/support/fixtures/item.txt
@@ -195,6 +198,7 @@ files:
 - spec/support/presenters/multiple_presenter.rb
 - spec/support/presenters/my_presenter.rb
 - spec/support/templates/erb/collapsible_list.html.erb
+- spec/support/templates/erb/custom_helper.html.erb
 - spec/support/templates/erb/item.html.erb
 - spec/support/templates/erb/quote.html.erb
 - spec/support/templates/erb/rails_helper.html.erb
@@ -243,6 +247,8 @@ test_files:
 - spec/support/fixtures.rb
 - spec/support/fixtures/complex_snippet.txt
 - spec/support/fixtures/complex_snippet_output.html
+- spec/support/fixtures/custom_helper.txt
+- spec/support/fixtures/custom_helper_output.html
 - spec/support/fixtures/full_quote.txt
 - spec/support/fixtures/full_quote_output.html
 - spec/support/fixtures/item.txt
@@ -274,6 +280,7 @@ test_files:
 - spec/support/presenters/multiple_presenter.rb
 - spec/support/presenters/my_presenter.rb
 - spec/support/templates/erb/collapsible_list.html.erb
+- spec/support/templates/erb/custom_helper.html.erb
 - spec/support/templates/erb/item.html.erb
 - spec/support/templates/erb/quote.html.erb
 - spec/support/templates/erb/rails_helper.html.erb