kombu 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 555b72c094087f10c29ed89696f91d92ac68516aa256fb78b08a1ed7acf8c986
+  data.tar.gz: 8c23db5a65333c5a6024b572a3f4c06e73151494006e7d0fd69d92cfa251cf87
+SHA512:
+  metadata.gz: 0f3575fd1fbe1d603eb952a2242f4eaffa60fa2b2e4491e3909e9cdca21ad5ea2d27f90d25619b95ad32195b3157fffe32c295cf0483e1cc2e0c4b5e35b46b05
+  data.tar.gz: 5bc0893ee1a32b87e43f4c22a4a4c32beba1c0fb002eeca9d86348e4bcd08b6b73640c894e5835ddcdd41bc2962118ab215bffca58f7ea4ba3184123763388a3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 madogiwa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# Kombu
+
+Kombu provides the ability to render the specified component directly from the controller.
+
+This gem may replace any javascript component except layouts in the `views` directory.
+
+This gem was inspired by the following projects.
+
+- [React-Rails](https://github.com/reactjs/react-rails)
+- [Inertia.js Rails Adapter](https://github.com/inertiajs/inertia-rails)
+
+## Usage
+
+### Setup
+
+Please configure the following settings according to your application.
+
+```ruby
+Rails.application.configure do
+  # NOTE: (OPTIONAL) id of the element (div) to mount (default: `vue-root`)
+  # config.kombu.default_mount_element_id = 'vue-root'
+
+  # NOTE: (REQUIIRED) Specify a proc that generates a tag that reads a javascript entry.
+  # See `lib/kombu/renderable.rb` for instance variables provided by kombu that can be used within proc.
+  config.kombu.javascript_entry_tag_proc = -> { helpers.javascript_pack_tag(@entry, defer: true) }
+
+  # NOTE: (REQUIIRED) Specify a proc that generates a tag that reads a css entry.
+  # See `lib/kombu/renderable.rb` for instance variables provided by kombu that can be used within proc.
+  config.kombu.stylesheet_entry_tag_proc = -> { helpers.stylesheet_pack_tag(@entry) }
+
+  # NOTE: (OPTIONAL) template of the view to render that contains the component. (default: See below)
+  # config.kombu.default_entry_view_template = <<~ERB
+  #   <div id="<%= @kombu_mount_element_id %>">
+  #     <%= kombu_component_tag %>
+  #   </div>
+  #   <% content_for :stylesheet do %>
+  #     <%= kombu_stylesheet_entry_tag %>
+  #   <% end %>
+  #   <% content_for :javascript do %>
+  #     <%= kombu_javascript_entry_tag %>
+  #   <% end %>
+  # ERB
+end
+```
+
+### Use `Kombu::Renderable`
+
+If you include `Kombu::Renderable` in any controller, you can use `kombu_render_component` which can render component directly.
+
+```ruby
+class ArticlesController < ApplicationController
+  include Kombu::Renderable
+
+  def index
+    @title = 'Articles'
+    @articles = [{ id: 1, title: 'artile1', body: 'body1' }, { id: 2, title: 'artile2', body: 'body2' }]
+    kombu_render_component('article-index-page', attributes: { 'title': @title, ':articles': @articles.to_json })
+    # NOTE: The following html is rendered.
+    # <div id="vue-root"><artile-index-page title="Articles" :articles="[{"id":1,"title":"artile1","body":"body1"},{"id":2,"title":"artile2","body":"body2"}]"></div>
+</artile-index-page>
+  end
+end
+```
+
+### (Optional) Rename method name.
+
+If you do not like the method name, you can change it to any name you like.
+
+```ruby
+module ComponentRenderable
+  extend ActiveSupport::Concern
+  include Kombu::Renderable
+
+  included do
+    alias render_component kombu_render_component
+  end
+end
+```
+
+```ruby
+class ArticlesController < ApplicationController
+  include ComponentRenderable
+
+  def index
+    @title = 'Articles'
+    @articles = [{ id: 1, title: 'artile1', body: 'body1' }, { id: 2, title: 'artile2', body: 'body2' }]
+    render_component('article-index-page', attributes: { 'title': @title, ':articles': @articles.to_json })
+  end
+end
+```
+
+### Testing (RSpec only)
+
+Kombu provides a matcher to validate values passed to `kombu_render_component`.
+You can use `kombu_component_rendered` by enabling it in `RSpec.configure`.
+
+```ruby
+require 'kombu/test/rspec/matchers/component_renderd_matcher'
+
+RSpec.configure do |config|
+  config.include Kombu::RSpec::Matchers::ComponentRenderedMatcher, type: :request
+end
+```
+
+```ruby
+describe 'GET /articles', type: :request do
+  before { get articles_path }
+
+  it 'Specific arguments must be passed to render_component.' do
+    title = 'Articles'
+    articles = [{ id: 1, title: 'artile1', body: 'body1' }, { id: 2, title: 'artile2', body: 'body2' }]
+    expect(controller).to kombu_component_rendered('article-index-page', attributes: { 'title': title, ':articles': articles.to_json })
+  end
+end
+```
+
+## How do it work
+
+See `lib/kombu/renderable.rb`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "kombu"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install kombu
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/kombu/configration.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/ordered_options"
+
+class Configration < ActiveSupport::OrderedOptions
+  def custom_payload(&block)
+    self.custom_payload_method = block
+  end
+end

data/lib/kombu/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Kombu
+  class Error < StandardError; end
+
+  class RenderError < Error; end
+end

data/lib/kombu/railtie.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require_relative "configration"
+
+module Kombu
+  class Railtie < ::Rails::Railtie
+    MOUNT_ELEMENT_ID = "vue-root"
+    ENTRY_VIEW_TEMPLATE = <<~ERB
+      <div id="<%= @kombu_mount_element_id %>">
+        <%= kombu_component_tag %>
+      </div>
+      <% content_for :stylesheet do %>
+        <%= kombu_stylesheet_entry_tag %>
+      <% end %>
+      <% content_for :javascript do %>
+        <%= kombu_javascript_entry_tag %>
+      <% end %>
+    ERB
+
+    config.kombu = Configration.new
+    config.kombu.default_mount_element_id = MOUNT_ELEMENT_ID
+    config.kombu.default_entry_view_template = ENTRY_VIEW_TEMPLATE
+  end
+end

data/lib/kombu/renderable.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "errors"
+
+module Kombu
+  module Renderable
+    include ActionView::Helpers::TagHelper
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :kombu_component_tag, :kombu_javascript_entry_tag, :kombu_stylesheet_entry_tag
+    end
+
+    def kombu_render_component(component_name, entry_name: nil, mount_element_id: nil, attributes: {})
+      @kombu_component = component_name
+      @kombu_attributes = attributes
+      @kombu_entry = entry_name.presence || kombu_default_entry
+      @kombu_mount_element_id = mount_element_id.presence || kombu_default_mount_element_id
+      render kombu_render_option
+    rescue => error
+      raise Kombu::RenderError, error.message
+    end
+
+    def kombu_component_tag
+      tag(@kombu_component, @kombu_attributes)
+    end
+
+    def kombu_javascript_entry_tag
+      raise_kombu_render_error_not_configured("javascript_entry_tag_proc") if kombu_javascript_entry_tag_proc.nil?
+      instance_exec(&kombu_javascript_entry_tag_proc)
+    end
+
+    def kombu_stylesheet_entry_tag
+      raise_kombu_render_error_not_configured("stylesheet_entry_tag_proc") if kombu_stylesheet_entry_tag_proc.nil?
+      instance_exec(&kombu_stylesheet_entry_tag_proc)
+    end
+
+    private
+
+    def kombu_default_entry
+      File.join(controller_name, action_name)
+    end
+
+    def kombu_render_option
+      {inline: kombu_template, layout: true}
+    end
+
+    def kombu_template
+      kombu_app_config.default_entry_view_template
+    end
+
+    def kombu_javascript_entry_tag_proc
+      kombu_app_config.javascript_entry_tag_proc
+    end
+
+    def kombu_stylesheet_entry_tag_proc
+      kombu_app_config.stylesheet_entry_tag_proc
+    end
+
+    def kombu_default_mount_element_id
+      kombu_app_config.default_mount_element_id
+    end
+
+    def kombu_app_config
+      @kombu_app_config ||= Rails.application.config.kombu
+    end
+
+    def raise_kombu_render_error_not_configured(config_name)
+      raise Kombu::RenderError,
+        "config.kombu.#{config_name} is not configured. Please set it during application initialization."
+    end
+  end
+end

data/lib/kombu/test/rspec/matchers/component_rendered_matcher.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Kombu
+  module RSpec
+    module Matchers
+      module ComponentRenderedMatcher
+        def kombu_component_rendered(component, entry: nil, mount_element_id: nil, attributes: {})
+          Matcher.new(component, entry: entry, mount_element_id: mount_element_id, attributes: attributes)
+        end
+
+        class Matcher
+          def initialize(component, entry: nil, mount_element_id: nil, attributes: {})
+            @expected_component = component
+            @expected_entry = entry
+            @expected_mount_element_id = mount_element_id
+            @expected_attributes = attributes
+          end
+
+          def matches?(controller)
+            set_actual_avaliables(controller)
+            component_match? && entry_match? && mount_element_id_match? && attributes_match?
+          end
+
+          def failure_message
+            return failure_component_message unless component_match?
+            return failure_attributes_message unless attributes_match?
+            return failure_entry_message unless entry_match?
+            return failure_mount_element_id_message unless mount_element_id_match?
+          end
+
+          private
+
+          def failure_component_message
+            "Expected component #{@expected_component} to match #{@actual_component}."
+          end
+
+          def failure_attributes_message
+            expected = pretty_json(@expected_attributes.to_json)
+            actual = pretty_json(@actual_attributes.to_json)
+            "Expected component attributes #{expected} to match #{actual}."
+          end
+
+          def failure_entry_message
+            "Expected entry #{@expected_entry} to match #{@actual_entry}."
+          end
+
+          def failure_mount_element_id_message
+            "Expected mount element id #{@expected_mount_element_id} to match #{@actual_mount_element_id}."
+          end
+
+          def component_match?
+            @expected_component == @actual_component
+          end
+
+          def attributes_match?
+            @expected_attributes == @actual_attributes
+          end
+
+          def entry_match?
+            return true if @expected_entry.nil?
+            @expected_entry == @actual_entry
+          end
+
+          def mount_element_id_match?
+            return true if @expected_mount_element_id.nil?
+            @expected_mount_element_id == @actual_mount_element_id
+          end
+
+          def set_actual_avaliables(actual) # rubocop:disable Naming/AccessorMethodName
+            @actual_component = actual.instance_variable_get(:@kombu_component)
+            @actual_attributes = actual.instance_variable_get(:@kombu_attributes)
+            @actual_entry = actual.instance_variable_get(:@kombu_entry)
+            @actual_mount_element_id = actual.instance_variable_get(:@kombu_mount_element_id)
+          end
+
+          def pretty_json(str)
+            JSON.pretty_generate(JSON.parse(str))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kombu/version.rb

@@ -0,0 +1,3 @@
+module Kombu
+  VERSION = "0.1.0"
+end

data/lib/kombu.rb

@@ -0,0 +1,7 @@
+require "kombu/version"
+require "kombu/railtie"
+
+module Kombu
+end
+
+require_relative "kombu/renderable"

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: kombu
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- madogiwa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description:
+email:
+- madogiwa0124@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/kombu.rb
+- lib/kombu/configration.rb
+- lib/kombu/errors.rb
+- lib/kombu/railtie.rb
+- lib/kombu/renderable.rb
+- lib/kombu/test/rspec/matchers/component_rendered_matcher.rb
+- lib/kombu/version.rb
+homepage: https://github.com/madogiwa0124/kombu
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/madogiwa0124/kombu
+  source_code_uri: https://github.com/madogiwa0124/kombu
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Kombu provides the ability to render the specified component directly from
+  the controller.
+test_files: []