spina 2.2.0 → 2.3.0

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

@@ -21,6 +21,11 @@ Spina.configure do |config|
   # 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
@@ -34,6 +39,13 @@ Spina.configure do |config|
   # 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

data/lib/spina.rb

@@ -1,4 +1,3 @@
-require 'spina/importmap_helper'
 require 'spina/engine'
 require 'spina/admin_sectionable'
 require 'spina/railtie'
@@ -17,24 +16,31 @@ module Spina
   PLUGINS = []
   THEMES = []
 
-  config_accessor :authentication,
+  config_accessor :api_key,
+                  :api_path,
+                  :authentication,
                   :backend_path, 
+                  :importmap,
                   :frontend_parent_controller,
                   :disable_frontend_routes,
                   :disable_decorator_load,
                   :locales, 
                   :embedded_image_size,
+                  :thumbnail_image_size,
                   :party_pooper,
                   :tailwind_purge_content,
                   :queues,
                   :transliterations
 
   # Defaults
+  self.api_key = nil
+  self.api_path = "api"
   self.authentication = "Spina::Authentication::Sessions"
   self.backend_path = 'admin'
   self.disable_frontend_routes = false
   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
@@ -44,6 +50,10 @@ module Spina
   # - config.queues.page_updates
   self.queues = ActiveSupport::InheritableOptions.new
   
+  # An importmap specifically meant for Spina
+  self.importmap = ActiveSupport::OrderedOptions.new
+  self.importmap.paths = Importmap::Paths.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 

data/lib/spina/engine.rb

@@ -1,4 +1,5 @@
 require 'sass-rails'
+require 'importmap-rails'
 require 'turbo-rails'
 require 'stimulus-rails'
 require 'ancestry'
@@ -9,6 +10,7 @@ require 'rack-rewrite'
 require 'babosa'
 require 'attr_json'
 require 'view_component/engine'
+require 'jsonapi/serializer'
 
 module Spina
   class Engine < ::Rails::Engine
@@ -36,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.paths.tap do |paths|
+        # Stimulus & Turbo
+        paths.asset "@hotwired/stimulus", path: "stimulus"
+        paths.asset "@hotwired/stimulus-autoloader", path: "stimulus-autoloader"
+        paths.asset "@hotwired/turbo-rails", path: "turbo"
+        
+        paths.assets_in 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.2.0"
+  VERSION = "2.3.0"
 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.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Bram Jetten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2021-08-12 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,22 +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.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: turbo-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: babosa
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -207,7 +235,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: babosa
+  name: jsonapi-serializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -772,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
@@ -801,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
@@ -865,6 +893,7 @@ 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/api/paginable.rb
 - app/controllers/concerns/spina/current_account.rb
 - app/controllers/concerns/spina/current_theme.rb
 - app/controllers/concerns/spina/frontend.rb
@@ -886,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
@@ -928,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
@@ -1053,7 +1092,6 @@ files:
 - 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

data/app/assets/javascripts/spina/importmap.json.erb

@@ -1,5 +0,0 @@
-{
-  "imports": {
-    <%= spina_importmap_with_stimulus_from Spina::Engine.root.join('app/assets/javascripts/spina/controllers'), Spina::Engine.root.join('app/assets/javascripts/spina/libraries') %>
-  }
-}

data/lib/spina/importmap_helper.rb

@@ -1,37 +0,0 @@
-module Spina
-  module ImportmapHelper
-  
-    def spina_importmap_with_stimulus_from(*paths)
-      [ %("stimulus": "#{asset_path("stimulus/libraries/stimulus")}"), spina_importmap_from(*paths) ].reject(&:blank?).join(",\n")
-    end
-  
-    def spina_importmap_from(*paths, prepend: "spina")
-      Array(paths).flat_map do |path|
-        if (absolute_path = absolute_root_of(path)).exist?
-          find_javascript_files_in_tree(absolute_path).collect do |filename|
-            module_filename = filename.relative_path_from(absolute_path)
-            module_name     = importmap_module_name_from(module_filename)
-            module_path     = asset_path("#{prepend}/" + absolute_path.basename.join(module_filename).to_s)
-      
-            %("#{module_name}": "#{module_path}")
-          end
-        end
-      end.compact.join(",\n")
-    end
-  
-    private
-      
-      # Strip off the extension and any versioning data for an absolute module name.
-      def importmap_module_name_from(filename)
-        filename.basename.to_s.remove(filename.extname).split("@").first
-      end
-    
-      def find_javascript_files_in_tree(path)
-        Dir[path.join("**/*.js{,m}")].collect { |file| Pathname.new(file) }.select(&:file?)
-      end
-    
-      def absolute_root_of(path)
-        (pathname = Pathname.new(path)).absolute? ? pathname : Rails.root.join(path)
-      end
-  end
-end