turbo_component 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2d1eaf2e204ef8c7ac0f67baf7c127e5a9c2868157a0aea50ca7090c5a834a2
+  data.tar.gz: 6d975082d202636f196f56914f5b13902b615191ba744a512d27dd68fd6a8065
+SHA512:
+  metadata.gz: 5bbf7ff1153b320f90c774b94b1057b4cacb3294e5911dd7b2c4d00949c01aba54a78e923412b532b180538f960fcdde6f6dfb25dc91ac6e14cc5e71bb054728
+  data.tar.gz: 89f5f9abfd287e9f962f36062b6cd252ce1dcf4183c79fdc3e8971eb9557e2e7c3f8e85afdc24b39fb8ec2ecbc95695c2a8939a2cbeca9b24aa89c4ee4b65f34

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Jose Galisteo
+
+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,9 @@
+# TurboComponent
+
+This project explores the idea of components not only in terms of view, like view_component or cells, but it also includes server actions required for the component.
+
+I part from the codebase of "pagelet_rails" and take advantage of turbo_rails to explore this idea.
+
+## Usage
+
+Do not use it, it is a work in progress.

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+  t.warning = false
+end
+
+task default: :test

data/app/helpers/turbo_components_helper.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module TurboComponentsHelper
+  include Turbo::FramesHelper
+
+  def turbo_component(turbo_key, opts = {}, &block)
+    async = opts.delete(:async)
+
+    if async
+      turbo_component_async(turbo_key, opts, &block)
+    else
+      # TODO: raise exception, block not allowed
+      turbo_component_inline_frame(turbo_key, opts)
+    end
+  end
+
+  def turbo_component_async(turbo_key, opts = {}, &block)
+    turbo_id = opts.delete(:turbo_id) || turbo_key
+    locals = opts.delete(:locals) || {}
+    permanent = opts.delete(:permanent)
+
+    # TODO: cache
+    serialized = ActiveJob::Arguments.serialize(locals)
+    encoded = TurboComponent::Encryptor.encode(serialized, purpose: turbo_id)
+    attrs = { _encoded: encoded, _turbo_id: turbo_id }
+
+    turbo_url = "turbo_component_#{turbo_key}"
+    base_params = params.to_unsafe_h.except(:action, :controller)
+    url = polymorphic_url(turbo_url, base_params.merge(attrs))
+
+    opts[:src] = url
+    opts["data-turbo-permanent"] = true if permanent
+    turbo_frame_tag(turbo_id, **opts, &block)
+  end
+
+  def turbo_component_inline_frame(turbo_key, opts)
+    target = opts[:target]
+    locals = opts[:locals] || {}
+    turbo_id = opts[:turbo_id] || turbo_key
+    turbo_frame_tag turbo_id, target: target do
+      base_params = params.to_unsafe_h.except(:action, :controller)
+      base_params[:_turbo_id] = turbo_id
+      base_params = base_params.merge(locals)
+      turbo_component_inline(turbo_key, locals: base_params)
+    end
+  end
+
+  def turbo_component_inline(turbo_key, p_options = {})
+    Rails.logger.info "Rendering turbo component #{turbo_key}"
+
+    turbo_url = "turbo_component_#{turbo_key}"
+    p_params = p_options.delete(:locals) { {} }.with_indifferent_access
+    path = polymorphic_url(turbo_url, p_params)
+
+    path_opts = Rails.application.routes.recognize_path(path)
+    p_params.reverse_merge!(path_opts)
+
+    controller_class = "#{path_opts[:controller].camelize}Controller".constantize
+    action = path_opts[:action]
+
+    c = controller_class.new
+    c.turbo_component_options p_options
+    c.turbo_component_options original_options: p_options
+
+    env = controller.request.env.select do |key, _value|
+      case key.to_s
+      when /^action_dispatch\.request/i,
+        /^action_controller/i,
+        /^rack\.request/i,
+        /^request/i,
+        "HTTP_ACCEPT",
+        "CONTENT_TYPE",
+        "CONTENT_LENGTH",
+        "REQUEST_METHOD"
+        false
+      else
+        true
+      end
+    end
+
+    # env['HTTP_X_REQUESTED_WITH'] = "XMLHttpRequest"
+    env = Rack::MockRequest.env_for(path, env)
+    p_request = ActionDispatch::Request.new(env)
+    p_request.parameters.clear
+    p_request.parameters.merge! p_params
+
+    if c.method(:dispatch).arity == 3
+      p_response = controller_class.make_response! p_request
+      c.dispatch(action, p_request, p_response)
+    else
+      c.dispatch(action, p_request)
+    end
+
+    body = c.response.body
+    body.html_safe
+  end
+end

data/app/views/layouts/turbo_components/container.html.erb

@@ -0,0 +1,7 @@
+<% if turbo_component_request? %>
+  <%= turbo_frame_tag turbo_key do %>
+      <%= content_for?(:content) ? yield(:content) : yield %>
+  <% end %>
+<% else %>
+    <%= content_for?(:content) ? yield(:content) : yield %>
+<% end %>

data/lib/generators/turbo_component/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates a turbo component scaffold
+
+Example:
+    bin/rails generate turbo_component ComponentName
+
+    This will create:
+        app/turbo_components/component_name/component_controller.rb
+        app/turbo_components/component_name/views/show.html.erb

data/lib/generators/turbo_component/templates/component_controller.rb.tt

@@ -0,0 +1,7 @@
+class <%= class_name %>::ComponentController < ApplicationController
+  include TurboComponent::Concerns::Controller
+
+  display :show
+  def show
+  end
+end

data/lib/generators/turbo_component/templates/show.html.erb

@@ -0,0 +1 @@
+<h1> Turbo component show </h1>

data/lib/generators/turbo_component/templates/show.html.erb.tt

@@ -0,0 +1,2 @@
+<h1><%= @component_class_name %>#show</h1>
+<p>Find me in <%= @path %></p>

data/lib/generators/turbo_component/turbo_component_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class TurboComponentGenerator < Rails::Generators::NamedBase
+  desc "Create a scaffold structure for a new turbo_component"
+  source_root File.expand_path("templates", __dir__)
+
+  def create_component_controller
+    template "component_controller.rb.tt", File.join(base_path, "component_controller.rb")
+  end
+
+  def create_component_show_view
+    @path = File.join(base_path, "views/show.html.erb")
+    @component_class_name = "#{name.classify}::Component"
+    template "show.html.erb.tt", @path
+  end
+
+  private
+  def base_path
+    File.join("app/turbo_components", name.underscore)
+  end
+end

data/lib/tasks/turbo_component_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :turbo_component do
+#   # Task goes here
+# end

data/lib/turbo_component.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "turbo-rails"
+require "turbo_component/version"
+require "turbo_component/engine"
+
+module TurboComponent
+  extend ActiveSupport::Autoload
+  eager_autoload do
+    autoload :Router
+    autoload :Encryptor
+  end
+
+  module Concerns
+    extend ActiveSupport::Autoload
+
+    eager_autoload do
+      autoload :Controller
+      autoload :Options
+      autoload :Routes
+      autoload :Tags
+    end
+  end
+end

data/lib/turbo_component/concerns/controller.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module TurboComponent::Concerns::Controller
+  extend ActiveSupport::Concern
+
+  included do
+    # order is important
+    include TurboComponent::Concerns::Routes
+    include TurboComponent::Concerns::Options
+
+    include TurboComponentsHelper
+
+    prepend_before_action :append_turbo_components_view_paths
+    prepend_before_action :parse_locals
+
+    append_view_path "app/turbo_components/"
+    append_view_path "test/dummy/app/turbo_components/" if Rails.env.test?
+
+    layout :layout_name
+
+    helper_method :turbo_component_request?
+    helper_method :turbo_key
+
+    turbo_component_options layout: "container"
+  end
+
+  def layout_name
+    layout = params[:layout] || turbo_component_options.layout
+
+    "turbo_components/#{layout}"
+  end
+
+  def turbo_component_request?
+    request.headers["Turbo-Frame"].present? && !turbo_stream_request?
+  end
+
+  def turbo_stream_request?
+    request.headers.fetch("HTTP_ACCEPT", "")&.include?("text/vnd.turbo-stream")
+  end
+
+  def turbo_key
+    params[:_turbo_id] || component_name
+  end
+
+  def component_name
+    controller_path.split("/component", 2)[0]
+  end
+
+  private
+  def parse_locals
+    return unless params[:_encoded].present?
+
+    decoded = TurboComponent::Encryptor.decode(params[:_encoded], purpose: params[:_turbo_id])
+    deserialized = ActiveJob::Arguments.deserialize(decoded)
+    deserialized.each do |key, value|
+      params[key] = value
+    end
+  end
+
+  def append_turbo_components_view_paths
+    # lookup_context.prefixes.clear
+    view = "#{component_name}/views"
+    lookup_context.prefixes.unshift view if lookup_context.prefixes.exclude?(view)
+
+    # https://github.com/rails/actionpack-action_caching/issues/32
+    lookup_context.formats.unshift :html if lookup_context.formats.exclude?(:html)
+  end
+end

data/lib/turbo_component/concerns/options.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module TurboComponent::Concerns::Options
+  extend ActiveSupport::Concern
+
+  included do
+    include Shared
+
+    helper_method :turbo_component_options
+  end
+
+  def turbo_component_options(*args)
+    set_turbo_component_options(*args)
+
+    opts = self.class.turbo_component_options
+    class_default_opts = opts.fetch("default", {})
+    class_action_opts = opts.fetch(action_name, {})
+
+    instance_default_opts = @turbo_component_options.fetch("default", {})
+    instance_action_opts = @turbo_component_options.fetch(action_name, {})
+
+    result = {}.with_indifferent_access
+               .deep_merge!(class_default_opts)
+               .deep_merge!(class_action_opts)
+               .deep_merge!(instance_default_opts)
+               .deep_merge!(instance_action_opts)
+
+    OpenStruct.new result
+  end
+
+  module Shared
+    def set_turbo_component_options(*args)
+      opts = args.extract_options!
+      actions = args
+      actions << "default" if actions.blank?
+
+      @turbo_component_options ||= {}.with_indifferent_access
+
+      if opts.any?
+        actions.each do |action|
+          @turbo_component_options.deep_merge! action => opts
+        end
+      end
+      @turbo_component_options
+    end
+  end
+
+  module ClassMethods
+    include Shared
+
+    def turbo_component_options(*args)
+      set_turbo_component_options(*args)
+
+      if superclass && superclass.instance_variable_defined?(:@turbo_component_options)
+        parent = superclass.instance_variable_get :@turbo_component_options
+        parent.merge(@turbo_component_options)
+      else
+        @turbo_component_options
+      end
+    end
+  end
+end

data/lib/turbo_component/concerns/routes.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module TurboComponent::Concerns::Routes
+  extend ActiveSupport::Concern
+
+  included do
+    @turbo_component_routes = []
+  end
+
+  module ClassMethods
+    def display(action)
+      controller_name = self.controller_name
+      component_name = self.name.split("::ComponentController", 2)[0].underscore
+      turbo_component_routes do
+        get component_name, to: "#{controller_name}##{action}", as: component_name
+      end
+    end
+
+    def get(action, path = "")
+      turbo_route(:get, action, path)
+    end
+
+    def post(action, path = "")
+      turbo_route(:post, action, path)
+    end
+
+    def put(action, path = "")
+      turbo_route(:put, action, path)
+    end
+
+    def patch(action, path = "")
+      turbo_route(:patch, action, path)
+    end
+
+    def delete(action, path = "")
+      turbo_route(:delete, action, path)
+    end
+
+    def turbo_route(verb, action, path)
+      controller_name = self.controller_name
+      component_name = self.name.split("::ComponentController", 2)[0].underscore
+      turbo_component_routes do
+        send(verb, "#{component_name}/#{path}", to: "#{controller_name}##{action}", as: "#{component_name}_#{action}")
+      end
+    end
+
+    def turbo_component_routes(&block)
+      @turbo_component_routes << block
+    end
+
+    def load_turbo_component_routes!(context)
+      @turbo_component_routes.each do |proc|
+        context.instance_eval(&proc)
+      end
+    end
+
+    def inherited(subklass)
+      subklass.instance_variable_set(:@turbo_component_routes, [])
+      super
+    end
+  end
+end

data/lib/turbo_component/encryptor.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class TurboComponent::Encryptor
+  DEFAULT_SALT = '!@#Q156^tdSXggT0&*789++8&?_|T%\/++==RqE'
+
+  attr_reader :salt
+
+  def self.encode(data, opts = {})
+    purpose = opts.delete(:purpose)
+    new(opts).encode(data, purpose: purpose)
+  end
+
+  def self.decode(encrypted_data, opts = {})
+    purpose = opts.delete(:purpose)
+    new(opts).decode(encrypted_data, purpose: purpose)
+  end
+
+  def self.get_key(secret, salt)
+    @get_key_cache ||= {}
+    key = [secret, salt]
+
+    @get_key_cache[key] ||= ActiveSupport::KeyGenerator.new(secret).generate_key(salt)
+  end
+
+  def initialize(opts = {})
+    @salt = opts.fetch :salt, DEFAULT_SALT
+    @secret = opts[:secret]
+  end
+
+  def secret
+    @secret || Rails.application.secrets[:secret_key_base]
+  end
+
+  def encode(data, purpose: nil)
+    encryptor.encrypt_and_sign(data, purpose: purpose)
+  end
+
+  def decode(encrypted_data, purpose: nil)
+    encryptor.decrypt_and_verify(encrypted_data, purpose: purpose)
+  end
+
+  private
+  def encryptor
+    @encryptor ||= begin
+      key = self.class.get_key secret, salt
+      key = key[0..31]
+      ActiveSupport::MessageEncryptor.new(key)
+    end
+  end
+end

data/lib/turbo_component/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TurboComponent
+  class Engine < ::Rails::Engine
+    # It loads the rails stuff like TurboComponentsHelper
+  end
+end

data/lib/turbo_component/router.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module TurboComponent
+  class Router
+    def self.load_routes!(context)
+      controllers = Dir[Rails.root.join("app", "turbo_components", "**", "*controller.rb")]
+
+      controllers.each do |controller_file|
+        module_name = module_name(controller_file)
+        controller = "#{module_name.camelize}::ComponentController".constantize
+
+        next unless controller.respond_to? :load_turbo_component_routes!
+
+        context.instance_eval do
+          scope module: module_name, path: "/_turbo_components", as: "turbo_component" do
+            controller.load_turbo_component_routes! self
+          end
+        end
+      end
+    end
+
+    def self.module_name(file)
+      File.dirname(file)
+          .split(Rails.root.join("app/turbo_components/").to_s, 2)[-1]
+    end
+  end
+end

data/lib/turbo_component/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TurboComponent
+  VERSION = "0.1.0.pre"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: turbo_component
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- Jose Galisteo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ceritium@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/helpers/turbo_components_helper.rb
+- app/views/layouts/turbo_components/container.html.erb
+- lib/generators/turbo_component/USAGE
+- lib/generators/turbo_component/templates/component_controller.rb.tt
+- lib/generators/turbo_component/templates/show.html.erb
+- lib/generators/turbo_component/templates/show.html.erb.tt
+- lib/generators/turbo_component/turbo_component_generator.rb
+- lib/tasks/turbo_component_tasks.rake
+- lib/turbo_component.rb
+- lib/turbo_component/concerns/controller.rb
+- lib/turbo_component/concerns/options.rb
+- lib/turbo_component/concerns/routes.rb
+- lib/turbo_component/encryptor.rb
+- lib/turbo_component/engine.rb
+- lib/turbo_component/router.rb
+- lib/turbo_component/version.rb
+homepage: https://github.com/ceritium/turbo_component
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ceritium/turbo_component
+  source_code_uri: https://github.com/ceritium/turbo_component
+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: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Components with super powers
+test_files: []