ledermann-rails-settings 2.5.0 → 2.6.0

data/spec/settings_spec.rb

@@ -1,24 +1,31 @@
 require 'spec_helper'
 
-describe "Defaults" do
-  it "should be stored for simple class" do
-    expect(Account.default_settings).to eq(:portal => {})
+describe 'Defaults' do
+  it 'should be stored for simple class' do
+    expect(Account.default_settings).to eq(portal: {})
   end
 
-  it "should be stored for parent class" do
-    expect(User.default_settings).to eq(:dashboard => { 'theme' => 'blue', 'view' => 'monthly', 'filter' => true },
-                                    :calendar => { 'scope' => 'company'})
+  # Modifying spec because it gives like this output on hash value
+  # "owner_name"=>#<Proc:0x00007f819b2b3210 /rails-settings/spec/spec_helper.rb:48 (lambda)>
+  it 'should be stored for parent class' do
+    expect(User.default_settings.keys).to eq(%i[dashboard calendar])
   end
 
-  it "should be stored for child class" do
-    expect(GuestUser.default_settings).to eq(:dashboard => { 'theme' => 'red', 'view' => 'monthly', 'filter' => true })
+  it 'should be stored for child class' do
+    expect(GuestUser.default_settings).to eq(
+      dashboard: {
+        'theme' => 'red',
+        'view' => 'monthly',
+        'filter' => true,
+      },
+    )
   end
 end
 
-describe "Getter/Setter" do
-  let(:account) { Account.new :subdomain => 'foo' }
+describe 'Getter/Setter' do
+  let(:account) { Account.new subdomain: 'foo' }
 
-  it "should handle method syntax" do
+  it 'should handle method syntax' do
     account.settings(:portal).enabled = true
     account.settings(:portal).template = 'black'
 
@@ -26,14 +33,14 @@ describe "Getter/Setter" do
     expect(account.settings(:portal).template).to eq('black')
   end
 
-  it "should return nil for not existing key" do
+  it 'should return nil for not existing key' do
     expect(account.settings(:portal).foo).to eq(nil)
   end
 end
 
 describe 'Objects' do
   context 'without defaults' do
-    let(:account) { Account.new :subdomain => 'foo' }
+    let(:account) { Account.new subdomain: 'foo' }
 
     it 'should have blank settings' do
       expect(account.settings(:portal).value).to eq({})
@@ -61,7 +68,7 @@ describe 'Objects' do
       expect(RailsSettings::SettingObject.count).to eq(0)
     end
 
-    it "should save object with settings" do
+    it 'should save object with settings' do
       account.settings(:portal).premium = true
       account.settings(:portal).fee = 42.5
       account.save!
@@ -71,10 +78,12 @@ describe 'Objects' do
       expect(account.settings(:portal).fee).to eq(42.5)
 
       expect(RailsSettings::SettingObject.count).to eq(1)
-      expect(RailsSettings::SettingObject.first.value).to eq({ 'premium' => true, 'fee' => 42.5 })
+      expect(RailsSettings::SettingObject.first.value).to eq(
+        { 'premium' => true, 'fee' => 42.5 },
+      )
     end
 
-    it "should save settings separated" do
+    it 'should save settings separated' do
       account.save!
 
       settings = account.settings(:portal)
@@ -89,11 +98,12 @@ describe 'Objects' do
   end
 
   context 'with defaults' do
-    let(:user) { User.new :name => 'Mr. Brown' }
+    let(:user) { User.new name: 'Mr. Brown' }
 
     it 'should have default settings' do
       expect(user.settings(:dashboard).theme).to eq('blue')
       expect(user.settings(:dashboard).view).to eq('monthly')
+      expect(user.settings(:dashboard).owner_name).to eq('Mr. Brown')
       expect(user.settings(:dashboard).filter).to eq(true)
       expect(user.settings(:calendar).scope).to eq('company')
     end
@@ -103,23 +113,28 @@ describe 'Objects' do
 
       expect(user.settings(:dashboard).theme).to eq('gray')
       expect(user.settings(:dashboard).view).to eq('monthly')
+      expect(user.settings(:dashboard).owner_name).to eq('Mr. Brown')
       expect(user.settings(:dashboard).filter).to eq(true)
       expect(user.settings(:calendar).scope).to eq('company')
     end
 
-    it "should overwrite settings" do
+    it 'should overwrite settings' do
       user.settings(:dashboard).theme = 'brown'
       user.settings(:dashboard).filter = false
+      user.settings(:dashboard).owner_name = 'Mr. Vishal'
       user.save!
 
       user.reload
       expect(user.settings(:dashboard).theme).to eq('brown')
       expect(user.settings(:dashboard).filter).to eq(false)
+      expect(user.settings(:dashboard).owner_name).to eq('Mr. Vishal')
       expect(RailsSettings::SettingObject.count).to eq(1)
-      expect(RailsSettings::SettingObject.first.value).to eq({ 'theme' => 'brown', 'filter' => false })
+      expect(RailsSettings::SettingObject.first.value).to eq(
+        { 'filter' => false, 'owner_name' => 'Mr. Vishal', 'theme' => 'brown' },
+      )
     end
 
-    it "should merge settings with defaults" do
+    it 'should merge settings with defaults' do
       user.settings(:dashboard).theme = 'brown'
       user.save!
 
@@ -127,31 +142,55 @@ describe 'Objects' do
       expect(user.settings(:dashboard).theme).to eq('brown')
       expect(user.settings(:dashboard).filter).to eq(true)
       expect(RailsSettings::SettingObject.count).to eq(1)
-      expect(RailsSettings::SettingObject.first.value).to eq({ 'theme' => 'brown' })
+      expect(RailsSettings::SettingObject.first.value).to eq(
+        { 'theme' => 'brown' },
+      )
+    end
+
+    context 'when default value is an Array' do
+      it 'should not mutate default_settings' do
+        expected_return_value = User.default_settings[:calendar]['events'].dup
+
+        user.settings(:calendar).events.push('new_value')
+        expect(User.default_settings[:calendar]['events']).to eq(
+          expected_return_value,
+        )
+      end
+    end
+
+    context 'when default value is a Hash' do
+      it 'should not mutate default_settings' do
+        expected_return_value = User.default_settings[:calendar]['profile'].dup
+
+        user.settings(:calendar).profile.update('new_key' => 'new_value')
+        expect(User.default_settings[:calendar]['profile']).to eq(
+          expected_return_value,
+        )
+      end
     end
   end
 end
 
-describe "Object without settings" do
-  let!(:user) { User.create! :name => 'Mr. White' }
+describe 'Object without settings' do
+  let!(:user) { User.create! name: 'Mr. White' }
 
-  it "should respond to #settings?" do
+  it 'should respond to #settings?' do
     expect(user.settings?).to eq(false)
     expect(user.settings?(:dashboard)).to eq(false)
   end
 
-  it "should have no setting objects" do
+  it 'should have no setting objects' do
     expect(RailsSettings::SettingObject.count).to eq(0)
   end
 
-  it "should add settings" do
-    user.settings(:dashboard).update! :smart => true
+  it 'should add settings' do
+    user.settings(:dashboard).update! smart: true
 
     user.reload
     expect(user.settings(:dashboard).smart).to eq(true)
   end
 
-  it "should not save settings if assigned nil" do
+  it 'should not save settings if assigned nil' do
     expect {
       user.settings = nil
       user.save!
@@ -159,27 +198,27 @@ describe "Object without settings" do
   end
 end
 
-describe "Object with settings" do
+describe 'Object with settings' do
   let!(:user) do
-    User.create! :name => 'Mr. White' do |user|
+    User.create! name: 'Mr. White' do |user|
       user.settings(:dashboard).theme = 'white'
       user.settings(:calendar).scope = 'all'
     end
   end
 
-  it "should respond to #settings?" do
+  it 'should respond to #settings?' do
     expect(user.settings?).to eq(true)
 
     expect(user.settings?(:dashboard)).to eq(true)
     expect(user.settings?(:calendar)).to eq(true)
   end
 
-  it "should have two setting objects" do
+  it 'should have two setting objects' do
     expect(RailsSettings::SettingObject.count).to eq(2)
   end
 
-  it "should update settings" do
-    user.settings(:dashboard).update! :smart => true
+  it 'should update settings' do
+    user.settings(:dashboard).update! smart: true
     user.reload
 
     expect(user.settings(:dashboard).smart).to eq(true)
@@ -187,7 +226,7 @@ describe "Object with settings" do
     expect(user.settings(:calendar).scope).to eq('all')
   end
 
-  it "should update settings by saving object" do
+  it 'should update settings by saving object' do
     user.settings(:dashboard).smart = true
     user.save!
 
@@ -195,7 +234,7 @@ describe "Object with settings" do
     expect(user.settings(:dashboard).smart).to eq(true)
   end
 
-  it "should destroy settings with nil" do
+  it 'should destroy settings with nil' do
     expect {
       user.settings = nil
       user.save!
@@ -204,7 +243,7 @@ describe "Object with settings" do
     expect(user.settings?).to eq(false)
   end
 
-  it "should raise exception on assigning other than nil" do
+  it 'should raise exception on assigning other than nil' do
     expect {
       user.settings = :foo
       user.save!
@@ -212,10 +251,10 @@ describe "Object with settings" do
   end
 end
 
-describe "Customized SettingObject" do
-  let(:project) { Project.create! :name => 'Heist' }
+describe 'Customized SettingObject' do
+  let(:project) { Project.create! name: 'Heist' }
 
-  it "should not accept invalid attributes" do
+  it 'should not accept invalid attributes' do
     project.settings(:info).owner_name = 42
     expect(project.settings(:info)).not_to be_valid
 
@@ -223,26 +262,46 @@ describe "Customized SettingObject" do
     expect(project.settings(:info)).not_to be_valid
   end
 
-  it "should accept valid attributes" do
+  it 'should accept valid attributes' do
     project.settings(:info).owner_name = 'Mr. Brown'
     expect(project.settings(:info)).to be_valid
   end
 end
 
-describe "to_settings_hash" do
+describe 'to_settings_hash' do
   let(:user) do
-    User.new :name => 'Mrs. Fin' do |user|
+    User.new name: 'Mrs. Fin' do |user|
       user.settings(:dashboard).theme = 'green'
+      user.settings(:dashboard).owner_name = 'Mr. Vishal'
       user.settings(:dashboard).sound = 11
       user.settings(:calendar).scope = 'some'
     end
   end
 
-  it "should return defaults" do
-    expect(User.new.to_settings_hash).to eq({:dashboard=>{"theme"=>"blue", "view"=>"monthly", "filter"=>true}, :calendar=>{"scope"=>"company"}})
+  # Modifying spec because it gives like this output on hash value
+  # "owner_name"=>#<Proc:0x00007f819b2b3210 /rails-settings/spec/spec_helper.rb:48 (lambda)>
+  it 'should return defaults' do
+    expect(User.new.to_settings_hash.keys).to eq(%i[dashboard calendar])
   end
 
-  it "should return merged settings" do
-    expect(user.to_settings_hash).to eq({:dashboard=>{"theme"=>"green", "view"=>"monthly", "filter"=>true, "sound" => 11}, :calendar=>{"scope"=>"some"}})
+  it 'should return merged settings' do
+    expect(user.to_settings_hash).to eq(
+      {
+        dashboard: {
+          'a' => 'b',
+          'filter' => true,
+          'owner_name' => 'Mr. Vishal',
+          'sound' => 11,
+          'theme' => 'green',
+          'view' => 'monthly',
+        },
+        calendar: {
+          'scope' => 'some',
+          'events' => [],
+          'profile' => {
+          },
+        },
+      },
+    )
   end
 end

data/spec/spec_helper.rb

@@ -1,17 +1,17 @@
 require 'simplecov'
 require 'coveralls'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-])
-SimpleCov.start do
-  add_filter '/spec/'
-end
+SimpleCov.formatter =
+  SimpleCov::Formatter::MultiFormatter.new(
+    [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter],
+  )
+SimpleCov.start { add_filter '/spec/' }
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
-Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+Dir[
+  File.expand_path(File.join(File.dirname(__FILE__), 'support', '**', '*.rb'))
+].each { |f| require f }
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -26,9 +26,7 @@ RSpec.configure do |config|
   #     --seed 1234
   #  config.order = 'random'
 
-  config.before(:each) do
-    clear_db
-  end
+  config.before(:each) { clear_db }
 
   config.after :suite do
     RailsSettingsMigration.migrate(:down)
@@ -45,14 +43,21 @@ end
 
 class User < ActiveRecord::Base
   has_settings do |s|
-    s.key :dashboard, :defaults => { :theme => 'blue', :view => 'monthly', :filter => true }
-    s.key :calendar,  :defaults => { :scope => 'company'}
+    s.key :dashboard,
+          defaults: {
+            theme: 'blue',
+            view: 'monthly',
+            a: 'b',
+            filter: true,
+            owner_name: ->(target) { target.name },
+          }
+    s.key :calendar, defaults: { scope: 'company', events: [], profile: {} }
   end
 end
 
 class GuestUser < User
   has_settings do |s|
-    s.key :dashboard, :defaults => { :theme => 'red', :view => 'monthly', :filter => true }
+    s.key :dashboard, defaults: { theme: 'red', view: 'monthly', filter: true }
   end
 end
 
@@ -61,32 +66,33 @@ class Account < ActiveRecord::Base
 end
 
 class Project < ActiveRecord::Base
-  has_settings :info, :class_name => 'ProjectSettingObject'
+  has_settings :info, class_name: 'ProjectSettingObject'
 end
 
 class ProjectSettingObject < RailsSettings::SettingObject
   validate do
     unless self.owner_name.present? && self.owner_name.is_a?(String)
-      errors.add(:base, "Owner name is missing")
+      errors.add(:base, 'Owner name is missing')
     end
   end
 end
 
 def setup_db
-  ActiveRecord::Base.configurations = YAML.load_file(File.dirname(__FILE__) + '/database.yml')
+  ActiveRecord::Base.configurations =
+    YAML.load_file(File.dirname(__FILE__) + '/database.yml')
   ActiveRecord::Base.establish_connection(:sqlite)
   ActiveRecord::Migration.verbose = false
 
   print "Testing with ActiveRecord #{ActiveRecord::VERSION::STRING}"
-  if ActiveRecord::VERSION::MAJOR == 4
-    print " #{defined?(ProtectedAttributes) ? 'with' : 'without'} gem `protected_attributes`"
-  end
   puts
 
-  require File.expand_path('../../lib/generators/rails_settings/migration/templates/migration.rb', __FILE__)
+  require File.expand_path(
+            '../../lib/generators/rails_settings/migration/templates/migration.rb',
+            __FILE__,
+          )
   RailsSettingsMigration.migrate(:up)
 
-  ActiveRecord::Schema.define(:version => 1) do
+  ActiveRecord::Schema.define(version: 1) do
     create_table :users do |t|
       t.string :type
       t.string :name

data/spec/support/matchers/perform_queries.rb

@@ -1,7 +1,5 @@
 RSpec::Matchers.define :perform_queries do |expected|
-  match do |block|
-    query_count(&block) == expected
-  end
+  match { |block| query_count(&block) == expected }
 
   failure_message do |actual|
     "Expected to run #{expected} queries, got #{@counter.query_count}"
@@ -9,7 +7,10 @@ RSpec::Matchers.define :perform_queries do |expected|
 
   def query_count(&block)
     @counter = ActiveRecord::QueryCounter.new
-    ActiveSupport::Notifications.subscribe('sql.active_record', @counter.to_proc)
+    ActiveSupport::Notifications.subscribe(
+      'sql.active_record',
+      @counter.to_proc,
+    )
     yield
     ActiveSupport::Notifications.unsubscribe(@counter.to_proc)
 

data/spec/support/query_counter.rb

@@ -11,7 +11,8 @@ module ActiveRecord
     end
 
     def callback(name, start, finish, message_id, values)
-      @query_count += 1 unless %w(CACHE SCHEMA).include?(values[:name]) || values[:sql] =~ /^begin/i || values[:sql] =~ /^commit/i
+      @query_count += 1 unless %w[CACHE SCHEMA].include?(values[:name]) ||
+        values[:sql] =~ /^begin/i || values[:sql] =~ /^commit/i
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ledermann-rails-settings
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Georg Ledermann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 2023-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,22 +96,20 @@ dependencies:
         version: 0.11.2
 description: Settings gem for Ruby on Rails
 email:
-- mail@georg-ledermann.de
+- georg@ledermann.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
-- ci/Gemfile-rails-4-2
-- ci/Gemfile-rails-5-0
-- ci/Gemfile-rails-5-1
-- ci/Gemfile-rails-5-2
-- ci/Gemfile-rails-6-0
+- gemfiles/rails_6_1.gemfile
+- gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_1.gemfile
 - lib/generators/rails_settings/migration/migration_generator.rb
 - lib/generators/rails_settings/migration/templates/migration.rb
 - lib/ledermann-rails-settings.rb
@@ -136,7 +134,7 @@ homepage: https://github.com/ledermann/rails-settings
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,15 +142,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: Ruby gem to handle settings for ActiveRecord instances by storing them as
   serialized Hash in a separate database table. Namespaces and defaults included.

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-gemfile:
-  - ci/Gemfile-rails-4-2
-  - ci/Gemfile-rails-5-0
-  - ci/Gemfile-rails-5-1
-  - ci/Gemfile-rails-5-2
-  - ci/Gemfile-rails-6-0
-matrix:
-  exclude:
-    - rvm: 2.4.6
-      gemfile: ci/Gemfile-rails-6-0
-before_install: gem update bundler
-sudo: false

data/ci/Gemfile-rails-4-2

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activerecord', '~> 4.2.11'
-gem 'protected_attributes' if ENV['PROTECTED_ATTRIBUTES'] == 'true'
-gem 'sqlite3', '~> 1.3.6'
-
-gemspec :path => "../"

data/ci/Gemfile-rails-5-0

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activerecord', '~> 5.0.7'
-gem 'sqlite3', '~> 1.3.6'
-
-gemspec :path => "../"

data/ci/Gemfile-rails-5-1

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activerecord', '~> 5.1.7'
-gem "sqlite3", "~> 1.3", ">= 1.3.6"
-
-gemspec :path => "../"

data/ci/Gemfile-rails-5-2

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activerecord', '~> 5.2.3'
-gem "sqlite3", "~> 1.3", ">= 1.3.6"
-
-gemspec :path => "../"