configurable_engine 2.0.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35d8e042be21d9ecc3832fcf236bec6145e58ee6a545185121cda190f26a935e
-  data.tar.gz: 5d3619555b52de54a69da528aec0e92a9b5911425ea06f244a01082e6cfd588d
+  metadata.gz: 283cf61227a97ab17df548eced982e91abac7fc66d8c14e69814376772d466cf
+  data.tar.gz: d39aaf3799d5be3f7ea5f652a6b66c546e9ab9d3b78ae0221429574c9b6215cd
 SHA512:
-  metadata.gz: ebc8c63d1ea3ac3722dd7632ab38ecba3cd60dd0b2a23b6595f9905e7aaa947aa8b069f0f8de5e0f275ca69cd09b786ee9f866aba82c6c7672f02f937116bdaf
-  data.tar.gz: b09227577c08b4e35523d134dbf7dbeff3ff2c1c45f6f01c536985c446239ec2ee8ee39b8c649e334c4bd9ee5a3a165a85b3c3fbdabbc2332fba4cbb2aec7f5e
+  metadata.gz: e545213eecab5c9d38d076ccbfcf23b7ff40e02b1f70b712521e50be7932d72a513173ee22211e92a046186fd95d5207c80bcff63fb94f3cfa799981c49342bf
+  data.tar.gz: c866f492aa4c716e0b17f658fcc3a7c259455d6b765049af2fcbcfd975daab3e2e2781633035abda509d5b811d23dad6e8968ac1059e4116a51334fb0bf5461d

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### v3.0.0 - April 2, 2025
+**breaking changes**
+Drops support for Rails < 7 and ruby < 3.2
+adds support for modern rails
+
 ### v2.0.2 - August 20, 2020
 **bug fixes**
 fix rendering with included module

data/app/controllers/configurable_engine/application_controller.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ConfigurableEngine
   class ApplicationController < ActionController::Base
-    layout "configurable_engine/application"
+    layout 'configurable_engine/application'
     protect_from_forgery with: :exception
   end
 end

data/app/controllers/configurable_engine/configurables_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ConfigurableEngine
   class ConfigurablesController < ::ConfigurableEngine::ApplicationController
     include ConfigurableEngine::ConfigurablesControllerMethods

data/app/models/configurable.rb

@@ -1,14 +1,12 @@
-class Configurable < ActiveRecord::Base
-  serialize :value
+# frozen_string_literal: true
 
+class Configurable < ActiveRecord::Base
   after_save    :invalidate_cache, if: -> { ConfigurableEngine::Engine.config.use_cache }
   after_destroy :invalidate_cache, if: -> { ConfigurableEngine::Engine.config.use_cache }
 
-  validates_presence_of    :name
-  validates_uniqueness_of  :name
+  validates :name, presence: true, uniqueness: { case_sensitive: true }
 
   validate :type_of_value
-  before_save :serialize_value
 
   def self.defaults
     @defaults ||= HashWithIndifferentAccess.new(
@@ -19,7 +17,7 @@ class Configurable < ActiveRecord::Base
   end
 
   def self.keys
-    self.defaults.collect { |k,v| k.to_s }.sort
+    defaults.collect { |k, _v| k.to_s }.sort
   end
 
   def self.[]=(key, value)
@@ -27,7 +25,10 @@ class Configurable < ActiveRecord::Base
     if exisiting
       exisiting.update_attribute(:value, value)
     else
-      create {|c| c.name = key.to_s; c.value = value}
+      create do |c|
+        c.name = key.to_s
+        c.value = Configurable.value_for_serialization key, value
+      end
     end
   end
 
@@ -38,23 +39,21 @@ class Configurable < ActiveRecord::Base
   def self.[](key)
     return parse_value key, defaults[key][:default] unless table_exists?
 
-    value, found = [false, false]
-    database_finder = -> do
+    value = false
+    found = false
+    database_finder = lambda do
       config = find_by_name(key)
-      found = !!config
+      found = !config.nil?
       value = config.try(:value)
     end
 
-
     if ConfigurableEngine::Engine.config.use_cache
       found = Rails.cache.exist?(cache_key(key))
       if found
         value = Rails.cache.fetch(cache_key(key))
       else
         database_finder.call
-        if found
-          Rails.cache.write cache_key(key), value
-        end
+        Rails.cache.write cache_key(key), value if found
       end
     else
       database_finder.call
@@ -64,9 +63,7 @@ class Configurable < ActiveRecord::Base
       value
     else
       parse_value(key, defaults[key][:default]).tap do |val|
-        if ConfigurableEngine::Engine.config.use_cache
-          Rails.cache.write cache_key(key), val
-        end
+        Rails.cache.write cache_key(key), val if ConfigurableEngine::Engine.config.use_cache
       end
     end
   end
@@ -75,10 +72,10 @@ class Configurable < ActiveRecord::Base
     self.class.parse_value name, super
   end
 
-  def self.parse_value key, value
+  def self.parse_value(key, value)
     case defaults[key][:type]
     when 'boolean'
-      [true, 1, "1", "t", "true"].include?(value)
+      [true, 1, '1', 't', 'true'].include?(value)
     when 'decimal'
       value ||= 0
       BigDecimal(value.to_s)
@@ -94,32 +91,30 @@ class Configurable < ActiveRecord::Base
     when 'date'
       if value.is_a? Date
         value
-      else
-       Date.parse(value) if value.present?
+      elsif value.present?
+        Date.parse(value)
       end
     else
       value
     end
   end
 
-  def self.serialized_value key
+  def self.serialized_value(key)
     value_for_serialization key, self[key]
   end
 
   def self.value_for_serialization(key, value)
     if defaults[key][:type] == 'list' && value.is_a?(Array)
-      if value.all? {|entry| entry.is_a? Array}
-        value = value.collect {|entry| entry.join ','}
-      end
+      value = value.collect { |entry| entry.join ',' } if value.all? { |entry| entry.is_a? Array }
       value.join("\n")
     else
       value.to_s
-    end.gsub("\r\n","\n")
+    end.gsub("\r\n", "\n")
   end
 
   def self.method_missing(name, *args)
     name_stripped = name.to_s.sub(/[\?=]$/, '')
-    if self.keys.include?(name_stripped)
+    if keys.include?(name_stripped)
       if name.to_s.end_with?('=')
         self[name_stripped] = args.first
       else
@@ -134,21 +129,30 @@ class Configurable < ActiveRecord::Base
 
   def type_of_value
     return unless name
+
     valid = case Configurable.defaults[name][:type]
-    when 'boolean'
-      [true, 1, "1", "true", false, 0, "0", "false"].include?(value)
-    when 'decimal'
-      BigDecimal(value) rescue false
-    when 'integer'
-      Integer(value) rescue false
-    when 'list'
-      value.is_a?(Array)
-    when 'date'
-      value.is_a?(Date)
-    else
-      true
-    end
-    errors.add(:value, I18n.t("activerecord.errors.messages.invalid")) unless valid
+            when 'boolean'
+              [true, 1, '1', 'true', false, 0, '0', 'false'].include?(value)
+            when 'decimal'
+              begin
+                BigDecimal(value)
+              rescue StandardError
+                false
+              end
+            when 'integer'
+              begin
+                Integer(value)
+              rescue StandardError
+                false
+              end
+            when 'list'
+              value.is_a?(Array)
+            when 'date'
+              value.is_a?(Date)
+            else
+              true
+            end
+    errors.add(:value, I18n.t('activerecord.errors.messages.invalid')) unless valid
   end
 
   def serialize_value
@@ -156,6 +160,6 @@ class Configurable < ActiveRecord::Base
   end
 
   def invalidate_cache
-    Rails.cache.delete(Configurable.cache_key self.name)
+    Rails.cache.delete(Configurable.cache_key(name))
   end
 end

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ConfigurableEngine::Engine.routes.draw do
-  resource :configurable, path: '/', only: [:show, :update]
+  resource :configurable, path: '/', only: %i[show update]
 end

data/lib/configurable_engine/configurables_controller_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ConfigurableEngine
   module ConfigurablesControllerMethods
     def show
@@ -7,16 +9,16 @@ module ConfigurableEngine
 
     def update
       failures = Configurable
-        .keys.map do |key|
-          Configurable.find_by_name(key) ||
-            Configurable.create {|c| c.name = key}
-        end.reject do |configurable|
-          configurable.value = params[configurable.name]
-          configurable.save
-        end
+                 .keys.map do |key|
+        Configurable.find_by_name(key) ||
+          Configurable.create { |c| c.name = key }
+      end.reject do |configurable|
+        configurable.value = params[configurable.name]
+        configurable.save
+      end
 
       if failures.empty?
-        redirect_to(action: :show, :notice => "Changes successfully updated")
+        redirect_to(action: :show, notice: 'Changes successfully updated')
       else
         flash[:error] = failures.flat_map(&:errors).flat_map(&:full_messages).join(',')
         redirect_to(action: :show)

data/lib/configurable_engine/engine.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ConfigurableEngine
   class Engine < ::Rails::Engine
-    engine_name "configurable"
+    engine_name 'configurable'
     isolate_namespace ConfigurableEngine
     config.use_cache = false
     config.generators do |g|

data/lib/configurable_engine/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ConfigurableEngine
-  VERSION = '2.0.2'
+  VERSION = '3.0.0'
 end

data/lib/configurable_engine.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'configurable_engine/engine'
 require 'configurable_engine/configurables_controller_methods'

data/lib/generators/configurable_engine/install_generator.rb

@@ -1,21 +1,22 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 module ConfigurableEngine
-class InstallGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
-
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
 
-   def self.source_root
+    def self.source_root
       @source_root ||= File.join(File.dirname(__FILE__), 'templates')
-   end
- 
-   def self.next_migration_number(dirname)
+    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)
+        format('%.3d', (current_migration_number(dirname) + 1))
       end
     end
- 
+
     def create_migration_file
       copy_file 'configurable.yml', 'config/configurable.yml'
       migration_template 'migration.rb', 'db/migrate/create_configurables.rb'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class CreateConfigurables < ActiveRecord::Migration[5.2]
   def self.up
     create_table :configurables do |t|
@@ -6,7 +8,7 @@ class CreateConfigurables < ActiveRecord::Migration[5.2]
 
       t.timestamps
     end
-    
+
     add_index :configurables, :name
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: configurable_engine
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Paul Campbell
@@ -9,22 +9,28 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-20 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 7.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 8.0.0
 description: 'Configurable is a Rails 4 engine that allows you to set up config variables
   in a config file, specifying default values for all environmentspec. These variables
   can then be set on a per-app basis using a user facing configuration screen. '
@@ -54,7 +60,8 @@ files:
 homepage: http://github.com/paulca/configurable_engine
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -70,8 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Database-backed configuration for Rails 4, with defaults from config file.
+summary: Database-backed configuration for Rails 7, with defaults from config file.
 test_files: []