product_tours 0.3.3 → 1.1.0

data/app/controllers/product_tours/tours_controller.rb

@@ -1,77 +1,228 @@
 # frozen_string_literal: true
 
 module ProductTours
-  class ToursController < ApplicationController
-    SIGNALS = %w[viewed dismissed completed].freeze
+  class ToursController < DashboardController
+    PER_PAGE = 50
 
-    def resolve
-      key = params[:key].to_s
-      return handle_unresolved_trigger(key, :disabled) unless ProductTours.enabled?(request)
-      return handle_unresolved_trigger(key, :invalid_key) unless key.match?(Post::KEY_FORMAT)
+    before_action :set_tour,
+                  only: %i[show edit update destroy refresh_video_metadata add_translation publish unpublish]
+    before_action :load_linkable_tours, only: %i[new create edit update]
+    before_action :load_translations, only: :show
 
-      post = find_post_by_locale(Post.all, key)
-      return handle_unresolved_trigger(key, :missing) unless post
-      return handle_unresolved_trigger(key, :unpublished) unless post.published?
+    def index
+      @status = Tour::STATUSES.include?(params[:status]) ? params[:status] : 'published'
+      @query = params[:q].to_s.strip.presence
+      @counts = Tour.where(locale: default_locale).group(:status).count
 
-      render json: post_payload(post)
+      key_scope = Tour.where(status: @status, locale: default_locale)
+      @keys = key_scope.distinct.order(:key).pluck(:key)
+
+      scope = tours_with_video.newest_first.where(status: @status, locale: default_locale)
+      scope = scope.where('LOWER(key) LIKE ?', "%#{Tour.sanitize_sql_like(@query.downcase)}%") if @query
+      @page = [params[:page].to_i, 1].max
+      @tours = scope.offset((@page - 1) * PER_PAGE).limit(PER_PAGE + 1).to_a
+      @more = @tours.size > PER_PAGE
+      @tours = @tours.first(PER_PAGE)
+
+      @selected_tour = tours_with_video.find_by(id: params[:tour_id]) if params[:tour_id].present?
+      load_translations if @selected_tour
+    end
+
+    def show; end
+
+    def new
+      @tour = Tour.new(locale: default_locale)
+    end
+
+    def create
+      @tour = Tour.new(tour_attributes.merge(locale: default_locale))
+      if @tour.save
+        redirect_to tour_path(@tour), notice: t('product_tours.dashboard.created', default: 'Tutorial created.')
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    def edit; end
+
+    def update
+      if @tour.update(tour_attributes)
+        remove_uploaded_video if remove_uploaded_video?
+        redirect_to tour_path(@tour), notice: t('product_tours.dashboard.updated', default: 'Tutorial updated.')
+      else
+        render :edit, status: :unprocessable_entity
+      end
     end
 
-    def signal
-      return head :forbidden unless ProductTours.enabled?(request)
+    def destroy
+      if default_locale_tour?(@tour) && translations_for(@tour).where.not(id: @tour.id).exists?
+        redirect_to tour_path(@tour),
+                    alert: t('product_tours.dashboard.delete_translations_first',
+                             default: 'Delete this tutorial\'s translations before deleting the ' \
+                                      'default-language tutorial.')
+        return
+      end
 
-      action = params[:event_action].to_s
-      return head :unprocessable_entity unless SIGNALS.include?(action)
+      @tour.destroy!
+      redirect_to tours_path,
+                  notice: t('product_tours.dashboard.deleted', default: 'Tutorial deleted.'), status: :see_other
+    end
+
+    def add_translation
+      locale = params[:locale].to_s
+      unless available_locales.include?(locale) && locale != @tour.locale
+        redirect_to tour_path(@tour),
+                    alert: t('product_tours.dashboard.translation_locale_invalid',
+                             default: 'Choose another available language.')
+        return
+      end
+
+      existing = Tour.find_by(locale: locale, key: @tour.key)
+      if existing
+        redirect_to tour_path(existing),
+                    notice: t('product_tours.dashboard.translation_exists',
+                              default: 'That translation already exists.')
+        return
+      end
+
+      source = translations_for(@tour).find_by(locale: default_locale) || @tour
+      translation = source.dup
+      translation.locale = locale
+      translation.status = 'draft'
+      if translation.action_tour_key.present? &&
+         !Tour.exists?(locale: locale, key: translation.action_tour_key)
+        translation.action_tour_key = nil
+      end
+      translation.save!
+      if Tour.description_supported? && source.description.present?
+        translation.update!(description: source.description.body)
+      end
+      translation.video.attach(source.video.blob) if source.uploaded_video?
+
+      redirect_to edit_tour_path(translation),
+                  notice: t('product_tours.dashboard.translation_added',
+                            default: 'Translation added as a draft. Translate its content before publishing.')
+    end
+
+    def publish
+      @tour.update!(status: 'published')
+      redirect_to tour_path(@tour), notice: t('product_tours.dashboard.published', default: 'Tutorial published.')
+    end
+
+    def unpublish
+      @tour.update!(status: 'draft')
+      redirect_to tour_path(@tour),
+                  notice: t('product_tours.dashboard.unpublished', default: 'Tutorial moved to drafts.')
+    end
 
-      post = find_post_by_locale(Post.published, params[:key].to_s)
-      return head :not_found unless post
+    def video_preview
+      resolved = VideoResolver.resolve(params[:url])
+      unless resolved
+        render json: { error: t('product_tours.dashboard.video_invalid', default: 'Enter a supported video URL.') },
+               status: :unprocessable_entity
+        return
+      end
 
-      payload = {
-        post_id: post.id,
-        key: post.key,
-        locale: post.locale,
-        page_url: clean_page_url(params[:page_url]),
-        source: params[:source].to_s.presence
-      }
-      event_name = "product_tours.#{action}"
-      ActiveSupport::Notifications.instrument(event_name, payload)
-      notify_host(event_name, payload)
-      head :no_content
+      metadata = VideoMetadata.fetch(params[:url])
+      render json: {
+        kind: resolved.kind,
+        provider: resolved.provider,
+        url: resolved.url,
+        title: metadata['provider_title'],
+        thumbnail_url: metadata['thumbnail_url']
+      }.compact
+    end
+
+    def refresh_video_metadata
+      metadata = VideoMetadata.fetch(@tour.video_url)
+      if metadata.present?
+        @tour.update!(video_metadata: @tour.video_metadata.to_h.merge(metadata))
+        redirect_to edit_tour_path(@tour),
+                    notice: t('product_tours.dashboard.metadata_updated', default: 'Video data refreshed.')
+      else
+        redirect_to edit_tour_path(@tour),
+                    alert: t('product_tours.dashboard.metadata_failed',
+                             default: 'Video data could not be fetched. The URL was not changed.')
+      end
     end
 
     private
 
-    def notify_host(event_name, payload)
-      ProductTours.config.on_event.call(event_name, payload, request)
-    rescue StandardError => e
-      Rails.logger.error("product_tours: on_event hook raised #{e.class}: #{e.message}")
+    def tours_with_video
+      Tour.video_upload_supported? ? Tour.with_attached_video : Tour.all
+    end
+
+    def set_tour
+      @tour = Tour.find(params[:id])
+    end
+
+    def tour_params
+      permitted = %i[key status title video_url action_label action_url action_tour_key]
+      permitted << :description if Tour.description_supported?
+      permitted << :video if Tour.video_upload_supported?
+      params.require(:tour).permit(*permitted)
+    end
+
+    def tour_attributes
+      attributes = tour_params
+      attributes.delete(:key) if identity_locked?
+      case params[:video_source]
+      when 'url'
+        attributes.delete(:video)
+      when 'upload'
+        attributes[:video_url] = nil
+      end
+      case params[:action_target]
+      when 'close'
+        attributes[:action_url] = nil
+        attributes[:action_tour_key] = nil
+      when 'url'
+        attributes[:action_tour_key] = nil
+      when 'tour'
+        attributes[:action_url] = nil
+      end
+      attributes
+    end
+
+    def load_linkable_tours
+      @linkable_tours = Tour.where.not(id: @tour&.id).order(:locale, :title, :key)
+                            .select(:id, :key, :locale, :status, :title)
+      @identity_locked = identity_locked?
     end
 
-    def post_payload(post)
-      video = post.resolved_video
-      video[:url] = media_path(post) if video&.dig(:kind) == 'upload'
-      {
-        key: post.key,
-        locale: post.locale,
-        title: post.title,
-        descriptionHtml: description_html(post),
-        video: video,
-        action: {
-          label: post.action_label.presence || default_action_label(post),
-          url: post.action_url.presence,
-          postKey: post.action_post_key.presence
-        }
-      }
+    def load_translations
+      tour = @selected_tour || @tour
+      @translations = translations_for(tour).order(:locale).to_a
+      @missing_translation_locales = available_locales - @translations.map(&:locale)
     end
 
-    def default_action_label(post)
-      key = post.action_post_key.present? ? :next : :done
-      I18n.t(key, scope: :product_tours, default: key.to_s.humanize)
+    def translations_for(tour)
+      Tour.where(key: tour.key)
     end
 
-    def description_html(post)
-      return unless Post.description_supported? && post.description.present?
+    def available_locales
+      (I18n.available_locales.map(&:to_s) + [default_locale]).uniq.sort
+    end
+
+    def default_locale
+      I18n.default_locale.to_s
+    end
+
+    def default_locale_tour?(tour)
+      tour.locale == default_locale
+    end
+
+    def identity_locked?
+      @tour&.persisted? &&
+        (!default_locale_tour?(@tour) || translations_for(@tour).where.not(id: @tour.id).exists?)
+    end
+
+    def remove_uploaded_video?
+      params[:video_source] == 'url' && @tour.uploaded_video?
+    end
 
-      post.description.body.to_s
+    def remove_uploaded_video
+      @tour.video.purge if @tour.uploaded_video?
     end
   end
 end

data/app/helpers/product_tours/{posts_helper.rb → tours_helper.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module ProductTours
-  module PostsHelper
+  module ToursHelper
     LOCALE_NAMES = {
       'ar' => 'Arabic', 'bg' => 'Bulgarian', 'bn' => 'Bengali', 'de' => 'German', 'el' => 'Greek',
       'en' => 'English', 'es' => 'Spanish', 'fr' => 'French', 'hi' => 'Hindi', 'hr' => 'Croatian',

data/app/models/product_tours/{post.rb → tour.rb}

@@ -3,13 +3,20 @@
 require 'uri'
 
 module ProductTours
-  class Post < ApplicationRecord
+  class Tour < ApplicationRecord
     KEY_FORMAT = /\A[a-z0-9]+(?:[._-][a-z0-9]+)*\z/
     STATUSES = %w[draft published].freeze
     DASHBOARD_STATUSES = %w[published draft].freeze
 
     enum :status, STATUSES.index_by(&:itself), default: :draft
 
+    # Explicit methods work in non-main Ractors; Rails' enum-generated
+    # predicates and bang methods are currently unisolated closures.
+    def draft? = status_for_database == 'draft'
+    def draft! = update!(status: 'draft')
+    def published? = status_for_database == 'published'
+    def published! = update!(status: 'published')
+
     has_rich_text :description if respond_to?(:has_rich_text)
 
     has_one_attached :video, service: ProductTours.config.storage_service if defined?(::ActiveStorage)
@@ -19,7 +26,7 @@ module ProductTours
     validates :status, inclusion: { in: STATUSES }
     validates :title, presence: true
     validate :action_has_one_destination
-    validate :action_post_is_linkable
+    validate :action_tour_is_linkable
     validate :action_url_is_safe
     validate :video_url_is_supported
     validate :uploaded_file_is_video
@@ -61,10 +68,10 @@ module ProductTours
       }.compact
     end
 
-    def action_post
-      return if action_post_key.blank?
+    def action_tour
+      return if action_tour_key.blank?
 
-      self.class.find_by(locale: locale, key: action_post_key)
+      self.class.find_by(locale: locale, key: action_tour_key)
     end
 
     private
@@ -97,25 +104,25 @@ module ProductTours
     end
 
     def action_has_one_destination
-      return unless action_url.present? && action_post_key.present?
+      return unless action_url.present? && action_tour_key.present?
 
-      errors.add(:base, 'Primary action can open a URL or another post, not both')
+      errors.add(:base, 'Primary action can open a URL or another tour, not both')
     end
 
-    def action_post_is_linkable
-      return if action_post_key.blank?
+    def action_tour_is_linkable
+      return if action_tour_key.blank?
 
-      unless action_post_key.match?(KEY_FORMAT)
-        errors.add(:action_post_key, 'must use a valid post key')
+      unless action_tour_key.match?(KEY_FORMAT)
+        errors.add(:action_tour_key, 'must use a valid tour key')
         return
       end
-      if action_post_key == key
-        errors.add(:action_post_key, 'cannot link to the same post')
+      if action_tour_key == key
+        errors.add(:action_tour_key, 'cannot link to the same tour')
         return
       end
-      return if locale.blank? || self.class.exists?(locale: locale, key: action_post_key)
+      return if locale.blank? || self.class.exists?(locale: locale, key: action_tour_key)
 
-      errors.add(:action_post_key, 'must identify an existing post in the same locale')
+      errors.add(:action_tour_key, 'must identify an existing tour in the same locale')
     end
 
     def uploaded_file_is_video

data/app/views/product_tours/{posts → tours}/_form.html.erb

@@ -1,14 +1,14 @@
-<%= form_with model: post, class: "post-form" do |form| %>
-  <% action_target = post.action_post_key.present? ? "post" : (post.action_url.present? ? "url" : "close") %>
-  <% linkable_posts = @linkable_posts.map do |candidate|
+<%= form_with model: tour, class: "tour-form" do |form| %>
+  <% action_target = tour.action_tour_key.present? ? "tour" : (tour.action_url.present? ? "url" : "close") %>
+  <% linkable_tours = @linkable_tours.map do |candidate|
        { id: candidate.id, key: candidate.key, locale: candidate.locale, status: candidate.status,
          label: "#{candidate.title} — #{candidate.key} (#{candidate.status})" }
      end %>
-  <% video_source = params[:video_source].presence || (post.uploaded_video? ? "upload" : "url") %>
-  <% if post.errors.any? %>
+  <% video_source = params[:video_source].presence || (tour.uploaded_video? ? "upload" : "url") %>
+  <% if tour.errors.any? %>
     <div class="errors" role="alert">
       <strong><%= t("product_tours.dashboard.fix_errors", default: "Fix the following fields:") %></strong>
-      <ul><% post.errors.full_messages.each do |message| %><li><%= message %></li><% end %></ul>
+      <ul><% tour.errors.full_messages.each do |message| %><li><%= message %></li><% end %></ul>
     </div>
   <% end %>
 
@@ -36,7 +36,7 @@
       <%= form.label :locale, t("product_tours.dashboard.language", default: "Language") %>
       <%= form.text_field :locale, disabled: true %>
       <small>
-        <% if post.new_record? %>
+        <% if tour.new_record? %>
           <%= t("product_tours.dashboard.default_language_hint", default: "New tutorials start in your app's default language. Add translations from the tutorial page.") %>
         <% else %>
           <%= t("product_tours.dashboard.language_locked_hint", default: "Add and open other languages from the tutorial page.") %>
@@ -45,11 +45,11 @@
     </div>
     <div class="field">
       <%= form.label :status, t("product_tours.dashboard.publication_status", default: "Publication status") %>
-      <%= form.select :status, ProductTours::Post::STATUSES.map { |status| [status.humanize, status] } %>
+      <%= form.select :status, ProductTours::Tour::STATUSES.map { |status| [status.humanize, status] } %>
     </div>
   </section>
 
-  <% if ProductTours::Post.description_supported? %>
+  <% if ProductTours::Tour.description_supported? %>
     <section class="form-section">
       <h2><%= t("product_tours.dashboard.description", default: "Description") %></h2>
       <div class="rich-editor" data-rich-editor>
@@ -60,18 +60,18 @@
           <button type="button" data-rich-command="insertOrderedList" aria-label="<%= t("product_tours.dashboard.numbered_list", default: "Numbered list") %>">1.</button>
           <button type="button" data-rich-command="createLink" aria-label="<%= t("product_tours.dashboard.link", default: "Link") %>">↗</button>
         </div>
-        <%= form.hidden_field :description, value: post.description.body.to_s, data: { rich_input: true } %>
+        <%= form.hidden_field :description, value: tour.description.body.to_s, data: { rich_input: true } %>
         <div class="rich-content" contenteditable="true" role="textbox" aria-multiline="true"
              aria-label="<%= t("product_tours.dashboard.description", default: "Description") %>"
-             data-rich-content><%= post.description.body.to_s.html_safe %></div>
+             data-rich-content><%= tour.description.body.to_s.html_safe %></div>
       </div>
     </section>
   <% end %>
 
   <section class="form-section">
     <h2><%= t("product_tours.dashboard.video", default: "Video") %></h2>
-    <% if ProductTours::Post.video_upload_supported? %>
-      <fieldset class="video-source-picker" data-video-source-picker data-has-upload="<%= post.uploaded_video? %>">
+    <% if ProductTours::Tour.video_upload_supported? %>
+      <fieldset class="video-source-picker" data-video-source-picker data-has-upload="<%= tour.uploaded_video? %>">
         <legend class="sr-only"><%= t("product_tours.dashboard.video_source", default: "Video source") %></legend>
         <label class="action-choice">
           <%= radio_button_tag :video_source, "url", video_source == "url", data: { video_source: true } %>
@@ -94,7 +94,7 @@
         <small><%= t("product_tours.dashboard.video_hint", default: "YouTube, Vimeo, Loom, Tella, Voomly, or a direct MP4/WebM URL.") %></small>
       </div>
       <div class="form-video-preview" data-video-preview
-           data-endpoint="<%= video_preview_posts_path %>"
+           data-endpoint="<%= video_preview_tours_path %>"
            data-loading="<%= t("product_tours.dashboard.video_loading", default: "Loading preview…") %>"
            data-error="<%= t("product_tours.dashboard.video_preview_failed", default: "This video could not be previewed.") %>"
            hidden>
@@ -103,14 +103,14 @@
       </div>
     </div>
 
-    <% if ProductTours::Post.video_upload_supported? %>
+    <% if ProductTours::Tour.video_upload_supported? %>
       <div data-video-source-fields="upload" <%= "hidden" unless video_source == "upload" %>>
         <div class="field">
           <%= form.label :video, t("product_tours.dashboard.video_file", default: "Video file") %>
           <%= form.file_field :video, accept: "video/*", disabled: video_source != "upload",
-                              required: video_source == "upload" && !post.uploaded_video? %>
-          <% if post.uploaded_video? %>
-            <small><%= t("product_tours.dashboard.current_video", default: "Current file: %{filename}", filename: post.video.filename) %></small>
+                              required: video_source == "upload" && !tour.uploaded_video? %>
+          <% if tour.uploaded_video? %>
+            <small><%= t("product_tours.dashboard.current_video", default: "Current file: %{filename}", filename: tour.video.filename) %></small>
           <% end %>
         </div>
       </div>
@@ -128,9 +128,9 @@
           <small><%= t("product_tours.dashboard.action_finish_hint", default: "Marks this tutorial complete and closes the modal.") %></small></span>
       </label>
       <label class="action-choice">
-        <%= radio_button_tag :action_target, "post", action_target == "post", data: { action_target: true } %>
-        <span><strong><%= t("product_tours.dashboard.action_post", default: "Continue to another tutorial") %></strong>
-          <small><%= t("product_tours.dashboard.action_post_hint", default: "Opens it in the same modal and automatically adds a Back button.") %></small></span>
+        <%= radio_button_tag :action_target, "tour", action_target == "tour", data: { action_target: true } %>
+        <span><strong><%= t("product_tours.dashboard.action_tour", default: "Continue to another tutorial") %></strong>
+          <small><%= t("product_tours.dashboard.action_tour_hint", default: "Opens it in the same modal and automatically adds a Back button.") %></small></span>
       </label>
       <label class="action-choice">
         <%= radio_button_tag :action_target, "url", action_target == "url", data: { action_target: true } %>
@@ -141,21 +141,21 @@
 
     <div class="field">
       <%= form.label :action_label, t("product_tours.dashboard.action_label", default: "Button label") %>
-      <%= form.text_field :action_label, placeholder: action_target == "post" ? t("product_tours.next", default: "Next") : t("product_tours.done", default: "Done"),
+      <%= form.text_field :action_label, placeholder: action_target == "tour" ? t("product_tours.next", default: "Next") : t("product_tours.done", default: "Done"),
                           data: { action_label: true } %>
       <small><%= t("product_tours.dashboard.action_label_hint", default: "Optional. A sensible label is used when left blank.") %></small>
     </div>
 
-    <div data-action-fields="post">
+    <div data-action-fields="tour">
       <div class="field">
-        <%= form.label :action_post_key, t("product_tours.dashboard.next_post", default: "Next tutorial") %>
-        <% same_locale_posts = @linkable_posts.select { |candidate| candidate.locale == post.locale } %>
-        <% post_options = same_locale_posts.map { |candidate| ["#{candidate.title} — #{candidate.key} (#{candidate.status})", candidate.key] } %>
-        <%= form.select :action_post_key, options_for_select(post_options, post.action_post_key),
-                        { include_blank: t("product_tours.dashboard.select_next_post", default: "Select the next tutorial…") },
-                        required: true, data: { action_post_select: true, selected_key: post.action_post_key,
-                                                current_post_id: post.id } %>
-        <small><%= t("product_tours.dashboard.next_post_hint", default: "Tutorials must use the same language. Draft tutorials can be linked while you prepare the sequence.") %></small>
+        <%= form.label :action_tour_key, t("product_tours.dashboard.next_tour", default: "Next tutorial") %>
+        <% same_locale_tours = @linkable_tours.select { |candidate| candidate.locale == tour.locale } %>
+        <% tour_options = same_locale_tours.map { |candidate| ["#{candidate.title} — #{candidate.key} (#{candidate.status})", candidate.key] } %>
+        <%= form.select :action_tour_key, options_for_select(tour_options, tour.action_tour_key),
+                        { include_blank: t("product_tours.dashboard.select_next_tour", default: "Select the next tutorial…") },
+                        required: true, data: { action_tour_select: true, selected_key: tour.action_tour_key,
+                                                current_tour_id: tour.id } %>
+        <small><%= t("product_tours.dashboard.next_tour_hint", default: "Tutorials must use the same language. Draft tutorials can be linked while you prepare the sequence.") %></small>
       </div>
     </div>
 
@@ -166,12 +166,12 @@
         <small><%= t("product_tours.dashboard.action_hint", default: "Use an app path such as /settings or a complete HTTP(S) URL.") %></small>
       </div>
     </div>
-    <script type="application/json" data-action-post-options><%= raw json_escape(linkable_posts.to_json) %></script>
+    <script type="application/json" data-action-tour-options><%= raw json_escape(linkable_tours.to_json) %></script>
   </section>
 
   <div class="form-actions">
-    <%= form.submit(post.persisted? ? t("product_tours.dashboard.save", default: "Save changes") : t("product_tours.dashboard.create", default: "Create tutorial"), class: "button primary") %>
-    <%= link_to t("product_tours.dashboard.cancel", default: "Cancel"), post.persisted? ? post_path(post) : posts_path, class: "button" %>
+    <%= form.submit(tour.persisted? ? t("product_tours.dashboard.save", default: "Save changes") : t("product_tours.dashboard.create", default: "Create tutorial"), class: "button primary") %>
+    <%= link_to t("product_tours.dashboard.cancel", default: "Cancel"), tour.persisted? ? tour_path(tour) : tours_path, class: "button" %>
   </div>
   </div>
 <% end %>