flavour_saver 4.0.2 → 5.0.0

data/lib/flavour_saver/runtime.rb

@@ -1,30 +1,30 @@
-require 'cgi'
+require "cgi"
 
 module FlavourSaver
-  UnknownNodeTypeException          = Class.new(StandardError)
-  UnknownContextException           = Class.new(StandardError)
-  InappropriateUseOfElseException   = Class.new(StandardError)
+  UnknownNodeTypeException = Class.new(StandardError)
+  UnknownContextException = Class.new(StandardError)
+  InappropriateUseOfElseException = Class.new(StandardError)
   UndefinedPrivateVariableException = Class.new(StandardError)
-  UnknownHelperException            = Class.new(RuntimeError)
-  ForbiddenMethodException          = Class.new(UnknownHelperException)
+  UnknownHelperException = Class.new(RuntimeError)
+  ForbiddenMethodException = Class.new(UnknownHelperException)
   class Runtime
+    attr_accessor :context, :ast, :privates
+    attr_writer :parent
 
-    attr_accessor :context, :parent, :ast, :privates
-
-    def self.run(ast, context, locals={}, helpers=[])
-      self.new(ast, context, locals, helpers).to_s
+    def self.run(ast, context, locals = {}, helpers = [])
+      new(ast, context, locals, helpers).to_s
     end
 
-    def initialize(ast, context=nil, locals={}, helpers=[],parent=nil)
+    def initialize(ast, context = nil, locals = {}, helpers = [], parent = nil)
       @ast = ast
       @locals = locals
       @helpers = helpers
       @context = context
       @parent = parent
-      @privates = parent ? parent.privates.dup : { 'root' => context }
+      @privates = parent ? parent.privates.dup : {"root" => context}
     end
 
-    def to_s(tmp_context = nil,privates={})
+    def to_s(tmp_context = nil, privates = {})
       result = nil
       if tmp_context
         old_context = @context
@@ -35,37 +35,35 @@ module FlavourSaver
         @privates = old_privates
         @context = old_context
       else
-        result = evaluate_node(@ast).to_s.force_encoding(Encoding::default_external)
+        result = evaluate_node(@ast).to_s.force_encoding(Encoding.default_external)
       end
       result
     end
 
-    def private_variable_set(name,value)
+    def private_variable_set(name, value)
       @privates[name.to_s] = value
     end
 
     def private_variable_get(name)
-      begin
-        @privates.fetch(name)
-      rescue KeyError
-        raise UndefinedPrivateVariableException, "private variable not found @#{name}"
-      end
+      @privates.fetch(name)
+    rescue KeyError
+      raise UndefinedPrivateVariableException, "private variable not found @#{name}"
     end
 
     def strip(tmp_context = nil)
-      self.to_s(tmp_context).gsub(/[\s]+/,' ').strip
+      to_s(tmp_context).gsub(/\s+/, " ").strip
     end
 
     def evaluate_node(node)
       case node
       when TemplateNode
-        node.items.map { |n| evaluate_node(n) }.join('')
+        node.items.map { |n| evaluate_node(n) }.join("")
       when BlockExpressionNode
         evaluate_block(node).to_s
       when OutputNode
         node.value
       when NumberNode
-        if node.value =~ /\./
+        if /\./.match?(node.value)
           node.value.to_f
         else
           node.value.to_i
@@ -79,12 +77,12 @@ module FlavourSaver
       when CallNode
         evaluate_call(node)
       when Hash
-        node.each do |key,value|
+        node.each do |key, value|
           node[key] = evaluate_argument(value)
         end
         node
       when CommentNode
-        ''
+        ""
       when PartialNode
         evaluate_partial(node)
       else
@@ -102,37 +100,37 @@ module FlavourSaver
     end
 
     def evaluate_partial(node)
-      _context = context
-      _context = evaluate_argument(node.context) if node.context
+      partial_context = context
+      partial_context = evaluate_argument(node.context) if node.context
       if defined?(::Rails)
-        context.send(:render, :partial => node.name, :object => _context)
+        context.send(:render, partial: node.name, object: partial_context)
       else
         partial = Partial.fetch(node.name)
         if partial.respond_to? :call
-          partial.call(_context)
+          partial.call(partial_context)
         else
-          create_child_runtime(partial).to_s(_context)
+          create_child_runtime(partial).to_s(partial_context)
         end
       end
     end
 
-    def evaluate_call(call, context=self.context, &block)
-      context = Helpers.decorate_with(context,@helpers,@locals) unless context.is_a? Helpers::Decorator
+    def evaluate_call(call, context = self.context, &block)
+      context = Helpers.decorate_with(context, @helpers, @locals) unless context.is_a? Helpers::Decorator
       case call
       when ParentCallNode
         depth = call.depth
-        (2..depth).inject(parent) { |p| p.parent }.evaluate_call(call.to_callnode,&block)
+        (2..depth).inject(parent) { |p| p.parent }.evaluate_call(call.to_callnode, &block)
       when LiteralCallNode
         result = context.send(:[], call.name)
-        result = result.call(*call.arguments.map { |a| evaluate_argument(a) },&block) if result.respond_to? :call
+        result = result.call(*call.arguments.map { |a| evaluate_argument(a) }, &block) if result.respond_to? :call
         result
       when LocalVarNode
-        result = private_variable_get(call.name)
+        private_variable_get(call.name)
       else
         if forbidden_method? context, call.name
           raise ForbiddenMethodException, "Refusing to call #{call.name.inspect} from a template: it isn't a helper, a local, or part of the template context's own API. Register a helper if you meant to expose it, or use #{"{{[#{call.name}]}}"} to read a data field of that name."
         end
-        if call.parent.is_a? BlockExpressionNode and !context.respond_to? call.name
+        if call.parent.is_a?(BlockExpressionNode) && !context.respond_to?(call.name)
           raise UnknownHelperException, "Template context doesn't respond to method #{call.name.inspect}."
         end
         context.public_send(call.name, *call.arguments.map { |a| evaluate_argument(a) }, &block)
@@ -148,8 +146,8 @@ module FlavourSaver
     end
 
     def evaluate_object_path(path, &block)
-      path.inject(context) do |context,call|
-        context = evaluate_call(call, context, &block)
+      path.inject(context) do |context, call|
+        evaluate_call(call, context, &block)
       end
     end
 
@@ -157,11 +155,11 @@ module FlavourSaver
       evaluate_object_path(node.method)
     end
 
-    def evaluate_block(node,block_context=@context)
+    def evaluate_block(node, block_context = @context)
       call = node.method.first
       content_runtime = create_child_runtime(node.contents)
       alternate_runtime = create_child_runtime(node.alternate) if node.respond_to? :alternate
-      block_runtime = BlockRuntime.new(block_context,content_runtime,alternate_runtime)
+      block_runtime = BlockRuntime.new(block_context, content_runtime, alternate_runtime)
 
       result = evaluate_call(call, block_context) { block_runtime }
 
@@ -172,17 +170,17 @@ module FlavourSaver
 
         # If the result is collectiony then act as an implicit
         # "each"
-        if result && result.respond_to?(:each)
+        if result&.respond_to?(:each)
           if result.respond_to?(:size) && (result.size > 0)
             r = []
             # Not using #each_with_index because the object might
             # not actually be an Enumerable
             count = 0
             result.each do |e|
-              r << block_runtime.contents(e, {'index' => count})
+              r << block_runtime.contents(e, {"index" => count})
               count += 1
             end
-            result = r.join('')
+            result = r.join("")
           else
             result = block_runtime.inverse
           end
@@ -191,19 +189,19 @@ module FlavourSaver
         elsif result
           result = block_runtime.contents result
         else
-          if block_runtime.has_inverse?
-            result = block_runtime.inverse
+          result = if block_runtime.has_inverse?
+            block_runtime.inverse
           else
-            result = ''
+            ""
           end
         end
       end
       result
     end
 
-    def create_child_runtime(body=[])
+    def create_child_runtime(body = [])
       node = body.is_a?(TemplateNode) ? body : TemplateNode.new(body)
-      Runtime.new(node,nil,@locals,@helpers,self)
+      Runtime.new(node, nil, @locals, @helpers, self)
     end
 
     def inspect
@@ -211,21 +209,21 @@ module FlavourSaver
     end
 
     class BlockRuntime
-      def initialize(block_context,content_runtime,alternate_runtime=nil)
+      def initialize(block_context, content_runtime, alternate_runtime = nil)
         @block_context = block_context
         @content_runtime = content_runtime
         @alternate_runtime = alternate_runtime
         @render_count = 0
       end
 
-      def contents(context=@block_context,locals={})
+      def contents(context = @block_context, locals = {})
         @render_count += 1
-        @content_runtime.to_s(context,locals) if @content_runtime
+        @content_runtime&.to_s(context, locals)
       end
 
-      def inverse(context=@block_context)
+      def inverse(context = @block_context)
         @render_count += 1
-        @alternate_runtime.to_s(context) if @alternate_runtime
+        @alternate_runtime&.to_s(context)
       end
 
       def has_inverse?
@@ -233,7 +231,7 @@ module FlavourSaver
       end
 
       def rendered?
-        @render_count > 0 ? @render_count : false
+        (@render_count > 0) ? @render_count : false
       end
 
       def rendered!
@@ -273,10 +271,10 @@ module FlavourSaver
     # public_send.
     def forbidden_method?(context, name)
       owner = begin
-                context.method(name).owner
-              rescue NameError
-                return false
-              end
+        context.method(name).owner
+      rescue NameError
+        return false
+      end
 
       return false if owner.equal? Helpers::Defaults
       return false unless Helpers::Decorator.ancestors.include? owner
@@ -294,32 +292,29 @@ module FlavourSaver
     end
 
     def escape(output)
-      if output.respond_to?(:html_safe) && output.html_safe?
-        # If the string is already marked as html_safe then don't
-        # escape it any further.
-        output
-
-      else
-        output = CGI.escapeHTML(output)
-
-        # We can't just use CGI.escapeHTML because Handlebars does extra
-        # escaping for its JavaScript environment. Thems the breaks.
-        output = output.gsub(/(['"`])/) do |match|
-          case match
-          when "'"
-            "&#x27;"
-          when '"'
-            "&quot;"
-          when '`'
-            "&#x60;"
-          end
+      # If the string is already marked as html_safe then don't
+      # escape it any further.
+      return output if output.respond_to?(:html_safe) && output.html_safe?
+
+      output = CGI.escapeHTML(output)
+
+      # We can't just use CGI.escapeHTML because Handlebars does extra
+      # escaping for its JavaScript environment. Thems the breaks.
+      output = output.gsub(/(['"`])/) do |match|
+        case match
+        when "'"
+          "&#x27;"
+        when '"'
+          "&quot;"
+        when "`"
+          "&#x60;"
         end
+      end
 
-        # Mark it as already escaped if we're in Rails
-        output.html_safe if output.respond_to? :html_safe
+      # Mark it as already escaped if we're in Rails
+      output.html_safe if output.respond_to? :html_safe
 
-        output
-      end
+      output
     end
   end
 end

data/lib/flavour_saver/template.rb

@@ -1,8 +1,7 @@
-require 'tilt/template'
+require "tilt/template"
 
 module FlavourSaver
   class Template < Tilt::Template
-
     def self.engine_initialized?
       true
     end
@@ -11,9 +10,8 @@ module FlavourSaver
       @ast = Parser.parse(Lexer.lex(data))
     end
 
-    def evaluate(scope=Object.new,locals={},&block)
-      Runtime.run(@ast,scope,locals)
+    def evaluate(scope = Object.new, locals = {}, &block)
+      Runtime.run(@ast, scope, locals)
     end
-
   end
 end

data/lib/flavour_saver/version.rb

@@ -1,3 +1,3 @@
 module FlavourSaver
-  VERSION = "4.0.2"
+  VERSION = "5.0.0"
 end

data/lib/flavour_saver.rb

@@ -1,16 +1,16 @@
 require "flavour_saver/version"
-require 'tilt'
+require "flavour_saver/error"
+require "tilt"
 
 module FlavourSaver
-
-  autoload :Lexer,          'flavour_saver/lexer'
-  autoload :Parser,         'flavour_saver/parser'
-  autoload :Runtime,        'flavour_saver/runtime'
-  autoload :Helpers,        'flavour_saver/helpers'
-  autoload :Partial,        'flavour_saver/partial'
-  autoload :RailsPartial,   'flavour_saver/rails_partial'
-  autoload :Template,       'flavour_saver/template'
-  autoload :NodeCollection, 'flavour_saver/node_collection'
+  autoload :Lexer, "flavour_saver/lexer"
+  autoload :Parser, "flavour_saver/parser"
+  autoload :Runtime, "flavour_saver/runtime"
+  autoload :Helpers, "flavour_saver/helpers"
+  autoload :Partial, "flavour_saver/partial"
+  autoload :RailsPartial, "flavour_saver/rails_partial"
+  autoload :Template, "flavour_saver/template"
+  autoload :NodeCollection, "flavour_saver/node_collection"
 
   if defined? Rails
     class Engine < Rails::Engine
@@ -45,20 +45,20 @@ module FlavourSaver
     Parser.parse(tokens)
   end
 
-  def evaluate(template,context)
+  def evaluate(template, context)
     Runtime.run(parse(lex(template)), context)
   end
 
-  def register_helper(*args,&b)
-    Helpers.register_helper(*args,&b)
+  def register_helper(*args, &b)
+    Helpers.register_helper(*args, &b)
   end
 
   def reset_helpers
     Helpers.reset_helpers
   end
 
-  def register_partial(name,content=nil,&block)
-    Partial.register_partial(name,content,&block)
+  def register_partial(name, content = nil, &block)
+    Partial.register_partial(name, content, &block)
   end
 
   def reset_partials
@@ -70,10 +70,10 @@ module FlavourSaver
   end
 
   def logger=(logger)
-    @logger=logger
+    @logger = logger
   end
 
-  Tilt.register(Template, 'handlebars', 'hbs')
+  Tilt.register(Template, "handlebars", "hbs")
 end
 
 FS = FlavourSaver

data/spec/acceptance/backtrack_spec.rb

@@ -1,14 +1,14 @@
-require 'tilt'
-require 'flavour_saver'
+require "tilt"
+require "flavour_saver"
 
-describe 'Fixture: backtrack.hbs' do
-  subject { Tilt.new(template).render(context).gsub(/[\s\r\n]+/, ' ').strip }
-  let(:template) { File.expand_path('../../fixtures/backtrack.hbs', __FILE__) }
-  let(:context) { Struct.new(:person,:company).new }
+describe "Fixture: backtrack.hbs" do
+  subject { Tilt.new(template).render(context).gsub(/[\s\r\n]+/, " ").strip }
+  let(:template) { File.expand_path("../../fixtures/backtrack.hbs", __FILE__) }
+  let(:context) { Struct.new(:person, :company).new }
 
-  it 'renders correctly' do
-    context.person = Struct.new(:name).new('Alan')
-    context.company = Struct.new(:name).new('Rad, Inc.')
+  it "renders correctly" do
+    context.person = Struct.new(:name).new("Alan")
+    context.company = Struct.new(:name).new("Rad, Inc.")
     expect(subject).to eq "Alan - Rad, Inc."
   end
 end

data/spec/acceptance/comment_spec.rb

@@ -1,12 +1,12 @@
-require 'tilt'
-require 'flavour_saver'
+require "tilt"
+require "flavour_saver"
 
-describe 'Fixture: comment.hbs' do
-  subject { Tilt.new(template).render(context).gsub(/[\s\r\n]+/, ' ').strip }
-  let(:template) { File.expand_path('../../fixtures/comment.hbs', __FILE__) }
-  let(:context)  { double(:context) }
+describe "Fixture: comment.hbs" do
+  subject { Tilt.new(template).render(context).gsub(/[\s\r\n]+/, " ").strip }
+  let(:template) { File.expand_path("../../fixtures/comment.hbs", __FILE__) }
+  let(:context) { double(:context) }
 
-  it 'renders correctly' do
+  it "renders correctly" do
     expect(subject).to eq "I am a very nice person!"
   end
 end

data/spec/acceptance/custom_block_helper_spec.rb

@@ -1,33 +1,33 @@
-require 'tilt'
-require 'flavour_saver'
+require "tilt"
+require "flavour_saver"
 
-describe 'Fixture: custom_block_helper.hbs' do
-  subject { Tilt.new(template).render(context).gsub(/[\s\r\n]+/, ' ').strip }
-  let(:template) { File.expand_path('../../fixtures/custom_block_helper.hbs', __FILE__) }
-  let(:context)  { double(:context) }
+describe "Fixture: custom_block_helper.hbs" do
+  subject { Tilt.new(template).render(context).gsub(/[\s\r\n]+/, " ").strip }
+  let(:template) { File.expand_path("../../fixtures/custom_block_helper.hbs", __FILE__) }
+  let(:context) { double(:context) }
 
   before(:each) do
     FlavourSaver::Helpers.reset_helpers
   end
 
-  describe 'method helper' do
-    it 'renders correctly' do
+  describe "method helper" do
+    it "renders correctly" do
       def three_times
         (1..3).map do |i|
           yield.contents i
-        end.join ''
+        end.join ""
       end
       FlavourSaver.register_helper(method(:three_times))
       expect(subject).to eq "1 time. 2 time. 3 time."
     end
   end
 
-  describe 'proc helper' do
-    it 'renders correctly' do
+  describe "proc helper" do
+    it "renders correctly" do
       FlavourSaver.register_helper(:three_times) { |&b|
         (1..3).map do |i|
           b.call.contents i
-        end.join ''
+        end.join ""
       }
       expect(subject).to eq "1 time. 2 time. 3 time."
     end

data/spec/acceptance/custom_helper_spec.rb

@@ -1,14 +1,14 @@
-require 'tilt'
-require 'flavour_saver'
+require "tilt"
+require "flavour_saver"
 
-describe 'Fixture: custom_helper.hbs' do
-  subject { Tilt.new(template).render(context).gsub(/[\s\r\n]+/, ' ').strip }
-  let(:template) { File.expand_path('../../fixtures/custom_helper.hbs', __FILE__) }
-  let(:context)  { double(:context) }
+describe "Fixture: custom_helper.hbs" do
+  subject { Tilt.new(template).render(context).gsub(/[\s\r\n]+/, " ").strip }
+  let(:template) { File.expand_path("../../fixtures/custom_helper.hbs", __FILE__) }
+  let(:context) { double(:context) }
 
-  it 'renders correctly' do
+  it "renders correctly" do
     FlavourSaver.register_helper(:say_what_again) do
-      'What?'
+      "What?"
     end
     expect(subject).to eq "What?"
   end