rbexy 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cf2789f8c063a3b67dc6c4da86979b89214679833c8be14bee61d52b1a17f3b
-  data.tar.gz: 89d4d684fb473837be4b7c239e034ec6d27f9b754978cb6bfeb7b77774310e9b
+  metadata.gz: 20306c3d1c288a652a8a9d4d455c9378a22165ef7c07240e234159794cd02d18
+  data.tar.gz: 4c8e6b19cd8f47744aba8e2850fbc73425678252628a7c6c46e31abf66937e97
 SHA512:
-  metadata.gz: cf0cd9cbf4fc983f6f7213da1babd5e6e334f86c3bd9a3f129f4889d69390946e858a29bc9cede2ffe36e510c6573fea1eb8e55b2e1f504964305a765efd3236
-  data.tar.gz: fc8090cb79071025b6f3ab491bdff3558a22dccfe43350830f36e6a8ba965e318b39e86bd07aec73659db428a4c223a115ccb3684b30a819e7dc5b577951d04b
+  metadata.gz: 70920c8f7a9da04edccbe8de30b6b12ad10e9bfe3d6a4657d412e74cad1f23c705c3bd213c81d15859b18457917f4dd5672030fd4d0072dd06bbf894c2d8eb15
+  data.tar.gz: 0aa89cce16b4011a91b2ffeb89472ec687b40bcd9f97f061dd85e7f01507fe034e4b3388fb14da066921c98846187f3c77b154b3d1d03b145716a7e50e9a4657

data/.gitignore

@@ -1,3 +1,4 @@
-spec/dummy/log/
+spec/dummy/log/*
 pkg/
-spec/dummy/tmp/
+spec/dummy/tmp/*
+spec/dummy/db/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbexy (0.2.1)
+    rbexy (1.0.0)
       actionview (>= 5.0, < 7.0)
       activesupport (>= 5.0, < 7.0)
       railties (>= 5.0, < 7.0)
@@ -201,7 +201,7 @@ PLATFORMS
 DEPENDENCIES
   guard-rspec (~> 4.7, >= 4.7.3)
   pry-byebug
-  rails (>= 5.0, < 7.0)
+  rails (>= 6.0, < 7.0)
   rake
   rbexy!
   rspec (~> 3.9)

data/README.md

@@ -48,6 +48,8 @@ Add it to your Gemfile and `bundle install`:
 gem "rbexy"
 ```
 
+_From 1.0 onward, we only support Rails 6. If you're using Rails 5, use the 0.x releases._
+
 In `config/application.rb`:
 
 ```ruby

data/docker-compose.yml

@@ -6,6 +6,7 @@ volumes:
 services:
   rbexy:
     build: .
+    image: rbexy
     volumes:
       - .:/app
       - bundle:/usr/local/bundle
@@ -13,3 +14,14 @@ services:
       - $HOME/.gitconfig:/root/.gitconfig:ro
       - $HOME/.gem/credentials:/root/.gem/credentials
     working_dir: /app
+  dummy:
+    image: rbexy
+    volumes:
+      - .:/app
+      - bundle:/usr/local/bundle
+    working_dir: /app/spec/dummy/
+    command: ./start.sh
+    ports:
+      - 3000:3000
+    environment:
+      - RAILS_LOG_STDOUT=1

data/lib/rbexy.rb

@@ -6,7 +6,6 @@ module Rbexy
   autoload :Nodes, "rbexy/nodes"
   autoload :Runtime, "rbexy/runtime"
   autoload :HashMash, "rbexy/hash_mash"
-  autoload :OutputBuffer, "rbexy/output_buffer"
   autoload :ComponentTagBuilder, "rbexy/component_tag_builder"
   autoload :ViewContextHelper, "rbexy/view_context_helper"
   autoload :Configuration, "rbexy/configuration"

data/lib/rbexy/component.rb

@@ -1,27 +1,24 @@
 require "action_view"
+require "active_support/core_ext/class/attribute"
 
 module Rbexy
   class Component < ActionView::Base
-    class LookupContext < ActionView::LookupContext
-      attr_accessor :component_name_stack
-
-      def self.details_hash(context)
-        context.registered_details.each_with_object({}) do |key, details_hash|
-          value = key == :locale ? [context.locale] : context.send(key)
-          details_hash[key] = value
-        end
-      end
+    autoload :BacktraceCleaner, "rbexy/component/backtrace_cleaner"
 
-      # We override any calls to args_for_lookup and set partial=false so that
-      # the lookup context doesn't automatically add a `_` prefix to the
-      # template path, since we're using the Rails partial-rendering
-      # functionality but don't want our templates prefixed with a `_`
-      def args_for_lookup(name, prefixes, partial, keys, details_options)
-        partial = false if component_name_stack.include?(name)
-        super(name, prefixes, partial, keys, details_options)
+    class TemplatePath < String
+      def to_s
+        self
       end
     end
 
+    def self.component_name
+      name.underscore
+    end
+
+    def component_name
+      self.class.component_name
+    end
+
     def initialize(view_context, **props)
       super(
         view_context.lookup_context,
@@ -40,20 +37,21 @@ module Rbexy
     def setup(**props); end
 
     def render(&block)
-      @content = nil
       @content_block = block_given? ? block : nil
       call
     end
 
     def call
-      replace_lookup_context
-      view_renderer.render(self, partial: component_name, &nil)
-    ensure
-      restore_lookup_context
+      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
     end
 
     def content
-      @content ||= content_block ? view_context.capture(self, &content_block) : ""
+      content_block ? content_block.call : ""
     end
 
     def create_context(name, value)
@@ -67,40 +65,13 @@ module Rbexy
         raise(ContextNotFound, "no parent context `#{name}`")
     end
 
-    def view_renderer
-      view_context.view_renderer
-    end
-
-    def component_name
-      self.class.name.underscore
+    def compiled_method_container
+      Rbexy::Component
     end
 
     private
 
-    attr_reader :view_context, :content_block, :old_lookup_context
-
-    def replace_lookup_context
-      unless view_renderer.lookup_context.is_a? Rbexy::Component::LookupContext
-        @old_lookup_context = view_renderer.lookup_context
-        view_renderer.lookup_context = build_lookup_context(old_lookup_context)
-      end
-
-      (view_renderer.lookup_context.component_name_stack ||= []) << component_name
-    end
-
-    def restore_lookup_context
-      return unless old_lookup_context
-      view_renderer.lookup_context = old_lookup_context
-      @old_lookup_context = nil
-    end
-
-    def build_lookup_context(existing_context)
-      paths = existing_context.view_paths.dup.unshift(
-        *Rbexy.configuration.template_paths.map { |p| ActionView::OptimizedFileSystemResolver.new(p) }
-      )
-
-      LookupContext.new(paths, LookupContext.details_hash(existing_context))
-    end
+    attr_reader :view_context, :content_block
 
     def method_missing(meth, *args, &block)
       if view_context.respond_to?(meth)
@@ -109,5 +80,10 @@ module Rbexy
         super
       end
     end
+
+    def clean_template_backtrace(backtrace)
+      return backtrace if Rbexy.configuration.debug
+      BacktraceCleaner.new(backtrace).call
+    end
   end
 end

data/lib/rbexy/component/backtrace_cleaner.rb

@@ -0,0 +1,59 @@
+module Rbexy
+  class Component
+    class BacktraceCleaner
+      attr_reader :backtrace
+
+      def initialize(backtrace)
+        @backtrace = backtrace
+        @found_templates = {}
+      end
+
+      def call
+        backtrace
+          .reject(&method(:internal_implementation_detail?))
+          .map(&method(:strip_rbx_internals_block_mention))
+      end
+
+      private
+
+      attr_reader :found_templates
+
+      def internal_implementation_detail?(line)
+        if template = template_name_if_rbx_internals(line)
+          redundant_internal_block?(line, template)
+        else
+          internal_method_call?(line)
+        end
+      end
+
+      def internal_method_call?(line)
+        line =~ /lib\/rbexy\/.*\.rb/ ||
+          line =~ /lib\/action_view\/.*\.rb/ ||
+          line =~ /lib\/active_support\/notifications\.rb/
+      end
+
+      def redundant_internal_block?(line, template)
+        if found_templates[template]
+          true
+        else
+          found_templates[template] = true
+          false
+        end
+      end
+
+      def strip_rbx_internals_block_mention(line)
+        if template_name_if_rbx_internals(line)
+          line.gsub(/block (\(\d+ levels\))? ?in /, "")
+        else
+          line
+        end
+      end
+
+      def template_name_if_rbx_internals(line)
+        if /\/(?<template>[^\/]*)\.rbx:\d+:in `(block |_)/ =~ line
+          template
+        end
+      end
+    end
+  end
+end

data/lib/rbexy/configuration.rb

@@ -2,6 +2,8 @@ module Rbexy
   class Configuration
     attr_accessor :component_provider
     attr_accessor :template_paths
+    attr_accessor :enable_context
+    attr_accessor :debug
 
     def template_paths
       @template_paths ||= []

data/lib/rbexy/lexer.rb

@@ -22,7 +22,7 @@ module Rbexy
       text_content: /[^<{#]+/,
       comment: /^\p{Blank}*#.*(\n|\z)/,
       whitespace: /\s+/,
-      attr: /[A-Za-z0-9\-_\.]+/,
+      attr: /[A-Za-z0-9\-_\.:]+/,
       open_attr_splat: /{\*\*/,
       attr_assignment: /=/,
       double_quote: /"/,
@@ -237,7 +237,6 @@ module Rbexy
     end
 
     def potential_expression_inner_tag
-      # binding.pry
       if self.curr_expr =~ Patterns.expression_internal_tag_prefixes
         tokens << [:EXPRESSION_BODY, curr_expr]
         self.curr_expr = ""

data/lib/rbexy/nodes.rb

@@ -18,11 +18,7 @@ module Rbexy
       end
 
       def compile
-        [
-          "Rbexy::OutputBuffer.new.tap { |output|",
-            children.map(&:compile).map { |c| "output << (#{c})"}.join(";"),
-          "}.html_safe"
-        ].join(" ")
+        "#{children.map(&:compile).map { |c| "@output_buffer << rbexy_prep_output(#{c})"}.join(";")};@output_buffer"
       end
     end
 
@@ -75,23 +71,24 @@ module Rbexy
         base_tag = "rbexy_tag.#{Util.safe_tag_name(name)}(#{compile_members})"
         tag = if children.length > 0
           [
-            "#{base_tag} {",
-              "Rbexy::OutputBuffer.new.tap { |output|",
-                children.map(&:compile).map { |c| "output << (#{c})"}.join(";"),
-              "}.html_safe",
-            "}"
-          ].join(" ")
+            "#{base_tag} { capture {",
+              children.map(&:compile).map { |c| "@output_buffer << rbexy_prep_output(#{c})" }.join(";"),
+            "} }"
+          ].join
         else
           base_tag
-        end
+        end + ".html_safe"
 
-        [
-          "Rbexy::OutputBuffer.new.tap { |output|",
-            "rbexy_context.push({}) if defined?(Rbexy::Component) && self.is_a?(Rbexy::Component);",
-            "output << (#{tag});",
-            "rbexy_context.pop if defined?(Rbexy::Component) && self.is_a?(Rbexy::Component);",
-          "}.html_safe"
-        ].join(" ")
+        if Rbexy.configuration.enable_context
+          [
+            "(",
+              "rbexy_context.push({});",
+              "#{tag}.tap { rbexy_context.pop }",
+            ")"
+          ].join
+        else
+          tag
+        end
       end
 
       def compile_members

data/lib/rbexy/rails.rb

@@ -3,5 +3,7 @@ module Rbexy
 
   module Rails
     autoload :Engine, "rbexy/rails/engine"
+    autoload :ControllerHelper, "rbexy/rails/controller_helper"
+    autoload :ComponentTemplateResolver, "rbexy/rails/component_template_resolver"
   end
 end

data/lib/rbexy/rails/component_template_resolver.rb

@@ -0,0 +1,35 @@
+require "action_view"
+
+module Rbexy
+  module Rails
+    class ComponentTemplateResolver < ActionView::FileSystemResolver
+      # Rails 6 requires us to override `_find_all` in order to hook
+      def _find_all(name, prefix, partial, details, key, locals)
+        find_templates(name, prefix, partial, details, locals)
+      end
+
+      # Rails 5 only requires `find_templates` (which tbh is the proper way
+      # to implement subclasses of ActionView::Resolver)
+      def find_templates(name, prefix, partial, details, locals = [])
+        return [] unless name.is_a? Rbexy::Component::TemplatePath
+
+        templates_path = File.join(@path, prefix, name)
+        extensions = details[:handlers].join(",")
+
+        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 = ["rbexy_component", prefix, name].join("/")
+
+          ActionView::Template.new(
+            source,
+            template_path,
+            handler,
+            locals: [],
+            virtual_path: virtual_path
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rbexy/rails/controller_helper.rb

@@ -0,0 +1,20 @@
+require "active_support/concern"
+
+module Rbexy
+  module Rails
+    module ControllerHelper
+      extend ActiveSupport::Concern
+
+      def rbexy_component_provider; end
+
+      class_methods do
+        def inherited(klass)
+          super
+          Rbexy.configuration.template_paths.each do |path|
+            prepend_view_path(Rbexy::Rails::ComponentTemplateResolver.new(path))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rbexy/rails/engine.rb

@@ -13,8 +13,7 @@ module Rbexy
         ActiveSupport.on_load :action_controller_base do
           helper Rbexy::ViewContextHelper
           helper_method :rbexy_component_provider
-
-          def rbexy_component_provider; end
+          include ControllerHelper
         end
 
         if defined?(ViewComponent)
@@ -25,6 +24,7 @@ module Rbexy
           require "rbexy/component_providers/rbexy_provider"
           config.component_provider = Rbexy::ComponentProviders::RbexyProvider.new
           config.template_paths << ::Rails.root.join("app", "components")
+          config.enable_context = true
         end
       end
     end

data/lib/rbexy/runtime.rb

@@ -34,6 +34,7 @@ module Rbexy
     end
 
     def evaluate(code)
+      @output_buffer = ActionView::OutputBuffer.new
       instance_eval(code)
     rescue => e
       e.set_backtrace(e.backtrace.map { |l| l.gsub("(eval)", "(rbx template string)") })

data/lib/rbexy/version.rb

@@ -1,3 +1,3 @@
 module Rbexy
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

data/lib/rbexy/view_context_helper.rb

@@ -7,5 +7,13 @@ module Rbexy
     def rbexy_context
       @rbexy_context ||= [{}]
     end
+
+    def rbexy_prep_output(*content)
+      return if content.length == 0
+      content = content.first
+
+      value = content.is_a?(Array) ? content.join.html_safe : content
+      [nil, false].include?(value) ? "" : value.to_s
+    end
   end
 end

data/rbexy.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "actionview", ">= 5.0", "< 7.0"
   spec.add_dependency "railties", ">= 5.0", "< 7.0"
 
-  spec.add_development_dependency "rails", ">= 5.0", "< 7.0"
+  spec.add_development_dependency "rails", ">= 6.0", "< 7.0"
   spec.add_development_dependency "rspec", "~> 3.9"
   spec.add_development_dependency "guard-rspec", "~> 4.7", ">= 4.7.3"
   spec.add_development_dependency "rspec-rails", "~> 4.0", ">= 4.0.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbexy
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Nick Giancola
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-17 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,7 +76,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
@@ -86,7 +86,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
@@ -224,6 +224,7 @@ files:
 - example.rb
 - lib/rbexy.rb
 - lib/rbexy/component.rb
+- lib/rbexy/component/backtrace_cleaner.rb
 - lib/rbexy/component_providers/namespaced_rbexy_provider.rb
 - lib/rbexy/component_providers/rbexy_provider.rb
 - lib/rbexy/component_providers/view_component_provider.rb
@@ -232,9 +233,10 @@ files:
 - lib/rbexy/hash_mash.rb
 - lib/rbexy/lexer.rb
 - lib/rbexy/nodes.rb
-- lib/rbexy/output_buffer.rb
 - lib/rbexy/parser.rb
 - lib/rbexy/rails.rb
+- lib/rbexy/rails/component_template_resolver.rb
+- lib/rbexy/rails/controller_helper.rb
 - lib/rbexy/rails/engine.rb
 - lib/rbexy/runtime.rb
 - lib/rbexy/version.rb

data/lib/rbexy/output_buffer.rb

@@ -1,8 +0,0 @@
-module Rbexy
-  class OutputBuffer < String
-    def <<(content)
-      value = content.is_a?(Array) ? content.join : content
-      super([nil, false].include?(value) ? "" : value.to_s)
-    end
-  end
-end