amber_component 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46dc65dbef14224da8e0ce373eb07528188c399444eb2b90968c1cf3dc049864
-  data.tar.gz: d547837963b2e6148a0724d961f3ba9fa1f540365a711d40d483a24ccdcf8909
+  metadata.gz: '0142826c9117720944d7c6f3ab6a8c56e551ed684c92e1d7ce4857ccbe2632c0'
+  data.tar.gz: 749a03720a2a3a6b7131ffc0e432af7dce37e11d4375052f6b051b799f9f66be
 SHA512:
-  metadata.gz: 9f060bd9c1a97475c0678ddc5c0df166bf6f05001cde7f43a41bdc130c068b2ea24c15518d384016aeef2e8ef592b2928c305a41aaaa24dcebf038783a96b57b
-  data.tar.gz: 8f2f8029094be9ac3eccbb55b1c46a3c1ed43bb5e7d4c55263bf9bf0a2501862589f7644b8c357ceaa1d8762ea2370125f29c85bce7299925588570ba5118860
+  metadata.gz: c06aa0648eb8767949de4b69ab288a1534333f0281095d757daf9564402c24c896bb94b78206d2b9219ddbccd61db1dc67281480ee8ac52abf541d8c17e18bc9
+  data.tar.gz: 196d879455fc376f6558048e801522a865753ece6aec2ecb6f0888a867707a43a04b629d87c2a2767800280482ec9d375cf56008e74bdbafd56d4b5ab5f8f2e5

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 ## [Unreleased]
 
-## [0.1.0] - 2022-07-21
+## [1.2.0] - 2023-01-25
+
+### Breaking changes
+
+- Inline view syntax has been changed from `view :[view_type] { '[content]' }` to `view '[content]', type: :[view_type]`
+
+- Overriding the view template when rendering a component has been removed (eg. `ExampleComponent.call view: '<h1>Some overriden view</h1>'`)
+
+### Added
+
+- ERB compiled template caching in production
+
+### Changed
+
+- View rendering pipeline has been rewritten
+
+### Fixed
+
+- Nesting components has been fixed
+
+## [1.1.1] - 2022-11-14
+
+### Added
+
+- Support for webpacker
+
+## [1.1.0] - 2022-11-13
+
+### Added
+
+- StimulusJS controllers for components
+
+## [1.0.0] - 2022-11-07
 
 - Initial release

data/Gemfile

@@ -10,7 +10,7 @@ gem 'rake', '~> 13.0'
 # Development dependencies
 gem 'byebug'
 gem 'git'
-gem 'haml'
+gem 'haml-rails'
 gem 'rubocop', '~> 1.21'
 gem 'sassc'
 gem 'solargraph'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    amber_component (1.1.1)
+    amber_component (1.2.0)
       actionview (>= 6)
       activemodel (>= 6)
       activesupport (>= 6)
@@ -48,9 +48,15 @@ GEM
     ffi (1.15.5)
     git (1.11.0)
       rchardet (~> 1.8)
-    haml (5.2.2)
-      temple (>= 0.8.0)
+    haml (6.1.1)
+      temple (>= 0.8.2)
+      thor
       tilt
+    haml-rails (2.1.0)
+      actionpack (>= 5.1)
+      activesupport (>= 5.1)
+      haml (>= 4.0.6)
+      railties (>= 5.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
@@ -139,7 +145,7 @@ GEM
       thor (~> 1.0)
       tilt (~> 2.0)
       yard (~> 0.9, >= 0.9.24)
-    temple (0.8.2)
+    temple (0.10.0)
     thor (1.2.1)
     tilt (2.0.11)
     tzinfo (2.0.5)
@@ -159,7 +165,7 @@ DEPENDENCIES
   bundler-audit
   byebug
   git
-  haml
+  haml-rails
   minitest (~> 5.0)
   railties
   rake (~> 13.0)

data/README.md

@@ -337,7 +337,10 @@ custom HTML to a component.
 
 This works similarly to React's `props.children`.
 
-To render the passed nested content call `yield.html_safe` somewhere inside the template/view.
+To render the passed nested content call `children(&block)` somewhere inside the ERB template/view.
+If you're using another template language like Haml,
+you may need to use `children{yield}` instead. This difference
+is due to how these templates are compiled.
 
 ```ruby
 # app/components/modal_component.rb
@@ -358,7 +361,7 @@ end
 
     <div class="modal_body">
         <!-- nested content will be rendered here -->
-        <%= yield.html_safe %>
+        <%= children(&block) %>
     </div>
 
     <div class="modal_footer">
@@ -389,7 +392,7 @@ Note that this will raise an error when no block/nested content is provided.
 
 In order to render nested content
 only when it is present (will work without nested content)
-you can use `yield.html_safe if block_given?`
+you can use `children(&block) if block_given?` in ERB templates (or `children{yield} if block_given?` for Haml and others)
 
 In general `block_given?` will return `true` when a block/nested content is present, otherwise `false`.
 You can use it to render content conditionally based on

data/lib/amber_component/assets.rb

@@ -5,15 +5,15 @@ module ::AmberComponent
   module Assets
     # Class methods for assets.
     module ClassMethods
-      # @return [String]
+      # @return [Pathname]
       def asset_dir_path
-        component_file_path, = source_location
+        component_file_path = source_location.first
         return asset_dir_from_name unless component_file_path
 
-        component_file_path.delete_suffix('.rb')
+        ::Pathname.new component_file_path.delete_suffix('.rb')
       end
 
-      # @return [String, nil]
+      # @return [Pathname, nil]
       def asset_dir_from_name
         return unless defined?(::Rails)
 
@@ -23,17 +23,17 @@ module ::AmberComponent
       # Get an array of all folders containing component assets.
       # This method should only be used on the parent class `AmberComponent::Base` or `ApplicationComponent`.
       #
-      # @return [Array<String>]
+      # @return [Array<Pathname>]
       def all_asset_dir_paths
         subclasses.map(&:asset_dir_path)
       end
 
-      # @param file_name [String, nil]
-      # @return [String, nil]
+      # @param file_name [String, Pathname, nil]
+      # @return [Pathname, nil]
       def asset_path(file_name)
         return unless file_name
 
-        ::File.join(asset_dir_path, file_name)
+        asset_dir_path / file_name
       end
 
       # Returns the name of the file inside the asset directory
@@ -45,15 +45,12 @@ module ::AmberComponent
         return [] unless ::File.directory?(asset_dir_path)
 
         ::Dir.entries(asset_dir_path).select do |file|
-          next unless ::File.file?(::File.join(asset_dir_path, file))
+          next unless ::File.file?(asset_dir_path / file)
 
           file.match? type_regexp
         end
       end
     end
 
-    # Instance methods for assets.
-    module InstanceMethods
-    end
   end
 end

data/lib/amber_component/base.rb

@@ -42,9 +42,7 @@ module ::AmberComponent
     extend Helpers::ClassHelper
 
     include Helpers::CssHelper
-    include Views::InstanceMethods
     extend  Views::ClassMethods
-    include Assets::InstanceMethods
     extend  Assets::ClassMethods
     include Rendering::InstanceMethods
     extend  Rendering::ClassMethods
@@ -57,18 +55,40 @@ module ::AmberComponent
       memoize :asset_dir_path
 
       # Memoize these methods in production
-      if ::ENV['RAILS_ENV'] == 'production'
+      if defined?(::Rails.env) && ::Rails.env.production?
         memoize :view_path
         memoize :view_file_name
         memoize :view_type
       end
 
+      # @return [Class]
+      def compiled_method_container
+        self
+      end
+
+      # @return [String]
+      def type
+        'text/html'
+      end
+
+      # @return [Symbol]
+      def format
+        :html
+      end
+
+      # @return [String]
+      def identifier
+        source_location.first
+      end
+
       private
 
       # @param subclass [Class]
       # @return [void]
       def inherited(subclass)
         super
+        return unless subclass.name
+
         method_body = lambda do |**kwargs, &block|
           subclass.render(**kwargs, &block)
         end
@@ -130,6 +150,11 @@ module ::AmberComponent
       end
     end
 
+    # @return [Class]
+    def compiled_method_container
+      self.class
+    end
+
     private
 
     # @param kwargs [Hash{Symbol => Object}]

data/lib/amber_component/rendering.rb

@@ -3,17 +3,82 @@
 module ::AmberComponent
   # Provides universal methods for rendering components.
   module Rendering
+
+    # @return [Symbol]
+    RENDER_TEMPLATE_METHOD_NAME = :__render
+
     # Class methods for rendering.
     module ClassMethods
       # @param kwargs [Hash{Symbol => Object}]
       # @return [String]
       def render(**kwargs, &block)
-        comp = new(**kwargs)
-
-        comp.render(&block)
+        new(**kwargs).render(&block)
       end
 
       alias call render
+
+      # @return [Boolean]
+      def compiled?
+        method_defined?(RENDER_TEMPLATE_METHOD_NAME)
+      end
+
+      # @return [Boolean]
+      def compile?
+        return true if defined?(::Rails.env) && ::Rails.env.development?
+
+        !compiled?
+      end
+
+      # @param force [Boolean] force recompilation
+      # @return [void]
+      def compile(force: false)
+        return if !compile? && !force
+        return if template_handler.nil?
+
+        render_template_method_redefinition_lock.synchronize do
+          silence_redefinition_of_method(RENDER_TEMPLATE_METHOD_NAME)
+          # rubocop:disable Style/EvalWithLocation
+          class_eval <<~CODE, view_path.to_s, 0 # rubocop:disable Style/DocumentDynamicEvalDefinition
+            def #{RENDER_TEMPLATE_METHOD_NAME}(local_assigns, output_buffer, &block)
+              #{compiled_template_source}
+            end
+          CODE
+          # rubocop:enable Style/EvalWithLocation
+        end
+      end
+
+      # @return [Class, nil]
+      def template_handler
+        @template_handler ||= ::ActionView::Template.registered_template_handler(view_type)
+      end
+
+      private
+
+      # @return [Mutex]
+      def render_template_method_redefinition_lock
+        @render_template_method_redefinition_lock ||= ::Mutex.new
+      end
+
+      # @return [String]
+      def compiled_template_source
+        handler = template_handler
+        unless handler
+          raise UnknownViewTypeError,
+                "view type `#{view_type.inspect}` is not known in #{self}, " \
+                "available types: #{::ActionView::Template.template_handler_extensions.inspect}"
+        end
+
+        if handler.method(:call).parameters.length > 1
+          handler.call(self, view_template_source)
+        else
+          handler.call(
+            source: view_template_source,
+            identifier: identifier,
+            type: type
+          )
+        end
+      end
+
     end
 
     # Instance methods for rendering.
@@ -21,10 +86,7 @@ module ::AmberComponent
       # @return [String]
       def render(&block)
         run_callbacks :render do
-          element  = render_view(&block)
-          # styles   = inject_styles
-          # element += styles unless styles.nil?
-          element.html_safe
+          compile_and_render(&block)
         end
       end
 
@@ -39,13 +101,49 @@ module ::AmberComponent
         render
       end
 
-      protected
+      # @param args [Array<Object>]
+      # @return [String]
+      def nested_content(*args, &block)
+        block_self = block.binding.receiver
+        return block_self.safe_capture(*args, &block) if block_self.respond_to?(:safe_capture)
+
+        safe_capture(*args, &block)
+      end
+      alias children nested_content
+
+      def safe_capture(*args)
+        value = nil
+        buffer = with_output_buffer { value = yield(*args) }
+        buffer.presence || value.html_safe
+      end
+
+      private
+
+      # @return [String]
+      def compile_and_render(&block)
+        self.class.compile
+        if self.class.compiled?
+          return _run(
+            RENDER_TEMPLATE_METHOD_NAME,
+            self.class.template_handler,
+            [],
+            ::ActionView::OutputBuffer.new,
+            &block
+          )
+        end
+
+        render_non_rails_string(
+          self.class.view_template_source,
+          self.class.view_type,
+          block
+        )
+      end
 
       # @param content [String]
       # @param type [Symbol]
       # @param block [Proc, nil]
       # @return [String]
-      def render_string(content, type, block = nil)
+      def render_non_rails_string(content, type, block = nil)
         TemplateHandler.render_from_string(self, content, type, block)
       end
     end

data/lib/amber_component/template_handler.rb

@@ -2,7 +2,7 @@
 
 module ::AmberComponent
   # Provides code which handles rendering different
-  # template languages.
+  # template languages outside of Rails.
   module TemplateHandler
     class << self
       # @param context [AmberComponent::Base]
@@ -11,16 +11,15 @@ module ::AmberComponent
       # @param block [Proc, nil]
       # @return [String]
       def render_from_string(context, content, type, block = nil)
-        options = if type.to_sym == :erb
-                    { engine_class: ERB }
-                  else
-                    {}
-                  end
+        tilt_handler = ::Tilt[type]
+        raise UnknownViewTypeError, <<~ERR.squish unless tilt_handler
+          Unknown view type for `#{context.class}`!
+          Check return value of param type in `view type: :[type]`
+          or the view file extension.
+        ERR
 
-        ::Tilt[type].new(options) { content }.render(context, &block)
+        tilt_handler.new { content }.render(context, &block).html_safe
       end
     end
   end
 end
-
-require_relative 'template_handler/erb'

data/lib/amber_component/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ::AmberComponent
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/amber_component/views.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
+require 'pathname'
+
 module ::AmberComponent
   # Provides methods concerning view registering and rendering.
   module Views
-    # View types with built-in embedded Ruby
-    #
-    # @return [Set<Symbol>]
-    VIEW_TYPES_WITH_RUBY = ::Set[:erb, :haml, :slim].freeze
-    # @return [Set<Symbol>]
-    ALLOWED_VIEW_TYPES = ::Set[:erb, :haml, :slim, :html].freeze
     # @return [Regexp]
     VIEW_FILE_REGEXP  = /^view\./.freeze
 
@@ -18,28 +14,25 @@ module ::AmberComponent
       #
       # Usage:
       #
-      #   view do
-      #     <<~ERB
-      #       <h1>
-      #         Hello <%= @name %>
-      #       </h1>
-      #     ERB
-      #   end
+      #   view <<~ERB
+      #     <h1>
+      #       Hello <%= @name %>
+      #     </h1>
+      #   ERB
       #
       # or:
       #
-      #   view :haml do
-      #     <<~HAML
-      #       %h1
-      #         Hello
-      #         = @name
-      #     HAML
-      #   end
+      #   view <<~HAML, type: :haml
+      #     %h1
+      #       Hello
+      #       = @name
+      #   HAML
       #
+      # @param content [String, Proc]
       # @param type [Symbol]
       # @return [void]
-      def view(type = :erb, &block)
-        @method_view = TypedContent.new(type: type, content: block)
+      def view(content, type: :erb)
+        @method_view = TypedContent.new(type: type, content: content)
       end
 
       # ERB/Haml/Slim view registered through the `view` method.
@@ -48,6 +41,13 @@ module ::AmberComponent
       attr_reader :method_view
 
       # @return [String]
+      def view_template_source
+        return @method_view.to_s if @method_view
+
+        ::File.read(view_path)
+      end
+
+      # @return [String, nil]
       def view_path
         asset_path view_file_name
       end
@@ -62,136 +62,11 @@ module ::AmberComponent
 
       # @return [Symbol]
       def view_type
-        (view_file_name.split('.')[1..].grep_v(/erb/).last || 'erb')&.to_sym
-      end
-    end
-
-    # Instance methods for views.
-    module InstanceMethods
-      protected
-
-      # @return [String]
-      def render_view(&block)
-        view_from_file   = render_view_from_file(&block)
-        view_from_method = render_class_method_view(&block)
-        view_from_inline = render_view_from_inline(&block)
-
-        view_content = view_from_file unless view_from_file.empty?
-        view_content = view_from_method unless view_from_method.empty?
-        view_content = view_from_inline unless view_from_inline.empty?
-
-        if view_content.nil? || view_content.empty?
-          raise ViewFileNotFoundError, "View for `#{self.class}` could not be found!"
-        end
-
-        view_content
-      end
-
-      # Helper method to render view from string or with other provided type.
-      #
-      # Usage:
-      #
-      #   render_view_from_content('<h1>Hello World</h1>')
-      #
-      # or:
-      #
-      #   render_view_from_content content: '**Hello World**', type: 'md'
-      #
-      # @param content [TypedContent, Hash{Symbol => String, Symbol, Proc}, String]
-      # @return [String, nil]
-      def render_view_from_content(content, &block)
-        return '' unless content
-        return content if content.is_a?(::String)
-
-        content = TypedContent.wrap(content)
-        type = content.type
-        content = content.to_s
-
-        if content.empty?
-          raise EmptyViewError, <<~ERR.squish
-            Custom view for `#{self.class}` from view method cannot be empty!
-          ERR
-        end
-
-        unless ALLOWED_VIEW_TYPES.include? type
-          raise UnknownViewTypeError, <<~ERR.squish
-            Unknown view type for `#{self.class}` from view method!
-            Check return value of param type in `view :[type] do`
-          ERR
-        end
-
-        unless VIEW_TYPES_WITH_RUBY.include? type
-          # first render the content with ERB if the
-          # type does not support embedding Ruby by default
-          content = render_string(content, :erb, block)
-        end
-
-        render_string(content, type, block)
-      end
-
-      # @return [String]
-      def render_view_from_file(&block)
-        view_path = self.class.view_path
-        return '' if view_path.nil? || !::File.file?(view_path)
-
-        content = ::File.read(view_path)
-        type = self.class.view_type
-
-        unless VIEW_TYPES_WITH_RUBY.include? type
-          content = render_string(content, :erb, block)
-        end
-
-        render_string(content, type, block)
-      end
-
-      # Method returning view from method in class file.
-      # Usage:
-      #
-      #   view do
-      #     <<~HTML
-      #       <h1>
-      #         Hello <%= @name %>
-      #       </h1>
-      #     HTML
-      #   end
-      #
-      # or:
-      #
-      #   view :haml do
-      #     <<~HAML
-      #       %h1
-      #         Hello
-      #         = @name
-      #     HAML
-      #   end
-      #
-      # @return [String]
-      def render_class_method_view(&block)
-        render_view_from_content(self.class.method_view, &block)
-      end
-
-      # Method returning view from params in view.
-      # Usage:
-      #
-      #   <%= ExampleComponent data: data, view: "<h1>Hello #{@name}</h1>" %>
-      #
-      # or:
-      #
-      #   <%= ExampleComponent data: data, view: { content: "<h1>Hello #{@name}</h1>", type: 'erb' } %>
-      #
-      # @return [String]
-      def render_view_from_inline(&block)
-        data = \
-          if @view.is_a? ::String
-            TypedContent.new(
-              type: :erb,
-              content: @view
-            )
-          else
-            @view
-          end
+        return @method_view.type if @method_view
+        raise ViewFileNotFoundError, "No view file for #{self}" unless view_file_name
 
-        render_view_from_content(data, &block)
+        view_file_path = ::Pathname.new view_file_name
+        view_file_path.extname.delete_prefix('.').to_sym
       end
     end
   end

data/lib/amber_component.rb

@@ -12,7 +12,6 @@ module ::AmberComponent
   class Error < ::StandardError; end
   class MissingPropsError < Error; end
   class IncorrectPropTypeError < Error; end
-  class ViewFileNotFoundError < Error; end
   class InvalidTypeError < Error; end
 
   class EmptyViewError < Error; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amber_component
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Ruby-Amber
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -123,7 +123,6 @@ files:
 - lib/amber_component/railtie.rb
 - lib/amber_component/rendering.rb
 - lib/amber_component/template_handler.rb
-- lib/amber_component/template_handler/erb.rb
 - lib/amber_component/test_helper.rb
 - lib/amber_component/typed_content.rb
 - lib/amber_component/version.rb

data/lib/amber_component/template_handler/erb.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'action_view'
-require 'ostruct'
-
-module ::AmberComponent
-  module TemplateHandler
-    # Handles rendering ERB with Rails-like syntax
-    class ERB < ::ActionView::Template::Handlers::ERB::Erubi
-      def initialize(input, properties = {})
-        properties[:bufvar] ||= "@output_buffer"
-        properties[:preamble] = "#{properties[:bufvar]}=#{::ActionView::OutputBuffer}.new;"
-        super
-      end
-    end
-  end
-end