ledermann-rails-settings 2.4.3 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54028088f04ee8257a762eb477193f71f0e04b3c6a8eddcbc573c8af673dfeb9
-  data.tar.gz: 6a7de3c087fa34df61adf6e507763fc614ee3f2e7ee76071aacb1feeff8dfba9
+  metadata.gz: 525e4533dc661bea55c6e6803a14e977041d3028f84c9242a3507f8056caa6a4
+  data.tar.gz: 79f1e5eb504fba6da95b7f3b1d13576851de5e45be5cb1aad941f6a69b025ba9
 SHA512:
-  metadata.gz: d39055f26f4772b7195a58f715948ded863581fbc5801bd05439964fa5ea2cf8b50b59f9947ded0ee01ccfd93e7170fe0951cb24155c4474f4e42cb8fdfaef5c
-  data.tar.gz: 9594e0e206154db02d57ddcdc14088b678b4bb5c128940da0ac61b59145de372fcd915f7242c87cf6785d63c7f96f96e4623259fdb227842d5d11d2ed957e43c
+  metadata.gz: 642b112d09ca8c17ac941e7423b35c1bd03d686604219cb0c9f96f7e18791ed2fdf55c98ab4f0e0204aa0a85730968420e5726e82ef663797643c75605410b4e
+  data.tar.gz: 1582f37a35eb83b9bba14f9ed34aeb4a0eb1161e66d193584988e46b2cd246ca30f3ac252086e22a62c37fe172118271728606c001f9542b13e41c2b61420d73

data/.github/workflows/main.yml

@@ -0,0 +1,39 @@
+name: Test
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+        gemfile:
+          - gemfiles/rails_6_1.gemfile
+          - gemfiles/rails_7_0.gemfile
+          - gemfiles/rails_7_1.gemfile
+
+    name: Ruby ${{ matrix.ruby_version }} / Gemfile ${{ matrix.gemfile }}
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+      COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+
+      - name: RSpec
+        run: bundle exec rake

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2018 Georg Ledermann
+Copyright (c) 2012-2023 Georg Ledermann
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
 # Settings for Rails
 
-[![Build Status](https://travis-ci.org/ledermann/rails-settings.svg?branch=master)](https://travis-ci.org/ledermann/rails-settings)
+[![Build Status](https://github.com/ledermann/rails-settings/actions/workflows/main.yml/badge.svg)](https://github.com/ledermann/rails-settings/actions)
 [![Code Climate](https://codeclimate.com/github/ledermann/rails-settings.svg)](https://codeclimate.com/github/ledermann/rails-settings)
 [![Coverage Status](https://coveralls.io/repos/ledermann/rails-settings/badge.svg?branch=master)](https://coveralls.io/r/ledermann/rails-settings?branch=master)
 
@@ -8,9 +8,8 @@ Ruby gem to handle settings for ActiveRecord instances by storing them as serial
 
 ## Requirements
 
-* Ruby 1.9.3 or newer
-* Rails 3.1 or newer (including Rails 5.2)
-
+- Ruby 3.0 or newer
+- Rails 6.1 or newer (including Rails 7.0)
 
 ## Installation
 
@@ -27,7 +26,6 @@ rails g rails_settings:migration
 rake db:migrate
 ```
 
-
 ## Usage
 
 ### Define settings
@@ -65,6 +63,26 @@ class ProjectSettingObject < RailsSettings::SettingObject
 end
 ```
 
+In case you need to define settings separatedly for the same models, you can use the persistent option
+
+```ruby
+module UserDashboardConcern
+  extend ActiveSupport::Concern
+
+  included do
+    has_settings persistent: true do |s|
+      s.key :dashboard
+    end
+  end
+end
+
+class User < ActiveRecord::Base
+  has_settings persistent: true do |s|
+    s.key :calendar
+  end
+end
+```
+
 ### Set settings
 
 ```ruby
@@ -79,11 +97,10 @@ or
 
 ```ruby
 user = User.find(1)
-user.settings(:dashboard).update_attributes! :theme => 'black'
-user.settings(:calendar).update_attributes! :scope => 'all', :display => 'daily'
+user.settings(:dashboard).update! :theme => 'black'
+user.settings(:calendar).update! :scope => 'all', :display => 'daily'
 ```
 
-
 ### Get settings
 
 ```ruby
@@ -102,7 +119,7 @@ user.settings(:calendar).scope
 
 ```ruby
 user = User.find(1)
-user.settings(:dashboard).update_attributes! :theme => nil
+user.settings(:dashboard).update! :theme => nil
 
 user.settings(:dashboard).view = nil
 user.settings(:dashboard).save!
@@ -118,13 +135,14 @@ User.without_settings
 # => all users without having any setting
 
 User.with_settings_for(:calendar)
-# => all users having a setting for 'calender'
+# => all users having a setting for 'calendar'
 
 User.without_settings_for(:calendar)
 # => all users without having settings for 'calendar'
 ```
 
 ### Eager Loading
+
 ```ruby
 User.includes(:setting_objects)
 # => Eager load setting_objects when querying many users
@@ -136,16 +154,14 @@ Version 2 is a complete rewrite and has a new DSL, so it's **not** compatible wi
 
 If you don't want to upgrade, you find the old version in the [1.x](https://github.com/ledermann/rails-settings/commits/1.x) branch. But don't expect any updates there.
 
-
 ## Changelog
 
 See https://github.com/ledermann/rails-settings/releases
 
-
 ## License
 
 MIT License
 
-Copyright (c) 2012-2018 [Georg Ledermann](http://www.georg-ledermann.de)
+Copyright (c) 2012-2023 [Georg Ledermann](https://ledermann.dev)
 
 This gem is a complete rewrite of [rails-settings](https://github.com/Squeegy/rails-settings) by [Alex Wayne](https://github.com/Squeegy)

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/{ci/Gemfile-rails-5-1 → gemfiles/rails_6_1.gemfile}

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 5.1.0'
+gem 'activerecord', '~> 6.1.2'
+gem "sqlite3", "~> 1.4"
 
 gemspec :path => "../"

data/{ci/Gemfile-rails-3-1 → gemfiles/rails_7_0.gemfile}

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 3.1.12'
+gem 'activerecord', '~> 7.0.0'
+gem "sqlite3", "~> 1.4"
 
 gemspec :path => "../"

data/gemfiles/rails_7_1.gemfile

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

data/lib/generators/rails_settings/migration/migration_generator.rb

@@ -5,18 +5,19 @@ module RailsSettings
   class MigrationGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
 
-    desc "Generates migration for rails-settings"
+    desc 'Generates migration for rails-settings'
     source_root File.expand_path('../templates', __FILE__)
 
     def create_migration_file
-      migration_template 'migration.rb', 'db/migrate/rails_settings_migration.rb'
+      migration_template 'migration.rb',
+                         'db/migrate/rails_settings_migration.rb'
     end
 
     def self.next_migration_number(dirname)
       if ActiveRecord::Base.timestamped_migrations
-        Time.now.utc.strftime("%Y%m%d%H%M%S")
+        Time.now.utc.strftime('%Y%m%d%H%M%S')
       else
-        "%.3d" % (current_migration_number(dirname) + 1)
+        '%.3d' % (current_migration_number(dirname) + 1)
       end
     end
   end

data/lib/generators/rails_settings/migration/templates/migration.rb

@@ -1,18 +1,12 @@
-MIGRATION_BASE_CLASS = if ActiveRecord::VERSION::MAJOR >= 5
-  ActiveRecord::Migration[5.0]
-else
-  ActiveRecord::Migration
-end
-
-class RailsSettingsMigration < MIGRATION_BASE_CLASS
+class RailsSettingsMigration < ActiveRecord::Migration[5.0]
   def self.up
     create_table :settings do |t|
-      t.string     :var,    :null => false
-      t.text       :value
-      t.references :target, :null => false, :polymorphic => true
-      t.timestamps :null => true
+      t.string :var, null: false
+      t.text :value
+      t.references :target, null: false, polymorphic: true
+      t.timestamps null: true
     end
-    add_index :settings, [ :target_type, :target_id, :var ], :unique => true
+    add_index :settings, %i[target_type target_id var], unique: true
   end
 
   def self.down

data/lib/rails-settings/base.rb

@@ -3,19 +3,23 @@ module RailsSettings
     def self.included(base)
       base.class_eval do
         has_many :setting_objects,
-                 :as         => :target,
-                 :autosave   => true,
-                 :dependent  => :delete_all,
-                 :class_name => self.setting_object_class_name
+                 as: :target,
+                 autosave: true,
+                 dependent: :delete_all,
+                 class_name: self.setting_object_class_name
 
         def settings(var)
           raise ArgumentError unless var.is_a?(Symbol)
-          raise ArgumentError.new("Unknown key: #{var}") unless self.class.default_settings[var]
+          unless self.class.default_settings[var]
+            raise ArgumentError.new("Unknown key: #{var}")
+          end
 
           if RailsSettings.can_protect_attributes?
-            setting_objects.detect { |s| s.var == var.to_s } || setting_objects.build({ :var => var.to_s }, :without_protection => true)
+            setting_objects.detect { |s| s.var == var.to_s } ||
+              setting_objects.build({ var: var.to_s }, without_protection: true)
           else
-            setting_objects.detect { |s| s.var == var.to_s } || setting_objects.build(:var => var.to_s, :target => self)
+            setting_objects.detect { |s| s.var == var.to_s } ||
+              setting_objects.build(var: var.to_s, target: self)
           end
         end
 
@@ -27,9 +31,12 @@ module RailsSettings
           end
         end
 
-        def settings?(var=nil)
+        def settings?(var = nil)
           if var.nil?
-            setting_objects.any? { |setting_object| !setting_object.marked_for_destruction? && setting_object.value.present? }
+            setting_objects.any? do |setting_object|
+              !setting_object.marked_for_destruction? &&
+                setting_object.value.present?
+            end
           else
             settings(var).value.present?
           end
@@ -38,7 +45,9 @@ module RailsSettings
         def to_settings_hash
           settings_hash = self.class.default_settings.dup
           settings_hash.each do |var, vals|
-            settings_hash[var] = settings_hash[var].merge(settings(var.to_sym).value)
+            settings_hash[var] = settings_hash[var].merge(
+              settings(var.to_sym).value,
+            )
           end
           settings_hash
         end

data/lib/rails-settings/configuration.rb

@@ -8,25 +8,45 @@ module RailsSettings
       raise ArgumentError unless klass
 
       @klass = klass
-      @klass.class_attribute :default_settings, :setting_object_class_name
-      @klass.default_settings = {}
-      @klass.setting_object_class_name = options[:class_name] || 'RailsSettings::SettingObject'
+
+      if options[:persistent]
+        unless @klass.methods.include?(:default_settings)
+          @klass.class_attribute :default_settings
+        end
+      else
+        @klass.class_attribute :default_settings
+      end
+
+      @klass.class_attribute :setting_object_class_name
+      @klass.default_settings ||= {}
+      @klass.setting_object_class_name =
+        options[:class_name] || 'RailsSettings::SettingObject'
 
       if block_given?
         yield(self)
       else
-        keys.each do |k|
-          key(k)
-        end
+        keys.each { |k| key(k) }
       end
 
-      raise ArgumentError.new('has_settings: No keys defined') if @klass.default_settings.blank?
+      if @klass.default_settings.blank?
+        raise ArgumentError.new('has_settings: No keys defined')
+      end
     end
 
-    def key(name, options={})
-      raise ArgumentError.new("has_settings: Symbol expected, but got a #{name.class}") unless name.is_a?(Symbol)
-      raise ArgumentError.new("has_settings: Option :defaults expected, but got #{options.keys.join(', ')}") unless options.blank? || (options.keys == [:defaults])
-      @klass.default_settings[name] = (options[:defaults] || {}).stringify_keys.freeze
+    def key(name, options = {})
+      unless name.is_a?(Symbol)
+        raise ArgumentError.new(
+                "has_settings: Symbol expected, but got a #{name.class}",
+              )
+      end
+      unless options.blank? || (options.keys == [:defaults])
+        raise ArgumentError.new(
+                "has_settings: Option :defaults expected, but got #{options.keys.join(', ')}",
+              )
+      end
+      @klass.default_settings[name] = (
+        options[:defaults] || {}
+      ).stringify_keys.freeze
     end
   end
 end

data/lib/rails-settings/scopes.rb

@@ -2,28 +2,27 @@ module RailsSettings
   module Scopes
     def with_settings
       result = joins("INNER JOIN settings ON #{settings_join_condition}")
-
-      if ActiveRecord::VERSION::MAJOR < 5
-        result.uniq
-      else
-        result.distinct
-      end
+      result.distinct
     end
 
     def with_settings_for(var)
       raise ArgumentError.new('Symbol expected!') unless var.is_a?(Symbol)
-      joins("INNER JOIN settings ON #{settings_join_condition} AND settings.var = '#{var}'")
+      joins(
+        "INNER JOIN settings ON #{settings_join_condition} AND settings.var = '#{var}'",
+      )
     end
 
     def without_settings
-      joins("LEFT JOIN settings ON #{settings_join_condition}").
-      where('settings.id IS NULL')
+      joins("LEFT JOIN settings ON #{settings_join_condition}").where(
+        'settings.id IS NULL',
+      )
     end
 
     def without_settings_for(var)
       raise ArgumentError.new('Symbol expected!') unless var.is_a?(Symbol)
-      joins("LEFT JOIN settings ON  #{settings_join_condition} AND settings.var = '#{var}'").
-      where('settings.id IS NULL')
+      joins(
+        "LEFT JOIN settings ON  #{settings_join_condition} AND settings.var = '#{var}'",
+      ).where('settings.id IS NULL')
     end
 
     def settings_join_condition

data/lib/rails-settings/setting_object.rb

@@ -2,18 +2,22 @@ module RailsSettings
   class SettingObject < ActiveRecord::Base
     self.table_name = 'settings'
 
-    belongs_to :target, :polymorphic => true
+    belongs_to :target, polymorphic: true
 
     validates_presence_of :var, :target_type
     validate do
-      errors.add(:value, "Invalid setting value") unless value.is_a? Hash
+      errors.add(:value, 'Invalid setting value') unless value.is_a? Hash
 
       unless _target_class.default_settings[var.to_sym]
         errors.add(:var, "#{var} is not defined!")
       end
     end
 
-    serialize :value, Hash
+    if ActiveRecord.version >= Gem::Version.new('7.1.0.beta1')
+      serialize :value, type: Hash
+    else
+      serialize :value, Hash
+    end
 
     if RailsSettings.can_protect_attributes?
       # attr_protected can not be used here because it touches the database which is not connected yet.
@@ -21,10 +25,10 @@ module RailsSettings
       attr_accessible
     end
 
-    REGEX_SETTER = /\A([a-z]\w+)=\Z/i
-    REGEX_GETTER = /\A([a-z]\w+)\Z/i
+    REGEX_SETTER = /\A([a-z]\w*)=\Z/i
+    REGEX_GETTER = /\A([a-z]\w*)\Z/i
 
-    def respond_to?(method_name, include_priv=false)
+    def respond_to?(method_name, include_priv = false)
       super || method_name.to_s =~ REGEX_SETTER || _setting?(method_name)
     end
 
@@ -32,7 +36,7 @@ module RailsSettings
       if block_given?
         super
       else
-        if attribute_names.include?(method_name.to_s.sub('=',''))
+        if attribute_names.include?(method_name.to_s.sub('=', ''))
           super
         elsif method_name.to_s =~ REGEX_SETTER && args.size == 1
           _set_value($1, args.first)
@@ -44,23 +48,48 @@ module RailsSettings
       end
     end
 
-  protected
+    protected
+
     if RailsSettings.can_protect_attributes?
       # Simulate attr_protected by removing all regular attributes
       def sanitize_for_mass_assignment(attributes, role = nil)
-        attributes.except('id', 'var', 'value', 'target_id', 'target_type', 'created_at', 'updated_at')
+        attributes.except(
+          'id',
+          'var',
+          'value',
+          'target_id',
+          'target_type',
+          'created_at',
+          'updated_at',
+        )
       end
     end
 
-  private
+    private
+
     def _get_value(name)
       if value[name].nil?
-        _target_class.default_settings[var.to_sym][name]
+        default_value = _get_default_value(name)
+        _deep_dup(default_value)
       else
         value[name]
       end
     end
 
+    def _get_default_value(name)
+      default_value = _target_class.default_settings[var.to_sym][name]
+
+      if default_value.respond_to?(:call)
+        default_value.call(target)
+      else
+        default_value
+      end
+    end
+
+    def _deep_dup(nested_hashes_and_or_arrays)
+      Marshal.load(Marshal.dump(nested_hashes_and_or_arrays))
+    end
+
     def _set_value(name, v)
       if value[name] != v
         value_will_change!

data/lib/rails-settings/version.rb

@@ -1,3 +1,3 @@
 module RailsSettings
-  VERSION = '2.4.3'
+  VERSION = '2.6.0'
 end

data/lib/rails-settings.rb

@@ -1,9 +1,8 @@
 module RailsSettings
-  # In Rails 3, attributes can be protected by `attr_accessible` and `attr_protected`
   # In Rails 4, attributes can be protected by using the gem `protected_attributes`
   # In Rails 5, protecting attributes is obsolete (there are `StrongParameters` only)
   def self.can_protect_attributes?
-    (ActiveRecord::VERSION::MAJOR == 3) || defined?(ProtectedAttributes)
+    defined?(ProtectedAttributes)
   end
 end
 
@@ -20,4 +19,3 @@ ActiveRecord::Base.class_eval do
     extend RailsSettings::Scopes
   end
 end
-

data/rails-settings.gemspec

@@ -4,26 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rails-settings/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = 'ledermann-rails-settings'
-  gem.version       = RailsSettings::VERSION
-  gem.licenses      = ['MIT']
-  gem.authors       = ['Georg Ledermann']
-  gem.email         = ['mail@georg-ledermann.de']
-  gem.description   = %q{Settings gem for Ruby on Rails}
-  gem.summary       = %q{Ruby gem to handle settings for ActiveRecord instances by storing them as serialized Hash in a separate database table. Namespaces and defaults included.}
-  gem.homepage      = 'https://github.com/ledermann/rails-settings'
-  gem.required_ruby_version = '>= 1.9.3'
+  gem.name = 'ledermann-rails-settings'
+  gem.version = RailsSettings::VERSION
+  gem.licenses = ['MIT']
+  gem.authors = ['Georg Ledermann']
+  gem.email = ['georg@ledermann.dev']
+  gem.description = 'Settings gem for Ruby on Rails'
+  gem.summary =
+    'Ruby gem to handle settings for ActiveRecord instances by storing them as serialized Hash in a separate database table. Namespaces and defaults included.'
+  gem.homepage = 'https://github.com/ledermann/rails-settings'
+  gem.required_ruby_version = '>= 3.0'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'activerecord', '>= 3.1'
+  gem.add_dependency 'activerecord', '>= 6.1'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'sqlite3'
   gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'coveralls'
-  gem.add_development_dependency 'simplecov', RUBY_VERSION < '2' ? '~> 0.11.2' : '>= 0.11.2'
+  gem.add_development_dependency 'coveralls_reborn'
+  gem.add_development_dependency 'simplecov', '>= 0.11.2'
 end