phlex-slotable 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47c3384e49460492a4ff914af1ecd7c6a16fa2841f90d49a4b83b84c305cf892
-  data.tar.gz: aed5afef686e5f630b98842de12b18cc9f5634dd9f099b07273a7aa281f2915a
+  metadata.gz: 810c73b60d034b69e40450d09c717d2657eb85e216c1d6d0097763888a82ba91
+  data.tar.gz: '049b8f8a4f9fdeb0ae8448f8936e06a3a51aa8985431a48c578f9e54b2a42b96'
 SHA512:
-  metadata.gz: 02c8d0105b65526025feea5fe1aadd7851a96e8406ccb574c0b7bb45d732e54dc85c98f6fbb182af5f57ae8f404cbe17a879bafad42ef6ce9ecd0c168c286d75
-  data.tar.gz: 76a8bfd794fd7a7040bf1699db0dd3001f9d7de0cac0f641515494307a3cb370ab173588e2ba3610553c601f907d1da3990d5580702c1308c008e6d2ce11a327
+  metadata.gz: 37a3b2960e4add904feb0e196be56ea502cd2c842bf7f307712c9c6497d0b1636dda95b120bdbf8763ba451deb4f048890c82c1715c75b1857f65d654b437644
+  data.tar.gz: 631e23380c93a533152a70210494fc45c42521fd4e25fc60c690098fc5f3e7e5220e5db2222e13c498159f52e437550b4eddd59a49c1767d9d10cafd54c36a99

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-## [Unreleased]
+## [1.0.0] - 2025-03-01
+- Reimplement DeferredRender module
+
+## [0.5.0] - 2024-09-08
+- Prepare for Phlex 2.0 💪
+- Drop Ruby 2.7, 3.0 and 3.1 support
+- Add Phlex::Kit compatibility tests
+- Make `Phlex::Slotable::VERSION` available by default
 
 ## [0.4.0] - 2024-02-14
 - [BREAKING CHANGE] Rename `many` option to `collection`.

data/README.md

@@ -13,6 +13,7 @@ Phlex::Slotable enables slots feature to [Phlex](https://www.phlex.fun/) views.
 - [Component slot](#component-slot)
 - [Lambda slot](#lambda-slot)
 - [Polymorphic slot](#polymorphic-slot)
+- [Performance](#performance)
 - [Development](#development)
 - [Contributing](#contributing)
 
@@ -85,7 +86,7 @@ Returning:
 
 ```html
 <header>
-	<h1>Hello World!</h1>
+  <h1>Hello World!</h1>
 </header>
 ```
 
@@ -98,7 +99,7 @@ class PageComponent < Phlex::HTML
   slot :title
 
   def template
-		if header_slot?
+    if header_slot?
       header { render title_slot }
     else
       plain "No title"
@@ -113,7 +114,7 @@ A slot collection denotes a slot capable of being rendered multiple times within
 
 ```ruby
 class ListComponent < Phlex::HTML
-	include Phlex::Slotable
+  include Phlex::Slotable
 
   slot :item, collection: true
 end
@@ -123,7 +124,7 @@ To render a collection of slots, iterate over the `{slot_name}_slots` collection
 
 ```ruby
 class ListComponent < Phlex::HTML
-	include Phlex::Slotable
+  include Phlex::Slotable
 
   slot :item, collection: true
 
@@ -210,8 +211,8 @@ Returning:
 
   <ul>
     <li class="active">Item A</li>
-  	<li>Item B</li>
-	  <li>Item C</li>
+    <li>Item B</li>
+    <li>Item C</li>
   </ul>
 </div>
 ```
@@ -235,7 +236,7 @@ class ListComponent < Phlex::HTML
 
   slot :header, ->(size:, &content) do
     render HeaderComponent.new(size: size, color: "primary")
-	end
+  end
   slot :item, ->(href:, &content) { li { a(href: href, &content) } }, collection: true
 
   def template
@@ -293,7 +294,7 @@ class IconComponent < Phlex::HTML
 end
 
 class ImageComponent < Phlex::HTML
-	# omitted code
+  # omitted code
 end
 
 class CardComponent < Phlex::HTML
@@ -304,7 +305,7 @@ class CardComponent < Phlex::HTML
   def template
     if avatar_slot?
       div id: "avatar" do
-	      render avatar_slot
+        render avatar_slot
       end
     end
   end
@@ -343,6 +344,29 @@ Note that you need to use `with_{type}_{slot_name}` to set slot content. In the
 > }
 > ```
 
+## Performance
+Using Phlex::Slotable you don't suffer a performance penalty compared to using Phlex::DeferredRender, sometimes it can even be a little faster.
+
+```
+Generated using `ruby benchmark/main.rb`
+
+Phlex 1.11.0
+Phlex::Slotable 0.5.0
+
+ruby 3.3.5 (2024-09-03 revision ef084cc8f4) [arm64-darwin23]
+Warming up --------------------------------------
+            Deferred    22.176k i/100ms
+            Slotable    23.516k i/100ms
+Calculating -------------------------------------
+            Deferred    222.727k (± 0.8%) i/s    (4.49 μs/i) -      1.131M in   5.078157s
+            Slotable    237.405k (± 0.6%) i/s    (4.21 μs/i) -      1.199M in   5.051936s
+
+Comparison:
+            Slotable:   237405.0 i/s
+            Deferred:   222726.8 i/s - 1.07x  slower
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/benchmark/main.rb

@@ -1,15 +1,25 @@
+RubyVM::YJIT.enable
+
 require "benchmark"
 require "benchmark/ips"
 require_relative "../lib/phlex/slotable"
 
+require "phlex/version"
+
+puts "Phlex #{Phlex::VERSION}"
+puts "Phlex::Slotable #{Phlex::Slotable::VERSION}"
+
 class DeferredList < Phlex::HTML
-  include Phlex::DeferredRender
+  def before_template(&)
+    vanish(&)
+    super
+  end
 
   def initialize
     @items = []
   end
 
-  def template
+  def view_template
     if @header
       h1(class: "header", &@header)
     end
@@ -36,7 +46,7 @@ class SlotableList < Phlex::HTML
   slot :header
   slot :item, collection: true
 
-  def template
+  def view_template
     if header_slot
       h1(class: "header", &header_slot)
     end
@@ -50,7 +60,7 @@ class SlotableList < Phlex::HTML
 end
 
 class DeferredListExample < Phlex::HTML
-  def template
+  def view_template
     render DeferredList.new do |list|
       list.header do
         "Header"
@@ -68,7 +78,7 @@ class DeferredListExample < Phlex::HTML
 end
 
 class SlotableListExample < Phlex::HTML
-  def template
+  def view_template
     render SlotableList.new do |list|
       list.with_header do
         "Header"

data/lib/phlex/slotable/version.rb

@@ -2,6 +2,6 @@
 
 module Phlex
   module Slotable
-    VERSION = "0.4.0"
+    VERSION = "1.0.0"
   end
 end

data/lib/phlex/slotable.rb

@@ -4,13 +4,22 @@ require "phlex"
 
 module Phlex
   module Slotable
+    autoload :VERSION, "./slotable/version"
+
+    module DeferredRender
+      def before_template(&)
+        vanish(&)
+        super
+      end
+    end
+
     def self.included(base)
       base.extend(ClassMethods)
     end
 
     module ClassMethods
       def slot(slot_name, callable = nil, types: nil, collection: false)
-        include Phlex::DeferredRender
+        include DeferredRender
 
         if types
           types.each do |type, callable|
@@ -44,7 +53,7 @@ module Phlex
           RUBY
         end
 
-        class_eval(setter_method, __FILE__, __LINE__ + 1)
+        class_eval(setter_method, __FILE__, __LINE__)
         define_lambda_method(slot_name_with_type, callable) if callable.is_a?(Proc)
       end
 
@@ -56,41 +65,37 @@ module Phlex
       def define_getter_method(slot_name, collection:)
         getter_method = if collection
           <<-RUBY
-            def #{slot_name}_slots
-              @#{slot_name}_slots ||= []
-            end
+            def #{slot_name}_slots = @#{slot_name}_slots ||= []
+
             private :#{slot_name}_slots
           RUBY
         else
           <<-RUBY
-            def #{slot_name}_slot
-              @#{slot_name}_slot
-            end
+            def #{slot_name}_slot = @#{slot_name}_slot
+
             private :#{slot_name}_slot
           RUBY
         end
 
-        class_eval(getter_method, __FILE__, __LINE__ + 1)
+        class_eval(getter_method, __FILE__, __LINE__)
       end
 
       def define_predicate_method(slot_name, collection:)
         predicate_method = if collection
           <<-RUBY
-            def #{slot_name}_slots?
-              #{slot_name}_slots.any?
-            end
+            def #{slot_name}_slots? = #{slot_name}_slots.any?
+
             private :#{slot_name}_slots?
           RUBY
         else
           <<-RUBY
-            def #{slot_name}_slot?
-              !#{slot_name}_slot.nil?
-            end
+            def #{slot_name}_slot? = !#{slot_name}_slot.nil?
+
             private :#{slot_name}_slot?
           RUBY
         end
 
-        class_eval(predicate_method, __FILE__, __LINE__ + 1)
+        class_eval(predicate_method, __FILE__, __LINE__)
       end
 
       def callable_value(slot_name, callable)
@@ -98,7 +103,7 @@ module Phlex
         when nil
           %(block)
         when Proc
-          %(-> { self.class.instance_method(:"__call_#{slot_name}__").bind_call(self, *args, **kwargs, &block) })
+          %(-> { __call_#{slot_name}__(*args, **kwargs, &block) })
         else
           %(#{callable}.new(*args, **kwargs, &block))
         end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: phlex-slotable
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - stephann
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-15 00:00:00.000000000 Z
+date: 2025-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: phlex
@@ -16,15 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.9'
-description:
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 email:
 - 3025661+stephannv@users.noreply.github.com
 executables: []
@@ -45,7 +49,6 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/stephannv/phlex-slotable
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,15 +56,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Enable Slot API for Phlex views
 test_files: []