spina 2.0.1 → 2.2.0

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

@@ -1,40 +1,62 @@
-::Spina::Theme.register do |theme|
+# Theme configuration file
+# ========================
+# This file is used for all theme configuration.
+# It's where you define everything that's editable in Spina CMS.
 
+Spina::Theme.register do |theme|
+  # All views are namespaced based on the theme's name
   theme.name = 'default'
-  theme.title = 'Default Theme'
-
-  theme.parts = [{
-    name: 'text',
-    title: "Text",
-    part_type: "Spina::Parts::Text"
-  }]
-
-  theme.view_templates = [{
-    name:       'homepage',
-    title:      'Homepage',
-    parts: ['text']
-  }, {
-    name: 'show',
-    title:        'Default',
-    description:  'A simple page',
-    usage:        'Use for your content',
-    parts:   ['text']
-  }]
-
-  theme.custom_pages = [{
-    name:           'homepage',
-    title:          'Homepage',
-    deletable:      false,
-    view_template:  'homepage'
-  }]
-
-  theme.navigations = [{
-    name: 'mobile',
-    label: 'Mobile'
-  }, {
-    name: 'main',
-    label: 'Main navigation',
-    auto_add_pages: true
-  }]
-
+  theme.title = 'Default theme'
+  
+  # Parts 
+  # Define all editable parts you want to use in your view templates
+  # 
+  # Built-in part types:
+  # - Line
+  # - MultiLine
+  # - Text (Rich text editor)
+  # - Image
+  # - ImageCollection
+  # - Attachment
+  # - Option
+  # - Repeater
+  theme.parts = [
+    {name: 'text',  title: "Body", part_type: "Spina::Parts::Text"}
+  ]
+  
+  # View templates
+  # Every page has a view template stored in app/views/my_theme/pages/*
+  # 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(text)}, 
+    {name: 'show', title: 'Page', parts: %w(text)}
+  ]
+  
+  # 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"},
+  ]
+  
+  # Navigations (optional)
+  # If your project has multiple navigations, it can be useful to configure multiple
+  # navigations.
+  theme.navigations = [
+    {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 = []
+  
+  # Plugins (optional)
+  theme.plugins = []
 end

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

@@ -1,73 +1,72 @@
-::Spina::Theme.register do |theme|
+# Theme configuration file
+# ========================
+# This file is used for all theme configuration.
+# It's where you define everything that's editable in Spina CMS.
 
+Spina::Theme.register do |theme|
+  # All views are namespaced based on the theme's name
   theme.name = 'demo'
   theme.title = 'Demo theme'
 
-  theme.layout_parts = ['line', 'body']
+  # Parts 
+  # Define all editable parts you want to use in your view templates
+  # 
+  # Built-in part types:
+  # - Line
+  # - MultiLine
+  # - Text (Rich text editor)
+  # - Image
+  # - ImageCollection
+  # - Attachment
+  # - 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", 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", part_type: "Spina::Parts::Line"}, 
+    {name: 'footer', title: "Footer", part_type: "Spina::Parts::Text"}
+  ]
 
-  # New config
-  theme.parts = [{
-    name: 'repeater',
-    title: "Repeater",
-    part_type: "Spina::Parts::Repeater",
-    parts: ['line', 'image', 'headline', 'image_collection']
-  }, {
-    name: 'line',
-    title: "Line",
-    part_type: "Spina::Parts::Line"
-  }, {
-    name: 'body',
-    title: "Body",
-    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",
-    part_type: "Spina::Parts::Line"
-  }, {
-    name: 'footer',
-    title: "Footer",
-    part_type: "Spina::Parts::Text"
-  }]
+  # View templates
+  # Every page has a view template stored in app/views/my_theme/pages/*
+  # 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)}
+  ]
 
-  theme.view_templates = [{
-    name: 'homepage',
-    title: 'Homepage',
-    page_parts: [],
-    parts: ['headline', 'body', 'image_collection']
-  }, {
-    name: 'show',
-    title: 'Default',
-    usage: 'Use for your content',
-    page_parts: [],
-    parts: ['body', 'image', 'repeater']
-  }, {
-    name: 'demo',
-    title: 'Demo',
-    description: 'Contains examples of every page part',
-    page_parts: [],
-    parts: ['body', 'image_collection', 'image', 'repeater']
-  }]
-
-  theme.custom_pages = [{
-    name:           'homepage',
-    title:          'Homepage',
-    deletable:      false,
-    view_template:  'homepage'
-  }, {
-    name:           'demo',
-    title:          'Demo',
-    deletable:      true,
-    view_template:  'demo'
-  }]
+  # 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'}
+  ]
+  
+  # Navigations (optional)
+  # If your project has multiple navigations, it can be useful to configure multiple
+  # navigations.
+  theme.navigations = [
+    {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"}
+  ]
 
+  # Plugins (optional)
   theme.plugins = ['reviews']
-
 end

data/lib/spina.rb

@@ -1,40 +1,77 @@
+require 'spina/importmap_helper'
 require 'spina/engine'
+require 'spina/admin_sectionable'
 require 'spina/railtie'
 require 'spina/plugin'
 require 'spina/theme'
+require 'spina/tailwind_purger'
 require 'spina/attr_json_spina_parts_model'
+require 'spina/attr_json_monkeypatch'
+require 'spina/authentication/sessions'
+require 'spina/authentication/basic'
 
 module Spina
-
   include ActiveSupport::Configurable
 
   PARTS = []
   PLUGINS = []
   THEMES = []
 
-  config_accessor :backend_path, 
+  config_accessor :authentication,
+                  :backend_path, 
                   :frontend_parent_controller,
                   :disable_frontend_routes,
-                  :max_page_depth, 
+                  :disable_decorator_load,
                   :locales, 
-                  :embedded_image_size
+                  :embedded_image_size,
+                  :party_pooper,
+                  :tailwind_purge_content,
+                  :queues,
+                  :transliterations
 
-  # Specify a backend path. Defaults to /admin.
+  # Defaults
+  self.authentication = "Spina::Authentication::Sessions"
   self.backend_path = 'admin'
-  
-  # The parent controller all frontend Spina controllers inherit from
-  # Default is ApplicationController
-  self.frontend_parent_controller = "ApplicationController"
-
   self.disable_frontend_routes = false
-
-  self.max_page_depth = 5
-
+  self.disable_decorator_load = false
+  self.embedded_image_size = [2000, 2000]
+  self.frontend_parent_controller = "ApplicationController"
   self.locales = [I18n.default_locale]
+  self.party_pooper = false
+  self.transliterations = %i(latin)
+  
+  # Queues for background jobs
+  # - config.queues.page_updates
+  self.queues = ActiveSupport::InheritableOptions.new
+  
+  # Tailwind purging
+  # Spina will by default purge all unused Tailwind classes by scanning
+  # the files listed below. You probably don't want to override this in 
+  # your main app. Spina Plugins can add files to this array.
+  self.tailwind_purge_content = Spina::Engine.root.glob("app/views/**/*.*") + 
+                                Spina::Engine.root.glob("app/components/**/*.*") + 
+                                Spina::Engine.root.glob("app/helpers/**/*.*") + 
+                                Spina::Engine.root.glob("app/assets/javascripts/**/*.js") +
+                                Spina::Engine.root.glob("app/**/tailwind/custom.css")
 
   # Images that are embedded in the Trix editor are resized to fit
   # You can optimize this for your website and go for a smaller (or larger) size
   # Default: 2000x2000px
-  self.embedded_image_size = "2000x2000>"
-
+  class << self
+    alias_method :config_original, :config
+    
+    def config
+      config_obj = self.config_original
+      
+      def config_obj.embedded_image_size=(image_size)
+        if image_size.is_a? String
+          ActiveSupport::Deprecation.warn("Spina embedded_image_size should be set to an array of arguments to be passed to the :resize_to_limit ImageProcessing macro. https://github.com/janko/image_processing/blob/master/doc/minimagick.md#resize_to_limit")
+        end
+        
+        self[:embedded_image_size] = image_size
+      end
+      
+      config_obj
+    end
+  end
 end

data/lib/spina/admin_sectionable.rb

@@ -0,0 +1,23 @@
+module Spina
+  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

data/lib/spina/attr_json_monkeypatch.rb

@@ -0,0 +1,28 @@
+module Spina
+  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
+        if RUBY_VERSION == "3.0.0" && RUBY_PATCHLEVEL == 0
+          define_method("#{name}=") do |value|
+            # This next line is uncommented in the attr_json gem
+            # We don't care about super here, so let's just comment it for now
+            # super(value) if defined?(super)
+            attribute_def = self.class.attr_json_registry.fetch(name.to_sym)
+            public_send(attribute_def.container_attribute)[attribute_def.store_key] = attribute_def.cast(value)
+          end
+        end
+      end
+      
+    end
+  
+  end
+end

data/lib/spina/authentication/basic.rb

@@ -0,0 +1,24 @@
+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
+        end
+    
+    end
+  end
+end

data/lib/spina/authentication/sessions.rb

@@ -0,0 +1,32 @@
+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
+    
+    end
+  end
+end

data/lib/spina/engine.rb

@@ -1,27 +1,27 @@
-require 'haml-rails'
 require 'sass-rails'
-require 'coffee-rails'
-require 'jquery-rails'
-require 'turbolinks'
+require 'turbo-rails'
+require 'stimulus-rails'
 require 'ancestry'
 require 'breadcrumbs_on_rails'
 require 'kaminari'
 require 'mobility'
 require 'rack-rewrite'
-require 'jsonb_accessor'
+require 'babosa'
 require 'attr_json'
+require 'view_component/engine'
 
 module Spina
   class Engine < ::Rails::Engine
-
     isolate_namespace Spina
 
     config.autoload_paths += %W( #{config.root}/lib )
 
-    config.to_prepare do    
+    config.to_prepare do
       # Require decorators from main application
-      [Rails.root].flatten.map { |p| Dir[p.join('app', 'decorators', '**', '*_decorator.rb')]}.flatten.uniq.each do |decorator|
-        Rails.configuration.cache_classes ? require(decorator) : load(decorator)
+      unless Spina.config.disable_decorator_load
+        Dir.glob(Rails.root + "app/decorators/**/*_decorator.rb").each do |decorator|
+          require_dependency(decorator)
+        end
       end
 
       # Register JSON part types for editing content
@@ -36,5 +36,11 @@ module Spina
         Spina::Parts::Attachment
       )
     end
+
+    initializer "spina.helpers" do
+      Rails.application.config.assets.configure do |env|
+        env.context_class.class_eval { include Spina::ImportmapHelper }
+      end
+    end
   end
 end