spina 2.12.0 → 2.13.0

data/lib/generators/spina/templates/config/initializers/themes/demo.rb

@@ -5,12 +5,12 @@
 
 Spina::Theme.register do |theme|
   # All views are namespaced based on the theme's name
-  theme.name = 'demo'
-  theme.title = 'Demo theme'
+  theme.name = "demo"
+  theme.title = "Demo theme"
 
-  # Parts 
+  # Parts
   # Define all editable parts you want to use in your view templates
-  # 
+  #
   # Built-in part types:
   # - Line
   # - MultiLine
@@ -21,13 +21,13 @@ Spina::Theme.register do |theme|
   # - Option
   # - Repeater
   theme.parts = [
-    {name: 'repeater', title: "Repeater", part_type: "Spina::Parts::Repeater", parts: %w(line image headline)}, 
-    {name: 'line', title: "Line", part_type: "Spina::Parts::Line"}, 
-    {name: 'body', title: "Body", hint: "Your content", part_type: "Spina::Parts::Text"}, 
+    {name: "repeater", title: "Repeater", part_type: "Spina::Parts::Repeater", item_name: "item", parts: %w[line image headline]},
+    {name: "line", title: "Line", part_type: "Spina::Parts::Line"},
+    {name: "body", title: "Body", hint: "Your content", part_type: "Spina::Parts::Text"},
     {name: "image_collection", title: "Image collection", part_type: "Spina::Parts::ImageCollection"},
-    {name: 'image', title: "Image", part_type: "Spina::Parts::Image"}, 
-    {name: 'headline', title: "Headline", hint: "Used in the header", part_type: "Spina::Parts::Line"}, 
-    {name: 'footer', title: "Footer", part_type: "Spina::Parts::Text"}
+    {name: "image", title: "Image", part_type: "Spina::Parts::Image"},
+    {name: "headline", title: "Headline", hint: "Used in the header", part_type: "Spina::Parts::Line"},
+    {name: "footer", title: "Footer", part_type: "Spina::Parts::Text"}
   ]
 
   # View templates
@@ -35,41 +35,41 @@ Spina::Theme.register do |theme|
   # You define which parts you want to enable for every view template
   # by referencing them from the theme.parts configuration above.
   theme.view_templates = [
-    {name: 'homepage', title: 'Homepage', parts: %w(headline body image_collection)}, 
-    {name: 'show', title: 'Default', parts: %w(body image repeater)}, 
-    {name: 'demo', title: 'Demo', parts: %w(body image_collection image repeater), exclude_from: %w(articles)}
+    {name: "homepage", title: "Homepage", parts: %w[headline body image_collection]},
+    {name: "show", title: "Default", parts: %w[body image repeater]},
+    {name: "demo", title: "Demo", parts: %w[body image_collection image repeater], exclude_from: %w[articles]}
   ]
 
   # Custom pages
   # Some pages should not be created by the user, but generated automatically.
   # By naming them you can reference them in your code.
   theme.custom_pages = [
-    {name: 'homepage', title: 'Homepage', deletable: false, view_template: 'homepage'}, 
-    {name: 'demo', title: 'Demo', deletable: true, view_template: 'demo'}
+    {name: "homepage", title: "Homepage", deletable: false, view_template: "homepage"},
+    {name: "demo", title: "Demo", deletable: true, view_template: "demo"}
   ]
-  
+
   # Navigations (optional)
   # If your project has multiple navigations, it can be useful to configure multiple
   # navigations.
   theme.navigations = [
-    {name: 'main', label: 'Main navigation'}
+    {name: "main", label: "Main navigation"}
   ]
-  
+
   # Layout parts (optional)
   # You can create global content that doesn't belong to one specific page. We call these layout parts.
   # You only have to reference the name of the parts you want to have here.
   theme.layout_parts = []
-  
+
   # Resources (optional)
   # Think of resources as a collection of pages. They are managed separately in Spina
   # allowing you to separate these pages from the 'main' collection of pages.
   theme.resources = [
-    {name: 'articles', label: "Articles", view_template: "article", slug: "articles"}
+    {name: "articles", label: "Articles", view_template: "article", slug: "articles"}
   ]
 
   # Plugins (optional)
-  theme.plugins = ['reviews']
-  
+  theme.plugins = ["reviews"]
+
   # Embeds (optional)
   theme.embeds = []
 end

data/lib/spina/admin_sectionable.rb

@@ -1,23 +1,20 @@
 module Spina
-  module AdminSectionable 
+  module AdminSectionable
     extend ActiveSupport::Concern
-    
+
     included do |base|
       extend ClassMethods
-      
+
       helper_method :admin_section
       attr_accessor :admin_section
     end
-    
+
     module ClassMethods
-    
       def admin_section(name)
         before_action do |controller|
           controller.send(:admin_section=, name.to_sym)
         end
       end
-      
     end
-  
   end
-end
+end

data/lib/spina/attr_json_monkeypatch.rb

@@ -1,13 +1,12 @@
 module Spina
-  module AttrJsonMonkeypatch 
+  module AttrJsonMonkeypatch
     extend ActiveSupport::Concern
-    
+
     included do |base|
       extend ClassMethods
     end
-    
+
     module ClassMethods
-    
       def attr_json_setter_monkeypatch(name)
         # Ruby bug in 3.0.0 related to defined?(super) returning true
         # https://github.com/jrochkind/attr_json/issues/112
@@ -21,8 +20,6 @@ module Spina
           end
         end
       end
-      
     end
-  
   end
-end
+end

data/lib/spina/attr_json_spina_parts_model.rb

@@ -1,11 +1,10 @@
-require 'attr_json/type/polymorphic_model'
+require "attr_json/type/polymorphic_model"
 
 # Extending the PolymorphicModel to use the Spina::PARTS array as input
 # as opposed to arguments
 module AttrJson
   module Type
     class SpinaPartsModel < PolymorphicModel
-
       def model_names
         spina_parts_lookup.keys
       end
@@ -23,7 +22,6 @@ module AttrJson
       def type_for_model_name(model_name)
         spina_parts_lookup[model_name]
       end
-
     end
   end
 end

data/lib/spina/authentication/basic.rb

@@ -2,23 +2,22 @@ module Spina
   module Authentication
     module Basic
       extend ActiveSupport::Concern
-      
+
       included do
         helper_method :logged_in?
       end
-      
+
       def logged_in?
         authenticate
       end
-      
+
       private
-      
-        def authenticate
-          authenticate_or_request_with_http_basic do |username, password|
-            username == Rails.application.credentials.dig(:spina, :username) && password == Rails.application.credentials.dig(:spina, :password)
-          end
+
+      def authenticate
+        authenticate_or_request_with_http_basic do |username, password|
+          username == Rails.application.credentials.dig(:spina, :username) && password == Rails.application.credentials.dig(:spina, :password)
         end
-    
+      end
     end
   end
-end
+end

data/lib/spina/authentication/sessions.rb

@@ -2,31 +2,30 @@ module Spina
   module Authentication
     module Sessions
       extend ActiveSupport::Concern
-      
+
       included do
         helper_method :current_spina_user
         helper_method :logged_in?
         helper_method :logout_path
       end
-      
+
       def current_spina_user
         Spina::Current.user ||= User.find_by(id: session[:spina_user_id]) if session[:spina_user_id]
       end
-      
+
       def logged_in?
         current_spina_user
       end
-      
+
       def logout_path
         spina.admin_logout_path
       end
-      
+
       private
-      
-        def authenticate
-          redirect_to admin_login_path, flash: {information: I18n.t('spina.notifications.login')} unless logged_in?
-        end
-    
+
+      def authenticate
+        redirect_to admin_login_path, flash: {information: I18n.t("spina.notifications.login")} unless logged_in?
+      end
     end
   end
-end
+end

data/lib/spina/embeddable.rb

@@ -1,48 +1,45 @@
 module Spina
   module Embeddable
     extend ActiveSupport::Concern
-    
+
     included do
       class_attribute :embed_attributes, default: []
       class_attribute :icon, default: nil
     end
-    
+
     class_methods do
       def from_json(json)
-        begin
-          attributes = JSON.parse(json)
-          attributes.transform_keys!(&:to_sym)
-          new(attributes)
-        rescue
-          Rails.logger.error "[#{self.class.name}] Couldn't parse JSON"
-          nil
-        end
+        attributes = JSON.parse(json)
+        attributes.transform_keys!(&:to_sym)
+        new(attributes)
+      rescue
+        Rails.logger.error "[#{self.class.name}] Couldn't parse JSON"
+        nil
       end
-      
+
       def attributes(*names)
         attr_accessor(*names.map(&:to_sym))
         self.embed_attributes += names.map(&:to_sym)
       end
-      
+
       # Give it an icon
       def heroicon(name)
         self.icon = name
       end
     end
-    
+
     def initialize(attributes = {})
       attributes.slice(*self.class.embed_attributes).each do |key, value|
         instance_variable_set("@#{key}", value)
       end
     end
-    
+
     def to_fields_path
       "#{to_partial_path}_fields"
     end
-    
+
     def to_trix_partial_path
       to_partial_path
     end
-    
   end
-end
+end

data/lib/spina/embeds/trix_conversion.rb

@@ -2,40 +2,39 @@ module Spina
   module Embeds
     module TrixConversion
       extend ActiveSupport::Concern
-      
+
       # Wrap rendered partial in an <embed> tag for Trix
-      def to_trix_attachment(content = trix_attachment_content)        
+      def to_trix_attachment(content = trix_attachment_content)
         wrap_with_embed_tag(content)
       end
-      
+
       def wrap_with_embed_tag(html)
         element = html_document.create_element("spina-embed", embed_tag_attributes)
         element.inner_html = html
         element.to_html
       end
-      
+
       private
-      
-        def embed_tag_attributes
-          spina_attributes.merge({"data-embed-attributes": embed_attributes_to_json})
-        end
-      
-        def embed_attributes_to_json
-          JSON.generate Hash[self.class.embed_attributes.map{|a| [a.to_s, send(a)]}]
-        end
-        
-        def spina_attributes
-          {"data-embed-type": self.class.name, "data-controller": "embed-tag"}
-        end
-      
-        def trix_attachment_content
-          ApplicationController.render(partial: to_trix_partial_path, formats: :html, object: self, as: model_name.element)
-        end
-        
-        def html_document
-          Nokogiri::HTML::Document.new.tap{|doc| doc.encoding = "UTF-8"}
-        end
-      
+
+      def embed_tag_attributes
+        spina_attributes.merge({"data-embed-attributes": embed_attributes_to_json})
+      end
+
+      def embed_attributes_to_json
+        JSON.generate self.class.embed_attributes.map { |a| [a.to_s, send(a)] }.to_h
+      end
+
+      def spina_attributes
+        {"data-embed-type": self.class.name, "data-controller": "embed-tag"}
+      end
+
+      def trix_attachment_content
+        ApplicationController.render(partial: to_trix_partial_path, formats: :html, object: self, as: model_name.element)
+      end
+
+      def html_document
+        Nokogiri::HTML::Document.new.tap { |doc| doc.encoding = "UTF-8" }
+      end
     end
   end
-end
+end

data/lib/spina/embeds.rb

@@ -1,11 +1,9 @@
 module Spina
   module Embeds
-  
     def self.constantize(embeddable_type)
       return nil if embeddable_type.blank?
       name = embeddable_type.camelize.demodulize.to_s
       "Spina::Embeds::#{name}".safe_constantize
     end
-
   end
-end
+end

data/lib/spina/engine.rb

@@ -1,33 +1,33 @@
-require 'importmap-rails'
-require 'turbo-rails'
-require 'stimulus-rails'
-require 'ancestry'
-require 'breadcrumbs_on_rails'
-require 'kaminari'
-require 'mobility'
-require 'rack-rewrite'
-require 'babosa'
-require 'attr_json'
-require 'view_component'
-require 'jsonapi/serializer'
-require 'browser'
-require 'sprockets/railtie'
+require "importmap-rails"
+require "turbo-rails"
+require "stimulus-rails"
+require "ancestry"
+require "breadcrumbs_on_rails"
+require "kaminari"
+require "mobility"
+require "rack-rewrite"
+require "babosa"
+require "attr_json"
+require "view_component"
+require "jsonapi/serializer"
+require "browser"
+require "sprockets/railtie"
 
 module Spina
   class Engine < ::Rails::Engine
     isolate_namespace Spina
-    
-    config.autoload_paths += %W( #{config.root}/lib )
+
+    config.autoload_paths += %W[#{config.root}/lib]
 
     config.to_prepare do
-      # Require decorators from main application
       unless Spina.config.disable_decorator_load
         Dir.glob(Rails.root + "app/decorators/**/*_decorator.rb").each do |decorator|
+          ActiveSupport::Deprecation.warn("using app/decorators is deprecated in favor of app/overrides. Read more about overriding Spina at spinacms.com/guides")
           require_dependency(decorator)
         end
       end
     end
-    
+
     config.to_prepare do
       Spina::Part.register(
         Spina::Parts::Line,
@@ -40,6 +40,5 @@ module Spina
         Spina::Parts::Attachment
       )
     end
-
   end
 end

data/lib/spina/part.rb

@@ -1,8 +1,6 @@
 module Spina
   class Part
-
     class << self
-
       def all
         ::Spina::PARTS
       end
@@ -13,15 +11,12 @@ module Spina
           all << part
         end
       end
-      
+
       def unregister(part)
         all.delete_if do |registered_part|
           registered_part.name == part.name
         end
       end
-
     end
-
   end
 end
-

data/lib/spina/plugin.rb

@@ -1,6 +1,5 @@
 module Spina
   class Plugin
-
     attr_accessor :name, :namespace, :settings
 
     def create_setting_class!
@@ -10,15 +9,15 @@ module Spina
       klass = Class.new(::Spina::Setting) do
         include AttrJson::Record
         include Spina::AttrJsonMonkeypatch
-        
+
         class_settings.each do |setting|
-          attr_json *setting, container_attribute: "preferences"
+          attr_json(*setting, container_attribute: "preferences")
           attr_json_setter_monkeypatch setting.first
         end
 
-        default_scope { where(plugin: "#{plugin_name}") }
+        default_scope { where(plugin: plugin_name.to_s) }
       end
-      "Spina::#{namespace_class}".constantize.const_set 'Setting', klass
+      "Spina::#{namespace_class}".constantize.const_set :Setting, klass
     end
 
     private
@@ -32,11 +31,11 @@ module Spina
     end
 
     def namespace_class
-      namespace.split('_').map{|part| part.camelize}.join
+      namespace.split("_").map { |part| part.camelize }.join
     end
 
     def data_mapped_settings_hash
-      hash = Hash.new
+      hash = {}
       settings.each do |key, value|
         hash[key] = map_data_type(value)
       end
@@ -44,12 +43,11 @@ module Spina
     end
 
     class << self
-
       def all
         ::Spina::PLUGINS
       end
 
-      def find_by(opts={})
+      def find_by(opts = {})
         all.find do |plugin|
           matches = true
           opts.each do |key, value|
@@ -62,8 +60,8 @@ module Spina
       def register
         plugin = new
         yield plugin
-        raise 'Missing plugin name' if plugin.name.nil?
-        raise 'Missing plugin namespace' if plugin.namespace.nil?
+        raise "Missing plugin name" if plugin.name.nil?
+        raise "Missing plugin namespace" if plugin.namespace.nil?
 
         if plugin.settings.present?
           plugin.create_setting_class!
@@ -72,8 +70,6 @@ module Spina
         all << plugin
         plugin
       end
-
     end
-
   end
 end

data/lib/spina/railtie.rb

@@ -1,23 +1,21 @@
 module Spina
   class Railtie < Rails::Railtie
-
     initializer "spina.assets.precompile" do |app|
-      app.config.assets.precompile += %w(spina/manifest)
+      app.config.assets.precompile += %w[spina/manifest]
     end
-    
+
     initializer "spina.theme_reloader" do |app|
       reloader = ThemeReloader.new
       reloader.execute
-      
+
       app.reloaders << reloader
       app.reloader.to_run do
         reloader.execute
       end
     end
-    
+
     ActiveSupport.on_load(:action_controller) do
       ::ActionController::Base.send(:include, Spina::AdminSectionable)
     end
-
   end
-end
+end

data/lib/spina/theme.rb

@@ -1,14 +1,12 @@
 module Spina
   class Theme
-
     attr_accessor :name, :title, :parts, :page_parts, :structures, :view_templates, :layout_parts, :custom_pages, :plugins, :public_theme, :config, :navigations, :resources, :embeds
 
     class << self
-
       def all
         ::Spina::THEMES
       end
-      
+
       def unregister(name)
         theme = find_by_name(name)
         all.delete(theme) if theme
@@ -21,30 +19,29 @@ module Spina
       def register
         theme = ::Spina::Theme.new
         yield theme
-        raise 'Missing theme name' if theme.name.nil?
+        raise "Missing theme name" if theme.name.nil?
         unregister(theme.name)
         if theme.plugins.nil?
           theme.plugins = ::Spina::Plugin.all.map { |plugin| plugin.name }
         end
         all << theme
       end
-
     end
 
     def initialize
-      @page_parts       = []
-      @structures       = []
-      @layout_parts     = []
-      @view_templates   = []
-      @custom_pages     = []
-      @navigations      = []
-      @resources        = []
-      @embeds           = []
+      @page_parts = []
+      @structures = []
+      @layout_parts = []
+      @view_templates = []
+      @custom_pages = []
+      @navigations = []
+      @resources = []
+      @embeds = []
       @public_theme = false
     end
-    
+
     def embeddables
-      embeds.map{|embed| Embeds.constantize(embed)}
+      embeds.map { |embed| Embeds.constantize(embed) }
     end
 
     def new_page_templates(resource: nil)
@@ -52,7 +49,7 @@ module Spina
       @view_templates.map do |view_template|
         next if is_custom_undeletable_page?(view_template[:name])
         next if view_template[:exclude_from]&.include?(page_collection)
-        
+
         OpenStruct.new({
           name: view_template[:name],
           title: view_template[:title],
@@ -68,6 +65,5 @@ module Spina
     def is_custom_undeletable_page?(view_template_name)
       @custom_pages.any? { |page| page[:view_template] == view_template_name && !page[:deletable] }
     end
-
   end
 end