spina-pro 0.0.1 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61fa276bfbebd315c4bef407d3cda74e65ea2159abe4e04723f47291a87d638a
-  data.tar.gz: c501cf42893c32e9155eff0b34bf20e3dab59ab5957bf72ea3c6f6e803660d72
+  metadata.gz: a249b2ddca255ef865e689250559290c21a163026a4e49a88e415eba2e69756a
+  data.tar.gz: ac4e83d34b35e85a1e0e16fcdf5fe9ae8aceb1758eb00eb6f1e0255880db0c65
 SHA512:
-  metadata.gz: 2268494194bb7795a239675e7d2e764ada496f5f7e82eab8d2fe6088883414c9c04093528692fb2257f4a7bdd96f8a00b9b3b9f8e067142675bee6e3a01af541
-  data.tar.gz: a43e99f11ad22e446492c2419842c5b0752b157f980d762cbfec49b5483e6083d1bb21f4fa597bb3d8a575423e7f231407ccbcddb376c6e449a147d514f98b74
+  metadata.gz: 429cbac4b67fbafe242fa4b374eca60f92608ad82fa2f387634ad044f66e6b818b40b6bed954c8e6047b3f8e27ecfb71aa7909cc117e915257e16140b367713e
+  data.tar.gz: 879f75bacd355cb8dba4d0352b700330f80963a7388d04e6088b480f310dfab2376879ecac4109df6cb232e475fb013da4ec4223330adcc24a59e2577f6f782b

data/CHANGELOG.md

@@ -0,0 +1,83 @@
+# Changelog
+
+## 0.12
+
+### 0.12.0
+- Added UI for spam messages
+
+## 0.11
+
+### 0.11.0
+- Added Dutch translations
+- Added config.track_not_found_errors (default: true)
+
+## 0.10
+
+### 0.10.3
+- Added Dutch translations
+
+### 0.10.2
+- Fixed licensing bug
+
+### 0.10.1
+- Fixed UI bug when deleting drafts
+- Temporarily disabled phoning home to spinacms.com (because of Apple and Heroku downtime)
+
+### 0.10.0
+- Updated ViewComponents Slots API to v3
+- Spina Pro now requires Spina >= v2.15.0
+
+## 0.9
+
+### 0.9.3
+- Fixed bug when creating new drafts
+
+### 0.9.2
+- Skip saving a revision if nothing changed
+- Use update instead of destroy/insert on search documents
+
+### 0.9.1
+- Add the `inbox` class method to messages
+
+### 0.9.0
+- Added support for version history
+- Refactored UI for drafts
+
+## 0.8
+
+### 0.8.1
+- Fixed bug for page revisions without AttrJson::NestedAttributes
+
+### 0.8.0
+- Added support for page revisions (multiple drafts)
+
+## 0.7
+
+### 0.7.1
+- Rename search methods to prevent naming collision
+
+### 0.7.0
+- Added support for Spina::Parts::Pro::Date/Datetime fields
+- Added support for ordering pages based on Date/Datetime fields
+
+## 0.6
+
+### 0.6.0
+- Multi-model support in global search
+- UI bugfixes
+- Added pagination to Rewrite Rules
+
+## 0.5
+
+### 0.5.0
+- Updated inbox view template
+- Fixed bug with Tailwind content
+- Fixed UI bug with page search
+
+## 0.4
+
+### 0.4.1
+- Fixed bug with expires_at DateTime parsing
+
+### 0.4.0
+- Licensing validation

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2026 Bram Jetten
+
+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,66 @@
+# Spina::Pro
+
+Spina Pro is a Rails engine that adds a collection of extra features to a
+[Spina CMS](https://www.spinacms.com) project. It was previously distributed as
+a commercial add-on and is now open source under the MIT license.
+
+## Features
+
+- **Global search** — full-text search across pages and other models, powered by
+  `pg_search`.
+- **Page revisions & drafts** — keep a version history of pages and work on
+  multiple drafts before publishing.
+- **Messages & inboxes** — store and manage form submissions (e.g. contact
+  forms) in the admin, with forwarding, archiving and spam/ham handling.
+- **Rewrite rules** — manage redirects, including auto-generated suggestions.
+- **404 tracking** — track and review not-found errors so you can fix broken
+  links.
+- **Date & DateTime parts** — extra page parts (`Spina::Parts::Pro::Date` and
+  `Spina::Parts::Pro::DateTime`) and ordering pages by date.
+- **UI niceties** — recently visited pages, hints, and an enhanced SEO tab.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "spina-pro"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Run the migrations from the engine:
+
+```bash
+$ bin/rails spina_pro:install:migrations
+$ bin/rails db:migrate
+```
+
+## Configuration
+
+Spina Pro can be configured in an initializer:
+
+```ruby
+# config/initializers/spina_pro.rb
+Spina::Pro.disable_hints          = false
+Spina::Pro.hide_inboxes           = false
+Spina::Pro.postgresql_dictionary  = "english"
+Spina::Pro.track_not_found_errors = true
+```
+
+Spina Pro requires Spina `>= 2.15.0` and a PostgreSQL database (the search and
+several other features rely on PostgreSQL-specific functionality).
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is released under the
+MIT license, so feel free to use it, fork it and build on top of it.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/spina/pro/manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../../../javascripts/spina/pro/controllers
+//= link_directory ../../../javascripts/spina/pro/libraries

data/app/assets/javascripts/spina/pro/controllers/form_autosave_controller.js

@@ -0,0 +1,19 @@
+import { Controller } from "@hotwired/stimulus"
+import debounce from "libraries/debounce"
+import formRequestSubmitPolyfill from "libraries/form-request-submit-polyfill"
+
+export default class extends Controller {
+  
+  submitForm = debounce(function() {
+    this.element.requestSubmit()
+  }.bind(this), this.debounceTime)
+  
+  save() {
+    this.submitForm()
+  }
+  
+  get debounceTime() {
+    return this.element.dataset.debounceTime || 200
+  }
+  
+}

data/app/assets/javascripts/spina/pro/controllers/search_controller.js

@@ -0,0 +1,64 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static get targets() {
+    return ['result']
+  }
+  
+  preventEnter(event) {
+    if (event.key === "Enter") event.preventDefault()
+  }
+  
+  navigate(event) {
+    switch(event.key) {
+      case "Enter":
+        this.selected.click()
+        break
+      case "ArrowUp":
+        this.selectPrevious()
+        break
+      case "ArrowDown":
+        this.selectNext()
+        break
+      default:
+    }
+  }
+  
+  selectPrevious() {
+    if (!this.selected) return 
+    let previous = this.selected.previousElementSibling
+    if (previous) this.selectResult(previous)
+  }
+  
+  selectNext() {
+    if (!this.selected) return 
+    let next = this.selected.nextElementSibling
+    if (next) this.selectResult(next)
+  }
+  
+  select(event) {
+    this.selectResult(event.currentTarget)
+  }
+  
+  selectResult(resultElement) {
+    this.deselectAll()
+    resultElement.querySelectorAll("[data-selected-class]").forEach(function(el) {
+      el.classList.add(el.dataset.selectedClass)
+    })
+    resultElement.dataset.selected = true
+  }
+  
+  deselectAll() {
+    this.resultTargets.forEach(function(result) {
+      result.querySelectorAll("[data-selected-class]").forEach(function(el) {
+        el.classList.remove(el.dataset.selectedClass)
+      })
+      result.removeAttribute('data-selected')
+    })
+  }
+  
+  get selected() {
+    return this.resultTargets.find(result => result.hasAttribute('data-selected'))
+  }
+  
+}

data/app/assets/javascripts/spina/pro/controllers/seo_controller.js

@@ -0,0 +1,66 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static get targets() {
+    return [ "title", "titleInput", "description", "descriptionInput", "widthCalculator", "widthResult" ]
+  }
+  
+  connect() {
+    this.renderTitle()
+    this.renderDescription()
+  }
+  
+  renderTitle() {
+    if (this.titleInputTarget.value != "") {
+      this.titleTarget.innerText = this.titleInputTarget.value
+    } else {
+      this.titleTarget.innerText = this.fallbackTitle
+    }
+  }
+  
+  renderDescription() {
+    if (this.descriptionInputTarget.value != "") {
+      this.descriptionTarget.innerText = this.descriptionInputTarget.value 
+    } else {
+      this.descriptionTarget.innerText = this.fallbackDescription
+    }
+    
+    this.calculateWidth()
+  }
+  
+  calculateWidth() {
+    this.widthCalculatorTarget.innerText = this.descriptionInputTarget.value
+    this.descriptionTarget.classList.remove('text-red-600', 'text-yellow-600', 'text-gray-700')
+    
+    if (this.descriptionWidth > this.descriptionDesktopMaximum) {
+      this.descriptionTarget.classList.add('text-red-600')
+    } else if (this.descriptionWidth > this.descriptionMobileMaximum) {
+      this.descriptionTarget.classList.add('text-yellow-600')
+    } else {
+      this.descriptionTarget.classList.add('text-gray-700')
+    }
+  }
+  
+  get fallbackTitle() {
+    return this.titleTarget.dataset.fallbackTitle
+  }
+  
+  get fallbackDescription() {
+    return this.descriptionTarget.dataset.fallbackDescription
+  }
+  
+  get descriptionWidth() {
+    return this.widthCalculatorTarget.offsetWidth
+  }
+  
+  // Max width for desktop
+  get descriptionDesktopMaximum() {
+    return 920
+  }
+  
+  // Max width for mobile
+  get descriptionMobileMaximum() {
+    return 680
+  }
+  
+}

data/app/assets/javascripts/spina/pro/libraries/debounce.js

@@ -0,0 +1,65 @@
+/**
+ * Returns a function, that, as long as it continues to be invoked, will not
+ * be triggered. The function will be called after it stops being called for
+ * N milliseconds. If `immediate` is passed, trigger the function on the
+ * leading edge, instead of the trailing. The function also has a property 'clear' 
+ * that is a function which will clear the timer to prevent previously scheduled executions. 
+ *
+ * @source underscore.js
+ * @see http://unscriptable.com/2009/03/20/debouncing-javascript-methods/
+ * @param {Function} function to wrap
+ * @param {Number} timeout in ms (`100`)
+ * @param {Boolean} whether to execute at the beginning (`false`)
+ * @api public
+ */
+export default function debounce(func, wait, immediate){
+  var timeout, args, context, timestamp, result;
+  if (null == wait) wait = 100;
+
+  function later() {
+    var last = Date.now() - timestamp;
+
+    if (last < wait && last >= 0) {
+      timeout = setTimeout(later, wait - last);
+    } else {
+      timeout = null;
+      if (!immediate) {
+        result = func.apply(context, args);
+        context = args = null;
+      }
+    }
+  };
+
+  var debounced = function(){
+    context = this;
+    args = arguments;
+    timestamp = Date.now();
+    var callNow = immediate && !timeout;
+    if (!timeout) timeout = setTimeout(later, wait);
+    if (callNow) {
+      result = func.apply(context, args);
+      context = args = null;
+    }
+
+    return result;
+  };
+
+  debounced.clear = function() {
+    if (timeout) {
+      clearTimeout(timeout);
+      timeout = null;
+    }
+  };
+  
+  debounced.flush = function() {
+    if (timeout) {
+      result = func.apply(context, args);
+      context = args = null;
+      
+      clearTimeout(timeout);
+      timeout = null;
+    }
+  };
+
+  return debounced;
+};

data/app/components/spina/pro/messages/field_component.html.erb

@@ -0,0 +1 @@
+<%= render partial: form_partial_path, locals: {f: form_builder, attribute: attribute} %>

data/app/components/spina/pro/messages/field_component.rb

@@ -0,0 +1,36 @@
+module Spina
+  module Pro
+    module Messages
+      class FieldComponent < ApplicationComponent
+        attr_reader :form_builder, :attribute
+        
+        def initialize(form_builder, attribute)
+          @form_builder, @attribute = form_builder, attribute
+        end
+        
+        def form_partial_path
+          "spina/admin/pro/messages/fields/#{partial}"
+        end
+        
+        private
+        
+          def partial
+            partial_exists? ? field_type : default_field_type
+          end
+        
+          def partial_exists?
+            helpers.lookup_context.template_exists?(field_type, "spina/admin/pro/messages/fields", true)
+          end
+          
+          def default_field_type
+            :string
+          end
+          
+          def field_type
+            form_builder.object.field_type(attribute)
+          end
+        
+      end
+    end
+  end
+end

data/app/components/spina/pro/messages/message_component.html.erb

@@ -0,0 +1,31 @@
+<%= link_to helpers.spina.admin_pro_inbox_message_path(message.inbox, message), class: button_classes, data: {turbo_frame: "modal"} do %>
+  <div class="flex items-center flex-1 relative">
+    <%= image_tag message.gravatar_url, alt: 'Image', class: image_classes %>
+    
+    <% if unread? %>
+      <div class="absolute w-3 h-3 bg-red-500 rounded-full -top-0.5 -left-0.5"></div>
+    <% end %>
+    
+    <div class="text-sm flex items-center flex-1">
+      <div class="flex-1">
+        <div class="block uppercase text-xs font-semibold tracking-wide text-gray-400">
+          <%= message.class.human_attribute_name(:name) %>
+        </div>
+        <%= message.to_name %>
+      </div>
+      
+      <% message.index_attributes.each do |attribute| %>
+        <div class="flex-1">
+          <div class="block uppercase text-xs font-semibold tracking-wide text-gray-400">
+            <%= message.class.human_attribute_name(attribute) %>
+          </div>
+          <%= message.send(attribute).presence || "–" %>
+        </div>
+      <% end %>
+    </div>
+  </div>
+  
+  <div class="text-gray-400 font-normal w-36 text-xs text-right">
+    <%=l message.created_at, format: :long %>
+  </div>
+<% end %>

data/app/components/spina/pro/messages/message_component.rb

@@ -0,0 +1,30 @@
+module Spina
+  module Pro
+    module Messages
+      class MessageComponent < ApplicationComponent
+        attr_reader :message
+        
+        def initialize(message)
+          @message = message
+        end
+        
+        def unread?
+          message.unread?
+        end
+        
+        def image_classes
+          "rounded-lg w-10 h-10 mr-3"
+        end
+        
+        def button_classes
+          if unread?
+            "border-b border-gray-200 flex items-center justify-between space-x-6 px-2 pr-4 py-2 bg-white hover:bg-gray-100 w-full text-left font-semibold shadow-sm relative"
+          else
+            "border-b border-gray-200 flex items-center justify-between space-x-6 px-2 pr-4 py-2 bg-gray-50 hover:bg-gray-100 w-full text-left font-normal"
+          end
+        end
+        
+      end
+    end
+  end
+end

data/app/components/spina/pro/pages/page_revision_component.html.erb

@@ -0,0 +1,42 @@
+<div class="ml-2">
+  <%= render Spina::UserInterface::DropdownComponent.new do |dropdown| %>
+    <% dropdown.with_button(classes: "btn btn-default h-6 px-1.5") do %>
+      <% if page_revision&.draft? || page.draft? %>
+        <div class="text-xs text-gray-500 uppercase font-semibold">
+          <%= Spina::Page.human_attribute_name(:draft) %>
+        </div>
+      <% elsif page_revision.present? %>
+        <div class="text-xs text-gray-500 uppercase font-semibold">
+          <%=l page_revision.updated_at, format: :short %>
+        </div>
+      <% else %>
+        <div class="text-xs text-emerald-500 uppercase font-semibold">
+          <%=t "spina.pro.page_revisions.live" %>
+        </div>
+      <% end %>
+      
+      <%= helpers.heroicon("chevron-down", style: :mini, class: "w-3 h-3 ml-1") %>
+    <% end %>
+    
+    <% dropdown.with_menu do %>
+      <div class="relative overflow-scroll" style="max-height: 220px" data-controller="infinite-scroll" data-infinite-scroll-target="container">
+        <%= helpers.turbo_frame_tag "version_history", src: helpers.spina.admin_pro_page_version_history_path(page, page_revision_id: page_revision&.id) %>
+      </div>
+      
+      <div class="px-2 py-1">
+        <% if @page.drafts.any? %>
+          <%= link_to helpers.spina.admin_pro_page_drafts_path(page, editing_id: page_revision&.id), class: 'btn btn-default h-7 text-xs', data: {turbo_frame: "modal"} do %>
+            <%=t "spina.pro.page_revisions.drafts" %> (<%= @page.drafts.count %>)
+          <% end %>
+        <% else %>
+          <%= form_with url: helpers.spina.admin_pro_page_drafts_path(@page), data: {turbo_frame: "_top"} do |f| %>
+            <%= button_tag type: :submit, class: "btn btn-default h-8 text-xs w-full" do %>
+              <%= helpers.heroicon('plus', style: :mini, class: 'w-4 h-4 mr-1') %>
+              <%=t "spina.pro.page_revisions.create_new_draft" %>
+            <% end %>
+          <% end %>
+        <% end %>
+      </div>
+    <% end %>
+  <% end %>
+</div>

data/app/components/spina/pro/pages/page_revision_component.rb

@@ -0,0 +1,15 @@
+module Spina
+  module Pro
+    module Pages
+      class PageRevisionComponent < ApplicationComponent
+        attr_reader :page, :page_revision
+        
+        def initialize(page, page_revision = nil)
+          @page = page
+          @page_revision = page_revision
+        end
+        
+      end
+    end
+  end
+end

data/app/components/spina/pro/user_interface/hint_component.html.erb

@@ -0,0 +1,6 @@
+<div class="px-8 py-4 text-sm font-medium leading-normal bg-blue-100 border-b border-blue-200 text-blue-400 flex items-center">
+  <%= helpers.heroicon('information-circle', style: :solid, class: 'w-7 h-7 mr-3') %>
+  <div class="max-w-xl">
+    <%= sanitize @hint %>
+  </div>
+</div>

data/app/components/spina/pro/user_interface/hint_component.rb

@@ -0,0 +1,17 @@
+module Spina
+  module Pro
+    module UserInterface
+      class HintComponent < ApplicationComponent
+        
+        def initialize(hint = "")
+          @hint = hint
+        end
+        
+        def render?
+          !Spina::Pro.config.disable_hints
+        end
+        
+      end
+    end
+  end
+end

data/app/controllers/spina/admin/pro/drafts_controller.rb

@@ -0,0 +1,41 @@
+module Spina
+  module Admin
+    module Pro
+      class DraftsController < AdminController
+        before_action :set_page
+        
+        def index
+          @drafts = @page.drafts
+        end
+        
+        def create
+          revision = @page.create_draft!(updated_by: current_spina_user.name)
+          redirect_to spina.edit_admin_page_path(@page, revision: revision.id)
+        end
+        
+        def update
+          @draft = @page.drafts.find(params[:id])
+          @draft.update(page_revision_params)
+          head :ok
+        end
+        
+        def destroy
+          @draft = @page.drafts.find(params[:id])
+          @draft.destroy
+          render turbo_stream: turbo_stream.remove(view_context.dom_id(@draft))
+        end
+        
+        private
+        
+          def page_revision_params
+            params.require(:page_revision).permit(:note)
+          end
+        
+          def set_page
+            @page = Spina::Page.find(params[:page_id])
+          end
+        
+      end
+    end
+  end
+end