bade 0.3.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 202b283306b0a05d870766ff8d7c17f8312727843632958adb2bb3f2300a673f
-  data.tar.gz: '0820f4f77eb7936b77748257faa1fd4ee51b206d4a7929c656f717127c7b2248'
+  metadata.gz: 631a47a8189e2172e6133dbcdd577b741446c493bd4d4fb9e3e7b3e902928891
+  data.tar.gz: 975e1ba152e0792d950577e6dbdcf12562a23300692479dc5a9b237c6c06b1e7
 SHA512:
-  metadata.gz: ecd2dbf7aa570c8051a2e1b59a1a537583cd2cd5005bb06328795de099fab4213a9cfd616a788d66e333a862253d6aecedd928632e3edb923f021e86658f6780
-  data.tar.gz: 8633aba2120eaf8f60f96a357cde8eda8c32d862e92dca3c060f66c014bf1031e5bc2916077ee1d1a7de6494cc62c426ded062065c664949acaf849fce71de66
+  metadata.gz: 1ebff9a8a22bd7a6dc902e76af2aeec794f95942469f2cc572d97b6cf19d8ceb23c0b1a778391b612a3b35583b5e7c9cc0dfdd9b3f6ea7423e5af943625659b1
+  data.tar.gz: ea97fdd39475caf4270535dd7b4af2dbcbcf929bd22cdb080b5b2a5618ad81f8e2796a467b3428a404dd789cb6443b34b9b889ddd32ed37288e1055b5c8446f9

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)
 
@@ -86,7 +87,6 @@ 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
@@ -381,12 +381,13 @@ module Bade
                     when :code
                       value = node.value.strip
 
-                      %w[end else }].include?(value) || value.match(/^when /)
+                      %w[end else }].include?(value) || value.match(/^(when|elsif) /)
                     when :newline
                       true
                     else
                       false
                     end
+
       return if should_skip
       return if node.lineno.nil?
 

data/lib/bade/parser.rb

@@ -29,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}

data/lib/bade/ruby_extensions/string.rb

@@ -95,13 +95,4 @@ class String
 
     count
   end
-
-  # source: http://apidock.com/rails/String/strip_heredoc
-  # @return [String]
-  #
-  def strip_heredoc
-    min_val = scan(/^[ \t]*(?=\S)/).min
-    indent = min_val&.size || 0
-    gsub(/^[ \t]{#{indent}}/, '')
-  end
 end

data/lib/bade/runtime/globals_tracker.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'utils/where'
+
 module Bade
   module Runtime
     # Tracks created global variables and constants in block.
@@ -10,9 +12,16 @@ module Bade
       # @return [Array<[Object, :Symbol]>]
       attr_accessor :caught_constants
 
-      def initialize
+      # @return [Array<String>, nil]
+      attr_accessor :constants_location_prefixes
+
+      # @param [Array<String>, nil] constants_location_prefixes If given, only constants whose location starts with one
+      #                                                         of the prefixes will be removed. If nil, all constants
+      #                                                         will be removed.
+      def initialize(constants_location_prefixes: nil)
         @caught_variables = []
         @caught_constants = []
+        @constants_location_prefixes = constants_location_prefixes
       end
 
       # @yieldreturn [T]
@@ -43,8 +52,8 @@ module Bade
       end
 
       def clear_constants
-        @caught_constants.each do |(obj, name)|
-          obj.send(:remove_const, name) if obj.const_defined?(name)
+        _filtered_constants.each do |(obj, name)|
+          obj.send(:remove_const, name)
         end
         @caught_constants = []
       end
@@ -54,6 +63,26 @@ module Bade
           eval("#{name} = nil", binding, __FILE__, __LINE__)
         end
       end
+
+      # Filteres caught constants by location prefixes and returns ones that should be removed.
+      #
+      # @return [Array<[Object, :Symbol]>]
+      def _filtered_constants
+        @caught_constants.select do |(obj, name)|
+          next unless obj.const_defined?(name)
+          next true if constants_location_prefixes.nil?
+
+          konst = obj.const_get(name)
+          begin
+            location = Bade.where_is(konst)
+          rescue ::ArgumentError
+            next
+          end
+
+          path = location.first
+          constants_location_prefixes&.any? { |prefix| path.start_with?(prefix) }
+        end
+      end
     end
   end
 end

data/lib/bade/runtime/mixin.rb

@@ -49,6 +49,9 @@ module Bade
 
           raise Block::MissingBlockDefinitionError.new(e.name, e.context, msg, render_binding.__location_stack)
 
+        rescue RuntimeError
+          raise
+
         rescue Exception => e
           msg = "Exception raised during execution of mixin `#{name}`: #{e}"
           raise Bade::Runtime::RuntimeError.wrap_existing_error(msg, e, render_binding.__location_stack)

data/lib/bade/runtime/render_binding.rb

@@ -86,7 +86,7 @@ module Bade
       # @param [String] filename
       def __load(filename)
         # FakeFS does not fake `load` method
-        if defined?(:FakeFS) && FakeFS.activated?
+        if Object.const_defined?(:FakeFS) && Object.const_get(:FakeFS).activated?
           # rubocop:disable Security/Eval
           eval(File.read(filename), __get_binding, filename)
           # rubocop:enable Security/Eval
@@ -98,7 +98,7 @@ module Bade
       # @param [String] filename
       def require_relative(filename)
         # FakeFS does not fake `require_relative` method
-        if defined?(:FakeFS) && FakeFS.activated?
+        if Object.const_defined?(:FakeFS) && Object.const_get(:FakeFS).activated?
           # rubocop:disable Security/Eval
           eval(File.read(filename), __get_binding, filename)
           # rubocop:enable Security/Eval

data/lib/bade/runtime/utils/where.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Inspired by https://gist.github.com/wtaysom/1236979
+
+module Bade
+  module Where
+    class << self
+      def is_proc(proc)
+        source_location(proc)
+      end
+
+      def is_method(klass, method_name)
+        source_location(klass.method(method_name))
+      end
+
+      def is_instance_method(klass, method_name)
+        source_location(klass.instance_method(method_name))
+      end
+
+      def are_methods(klass, method_name)
+        are_via_extractor(:method, klass, method_name)
+      end
+
+      def are_instance_methods(klass, method_name)
+        are_via_extractor(:method, klass, method_name)
+      end
+
+      def is_class(klass)
+        defined_methods(klass)
+          .group_by { |sl| sl[0] }
+          .map do |file, sls|
+            lines = sls.map { |sl| sl[1] }
+            count = lines.size
+            line = lines.min
+
+            {
+              file: file,
+              count: count,
+              line: line
+            }
+          end
+          .sort_by { |fc| fc[:count] }
+          .map { |fc| [fc[:file], fc[:line]] }
+      end
+
+      # Raises ArgumentError if klass does not have any Ruby methods defined in it.
+      def is_class_primarily(klass)
+        source_locations = is_class(klass)
+        if source_locations.empty?
+          methods = defined_methods(klass)
+          msg = if methods.empty?
+                  "#{klass} has no methods"
+                else
+                  "#{klass} only has built-in methods (#{methods.size} in total)"
+                end
+
+          raise ::ArgumentError, msg
+        end
+        source_locations[0]
+      end
+
+      private
+
+      def source_location(method)
+        method.source_location || (
+          method.to_s =~ /: (.*)>/
+          Regexp.last_match(1)
+        )
+      end
+
+      def are_via_extractor(extractor, klass, method_name)
+        klass.ancestors
+             .map do |ancestor|
+               method = ancestor.send(extractor, method_name)
+               source_location(method) if method.owner == ancestor
+             end
+             .compact
+      end
+
+      def defined_methods(klass)
+        methods = klass.methods(false).map { |m| klass.method(m) } +
+                  klass.instance_methods(false).map { |m| klass.instance_method(m) }
+        methods
+          .map(&:source_location)
+          .compact
+      end
+    end
+  end
+
+  def self.where_is(klass, method = nil)
+    if method
+      begin
+        Where.is_instance_method(klass, method)
+      rescue NameError
+        Where.is_method(klass, method)
+      end
+    else
+      Where.is_class_primarily(klass)
+    end
+  end
+end

data/lib/bade/runtime.rb

@@ -3,6 +3,10 @@
 module Bade
   module Runtime
     Location = Struct.new(:path, :lineno, :label, keyword_init: true) do
+      def template?
+        path == TEMPLATE_FILE_NAME || path&.include?('.bade')
+      end
+
       def to_s
         "#{path || TEMPLATE_FILE_NAME}:#{lineno}:in `#{label}'"
       end
@@ -13,23 +17,41 @@ module Bade
       #
       attr_reader :template_backtrace
 
+      # @return [Boolean]
+      #
+      attr_reader :print_locations_warning
+
       # @param [String] msg
       # @param [Array<Location>] template_backtrace
       # @param [Exception, nil] original
-      def initialize(msg, template_backtrace = [], original: nil)
+      def initialize(msg, template_backtrace = [], original: nil, print_locations_warning: false)
         super(msg)
         @template_backtrace = template_backtrace
         @original = original
+        @print_locations_warning = print_locations_warning
       end
 
-      def message
+      def to_s
         if @template_backtrace.empty?
           super
         else
+          warning = if print_locations_warning
+                      <<~TEXT
+
+                        !!! WARNING !!!, filenames and line numbers of functions can be misleading due to using Ruby
+                        functions in different Bade file. Trust only functions names. Mixins are fine.
+
+                        This will be fixed in https://github.com/epuber-io/bade/issues/32
+                      TEXT
+                    else
+                      ''
+                    end
+
           <<~MSG.rstrip
             #{super}
             template backtrace:
             #{__formatted_backtrace.join("\n")}
+            #{warning}
           MSG
         end
       end
@@ -53,14 +75,20 @@ module Bade
       def self.process_locations(locations)
         return [] if locations.nil?
 
-        index = locations&.find_index { |loc| loc.path == TEMPLATE_FILE_NAME || loc.path&.include?('.bade') }
+        # map to Bade's Location
+        new_locations = locations.map { |loc| Location.new(path: loc.path, lineno: loc.lineno, label: loc.label) }
+
+        # find location to use or drop
+        index = new_locations.rindex(&:template?)
         return [] if index.nil?
 
-        new_locations = locations[0...index] || []
+        # get only locations inside template
+        new_locations = new_locations[0...index] || []
 
-        new_locations.map do |loc|
-          Location.new(path: loc.path, lineno: loc.lineno, label: loc.label)
-        end
+        # filter out not interested locations
+        new_locations
+          .reject { |loc| loc.path.start_with?(__dir__) }
+          .reject { |loc| loc.template? && loc.label.include?('lambda_instance') }
       end
 
       # @param [String] msg
@@ -68,8 +96,9 @@ module Bade
       # @param [Array<Location>] template_backtrace
       # @return [RuntimeError]
       def self.wrap_existing_error(msg, error, template_backtrace)
-        locs = Bade::Runtime::RuntimeError.process_locations(error.backtrace_locations) + template_backtrace
-        Bade::Runtime::RuntimeError.new(msg, locs, original: error)
+        ruby_locs = Bade::Runtime::RuntimeError.process_locations(error.backtrace_locations)
+        locs = ruby_locs + template_backtrace
+        Bade::Runtime::RuntimeError.new(msg, locs, original: error, print_locations_warning: !ruby_locs.empty?)
       end
     end
 

data/lib/bade/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bade
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.3.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bade
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Roman Kříž
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -112,6 +112,7 @@ files:
 - lib/bade/runtime/globals_tracker.rb
 - lib/bade/runtime/mixin.rb
 - lib/bade/runtime/render_binding.rb
+- lib/bade/runtime/utils/where.rb
 - lib/bade/version.rb
 homepage: https://github.com/epuber-io/bade
 licenses:
@@ -133,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
+rubygems_version: 3.3.9
 signing_key:
 specification_version: 4
 summary: Minimalistic template engine for Ruby.