setting_accessors 0.3.0 → 1.0.0

data/lib/setting_accessors/setting_set.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+#
+# Helper class to make accessing record specific settings easier
+#
+module SettingAccessors
+  class SettingSet
+    include ::SettingAccessors::Helpers
+
+    attr_reader :record
+
+    def initialize(record)
+      @record = record
+      @temp_settings = {}
+    end
+
+    #
+    # Tries to retrieve the given setting's value from the temp settings
+    # (already read/written values in this instance). If the setting hasn't been
+    # used before, its value is retrieved from the database.
+    #
+    # If a setting hasn't been read by this record (instance) before, its value
+    # is stored in the local read set.
+    #
+    # TODO: See if this causes problems with read settings not being updated by external changes.
+    #       User1: Read Setting X
+    #       User2: Update Setting X
+    #       User1: Read Setting X -> Gets old value from temp settings.
+    #   This shouldn't be too dangerous as the system state will be refreshed with every request though.
+    #
+    # @param [Boolean] skip_cached
+    #   If set to +true+, the setting value is freshly loaded from the database,
+    #   even if a value that's not yet persisted exists.
+    #
+    def get(key, skip_cached: false)
+      return @temp_settings[key.to_sym] if !skip_cached && key?(key)
+
+      value = SettingAccessors.setting_class.get(key, record)
+      @temp_settings[key.to_sym] = value unless value.nil?
+      value
+    end
+
+    alias [] get
+
+    def key?(key)
+      @temp_settings.key?(key.to_sym)
+    end
+
+    #
+    # Writes a setting's value
+    #
+    def set(key, val)
+      track_old_value(key)
+      set_value_before_type_cast(key, val)
+      @temp_settings[key.to_sym] = SettingAccessors::Internal.converter(value_type(key)).new(val).convert
+    end
+
+    alias []= set
+
+    #
+    # Tries to find a setting for this record.
+    # If none is found, will return the default setting value
+    # specified in the setting accessor call
+    #
+    # @param [Boolean] store_default
+    #   If set to +true+, the setting's default value is written to the temporary settings
+    #   for faster access. Otherwise, a database lookup is performed every time.
+    #
+    # @param [Boolean] skip_cached
+    #   If set to +true+, a possible temporary setting is skipped when looking up the value.
+    #   This means, the default value is returned even if there is a not yet persisted change to the setting.
+    #
+    def get_or_default(key, store_default: true, skip_cached: false)
+      result = get(key, skip_cached: skip_cached)
+      return result if result || (key?(key) && !skip_cached)
+
+      try_dup(SettingAccessors.setting_class.get_or_default(key, record)).tap do |value|
+        set(key, value) if store_default
+      end
+    end
+
+    #
+    # @return [String] the setting's value type in the +record+'s context
+    #
+    def value_type(key)
+      SettingAccessors::Internal.setting_value_type(key, record)
+    end
+
+    #----------------------------------------------------------------
+    #               ActiveRecord Helper Methods Emulation
+    #----------------------------------------------------------------
+
+    #
+    # @return [Object] the value the given setting had after it was last persisted
+    #
+    def value_was(key)
+      lookup_nested_hash(@old_values, key.to_s)
+    rescue NestedHashKeyNotFoundException
+      get(key)
+    end
+
+    def value_changed?(key)
+      get(key) != value_was(key)
+    end
+
+    def value_before_type_cast(key)
+      lookup_nested_hash(@values_before_type_casts, key.to_s)
+    rescue NestedHashKeyNotFoundException
+      get(key)
+    end
+
+    def changed_settings
+      @temp_settings.select { |k, _| value_changed?(k) }
+    end
+
+    protected
+
+    #
+    # Keeps a record of the originally set value for a setting before it was
+    # automatically converted.
+    #
+    def set_value_before_type_cast(key, value)
+      @values_before_type_casts ||= {}
+      @values_before_type_casts[key.to_s] = value
+    end
+
+    #
+    # Keeps a local copy of a setting's value before it was overridden.
+    # Once the setting is persisted, this value is cleared.
+    #
+    def track_old_value(key)
+      @old_values ||= {}
+
+      unless @old_values.key?(key.to_s)
+        @old_values[key.to_s] = get_or_default(key, skip_cached: true, store_default: false)
+      end
+    end
+
+    #
+    # @return [Object] the duplicated value if it is in fact duplicable. The actual value otherwise
+    #
+    def try_dup(value)
+      value.duplicable? ? value.dup : value
+    end
+
+    #
+    # Saves the new setting values into the database
+    # Please note that there is no check if the values changed their
+    # in the meantime.
+    #
+    # Also, this method expects that the settings were validated
+    # before using #validate! and will therefore not perform
+    # validations itself.
+    #
+    def persist!
+      @temp_settings.each do |key, value|
+        Setting.set(key, value, assignable: record)
+      end
+      flush!
+    end
+
+    def flush!
+      @temp_settings = {}
+      @values_before_type_casts = {}
+      @old_values = {}
+    end
+  end
+end

data/lib/setting_accessors/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SettingAccessors
-  VERSION = '0.3.0'.freeze
+  VERSION = '1.0.0'
 end

data/lib/tasks/setting_accessors_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # desc "Explaining what the task does"
 # task :setting_accessors do
 #   # Task goes here

data/setting_accessors.gemspec

@@ -1,32 +1,40 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'setting_accessors/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'setting_accessors'
   spec.version       = SettingAccessors::VERSION
-  spec.authors       = ["Stefan Exner"]
-  spec.email         = ["stex@sterex.de"]
-  spec.summary       = %q{A global key-value-store and virtual model columns}
-  spec.description   = %q{Adds a global key-value-store to Rails applications and allows adding typed columns
-                          to model classes without having to change the database layout.}
+  spec.authors       = ['Stefan Exner']
+  spec.email         = ['stex@sterex.de']
+  spec.summary       = 'A global key-value-store and virtual model columns'
+  spec.description   = 'Adds a global key-value-store to Rails applications and allows adding typed columns
+                        to model classes without having to change the database layout.'
   spec.homepage      = 'https://www.github.com/stex/setting_accessors'
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = ['>= 2.2.2', '< 3']
+  spec.required_ruby_version = ['>= 2.3', '< 3']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency 'appraisal', '~> 2.2'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'generator_spec', '~> 0.9'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rubocop', '~> 0.60'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
-  spec.add_development_dependency 'shoulda', '~> 3.5'
-  spec.add_development_dependency 'minitest', '~> 5.5'
-  spec.add_development_dependency 'byebug', '~> 3.5'
+  spec.add_development_dependency 'with_model', '~> 2.1'
 
-  spec.add_dependency 'rails', ['>= 4.1', '< 5.1']
+  spec.add_dependency 'activemodel', ['>= 4.2', '<= 5.2']
+  spec.add_dependency 'activerecord', ['>= 4.2', '<= 5.2']
+  spec.add_dependency 'activesupport', ['>= 4.2', '<= 5.2']
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: setting_accessors
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Stefan Exner
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2018-07-18 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,169 +67,171 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.4'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0.60'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '0.60'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: with_model
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
+        version: '4.2'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
+        version: '4.2'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 description: |-
   Adds a global key-value-store to Rails applications and allows adding typed columns
-                            to model classes without having to change the database layout.
+                          to model classes without having to change the database layout.
 email:
 - stex@sterex.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
+- ".editorconfig"
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_4.2.gemfile.lock
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.0.gemfile.lock
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.1.gemfile.lock
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_5.2.gemfile.lock
 - lib/generators/setting_accessors/install_generator.rb
 - lib/generators/setting_accessors/templates/migration.rb.erb
 - lib/generators/setting_accessors/templates/model.rb.erb
 - lib/generators/setting_accessors/templates/settings.yml
 - lib/setting_accessors.rb
-- lib/setting_accessors/accessor.rb
-- lib/setting_accessors/converter.rb
+- lib/setting_accessors/accessor_generator.rb
+- lib/setting_accessors/converters/base.rb
+- lib/setting_accessors/converters/boolean_converter.rb
+- lib/setting_accessors/converters/integer_converter.rb
+- lib/setting_accessors/converters/polymorphic_converter.rb
+- lib/setting_accessors/converters/string_converter.rb
+- lib/setting_accessors/helpers.rb
 - lib/setting_accessors/integration.rb
-- lib/setting_accessors/integration_validator.rb
 - lib/setting_accessors/internal.rb
 - lib/setting_accessors/setting_scaffold.rb
-- lib/setting_accessors/validator.rb
+- lib/setting_accessors/setting_set.rb
 - lib/setting_accessors/version.rb
 - lib/tasks/setting_accessors_tasks.rake
 - setting_accessors.gemspec
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/images/.keep
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/mailers/.keep
-- test/dummy/app/models/.keep
-- test/dummy/app/models/concerns/.keep
-- test/dummy/app/models/post.rb
-- test/dummy/app/models/setting.rb
-- test/dummy/app/models/user.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/setting_accessors.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/config/settings.yml
-- test/dummy/db/migrate/20150102112106_create_users.rb
-- test/dummy/db/migrate/20150102115329_create_settings.rb
-- test/dummy/db/migrate/20150723114600_create_posts.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/lib/assets/.keep
-- test/dummy/log/.keep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/test/fixtures/posts.yml
-- test/dummy/test/models/post_test.rb
-- test/dummy/test/models/setting_test.rb
-- test/dummy/test/models/user_test.rb
-- test/generators/install_generator_test.rb
-- test/setting_accessors_test.rb
-- test/test_helper.rb
 homepage: https://www.github.com/stex/setting_accessors
 licenses:
 - MIT
@@ -214,7 +244,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '2.3'
   - - "<"
     - !ruby/object:Gem::Version
       version: '3'
@@ -225,64 +255,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A global key-value-store and virtual model columns
-test_files:
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/images/.keep
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/mailers/.keep
-- test/dummy/app/models/.keep
-- test/dummy/app/models/concerns/.keep
-- test/dummy/app/models/post.rb
-- test/dummy/app/models/setting.rb
-- test/dummy/app/models/user.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/setting_accessors.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/config/settings.yml
-- test/dummy/db/migrate/20150102112106_create_users.rb
-- test/dummy/db/migrate/20150102115329_create_settings.rb
-- test/dummy/db/migrate/20150723114600_create_posts.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/lib/assets/.keep
-- test/dummy/log/.keep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/test/fixtures/posts.yml
-- test/dummy/test/models/post_test.rb
-- test/dummy/test/models/setting_test.rb
-- test/dummy/test/models/user_test.rb
-- test/generators/install_generator_test.rb
-- test/setting_accessors_test.rb
-- test/test_helper.rb
+test_files: []