settingson 1.6.0 → 1.6.1

data/.travis.yml

@@ -11,3 +11,6 @@ rvm:
 gemfile:
   - gemfiles/4.2.gemfile
   - gemfiles/5.0.gemfile
+
+env:
+  - CODECLIMATE_REPO_TOKEN=620b22e287791de2c9f8a522182ddf57098302ff8958768f8192eaaa7d8a685d

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in settingson.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,6 +1,7 @@
 [![Gem Version](https://badge.fury.io/rb/settingson.svg)](http://badge.fury.io/rb/settingson)
 [![Build Status](https://travis-ci.org/daanforever/settingson.svg?branch=master)](https://travis-ci.org/daanforever/settingson)
 [![Code Climate](https://codeclimate.com/github/daanforever/settingson/badges/gpa.svg)](https://codeclimate.com/github/daanforever/settingson)
+[![Test Coverage](https://codeclimate.com/github/daanforever/settingson/badges/coverage.svg)](https://codeclimate.com/github/daanforever/settingson/coverage)
 
 # Settingson
 
@@ -111,23 +112,15 @@ end
 New way:
 in config/initializers/settingson.rb
 ```ruby
-Settings.defaults do
-  Settings.server.smtp.host? || Settings.server.smtp.host = 'host'
-  Settings.server.smtp.port? || Settings.server.smtp.port = 25
+Settings.defaults do |conf|
+  conf.server.smtp.host = 'host'
+  conf.server.smtp.port = 25
 end
 ```
 
-Old way:
-in config/initializers/settingson.rb
 ```ruby
-Rails.application.config.after_initialize do
-  begin
-    Settings.server.smtp.host? || Settings.server.smtp.host = 'host'
-    Settings.server.smtp.port? || Settings.server.smtp.port = '25'
-  rescue
-    Rails.logger.warn('Something goes wrong')
-  end
-end
+conf.server.smtp.host # => 'host'
+conf.server.smtp.port # => 25
 ```
 
 ## Contributing

data/app/models/concerns/settingson/base.rb

@@ -11,9 +11,8 @@ module Settingson::Base
     #
     # # or
     #
-    # Settings.configure.expires = 600
-    # Settings.configure.enabled = true
-
+    # Settings.configure.cache.expires = 600
+    # Settings.configure.cache.enabled = true
     def configure
       @_settings ||= ::Settingson::Config.new
       yield @_settings if block_given?
@@ -24,32 +23,15 @@ module Settingson::Base
     #   settings.server.host = 'host'
     #   settings.server.port = 80
     # end
-    # FIXME: not ready yet
     def defaults
+      return unless block_given?
       Rails.application.config.after_initialize do
-        begin
-          yield new(settingson: 'defaults') if block_given?
-        rescue
-          Rails.logger.warn('Settingson::defaults failed')
-        end
+        yield Settingson::Store.new( klass: self, path: '__defaults' )
       end
-      true
-    end
-
-    # Settings.delete_all
-    # Delete cached items before super
-    def delete_all
-      Rails.cache.delete_matched(/#{self.configure.cache.namespace}/)
-      super
     end
 
     # Settings.from_hash('smtp.host' => 'host')
-
-    def cached(*args)
-      ActiveSupport::Deprecation.warn('Now caching is enabled by default')
-      self.new
-    end
-
+    # Settings.smtp.host
     def from_hash(attributes)
       case attributes
       when Hash
@@ -61,102 +43,29 @@ module Settingson::Base
       end
     end
 
-    def method_missing(symbol, *args)
+    # Custom hook for clear cache before delete_all
+    #
+    def delete_all
       super
-    rescue NameError
-      self.new.send(symbol, *args)
-    rescue NoMethodError
-      self.new.send(symbol, *args)
+      Rails.cache.delete_matched(/#{self.configure.cache.namespace}/)
     end
 
+    def method_missing(symbol, *args)
+      super
+    rescue NameError, NoMethodError
+      Settingson::Store.new(klass: self).send(symbol, args.first)
+    end
 
   end # module ClassMethods
 
   included do
-    attr_accessor  :settingson
     serialize      :value
     before_destroy :__delete_cached
   end
 
-  def __debug(message)
-    Rails.logger.debug(message) if self.class.configure.debug
-  end
-
   def __delete_cached
     cache_key = "#{self.class.configure.cache.namespace}/#{self.key}"
     Rails.cache.delete(cache_key)
-    __debug("#{self.class.name}: delete '#{self.key}' '#{cache_key}'")
-  end
-
-  def to_s
-    self.new_record? ? '' : super
-  end
-
-  def inspect
-    self.new_record? ? '""' : super
-  end
-
-  def to_i
-    self.new_record? ? 0 : super
-  end
-
-  def nil?
-    self.new_record? ? true : super
-  end
-
-  alias empty? nil?
-
-  def method_missing(symbol, *args)
-    super
-  rescue NameError
-    __rescue_action(symbol.to_s, args.first)
-  rescue NoMethodError
-    __rescue_action(symbol.to_s, args.first)
-  end # method_missing
-
-  protected
-
-  def __cached_key
-    [ self.class.configure.cache.namespace, @settingson ].join('/')
-  end
-
-  def __rescue_action(key, value)
-    case key
-    when /(.+)=/  # setter
-      @settingson = [@settingson, $1].compact.join('.')
-      record = self.class.find_or_create_by!(key: @settingson)
-      record.update!(value: value)
-      Rails.cache.write(__cached_key, value)
-      __debug("#{self.class.name}##{__method__} setter '#{__cached_key}'")
-      record.value
-    else # returns values or self
-      @settingson = [@settingson, key].compact.join('.')
-      __debug("#{self.class.name}##{__method__} getter '#{@settingson}'")
-      __cached_value_or_self
-    end
-  end
-
-  def __cached_value_or_self
-    result = __cached_value
-    result.is_a?(ActiveRecord::RecordNotFound) ? self : result
-  end
-
-  def __cached_value
-    __debug("#{self.class.name}##{__method__} '#{@settingson}'")
-    Rails.cache.fetch(
-      __cached_key,
-      expires_in:         self.class.configure.cache.expires,
-      race_condition_ttl: self.class.configure.cache.race_condition_ttl
-    ) do
-      __debug("#{self.class.name}: fresh '#{@settingson}'")
-      __fresh_value
-    end
-  end
-
-  def __fresh_value
-    self.class.find_by!(key: @settingson).value
-  rescue ActiveRecord::RecordNotFound
-    ActiveRecord::RecordNotFound.new
   end
 
 end # Settingson::Base

data/gemfiles/4.2.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
+gem "codeclimate-test-reporter", :group => :test, :require => nil
 gem "rails", "~> 4.2.0"
 
 gemspec :path => "../"

data/gemfiles/4.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    settingson (1.5.14)
+    settingson (1.6.0)
       rails (>= 4.0)
 
 GEM
@@ -48,9 +48,12 @@ GEM
       thor (>= 0.14.0)
     arel (6.0.3)
     builder (3.2.2)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     concurrent-ruby (1.0.2)
     database_cleaner (1.5.3)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     erubis (2.7.0)
     faker (1.6.6)
       i18n (~> 0.5)
@@ -122,6 +125,11 @@ GEM
       rspec-mocks (~> 3.5.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     spring (1.7.2)
     spring-commands-rspec (1.0.4)
       spring (>= 0.9.1)
@@ -144,6 +152,7 @@ PLATFORMS
 DEPENDENCIES
   appraisal
   bundler (>= 1.6)
+  codeclimate-test-reporter
   database_cleaner
   faker
   rails (~> 4.2.0)

data/gemfiles/5.0.gemfile

@@ -2,6 +2,7 @@
 
 source "https://rubygems.org"
 
+gem "codeclimate-test-reporter", :group => :test, :require => nil
 gem "rails", "~> 5.0.0"
 
 gemspec :path => "../"

data/gemfiles/5.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    settingson (1.5.14)
+    settingson (1.6.0)
       rails (>= 4.0)
 
 GEM
@@ -50,15 +50,19 @@ GEM
       thor (>= 0.14.0)
     arel (7.1.2)
     builder (3.2.2)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     concurrent-ruby (1.0.2)
     database_cleaner (1.5.3)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     erubis (2.7.0)
     faker (1.6.6)
       i18n (~> 0.5)
     globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
+    json (2.0.2)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.4)
@@ -124,6 +128,11 @@ GEM
       rspec-mocks (~> 3.5.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     spring (1.7.2)
     spring-commands-rspec (1.0.4)
       spring (>= 0.9.1)
@@ -149,6 +158,7 @@ PLATFORMS
 DEPENDENCIES
   appraisal
   bundler (>= 1.6)
+  codeclimate-test-reporter
   database_cleaner
   faker
   rails (~> 5.0.0)

data/lib/settingson/store.rb

@@ -1,4 +1,108 @@
-module Settingson::Store
+class Settingson::Store
 
+  def initialize(klass:, path: nil)
+    @__klass  = klass
+    @__path   = path
+  end
+
+  def to_s
+    self.new_record? ? '' : super
+  end
+
+  def to_i
+    self.new_record? ? 0 : super
+  end
+
+  def nil?
+    self.new_record? ? true : super
+  end
+
+  alias empty? nil?
+
+  def method_missing(symbol, *args)
+    __rescue_action(symbol.to_s, args.first)
+  end # method_missing
+
+  protected
+
+  def __debug(message)
+    message = sprintf("%s#%-32s: %s",
+                      self.class.name,
+                      caller_locations.first.label,
+                      message)
+    Rails.logger.debug(message) if @__klass.configure.debug
+  end
+
+  def __rescue_action(key, value)
+    case key
+    when /(.+)=/  # setter
+      __debug("set '#{$1}' value '#{value}' path '#{@__path}'")
+      __set($1, value)
+    else # returns values or self
+      __debug("get '#{key}' value '#{value}' path '#{@__path}'")
+      __get(key)
+    end
+  end
+
+  def __set(key, value)
+    __update_search_path(key)
+    if record = @__klass.find_by(key: @__path)
+      record.update!(value: value)
+    else
+      @__klass.create!(key: @__path, value: value)
+    end
+    Rails.cache.write(__cache_key(@__path), value)
+    value
+  end
+
+  def __get(key)
+    __update_search_path(key)
+    result = __cached_or_default_value(@__path)
+
+    if result.is_a?(ActiveRecord::RecordNotFound)
+      __debug("return self with path: #{@__path}")
+      self
+    else
+      __debug("return result")
+      result
+    end
+  end
+
+  def __update_search_path(key)
+    @__path = [@__path, key].compact.join('.')
+  end
+
+  def __cached_or_default_value(key)
+    result = __cached_value(key)
+
+    if result.is_a?(ActiveRecord::RecordNotFound) # Try defaults
+      __cached_value('__defaults.' + key)
+    else
+      result
+    end
+  end
+
+  def __cache_key(key)
+    [ @__klass.configure.cache.namespace, key ].join('/')
+  end
+
+  def __cached_value(key)
+    __debug("looking in cache '#{__cache_key(key)}'")
+    Rails.cache.fetch(
+      __cache_key(key),
+      expires_in:         @__klass.configure.cache.expires,
+      race_condition_ttl: @__klass.configure.cache.race_condition_ttl
+    ) do
+      __debug("ask DB '#{key}'")
+      __get_from_db(key)
+    end
+  end
+
+  def __get_from_db(key)
+    @__klass.find_by!(key: key).value
+  rescue ActiveRecord::RecordNotFound
+    __debug("not found")
+    ActiveRecord::RecordNotFound.new
+  end
 
 end

data/lib/settingson/version.rb

@@ -1,3 +1,3 @@
 module Settingson
-  VERSION = "1.6.0"
+  VERSION = "1.6.1"
 end

data/spec/dummy/config/initializers/settingson.rb

@@ -0,0 +1 @@
+Settings.configure.debug = true

data/spec/models/settings_spec.rb

@@ -2,9 +2,32 @@ require 'spec_helper'
 
 describe Settings do
 
-  describe 'Settings.defaults' do
-    it 'not raises errors' do
-      expect{ Settings.default {} }.to_not raise_error
+  describe '::defaults' do
+    it 'not raises errors without parameters' do
+      expect{ Settings.defaults {} }.to_not raise_error
+    end
+
+    it 'returns default value for simple value' do
+      word = Faker::Lorem.word
+      Settings.defaults{|s| s.cached_key = word}
+      expect( Settings.cached_key ).to eq(word)
+    end
+
+    it 'returns default value for complex value' do
+      word = Faker::Lorem.word
+      Settings.defaults{|s| s.some.key = word}
+      expect( Settings.some.key ).to eq(word)
+    end
+  end
+
+  describe '::from_hash' do
+    it 'accessable by hash key' do
+      Settings.from_hash(hello: :world)
+      expect( Settings.hello ).to eq(:world)
+    end
+
+    it 'raises error when not Hash' do
+      expect{Settings.from_hash([:hello, :world])}.to raise_error(ArgumentError)
     end
   end
 
@@ -15,11 +38,13 @@ describe Settings do
     it 'not raises error on create new element' do
       expect{ Settings.hello = Faker::Lorem.word }.to_not raise_error
     end
-    it 'returns same Fixnum' do
-      word = Faker::Lorem.word
+    it 'returns same Fixnum #1' do
       Settings.number = 100
       expect( Settings.number ).to eq(100)
     end
+    it 'returns 0 when key not found' do
+      expect( Settings.not_found.to_i ).to eq(0)
+    end
     it 'returns same String' do
       word = Faker::Lorem.word
       Settings.hello = word
@@ -27,13 +52,18 @@ describe Settings do
     end
     it 'returns same value for complex key #1' do
       word = Faker::Lorem.word
-      Settings.hello.hello = word
-      expect( Settings.hello.hello ).to eq(word)
+      Settings.hello1.hello2 = word
+      expect( Settings.hello1.hello2 ).to eq(word)
     end
     it 'returns same value for complex key #2' do
       word = Faker::Lorem.word
-      Settings.i.hello = word
-      expect( Settings.i.hello ).to eq(word)
+      Settings.hello.key = word
+      expect( Settings.hello.key ).to eq(word)
+    end
+    it 'returns same value for complex key #3' do
+      word = Faker::Lorem.word
+      Settings.hello.hello = word
+      expect( Settings.hello.hello ).to eq(word)
     end
     it 'not destroys record with nil value #1' do
       word = Faker::Lorem.word

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 ENV["RAILS_ENV"] ||= 'test'
 
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require ::File.expand_path('../dummy/config/environment',  __FILE__)
 require 'rspec/rails'
 require 'database_cleaner'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settingson
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - dan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-16 00:00:00.000000000 Z
+date: 2016-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -157,8 +157,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Appraisals
 - Gemfile
@@ -212,6 +214,7 @@ files:
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
 - spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/settingson.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb
@@ -286,6 +289,7 @@ test_files:
 - spec/dummy/config/initializers/inflections.rb
 - spec/dummy/config/initializers/mime_types.rb
 - spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/settingson.rb
 - spec/dummy/config/initializers/wrap_parameters.rb
 - spec/dummy/config/locales/en.yml
 - spec/dummy/config/routes.rb