shortcode 0.4.3 → 1.0.0

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.0.0 (July 29, 2014)
+
+Features:
+
+  - Adds support for attributes without quotations around them
+
+Breaking Changes:
+
+  - Renamed configuration options so they are more clear
+
+
 ## 0.4.3 (July 16, 2014)
 
 Features:

data/Gemfile.lock

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

data/README.md

@@ -107,6 +107,7 @@ If you wish to use custom helper modules in templates you can do so by specifyin
 Shortcode.setup do |config|
   config.helpers = [CustomHelper, AnotherCustomHelper]
 end
+```
 
 ### Presenters
 
@@ -213,7 +214,10 @@ Shortcode.setup do |config|
   config.self_closing_tags = [:youtube]
 
   # the type of quotes to use for attribute values, default is double quotes (")
-  config.quotes = '"'
+  config.attribute_quote_type = '"'
+
+  # Allows quotes around attributes to be omitted. Defaults to true (quotes must be present around the value).
+  config.use_attribute_quotes = true
 end
 ```
 

data/lib/shortcode/configuration.rb

@@ -18,15 +18,19 @@ class Shortcode::Configuration
   attr_accessor :self_closing_tags
 
   # Set the quotation sign used for attribute values. Defaults to double quote (")
-  attr_accessor :quotes
+  attr_accessor :attribute_quote_type
+
+  # Allows quotes around attributes to be omitted. Defaults to false (quotes must be present around the value).
+  attr_accessor :use_attribute_quotes
 
   def initialize
-    @template_parser    = :erb
-    @template_path      = "app/views/shortcode_templates"
-    @templates          = nil
-    @helpers            = []
-    @block_tags         = []
-    @self_closing_tags  = []
-    @quotes             = '"'
+    @template_parser      = :erb
+    @template_path        = "app/views/shortcode_templates"
+    @templates            = nil
+    @helpers              = []
+    @block_tags           = []
+    @self_closing_tags    = []
+    @attribute_quote_type = '"'
+    @use_attribute_quotes = true
   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(Shortcode.configuration.quotes) }
+  rule(:quotes) { str(Shortcode.configuration.attribute_quote_type) }
 
   rule(:space)        { str(' ').repeat(1) }
   rule(:space?)       { space.maybe }
@@ -11,8 +11,11 @@ class Shortcode::Parser < Parslet::Parser
   rule(:whitespace)   { (space | newline).repeat(1) }
   rule(:whitespace?)  { whitespace.maybe }
 
-  rule(:key)    { match('[a-zA-Z0-9\-_]').repeat(1) }
-  rule(:value)  { quotes >> (quotes.absent? >> any).repeat.as(:value) >> quotes }
+  rule(:key) { match('[a-zA-Z0-9\-_]').repeat(1) }
+
+  rule(:value_with_quotes) { quotes >> (quotes.absent? >> any).repeat.as(:value) >> quotes }
+  rule(:value_without_quotes) { quotes.absent? >> ( (str(']') | whitespace).absent? >> any ).repeat.as(:value) }
+  rule(:value) { Shortcode.configuration.use_attribute_quotes ? value_with_quotes : (value_without_quotes | value_with_quotes) }
 
   rule(:option)   { key.as(:key) >> str('=') >> value }
   rule(:options)  { (str(' ') >> option).repeat(1) }

data/lib/shortcode/version.rb

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

data/spec/parser_spec.rb

@@ -8,6 +8,7 @@ describe Shortcode::Parser do
 
   let(:simple_quote)      { load_fixture :simple_quote }
   let(:full_quote)        { load_fixture :full_quote }
+  let(:without_quotes)    { load_fixture :without_quotes }
   let(:quote_with_extras) { load_fixture :quote_with_extras }
   let(:simple_list)       { load_fixture :simple_list }
   let(:timeline_event)    { load_fixture :timeline_event }
@@ -25,20 +26,35 @@ describe Shortcode::Parser do
     end
   end
 
-  it "parses quotes using custom quotations" do
-    Shortcode.setup do |config|
-      config.quotes = "'"
+  context "attribute_quote_type configuration" do
+
+    before do
+      Shortcode.setup do |config|
+        config.attribute_quote_type = "'"
+      end
     end
 
-    quotes.each do |string|
-      # Change double quotes to single quotes in the fixture
-      expect(parser).to parse(string.gsub '"', "'")
+    it "parses quotes using custom quotations" do
+      quotes.each do |string|
+        # Change double quotes to single quotes in the fixture
+        expect(parser).to parse(string.gsub '"', "'")
+      end
     end
 
-    # Reset configuration to default
-    Shortcode.setup do |config|
-      config.quotes = '"'
+  end
+
+  context "use_attribute_quotes configuration" do
+
+    before do
+      Shortcode.setup do |config|
+        config.use_attribute_quotes = false
+      end
     end
+
+    it "parses shortcodes with optional quotes" do
+      expect(parser).to parse(without_quotes)
+    end
+
   end
 
   it "parses list shortcodes" do

data/spec/spec_helper.rb

@@ -25,7 +25,8 @@ RSpec.configure do |config|
       config.templates = nil
       config.block_tags = [:quote, :collapsible_list, :item, :timeline_person, :rails_helper, :custom_helper]
       config.self_closing_tags = [:timeline_event, :timeline_info]
-      config.quotes = '"'
+      config.attribute_quote_type = '"'
+      config.use_attribute_quotes = true
     end
   end
 end

data/spec/support/fixtures/without_quotes.txt

@@ -0,0 +1 @@
+[quote author="Jamie Dyer" title=King_of_England]A quote[/quote]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortcode
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -191,6 +191,7 @@ files:
 - spec/support/fixtures/timeline_info_output.html
 - spec/support/fixtures/timeline_person.txt
 - spec/support/fixtures/timeline_person_output.html
+- spec/support/fixtures/without_quotes.txt
 - spec/support/presenters/missing_attributes_presenter.rb
 - spec/support/presenters/missing_content_presenter.rb
 - spec/support/presenters/missing_for_presenter.rb
@@ -273,6 +274,7 @@ test_files:
 - spec/support/fixtures/timeline_info_output.html
 - spec/support/fixtures/timeline_person.txt
 - spec/support/fixtures/timeline_person_output.html
+- spec/support/fixtures/without_quotes.txt
 - spec/support/presenters/missing_attributes_presenter.rb
 - spec/support/presenters/missing_content_presenter.rb
 - spec/support/presenters/missing_for_presenter.rb