bade 0.2.5 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 148aef838267196453c729800e51c4d3b1f194586f5226e00c659d8f3fc80e58
-  data.tar.gz: dff1e493ea8a08976cd6cdd1fc80cf937cb2582bc41630c2ca6198fc9eab5ada
+  metadata.gz: 5a90545fdee8d531bb87e12dd7943c0486daf3eac68f1d0c69ba216c7595f452
+  data.tar.gz: cdbf2cbc427cb9dd590768d493f99c91f22ac51a0a3caa172abb0b6c96b81b57
 SHA512:
-  metadata.gz: 86853f78cc0d8647ab5d639664dbb12d5e7101165641d91e4afdbc2affb3cf2c5434ea85bc7f9f92cec7ed571d34a4f23dd4bc0db6eaea9522df29e986df071f
-  data.tar.gz: 335be41aa317132979197275b9c6fad798525af1247d2878239229e4f81b6beaac916000af24a1da0ccd61ea22ee3356127aa7a485fe806cc9385ef8945370be
+  metadata.gz: 88708cad2d3145bfe33fb2ca65acbd795b3f8b3074da64f53e8d053d09925a3f750627893c303c2000fe4e9e8328abf4b9fe60a8e1c925a4ccb8966f37887fff
+  data.tar.gz: 8b21e240977c4f4c0c0387c244dcfb215141e453e04fde9f47762cb59ec22f43ee8056a17c39f41037d52b2a3d2bde8f66ad2b7623d8f8819f9444eebb075741

data/Bade.gemspec

@@ -14,16 +14,17 @@ Gem::Specification.new do |spec|
   spec.summary     = 'Minimalistic template engine for Ruby.'
   spec.homepage    = 'https://github.com/epuber-io/bade'
   spec.license     = 'MIT'
-  spec.required_ruby_version = '>= 2.0'
+  spec.metadata    = { 'rubygems_mfa_required' => 'true' }
+  spec.required_ruby_version = '>= 2.5'
 
   spec.files         = Dir['bin/**/*'] + Dir['lib/**/*'] + %w[Bade.gemspec Gemfile README.md]
   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']
 
-  spec.add_dependency 'psych', '>= 2.2', '< 4.0'
+  spec.add_dependency 'psych', '>= 2.2', '< 5.0'
 
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'fakefs', '~> 1.3'
   spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rubocop', '~> 0.50.0'
+  spec.add_development_dependency 'rubocop', '~> 1.14'
 end

data/Gemfile

@@ -5,9 +5,13 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'benchmark-ips', require: false
-gem 'coveralls', require: false
 
-group :banchmarks, optional: true do
+group :dev, optional: true do
+  gem 'debase', require: false
+  gem 'ruby-debug-ide', require: false
+end
+
+group :benchmarks, optional: true do
   gem 'flamegraph'
   gem 'ruby-prof'
 end

data/README.md

@@ -1,7 +1,7 @@
 
 # Bade
 
-[![Gem Version](https://badge.fury.io/rb/bade.svg)](http://badge.fury.io/rb/bade) [![Build Status](https://travis-ci.org/epuber-io/bade.svg?branch=master)](https://travis-ci.org/epuber-io/bade) [![Coverage Status](https://coveralls.io/repos/epuber-io/bade/badge.svg?branch=master&service=github)](https://coveralls.io/github/epuber-io/bade?branch=master) [![Inline docs](http://inch-ci.org/github/epuber-io/bade.svg?branch=master)](http://inch-ci.org/github/epuber-io/bade)
+[![Gem Version](https://badge.fury.io/rb/bade.svg)](http://badge.fury.io/rb/bade) [![Build Status](https://github.com/epuber-io/bade/actions/workflows/tests.yml/badge.svg)](https://github.com/epuber-io/bade/actions) [![Coverage Status](https://coveralls.io/repos/epuber-io/bade/badge.svg?branch=master&service=github)](https://coveralls.io/github/epuber-io/bade?branch=master) [![Inline docs](https://inch-ci.org/github/epuber-io/bade.svg?branch=master)](https://inch-ci.org/github/epuber-io/bade)
 
 
 Minimalistic template engine written in Ruby for Ruby. Developed mainly to help with creating e-books. Highly influenced by [Jade](http://jade-lang.com) and [Slim](http://slim-lang.com).
@@ -30,7 +30,7 @@ Or install it yourself as:
 
 ## Development
 
-After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+After checking out the repo, run `bundle install --with dev` to install dependencies. Then, run `rake spec` to run the tests.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
@@ -40,7 +40,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 Bug reports and pull requests are welcome on GitHub at https://github.com/epuber-io/bade. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
-## TODO
+## TODO
 
 - [ ] create documentation about syntax
 - [ ] create several examples

data/lib/bade/ast/document.rb

@@ -24,7 +24,7 @@ module Bade
 
       # @param root [Bade::Node]
       #
-      def initialize(root: Node.new(:root), file_path: nil)
+      def initialize(root: Node.new(:root, nil), file_path: nil)
         @root = root
 
         @file_path = file_path.dup.freeze unless file_path.nil?

data/lib/bade/ast/node/value_node.rb

@@ -17,17 +17,26 @@ module Bade
       #
       attr_accessor :conditional
 
+      # @return [String, nil]
+      #
+      attr_accessor :default_value
+
       ruby2_keywords def initialize(*args)
         super(*args)
 
         @escaped = false
         @conditional = false
+        @default_value = nil
       end
 
       # @param [ValueNode] other
       #
       def ==(other)
-        super && value == other.value && escaped == other.escaped && conditional == other.conditional
+        super &&
+          value == other.value &&
+          escaped == other.escaped &&
+          conditional == other.conditional &&
+          default_value == other.default_value
       end
     end
   end

data/lib/bade/ast/node.rb

@@ -10,7 +10,11 @@ module Bade
       #
       attr_reader :type
 
-      # @return [Array<Bade::Node>]
+      # @return [Bade::AST::Node, nil]
+      #
+      attr_accessor :parent
+
+      # @return [Array<Bade::AST::Node>]
       #
       attr_accessor :children
 
@@ -20,10 +24,16 @@ module Bade
       #
       attr_reader :lineno
 
-      def initialize(type, lineno: nil)
+      # @return [String] filename
+      #
+      attr_reader :filename
+
+      def initialize(type, parent = nil, lineno: nil, filename: nil)
         @type = type
+        @parent = parent
         @children = []
         @lineno = lineno
+        @filename = filename
       end
 
       def to_s

data/lib/bade/ast/node_registrator.rb

@@ -38,12 +38,12 @@ module Bade
         #
         # @return [Bade::AST::Node]
         #
-        def create(type, lineno)
+        def create(type, parent, lineno: nil, filename: nil)
           klass = registered_types[type]
 
           raise ::KeyError, "Undefined node type #{type.inspect}" if klass.nil?
 
-          klass.new(type, lineno: lineno)
+          klass.new(type, parent, lineno: lineno, filename: filename)
         end
       end
 
@@ -55,6 +55,7 @@ module Bade
       register_type DoctypeNode, :doctype
 
       register_type ValueNode, :import
+      register_type ValueNode, :yield
 
       # --- Comments
 

data/lib/bade/ast/string_serializer.rb

@@ -37,13 +37,13 @@ module Bade
 
         children_s = ''
         if node.children.count > 0
-          children_s = "\n" + node.children.map { |n| node_to_s(n, level + 1) }.join("\n") + "\n#{indent}"
+          children_s = "\n#{node.children.map { |n| node_to_s(n, level + 1) }.join("\n")}\n#{indent}"
         end
 
         other = ''
 
         case node
-        when TagNode
+        when TagNode, MixinCommonNode
           other = node.name
         when KeyValueNode
           other = "#{node.name}:#{node.value}"
@@ -56,15 +56,13 @@ module Bade
                            ''
                          end
           other = "#{escaped_sign}#{node.value}"
-        when MixinCommonNode
-          other = node.name
         when Node
           # nothing
         else
           raise "Unknown node class #{node.class} of type #{node.type} for serializing"
         end
 
-        other = ' ' + other if other && !other.empty?
+        other = " #{other}" if other && !other.empty?
 
         "#{indent}(#{type_s}#{other}#{children_s})"
       end

data/lib/bade/generator.rb

@@ -41,6 +41,7 @@ module Bade
       code_indent do
         buff_code "self.#{NEW_LINE_NAME} = #{NEW_LINE_NAME}"
         buff_code "self.#{BASE_INDENT_NAME} = #{BASE_INDENT_NAME}"
+        buff_code "__buffs_push(#{location(filename: document.file_path, lineno: 0, label: '<top>')})"
 
         visit_document(document)
 
@@ -75,7 +76,7 @@ module Bade
     end
 
     def buff_code(text)
-      @buff << '  ' * @code_indent + text
+      @buff << "#{'  ' * @code_indent}#{text}"
     end
 
     # @param document [Bade::Document]
@@ -115,6 +116,8 @@ module Bade
     # @param current_node [Node]
     #
     def visit_node(current_node)
+      update_location_node(current_node)
+
       case current_node.type
       when :root
         visit_node_children(current_node)
@@ -134,7 +137,7 @@ module Bade
         buff_print_text ' -->'
 
       when :comment
-        comment_text = '#' + current_node.children.map(&:value).join("\n#")
+        comment_text = "##{current_node.children.map(&:value).join("\n#")}"
         buff_code(comment_text)
 
       when :doctype
@@ -166,8 +169,11 @@ module Bade
                       "#{base_path}.rb"
                     end
 
-        buff_code "load('#{load_path}')" unless load_path.nil?
-
+        buff_code "__load('#{load_path}')" unless load_path.nil?
+      when :yield
+        block_name = DEFAULT_BLOCK_NAME
+        method = current_node.conditional ? 'call' : 'call!'
+        buff_code "#{block_name}.#{method}"
       else
         raise "Unknown type #{current_node.type}"
       end
@@ -267,19 +273,22 @@ module Bade
       params = mixin_node.params
       result = []
 
-      if mixin_node.type == :mixin_call
+      case mixin_node.type
+      when :mixin_call
         blocks = mixin_node.blocks
 
         other_children = (mixin_node.children - mixin_node.blocks - mixin_node.params)
         if other_children.count { |n| n.type != :newline } > 0
-          def_block_node = AST::NodeRegistrator.create(:mixin_block, mixin_node.lineno)
+          def_block_node = AST::NodeRegistrator.create(:mixin_block, mixin_node, lineno: mixin_node.lineno)
           def_block_node.name = DEFAULT_BLOCK_NAME
           def_block_node.children = other_children
 
           blocks << def_block_node
         end
 
-        if !blocks.empty?
+        if blocks.empty?
+          result << '{}'
+        else
           buff_code '__blocks = {}'
 
           blocks.each do |block|
@@ -287,17 +296,18 @@ module Bade
           end
 
           result << '__blocks.dup'
-        else
-          result << '{}'
         end
-      elsif mixin_node.type == :mixin_decl
+      when :mixin_decl
         result << '__blocks'
       end
 
+      # positional params
+      result += params.select { |n| n.type == :mixin_param }
+                      .map { |param| param.default_value ? "#{param.value} = #{param.default_value}" : param.value }
 
-      # normal params
-      result += params.select { |n| n.type == :mixin_param }.map(&:value)
-      result += params.select { |n| n.type == :mixin_key_param }.map { |param| "#{param.name}: #{param.value}" }
+      # key-value params
+      result += params.select { |n| n.type == :mixin_key_param }
+                      .map { |param| "#{param.name}: #{param.value}" }
 
       result.join(', ')
     end
@@ -309,14 +319,10 @@ module Bade
     # @return [nil]
     #
     def block_definition(block_node)
-      buff_code "__blocks['#{block_node.name}'] = __create_block('#{block_node.name}') do"
+      buff_code "__blocks['#{block_node.name}'] = __create_block('#{block_node.name}', #{location_node(block_node)}) do"
 
       code_indent do
-        buff_code '__buffs_push()'
-
         visit_node_children(block_node)
-
-        buff_code '__buffs_pop()'
       end
 
       buff_code 'end'
@@ -350,7 +356,7 @@ module Bade
     #
     def visit_block_decl(current_node)
       params = formatted_mixin_params(current_node)
-      buff_code "#{MIXINS_NAME}['#{current_node.name}'] = __create_mixin('#{current_node.name}', &lambda { |#{params}|"
+      buff_code "#{MIXINS_NAME}['#{current_node.name}'] = __create_mixin('#{current_node.name}', #{location_node(current_node)}, &lambda { |#{params}|"
 
       code_indent do
         blocks_name_declaration(current_node)
@@ -367,6 +373,55 @@ module Bade
     def escape_double_quotes!(str)
       str.gsub!(/"/, '\"')
     end
+
+    # @param [Bade::AST::Node]
+    # @return [Void]
+    def update_location_node(node)
+      should_skip = case node.type
+                    when :code
+                      value = node.value.strip
+
+                      %w[end else }].include?(value) || value.match(/^(when|elsif) /)
+                    when :newline
+                      true
+                    else
+                      false
+                    end
+
+      return if should_skip
+      return if node.lineno.nil?
+
+      buff_code "__update_lineno(#{node.lineno})"
+    end
+
+    # @param [String] filename
+    # @param [Fixnum] lineno
+    # @param [String] label
+    # @return [String]
+    def location(filename:, lineno:, label:)
+      args = [
+        filename ? "path: '#{filename}'" : nil,
+        "lineno: #{lineno}",
+        "label: '#{label}'",
+      ].compact
+
+      "Location.new(#{args.join(',')})"
+    end
+
+    # @param [Node] node
+    # @return [String]
+    def location_node(node)
+      label = case node.type
+              when :mixin_decl
+                "+#{node.name}"
+              when :mixin_block
+                "#{node.name} in +#{node.parent.name}"
+              else
+                node.name
+              end
+
+      location(filename: node.filename, lineno: node.lineno, label: label)
+    end
   end
 
   # backward compatibility

data/lib/bade/parser/parser_lines.rb

@@ -7,6 +7,7 @@ module Bade
   class Parser
     module LineIndicatorRegexps
       IMPORT = /\Aimport /.freeze
+      YIELD = /\Ayield(!?)/.freeze
       MIXIN_DECL = /\Amixin #{NAME_RE_STRING}/.freeze
       MIXIN_CALL = /\A\+#{NAME_RE_STRING}/.freeze
       BLOCK_DECLARATION = /\Ablock #{NAME_RE_STRING}/.freeze
@@ -135,6 +136,11 @@ module Bade
         @line = $'
         parse_import
 
+      when LineIndicatorRegexps::YIELD
+        @line = $'
+        node = append_node(:yield, add: true)
+        node.conditional = $1.nil?
+
       when LineIndicatorRegexps::MIXIN_DECL
         # Mixin declaration
         @line = $'
@@ -195,12 +201,8 @@ module Bade
         @line = $' if $1
         parse_tag($&)
 
-      when LineIndicatorRegexps::TAG_CLASS_START_BLOCK
-        # Found class name -> implicit div
-        parse_tag 'div'
-
-      when LineIndicatorRegexps::TAG_ID_START_BLOCK
-        # Found id name -> implicit div
+      when LineIndicatorRegexps::TAG_CLASS_START_BLOCK, LineIndicatorRegexps::TAG_ID_START_BLOCK
+        # Found a class or id selector.
         parse_tag 'div'
 
       else

data/lib/bade/parser/parser_mixin.rb

@@ -18,6 +18,7 @@ module Bade
       PARAMS_PARAM_NAME = /\A\s*#{NAME_RE_STRING}/.freeze
       PARAMS_BLOCK_NAME = /\A\s*&#{NAME_RE_STRING}/.freeze
       PARAMS_KEY_PARAM_NAME = CODE_ATTR_RE
+      PARAMS_PARAM_DEFAULT_START = /\A\s*=/.freeze
     end
 
     def parse_mixin_call(mixin_name)
@@ -114,7 +115,12 @@ module Bade
 
         when MixinRegexps::PARAMS_PARAM_NAME
           @line = $'
-          append_node(:mixin_param, value: $1)
+          attr_node = append_node(:mixin_param, value: $1)
+
+          if @line =~ MixinRegexps::PARAMS_PARAM_DEFAULT_START
+            @line = $'
+            attr_node.default_value = parse_ruby_code(ParseRubyCodeRegexps::END_PARAMS_ARG)
+          end
 
         when MixinRegexps::PARAMS_BLOCK_NAME
           @line = $'

data/lib/bade/parser.rb

@@ -17,6 +17,8 @@ module Bade
       attr_reader :error, :file, :line, :lineno, :column
 
       def initialize(error, file, line, lineno, column)
+        super(error)
+
         @error = error
         @file = file || '(__TEMPLATE__)'
         @line = line.to_s
@@ -27,7 +29,7 @@ module Bade
       def to_s
         line = @line.lstrip
         column = @column + line.size - @line.size
-        <<-MSG.strip_heredoc
+        <<~MSG
           #{error}
             #{file}, Line #{lineno}, Column #{@column}
             #{line}
@@ -60,7 +62,7 @@ module Bade
       @file_path = file_path
 
       @tab_re = /\G((?: {#{tabsize}})*) {0,#{tabsize - 1}}\t/
-      @tab = '\1' + ' ' * tabsize
+      @tab = "\1#{' ' * tabsize}"
 
       reset
     end
@@ -106,7 +108,7 @@ module Bade
       @stacks << @stacks.last.dup while indent >= @stacks.length
 
       parent = @stacks[indent].last
-      node = AST::NodeRegistrator.create(type, @lineno)
+      node = AST::NodeRegistrator.create(type, parent, lineno: @lineno, filename: @file_path)
       parent.children << node
 
       node.value = value unless value.nil?

data/lib/bade/precompiled.rb

@@ -26,9 +26,9 @@ module Bade
              end
 
       hash = if Gem::Version.new(Psych::VERSION) >= Gem::Version.new('3.0')
-               YAML.safe_load(file, filename: file.path, permitted_classes: [Symbol])
+               Psych.safe_load(file, filename: file.path, permitted_classes: [Symbol])
              else
-               YAML.safe_load(file, [Symbol])
+               Psych.safe_load(file, [Symbol])
              end
       raise LoadError, 'YAML file is not in valid format' unless hash.is_a?(Hash)
 

data/lib/bade/renderer.rb

@@ -9,7 +9,7 @@ require_relative 'precompiled'
 
 module Bade
   class Renderer
-    class LoadError < ::RuntimeError
+    class LoadError < Bade::Runtime::RuntimeError
       # @return [String]
       #
       attr_reader :loading_path
@@ -22,18 +22,29 @@ module Bade
       # @param [String] reference_path  reference file from which is load performed
       # @param [String] msg  standard message
       #
-      def initialize(loading_path, reference_path, msg = nil)
-        super(msg)
+      def initialize(loading_path, reference_path, msg, template_backtrace = [])
+        super(msg, template_backtrace)
         @loading_path = loading_path
         @reference_path = reference_path
       end
     end
 
-    def initialize
-      @optimize = false
+    class << self
+      def _globals_tracker
+        @globals_tracker ||= Bade::Runtime::GlobalsTracker.new
+      end
+
+      # When set to true it will remove all constants that template created. Off by default.
+      #
+      # @return [Boolean]
+      attr_accessor :clear_constants
     end
 
-    TEMPLATE_FILE_NAME = '(__template__)'.freeze
+    # @param clear_constants [Boolean] When set to true it will remove all constants that template created. Off by default.
+    def initialize(clear_constants: Bade::Renderer.clear_constants)
+      @optimize = false
+      @clear_constants = clear_constants
+    end
 
     # @return [String]
     #
@@ -59,6 +70,10 @@ module Bade
     #
     attr_accessor :optimize
 
+    # @return [Boolean] When set to true it will remove all constants that template created. Off by default.
+    #
+    attr_accessor :clear_constants
+
 
     # ----------------------------------------------------------------------------- #
     # Internal attributes
@@ -77,8 +92,8 @@ module Bade
     #
     # @return [Renderer] preconfigured instance of this class
     #
-    def self.from_source(source, file_path = nil)
-      inst = new
+    def self.from_source(source, file_path = nil, clear_constants: Bade::Renderer.clear_constants)
+      inst = new(clear_constants: clear_constants)
       inst.source_text = source
       inst.file_path = file_path
       inst
@@ -88,14 +103,14 @@ module Bade
     #
     # @return [Renderer] preconfigured instance of this class
     #
-    def self.from_file(file)
+    def self.from_file(file, clear_constants: Bade::Renderer.clear_constants)
       path = if file.is_a?(File)
                file.path
              else
                file
              end
 
-      from_source(nil, path)
+      from_source(nil, path, clear_constants: clear_constants)
     end
 
     # Method to create Renderer from Precompiled object, for example when you want to reuse precompiled object from disk
@@ -104,8 +119,8 @@ module Bade
     #
     # @return [Renderer] preconfigured instance of this class
     #
-    def self.from_precompiled(precompiled)
-      inst = new
+    def self.from_precompiled(precompiled, clear_constants: Bade::Renderer.clear_constants)
+      inst = new(clear_constants: clear_constants)
       inst.precompiled = precompiled
       inst
     end
@@ -125,11 +140,20 @@ module Bade
       self
     end
 
+    # @return [self]
     def with_binding(binding)
       self.lambda_binding = binding
       self
     end
 
+    # @param [RenderBinding] binding
+    # @return [self]
+    def with_render_binding(binding)
+      self.lambda_binding = nil
+      self.render_binding = binding
+      self
+    end
+
     def optimized
       self.optimize = true
       self
@@ -173,10 +197,12 @@ module Bade
     # @return [Proc]
     #
     def lambda_instance
-      if lambda_binding
-        lambda_binding.eval(lambda_string, file_path || TEMPLATE_FILE_NAME)
-      else
-        render_binding.instance_eval(lambda_string, file_path || TEMPLATE_FILE_NAME)
+      _catching_globals do
+        if lambda_binding
+          lambda_binding.eval(lambda_string, file_path || Bade::Runtime::TEMPLATE_FILE_NAME)
+        else
+          render_binding.instance_eval(lambda_string, file_path || Bade::Runtime::TEMPLATE_FILE_NAME)
+        end
       end
     end
 
@@ -197,13 +223,22 @@ module Bade
         Generator::NEW_LINE_NAME.to_sym => new_line,
         Generator::BASE_INDENT_NAME.to_sym => indent,
       }
-      run_vars.reject! { |_key, value| value.nil? } # remove nil values
+      run_vars.compact! # remove nil values
 
-      lambda_instance.call(**run_vars)
+      begin
+        return _catching_globals do
+          lambda_instance.call(**run_vars)
+        end
+      rescue Bade::Runtime::RuntimeError => e
+        raise e
+      rescue Exception => e
+        msg = "Exception raised during execution of template: #{e}"
+        raise Bade::Runtime::RuntimeError.wrap_existing_error(msg, e, render_binding.__location_stack)
+      ensure
+        self.class._globals_tracker.clear_constants if @clear_constants
+      end
     end
 
-
-
     private
 
     # @param [String] content  source code of the template
@@ -275,5 +310,16 @@ module Bade
         end
       end
     end
+
+    def _catching_globals(&block)
+      if @clear_constants
+        self.class._globals_tracker.catch(&block)
+      else
+        block.call
+      end
+    end
   end
 end
+
+# Set default value to clear_constants
+Bade::Renderer.clear_constants = false

data/lib/bade/ruby2_keywords.rb

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 
 def ruby2_keywords(*) end if RUBY_VERSION < '2.7'