bade 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ed7e7245f8cbc2101c82381279d924b8207f708d
-  data.tar.gz: f7cdf22720b27a64cf05cb3888960a0f1c309fea
+SHA256:
+  metadata.gz: 202b283306b0a05d870766ff8d7c17f8312727843632958adb2bb3f2300a673f
+  data.tar.gz: '0820f4f77eb7936b77748257faa1fd4ee51b206d4a7929c656f717127c7b2248'
 SHA512:
-  metadata.gz: 5a953b1e7336bd05a52d1bf1b8a5ce8310128ac173639a0ef0f4c8b9c55104885a5d924f1aacf14ae79f63af3497e6f5ae7eb0b499e047e9f5f5e1e49aaf8195
-  data.tar.gz: 6516a22a30ba0c11655afb34217494cf69d5b28c6bcbd6354c9c8ce502a5391cd0b8de12df3a4f00f53cf6cbeebc2678ad005781ff71ecba19cec0ff011f69a0
+  metadata.gz: ecd2dbf7aa570c8051a2e1b59a1a537583cd2cd5005bb06328795de099fab4213a9cfd616a788d66e333a862253d6aecedd928632e3edb923f021e86658f6780
+  data.tar.gz: 8633aba2120eaf8f60f96a357cde8eda8c32d862e92dca3c060f66c014bf1031e5bc2916077ee1d1a7de6494cc62c426ded062065c664949acaf849fce71de66

data/Bade.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'bade/version'
 
-
 Gem::Specification.new do |spec|
   spec.name        = 'bade'
   spec.version     = Bade::VERSION
@@ -14,15 +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.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_development_dependency 'bundler', '~> 1'
+  spec.add_dependency 'psych', '>= 2.2', '< 5.0'
+
+  spec.add_development_dependency 'fakefs', '~> 1.3'
   spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rake', '~> 11'
-  spec.add_development_dependency 'rubocop', '~> 0.35'
+  spec.add_development_dependency 'rubocop', '~> 1.14'
 end

data/Gemfile

@@ -1,8 +1,17 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
-gem 'coveralls', require: false
 gem 'benchmark-ips', require: false
-gem 'ruby-prof'
-gem 'flamegraph'
+
+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/mixin_node.rb

@@ -22,19 +22,19 @@ module Bade
 
     class MixinDeclarationNode < MixinCommonNode
       def allowed_parameter_types
-        [:mixin_param, :mixin_key_param, :mixin_block_param]
+        %i[mixin_param mixin_key_param mixin_block_param]
       end
     end
 
     class MixinBlockNode < MixinCommonNode
       def allowed_parameter_types
-        [:mixin_param, :mixin_key_param]
+        %i[mixin_param mixin_key_param]
       end
     end
 
     class MixinCallNode < MixinCommonNode
       def allowed_parameter_types
-        [:mixin_param, :mixin_key_param]
+        %i[mixin_param mixin_key_param]
       end
 
       def blocks

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../../ruby2_keywords'
+
 module Bade
   module AST
     class StaticTextNode < Node
@@ -11,8 +13,8 @@ module Bade
       #
       attr_accessor :escaped
 
-      def initialize(*args)
-        super
+      ruby2_keywords def initialize(*args)
+        super(*args)
 
         @escaped = false
       end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../../ruby2_keywords'
+
 module Bade
   module AST
     class ValueNode < Node
@@ -15,17 +17,26 @@ module Bade
       #
       attr_accessor :conditional
 
-      def initialize(*args)
-        super
+      # @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,11 +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

@@ -66,7 +66,7 @@ module Bade
     # @param [String] text
     #
     def buff_print_static_text(text)
-      buff_print_value("'#{text.gsub("'", "\\'")}'") unless text.empty?
+      buff_print_value("'#{text.gsub("'", "\\\\'")}'") unless text.empty?
     end
 
     def buff_print_value(value)
@@ -75,10 +75,9 @@ module Bade
     end
 
     def buff_code(text)
-      @buff << '  ' * @code_indent + text
+      @buff << "#{'  ' * @code_indent}#{text}"
     end
 
-
     # @param document [Bade::Document]
     #
     def visit_document(document)
@@ -87,6 +86,7 @@ module Bade
       end
 
       buff_code("# ----- start file #{document.file_path}") unless document.file_path.nil?
+      buff_code "__buffs_push(#{location(filename: document.file_path, lineno: 0, label: '<top>')})"
 
       new_root = if @optimize
                    Optimizer.new(document.root).optimize
@@ -116,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)
@@ -135,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
@@ -158,8 +160,7 @@ module Bade
         buff_print_text output_code
 
       when :newline
-        # buff_print_value(NEW_LINE_NAME)
-
+        # no-op
       when :import
         base_path = File.expand_path(current_node.value, File.dirname(@document.file_path))
         load_path = if base_path.end_with?('.rb') && File.exist?(base_path)
@@ -168,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
@@ -269,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|
@@ -289,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
@@ -311,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'
@@ -352,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)
@@ -362,8 +366,6 @@ module Bade
       buff_code '})'
     end
 
-
-
     # @param [String] str
     #
     # @return [Void]
@@ -371,6 +373,54 @@ 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 /)
+                    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_constants.rb

@@ -9,10 +9,10 @@ module Bade
     NAME_RE_STRING = "(#{WORD_RE}(?:#{WORD_RE}|:|-|_)*)".freeze
 
     ATTR_NAME_RE_STRING = "\\A\\s*#{NAME_RE_STRING}".freeze
-    CODE_ATTR_RE = /#{ATTR_NAME_RE_STRING}\s*&?:\s*/
+    CODE_ATTR_RE = /#{ATTR_NAME_RE_STRING}\s*&?:\s*/.freeze
 
-    TAG_RE = /\A#{NAME_RE_STRING}/
-    CLASS_TAG_RE = /\A\.#{NAME_RE_STRING}/
-    ID_TAG_RE = /\A##{NAME_RE_STRING}/
+    TAG_RE = /\A#{NAME_RE_STRING}/.freeze
+    CLASS_TAG_RE = /\A\.#{NAME_RE_STRING}/.freeze
+    ID_TAG_RE = /\A##{NAME_RE_STRING}/.freeze
   end
 end

data/lib/bade/parser/parser_lines.rb

@@ -6,19 +6,20 @@ module Bade
 
   class Parser
     module LineIndicatorRegexps
-      IMPORT = /\Aimport /
-      MIXIN_DECL = /\Amixin #{NAME_RE_STRING}/
-      MIXIN_CALL = /\A\+#{NAME_RE_STRING}/
-      BLOCK_DECLARATION = /\Ablock #{NAME_RE_STRING}/
-      HTML_COMMENT = %r{\A//! }
-      NORMAL_COMMENT = %r{\A//}
-      TEXT_BLOCK_START = /\A\|( ?)/
-      INLINE_HTML = /\A</
-      CODE_BLOCK = /\A-/
-      OUTPUT_BLOCK = /\A(\??)(&?)=/
-      DOCTYPE = /\Adoctype\s/i
-      TAG_CLASS_START_BLOCK = /\A\./
-      TAG_ID_START_BLOCK = /\A#/
+      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
+      HTML_COMMENT = %r{\A//! }.freeze
+      NORMAL_COMMENT = %r{\A//}.freeze
+      TEXT_BLOCK_START = /\A\|( ?)/.freeze
+      INLINE_HTML = /\A</.freeze
+      CODE_BLOCK = /\A-/.freeze
+      OUTPUT_BLOCK = /\A(\??)(&?)=/.freeze
+      DOCTYPE = /\Adoctype\s/i.freeze
+      TAG_CLASS_START_BLOCK = /\A\./.freeze
+      TAG_ID_START_BLOCK = /\A#/.freeze
     end
 
     def reset(lines = nil, stacks = nil)
@@ -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

@@ -6,18 +6,19 @@ module Bade
 
   class Parser
     module MixinRegexps
-      TEXT_START = /\A /
-      BLOCK_EXPANSION = /\A:\s+/
-      OUTPUT_CODE = /\A(&?)=/
+      TEXT_START = /\A /.freeze
+      BLOCK_EXPANSION = /\A:\s+/.freeze
+      OUTPUT_CODE = /\A(&?)=/.freeze
 
-      PARAMS_END = /\A\s*\)/
+      PARAMS_END = /\A\s*\)/.freeze
 
-      PARAMS_END_SPACES = /^\s*$/
-      PARAMS_ARGS_DELIMITER = /\A\s*,/
+      PARAMS_END_SPACES = /^\s*$/.freeze
+      PARAMS_ARGS_DELIMITER = /\A\s*,/.freeze
 
-      PARAMS_PARAM_NAME = /\A\s*#{NAME_RE_STRING}/
-      PARAMS_BLOCK_NAME = /\A\s*&#{NAME_RE_STRING}/
+      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)
@@ -64,7 +65,7 @@ module Bade
           @line = $'
           attr_node = append_node(:mixin_key_param)
           attr_node.name = fixed_trailing_colon($1)
-          attr_node.value = parse_ruby_code(ParseRubyCodeRegexps::END_PARAMS_ARG)
+          attr_node.value = parse_ruby_code(ParseRubyCodeRegexps::END_PARAMS_ARG, allow_multiline: true)
 
         when MixinRegexps::PARAMS_ARGS_DELIMITER
           # args delimiter
@@ -83,7 +84,7 @@ module Bade
 
         else
           attr_node = append_node(:mixin_param)
-          attr_node.value = parse_ruby_code(ParseRubyCodeRegexps::END_PARAMS_ARG)
+          attr_node.value = parse_ruby_code(ParseRubyCodeRegexps::END_PARAMS_ARG, allow_multiline: true)
         end
       end
     end
@@ -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 = $'