rails-settings-cached-rails-admin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e431dea803a3efc3f5f6dca35206796f2aed72292c3ce827de4fb757f012f3a
+  data.tar.gz: 25a94de3d6f107892eaa7b9e377755b40ca7b73a7c63bfc1ee6e679b1aaffa1c
+SHA512:
+  metadata.gz: e77a8e3b0777b2130b547bdd1a5a2e094be9470c3d467a0c39f27dee53c47f386c9a29fc637da46bfdee79b2394c9df8e68648f132d0dbd2c7b7a46e646b688c
+  data.tar.gz: 58496e8fb456eb6a8002b3c5fbe10fed3ebb6f182fe4173da7c69e67eede28e8f189ed446a2abc8f89aeac9976c7ad63f89786e23e4ca4ccb31a3177c2e51b4f

data/.cursor/rules

@@ -0,0 +1,12 @@
+This gem is solving following problem:
+
+When we using two ruby gems:
+
+rails_admin - for admin panel 
+rails-settings-cached - for storing settings
+
+Problem is that on settings dasboard i want to have tab called Setting that will open settings in user friendly ui.
+
+Default rails_admin behaviour is showing setting item in table with 0 records and it hard to understand for non-technical that to override default Setting need to create record with key value.
+I want provide more user friendly interface for making it with default values that setted in class Setting < RailsSettings::Base model
+Please make it as a gem, create good name for it reflected what it doing, i want to test it locally before publis

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_admin_settings_ui.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+
+# For testing
+gem "sqlite3", "~> 1.4"
+gem "rails", "~> 7.0"
+gem "rails_admin", "~> 3.0"
+gem "rails-settings-cached", "~> 2.8"
+
+# For development
+gem "pry"
+gem "byebug"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Rails Admin Settings UI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/MANUAL_SETUP.md

@@ -0,0 +1,68 @@
+# Manual Setup Instructions
+
+Since Rails Admin action registration can have timing issues, here's how to manually configure the gem:
+
+## Step 1: Add to your Rails Admin initializer
+
+In your `config/initializers/rails_admin.rb`, modify it like this:
+
+```ruby
+# Load the settings action
+require 'rails_admin_settings_ui'
+
+RailsAdmin.config do |config|
+  # ... your existing config
+
+  config.actions do
+    dashboard
+    index
+    show  
+    new
+    edit
+    delete
+    
+    # Manually register the settings action
+    collection :settings_ui, RailsAdminSettingsUi::SettingsUi
+  end
+
+  # Hide the default Setting model from navigation
+  config.model 'Setting' do
+    visible false
+  end
+end
+```
+
+## Step 2: Alternative approach using register
+
+If the above doesn't work, try this approach:
+
+```ruby
+# Load the settings action
+require 'rails_admin_settings_ui'
+
+# Register the action manually
+RailsAdmin::Config::Actions.register(:settings_ui, RailsAdminSettingsUi::SettingsUi)
+
+RailsAdmin.config do |config|
+  # ... your existing config
+
+  config.actions do
+    dashboard
+    index
+    show  
+    new
+    edit
+    delete
+    settings_ui  # Now this should work
+  end
+
+  # Hide the default Setting model from navigation
+  config.model 'Setting' do
+    visible false
+  end
+end
+```
+
+## Step 3: Restart your Rails server
+
+Make sure to restart your Rails server after making these changes.

data/README.md

@@ -0,0 +1,180 @@
+# RailsAdminSettingsUi
+
+A user-friendly interface for managing application settings in Rails Admin, designed to work seamlessly with the `rails-settings-cached` gem.
+
+## Features
+
+- **User-friendly interface**: Replace the confusing default Rails Admin table view with an intuitive settings form
+- **Automatic field type detection**: Smart field rendering based on your setting values (boolean, integer, email, URL, JSON, etc.)
+- **Categorized settings**: Automatically groups settings by prefix for better organization
+- **Default value management**: Shows default values and allows easy reset to defaults
+- **Tab-based interface**: Clean, organized display with categories in separate tabs
+- **Real-time validation**: Immediate feedback for invalid JSON and other field types
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-settings-cached-rails-admin'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Prerequisites
+
+This gem requires:
+- `rails_admin` gem
+- `rails-settings-cached` gem
+- A `Setting` model that inherits from `RailsSettings::Base`
+
+## Usage
+
+### 1. Set up your Setting model
+
+Make sure you have a Setting model with default values:
+
+```ruby
+class Setting < RailsSettings::Base
+  cache_prefix { "v1" }
+
+  # General settings
+  field :app_name, default: "My Application"
+  field :maintenance_mode, default: false
+  field :max_users, default: 1000
+
+  # Email settings  
+  field :mail_from, default: "noreply@example.com"
+  field :mail_host, default: "smtp.example.com"
+  field :mail_port, default: 587
+
+  # API settings
+  field :api_key, default: ""
+  field :api_timeout, default: 30.0
+  field :api_endpoints, default: ["https://api.example.com"]
+
+  # Advanced settings
+  field :feature_flags, default: { "new_ui" => false, "beta_features" => false }
+end
+```
+
+### 2. Configure Rails Admin
+
+In your Rails Admin configuration, enable the settings action:
+
+```ruby
+# config/initializers/rails_admin.rb
+RailsAdmin.config do |config|
+  # ... your existing configuration
+
+  # Enable the settings UI action
+  config.actions do
+    dashboard
+    index
+    show
+    new
+    edit
+    delete
+    settings_ui  # Add this line
+  end
+
+  # Optional: Hide the default Setting model from the navigation
+  config.model 'Setting' do
+    visible false
+  end
+end
+```
+
+### 3. Access the Settings UI
+
+Once configured, you'll see a "Settings" tab in your Rails Admin dashboard. Click it to access the user-friendly settings interface.
+
+## How it works
+
+### Automatic categorization
+
+Settings are automatically grouped into categories based on their key prefixes:
+- `mail_*` settings → "Mail" category
+- `api_*` settings → "API" category  
+- Other settings → "General" category
+
+### Smart field types
+
+The gem automatically detects appropriate field types:
+- `Boolean` values → Checkbox
+- `Integer` values → Number field
+- `Float` values → Number field with decimals
+- `Array` values → Comma-separated text field
+- `Hash` values → JSON text area
+- Email-like strings → Email field
+- URL-like strings → URL field
+- Long text → Text area
+- Everything else → Text field
+
+### Default value handling
+
+- Shows current vs. default values
+- Provides "Reset to Default" buttons for modified settings
+- Displays default values as help text
+
+## Customization
+
+### Custom categorization
+
+Override the `extract_category` method for custom grouping logic:
+
+```ruby
+RailsAdminSettingsUi::SettingsAction.class_eval do
+  private
+
+  def extract_category(key)
+    case key.to_s
+    when /notification|email|mail/
+      'Notifications'
+    when /payment|billing|stripe/
+      'Payments' 
+    when /social|oauth|auth/
+      'Authentication'
+    else
+      super
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+bundle install
+```
+
+To test the gem locally before publishing:
+
+1. Build the gem:
+```bash
+gem build rails_admin_settings_ui.gemspec
+```
+
+2. Install locally:
+```bash
+gem install rails_admin_settings_ui-0.1.0.gem
+```
+
+3. Or use it directly from your Gemfile:
+```ruby
+gem 'rails_admin_settings_ui', path: '/path/to/rails_admin_settings_ui'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/rails_admin_settings_ui.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec