stomp_base 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 432af31faec38b086abee4fa9d32c0e1bd9ef3ccc15671a89f9e3edbf1fa5046
-  data.tar.gz: 41c7d84e8ebb7db6dc7283af52a2a2b34f3eced03fc0d50adb941eb99eb9a623
+  metadata.gz: f766bad393da3ae69fa86a14e37ddd0757eb933c47b209b2ece04e2bc17ad7f0
+  data.tar.gz: cd1caea93843548baba429391a50b4cfac2852b0be1c5ff4534f38317df35c63
 SHA512:
-  metadata.gz: bf0f56a08d45a7044bd93efa8eb6389687b1984d0c5993e2e00808481ddda350e79460849982b20d5fc866e7c8915a3a8117c1c6ab614ff22b3fe0cf4af751ba
-  data.tar.gz: c01073b6cf496092b6fcda82ee5de049084d4f7ba79e542431147ed72a2a472bb507bad835dbe914ec4644955d4c10eb6bba0cc386eb7e05a123bd0abaf63e1b
+  metadata.gz: 4358c4e43a782e99b8c13d31ae7f00e3124b70a0db5ccb3c804cbebc68ac5b09960eaa22b6c388420e8dd9caeba08f0bc9d3390cc8b783ad4c7e43daf65558b9
+  data.tar.gz: 764692e137d6292629990b71f87a6e8952161a96fad790d0fe6ebbbdeae3e9133bfe7fe493e85d127956898f2c5aa30e5abd9a2ea7bb4208a4979b27131fb27e

data/CHANGELOG.md

@@ -7,17 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2025-06-28
+
+### Added
+- **API-only Rails Support**: Automatic compatibility for API-only Rails applications
+  - Auto-configure necessary middleware (session, cookies, flash, method override)
+  - Automatic session store configuration for API-only applications
+  - No manual middleware configuration required in host applications
+- **Japanese Documentation**: Complete Japanese translation of README.md (README.ja.md)
+- **Rails Demo API**: Complete API-only Rails demonstration application
+  - Sample models, migrations, and authentication specifications
+  - Proper bin/ directory with Rails binstubs
+  - Complete environment configurations
+
 ### Changed
-- **Test Structure**: Updated test helper file structure for better separation of concerns
-  - Moved configuration tests to `spec/unit/configuration_spec.rb`
-  - Updated `spec_helper.rb` for pure Ruby logic tests only
-  - Deprecated main `spec/rails_helper.rb` with automatic redirection to appropriate helpers
-  - Rails-based tests now use `spec/rails_demo/spec/rails_helper.rb`
-- **Configuration**: Fixed duplicate `disable_authentication` method in Configuration class
+- **Settings Controller**: Improved settings save functionality with proper flash message handling
+- **Application Controller**: Simplified to use Rails standard flash functionality
+- **Routes**: Added POST route support for settings form submission
+- **Documentation**: Added cross-language links between README files
 
 ### Fixed
-- Removed duplicate method definitions in `StompBase::Configuration`
-- Updated test helper references for consistency
+- **RuboCop Issues**: Fixed RuboCop execution and code style issues
+- **CSS Assets**: Resolved CSS asset loading issues in API-only Rails applications
+- **Error Handling**: Improved error handling and logging for middleware setup
 
 ## [0.2.0] - 2025-05-28
 
@@ -71,5 +83,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 🔧 Easy Integration: Simple gem installation and mounting process
 - 🔐 Built-in Authentication: Simple authentication options (Basic Auth, API keys, Custom)
 
+[0.2.1]: https://github.com/snowwshiro/stomp_base/releases/tag/v0.2.1
 [0.2.0]: https://github.com/snowwshiro/stomp_base/releases/tag/v0.2.0
 [0.1.0]: https://github.com/snowwshiro/stomp_base/releases/tag/v0.1.0

data/README.md

@@ -1,5 +1,7 @@
 # 🎛️ Stomp Base
 
+[ja README](./README.ja.md)
+
 [![CI](https://github.com/snowwshiro/stomp_base/workflows/CI/badge.svg)](https://github.com/snowwshiro/stomp_base/actions/workflows/ci.yml)
 [![Code Quality](https://github.com/snowwshiro/stomp_base/workflows/Code%20Quality/badge.svg)](https://github.com/snowwshiro/stomp_base/actions/workflows/code-quality.yml)
 [![Coverage](https://github.com/snowwshiro/stomp_base/workflows/Coverage/badge.svg)](https://github.com/snowwshiro/stomp_base/actions/workflows/coverage.yml)
@@ -59,6 +61,30 @@ end
 2. **Install View Component** (automatically included as dependency):
 The gem includes View Component as a dependency, so no additional setup is required.
 
+### API-Only Rails Applications
+
+StompBase automatically works with API-only Rails applications! The engine detects when the asset pipeline is not available and configures static asset serving automatically.
+
+**No additional configuration needed** - StompBase will:
+- Detect API-only mode (`config.api_only = true`)
+- Automatically serve CSS assets via `ActionDispatch::Static` middleware
+- Display helpful warnings if public file server is disabled
+
+If you encounter styling issues in an API-only app, ensure public file server is enabled:
+
+```ruby
+# config/application.rb or config/environments/development.rb
+config.public_file_server.enabled = true
+```
+
+Alternatively, you can enable ActionView and the asset pipeline:
+
+```ruby
+# config/application.rb
+require "action_view/railtie"
+# Remove or comment out: config.api_only = true
+```
+
 ## Usage
 
 ### Accessing the Dashboard

data/app/controllers/stomp_base/application_controller.rb

@@ -2,6 +2,10 @@
 
 module StompBase
   class ApplicationController < ActionController::Base
+    # Include necessary modules for API-only compatibility
+    include ActionController::Cookies
+    include ActionController::Flash unless included_modules.include?(ActionController::Flash)
+
     include StompBase::I18nHelper
     include StompBase::Authentication
 

data/app/controllers/stomp_base/settings_controller.rb

@@ -14,7 +14,7 @@ module StompBase
 
       update_theme_setting(params[:theme]) if params[:theme]
 
-      redirect_back(fallback_location: stomp_base.root_path, notice: t("stomp_base.settings.settings_updated"))
+      safe_redirect_with_notice(t("stomp_base.settings.settings_updated"))
     end
 
     def update_locale
@@ -43,7 +43,7 @@ module StompBase
       respond_to do |format|
         format.json { render json: { status: "success", locale: locale } }
         format.html do
-          redirect_back(fallback_location: stomp_base.root_path, notice: t("stomp_base.settings.settings_updated"))
+          safe_redirect_with_notice(t("stomp_base.settings.settings_updated"))
         end
       end
     end
@@ -55,7 +55,7 @@ module StompBase
                  status: :unprocessable_entity
         end
         format.html do
-          redirect_back(fallback_location: stomp_base.root_path, alert: t("stomp_base.settings.invalid_locale"))
+          safe_redirect_with_alert(t("stomp_base.settings.invalid_locale"))
         end
       end
     end
@@ -75,5 +75,15 @@ module StompBase
 
       session[:stomp_base_theme] = theme
     end
+
+    def safe_redirect_with_notice(message)
+      flash[:notice] = message
+      redirect_back(fallback_location: stomp_base.root_path)
+    end
+
+    def safe_redirect_with_alert(message)
+      flash[:alert] = message
+      redirect_back(fallback_location: stomp_base.root_path)
+    end
   end
 end

data/config/routes.rb

@@ -8,7 +8,9 @@ StompBase::Engine.routes.draw do
 
   get "settings", to: "settings#index"
   patch "settings", to: "settings#update"
+  post "settings", to: "settings#update"
   patch "settings/locale", to: "settings#update_locale", as: "update_locale"
+  post "settings/locale", to: "settings#update_locale"
 
   # Console routes
   get "console", to: "console#index"

data/lib/stomp_base/engine.rb

@@ -15,14 +15,16 @@ module StompBase
       g.helper true
     end
 
-    # Add asset paths for Rails 8 compatibility
-    if defined?(Rails.application.config.assets)
-      config.assets.paths << root.join("app", "assets", "javascripts")
-      config.assets.paths << root.join("app", "assets", "stylesheets")
-      config.assets.paths << root.join("app", "javascript")
+    # Add asset paths for Rails compatibility (when asset pipeline is available)
+    config.after_initialize do |app|
+      if app.config.respond_to?(:assets)
+        app.config.assets.paths << root.join("app", "assets", "javascripts")
+        app.config.assets.paths << root.join("app", "assets", "stylesheets")
+        app.config.assets.paths << root.join("app", "javascript")
 
-      # CSS precompilation (JavaScript is managed by importmap)
-      config.assets.precompile += %w[stomp_base/application.css stomp_base/base.css]
+        # CSS precompilation (JavaScript is managed by importmap)
+        app.config.assets.precompile += %w[stomp_base/application.css stomp_base/base.css]
+      end
     end
 
     # I18n configuration
@@ -36,5 +38,102 @@ module StompBase
         I18n.default_locale = StompBase.locale
       end
     end
+
+    # Configure static asset serving for API-only Rails applications
+    initializer "stomp_base.static_assets" do |app|
+      if self.class.should_serve_static_assets?(app.config)
+        app.middleware.use(
+          ::ActionDispatch::Static,
+          "#{root}/app/assets",
+          headers: {
+            "Cache-Control" => "public, max-age=31536000"
+          }
+        )
+      end
+    end
+
+    # Configuration validation for StompBase compatibility
+    initializer "stomp_base.validate_configuration" do |app|
+      app.config.after_initialize do
+        if app.config.api_only && !app.config.respond_to?(:assets)
+          Rails.logger.info "StompBase: Detected API-only Rails application without asset pipeline"
+
+          if app.config.public_file_server.enabled
+            Rails.logger.info "StompBase: Configured static asset serving for API-only mode"
+          else
+            Rails.logger.warn <<~WARNING
+              ⚠️  StompBase Warning: Your API-only Rails application has public file server disabled.
+              StompBase requires CSS assets to be served for proper UI functionality.
+
+              To fix this, add to your config/application.rb or config/environments/#{Rails.env}.rb:
+                config.public_file_server.enabled = true
+
+              Or enable ActionView and asset pipeline by uncommenting in config/application.rb:
+                require "action_view/railtie"
+            WARNING
+          end
+        end
+      end
+    end
+
+    # Configure middleware for API-only Rails applications
+    initializer "stomp_base.api_middleware", before: :build_middleware_stack do |app|
+      if app.config.api_only
+        Rails.logger.info "StompBase: Configuring middleware for API-only Rails application"
+
+        # Add necessary middleware for StompBase compatibility
+        required_middleware = [
+          [Rack::MethodOverride, []],
+          [ActionDispatch::Cookies, []],
+          [ActionDispatch::Session::CookieStore, []],
+          [ActionDispatch::Flash, []]
+        ]
+
+        required_middleware.each do |middleware_class, args|
+          app.config.middleware.use middleware_class, *args
+          Rails.logger.debug { "StompBase: Added #{middleware_class} middleware" }
+        rescue ArgumentError => e
+          # Middleware might already be present
+          Rails.logger.debug { "StompBase: #{middleware_class} middleware already present or error: #{e.message}" }
+        end
+
+        Rails.logger.info "StompBase: Middleware configuration completed"
+      end
+    end
+
+    # Configure session store for API-only Rails applications
+    initializer "stomp_base.session_store" do |app|
+      if app.config.api_only && !Rails.application.config.session_store
+        app.config.session_store :cookie_store, key: "_#{Rails.application.class.module_parent_name.underscore}_session"
+        Rails.logger.info "StompBase: Configured cookie session store for API-only application"
+      end
+    end
+
+    # Check if we need to serve static assets (for API-only Rails apps)
+    def self.should_serve_static_assets?(app_config)
+      # Serve static assets if:
+      # 1. The asset pipeline is not available (API-only mode)
+      # 2. Public file server is enabled (default in development/test)
+      !app_config.respond_to?(:assets) && app_config.public_file_server.enabled
+    end
+
+    # Check for ActionView availability and provide guidance
+    initializer "stomp_base.actionview_check", after: :load_config_initializers do |app|
+      if app.config.api_only
+        if defined?(ActionView::Railtie) && Rails.application.config.railties_order.include?(ActionView::Railtie)
+          Rails.logger.info "StompBase: ActionView railtie detected - full UI functionality available"
+        else
+          Rails.logger.warn <<~WARNING
+            ⚠️  StompBase Notice: ActionView railtie is not loaded.
+            StompBase requires ActionView for rendering UI components.
+
+            To enable ActionView, uncomment this line in your config/application.rb:
+              require "action_view/railtie"
+
+            StompBase will attempt to function with limited capabilities.
+          WARNING
+        end
+      end
+    end
   end
 end

data/lib/stomp_base/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StompBase
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stomp_base
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - snowwshiro