klenod-build 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a05a70d821a5b94964b4bade32066b9fd1bdade13d2b3899becdeb46d3d33ef
-  data.tar.gz: 68ac76064521f6ca7678d51256672d5ea9161814215bf4c9e3b5a3f743350bc8
+  metadata.gz: 3f6f0bd5e9b747b26e394d5c041f30ce22aa9436f8483689172c48ae2219af1b
+  data.tar.gz: 8a11818a46097229cab6c5c2f94515306f9f989c7b2c49eefcb045b46e68a3a8
 SHA512:
-  metadata.gz: 440df52a915ecb0b8312622268b94d413c3447d80912ef42a797a959aaadca42ec3c108a08439d79eb7cf9fff0d7baf4a5425e565d087b4f6b18efee84d0f2df
-  data.tar.gz: 1ddb4e48b0156a21160fa3d93f855ab657bc4ed40d323e5f3d2f6bbd9dc3d27b36c093ec9731b1eeb791a4b601499721ce89665c23c84be4ad57c02c84491d9f
+  metadata.gz: f10d5c296da38e42bfd54e37366dd28e834bbb21b2ed455ea0ab1b325eb4e43ca2e8dc41b0e0d30b6709db8563441573ed5132a9d85ef1f81d8287459a9c40a0
+  data.tar.gz: ed6f70303f40f60b71147980de86b84482106407d927ac7aa248efccb92c2ee83cff94fdf0baa382e2e18229460e526cad265679383d27b8d80aa2ce8106edde

data/lib/klenod/build/plugins/haml_plugin/transformer/ruby_builder.rb

@@ -28,9 +28,9 @@ module Klenod
               end
             end
 
-            def initialize(profiler: nil, global_variables: nil)
+            def initialize(profiler: nil, variables: nil)
               @profiler = profiler
-              @global_variables = global_variables
+              @variables = variables || {}
               @expression_cache = {}
               @statements_cache = {}
               @program_cache = {}
@@ -411,6 +411,12 @@ module Klenod
               source_factory_call(factory: factory, tag: tag, children: children, props: props, mark: mark)
             end
 
+            def component_factory_call(factory:, tag:, children:, props:, mark: nil)
+              call = source_factory_call(factory: factory, tag: tag, children: [], props: props, mark: mark)
+              body = Fragment.new("[#{children.map { |child| argument_source(child) }.join(", ")}]", nil)
+              script_block("#{call.source} do", body)
+            end
+
             def slot_call(name:, fallback:)
               arguments = ["self", name ? argument_source(name) : "nil"]
               arguments << argument_source(fallback) if fallback
@@ -505,7 +511,7 @@ module Klenod
 
             def rewrite_ruby_source(source, line_no)
               source = rewrite_line_constant(source, line_no)
-              rewrite_global_variables(source)
+              rewrite_variables(source)
             end
 
             def rewrite_line_constant(source, line_no)
@@ -527,25 +533,33 @@ module Klenod
                 end
             end
 
-            def rewrite_global_variables(source)
-              return source unless @global_variables
+            VARIABLE_TOKEN_KINDS = {
+              on_gvar: [:global, "$", /\A\$[a-z]\w*\z/],
+              on_cvar: [:class, "@@", /\A@@[a-z]\w*\z/],
+              on_ivar: [:instance, "@", /\A@[a-z]\w*\z/]
+            }.freeze
+
+            def rewrite_variables(source)
+              return source if @variables.empty?
 
               line_offsets = [0]
               source.each_line(chomp: false) { |line| line_offsets << line_offsets.last + line.length }
 
               Ripper
                 .lex(source)
-                .select { |(_line, _column), type, token, _state| type == :on_gvar && prop_global_variable?(token) }
-                .reverse_each
-                .each_with_object(source.dup) do |((line, column), _type, token, _state), rewritten|
-                  name = token.delete_prefix("$")
+                .filter_map do |(line, column), type, token, _state|
+                  kind, prefix, pattern = VARIABLE_TOKEN_KINDS[type]
+                  receiver = @variables[kind]
+                  next unless receiver && token.match?(pattern)
+
+                  name = token.delete_prefix(prefix)
                   offset = line_offsets.fetch(line - 1) + column
-                  rewritten[offset, token.length] = "#{@global_variables}[#{symbol_source(name)}]"
+                  [offset, token.length, "(#{receiver})[#{symbol_source(name)}]"]
+                end
+                .reverse_each
+                .each_with_object(source.dup) do |(offset, length, replacement), rewritten|
+                  rewritten[offset, length] = replacement
                 end
-            end
-
-            def prop_global_variable?(token)
-              token.match?(/\A\$[a-z]\w*\z/)
             end
 
             def source_expressions(expressions)

data/lib/klenod/build/plugins/haml_plugin/transformer.rb

@@ -36,27 +36,31 @@ module Klenod
             factory:,
             styles_source:,
             translations_source:,
+            component_children: :eager,
             i18n_source: nil,
             styleable: false,
             profiler: nil,
             import_rewriter: nil,
             markdown_components_source: "{}",
-            global_variables: nil,
+            variables: nil,
             haml_helper_source: nil,
             cache_static_subtrees: false
           )
             component_base_class = ConstPath.parse(component_base_class, name: "component_base_class")
             factory = ConstPath.parse(factory, name: "factory")
-            builder = RubyBuilder.new(profiler: profiler, global_variables: global_variables)
+            validate_component_children(component_children)
+            builder = RubyBuilder.new(profiler: profiler, variables: variables)
             haml_helper_source ||= builder.constant_assignment("HamlHelper", "Object") if styleable || cache_static_subtrees
             previous_profiler = @profiler
             previous_module_id = @module_id
             previous_static_constants = @static_constants
             previous_cache_static_subtrees = @cache_static_subtrees
+            previous_component_children = @component_children
             @profiler = profiler
             @module_id = module_id
             @static_constants = []
             @cache_static_subtrees = cache_static_subtrees
+            @component_children = component_children
             template =
               if profiler
                 profiler.measure(:haml_compile_template, module_id: module_id.to_s) do
@@ -131,12 +135,19 @@ module Klenod
             @module_id = previous_module_id
             @static_constants = previous_static_constants
             @cache_static_subtrees = previous_cache_static_subtrees
+            @component_children = previous_component_children
           end
 
           private
 
           Template = Data.define(:ruby, :render, :static_constants)
 
+          def validate_component_children(value)
+            return if HamlPlugin::COMPONENT_CHILDREN_MODES.include?(value)
+
+            raise ArgumentError, "component_children must be one of: #{HamlPlugin::COMPONENT_CHILDREN_MODES.join(", ")}"
+          end
+
           def measure_compile(name)
             return yield unless @profiler
 
@@ -456,13 +467,17 @@ module Klenod
             tag = measure_compile_detail(:haml_compile_tag_name) { compile_tag_name(node, builder: builder) }
             props = measure_compile_detail(:haml_compile_tag_attributes) { attributes(node, styleable: styleable, builder: builder) }
 
-            builder.factory_call(
-              factory: factory,
-              tag: tag,
-              children: children,
-              props: props,
-              mark: mark
-            )
+            if @component_children == :lazy && constant_tag_name?(node.value.fetch(:name)) && !children.empty?
+              builder.component_factory_call(factory: factory, tag: tag, children: children, props: props, mark: mark)
+            else
+              builder.factory_call(
+                factory: factory,
+                tag: tag,
+                children: children,
+                props: props,
+                mark: mark
+              )
+            end
           end
 
           def compile_tag_name(node, builder:)

data/lib/klenod/build/plugins/haml_plugin.rb

@@ -28,6 +28,8 @@ module Klenod
 
         DEFAULT_COMPONENT_BASE_CLASS = ComponentDefaults::DEFAULT_COMPONENT_BASE_CLASS
         DEFAULT_FACTORY = ComponentDefaults::DEFAULT_FACTORY
+        DEFAULT_COMPONENT_CHILDREN = :eager
+        COMPONENT_CHILDREN_MODES = %i[eager lazy].freeze
         HAML_HELPER_SPECIFIER = "virtual:klenod/haml_helper"
         HAML_HELPER_MODULE_ID = ModuleId.new("#{HAML_HELPER_SPECIFIER}.rb", nil)
         STATIC_CLASS_SOURCE_PATTERN = /^[ \t]*(?:%[-:\w]+)?(?:#[\w-]+)?\.[\w-]|[({][^)}\n]*\bclass\s*=/m
@@ -43,6 +45,8 @@ module Klenod
 
           DEFAULT_COMPONENT_BASE_CLASS = HamlPlugin::DEFAULT_COMPONENT_BASE_CLASS
           DEFAULT_FACTORY = HamlPlugin::DEFAULT_FACTORY
+          DEFAULT_COMPONENT_CHILDREN = HamlPlugin::DEFAULT_COMPONENT_CHILDREN
+          COMPONENT_CHILDREN_MODES = HamlPlugin::COMPONENT_CHILDREN_MODES
           HAML_HELPER_SPECIFIER = HamlPlugin::HAML_HELPER_SPECIFIER
           HAML_HELPER_MODULE_ID = HamlPlugin::HAML_HELPER_MODULE_ID
           STATIC_CLASS_SOURCE_PATTERN = HamlPlugin::STATIC_CLASS_SOURCE_PATTERN
@@ -58,14 +62,16 @@ module Klenod
           def initialize(
             component_base_class: DEFAULT_COMPONENT_BASE_CLASS,
             factory: DEFAULT_FACTORY,
-            global_variables: nil,
+            component_children: DEFAULT_COMPONENT_CHILDREN,
+            variables: nil,
             i18n_class: nil,
             i18n_constant: nil,
             cache_static_subtrees: false
           )
             @component_base_class = component_base_class
             @factory = factory
-            @global_variables = validate_global_variables(global_variables)
+            @component_children = validate_component_children(component_children)
+            @variables = validate_variables(variables)
             @i18n_class, @i18n_constant = validate_i18n_options(i18n_class, i18n_constant)
             @cache_static_subtrees = cache_static_subtrees
             @transformer = Transformer.new
@@ -191,6 +197,7 @@ module Klenod
                 component_class_name: component_class_name,
                 component_base_class: @component_base_class,
                 factory: @factory,
+                component_children: @component_children,
                 styles_source: styles_source,
                 translations_source: translations_source,
                 i18n_source: i18n_source_for(builder),
@@ -199,7 +206,7 @@ module Klenod
                 profiler: context.profiler,
                 import_rewriter: import_rewriter,
                 markdown_components_source: markdown_components_dependency ? "__klenod_import__(#{markdown_components_dependency.id.inspect})::Default" : "{}",
-                global_variables: @global_variables,
+                variables: @variables,
                 cache_static_subtrees: @cache_static_subtrees
               )
             import_rewrite =
@@ -257,16 +264,36 @@ module Klenod
 
           InlineCssSource = Data.define(:text, :line_offset, :column_offset)
 
-          def validate_global_variables(global_variables)
-            return nil if global_variables.nil?
+          VARIABLE_KINDS = %i[global class instance].freeze
+
+          def validate_component_children(value)
+            return value if COMPONENT_CHILDREN_MODES.include?(value)
+
+            raise ArgumentError, "component_children must be one of: #{COMPONENT_CHILDREN_MODES.join(", ")}"
+          end
+
+          def validate_variables(variables)
+            return {}.freeze if variables.nil?
+            raise ArgumentError, "variables must be a Hash" unless variables.is_a?(Hash)
+
+            unknown_kinds = variables.keys - VARIABLE_KINDS
+            unless unknown_kinds.empty?
+              raise ArgumentError, "variables contains unknown kinds: #{unknown_kinds.map(&:inspect).join(", ")}"
+            end
+
+            variables.to_h { |kind, source| [kind, validate_variable_receiver(kind, source)] }.freeze
+          end
+
+          def validate_variable_receiver(kind, source)
+            raise ArgumentError, "variables[#{kind.inspect}] must be a Ruby expression String" unless source.is_a?(String)
 
-            source = global_variables.to_s
             parsed = SyntaxTree.parse(source)&.statements&.body
-            raise ArgumentError, "global_variables must be a Ruby expression" unless parsed&.length == 1
+            raise ArgumentError, "variables[#{kind.inspect}] must be a Ruby expression" unless parsed&.length == 1
+            SyntaxTree.parse("(#{source})[:__klenod_variable__]")
 
             source
           rescue SyntaxTree::Parser::ParseError
-            raise ArgumentError, "global_variables must be a Ruby expression"
+            raise ArgumentError, "variables[#{kind.inspect}] must be a Ruby expression"
           end
 
           def validate_i18n_options(i18n_class, i18n_constant)

data/lib/klenod/build/version.rb

@@ -2,6 +2,6 @@
 
 module Klenod
   module Build
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: klenod-build
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrés Alin
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement
@@ -219,8 +219,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
-description: Klenod build constructs Ruby module graphs, runs plugins, emits assets,
-  and serializes runtime bundles.
+description: Build system and devtools for Klenod.
 email:
 - andreas.alin@gmail.com
 executables: []
@@ -306,5 +305,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.16
 specification_version: 4
-summary: Build graph and plugins for Klenod.
+summary: Build system for Klenod.
 test_files: []