activeadmin_settings_cached 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 603aca9e3f4f9203e5615d4d1a6de0971c712bd0
-  data.tar.gz: 9479bedf926819b92387a229c3a86f82d0bc47d3
+SHA256:
+  metadata.gz: ee6c14de48fbbb2c5b92865102c9e924b0653fa9e000c8c16cc60a7b44e857e1
+  data.tar.gz: b5a1e74381075692da0aec927cf76a8205c3d26c0964f297a6909652da735008
 SHA512:
-  metadata.gz: 93838c32f20dffc07cd5089f91b5c95587286b078ca8769b0768b55c40d90c36b22b332edcb6c58805a6fd6bf58bb4504e58b5bfcecf49c1f1faa644255ad17b
-  data.tar.gz: 2c7b7968c14440954dce41f50b02ac8b3f2e2ef787e02512212a6c2df7fb9fc38d56928b4ad17c39726037e9e6dde55a849191edc1d863667500ffbb1f53560e
+  metadata.gz: 9ead2b850cf382b950cbe026055405f75a55071a86834b1caafeeb17ce9f52549538c987a32a33a13592ee96e6b448b4b2ef65137544f487e47aee71c205d0c5
+  data.tar.gz: dd196049e5aafa3611f7636bf3b56ea9e089c7fb1c4b29600f24fd0cef8bf99d25c9623f923b8decf9ca7da2a5da385e8645bf19e4629c7e97ee037037138207

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.2', '3.3', '3.4']
+        gemfile: [rails7.2, rails8.0]
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Create test app
+        run: bundle exec rake setup
+      - name: Run specs
+        run: bundle exec rake

data/Appraisals

@@ -1,17 +1,9 @@
 # frozen_string_literal: true
 
-appraise 'rails4.2' do
-  gem 'rails', '~> 4.2.0'
+appraise 'rails7.2' do
+  gem 'rails', '~> 7.2.0'
 end
 
-appraise 'rails5.0' do
-  gem 'rails', '~> 5.0.1'
-  gem 'inherited_resources', git: 'https://github.com/activeadmin/inherited_resources.git'
-  gem 'listen'
-end
-
-appraise 'rails5.1' do
-  gem 'rails', '~> 5.1.0'
-  gem 'inherited_resources', git: 'https://github.com/activeadmin/inherited_resources.git'
-  gem 'listen'
+appraise 'rails8.0' do
+  gem 'rails', '~> 8.0.0'
 end

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+# v3.0.0 2026-10-31
+
+## Changed
+
+- Support rails-settings-cached v2 (`>= 2.8.2`), drop support for older versions
+- Show editable fields grouped by scope, input depends on field type
+- Values are coerced by rails-settings-cached, `Coercions` is removed
+- Save only changed values
+- Show validation errors in flash
+- Test against Rails 7.2 and 8.0 on GitHub Actions, remove Travis CI
+
+## Removed
+
+- `starting_with` and `key` options, use `scope` option instead
+
+# v2.3.1 2018-05-22
+
+## Changed
+
+- Remove dry-types dependency
+
+## Fixed
+- Breaking change in dry-types: Rename Types::Form to Types::Params (Julien FLAJOLLET)
+
 # v2.2.0 2017-12-22
 
 ## Added

data/Dockerfile

@@ -1,6 +1,4 @@
-FROM ruby:2.3-slim
-
-ENV PHANTOMJS_VERSION 1.9.8
+FROM ruby:3.4-slim
 
 RUN apt-get update -qq && \
   DEBIAN_FRONTEND=noninteractive apt-get install -yq --no-install-recommends \
@@ -8,19 +6,8 @@ RUN apt-get update -qq && \
   gcc \
   g++ \
   libsqlite3-dev \
-  git-core \
-  wget \
-  libfreetype6 \
-  libfontconfig \
-  bzip2 && \
+  libyaml-dev \
+  git-core && \
   apt-get clean
 
-RUN \
-  wget -q --no-check-certificate -O /tmp/phantomjs-$PHANTOMJS_VERSION-linux-x86_64.tar.bz2 https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-$PHANTOMJS_VERSION-linux-x86_64.tar.bz2 && \
-  mkdir -p /srv/var && \
-  tar -xjf /tmp/phantomjs-$PHANTOMJS_VERSION-linux-x86_64.tar.bz2 -C /tmp && \
-  rm -f /tmp/phantomjs-$PHANTOMJS_VERSION-linux-x86_64.tar.bz2 && \
-  mv /tmp/phantomjs-$PHANTOMJS_VERSION-linux-x86_64/ /srv/var/phantomjs && \
-  ln -s /srv/var/phantomjs/bin/phantomjs /usr/bin/phantomjs
-
 WORKDIR /app

data/Gemfile

@@ -2,9 +2,13 @@
 
 source 'https://rubygems.org'
 
+gem 'rails', '~> 8.0.0'
+gem 'sassc-rails'
+gem 'sprockets-rails'
+
 group :test do
   gem 'pry-byebug'
-  gem 'therubyracer'
+  gem 'puma'
 end
 
 gemspec

data/Makefile

@@ -1,7 +1,10 @@
+RUN := run --rm --service-ports
+DOCKER_COMPOSE_RUN := docker-compose $(RUN)
+
 default: test
 
-rake:
-	bundle exec rake ${T}
+bash:
+	${DOCKER_COMPOSE_RUN} app bash
 
 test: appraisals
 	bundle exec appraisal rspec ${T}
@@ -9,9 +12,17 @@ test: appraisals
 appraisals: setup
 	bundle exec appraisal install
 
+appraisals-generate:
+	bundle exec appraisal generate
+
+
 setup:
-	gem install bundler --no-ri --no-rdoc
+	gem install bundler
 	bundle check || bundle install -j 2
+	bundle exec appraisal rake setup
+
+down:
+	docker-compose down
 
 clean:
 	rm -f Gemfile.lock

data/README.md

@@ -1,12 +1,12 @@
 # Activeadmin Settings Cached
 
 [![Gem Version](https://badge.fury.io/rb/activeadmin_settings_cached.svg)](http://badge.fury.io/rb/activeadmin_settings_cached)
-[![Build Status](https://travis-ci.org/artofhuman/activeadmin_settings_cached.svg?branch=master)](https://travis-ci.org/artofhuman/activeadmin_settings_cached)
-[![Dependency Status](https://gemnasium.com/badges/github.com/artofhuman/activeadmin_settings_cached.svg)](https://gemnasium.com/github.com/artofhuman/activeadmin_settings_cached)
-[![Coverage Status](https://coveralls.io/repos/github/artofhuman/activeadmin_settings_cached/badge.svg?branch=master)](https://coveralls.io/github/artofhuman/activeadmin_settings_cached?branch=master)
+[![CI](https://github.com/artofhuman/activeadmin_settings_cached/actions/workflows/ci.yml/badge.svg)](https://github.com/artofhuman/activeadmin_settings_cached/actions/workflows/ci.yml)
 
 Provides a nice UI interface for [rails-settings-cached](https://github.com/huacnlee/rails-settings-cached) gem in [Active Admin](http://activeadmin.info/).
 
+Version 3 supports rails-settings-cached v2 (`>= 2.8.2`). For rails-settings-cached `< 0.6.7` use version 2.x of this gem.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,9 +26,9 @@ Create your settings model:
 
 Create your settings page:
 
-    # From generators                   
-    $ rails g active_admin:settings Setting  
-                 
+    # From generators
+    $ rails g active_admin:settings Setting
+
     # Or manual
 
 ``` ruby
@@ -43,15 +43,38 @@ ActiveAdmin.register_page 'Setting' do
 end
 ```
 
-And configure your default values in your Settings model:
+And define your fields in your Setting model:
 
 ``` ruby
-class Settings < RailsSettings::CachedSettings
-  defaults[:my_awesome_settings] = 'This is my settings'
+class Setting < RailsSettings::Base
+  field :app_name, default: 'My app'
+
+  scope :mail do
+    field :admin_emails, type: :array, default: %w[admin@example.com]
+    field :notifications_enabled, type: :boolean, default: true
+    field :default_locale, default: 'en', option_values: %w[en de ru], help_text: 'Language of emails'
+  end
+
+  field :api_key, default: ENV['API_KEY'], readonly: true
 end
 ```
 
-In your application's admin interface, there will now be a new page with this setting
+In your application's admin interface, there will now be a new page with these settings.
+
+Every editable field is shown. Readonly fields are not shown. Fields are grouped by `scope`.
+The input depends on the field `type`:
+
+Type                               | Input
+---------------------------------- | -----
+`:string`                          | text field
+`:integer`, `:float`, `:big_decimal` | number field
+`:boolean`                         | checkbox
+`:array`                           | textarea, one value per line
+`:hash`                            | textarea with YAML
+
+A field with `option_values` is shown as a select. A field with `help_text` shows it as a hint.
+Validation errors from `validates` are shown in the flash message.
+Only changed values are saved, so unchanged fields keep their default value.
 
 ## active_admin_settings_page DSL
 
@@ -68,14 +91,20 @@ end
 Tool                    | Description
 ---------------------   | -----------
 :model_name					|String, settings model name override (default: uses name from global config.)
-:starting_with			|String, each key must starting with, (default: nil)
-:key			|String, Symbol root key, can be replacement for starting_with, (default: nil)
+:scope			|Symbol, Array of Symbols, show only fields from these scopes (default: nil, all fields)
 :template				|String, custom template rendering (default: 'admin/settings/index')
 :template_object				|object passing to view (default: ActiveadminSettingsCached::Model instance)
 :display    |Hash, display settings override (default: {})
 :title			|String, title value override (default: I18n.t('settings.menu.label'))
 :after_save |Proc, callback for action after POST request, (default: nil)
- 
+
+#### Settings on different pages
+
+```ruby
+ActiveAdmin.register_page 'Mail Settings' do
+  active_admin_settings_page(scope: :mail, title: 'Mail Settings')
+end
+```
 
 ## Localization
 You can localize settings keys in local file
@@ -84,7 +113,9 @@ You can localize settings keys in local file
 en:
   settings:
     attributes:
-      my_awesome_settings: 'My Awesome Lolaized Setting'
+      my_awesome_settings: 'My Awesome Localized Setting'
+    scopes:
+      mail: 'Mail'
 ```
 ## Model name
 
@@ -98,7 +129,7 @@ end
 
 ## Display options
 
-If you need define display options for settings fields, eg textarea, url or :timestamp and etc., you can set `display` option in initializer.
+If you need to override the input for a field, eg textarea, url or :timestamp and etc., you can set `display` option in initializer.
 
 
 ``` ruby
@@ -120,3 +151,18 @@ Available options see [here](https://github.com/justinfrench/formtastic#the-avai
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## How run local example
+
+```
+make bash
+make setup
+cd spec/rails/rails-8.0.*/
+BUNDLE_GEMFILE=/app/gemfiles/rails8.0.gemfile bundle exec rails s -b 0.0.0.0
+```
+
+## Upgrading from 2.x
+
+- Update rails-settings-cached to v2 and define your settings with `field`.
+- `starting_with` and `key` options are removed. Use rails-settings-cached `scope` and the `scope` option.
+- Values are coerced by rails-settings-cached field types. `display` only changes the input.

data/activeadmin_settings_cached.gemspec

@@ -19,18 +19,14 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.add_dependency 'activeadmin'
-  s.add_dependency 'dry-types', '>= 0.8.1'
-  s.add_dependency 'rails-settings-cached', '>= 0.5.3', '< 0.6.7'
+  s.add_dependency 'activeadmin', '>= 1.0', '< 4'
+  s.add_dependency 'rails-settings-cached', '~> 2.8', '>= 2.8.2'
 
   s.add_development_dependency 'appraisal'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'capybara'
-  s.add_development_dependency 'coveralls'
-  s.add_development_dependency 'database_cleaner'
-  s.add_development_dependency 'poltergeist'
+  s.add_development_dependency 'database_cleaner-active_record'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec-rails'
-  s.add_development_dependency 'selenium-webdriver'
   s.add_development_dependency 'sqlite3'
 end

data/app/views/admin/settings/_index.html.erb

@@ -7,19 +7,26 @@
           <th><%= t('settings.index.value')%></th>
         </tr>
       </thead>
-      <tbody>
-        <% settings_model.settings.each_pair do |name, _| %>
-          <% field_name = settings_model.field_name(name) %>
-          <tr class="odd">
-            <td><strong><%= f.label field_name, t("settings.attributes.#{field_name}", default: field_name) %></strong></td>
-            <td>
-              <div class='form'>
-                <ol><%= f.input field_name, settings_model.field_options(field_name, name) %></ol>
-              </div>
-            </td>
-          </tr>
-        <% end%>
-      </tbody>
+      <% settings_model.fields_by_scope.each_pair do |scope, fields| %>
+        <tbody>
+          <% if scope %>
+            <tr>
+              <th colspan="2"><%= t("settings.scopes.#{scope}", default: scope.to_s.humanize) %></th>
+            </tr>
+          <% end %>
+          <% fields.each do |field| %>
+            <% key = field[:key] %>
+            <tr class="odd">
+              <td><strong><%= f.label key, t("settings.attributes.#{key}", default: key) %></strong></td>
+              <td>
+                <div class='form'>
+                  <ol><%= f.input key, settings_model.field_options(key) %></ol>
+                </div>
+              </td>
+            </tr>
+          <% end %>
+        </tbody>
+      <% end %>
     </table>
     <%= f.submit %>
   <% end %>

data/config/locales/de.yml

@@ -3,6 +3,7 @@ de:
     settings:
       update:
         success: Konfiguration wurde gespeichert.
+        error: 'Konfiguration konnte nicht gespeichert werden: %{details}'
 
   activerecord:
     models:

data/config/locales/en.yml

@@ -3,6 +3,7 @@ en:
     settings:
       update:
         success: Settings was successfully updated.
+        error: 'Settings were not saved: %{details}'
 
   activerecord:
     models:

data/config/locales/ru.yml

@@ -3,6 +3,7 @@ ru:
     settings:
       update:
         success: Настройки были успешно сохранены.
+        error: 'Не удалось сохранить настройки: %{details}'
 
   activerecord:
     models:

data/docker-compose.yml

@@ -1,13 +1,17 @@
-version: '2'
+version: '3.3'
 
 services:
   app:
     build: '.'
     command: 'make test'
     volumes:
-      - '.:/app'
-      - gems:/usr/local/bundle
+      - .:/app:cached
+      - bundler-data:/usr/local/bundle/
+      - bin-data:/usr/local/bin/
+    ports:
+      - "3000:3000"
+
 
 volumes:
-  gems:
-    external: true
+  bundler-data:
+  bin-data:

data/gemfiles/{rails4.2.gemfile → rails7.2.gemfile}

@@ -2,11 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.2.0"
+gem "rails", "~> 7.2.0"
+gem "sassc-rails"
+gem "sprockets-rails"
 
 group :test do
   gem "pry-byebug"
-  gem "therubyracer"
+  gem "puma"
 end
 
 gemspec path: "../"

data/gemfiles/rails8.0.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 8.0.0"
+gem "sassc-rails"
+gem "sprockets-rails"
+
+group :test do
+  gem "pry-byebug"
+  gem "puma"
+end
+
+gemspec path: "../"

data/lib/activeadmin_settings_cached/dsl.rb

@@ -8,8 +8,7 @@ module ActiveadminSettingsCached
     #
     # @param [Hash] options
     # @option options [String] :model_name, settings model name override (default: uses name from global config.)
-    # @option options [String] :starting_with, each key must starting with, (default: nil)
-    # @option options [String] :key, root key can be replacement for starting_with, (default: nil)
+    # @option options [Symbol, Array<Symbol>] :scope, show only fields from these rails-settings-cached scopes (default: nil)
     # @option options [String] :template custom, template rendering (default: 'admin/settings/index')
     # @option options [String] :template_object, object to use in templates (default: ActiveadminSettingsCached::Model instance)
     # @option options [String] :display, display settings override (default: nil)
@@ -19,23 +18,32 @@ module ActiveadminSettingsCached
       options.assert_valid_keys(*ActiveadminSettingsCached::Options::VALID_OPTIONS)
 
       options = ActiveadminSettingsCached::Options.options_for(options)
-      coercion =
-        ActiveadminSettingsCached::Coercions.new(options[:template_object].defaults, options[:template_object].display)
 
       content title: options[:title] do
         render partial: options[:template], locals: { settings_model: options[:template_object] }
       end
 
       page_action :update, method: :post do
-        settings_params = params.require(:settings).permit!
+        settings_model = options[:template_object]
+        settings_params = params.require(:settings).permit(*settings_model.keys)
+        errors = []
 
-        coercion.cast_params(settings_params) do |name, value|
-          options[:template_object].save(name, value)
+        settings_params.each do |key, value|
+          next unless settings_model.changed?(key, value)
+
+          settings_model.save(key, value)
+        rescue ActiveRecord::RecordInvalid => e
+          errors.concat(e.record.errors.full_messages)
+        end
+
+        if errors.any?
+          flash[:error] = t('activeadmin_settings_cached.settings.update.error', details: errors.join(', '))
+        else
+          flash[:success] = t('activeadmin_settings_cached.settings.update.success')
         end
 
-        flash[:success] = t('activeadmin_settings_cached.settings.update.success'.freeze)
-        Rails.version.to_i >= 5 ? redirect_back(fallback_location: admin_root_path) : redirect_to(:back)
         options[:after_save].call if options[:after_save].respond_to?(:call)
+        redirect_back(fallback_location: admin_root_path)
       end
 
       instance_eval(&block) if block_given?

data/lib/activeadmin_settings_cached/engine.rb

@@ -5,9 +5,6 @@ require 'active_admin'
 
 module ActiveadminSettingsCached
   class Engine < Rails::Engine
-    config.mount_at = '/'
-    config.autoload_paths += Dir["#{config.root}/lib"]
-
     initializer 'activeadmin_settings_cached' do
       ::ActiveAdmin::DSL.send(:include, ::ActiveadminSettingsCached::DSL)
     end