activeadmin_settings_cached 2.2.0 → 3.0.0

data/spec/settings_spec.rb

@@ -1,22 +1,8 @@
 # frozen_string_literal: true
 
-RSpec.describe 'settings', type: :feature, js: true do
+RSpec.describe 'settings', type: :feature do
   before do
-    Setting['some'] = {
-      'first_setting' => 'CCC',
-      'second_setting' => false
-    }
-    Setting['base.first_setting'] = 'AAA'
-    Setting['base.second_setting'] = true
-    Setting['second.first_setting'] = false
-    Setting['second.second_setting'] = 'BBB'
-  end
-
-  let(:initial_some_settings) do
-    {
-      first_setting: 'CCC',
-      second_setting: false
-    }.with_indifferent_access
+    ActiveadminSettingsCached.config.display = {}
   end
 
   shared_examples_for 'render input with value' do |input_value|
@@ -25,112 +11,140 @@ RSpec.describe 'settings', type: :feature, js: true do
     end
   end
 
-  shared_examples_for 'fill and save base settings to db' do
-    it 'saves base settings to db' do
-      fill_in('settings_base.first_setting', with: 'First')
-      uncheck('settings_base.second_setting')
-      fill_in('settings_base.third_setting', with: '100')
-      fill_in('settings_base.four_setting', with: '50.5')
-      fill_in('settings_base.five_setting', with: 'five')
+  context 'all settings page' do
+    before do
+      add_all_setting_resource
+      visit '/admin/settings'
+    end
 
-      submit
+    it_behaves_like 'render input with value', 'AAA'
+    it_behaves_like 'render input with value', 'BBB'
 
-      expect(Setting['base.first_setting']).to eq 'First'
-      expect(Setting['base.second_setting']).to eq false
-      expect(Setting['base.third_setting']).to eq 100
-      expect(Setting['base.four_setting']).to eq 50.5
-      expect(Setting['base.five_setting']).to eq :five
+    it 'groups fields by scope' do
+      expect(page).to have_selector('th', text: 'Base')
+      expect(page).to have_selector('th', text: 'Second')
+    end
+
+    it 'hides readonly fields' do
+      expect(page).not_to have_field('settings_secret')
+    end
+
+    it 'renders field help text' do
+      expect(page).to have_content('Interface language')
+    end
+
+    it 'renders array and hash values' do
+      expect(find_field('settings_admin_emails').value.strip).to eq("a@example.com\nb@example.com")
+      expect(find_field('settings_notification_options').value.strip).to eq('send_all: true')
     end
-  end
 
-  shared_examples_for 'fill and save second settings to db' do
     it 'saves settings to db' do
-      fill_in('settings_second.second_setting', with: 'Awesome second')
-      check('settings_second.first_setting')
+      fill_in('settings_app_name', with: 'App')
+      fill_in('settings_title', with: 'First')
+      uncheck('settings_captcha_enabled')
+      fill_in('settings_user_limit', with: '100')
+      fill_in('settings_tax_rate', with: '50.5')
+      select('de', from: 'settings_default_locale')
+      fill_in('settings_admin_emails', with: "x@example.com\ny@example.com")
+      fill_in('settings_notification_options', with: "send_all: false\nlogging: true")
 
       submit
 
-      expect(Setting['second.second_setting']).to eq 'Awesome second'
-      expect(Setting['second.first_setting']).to eq true
-      expect(Setting.some.with_indifferent_access).to eq(initial_some_settings)
+      expect(page).to have_content('Settings was successfully updated.')
+      expect(Setting.app_name).to eq 'App'
+      expect(Setting.title).to eq 'First'
+      expect(Setting.captcha_enabled).to eq false
+      expect(Setting.user_limit).to eq 100
+      expect(Setting.tax_rate).to eq 50.5
+      expect(Setting.default_locale).to eq 'de'
+      expect(Setting.admin_emails).to eq %w[x@example.com y@example.com]
+      expect(Setting.notification_options).to eq('send_all' => false, 'logging' => true)
     end
-  end
 
-  shared_examples_for 'fill and save some settings to db' do
-    it 'save some settings to db' do
-      fill_in('settings_some.first_setting', with: 'Awesome value')
-      check('settings_some.second_setting')
+    it 'does not persist unchanged values' do
+      fill_in('settings_title', with: 'First')
 
       submit
 
-      expect(Setting['some']['first_setting']).to eq 'Awesome value'
-      expect(Setting['some']['second_setting']).to eq true
+      expect(Setting.pluck(:var)).to eq %w[title]
+    end
+
+    it 'shows validation errors' do
+      fill_in('settings_title', with: 'A' * 11)
+      fill_in('settings_app_name', with: 'App')
+
+      submit
+
+      expect(page).to have_content('Settings were not saved: Title is too long')
+      expect(Setting.title).to eq 'BBB'
+      expect(Setting.app_name).to eq 'App'
     end
   end
 
-  context 'global config' do
+  context 'when settings on different pages' do
     before do
-      ActiveadminSettingsCached.configure do |config|
-        config.display = {
-          'base.first_setting'    => 'string',
-          'base.second_setting'   => 'boolean',
-          'base.third_setting'    => 'number',
-          'base.four_setting'     => 'number',
-          'base.five_setting'     => 'string',
-          'second.first_setting'  => 'boolean',
-          'second.second_setting' => 'string',
-          'some.first_setting'    => 'string',
-          'some.second_setting'   => 'boolean'
-        }
-      end
-
-      add_setting_resource
+      add_base_setting_resource
       add_second_setting_resource
-      add_some_setting_resource
-      add_all_setting_resource
     end
 
-    context 'all setting index' do
-      before { visit '/admin/settings' }
+    context 'base settings page' do
+      before { visit '/admin/base_settings' }
 
-      it_behaves_like 'render input with value', 'AAA'
       it_behaves_like 'render input with value', 'BBB'
 
-      # TODO: fixme
-      # it_behaves_like 'render input with value', Setting['some'].with_indifferent_access
-      it_behaves_like 'fill and save base settings to db'
-      it_behaves_like 'fill and save second settings to db'
+      it 'shows only base fields' do
+        expect(page).to have_field('settings_title')
+        expect(page).not_to have_field('settings_app_name')
+        expect(page).not_to have_field('settings_admin_emails')
+      end
+
+      it 'saves settings to db' do
+        fill_in('settings_title', with: 'Base')
+        check('settings_captcha_enabled')
+        submit
+
+        expect(Setting.title).to eq 'Base'
+        expect(Setting.captcha_enabled).to eq true
+      end
+    end
+
+    context 'second settings page' do
+      before { visit '/admin/second_settings' }
+
+      it 'shows only second fields' do
+        expect(page).to have_field('settings_admin_emails')
+        expect(page).not_to have_field('settings_title')
+      end
+    end
+  end
+
+  context 'with display options' do
+    before do
+      add_all_setting_resource(display: { app_name: :text })
+      visit '/admin/settings'
+    end
+
+    it 'uses display input type' do
+      expect(page).to have_selector('textarea#settings_app_name')
     end
   end
 
   context 'with custom template_object' do
     context 'when right object' do
       before do
-        display_settings = {
-          'base.first_setting'    => 'string',
-          'base.second_setting'   => 'boolean',
-          'base.third_setting'    => 'number',
-          'base.four_setting'     => 'number',
-          'base.five_setting'     => 'string',
-          'second.first_setting'  => 'boolean',
-          'second.second_setting' => 'string'
-        }
-
-        add_all_setting_resource(
-          template_object: ActiveadminSettingsCached::Model.new(display: display_settings)
-        )
-
-        visit '/admin/base_settings'
+        add_all_setting_resource(template_object: ActiveadminSettingsCached::Model.new(scope: :base))
+        visit '/admin/settings'
       end
 
-      it_behaves_like 'render input with value', 'AAA'
+      it_behaves_like 'render input with value', 'BBB'
+
+      it { expect(page).not_to have_field('settings_app_name') }
     end
 
     context 'when wrong object' do
       before do
         add_all_setting_resource(template_object: nil)
-
-        visit '/admin/base_settings'
+        visit '/admin/settings'
       end
 
       it_behaves_like 'render input with value', 'AAA'
@@ -138,136 +152,39 @@ RSpec.describe 'settings', type: :feature, js: true do
   end
 
   describe 'with after_save' do
-    context 'when right object' do
+    context 'when submitted' do
       before do
-        after_save = ->() {}
-        display_settings = {
-          'base.first_setting'    => 'string',
-          'base.second_setting'   => 'boolean',
-          'base.third_setting'    => 'number',
-          'base.four_setting'     => 'number',
-          'base.five_setting'     => 'string',
-          'second.first_setting'  => 'boolean',
-          'second.second_setting' => 'string'
-        }
-
+        after_save = -> {}
         expect(after_save).to receive(:call).and_call_original
 
-        add_some_setting_resource(
-          template_object: ActiveadminSettingsCached::Model.new(display: display_settings),
-          after_save: after_save
-        )
-
-        visit '/admin/some_settings'
-
+        add_base_setting_resource(after_save: after_save)
+        visit '/admin/base_settings'
         submit
       end
 
-      it_behaves_like 'render input with value', 'AAA'
+      it_behaves_like 'render input with value', 'BBB'
     end
 
     context 'when only open' do
       before do
-        after_save = ->() {}
-
+        after_save = -> {}
         expect(after_save).not_to receive(:call)
 
-        add_some_setting_resource(template_object: nil,
-                                  after_save: after_save)
-
-        visit '/admin/some_settings'
+        add_base_setting_resource(after_save: after_save)
+        visit '/admin/base_settings'
       end
 
-      it_behaves_like 'render input with value', 'CCC'
+      it_behaves_like 'render input with value', 'BBB'
     end
 
     context 'when wrong object' do
       before do
-        add_some_setting_resource(template_object: nil,
-                                  after_save: 'some')
-
-        visit '/admin/some_settings'
-      end
-
-      it_behaves_like 'render input with value', 'CCC'
-    end
-  end
-
-  context 'when settings on different pages' do
-    before do
-      ActiveadminSettingsCached.configure do |config|
-        config.display = {}
+        add_base_setting_resource(after_save: 'some')
+        visit '/admin/base_settings'
+        submit
       end
 
-      add_setting_resource(
-        display: {
-          'base.first_setting'  => 'string',
-          'base.second_setting' => 'boolean',
-          'base.third_setting'  => 'number',
-          'base.four_setting'   => 'number',
-          'base.five_setting'   => 'string'
-        }
-      )
-
-      add_second_setting_resource(
-        display: {
-          'second.first_setting'  => 'boolean',
-          'second.second_setting' => 'string'
-        }
-      )
-
-      add_some_setting_resource(
-        display: {
-          'some.first_setting'  => 'string',
-          'some.second_setting' => 'boolean'
-        }
-      )
-
-      add_all_setting_resource(
-        display: {
-          'base.first_setting'    => 'string',
-          'base.second_setting'   => 'boolean',
-          'base.third_setting'    => 'number',
-          'base.four_setting'     => 'number',
-          'base.five_setting'     => 'string',
-          'second.first_setting'  => 'boolean',
-          'second.second_setting' => 'string'
-        }
-      )
-    end
-
-    context 'base settings page' do
-      before { visit '/admin/base_settings' }
-
-      it_behaves_like 'render input with value', 'AAA'
-      it_behaves_like 'fill and save base settings to db'
-    end
-
-    context 'second setting page' do
-      before { visit '/admin/second_settings' }
-
       it_behaves_like 'render input with value', 'BBB'
-      it_behaves_like 'fill and save second settings to db'
-    end
-
-    context 'some setting index' do
-      before { visit '/admin/some_settings' }
-
-      it_behaves_like 'render input with value', 'CCC'
-      it_behaves_like 'fill and save some settings to db'
-    end
-
-    context 'all setting index' do
-      before { visit '/admin/settings' }
-
-      it_behaves_like 'render input with value', 'AAA'
-      it_behaves_like 'render input with value', 'BBB'
-      # FIXME
-      #it_behaves_like 'render input with value', Setting['some'].with_indifferent_access
-
-      it_behaves_like 'fill and save base settings to db'
-      it_behaves_like 'fill and save second settings to db'
-      it { expect(Setting.some.with_indifferent_access).to eq(initial_some_settings) }
     end
   end
 

data/spec/spec_helper.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
 
-require 'database_cleaner'
-
-require 'coveralls'
-Coveralls.wear!
+require 'database_cleaner/active_record'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH << File.expand_path('../support', __FILE__)
 
-ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 require 'bundler'
 Bundler.setup
 
@@ -22,11 +19,6 @@ unless File.exist?(ENV['RAILS_ROOT'])
   system 'rake setup'
 end
 
-require 'active_model'
-# require ActiveRecord to ensure that Ransack loads correctly
-require 'active_record'
-require 'active_admin'
-ActiveAdmin.application.load_paths = [ENV['RAILS_ROOT'] + '/app/admin']
 require ENV['RAILS_ROOT'] + '/config/environment.rb'
 # Disabling authentication in specs so that we don't have to worry about
 # it allover the place
@@ -38,22 +30,6 @@ require 'support/admin'
 require 'capybara/rails'
 require 'capybara/rspec'
 
-unless ENV['CAPYBARA_FIREFOX']
-  require 'capybara/poltergeist'
-
-  Capybara.register_driver :poltergeist do |app|
-    Capybara::Poltergeist::Driver.new(app, {
-        js_errors: true,
-        timeout: 80,
-        debug: true,
-        :phantomjs_options => ['--debug=no', '--load-images=no']
-
-    })
-  end
-
-  Capybara.javascript_driver = :poltergeist
-end
-
 RSpec.configure do |config|
   DatabaseCleaner.strategy = :truncation
 
@@ -63,5 +39,6 @@ RSpec.configure do |config|
 
   config.after(:each) do
     DatabaseCleaner.clean
+    Setting.clear_cache
   end
 end

data/spec/support/admin.rb

@@ -8,21 +8,14 @@ def base_add_resource(options = {}, &block)
   Rails.application.reload_routes!
 end
 
-def add_setting_resource(options = {}, &block)
-  options = { model_name: 'Setting', starting_with: 'base.', title: 'Base Settings',
+def add_base_setting_resource(options = {}, &block)
+  options = { model_name: 'Setting', scope: :base, title: 'Base Settings',
               after_save: -> {} }.merge!(options)
   base_add_resource(options, &block)
 end
 
 def add_second_setting_resource(options = {}, &block)
-  options = { model_name: 'Setting', starting_with: 'second.',
-              title: 'Second Settings' }.merge!(options)
-  base_add_resource(options, &block)
-end
-
-def add_some_setting_resource(options = {}, &block)
-  options = { model_name: 'Setting', title: 'Some Settings', key: 'some',
-              after_save: -> {} }.merge!(options)
+  options = { model_name: 'Setting', scope: :second, title: 'Second Settings' }.merge!(options)
   base_add_resource(options, &block)
 end
 

data/spec/support/rails_template.rb

@@ -1,37 +1,51 @@
 # frozen_string_literal: true
 # Rails template to build the sample app for specs
 
-generate :settings, 'Setting'
-
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-generate :'active_admin:install --skip --skip-users'
-generate :'formtastic:install'
+create_file 'app/assets/config/manifest.js', <<-JS
+//= link_tree ../images
+//= link active_admin.css
+//= link active_admin.js
+JS
+
+generate :'active_admin:install', '--skip-users'
 generate :'settings:install'
 
+# Both generators can create migrations within the same second
+Dir[File.join(destination_root, 'db/migrate/*_create_settings.rb')].each do |file|
+  File.rename(file, file.sub(/\d{14}(?=_create_settings)/) { |version| (version.to_i + 1).to_s })
+end
+
 # Configure Setup
 inject_into_file 'config/initializers/active_admin.rb', <<-RUBY, before: "ActiveAdmin.setup do |config|"
-  ActiveadminSettingsCached.configure do |config|
-    config.model_name = 'Setting'
-  end
+ActiveadminSettingsCached.configure do |config|
+  config.model_name = 'Setting'
+end
+
 RUBY
 
-# Default Settings
-inject_into_file 'config/app.yml', <<-YAML, after: "defaults: &defaults\n"
-  some:
-    first_setting: AAA
-    second_setting: true
-  'base.first_setting': AAA
-  'base.second_setting': true
-  'base.third_setting': 5
-  'base.four_setting': 5.50
-  'base.five_setting': :aaa
-  'base.six_setting': ['a', 'b']
-  'second.first_setting': false
-  'second.second_setting': BBB
-YAML
+create_file 'app/models/setting.rb', <<-RUBY, force: true
+class Setting < RailsSettings::Base
+  field :app_name, default: 'AAA'
+
+  scope :base do
+    field :title, default: 'BBB', validates: { length: { maximum: 10 } }
+    field :captcha_enabled, type: :boolean, default: true
+    field :user_limit, type: :integer, default: 5
+    field :tax_rate, type: :float, default: 5.5
+    field :default_locale, default: 'en', option_values: %w[en de ru], help_text: 'Interface language'
+  end
+
+  scope :second do
+    field :admin_emails, type: :array, default: %w[a@example.com b@example.com]
+    field :notification_options, type: :hash, default: { 'send_all' => true }
+    field :secret, default: 'hidden', readonly: true
+  end
+end
+RUBY
 
 route "root :to => 'admin/dashboard#index'"
 
 rake 'db:migrate'
-rake 'db:test:prepare'
+rake 'db:migrate', env: 'test'

data/tasks/test.rake

@@ -3,20 +3,18 @@
 desc 'Creates a test rails app for the specs to run against'
 task :setup do
   require 'rails/version'
-  if File.exists? dir = "spec/rails/rails-#{Rails::VERSION::STRING}"
+  if File.exist? dir = "spec/rails/rails-#{Rails::VERSION::STRING}"
     puts "test app #{dir} already exists; skipping"
   else
     system 'mkdir -p spec/rails'
 
     args = %w[
       -m\ spec/support/rails_template.rb
-      --skip-gemfile
+      --minimal
       --skip-bundle
       --skip-git
-      --skip-keeps
-      --skip-turbolinks
-      --skip-test-unit
-      --skip-spring
+      --skip-test
+      --skip-asset-pipeline
     ]
 
     system "bundle exec rails new #{dir} #{args.join ' '}"