setting_accessors 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf27bd36edbc82a68d4f3030c58e3582f71c63dafd2289c5fb483bfd8a81263
-  data.tar.gz: 153d794f0323bb0f8518a8331145766df1ca8fc935c88a4419f9b5772c2226db
+  metadata.gz: 3fcd820da4c83ab5b7b6d428304289e115ac09a35570be868f53091d441dbfa5
+  data.tar.gz: cdcb83249a2196a0878200171edc82a51780a82b3d081cf480c2fc161d38b192
 SHA512:
-  metadata.gz: ff2f5b55fb799e97f14272962f832de8121ee549aa53a7c988a205e7028b4d9b9ad1f5cd5f141a5ce8c8d5d29b494b7ffff2e1ead3929dae4e5df3406f64d285
-  data.tar.gz: 1c7819afb12ef5cfd4de81ca05e6c3c5605eb1c9e2173a977bcd806b64b229443733e13b1c31b18dc3579a1fc17ca1b4677ee6f7d7c47bc701caa2a61e1b32e0
+  metadata.gz: 5b6e63ac875a54ea5280fb1c8e605c27dcaf6d9c3f7964c4cfaf2dfca5ba04539c00a14f341047d2e696832c35947b06325132e28b9e92e097e9251f65d35d32
+  data.tar.gz: 1ecf896390e1b251b08d2458677613a50a510c3bf764ad088ee0c43d06d1a3882127b11d6cbe57e4f60dae06516fa3f6845be1da4caa77048cf59cdddae34514

data/.travis.yml

@@ -1,6 +1,10 @@
 language: ruby
 cache: bundler
 
+env:
+  global:
+    - CC_TEST_REPORTER_ID=6dc7db591131b55839297349c4a843ee7d7d9b28731c6bb4f1db9d42fa86c7b6
+
 rvm:
   - 2.3.0
   - 2.3.3
@@ -16,8 +20,17 @@ gemfile:
   - gemfiles/rails_5.2.gemfile
 
 before_install: 'gem install bundler'
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+
 script: 'bundle exec rake'
 
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
 notifications:
   email:
     on_failure: change

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.1.0
+
+A bugfix and slight refactoring release which takes care of several issues regarding
+changing setting-values in-place without actually setting them before. (#13)
+
+* More and better specs
+* Better handling of non-existent settings through exception handling rather than multiple error prone tests
+
 ## 1.0.0
 
 This is almost a complete refactoring of the gem which also removes some not really needed functionality.  

data/README.md

@@ -4,6 +4,7 @@ SettingAccessors
 [![Gem Version](https://badge.fury.io/rb/setting_accessors.svg)](http://badge.fury.io/rb/setting_accessors)
 [![Build Status](https://travis-ci.org/Stex/setting_accessors.svg?branch=master)](https://travis-ci.org/Stex/setting_accessors)
 [![Maintainability](https://api.codeclimate.com/v1/badges/78becd1d005aab2d1409/maintainability)](https://codeclimate.com/github/Stex/setting_accessors/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a99a88d28ad37a79dbf6/test_coverage)](https://codeclimate.com/github/codeclimate/codeclimate/test_coverage)
 
 Sometimes it's handy to keep track of various settings or attributes in ActiveRecord instances and persist them through various requests (and sessions). An example would be to store a items-per-page value for multiple tables in the application per user or probably also set default sorting directions.
 

data/gemfiles/rails_4.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    setting_accessors (1.0.0)
+    setting_accessors (1.1.0)
       activemodel (>= 4.2, <= 5.2)
       activerecord (>= 4.2, <= 5.2)
       activesupport (>= 4.2, <= 5.2)
@@ -50,9 +50,12 @@ GEM
     arel (6.0.4)
     ast (2.4.0)
     builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
     concurrent-ruby (1.1.3)
     crass (1.0.4)
     diff-lcs (1.3)
+    docile (1.1.5)
     erubis (2.7.0)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
@@ -62,11 +65,13 @@ GEM
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1-x86_64-darwin-17)
+    json (2.1.0)
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
+    method_source (0.9.2)
     mini_mime (1.0.1)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
@@ -76,6 +81,12 @@ GEM
     parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
     rack (1.6.11)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -127,6 +138,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -150,11 +166,14 @@ DEPENDENCIES
   appraisal (~> 2.2)
   bundler (~> 1.6)
   generator_spec (~> 0.9)
+  pry (~> 0.12)
+  pry-byebug (~> 3.6)
   rails (~> 4.2.0)
   rake (~> 10.4)
   rspec (~> 3.8)
   rubocop (~> 0.60)
   setting_accessors!
+  simplecov (~> 0.16)
   sqlite3 (~> 1.3)
   with_model (~> 2.1)
 

data/gemfiles/rails_5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    setting_accessors (1.0.0)
+    setting_accessors (1.1.0)
       activemodel (>= 4.2, <= 5.2)
       activerecord (>= 4.2, <= 5.2)
       activesupport (>= 4.2, <= 5.2)
@@ -53,9 +53,12 @@ GEM
     arel (7.1.4)
     ast (2.4.0)
     builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
     concurrent-ruby (1.1.3)
     crass (1.0.4)
     diff-lcs (1.3)
+    docile (1.1.5)
     erubis (2.7.0)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
@@ -65,6 +68,7 @@ GEM
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1-x86_64-darwin-17)
+    json (2.1.0)
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -81,6 +85,12 @@ GEM
     parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
     rack (2.0.6)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -131,6 +141,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -157,11 +172,14 @@ DEPENDENCIES
   appraisal (~> 2.2)
   bundler (~> 1.6)
   generator_spec (~> 0.9)
+  pry (~> 0.12)
+  pry-byebug (~> 3.6)
   rails (~> 5.0.0)
   rake (~> 10.4)
   rspec (~> 3.8)
   rubocop (~> 0.60)
   setting_accessors!
+  simplecov (~> 0.16)
   sqlite3 (~> 1.3)
   with_model (~> 2.1)
 

data/gemfiles/rails_5.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    setting_accessors (1.0.0)
+    setting_accessors (1.1.0)
       activemodel (>= 4.2, <= 5.2)
       activerecord (>= 4.2, <= 5.2)
       activesupport (>= 4.2, <= 5.2)
@@ -53,9 +53,12 @@ GEM
     arel (8.0.0)
     ast (2.4.0)
     builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
     concurrent-ruby (1.1.3)
     crass (1.0.4)
     diff-lcs (1.3)
+    docile (1.1.5)
     erubi (1.7.1)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
@@ -65,6 +68,7 @@ GEM
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
+    json (2.1.0)
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -81,6 +85,12 @@ GEM
     parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
     rack (2.0.6)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -131,6 +141,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -157,11 +172,14 @@ DEPENDENCIES
   appraisal (~> 2.2)
   bundler (~> 1.6)
   generator_spec (~> 0.9)
+  pry (~> 0.12)
+  pry-byebug (~> 3.6)
   rails (~> 5.1.0)
   rake (~> 10.4)
   rspec (~> 3.8)
   rubocop (~> 0.60)
   setting_accessors!
+  simplecov (~> 0.16)
   sqlite3 (~> 1.3)
   with_model (~> 2.1)
 

data/gemfiles/rails_5.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    setting_accessors (1.0.0)
+    setting_accessors (1.1.0)
       activemodel (>= 4.2, <= 5.2)
       activerecord (>= 4.2, <= 5.2)
       activesupport (>= 4.2, <= 5.2)
@@ -57,9 +57,12 @@ GEM
     arel (9.0.0)
     ast (2.4.0)
     builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
     concurrent-ruby (1.1.3)
     crass (1.0.4)
     diff-lcs (1.3)
+    docile (1.1.5)
     erubi (1.7.1)
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
@@ -69,6 +72,7 @@ GEM
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
+    json (2.1.0)
     loofah (2.2.3)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -88,6 +92,12 @@ GEM
     parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
     rack (2.0.6)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -139,6 +149,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -165,11 +180,14 @@ DEPENDENCIES
   appraisal (~> 2.2)
   bundler (~> 1.6)
   generator_spec (~> 0.9)
+  pry (~> 0.12)
+  pry-byebug (~> 3.6)
   rails (~> 5.2.0)
   rake (~> 10.4)
   rspec (~> 3.8)
   rubocop (~> 0.60)
   setting_accessors!
+  simplecov (~> 0.16)
   sqlite3 (~> 1.3)
   with_model (~> 2.1)
 

data/lib/setting_accessors.rb

@@ -21,6 +21,10 @@ ActiveRecord::Base.class_eval do
 end
 
 module SettingAccessors
+  class Error < StandardError; end
+  class NestedHashKeyNotFoundError < Error; end
+  class SettingNotFoundError < Error; end
+
   def self.setting_class
     setting_class_name.constantize
   end

data/lib/setting_accessors/helpers.rb

@@ -2,9 +2,6 @@
 
 module SettingAccessors
   module Helpers
-    class Error < StandardError; end
-    class NestedHashKeyNotFoundException < Error; end
-
     def ensure_nested_hash!(hash, *keys)
       h = hash
       keys.each do |key|
@@ -14,11 +11,11 @@ module SettingAccessors
     end
 
     def lookup_nested_hash(hash, *keys)
-      fail NestedHashKeyNotFoundException if hash.nil?
+      fail NestedHashKeyNotFoundError if hash.nil?
 
       h = hash
       keys.each do |key|
-        fail NestedHashKeyNotFoundException unless h.key?(key)
+        fail NestedHashKeyNotFoundError unless h.key?(key)
 
         h = h[key]
       end

data/lib/setting_accessors/internal.rb

@@ -62,7 +62,7 @@ module SettingAccessors
     #
     def self.get_class_setting(klass, setting_name)
       lookup_nested_hash(class_settings, klass.to_s, setting_name.to_s)
-    rescue ::SettingAccessors::Helpers::NestedHashKeyNotFoundException
+    rescue NestedHashKeyNotFoundError
       nil
     end
 

data/lib/setting_accessors/setting_scaffold.rb

@@ -37,6 +37,15 @@ module SettingAccessors
         setting_record(name, assignable).try(:value)
       end
 
+      #
+      # Like #get, but will raise an exception if the requested setting doesn't exist in the database
+      #
+      def get!(name, assignable = nil)
+        setting_record!(name, assignable).value
+      rescue ActiveRecord::RecordNotFound
+        raise ::SettingAccessors::SettingNotFoundError
+      end
+
       alias [] get
 
       #
@@ -46,11 +55,9 @@ module SettingAccessors
       # This only works for class-wise settings, meaning that an assignable has to be present.
       #
       def get_or_default(name, assignable)
-        if (val = get(name, assignable)).nil?
-          new(name: name, assignable: assignable).default_value
-        else
-          val
-        end
+        get!(name, assignable)
+      rescue ::SettingAccessors::SettingNotFoundError
+        get_default_value(name, assignable)
       end
 
       #
@@ -108,6 +115,14 @@ module SettingAccessors
         find_by(name: name.to_s, assignable: assignable)
       end
 
+      #
+      # Like #setting_record, but will raise an ActiveRecord::RecordNotFound exception
+      # if the record doesn't exist yet
+      #
+      def setting_record!(name, assignable = nil)
+        setting_record(name, assignable) || raise(ActiveRecord::RecordNotFound)
+      end
+
       #
       # Makes accessing settings a little easier.
       # Examples:

data/lib/setting_accessors/setting_set.rb

@@ -22,22 +22,12 @@ module SettingAccessors
     # 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)
+    def get(key)
+      return @temp_settings[key.to_sym] if key?(key)
 
-      value = SettingAccessors.setting_class.get(key, record)
-      @temp_settings[key.to_sym] = value unless value.nil?
-      value
+      @temp_settings[key.to_sym] = current_database_value!(key)
+    rescue SettingNotFoundError
+      nil
     end
 
     alias [] get
@@ -66,15 +56,11 @@ module SettingAccessors
     #   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)
+    def get_or_default(key, store_default: true)
+      result = get(key)
+      return result if key?(key) # If no key is found here, we didn't have a setting in the database
 
-      try_dup(SettingAccessors.setting_class.get_or_default(key, record)).tap do |value|
+      try_dup(default_value(key)).tap do |value|
         set(key, value) if store_default
       end
     end
@@ -95,26 +81,57 @@ module SettingAccessors
     #
     def value_was(key)
       lookup_nested_hash(@old_values, key.to_s)
-    rescue NestedHashKeyNotFoundException
-      get(key)
+    rescue NestedHashKeyNotFoundError
+      current_database_value(key)
     end
 
+    #
+    # @return [Boolean] +true+ if the value for the given setting differs from the database or default value
+    #
     def value_changed?(key)
       get(key) != value_was(key)
     end
 
+    #
+    # @return [Object] The raw value passed to this setting before it was casted to the correct type
+    #
     def value_before_type_cast(key)
       lookup_nested_hash(@values_before_type_casts, key.to_s)
-    rescue NestedHashKeyNotFoundException
+    rescue NestedHashKeyNotFoundError
       get(key)
     end
 
+    #
+    # @return [Hash] the settings which were actually changed since the last persist!
+    #
     def changed_settings
       @temp_settings.select { |k, _| value_changed?(k) }
     end
 
     protected
 
+    #
+    # @return [Object] the current setting value from the database or +nil+ if the setting does not exist yet.
+    #
+    def current_database_value(key)
+      SettingAccessors.setting_class.get(key, record)
+    end
+
+    #
+    # Like #current_database_value, but will raise a SettingNotFound exception
+    # if there is no current database value
+    #
+    def current_database_value!(key)
+      SettingAccessors.setting_class.get!(key, record)
+    end
+
+    #
+    # @return [Object] the default value for the given setting
+    #
+    def default_value(key)
+      SettingAccessors.setting_class.get_default_value(key, record)
+    end
+
     #
     # Keeps a record of the originally set value for a setting before it was
     # automatically converted.
@@ -132,7 +149,11 @@ module SettingAccessors
       @old_values ||= {}
 
       unless @old_values.key?(key.to_s)
-        @old_values[key.to_s] = get_or_default(key, skip_cached: true, store_default: false)
+        @old_values[key.to_s] = begin
+                                  current_database_value!(key)
+                                rescue SettingNotFoundError
+                                  default_value(key)
+                                end
       end
     end
 
@@ -153,7 +174,7 @@ module SettingAccessors
     # validations itself.
     #
     def persist!
-      @temp_settings.each do |key, value|
+      changed_settings.each do |key, value|
         Setting.set(key, value, assignable: record)
       end
       flush!

data/lib/setting_accessors/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SettingAccessors
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/setting_accessors.gemspec

@@ -28,9 +28,12 @@ Gem::Specification.new do |spec|
   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 'pry', '~> 0.12'
+  spec.add_development_dependency 'pry-byebug', '~> 3.6'
   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 'simplecov', '~> 0.16'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
   spec.add_development_dependency 'with_model', '~> 2.1'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: setting_accessors
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Stefan Exner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-26 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement