view_component_helper 0.4.5 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57701718d039ac056f76dc09a6ad26114b495067fcbf6af07b9b0ffd30f3fbaf
-  data.tar.gz: 9686baee018175896e73771ba436427183d8bba00e976441608e912e88515b4d
+  metadata.gz: 5966bd782f29a9d3e10a9bd583c6d79d7239f2f767de4cd3e4e5a13b302e0e81
+  data.tar.gz: 7c6fc694458ae9dd2d583b6d7df13c482399b81f3c4c618c979bc6d7288baf84
 SHA512:
-  metadata.gz: 9d765d480b9be81327db65955ffc028f2bd021bf66484344626e1d823690b92023dcbfcbb2834f463bf743ab9077dcf25d02700706872f0b62ecdd58cdb31a42
-  data.tar.gz: 50a5cf227fbff3fb388e83e8c960df0ec52b7d616d7855a1433d6eb4fbd4246de5fbf6f65cbe19b194a32cb42dfb7dbe73ccea68d9d2072b55c1f69684a9b32a
+  metadata.gz: 70c4004614931d4caa0f88de8f07fd9dd312c9e456450b4c8094225aeb760c3d876be8339cc6daa22c92e8dde428f038e37876a24ccab61fc0be2f2c51033eff
+  data.tar.gz: d75ee370dfc30a75114c4012f55c6ff0b6d89f370678957ca04b0d1a07e570db6d6a88e223d21a482df022f525883c876b8a8f3f3e9709f36c8f0f02f87cedf3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    view_component_helper (0.4.5)
+    view_component_helper (0.9.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,8 @@
 # ViewComponentHelper
+[![Gem Version](https://badge.fury.io/rb/view_component_helper.svg)](https://badge.fury.io/rb/view_component_helper)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/view_component_helper`. To experiment with that code, run `bin/console` for an interactive prompt.
+`ViewComponentHelper` is a simple gem designed to enhance the functionality provided by [ViewComponent](https://github.com/ViewComponent/view_component). It offers shortcuts to access generated ViewComponents, making your Rails development experience smoother and more efficient.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -30,15 +30,40 @@ or
 <%= vc("messageComponent", name: "World") %>
 ```
 
-Make sure to incorporate ViewComponent as described in the reference link to enhance your application's functionality.
+## Usage
+For more information on ViewComponents, please refer to the [official documentation](https://viewcomponent.org/).
+
+`ViewComponentHelper` allows for easier referencing of `ViewComponent` classes located under the `app/components` directory by providing you with intuitive shortcut methods.
+
+### How it works
+For every `ViewComponent` you define within the `app/components` directory, `ViewComponentHelper` automatically provides a shortcut method to render it.
+
+### Examples
 
+1. For a component located at `app/components/title_component.rb`:
 
+You can utilize the following shortcut:
+```ruby
+title_component(title: "test title")
+```
+
+2. For a component located at `app/components/button.rb`:
 
-## Development
+```erb
+<%= button %>
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+3. For a component located at `app/components/dialog/component.rb`
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```erb
+<%= dialog_component do |c| %>
+  <% c.with_title { "dialog title" } %>
+  <% c.with_body do %>
+    <p>this is dialog body</p>
+  <% end %>
+  <div>content</div>
+<% end %>
+```
 
 ## Contributing
 

data/lib/view_component_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ViewComponentHelper
-  VERSION = "0.4.5"
+  VERSION = "0.9.1"
 end

data/lib/view_component_helper/view_helper.rb

@@ -7,26 +7,26 @@
 # and displaying components based on their file paths and additional arguments.
 #
 module ViewComponentHelper
+  require "active_support/core_ext/string/inflections"
+
   def render_view_component(path, *args, collection: nil, **kwargs, &block)
     component_klass = path.classify.constantize
 
     if collection
       render component_klass.with_collection(collection, *args, **kwargs, &block)
     else
-      render component_klass.new(*args, **kwargs, &block)
+      component_instance = component_klass.new(*args, **kwargs)
+      component_instance.instance_exec(&block) if block_given?
+      render(component_instance)
     end
   end
 
   alias render_vc render_view_component
   alias vc render_view_component
 
-  def self.default_component_loader
-    -> { Dir[Rails.root.join("app/components/**/*.rb")] }
-  end
-
-  def self.load_components(component_loader = default_component_loader)
+  def self.load_components(component_loader = -> { Dir[Rails.root.join("app/components/**/*.rb")] })
     component_loader.call.each do |file|
-      component_path = extract_component_path(file)
+      component_path = file[%r{components/(.*)\.rb$}, 1]
       component_class_name = component_path.camelize
       method_name = component_path.gsub("/", "_")
 
@@ -34,10 +34,6 @@ module ViewComponentHelper
     end
   end
 
-  def self.extract_component_path(file)
-    file.gsub("#{Rails.root.join("app/components")}/", "").gsub(".rb", "")
-  end
-
   def self.valid_component_class?(component_class_name)
     Object.const_defined?(component_class_name) && component_class_name.constantize < ViewComponent::Base
   end
@@ -49,7 +45,8 @@ module ViewComponentHelper
       if collection
         render component_klass.with_collection(collection, *args, **kwargs, &block)
       else
-        render component_klass.new(*args, **kwargs, &block)
+        component_instance = component_klass.new(*args, **kwargs, &block)
+        render component_instance
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_helper
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.9.1
 platform: ruby
 authors:
 - yamitake
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2023-11-13 00:00:00.000000000 Z
 dependencies: []
 description: 'Simplify integration and boost productivity. '
 email: