shortcode 1.2.1 → 2.0.0.pre

data/lib/shortcode/configuration.rb

@@ -1,4 +1,5 @@
 class Shortcode::Configuration
+
   # Sets the template parser to use, supports :erb, :haml, and :slim, default is :haml
   attr_accessor :template_parser
 
@@ -32,7 +33,7 @@ class Shortcode::Configuration
   # Set the quotation sign used for attribute values. Defaults to double quote (")
   attr_accessor :attribute_quote_type
 
-  # Allows quotes around attributes to be omitted. Defaults to false (quotes must be present around the value).
+  # Allows quotes around attributes to be omitted. Defaults to false (quotes must be present around the value)
   attr_accessor :use_attribute_quotes
 
   def initialize
@@ -51,4 +52,5 @@ class Shortcode::Configuration
   def register_presenter(presenter)
     Shortcode::Presenter.register(self, presenter)
   end
+
 end

data/lib/shortcode/parser.rb

@@ -1,4 +1,5 @@
 class Shortcode::Parser
+
   def initialize(configuration)
     @configuration = configuration
     setup_rules
@@ -23,51 +24,54 @@ class Shortcode::Parser
     @klass_instance ||= klass.new
   end
 
+  # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/LineLength
   def setup_rules
     define_match_any_of
 
     shortcode_configuration = @configuration
-    klass.rule(:block_tag)        { match_any_of shortcode_configuration.block_tags }
+    klass.rule(:block_tag) { match_any_of shortcode_configuration.block_tags }
     klass.rule(:self_closing_tag) { match_any_of shortcode_configuration.self_closing_tags }
 
     klass.rule(:quotes) { str(shortcode_configuration.attribute_quote_type) }
 
-    klass.rule(:space)        { str(' ').repeat(1) }
-    klass.rule(:space?)       { space.maybe }
-    klass.rule(:newline)      { (str("\r\n") | str("\n")) >> space? }
-    klass.rule(:newline?)     { newline.maybe }
-    klass.rule(:whitespace)   { (space | newline).repeat(1) }
+    klass.rule(:space) { str(" ").repeat(1) }
+    klass.rule(:space?) { space.maybe }
+    klass.rule(:newline) { (str("\r\n") | str("\n")) >> space? }
+    klass.rule(:newline?) { newline.maybe }
+    klass.rule(:whitespace) { (space | newline).repeat(1) }
 
     klass.rule(:key) { match('[a-zA-Z0-9\-_]').repeat(1) }
 
     klass.rule(:value_with_quotes) { quotes >> (quotes.absent? >> any).repeat.as(:value) >> quotes }
-    klass.rule(:value_without_quotes) { quotes.absent? >> ( (str(']') | whitespace).absent? >> any ).repeat.as(:value) }
+    klass.rule(:value_without_quotes) { quotes.absent? >> ((str("]") | whitespace).absent? >> any).repeat.as(:value) }
     klass.rule(:value) { shortcode_configuration.use_attribute_quotes ? value_with_quotes : (value_without_quotes | value_with_quotes) }
 
-    klass.rule(:option)   { key.as(:key) >> str('=') >> value }
-    klass.rule(:options)  { (str(' ') >> option).repeat(1) }
+    klass.rule(:option) { key.as(:key) >> str("=") >> value }
+    klass.rule(:options) { (str(" ") >> option).repeat(1) }
     klass.rule(:options?) { options.repeat(0, 1) }
 
-    klass.rule(:open)       { str('[') >> block_tag.as(:open) >> options?.as(:options) >> str(']') >> newline? }
-    klass.rule(:close)      { str('[/') >> block_tag.as(:close) >> str(']') >> newline? }
-    klass.rule(:open_close) { str('[') >> self_closing_tag.as(:open_close) >> options?.as(:options) >> str(']') >> newline? }
+    klass.rule(:open) { str("[") >> block_tag.as(:open) >> options?.as(:options) >> str("]") >> newline? }
+    klass.rule(:close) { str("[/") >> block_tag.as(:close) >> str("]") >> newline? }
+    klass.rule(:open_close) { str("[") >> self_closing_tag.as(:open_close) >> options?.as(:options) >> str("]") >> newline? }
 
-    klass.rule(:text)   { ((close | block | open_close).absent? >> any).repeat(1).as(:text) }
-    klass.rule(:block)  { (open >> (block | text | open_close).repeat.as(:inner) >> close) }
+    klass.rule(:text) { ((close | block | open_close).absent? >> any).repeat(1).as(:text) }
+    klass.rule(:block) { (open >> (block | text | open_close).repeat.as(:inner) >> close) }
 
     klass.rule(:body) { (block | text | open_close).repeat.as(:body) }
     klass.root(:body)
   end
+  # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/LineLength
 
   def define_match_any_of
     klass.send(:define_method, :match_any_of) do |tags|
-      if tags.length < 1
-        return str('')
+      if tags.empty?
+        str("")
       else
-        tags.map{ |tag| str(tag) }.inject do |tag_chain, tag|
+        tags.map { |tag| str(tag) }.inject do |tag_chain, tag|
           tag_chain.send :|, tag
         end
       end
     end
   end
+
 end

data/lib/shortcode/presenter.rb

@@ -1,14 +1,21 @@
 class Shortcode::Presenter
+
   def self.register(configuration, presenter)
     validate presenter
     [*presenter.for].each { |k| configuration.presenters[k.to_sym] = presenter }
   end
 
   def self.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)
+    unless presenter.respond_to?(:for)
+      raise ArgumentError, "The presenter must define the class method #for"
+    end
+    unless presenter.private_instance_methods(false).include?(:initialize)
+      raise ArgumentError, "The presenter must define an initialize method"
+    end
+    %w[content attributes].each do |method|
+      unless presenter.method_defined?(method.to_sym)
+        raise ArgumentError, "The presenter must define the method ##{method}"
+      end
     end
   end
 
@@ -20,23 +27,19 @@ class Shortcode::Presenter
     initialize_custom_presenter(name)
   end
 
-  def content
-    @content
-  end
+  attr_reader :content
 
-  def attributes
-    @attributes
-  end
+  attr_reader :attributes
 
   private
 
   attr_reader :configuration
 
   def initialize_custom_presenter(name)
-    if configuration.presenters.has_key? name.to_sym
-      presenter   = configuration.presenters[name.to_sym].new(@attributes, @content, @additional_attributes)
-      @attributes = presenter.attributes
-      @content    = presenter.content
-    end
+    return unless configuration.presenters.key?(name.to_sym)
+    presenter   = configuration.presenters[name.to_sym].new(@attributes, @content, @additional_attributes)
+    @attributes = presenter.attributes
+    @content    = presenter.content
   end
+
 end

data/lib/shortcode/processor.rb

@@ -1,7 +1,8 @@
 class Shortcode::Processor
 
   def process(string, configuration, additional_attributes=nil)
-    transformer(configuration).apply parser(configuration).parse(string), additional_attributes: additional_attributes
+    transformer(configuration).apply parser(configuration).parse(string),
+                                     additional_attributes: additional_attributes
   end
 
   private
@@ -13,4 +14,5 @@ class Shortcode::Processor
   def transformer(configuration)
     @transformer ||= Shortcode::Transformer.new(configuration)
   end
+
 end

data/lib/shortcode/railtie.rb

@@ -1,3 +1,5 @@
 class Shortcode::TemplateBinding
+
   include ActionView::Helpers
+
 end

data/lib/shortcode/tag.rb

@@ -1,9 +1,13 @@
 class Shortcode::Tag
 
-  def initialize(name, configuration, attributes=[], content='', additional_attributes=nil)
+  def initialize(name, configuration, attributes=[], content="", additional_attributes=nil)
     @name = name.downcase
     @configuration = configuration
-    @binding = Shortcode::TemplateBinding.new(@name, @configuration, attributes, content, additional_attributes)
+    @binding = Shortcode::TemplateBinding.new(@name,
+                                              @configuration,
+                                              attributes,
+                                              content,
+                                              additional_attributes)
   end
 
   def markup
@@ -21,10 +25,11 @@ class Shortcode::Tag
 
   attr_reader :configuration
 
+  # rubocop:disable Metrics/AbcSize
   def render_template
     case configuration.template_parser
     when :erb
-      ERB.new(markup).result(@binding.get_binding)
+      ERB.new(markup).result(@binding.expose_binding)
     when :haml
       Haml::Engine.new(markup).render(@binding)
     when :slim
@@ -33,6 +38,7 @@ class Shortcode::Tag
       raise Shortcode::TemplateParserNotSupported, configuration.template_parser
     end
   end
+  # rubocop:enable Metrics/AbcSize
 
   def first_priority_template
     configuration.check_config_templates_first ? markup_from_config : markup_from_file
@@ -60,6 +66,7 @@ class Shortcode::Tag
   end
 
   def template_paths
-    [ "#{@name}.html.#{configuration.template_parser.to_s}", "#{@name}.#{configuration.template_parser.to_s}" ]
+    ["#{@name}.html.#{configuration.template_parser}", "#{@name}.#{configuration.template_parser}"]
   end
+
 end

data/lib/shortcode/template_binding.rb

@@ -1,16 +1,20 @@
 class Shortcode::TemplateBinding
 
-  def initialize(name, configuration, attributes=[], content='', additional_attributes=nil)
+  def initialize(name, configuration, attributes=[], content="", additional_attributes=nil)
     @configuration = configuration
     include_helper_modules
-    presenter      = Shortcode::Presenter.new name, configuration, set_attributes(attributes), content, additional_attributes
-    @name          = name
-    @attributes    = presenter.attributes
-    @content       = presenter.content
+    presenter = Shortcode::Presenter.new name,
+                                         configuration,
+                                         map_attributes(attributes),
+                                         content,
+                                         additional_attributes
+    @name = name
+    @attributes = presenter.attributes
+    @content = presenter.content
   end
 
   # Expose private binding() method for use with erb templates
-  def get_binding
+  def expose_binding
     binding
   end
 
@@ -18,7 +22,7 @@ class Shortcode::TemplateBinding
 
   attr_reader :configuration
 
-  def set_attributes(attributes)
+  def map_attributes(attributes)
     hash = {}
     attributes.each { |o| hash[o[:key].to_sym] = o[:value] }
     hash
@@ -31,4 +35,5 @@ class Shortcode::TemplateBinding
       self.class.send(:include, helper)
     end
   end
+
 end

data/lib/shortcode/transformer.rb

@@ -1,10 +1,11 @@
 class Shortcode::Transformer
+
   def initialize(configuration)
     @configuration = configuration
     setup_rules
   end
 
-  def apply(str, options = {})
+  def apply(str, options={})
     klass_instance.apply(str, options)
   end
 
@@ -18,8 +19,9 @@ class Shortcode::Transformer
     @klass_instance ||= klass.new
   end
 
+  # rubocop:disable Metrics/AbcSize
   def setup_rules
-    shortcode_configuration = @configuration
+    config = @configuration
 
     klass.rule(text: klass.send(:simple, :text)) { String(text) }
     klass.rule(
@@ -27,12 +29,14 @@ class Shortcode::Transformer
       options:  klass.send(:subtree, :options),
       inner:    klass.send(:sequence, :inner),
       close:    klass.send(:simple, :name)
-    ) { Shortcode::Tag.new(name.to_s, shortcode_configuration, options, inner.join, additional_attributes).render }
+    ) { Shortcode::Tag.new(name.to_s, config, options, inner.join, additional_attributes).render }
     klass.rule(
       open_close: klass.send(:simple, :name),
       options:    klass.send(:subtree, :options)
-    ) { Shortcode::Tag.new(name.to_s, shortcode_configuration, options, '', additional_attributes).render }
+    ) { Shortcode::Tag.new(name.to_s, config, options, "", additional_attributes).render }
 
     klass.rule(body: klass.send(:sequence, :strings)) { strings.join }
   end
+  # rubocop:enable Metrics/AbcSize
+
 end

data/lib/shortcode/version.rb

@@ -1,3 +1,5 @@
 class Shortcode
-  VERSION = "1.2.1"
+
+  VERSION = "2.0.0.pre".freeze
+
 end

data/shortcode.gemspec

@@ -1,7 +1,7 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'shortcode/version'
+require "shortcode/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "shortcode"
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/kernow/shortcode"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
@@ -21,9 +21,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "parslet", "1.8.0"
 
   spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "coveralls", "~> 0.8"
-  spec.add_development_dependency "slim", "~> 3.0"
   spec.add_development_dependency "haml", "~> 5.0"
+  spec.add_development_dependency "rails", "5.1.4"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "rubocop", "~> 0.51"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.19"
+  spec.add_development_dependency "slim", "~> 3.0"
 end

data/spec/.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_from:
+  - ../.rubocop.yml
+
+EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 3
+
+RSpec/NestedGroups:
+  Max: 3

data/spec/performance_spec.rb

@@ -1,11 +1,10 @@
-require 'spec_helper'
-require 'parslet/rig/rspec'
-require 'pp'
-require 'benchmark'
+require "spec_helper"
+require "parslet/rig/rspec"
+require "pp"
+require "benchmark"
 
 # Uncomment to run performace specs
 
-
 # describe Shortcode do
 
 #   let(:long_text)   { load_fixture :long_text }

data/spec/rails_helpers_spec.rb

@@ -1,72 +1,66 @@
-require 'spec_helper'
+require "spec_helper"
 
 module ShortcodeSpecViewHelper
+
   def wrap_in_p(content)
     content_tag :p, content
   end
-end
 
-describe "rails helpers" do
+end
 
+describe "rails helpers", type: :feature do
   let(:template)    { load_fixture :rails_helper }
 
   let(:erb_output)  { load_fixture :rails_helper_output_erb,  :html }
   let(:haml_output) { load_fixture :rails_helper_output_haml, :html }
   let(:slim_output) { load_fixture :rails_helper_output_slim, :html }
 
-  describe "erb" do
+  let(:shortcode) { Shortcode.new }
+  let(:configuration) { shortcode.configuration }
 
+  before do
+    configuration.block_tags = %i[rails_helper custom_helper]
+    configuration.template_path = File.join File.dirname(__FILE__), "support/templates/erb"
+  end
+
+  describe "erb" do
     it "are accessible within erb templates" do
-      expect(Shortcode.process(template).gsub("\n",'')).to eq(erb_output)
+      expect(shortcode.process(template).delete("\n")).to eq(erb_output)
     end
-
   end
 
   describe "haml" do
-
-    before(:each) do
-      Shortcode.setup do |config|
-        config.template_parser = :haml
-        config.template_path = File.join File.dirname(__FILE__), "support/templates/haml"
-      end
+    before do
+      configuration.template_parser = :haml
+      configuration.template_path = File.join File.dirname(__FILE__), "support/templates/haml"
     end
 
     it "are accessible within haml templates" do
-      expect(Shortcode.process(template).gsub("\n",'')).to eq(haml_output)
+      expect(shortcode.process(template).delete("\n")).to eq(haml_output)
     end
-
   end
 
   describe "slim" do
-
-    before(:each) do
-      Shortcode.setup do |config|
-        config.template_parser = :slim
-        config.template_path = File.join File.dirname(__FILE__), "support/templates/slim"
-      end
+    before do
+      configuration.template_parser = :slim
+      configuration.template_path = File.join File.dirname(__FILE__), "support/templates/slim"
     end
 
     it "are accessible within slim templates" do
-      expect(Shortcode.process(template).gsub("\n",'')).to eq(slim_output)
+      expect(shortcode.process(template).delete("\n")).to eq(slim_output)
     end
-
   end
 
   describe "using a custom helper module" do
-
     let(:template) { load_fixture :custom_helper }
-    let(:output)   { load_fixture :custom_helper_output,  :html }
+    let(:output)   { load_fixture :custom_helper_output, :html }
 
-    before(:each) do
-      Shortcode.setup do |config|
-        config.helpers = [ShortcodeSpecViewHelper]
-      end
+    before do
+      configuration.helpers = [ShortcodeSpecViewHelper]
     end
 
     it "is accessible within templates" do
-      expect(Shortcode.process(template).gsub("\n",'')).to eq(output)
+      expect(shortcode.process(template).delete("\n")).to eq(output)
     end
-
   end
-
 end