thecore_ui_commons 3.3.5 → 3.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b58f423320587051088f25354d36950d9d5fdb366746726e9ddbb4b3104fefd
-  data.tar.gz: ebe5d1b2767ffafd2e65058762cf8c659a81b58278d2e348c54807884fd448ef
+  metadata.gz: 7d1091f859ef05f14096826e8d5cd82712958819de284543dfc26120e90c0dc4
+  data.tar.gz: aea72ad38d7f5ac1f53af37faef3fc7f3f5b8d7f0000f918bb568093950433f8
 SHA512:
-  metadata.gz: c1ada14a934779f350426cbe6f55930241c6edf9ccab6a95bf48acbca4b858b3fdcd32c8d748f34be12ba32618fa8f4ec1f68b27c789ff5b570392b2b0b0e40f
-  data.tar.gz: 4db90277e3254f3d8cd5707fdef3876e3f7dea24fd61d2a586106672b4a76e59062b8c2ff9a20483ee2949d77cb43ceb4c1a56b9897e5ad5028e68beadf10a8a
+  metadata.gz: 2a7096802f754f1f38d48adaf8491798e61f1cf725d850e53f5f7d40e209ecab3470371e04dc2d4bad5716fa5dcf27f1accfd0cab7c03693d30d54e8e244c9da
+  data.tar.gz: acc0f1101c996dab5ccce5673f0e415265fa3e49437c6f7cecba832d96909756e5927ecd2bc39bf3e7b62b00e7e42ed3966881625955974c989ee0b5b08b5b4d

data/README.md

@@ -1 +1,27 @@
-This is part of Thecore framework: https://github.com/gabrieletassoni/thecore/tree/release/3
+# thecore_ui_commons
+
+A Rails engine providing shared UI artifacts for [Thecore](https://github.com/gabrieletassoni/thecore/tree/release/3)-based host applications.
+
+## What it provides
+
+- **Layouts** — Devise session page, Swagger UI, mailer (HTML + text)
+- **Partials** — Bootstrap flash alerts, Kaminari pagination, drag-drop file uploader, logos
+- **ECharts helpers** — Ruby classes for building Apache ECharts config server-side (`Vector`, `MultipleVectors`, `Binary`, `BinarySeries`, `Speedometer`, `Map`)
+- **Swagger versioning** — `/info/swagger/:version` with automatic version discovery from mounted routes
+- **Assets** — shared CSS/JS manifests, Active Job monitor, Devise i18n injection
+
+## Installation
+
+Add to your host app's `Gemfile`:
+
+```ruby
+gem 'thecore_ui_commons', '~> 3.0'
+```
+
+The engine mounts automatically. No configuration required.
+
+## Swagger UI
+
+The Swagger UI is available at `/info/swagger` (redirects to `/info/swagger/v2`).
+
+If your app mounts `model_driven_api`, the engine discovers all available API versions at startup by scanning `Rails.application.routes` for paths matching `api/vN/info/swagger`. A version nav banner appears automatically above the Swagger UI — no configuration needed.

data/app/controllers/info_controller.rb

@@ -1,8 +1,10 @@
 class InfoController < ApplicationController
-    # This is a model-less controller just to render che swagger page using a custom layout
     layout 'swagger'
     def swagger
+        @version = params[:version].to_s.gsub(/[^a-zA-Z0-9]/, '')
+        @versions = ThecoreUiCommons.swagger_api_versions
         uri = URI(request.url)
-        @swagger_json_url = "#{uri.scheme}://#{uri.host}#{":#{uri.port}" if uri.port.present?}#{ENV.fetch("RAILS_RELATIVE_URL_ROOT", "")}/api/v2/info/swagger.json"
+        @base_url = "#{uri.scheme}://#{uri.host}#{":#{uri.port}" if uri.port.present?}#{ENV.fetch("RAILS_RELATIVE_URL_ROOT", "")}"
+        @swagger_json_url = "#{@base_url}/api/#{@version}/info/swagger.json"
     end
-end
+end

data/app/views/info/swagger.html.erb

@@ -1,28 +1,55 @@
-<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui-bundle.js"> </script>
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui-standalone-preset.js"> </script>
-    <script>
-        function get(yourUrl){
-            var Httpreq = new XMLHttpRequest(); // a new request
-            Httpreq.open("GET",yourUrl,false);
-            Httpreq.send(null);
-            var json_obj = JSON.parse(Httpreq.responseText);
-            return json_obj;          
-        }
-        window.onload = function() {
-            const ui = SwaggerUIBundle({
-            spec: get('<%= @swagger_json_url %>'),
-            dom_id: '#swagger-ui',
-            deepLinking: true,
-            presets: [
-                SwaggerUIBundle.presets.apis,
-                SwaggerUIStandalonePreset
-            ],
-            plugins: [
-                SwaggerUIBundle.plugins.DownloadUrl
-            ],
-            layout: "StandaloneLayout"
-            })
-        
-            window.ui = ui
-        }
-</script>
+<% if @versions.length > 1 %>
+  <% content_for :version_nav do %>
+    <style>
+      #version-nav {
+        display: flex;
+        align-items: center;
+        gap: 0.4rem;
+        padding: 0.55rem 1rem;
+        background: #f1f5f9;
+        border-bottom: 1px solid #e2e8f0;
+        font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
+        font-size: 0.82rem;
+        color: #64748b;
+      }
+      #version-nav .vn-label { margin-right: 0.2rem; }
+      #version-nav a {
+        display: inline-block;
+        padding: 0.22rem 0.7rem;
+        border-radius: 999px;
+        text-decoration: none;
+        border: 1px solid #3b82f6;
+        color: #3b82f6;
+        font-weight: 500;
+        transition: background 0.15s, color 0.15s;
+      }
+      #version-nav a:hover { background: #3b82f6; color: #fff; }
+      #version-nav a.current { background: #3b82f6; color: #fff; pointer-events: none; }
+    </style>
+    <div id="version-nav">
+      <span class="vn-label">API version:</span>
+      <% @versions.each do |v| %>
+        <% if v == @version %>
+          <a href="#" class="current"><%= v %></a>
+        <% else %>
+          <a href="<%= request.path.sub(/[^\/]+$/, v) %>"><%= v %></a>
+        <% end %>
+      <% end %>
+    </div>
+  <% end %>
+<% end %>
+
+<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui-bundle.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui-standalone-preset.js"></script>
+<script>
+  window.addEventListener('load', function () {
+    SwaggerUIBundle({
+      url: '<%= j @swagger_json_url %>',
+      dom_id: '#swagger-ui',
+      deepLinking: true,
+      presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
+      plugins: [SwaggerUIBundle.plugins.DownloadUrl],
+      layout: 'StandaloneLayout'
+    });
+  });
+</script>

data/app/views/layouts/swagger.html.erb

@@ -2,14 +2,10 @@
   <head>
     <meta charset="UTF-8">
     <link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui.css" >
-    <style>
-    .swagger-ui .topbar {
-      display: none;
-    }
-    </style>
   </head>
 
   <body>
+    <%= yield :version_nav %>
     <div id="swagger-ui"></div>
     <%=yield%>
   </body>

data/config/routes.rb

@@ -3,7 +3,7 @@ Rails.application.routes.draw do
         controllers = {
             sessions: "users/sessions"
         }
-        controllers[:omniauth_callbacks] = 'users/omniauth_callbacks' if ThecoreAuthCommons.oauth_vars?
+        controllers[:omniauth_callbacks] = 'users/omniauth_callbacks' if ThecoreAuthCommons.respond_to?(:oauth_vars?) && ThecoreAuthCommons.oauth_vars?
         devise_for :users, controllers: controllers
     end
     
@@ -14,6 +14,7 @@ Rails.application.routes.draw do
     end
 
     scope ENV.fetch("RAILS_RELATIVE_URL_ROOT", "/") do
-        get '/info/swagger', to: 'info#swagger'
+        get '/info/swagger', to: redirect { |_params, req| "#{req.path}/v2" }
+        get '/info/swagger/:version', to: 'info#swagger'
     end
 end

data/lib/thecore_ui_commons/version.rb

@@ -1,3 +1,3 @@
 module ThecoreUiCommons
-  VERSION = "3.3.5".freeze
+  VERSION = "3.3.6".freeze
 end

data/lib/thecore_ui_commons.rb

@@ -16,6 +16,25 @@ require "omniauth/rails_csrf_protection"
 require "thecore_ui_commons/engine"
 
 module ThecoreUiCommons
+	@swagger_api_versions = nil
+
+	class << self
+		attr_writer :swagger_api_versions
+
+		def swagger_api_versions
+			@swagger_api_versions.nil? ? scan_swagger_routes(Rails.application.routes.routes) : @swagger_api_versions
+		end
+	end
+
+	def self.scan_swagger_routes(routes)
+		routes
+			.map { |r| r.path.spec.to_s }
+			.grep(/\/api\/(v\d+)\/info\/swagger/)
+			.map { |p| p.match(/\/api\/(v\d+)\/info\/swagger/)[1] }
+			.uniq
+			.sort_by { |v| v[1..].to_i }
+	end
+
 	def self.save_files files
 		files.each do |pic|
 			upload_dir = Rails.root.join(Settings.ns(:importer).import_from_folder, 'uploads')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thecore_ui_commons
 version: !ruby/object:Gem::Version
-  version: 3.3.5
+  version: 3.3.6
 platform: ruby
 authors:
 - Gabriele Tassoni