view_component-contrib 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ade40aaa2e5db43b72e6ee1de31978639bd057aef496e2aa5885296b67d58ac4
-  data.tar.gz: ab518d6378b41e51fe978a50b00e22bd7e6e03231a8e93c1d1f3d1ad707f0ea4
+  metadata.gz: cebcea7442b79ea935dd0039c361e813b597c8f63a15a9cd90407635a6a96856
+  data.tar.gz: 98e1aeecc1354a1e619bf75c765aa64f0051ac5ff4d7d0c81fb42425e7da7ae5
 SHA512:
-  metadata.gz: 15b64d686c8dd5d871c1c5b3c07adbbfa9fd4f538130df0ab4bda67cdf88f4109db386f6f311e3392a005860ea0e06115f18e1112fa536bab034ee3264acf79e
-  data.tar.gz: 32a4e8f9106866b0f49808a5b5250023d08a001ac3b1c66c66cb7971820046679570040b70e98ebdc56ad7113ce87945b59112156a3c5a941f1b022d1bc6c0bb
+  metadata.gz: 427691d12a38bfcab3c0861506aade1ada63422badb1b207e5fff49cd72bc66c8a6aadfd220b51385ef5abc2166061cd8333afbf14e915058e98bf2899438ad5
+  data.tar.gz: 5eb44287d55acb724d458d6eca667296787215cafced750c9071834ee2203b89327d93ff983b1b2e9879b961e13eb8b5d4f2af237c690a4c3f6bc6cbdaa6654c

data/CHANGELOG.md

@@ -2,6 +2,53 @@
 
 ## master
 
+## 0.1.6 (2023-11-07)
+
+- Support preview classes named `<component|partial>_preview.rb`. ([@palkan][])
+
+It's also possible to explicitly specify the component class name for the preview class:
+
+```ruby
+class MyComponentPreview
+  self.component_class_name = "SomeComponent"
+
+  def default
+    render_component
+  end
+end
+```
+
+## 0.1.5 (2023-11-02)
+
+- Support content blocks in `#render_component` and `#render_with`. ([@palkan][])
+
+```ruby
+class MyComponent::Preview
+  def default
+    # Now you can pass a block to render_component to render it inside the component:
+    render_component(kind: "info") do
+      "Welcome!"
+    end
+  end
+end
+```
+
+- Support implicit components in `#render_component` helper. ([@palkan][])
+
+```ruby
+class MyComponent::Preview
+  def default
+    # Before
+    render_component(MyComponent::Component.new(foo: "bar"))
+  end
+
+  # After
+  def default
+    render_component(foo: "bar")
+  end
+end
+```
+
 ## 0.1.4 (2023-04-30)
 
 - Fix compatibility with new errors classes in view_component.

data/README.md

@@ -47,6 +47,9 @@ bundle exec rails g view_component -h
 **Why adding a custom generator to the project instead of bundling it into the gem?** The generator could only be useful if it fits
 your project needs. The more control you have over the generator the better. Thus, the best way is to make the generator a part of a project.
 
+> [!IMPORTANT]
+> If your application has the `lib/` folder in the autoload paths, make sure you ignored the generated `lib/generators` folder. In Rails 7.1+, you can do this via adding `generators` the `config.autoload_lib` call's `ignore` option. Before, you can use `Rails.autoloaders.main.ignore(...)`.
+
 ## Organizing components, or sidecar pattern extended
 
 ViewComponent provides different ways to organize your components: putting everyhing (Ruby files, templates, etc.) into `app/components` folder or using a _sidecar_ directory for everything but the `.rb` file itself. The first approach could easily result in a directory bloat; the second is better though there is a room for improvement: we can move `.rb` files into sidecar folders as well. Then, we can get rid of the _noisy_ `_component` suffixes. Finally, we can also put previews there (since storing them within the test folder is a little bit confusing):
@@ -156,6 +159,14 @@ class Banner::Preview < ApplicationViewComponentPreview
   def default
     # This will use `absolute w-full` for the container class
     render_component Banner::Component.new(text: "Welcome!")
+
+    # or even shorter
+    render_component(text: "Welcome!")
+
+    # you can also pass a content block
+    render_component(kind: :notice) do
+      "Some content"
+    end
   end
 
   def mobile
@@ -434,6 +445,20 @@ class FlashAlert::Component < ApplicationViewComponent
 end
 ```
 
+## Supporting `.with_collection`
+
+The `.with_collection` method from ViewComponent expects a component class to have the "Component" suffix to correctly infer the parameter name. Since we're using a different naming convention, we need to specify the collection parameter name explicitly. For example:
+
+```ruby
+class PostCard::Component < ApplicationViewComponent
+  with_collection_parameter :post
+
+  option :post
+end
+```
+
+You can add this to following line to your component generator (unless it's already added): `with_collection_parameter :<%= singular_name %>` to always explicitly provide the collection parameter name.
+
 ## Wrapped components
 
 Sometimes we need to wrap a component into a custom HTML container (for positioning or whatever). By default, such wrapping doesn't play well with the `#render?` method because if we don't need a component, we don't need a wrapper.

data/app/views/view_component_contrib/preview.html.erb

@@ -1,6 +1,10 @@
 <div class="<%= container_class %>">
   <%- if component -%>
-    <%= render component %>
+    <%- if local_assigns[:content_block] -%>
+      <%= render component, &content_block %>
+    <% else %>
+      <%= render component %>
+    <% end %>
   <%- else -%>
   Failed to infer a component from the preview: <%= error %>
   <%- end -%>

data/lib/view_component_contrib/preview/base.rb

@@ -43,11 +43,29 @@ module ViewComponentContrib
           end
         end
 
+        # Infer component class name from preview class name:
+        # - Namespace::ButtonPreview => Namespace::Button::Component | Namespace::ButtonComponent | Namespace::Button
+        # - Button::Preview => Button::Component | ButtonComponent | Button
+        def component_class_name
+          @component_class_name ||= begin
+            component_name = name.sub(/(::Preview|Preview)$/, "")
+            [
+              "#{component_name}::Component",
+              "#{component_name}Component",
+              component_name
+            ].find do
+              _1.safe_constantize
+            end
+          end
+        end
+
+        attr_writer :component_class_name
+
         private
 
         def build_component_instance(locals)
           return locals unless locals[:component].nil?
-          locals[:component] = name.sub(/Preview$/, "Component").safe_constantize&.new
+          locals[:component] = component_class_name.safe_constantize&.new
         rescue => e
           locals[:component] = nil
           locals[:error] = e.message
@@ -60,8 +78,14 @@ module ViewComponentContrib
       end
 
       # Shortcut for render_with_template(locals: {component: ...})
-      def render_component(component)
-        render_with(component: component)
+      def render_component(component_or_props = nil, &block)
+        component = if component_or_props.is_a?(::ViewComponent::Base)
+          component_or_props
+        else
+          self.class.component_class_name.constantize.new(**(component_or_props || {}))
+        end
+
+        render_with(component: component, content_block: block)
       end
     end
   end

data/lib/view_component_contrib/preview/sidecarable.rb

@@ -3,7 +3,7 @@
 module ViewComponentContrib
   module Preview
     module Sidecarable
-      PREVIEW_GLOB = "**/preview.rb"
+      PREVIEW_GLOB = "**/{preview.rb,*_preview.rb}"
 
       def self.extended(base)
         base.singleton_class.prepend(ClassMethods)
@@ -17,7 +17,7 @@ module ViewComponentContrib
         end
 
         def preview_name
-          name.chomp("::Preview").underscore
+          name.sub(/(::Preview|Preview)$/, "").underscore
         end
       end
     end

data/lib/view_component_contrib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ViewComponentContrib # :nodoc:all
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component-contrib
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-30 00:00:00.000000000 Z
+date: 2023-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: view_component
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ruby-next
+  name: ruby-next-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A collection of extensions and developer tools for ViewComponent