katalyst-kpop 2.0.9 → 3.0.0.beta.1

data/config/importmap.rb

@@ -1,6 +1,3 @@
 # frozen_string_literal: true
 
-pin_all_from Katalyst::Kpop::Engine.root.join("app/assets/javascripts/controllers"),
-             under: "controllers",
-             # preload in tests so that we don't start clicking before controllers load
-             preload: Rails.env.test?
+pin "@katalyst/kpop", to: "katalyst/kpop.js", preload: true

data/lib/katalyst/kpop/engine.rb

@@ -1,34 +1,35 @@
 # frozen_string_literal: true
 
 require "rails"
+require "turbo-rails"
 
 module Katalyst
   module Kpop
     class Engine < ::Rails::Engine
       config.autoload_once_paths = %W(#{root}/app/helpers)
 
-      initializer "kpop.helpers", before: :load_config_initializers do
-        ActiveSupport.on_load(:action_controller_base) do
-          helper Katalyst::Kpop::Engine.helpers
-        end
+      PRECOMPILE_ASSETS = %w(kpop.js kpop.min.js kpop.min.js.map).freeze
 
-        ActiveSupport.on_load(:action_view_base) do
-          helper Katalyst::Kpop::Engine.helpers
+      initializer "kpop.assets" do
+        if Rails.application.config.respond_to?(:assets)
+          Rails.application.config.assets.precompile += PRECOMPILE_ASSETS
         end
       end
 
-      initializer "kpop.assets" do
-        config.after_initialize do |app|
-          if app.config.respond_to?(:assets)
-            app.config.assets.precompile += %w(kpop.js)
-          end
+      initializer "kpop.helpers", before: :load_config_initializers do
+        ::Turbo::Streams::TagBuilder.define_method(:kpop) do
+          Katalyst::Kpop::Turbo::TagBuilder.new(self)
+        end
+
+        ActiveSupport.on_load(:action_controller_base) do
+          helper Katalyst::Kpop::Engine.helpers
         end
       end
 
       initializer "kpop.importmap", before: "importmap" do |app|
         if app.config.respond_to?(:importmap)
           app.config.importmap.paths << root.join("config/importmap.rb")
-          app.config.importmap.cache_sweepers << root.join("app/assets/javascripts")
+          app.config.importmap.cache_sweepers << root.join("app/assets/builds")
         end
       end
     end

data/lib/katalyst/kpop/matchers/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rspec/rails/matchers/base_matcher"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      class Base < RSpec::Rails::Matchers::BaseMatcher
+        attr_reader :matched
+
+        def matches?(actual)
+          @matched = super
+          @matched.present?
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/capybara_matcher.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/base"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class CapybaraMatcher < Base
+        attr_reader :matched
+
+        def matches?(actual)
+          super
+        rescue ::Capybara::ElementNotFound
+          nil
+        end
+
+        def match(expected, actual)
+          actual.find(expected)
+        end
+
+        def description
+          "match #{expected}"
+        end
+
+        def describe_expected
+          expected.inspect
+        end
+
+        def describe_actual
+          response = actual.native.children.to_html.gsub(/\s+/, " ")
+          response = "#{response[0..120]}..." if response.length > 120
+          response.inspect
+        end
+
+        def failure_message
+          "expected #{describe_expected} but received #{describe_actual} instead"
+        end
+
+        def failure_message_when_negated
+          "expected not to find #{expected}"
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/capybara_parser.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/base"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class CapybaraParser < Base
+        def match(_, actual)
+          @html = Nokogiri::HTML5.parse(actual.body)
+          Capybara::Node::Simple.new(@html)
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/chained_matcher.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "rspec/rails/matchers/base_matcher"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class ChainedMatcher < RSpec::Rails::Matchers::BaseMatcher
+        Input = Struct.new(:matched)
+
+        delegate :failure_message, :failure_message_when_negated, to: :@matcher
+
+        def initialize(*matchers)
+          super()
+          matchers.each { |m| self << m }
+        end
+
+        def <<(matcher)
+          matcher = matcher.new if matcher.is_a?(Class)
+          (@matchers ||= []) << matcher
+          self
+        end
+
+        def match(_, actual)
+          @matcher = Input.new(actual)
+          @matchers.all? do |matcher|
+            input    = @matcher.matched
+            @matcher = matcher
+            matcher.matches?(input)
+          end
+        end
+
+        def description
+          @matchers.last.description
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/frame_matcher.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/capybara_matcher"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class FrameMatcher < CapybaraMatcher
+        def initialize(id: "kpop")
+          super("turbo-frame##{id}")
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/modal_matcher.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/capybara_matcher"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class ModalMatcher < CapybaraMatcher
+        def initialize
+          super("[data-controller*='kpop--modal']")
+        end
+
+        def description
+          "contain a kpop modal"
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/redirect_finder.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/capybara_matcher"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class RedirectFinder < CapybaraMatcher
+        def initialize
+          super("[data-controller='kpop--redirect']")
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/redirect_matcher.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/base"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class RedirectMatcher < Base
+        def match(expected, actual)
+          actual["data-kpop--redirect-path-value"].to_s.match?(expected)
+        end
+
+        def description
+          "kpop redirect to #{expected.inspect}"
+        end
+
+        def failure_message
+          "expected a kpop redirect to #{expected.inspect} but received #{actual.native.to_html.inspect} instead"
+        end
+
+        def failure_message_when_negated
+          "expected not to find a kpop redirect to #{expected.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/response_matcher.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/base"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class ResponseMatcher < Base
+        def match(_, actual)
+          case actual
+          when ::ActionDispatch::Response
+            ::ActionDispatch::TestResponse.from_response(actual)
+          when ::ActionDispatch::TestResponse
+            actual
+          end
+        end
+
+        def description
+          "a response"
+        end
+
+        def failure_message
+          "expected a response but received #{actual.inspect} instead"
+        end
+
+        def failure_message_when_negated
+          "expected not to receive a response"
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/stream_matcher.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/capybara_matcher"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class StreamMatcher < CapybaraMatcher
+        def initialize(id: "kpop", action: "update")
+          super("turbo-stream[action='#{action}'][target='#{id}']")
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/title_finder.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/capybara_matcher"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class TitleFinder < CapybaraMatcher
+        def initialize
+          super(".kpop-title")
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers/title_matcher.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/base"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api private
+      class TitleMatcher < Base
+        def description
+          "contain a kpop modal with title #{expected.inspect}"
+        end
+
+        def match(expected, actual)
+          expected.match?(actual.text)
+        end
+
+        def failure_message
+          "expected a kpop modal with title #{expected.inspect} but received #{actual.native.to_html.inspect} instead"
+        end
+
+        def failure_message_when_negated
+          "expected not to find a kpop modal with title #{expected}"
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/matchers.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/matchers/base"
+require "katalyst/kpop/matchers/capybara_matcher"
+require "katalyst/kpop/matchers/capybara_parser"
+require "katalyst/kpop/matchers/chained_matcher"
+require "katalyst/kpop/matchers/frame_matcher"
+require "katalyst/kpop/matchers/modal_matcher"
+require "katalyst/kpop/matchers/redirect_finder"
+require "katalyst/kpop/matchers/redirect_matcher"
+require "katalyst/kpop/matchers/response_matcher"
+require "katalyst/kpop/matchers/stream_matcher"
+require "katalyst/kpop/matchers/title_finder"
+require "katalyst/kpop/matchers/title_matcher"
+
+module Katalyst
+  module Kpop
+    module Matchers
+      # @api public
+      # Passes if `response` contains a turbo response with a kpop dismiss action.
+      #
+      # @example
+      #   expect(response).to kpop_dismiss
+      def kpop_dismiss(id: "kpop")
+        ChainedMatcher.new(ResponseMatcher, CapybaraParser, StreamMatcher.new(id:, action: "append"))
+      end
+
+      # @api public
+      # Passes if `response` contains a turbo response with a kpop redirect to
+      # the provided `target`.
+      #
+      # @example Matching a path against a turbo response containing a kpop redirect
+      #   expect(response).to kpop_redirect_to("/path/to/resource")
+      def kpop_redirect_to(target, id: "kpop")
+        raise ArgumentError, "Invalid target: nil" unless target
+
+        ChainedMatcher.new(ResponseMatcher,
+                           CapybaraParser,
+                           StreamMatcher.new(id:, action: "append"),
+                           RedirectFinder,
+                           RedirectMatcher.new(target))
+      end
+
+      # @api public
+      # Passes if `response` contains a turbo stream response with a kpop modal.
+      # Supports matching on:
+      #  * id – kpop frame id
+      #  * title - modal title
+      #
+      # @example Matching turbo stream response with a Shopping Cart modal
+      #   expect(response).to render_kpop_stream(title: "Shopping Cart")
+      def render_kpop_stream(id: "kpop", title: nil)
+        matcher = ChainedMatcher.new(ResponseMatcher, CapybaraParser, StreamMatcher.new(id:, action: "kpop_open"),
+                                     ModalMatcher)
+        matcher << TitleFinder << TitleMatcher.new(title) if title.present?
+        matcher
+      end
+
+      # @api public
+      # Passes if `response` contains a turbo frame with a kpop modal.
+      # Supports matching on:
+      #  * id – turbo frame id
+      #  * title - modal title
+      #
+      # @example Matching turbo stream response with a Shopping Cart modal
+      #   expect(response).to render_kpop_frame(title: "Shopping Cart")
+      def render_kpop_frame(id: "kpop", title: nil)
+        matcher = ChainedMatcher.new(ResponseMatcher, CapybaraParser, FrameMatcher.new(id:), ModalMatcher)
+        matcher << TitleFinder << TitleMatcher.new(title) if title.present?
+        matcher
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Katalyst::Kpop::Matchers, type: :component
+  config.include Katalyst::Kpop::Matchers, type: :request
+end

data/lib/katalyst/kpop/turbo.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "katalyst/kpop/engine"
+
+module Katalyst
+  module Kpop
+    module Turbo
+      class TagBuilder
+        delegate :action, :append, :tag, to: :@builder
+
+        def initialize(builder)
+          @builder = builder
+        end
+
+        # Open a modal in the kpop frame identified by <tt>id</tt> either the <tt>content</tt> passed in or a
+        # rendering result determined by the <tt>rendering</tt> keyword arguments, the content in the block,
+        # or the rendering of the content as a record. Examples:
+        #
+        #   <%= turbo_stream.kpop.open modal %>
+        #   <%= turbo_stream.kpop.open partial: "modals/modal", locals: { record: } %>
+        #   <%= turbo_stream.kpop.open do %>
+        #     <%= render Kpop::ModalComponent.new(title: "Example") do %>
+        #       ...
+        #     <% end %>
+        #   <% end %>
+        def open(content = nil, id: "kpop", **, &)
+          @builder.action(:kpop_open, id, content, **, &)
+        end
+
+        # Render a turbo stream action that will dismiss any open kpop modal.
+        def dismiss(id: "kpop")
+          append(id) do
+            tag.div("", data: {
+                      controller:                     "kpop--close",
+                      kpop__close_kpop__frame_outlet: "##{id}",
+                      turbo_temporary:                "",
+                    })
+          end
+        end
+
+        # Renders a kpop redirect controller response that will escape the frame and navigate to the given URL.
+        def redirect_to(url, id: "kpop", target: nil)
+          append(id) do
+            tag.div("", data: {
+                      controller:                        "kpop--redirect",
+                      kpop__redirect_kpop__frame_outlet: "##{id}",
+                      kpop__redirect_path_value:         url,
+                      kpop__redirect_target_value:       target,
+                      turbo_temporary:                   "",
+                    })
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katalyst/kpop/version.rb

@@ -2,6 +2,6 @@
 
 module Katalyst
   module Kpop
-    VERSION = "2.0.9"
+    VERSION = "3.0.0.beta.1"
   end
 end

data/lib/katalyst/kpop.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
+require "html_attributes_utils"
+require "view_component"
+
 require "katalyst/kpop/engine"
+require "katalyst/kpop/turbo"
 require "katalyst/kpop/version"
 
 module Katalyst

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-kpop
 version: !ruby/object:Gem::Version
-  version: 2.0.9
+  version: 3.0.0.beta.1
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-30 00:00:00.000000000 Z
-dependencies: []
+date: 2023-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-attributes-utils
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  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:
 - developers@katalyst.com.au
@@ -18,25 +60,58 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- app/assets/builds/katalyst/kpop.css
+- app/assets/builds/katalyst/kpop.esm.js
 - app/assets/builds/katalyst/kpop.js
 - app/assets/builds/katalyst/kpop.min.js
+- app/assets/builds/katalyst/kpop.min.js.map
+- app/assets/builds/katalyst/kpop.umd.js
 - app/assets/config/kpop.js
-- app/assets/javascripts/controllers/kpop_controller.js
-- app/assets/javascripts/controllers/scrim_controller.js
-- app/assets/javascripts/katalyst/kpop.js
 - app/assets/stylesheets/katalyst/kpop.scss
-- app/assets/stylesheets/katalyst/kpop/_index.scss
-- app/assets/stylesheets/katalyst/kpop/_kpop.scss
+- app/assets/stylesheets/katalyst/kpop/_frame.scss
+- app/assets/stylesheets/katalyst/kpop/_modal.scss
 - app/assets/stylesheets/katalyst/kpop/_scrim.scss
-- app/helpers/kpop/modal.rb
+- app/assets/stylesheets/katalyst/kpop/_side_panel.scss
+- app/assets/stylesheets/katalyst/kpop/_variables.scss
+- app/components/concerns/kpop/has_html_attributes.rb
+- app/components/kpop/frame_component.html.erb
+- app/components/kpop/frame_component.rb
+- app/components/kpop/modal/title_component.html.erb
+- app/components/kpop/modal/title_component.rb
+- app/components/kpop/modal_component.html.erb
+- app/components/kpop/modal_component.rb
+- app/components/scrim_component.rb
 - app/helpers/kpop_helper.rb
-- app/helpers/scrim_helper.rb
+- app/javascript/kpop/application.js
+- app/javascript/kpop/controllers/close_controller.js
+- app/javascript/kpop/controllers/frame_controller.js
+- app/javascript/kpop/controllers/modal_controller.js
+- app/javascript/kpop/controllers/redirect_controller.js
+- app/javascript/kpop/controllers/scrim_controller.js
+- app/javascript/kpop/debug.js
+- app/javascript/kpop/modals/content_modal.js
+- app/javascript/kpop/modals/frame_modal.js
+- app/javascript/kpop/modals/modal.js
+- app/javascript/kpop/modals/stream_modal.js
+- app/javascript/kpop/modals/stream_renderer.js
 - app/views/layouts/kpop.html.erb
 - config/importmap.rb
 - config/routes.rb
 - lib/katalyst/kpop.rb
 - lib/katalyst/kpop/engine.rb
+- lib/katalyst/kpop/matchers.rb
+- lib/katalyst/kpop/matchers/base.rb
+- lib/katalyst/kpop/matchers/capybara_matcher.rb
+- lib/katalyst/kpop/matchers/capybara_parser.rb
+- lib/katalyst/kpop/matchers/chained_matcher.rb
+- lib/katalyst/kpop/matchers/frame_matcher.rb
+- lib/katalyst/kpop/matchers/modal_matcher.rb
+- lib/katalyst/kpop/matchers/redirect_finder.rb
+- lib/katalyst/kpop/matchers/redirect_matcher.rb
+- lib/katalyst/kpop/matchers/response_matcher.rb
+- lib/katalyst/kpop/matchers/stream_matcher.rb
+- lib/katalyst/kpop/matchers/title_finder.rb
+- lib/katalyst/kpop/matchers/title_matcher.rb
+- lib/katalyst/kpop/turbo.rb
 - lib/katalyst/kpop/version.rb
 homepage: https://github.com/katalyst/kpop
 licenses:
@@ -51,14 +126,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Modal library that uses Turbo and Stimulus.