thecore_settings 1.1.15 → 2.0.5

data/spec/advanced_usage_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Settings advanced usage' do
+  it 'with defaults' do
+    s = Settings.email(default: 'test@example.com')
+    expect(s).to eq 'test@example.com'
+    expect(Settings.get(:email).to_s).to eq 'test@example.com'
+  end
+end

data/spec/carrierwave_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe "Uploads" do
+  if Settings.file_uploads_engine != :carrierwave
+    pending "paperclip not detected, skipped. To run use UPLOADS=carrierwave rspec"
+  else
+    before :each do
+      f = "#{File.dirname(__FILE__)}/../uploads/1024x768.gif"
+      if File.file?(f)
+        File.unlink(f)
+      end
+    end
+    it 'supports file kind' do
+      Settings.set('file', File.open("#{File.dirname(__FILE__)}/support/1024x768.gif"), kind: 'file')
+
+      # because we're not inside Rails
+      Settings.get(:file).file.root = '/'
+
+      expect(Settings.get(:file).file.file.file).to eq "#{File.dirname(__FILE__).gsub('/spec', '/')}uploads/1024x768.gif"
+
+      expect(File.exists?(Settings.root_file_path.join("uploads/1024x768.gif"))).to be_truthy
+    end
+
+    it 'supports image kind' do
+      Settings.set('file', File.open("#{File.dirname(__FILE__)}/support/1024x768.gif"), kind: 'image')
+
+      # because we're not inside Rails
+      Settings.get(:file).file.root = '/'
+
+      expect(Settings.get(:file).file.file.file).to eq "#{File.dirname(__FILE__).gsub('/spec', '/')}uploads/1024x768.gif"
+
+      expect(File.exists?(Settings.root_file_path.join("uploads/1024x768.gif"))).to be_truthy
+    end
+
+    it 'supports defaults' do
+      Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults_w_file.yml'))
+      expect(File.exists?(Settings.root_file_path.join("uploads/1024x768.gif"))).to be_truthy
+    end
+  end
+end
+

data/spec/database_trickery_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+# this tests check how well thecore_settings handles settings disappearing from DB during execution
+# real usage: app specs with database_cleaner enabled
+describe 'Database trickery' do
+
+  it "should handle settings disappearing from DB" do
+    email = "my@mail.ru"
+    email2 = "my2@mail.ru"
+    Settings.email = email
+    expect(Settings.email).to eq(email)
+    ThecoreSettings::Setting.destroy_all
+    # settings are still cached
+    expect(Settings.email).to eq(email)
+
+    Settings.email = email2
+    expect(Settings.email).to eq(email2)
+  end
+
+  it "should handle settings appearing in DB when settings are loaded" do
+    expect(Settings.tst2).to eq('')
+    ThecoreSettings::Setting.create!(key: 'tst', raw: 'tst')
+    # settings are still cached, but when we try to create a setting it sees updated value in DB
+    expect(Settings.tst).to eq('tst')
+  end
+
+  it "should handle settings appearing in DB when settings are not loaded" do
+    ThecoreSettings::Setting.create(key: 'tst', raw: 'tst')
+    Settings.tst = 'str'
+    expect(Settings.tst).to eq('str')
+  end
+
+  it "#destroy_all!" do
+    Settings.tst = 'str'
+    Settings.destroy_all!
+    expect(Settings.tst).to eq('')
+  end
+
+  it "#destroy!" do
+    Settings.tst = 'str'
+    Settings.tst2 = 'str2'
+    Settings.destroy!(:tst)
+    expect(Settings.tst).to eq('')
+    expect(Settings.tst2).to eq('str2')
+  end
+end

data/spec/defaults_spec.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Settings loading defaults' do
+  before :each do
+    Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults.yml'))
+  end
+
+  it 'loads twice ok' do
+    Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults.yml'))
+    Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults.yml'))
+  end
+
+  it 'sets value' do
+    expect(Settings.footer).to eq 'test <b></b>'
+    expect(Settings.get(:footer).kind).to eq 'html'
+  end
+
+  it 'sets kind' do
+    expect(Settings.get(:phone).phone_kind?).to be_truthy
+    expect(Settings.get(:phone).val.city).to eq '906'
+    expect(Settings.get(:phone).val.formatted_subscriber).to eq '111-11-11'
+  end
+
+  it 'sets enabled' do
+    expect(Settings.phone_enabled?).to eq true
+    expect(Settings.disabled_enabled?).to eq false
+    expect(Settings.enabled?(:disabled)).to eq false
+  end
+
+  it 'works with namespace' do
+    expect(Settings.ns(:main).phone).to eq '906 1111111'
+    expect(Settings.ns(:other).footer).to eq 'zzz'
+    expect(Settings.footer).to eq 'test <b></b>'
+    expect(Settings.ns(:main).footer).to eq 'test <b></b>'
+  end
+
+  it 'works with fallback' do
+    expect(Settings.ns(:etc, fallback: :main).phone).to eq '906 1111111'
+    expect(Settings.ns(:etc, fallback: :main).footer).to eq 'test <b></b>'
+    expect(Settings.ns(:other, fallback: :main).footer).to eq 'zzz'
+    expect(Settings.ns(:etc, fallback: :other).footer).to eq 'zzz'
+  end
+
+  it 'works with custom default namespace' do
+    Settings.ns_default = 'other'
+    Settings.ns_fallback = 'other'
+
+    expect(Settings.ns(:main).phone).to eq '906 1111111'
+    expect(Settings.ns(:other).footer).to eq 'zzz'
+    expect(Settings.ns(:main).footer).to eq 'test <b></b>'
+    expect(Settings.footer).to eq 'zzz'
+
+    expect(Settings.ns(:main).phone).to eq '906 1111111'
+    expect(Settings.ns(:main).true_setting).to be true
+    expect(Settings.ns(:main).false_setting).to be false
+    expect(Settings.ns(:other).footer).to eq 'zzz'
+    expect(Settings.ns(:main).footer).to eq 'test <b></b>'
+    expect(Settings.footer).to eq 'zzz'
+
+    expect(Settings.ns(:etc, fallback: :main).phone).to eq '906 1111111'
+    expect(Settings.ns(:etc, fallback: :main).footer).to eq 'test <b></b>'
+    expect(Settings.ns(:other, fallback: :main).footer).to eq 'zzz'
+    expect(Settings.ns(:etc, fallback: :other).footer).to eq 'zzz'
+
+    Settings.ns_default = :etc
+    Settings.ns_fallback = :main
+    expect(Settings.phone).to eq '906 1111111'
+    expect(Settings.footer).to eq 'test <b></b>'
+
+    Settings.ns_fallback = :other
+    expect(Settings.footer).to eq 'zzz'
+
+    Settings.ns_default = :other
+    Settings.ns_fallback = :main
+    expect(Settings.footer).to eq 'zzz'
+  end
+
+  it "doesn't overwrite" do
+    Settings.ns(:main).phone = '906 2222222'
+    Settings.ns(:other).footer = 'xxx'
+    Settings.apply_defaults!(File.join(File.dirname(__FILE__), 'support/defaults.yml'))
+    expect(Settings.ns(:main).phone).to eq '906 2222222'
+    expect(Settings.ns(:other).footer).to eq 'xxx'
+  end
+end

data/spec/enabling_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Settings enabling and disabling' do
+  it 'works for name_enabled? and name_enabled =' do
+    Settings.zzz = '123'
+    expect(Settings.zzz).to eq '123'
+    expect(Settings.get(:zzz).enabled).to eq true
+    expect(Settings.enabled?(:zzz)).to eq true
+    expect(Settings.zzz_enabled?).to eq true
+
+    expect(Settings.zzz).to eq '123'
+    Settings.zzz_enabled = false
+    expect(Settings.zzz_enabled?).to eq false
+    expect(Settings.get(:zzz).enabled).to eq false
+    expect(Settings.enabled?(:zzz)).to eq false
+    expect(Settings.zzz).to eq ''
+    Settings.unload!
+    expect(Settings.zzz).to eq ''
+    expect(Settings.get(:zzz).raw).to eq '123'
+
+    Settings.zzz_enabled = true
+    expect(Settings.zzz).to eq '123'
+    expect(Settings.zzz_enabled?).to eq true
+    expect(Settings.get(:zzz).enabled).to eq true
+    expect(Settings.enabled?(:zzz)).to eq true
+  end
+end

data/spec/factories/setting.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+FactoryBot.define do
+  factory :setting, class: ThecoreSettings::Setting do
+    sequence(:key){|n| "setting_#{n}" }
+    raw { "Контент 1" }
+  end
+end

data/spec/label_spec.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Settings label' do
+  it "should have label" do
+    label = "E-Mail"
+    Settings.email(label: label, default: "my@mail.ru")
+    expect(Settings.get(:email).name).to eq(label)
+  end
+
+  it "should properly set label as key if blank" do
+    Settings.email(default: "my@mail.ru")
+    expect(Settings.get(:email).name).to eq('email')
+  end
+end

data/spec/migration_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Migrating from old versions' do
+  it 'sets ns' do
+    coll = ThecoreSettings::Setting.collection
+    if coll.respond_to?(:insert_one)
+      coll.insert_one({enabled: true, key: 'test', raw: '9060000000', type: 'phone'})
+    else
+      coll.insert({enabled: true, key: 'test', raw: '9060000000', type: 'phone'})
+    end
+    ThecoreSettings.migrate!
+    expect(ThecoreSettings::Setting.first.key).to eq 'test'
+    expect(ThecoreSettings::Setting.first.raw).to eq '9060000000'
+    expect(ThecoreSettings::Setting.first.ns).to eq 'main'
+    expect(ThecoreSettings::Setting.first.kind).to eq 'phone'
+  end
+end
+

data/spec/model_spec.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe ThecoreSettings::Setting do
+  it { is_expected.to have_fields(:enabled, :key, :kind, :raw) }
+
+  it "correctly return content when enabled" do
+    setting = FactoryBot.create(:setting)
+    expect(setting.to_s).to eq "Контент 1"
+  end
+
+  it "return empty string when disabled" do
+    setting = FactoryBot.create(:setting, enabled: false)
+    expect(setting.to_s).to eq ""
+  end
+
+  it "correctly process {{year}}" do
+    setting = FactoryBot.create(:setting, raw: '© {{year}} company')
+    expect(setting.val).to eq "© #{Time.now.strftime('%Y')} company"
+  end
+
+  it "correctly process {{year|2010}}" do
+    setting = FactoryBot.create(:setting, raw: '© {{year|2010}} company')
+    expect(setting.val).to eq "© 2010-#{Time.now.strftime('%Y')} company"
+  end
+
+  it "correctly process {{year|current_year}}" do
+    setting = FactoryBot.create(:setting, raw: '© {{year|' + Time.now.strftime('%Y') + '}} company')
+    expect(setting.val).to eq "© #{Time.now.strftime('%Y')} company"
+    expect(setting.val.class.name).not_to eq "ActiveSupport::SafeBuffer"
+  end
+
+  it 'return html_safe string when in html mode' do
+    setting = FactoryBot.create(:setting, raw: '© {{year}} company', kind: 'html')
+    expect(setting.val).to eq "© #{Time.now.strftime('%Y')} company"
+    expect(setting.val.class.name).to eq "ActiveSupport::SafeBuffer"
+  end
+
+  it 'sanitize html when in sanitized mode' do
+    setting = FactoryBot.create(:setting, raw: '&copy; {{year}} company <a href="javascript:alert()">test</a>', kind: 'sanitized')
+    expect(setting.val).to eq "© #{Time.now.strftime('%Y')} company <a>test</a>"
+    expect(setting.val.class.name).to eq "ActiveSupport::SafeBuffer"
+  end
+
+  it 'sanitize html when in sanitize mode' do
+    if defined?(Rails)
+      setting = FactoryBot.create(:setting, raw: '&copy; {{year}} company <a href="javascript:alert()">test</a>', kind: 'sanitize')
+      expect(setting.val).to eq "© #{Time.now.strftime('%Y')} company <a>test</a>"
+      expect(setting.val.class.name).to eq "ActiveSupport::SafeBuffer"
+    else
+      expect {
+        FactoryBot.create(:setting, raw: '&copy; {{year}} company <a href="javascript:alert()">test</a>', kind: 'sanitize')
+      }.to raise_error(ThecoreSettings::NoRailsError)
+    end
+  end
+
+  it 'sanitize html when in sanitize_code mode' do
+    if defined?(Rails)
+      setting = FactoryBot.create(:setting, raw: '&copy; {{year}} company <a href="javascript:alert()">test</a>', kind: 'sanitize_code')
+      expect(setting.val).to eq "© #{Time.now.strftime('%Y')} company <a>test</a>"
+      expect(setting.val.class.name).to eq "ActiveSupport::SafeBuffer"
+    else
+      expect {
+        FactoryBot.create(:setting, raw: '&copy; {{year}} company <a href="javascript:alert()">test</a>', kind: 'sanitize_code')
+      }.to raise_error(ThecoreSettings::NoRailsError)
+    end
+  end
+
+  it 'remove html when in strip_tags mode' do
+    if defined?(Rails)
+      setting = FactoryBot.create(:setting, raw: '&copy; {{year}} company <a href="javascript:alert()">test</a>', kind: 'strip_tags')
+      expect(setting.val).to eq "© #{Time.now.strftime('%Y')} company test"
+      expect(setting.val.class.name).to eq "ActiveSupport::SafeBuffer"
+    else
+      expect {
+        FactoryBot.create(:setting, raw: '&copy; {{year}} company <a href="javascript:alert()">test</a>', kind: 'strip_tags')
+      }.to raise_error(ThecoreSettings::NoRailsError)
+    end
+  end
+
+  it 'formats text and cleans html in simple_format mode' do
+    if defined?(Rails)
+      setting = FactoryBot.create(:setting, raw: "&copy; {{year}}\n\ncompany <a href='javascript:alert()'>test</a>", kind: 'simple_format')
+      expect(setting.val).to eq "<p>© #{Time.now.strftime('%Y')}</p>\n\n<p>company <a>test</a></p>"
+      expect(setting.val.class.name).to eq "ActiveSupport::SafeBuffer"
+    else
+      expect {
+        FactoryBot.create(:setting, raw: "&copy; {{year}}\n\ncompany <a href='javascript:alert()'>test</a>", kind: 'simple_format')
+      }.to raise_error(ThecoreSettings::NoRailsError)
+    end
+  end
+
+  it 'formats text and DOESNT html in simple_format_raw mode' do
+    if defined?(Rails)
+      setting = FactoryBot.create(:setting, raw: "&copy; {{year}}\n\ncompany <a href='javascript:alert()'>test</a>", kind: 'simple_format_raw')
+      expect(setting.val).to eq "<p>&copy; #{Time.now.strftime('%Y')}</p>\n\n<p>company <a href='javascript:alert()'>test</a></p>"
+      expect(setting.val.class.name).to eq "ActiveSupport::SafeBuffer"
+    else
+      expect {
+        FactoryBot.create(:setting, raw: "&copy; {{year}}\n\ncompany <a href='javascript:alert()'>test</a>", kind: 'simple_format_raw')
+      }.to raise_error(ThecoreSettings::NoRailsError)
+    end
+  end
+end

data/spec/namespaced_spec.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe 'Namespaced settings' do
+  before :each do 
+   Settings.destroy_all!
+  end
+
+  it 'sets namespaced' do
+    Settings.ns(:other).test = 'test'
+  end
+
+  it 'reads namespaced from cache' do
+    ns = Settings.ns(:other)
+    ns.test = 'test'
+    expect(ns.test).to eq 'test'
+  end
+
+  it 'reads namespaced from db' do
+    Settings.ns(:other).test = 'test'
+    expect(Settings.ns(:other).test).to eq 'test'
+  end
+
+  it 'destroys' do
+    Settings.ns(:other).test = 'test'
+    Settings.ns(:other).destroy_all!
+    expect(Settings.ns(:other).test).to eq ''
+  end
+
+  it 'sets kind' do
+    expect {
+      Settings.ns(:other).set(:phone, 'test', kind: 'phone')
+    }.to raise_error
+    Settings.ns(:other).set(:phone, '906 111 11 11', kind: 'phone')
+    expect(Settings.get(:phone, ns: 'other').phone_kind?).to be_truthy
+    expect(Settings.get(:phone, ns: 'other').val.city).to eq '906'
+    expect(Settings.get(:phone, ns: 'other').val.formatted_subscriber).to eq '111-11-11'
+
+    ns = Settings.ns(:other)
+    expect(ns.get(:phone).phone_kind?).to be_truthy
+    expect(ns.get(:phone).val.city).to eq '906'
+    expect(ns.get(:phone).val.formatted_subscriber).to eq '111-11-11'
+  end
+
+  it 'works with custom defaults' do
+    Settings.ns_default = 'hitfood'
+    Settings.ns_fallback = 'main'
+    expect(Settings.test).to eq ''
+    Settings.test = 'zzz'
+    expect(Settings.get(:test, ns: 'hitfood').raw).to eq 'zzz'
+    expect(Settings.get(:test, ns: 'main').raw).to eq ''
+  end
+
+  it 'falls back to default ns' do
+    Settings.ns_default = 'main'
+    Settings.ns_fallback = 'main'
+
+    Settings.ns(:main).test = 'main'
+    Settings.ns(:other).test = 'other'
+
+    expect(Settings.ns('main').test).to eq 'main'
+    expect(Settings.ns('other').test).to eq 'other'
+    expect(Settings.ns('other1').test).to eq 'main'
+    expect(Settings.ns('other2', fallback: nil).test).to eq ''
+  end
+end