spina 2.1.1 → 2.3.2

data/config/routes.rb

@@ -11,6 +11,16 @@ Rails.application.routes.draw do
 end
 
 Spina::Engine.routes.draw do
+  
+  # API
+  namespace :api, path: Spina.config.api_path do
+    resources :pages, only: [:index, :show]
+    resources :navigations, only: [:index, :show]
+    resources :resources, only: [:index, :show] do
+      resources :pages, only: [:index, :show]
+    end
+    resources :images, only: [:show]
+  end
 
   # Backend
   namespace :admin, path: Spina.config.backend_path do

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

@@ -1,31 +1,59 @@
-Spina.configure do |config|
-  # Set locales
-  config.locales = [:en]
-  # Run `rake spina:update_translations` after you add any new locale.
-
-  # Important Note
-  # ==============
-
-  # You MUST restart your server before changes to this file
-  # will take effect.
+Spina.configure do |config|  
+  # Locales
+  # ===============
+  # All locales your content should be available in.
+  # config.locales = [I18n.default_locale]
 
+  # Backend path
+  # ===============
   # Specify a backend path. Defaults to /admin.
   # config.backend_path = 'admin'
   
+  # Frontend routes
+  # ===============
+  # Uncomment the config below to disable all frontend routes.
+  # You'll have to write your own.
+  # config.disable_frontend_routes = true
+  
+  # Embedded image size
+  # ===============
+  # Images that are inserted in rich text fields are resized automatically.
+  # You can define your desired dimensions here.
+  # config.embedded_image_size = [2000, 2000]
+  
+  # Thumbnail image size
+  # ===============
+  # Thumbnail images for the API are generated using `resize_to_fill`.
+  # config.thumbnail_image_size = [400, 400]
+  
+  # Parent controller
+  # ===============
   # The parent controller all frontend Spina controllers inherit from
   # Defaults to ApplicationController
   # config.frontend_parent_controller = "ApplicationController"
   
+  # Authentication
+  # ===============
+  # Specify the module that handles authentication
+  # You can swap this out for something like Devise, or you can use your own authentication.
+  # The default is Spina::Authentication::Sessions and includes basic user management
+  # config.authentication = "Spina::Authentication::Sessions"
+  
+  # API
+  # ===============
+  # Set an API key to activate Spina's API. 
+  # It's highly recommended to use Rails credentials to store this API key.
+  # config.api_key = Rails.application.credentials.spina_api_key
+  # config.api_path = 'api'
+  
   # Background jobs
   # ===============
-  # 
   # By default, all background jobs are queued as :default
   # config.queues.page_updates = :default
 
   # Confetti
   # ===============
-  # 
-  # For people who don't appreciate confetti, you can disable that here 
+  # For people who don't appreciate confetti, you can disable that here.
   # config.party_pooper = true
 
   # Pages Options
@@ -33,4 +61,11 @@ Spina.configure do |config|
 
   # Note that you might need to remove cached asset after changing this value
   # config.max_page_depth = 5
+
+  # Transliterations
+  # ===============
+  # Set provided transliterations for normalizing url slugs
+  # %i( bulgarian cyrillic danish german greek latin macedonian norwegian 
+  #     romanian russian serbian spanish swedish ukrainian vietnamese)
+  # config.transliterations = %i(latin)
 end

data/lib/spina.rb

@@ -1,4 +1,3 @@
-require 'spina/importmap_helper'
 require 'spina/engine'
 require 'spina/admin_sectionable'
 require 'spina/railtie'
@@ -7,6 +6,8 @@ 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
@@ -15,34 +16,52 @@ module Spina
   PLUGINS = []
   THEMES = []
 
-  config_accessor :backend_path, 
+  config_accessor :api_key,
+                  :api_path,
+                  :authentication,
+                  :backend_path, 
+                  :importmap,
                   :frontend_parent_controller,
                   :disable_frontend_routes,
-                  :max_page_depth,
+                  :disable_decorator_load,
                   :locales, 
                   :embedded_image_size,
+                  :thumbnail_image_size,
                   :party_pooper,
                   :tailwind_purge_content,
-                  :queues
+                  :queues,
+                  :transliterations
 
-  # Specify a backend path. Defaults to /admin.
+  # Defaults
+  self.api_key = nil
+  self.api_path = "api"
+  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.thumbnail_image_size = [400, 400]
+  self.frontend_parent_controller = "ApplicationController"
   self.locales = [I18n.default_locale]
+  self.party_pooper = false
+  self.transliterations = %i(latin)
   
-  # Queues
+  # Queues for background jobs
+  # - config.queues.page_updates
   self.queues = ActiveSupport::InheritableOptions.new
   
-  # Don't like confetti?
-  self.party_pooper = false
+  # An importmap specifically meant for Spina
+  self.importmap = Importmap::Map.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
@@ -64,18 +83,4 @@ module Spina
       config_obj
     end
   end
-  
-  self.embedded_image_size = [2000, 2000]
-
-  
-  # 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")
-
 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,4 +1,5 @@
 require 'sass-rails'
+require 'importmap-rails'
 require 'turbo-rails'
 require 'stimulus-rails'
 require 'ancestry'
@@ -6,8 +7,10 @@ require 'breadcrumbs_on_rails'
 require 'kaminari'
 require 'mobility'
 require 'rack-rewrite'
+require 'babosa'
 require 'attr_json'
 require 'view_component/engine'
+require 'jsonapi/serializer'
 
 module Spina
   class Engine < ::Rails::Engine
@@ -15,10 +18,12 @@ module 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
@@ -33,11 +38,17 @@ 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 }
+    
+    initializer "spina.importmap" do
+      Spina.config.importmap.draw do
+        # Stimulus & Turbo
+        pin "@hotwired/stimulus", to: "stimulus.js"
+        pin "@hotwired/stimulus-autoloader", to: "stimulus-autoloader.js"
+        pin "@hotwired/turbo-rails", to: "turbo.js"
+        
+        pin_all_from Spina::Engine.root.join("app/assets/javascripts/spina"), append_base_path: true
       end
     end
+    
   end
 end

data/lib/spina/railtie.rb

@@ -2,7 +2,7 @@ module Spina
   class Railtie < Rails::Railtie
 
     initializer "spina.assets.precompile" do |app|
-      app.config.assets.precompile += %w(spina/manifest spina/importmap.json)
+      app.config.assets.precompile += %w(spina/manifest)
     end
     
     ActiveSupport.on_load(:action_controller) do

data/lib/spina/version.rb

@@ -1,3 +1,3 @@
 module Spina
-  VERSION = "2.1.1"
+  VERSION = "2.3.2"
 end

data/lib/tasks/spina_tasks.rake

@@ -25,7 +25,7 @@ namespace :spina do
     desc "Compile Tailwind.css for Spina"
     task :compile do
       Dir.chdir(File.join(__dir__, "../..")) do
-        system "npx tailwindcss-cli@latest build ./app/assets/stylesheets/spina/tailwind/custom.css -o ./app/assets/stylesheets/spina/_tailwind.css -c ./app/assets/config/spina/tailwind.config.js"
+        system "npx tailwindcss-cli@latest build -i ./app/assets/stylesheets/spina/tailwind/custom.css -o ./app/assets/stylesheets/spina/_tailwind.css -c ./app/assets/config/spina/tailwind.config.js"
       end
     end
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spina
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.3.2
 platform: ruby
 authors:
 - Bram Jetten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2021-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -126,16 +126,16 @@ dependencies:
   name: mobility
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: rack-rewrite
   requirement: !ruby/object:Gem::Requirement
@@ -178,8 +178,50 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.32'
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: babosa
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -193,7 +235,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: stimulus-rails
+  name: jsonapi-serializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -758,6 +800,7 @@ files:
 - app/assets/images/spina/favicon.png
 - app/assets/images/spina/spina.png
 - app/assets/images/spina/spina.svg
+- app/assets/javascripts/spina/application.js
 - app/assets/javascripts/spina/controllers/attachment_picker_controller.js
 - app/assets/javascripts/spina/controllers/autofocus_controller.js
 - app/assets/javascripts/spina/controllers/button_controller.js
@@ -787,7 +830,6 @@ files:
 - app/assets/javascripts/spina/controllers/toggle_controller.js
 - app/assets/javascripts/spina/controllers/trix_controller.js
 - app/assets/javascripts/spina/controllers/unique_id_controller.js
-- app/assets/javascripts/spina/importmap.json.erb
 - app/assets/javascripts/spina/libraries/canvas-confetti.js
 - app/assets/javascripts/spina/libraries/canvas-confetti@1.3.2.js
 - app/assets/javascripts/spina/libraries/form-request-submit-polyfill.js
@@ -851,7 +893,9 @@ files:
 - app/components/spina/user_interface/modal_component.rb
 - app/components/spina/user_interface/tab_link_component.html.erb
 - app/components/spina/user_interface/tab_link_component.rb
-- app/controllers/concerns/spina/current_methods.rb
+- app/controllers/concerns/spina/api/paginable.rb
+- app/controllers/concerns/spina/current_account.rb
+- app/controllers/concerns/spina/current_theme.rb
 - app/controllers/concerns/spina/frontend.rb
 - app/controllers/spina/admin/accounts_controller.rb
 - app/controllers/spina/admin/admin_controller.rb
@@ -871,6 +915,11 @@ files:
 - app/controllers/spina/admin/settings_controller.rb
 - app/controllers/spina/admin/theme_controller.rb
 - app/controllers/spina/admin/users_controller.rb
+- app/controllers/spina/api/api_controller.rb
+- app/controllers/spina/api/images_controller.rb
+- app/controllers/spina/api/navigations_controller.rb
+- app/controllers/spina/api/pages_controller.rb
+- app/controllers/spina/api/resources_controller.rb
 - app/controllers/spina/application_controller.rb
 - app/controllers/spina/pages_controller.rb
 - app/controllers/spina/sitemaps_controller.rb
@@ -913,6 +962,11 @@ files:
 - app/models/spina/user.rb
 - app/presenters/spina/content_presenter.rb
 - app/presenters/spina/menu_presenter.rb
+- app/serializers/spina/api/base_serializer.rb
+- app/serializers/spina/api/image_serializer.rb
+- app/serializers/spina/api/navigation_serializer.rb
+- app/serializers/spina/api/page_serializer.rb
+- app/serializers/spina/api/resource_serializer.rb
 - app/views/layouts/spina/admin/admin.html.erb
 - app/views/layouts/spina/admin/application.html.erb
 - app/views/layouts/spina/admin/sessions.html.erb
@@ -1035,8 +1089,9 @@ files:
 - lib/spina/admin_sectionable.rb
 - lib/spina/attr_json_monkeypatch.rb
 - lib/spina/attr_json_spina_parts_model.rb
+- lib/spina/authentication/basic.rb
+- lib/spina/authentication/sessions.rb
 - lib/spina/engine.rb
-- lib/spina/importmap_helper.rb
 - lib/spina/part.rb
 - lib/spina/plugin.rb
 - lib/spina/railtie.rb