rbexy 2.0.0.beta4 → 2.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9cb20a821099f8fd51a0abb4b80ad3b2d8d936afcfe240a4b99ea29f4dea92a
-  data.tar.gz: aab32903c9632f245857c917b0b99743e5e58ddb8356fce1274c5dd2e4791b37
+  metadata.gz: 5d36622639519d2abe9b9306612de65de836294ad529109d0ed5c1f8f11c0750
+  data.tar.gz: bae1042c6e80c5ec1a4f609162eee4d1efc66f340a6e742bc22d315bf486f597
 SHA512:
-  metadata.gz: a849303b1f41e2e6295558b09f1a608a3b24bca8317bde650c579c6a0da2206c67f1ea9bb49e4b7bf15e66497960fff70703845544a57271c4947e4abe16d5ef
-  data.tar.gz: 5f08d1838d39cf38d3f3d727e5c1ea098255e81e4a2ab4affd2b67a77a10d7f55dccdff52114f5ce9d544238d81d09a66f548ed74961298026f7887ad30339fd
+  metadata.gz: 749d66a40e869ee18c086d1d1c299936fb8c65ab742492a575a6d1afbc400a8c553df5cb337edf57b43aa200e856ec38b4c2bf6acee3d458a2dcfb86831f4cf7
+  data.tar.gz: 88a13df06a488a65ebf7e6aad95051ae23fad394f628e66e667c2ed1584a4e6c33909209e11ccdb210fbc6f41c089f1ce8cef3b80283e099998290c7608e924e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbexy (2.0.0.beta4)
+    rbexy (2.0.0.beta5)
       actionview (>= 6.0, < 7.0)
       activesupport (>= 6.0, < 7.0)
 

data/README.md

@@ -301,7 +301,7 @@ By default, we'll look for a template file in the same directory as the class an
 <h1>{@title}</h1>
 ```
 
-You can call this component from another `.rbx` template file (`<PageHeader title="Hello" />`)—either one rendered by another component class or a Rails view file like `app/views/products/index.rbx`. Or you can call it from ERB (or any other template language) like `PageHeaderComponent.new(self, title: "Hello").render`.
+You can call this component from another `.rbx` template file (`<PageHeader title="Hello" />`)—either one rendered by another component class or a Rails view file like `app/views/products/index.rbx`. Or you can call it from ERB (or any other template language) like `PageHeaderComponent.new(self, title: "Hello").render_in`.
 
 Your components and their templates run in the same context as traditional Rails views, so you have access to all of the view helpers you're used to as well as any custom helpers you've defined in `app/helpers/`.
 

data/lib/rbexy/cache_component.rb

@@ -0,0 +1,17 @@
+module Rbexy
+  class CacheComponent < Rbexy::Component
+    def setup(key:)
+      @key = key
+    end
+
+    def call
+      @current_template = view_context.instance_variable_get(:@current_template)
+
+      capture do
+        cache @key, virtual_path: @current_template.virtual_path do
+          @output_buffer << content
+        end
+      end
+    end
+  end
+end

data/lib/rbexy/component.rb

@@ -1,4 +1,5 @@
 require "action_view"
+require "active_support/core_ext/class/attribute"
 
 module Rbexy
   class Component < ActionView::Base
@@ -10,12 +11,22 @@ module Rbexy
       end
     end
 
-    def self.component_name
-      name.underscore
+    class_attribute :component_file_location
+
+    def self.inherited(klass)
+      klass.component_file_location = caller_locations(1, 10).reject { |l| l.label == "inherited" }[0].absolute_path
+    end
+
+    def self.template_path
+      TemplatePath.new(component_name)
+    end
+
+    def self.call_component?
+      method_defined?(:call)
     end
 
-    def component_name
-      self.class.component_name
+    def self.component_name
+      name.underscore
     end
 
     def initialize(view_context, **props)
@@ -35,18 +46,9 @@ module Rbexy
     # call super(view_context).
     def setup(**props); end
 
-    def render(&block)
+    def render_in(_context = view_context, &block)
       @content_block = block_given? ? block : nil
-      call
-    end
-
-    def call
-      path = TemplatePath.new(component_name)
-      template = view_context.lookup_context.find(path)
-      template.render(self, {})
-    rescue ActionView::Template::Error => error
-      error.set_backtrace clean_template_backtrace(error.backtrace)
-      raise error
+      self.class.call_component? ? call : _render
     end
 
     def content
@@ -61,6 +63,15 @@ module Rbexy
 
     attr_reader :view_context, :content_block
 
+    def _render
+      path = self.class.template_path
+      template = view_context.lookup_context.find(path)
+      template.render(self, {})
+    rescue ActionView::Template::Error => error
+      error.set_backtrace clean_template_backtrace(error.backtrace)
+      raise error
+    end
+
     def method_missing(meth, *args, &block)
       view_context.send(meth, *args, &block)
     end

data/lib/rbexy/component_resolver.rb

@@ -19,6 +19,13 @@ module Rbexy
       tspan tt u ul unknown use var video view wbr xmp
     ).to_set
 
+    def self.try_constantize
+      yield
+    rescue NameError => e
+      raise e unless e.message =~ /wrong constant name/ || e.message =~ /uninitialized constant/
+      nil
+    end
+
     attr_reader :component_namespaces
 
     def initialize
@@ -43,18 +50,11 @@ module Rbexy
     private
 
     def find(name)
-      find!(name)
-    rescue NameError => e
-      raise e unless e.message =~ /wrong constant name/ || e.message =~ /uninitialized constant/
-      nil
+      self.class.try_constantize { ActiveSupport::Inflector.constantize("#{name.gsub(".", "::")}Component") }
     end
 
     def matching_namespaces(template)
       component_namespaces.select { |path, ns| template.identifier.start_with?(path) }.values.flatten.uniq
     end
-
-    def find!(name)
-      ActiveSupport::Inflector.constantize("#{name.gsub(".", "::")}Component")
-    end
   end
 end

data/lib/rbexy/configuration.rb

@@ -22,7 +22,7 @@ module Rbexy
     def component_rendering_templates
       @component_rendering_templates ||= {
         children: "{capture{%{children}}}",
-        component: "::%{component_class}.new(%{view_context},%{kwargs}).render%{children_block}"
+        component: "::%{component_class}.new(%{view_context},%{kwargs}).render_in%{children_block}"
       }
     end
   end

data/lib/rbexy/rails.rb

@@ -1,9 +1,11 @@
 module Rbexy
   autoload :Component, "rbexy/component"
+  autoload :CacheComponent, "rbexy/cache_component"
 
   module Rails
     autoload :Engine, "rbexy/rails/engine"
     autoload :ControllerHelper, "rbexy/rails/controller_helper"
     autoload :ComponentTemplateResolver, "rbexy/rails/component_template_resolver"
+    autoload :RbxDependencyTracker, "rbexy/rails/rbx_dependency_tracker"
   end
 end

data/lib/rbexy/rails/component_template_resolver.rb

@@ -1,7 +1,13 @@
+require "active_support/digest"
+
 module Rbexy
   module Rails
     class ComponentTemplateResolver < ActionView::FileSystemResolver
-      VIRTUAL_ROOT = "rbexy_component".freeze
+      COMMENT_SYNTAX = {
+        rbx: "# %s",
+        erb: "<%# %s %>",
+        html: "<!-- %s -->"
+      }
 
       # Rails 6 requires us to override `_find_all` in order to hook
       def _find_all(name, prefix, partial, details, key, locals)
@@ -14,22 +20,71 @@ module Rbexy
         return [] unless name.is_a? Rbexy::Component::TemplatePath
 
         templates_path = File.join(@path, prefix, name)
+        component_name = prefix.present? ? File.join(prefix, name) : name
+        virtual_path = Rbexy::Component::TemplatePath.new(component_name)
+
         extensions = details[:handlers].join(",")
+        templates = find_rbx_templates(templates_path, extensions, component_name, virtual_path)
+
+        if templates.none?
+          templates = find_call_component_cachebuster_templates(templates_path, component_name, virtual_path)
+        end
+
+        templates
+      end
 
+      def find_rbx_templates(templates_path, extensions, component_name, virtual_path)
         Dir["#{templates_path}.*{#{extensions}}"].map do |template_path|
           source = File.binread(template_path)
-          handler = ActionView::Template.handler_for_extension(File.extname(template_path)[1..-1])
-          virtual_path = File.join(VIRTUAL_ROOT, prefix, name)
+          extension = File.extname(template_path)[1..-1]
+          handler = ActionView::Template.handler_for_extension(extension)
 
           ActionView::Template.new(
-            source,
+            "#{source}#{component_class_cachebuster(component_name, extension)}",
             template_path,
             handler,
+            format: extension.to_sym,
             locals: [],
             virtual_path: virtual_path
           )
         end
       end
+
+      def find_call_component_cachebuster_templates(templates_path, component_name, virtual_path)
+        component_class = find_component_class(component_name)
+        return [] unless component_class && component_class.call_component?
+
+        [
+          ActionView::Template.new(
+            cachebuster_digest_as_comment(component_class.component_file_location, :rbx),
+            "#{templates_path}.rbexycall",
+            ActionView::Template.handler_for_extension(:rbx),
+            format: :rbx,
+            locals: [],
+            virtual_path: virtual_path
+          )
+        ]
+      end
+
+      def component_class_cachebuster(component_name, template_format)
+        component_class = find_component_class(component_name)
+        return unless component_class
+
+        cachebuster_digest_as_comment(component_class.component_file_location, template_format)
+      end
+
+      def find_component_class(component_name)
+        Rbexy::ComponentResolver.try_constantize { component_name.classify.constantize }
+      end
+
+      def cachebuster_digest_as_comment(filename, format)
+        source = File.binread(filename)
+        digest = ActiveSupport::Digest.hexdigest(source)
+
+        comment_template = COMMENT_SYNTAX[format.to_sym] || COMMENT_SYNTAX[:html]
+        comment = comment_template % digest
+        "\n#{comment}"
+      end
     end
   end
 end

data/lib/rbexy/rails/engine.rb

@@ -1,4 +1,5 @@
 require "rbexy/rails"
+require "action_view/dependency_tracker"
 
 module Rbexy
   module Rails
@@ -7,6 +8,7 @@ module Rbexy
         template_handler = proc { |template, source| Rbexy.compile(Rbexy::Template.new(source, template.identifier)) }
 
         ActionView::Template.register_template_handler(:rbx, template_handler)
+        ActionView::DependencyTracker.register_tracker(:rbx, RbxDependencyTracker)
 
         ActiveSupport.on_load :action_controller_base do
           include ControllerHelper

data/lib/rbexy/rails/rbx_dependency_tracker.rb

@@ -0,0 +1,37 @@
+module Rbexy
+  module Rails
+    class RbxDependencyTracker
+      def self.supports_view_paths?
+        true
+      end
+
+      def self.call(name, template, view_paths = nil)
+        new(name, template, view_paths).dependencies
+      end
+
+      def initialize(name, template, view_paths = nil)
+        @name, @template, @view_paths = name, template, view_paths
+      end
+
+      def dependencies
+        rails_render_helper_dependencies + rbexy_dependencies
+      end
+
+      private
+
+      attr_reader :name, :template, :view_paths
+
+      def rails_render_helper_dependencies
+        ActionView::DependencyTracker::ERBTracker.call(name, template, view_paths)
+      end
+
+      def rbexy_dependencies
+        Lexer.new(template, Rbexy.configuration.element_resolver).tokenize
+          .select { |t| t[0] == :TAG_DETAILS && t[1][:type] == :component }
+          .map { |t| t[1][:component_class] }
+          .uniq
+          .map(&:template_path)
+      end
+    end
+  end
+end

data/lib/rbexy/version.rb

@@ -1,3 +1,3 @@
 module Rbexy
-  VERSION = "2.0.0.beta4"
+  VERSION = "2.0.0.beta5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbexy
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta4
+  version: 2.0.0.beta5
 platform: ruby
 authors:
 - Nick Giancola
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-16 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -217,6 +217,7 @@ files:
 - docker-compose.yml
 - lib/rbexy.rb
 - lib/rbexy/ast_transformer.rb
+- lib/rbexy/cache_component.rb
 - lib/rbexy/component.rb
 - lib/rbexy/component/backtrace_cleaner.rb
 - lib/rbexy/component_context.rb
@@ -244,6 +245,7 @@ files:
 - lib/rbexy/rails/component_template_resolver.rb
 - lib/rbexy/rails/controller_helper.rb
 - lib/rbexy/rails/engine.rb
+- lib/rbexy/rails/rbx_dependency_tracker.rb
 - lib/rbexy/refinements.rb
 - lib/rbexy/refinements/array.rb
 - lib/rbexy/refinements/array/find_map.rb