settingson 1.4.1 → 1.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d855dba93399013f3232112fb5c387ec630a2d2
-  data.tar.gz: 7f82756e384c88d1da5c9e94447f675196edd1ae
+  metadata.gz: 46d441faeb98c67815ddeb8588cc3b6c7ee19a17
+  data.tar.gz: 31eae27b20ceca3b9a8fea750f9f50774f45c953
 SHA512:
-  metadata.gz: cd0c3532cd6169d0e581b9e7bcf9d7d71802f6e4ee63d2dc4704fa13f4665c84f64625eea004b1e87959ff9c39c60655dae49f63a7b1dc2912be7ce209e866d1
-  data.tar.gz: 547abb27ae4c7000997ec3d682a6f3e280aaf8f2151500d850ecea675c4b78cad0faaa7e2871b1985666a8ff106a4caaf75caf7495de31bb603c0617be61e75b
+  metadata.gz: 7d9857097bf89d3a7b3c5a747299078a42b858638aa967feabdfeda7477713c03b287e0739e57b252b873370723f0285f97b2457eb08f718e39d5d9641c1ad2d
+  data.tar.gz: 611c40af49e3c325fd6bf7d227a54975d97441440298626d1a7da8eef19ebc09882782372aaeae92c79943fbaf667cc2423f579a7b926f527c8e7ae79c34dc0b

data/.gitignore

@@ -11,15 +11,19 @@ doc/
 lib/bundler/man
 pkg
 rdoc
-spec/reports
+/tmp
 test/tmp
 test/version_tmp
-tmp
 *.bundle
 *.so
 *.o
 *.a
 mkmf.log
+spec/reports
 spec/dummy/db/development.sqlite3
 spec/dummy/db/test.sqlite3
 spec/dummy/log/*
+spec/dummy/tmp/*
+!spec/dummy/tmp/cache
+spec/dummy/tmp/cache/*
+!spec/dummy/tmp/cache/.keep

data/README.md

@@ -1,10 +1,44 @@
 [![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)
 
 # Settingson
 
 Simple settings management for applications (Ruby on Rails 4 with ActiveRecord)
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+    gem 'settingson'
+```
+
+And then execute:
+
+```console
+    $ bundle
+```
+
+Or install it yourself as:
+
+```console
+    $ gem install settingson
+```
+
+## Usage
+
+```console
+rails g settingson MODEL
+```
+Replace MODEL by the class name used for the applications settings, it's frequently `Settings` but it may also be `Configuration` or something else. This will create a model (if one does not exist) and configure it with default options.
+
+Next, you'll usually run
+```console
+rake db:migrate
+```
+as the generator will have created a migration file (if your ORM supports them).
+
 ## Example
 
 shell commands:
@@ -29,8 +63,10 @@ Settings.server.smtp.port                 # => 25
 
 Settings.from_hash({hello: :world})
 Settings.hello                            # => :world
+Settings.hello?                           # => true
 
 Settings.not_found                        # => ""
+Settings.not_found?                       # => false
 Settings.not_found.nil?                   # => true
 Settings.not_found.empty?                 # => true
 Settings.not_found.blank?                 # => true
@@ -47,34 +83,6 @@ Settings.all                # =>
 #  #<Settings id: 5, key: "hello", value: :world, created_at: "2015-12-08 15:18:32", updated_at: "2015-12-08 15:18:32">]
 ```
 
-### Cached values
-
-Caching implemented via ActiveSupport::Cache::Store [(read more)](http://guides.rubyonrails.org/caching_with_rails.html).
-
-By default 10 seconds:
-```ruby
-Settings.hello.world = 'message'          # => 'message'
-Settings.cached.hello.world               # => 'message' with asking DB
-Settings.cached.hello.world               # => 'message' without asking DB
-sleep 11
-Settings.cached.hello.world               # => 'message' with asking DB
-```
-
-You can change time to Live:
-```ruby
-Settings.cached(30.minutes).hello.world   # => 'message'
-# same as
-Settings.cached(1800).hello.world         # => 'message'
-```
-
-Benchmark results:
-```ruby
-puts Benchmark.measure { 1.upto(10000){ Settings.hello.world }}
-# => 36.210000   0.680000  36.890000 ( 37.372218)
-puts Benchmark.measure { 1.upto(10000){ Settings.cached.hello.world }}
-# =>  7.140000   0.060000   7.200000 (  7.246746)
-```
-
 ### Using with [Simple Form](https://github.com/plataformatec/simple_form) and [Haml](https://github.com/haml/haml)
 in view:
 ```ruby
@@ -90,9 +98,9 @@ in controller:
 class SettingsController < ApplicationController
   def update
     if Settings.from_hash(params[:settings])
-      flash[:notice] = t('settings_updated', default: 'Settings updated successfully')
+      flash.now[:notice] = t('settings_updated', default: 'Settings updated successfully')
     else
-      flash[:alert]  = t('settings_not_updated', default: 'Settings not updated')
+      flash.now[:alert]  = t('settings_not_updated', default: 'Settings not updated')
     end
     render :edit
   end
@@ -122,39 +130,6 @@ Rails.application.config.after_initialize do
 end
 ```
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-    gem 'settingson'
-```
-
-And then execute:
-
-```console
-    $ bundle
-```
-
-Or install it yourself as:
-
-```console
-    $ gem install settingson
-```
-
-## Usage
-
-```console
-rails g settingson MODEL
-```
-Replace MODEL by the class name used for the applications settings, it's frequently `Settings` but it may also be `Configuration` or something else. This will create a model (if one does not exist) and configure it with default options.
-
-Next, you'll usually run
-```console
-rake db:migrate
-```
-as the generator will have created a migration file (if your ORM supports them).
-
 ## Contributing
 
 1. Fork it ( https://github.com/daanforever/settingson/fork )

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

@@ -2,9 +2,79 @@ module Settingson::Base
 
   extend ActiveSupport::Concern
 
+  module ClassMethods
+
+    # Settings.configure do |config|
+    #   config.cache.expires = 600   # default: 600
+    #   config.cache.enabled = true  # default: true
+    # end
+    #
+    # # or
+    #
+    # Settings.configure.expires = 600
+    # Settings.configure.enabled = true
+
+    def configure
+      @_settings ||= ::Settingson::Config.new
+      yield @_settings if block_given?
+      @_settings
+    end
+
+    # Settings.defaults do |settings|
+    #   settings.server.host = 'host'
+    #   settings.server.port = 80
+    # end
+    # FIXME: not ready yet
+    def defaults
+      Rails.application.config.after_initialize do
+        begin
+          yield new(settingson: 'defaults') if block_given?
+        rescue
+          Rails.logger.warn('Settingson::defaults failed')
+        end
+      end
+      true
+    end
+
+    # Settings.from_hash('smtp.host' => 'host')
+
+    def cached(*args)
+      ActiveSupport::Deprecation.warn('Now caching is enabled by default')
+      self.new
+    end
+
+    def from_hash(attributes)
+      case attributes
+      when Hash
+        attributes.map{|k,v| find_or_create_by(key: k).update!(value: v)}
+        Rails.cache.clear
+        true
+      else
+        raise ArgumentError, 'Hash required', caller
+      end
+    end
+
+    def method_missing(symbol, *args)
+      super
+    rescue NameError
+      self.new.send(symbol, *args)
+    rescue NoMethodError
+      self.new.send(symbol, *args)
+    end
+
+
+  end # module ClassMethods
+
   included do
     attr_accessor :settingson
     serialize     :value
+    before_destroy :delete_cached
+  end
+
+  def delete_cached
+    cache_key = "#{self.class.configure.cache.namespace}/#{self.key}"
+    Rails.cache.delete(cache_key)
+    Rails.logger.debug("#{self.class.name}: delete '#{self.key}' '#{cache_key}'")
   end
 
   def to_s
@@ -25,142 +95,57 @@ module Settingson::Base
 
   alias empty? nil?
 
-  def _settingson_fresh_value
-    self.class.find_by(key: @settingson)
-  end
-
-  def _settingson_cached(expires_in)
-    @_settingson_cached = expires_in
-    self
-  end
-
-  def _settingson_cached_value
-    Rails.cache.fetch("settingson_cache/#{@settingson}", expires_in: @_settingson_cached) do
-      _settingson_fresh_value
-    end
-  end
-
-  def _settingson_value
-    if @_settingson_cached
-      _settingson_cached_value
-    else
-      _settingson_fresh_value
-    end
-  end
-
-  def _settingson_find_or_create(key)
-    if @settingson.blank?
-      @settingson = key
-    else
-      @settingson += ".#{key}"
-    end
-  end
-
   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
 
-    case symbol.to_s
-    when /(.+)=/  # setter
-
-      _settingson_find_or_create($1)
+  protected
 
-      if args.first.nil? and record = _settingson_fresh_value
-        record.destroy
-      elsif record = _settingson_fresh_value
-        record.update!(value: args.first)
-      else
-        self.class.create(key: @settingson, value: args.first)
-      end
-
-      Rails.cache.delete("settingson_cache/#{@settingson}")
-
-    when /(.+)\?$/  # returns boolean
-
-      _settingson_find_or_create($1)
-      _settingson_value.present?
-
-    when /(.+)\!$/  # returns self or nil
-
-      _settingson_find_or_create($1)
-      _settingson_value
+  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)
+      Rails.logger.debug("#{self.class.name}##{__method__} setter '#{cached_key}'")
+      record.value
     else # returns values or self
-
-      _settingson_find_or_create(symbol.to_s)
-
-      if record = _settingson_value
-        record.value
-      else
-        self
-      end
-
+      @settingson = [@settingson, key].compact.join('.')
+      Rails.logger.debug("#{self.class.name}##{__method__} getter '#{@settingson}'")
+      cached_value_or_self
     end
   end
 
-  module ClassMethods
-
-    # Settings.defaults do
-    #   Settings.server.host? || Settings.server.host = 'host'
-    #   Settings.server.port? || Settings.server.port = 80
-    # end
-
-    def defaults(&block)
-      Rails.application.config.after_initialize do
-        begin
-          yield
-        rescue
-          Rails.logger.warn('Settingson::defaults failed')
-        end
-      end
-    end
-
-    def from_hash(attributes)
-      case attributes
-      when Hash
-        attributes.map{|k,v| find_or_create_by(key: k).update!(value: v)}
-      else
-        false
-      end
-    end
-
-    def method_missing(symbol, *args)
-      super
-    rescue NoMethodError
-
-      case symbol.to_s
-      when /(.+)=/  # setter
-
-        @settingson = $1
-
-        if record = find_by(key: @settingson) and args.first.nil?
-          record.destroy
-        elsif record
-          record.update(value: args.first)
-        else
-          self.create(key: @settingson,
-                      value: args.first,
-                      settingson: @settingson)
-        end
-      when /(.+)\?$/  # returns boolean
-        find_by(key: $1).present?
-      when /(.+)\!$/  # returns self or nil
-        find_by(key: $1)
-      else # getter
-
-        if record = find_by(key: symbol.to_s)
-          record.value
-        else
-          new(settingson: symbol.to_s)
-        end
-
-      end
-    end
+  def cached_value_or_self
+    result = cached_value
+    result.is_a?(ActiveRecord::RecordNotFound) ? self : result
+  end
 
-    def cached(expires_in = 10.seconds)
-      new._settingson_cached(expires_in)
+  def cached_value
+    Rails.logger.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
+      Rails.logger.debug("#{self.class.name}: fresh '#{@settingson}'")
+      fresh_value
     end
+  end
 
-  end # module ClassMethods
+  def fresh_value
+    self.class.find_by!(key: @settingson).value
+  rescue ActiveRecord::RecordNotFound
+    ActiveRecord::RecordNotFound.new
+  end
 
-end
+end # Settingson::Base

data/lib/settingson/config.rb

@@ -0,0 +1,11 @@
+class Settingson::Config
+  attr_accessor :cache
+
+  def initialize
+    @cache = OpenStruct.new(expires_in: 60.seconds,
+                            race_condition_ttl: 10.seconds,
+                            enabled: true,
+                            namespace: "settingson/#{Rails.env}"
+                            )
+  end
+end

data/lib/settingson/store.rb

@@ -1,4 +1,4 @@
 module Settingson::Store
 
 
-end
+end

data/lib/settingson/version.rb

@@ -1,3 +1,3 @@
 module Settingson
-  VERSION = "1.4.1"
+  VERSION = "1.5.12"
 end

data/lib/settingson.rb

@@ -1,4 +1,5 @@
 require "settingson/version"
+require 'settingson/config'
 
 module Settingson
   if defined?(Rails)

data/spec/models/settings_spec.rb

@@ -3,49 +3,48 @@ require 'spec_helper'
 describe Settings do
 
   describe 'Settings.defaults' do
-    # very bad spec. TODO: rewrite me
     it 'not raises errors' do
       expect{ Settings.default {} }.to_not raise_error
     end
   end
 
-  it 'not raises error on create new instance of Settings' do
-    expect{ Settings.new }.to_not raise_error
-  end
-  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
-    Settings.number = 100
-    expect( Settings.number ).to eq(100)
-  end
-  it 'returns same String' do
-    word = Faker::Lorem.word
-    Settings.hello = word
-    expect( Settings.hello ).to eq(word)
-  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)
-  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)
-  end
-
-  it 'destroys record with nil value #1' do
-    word = Faker::Lorem.word
-    Settings.some = word
-    expect{ Settings.some = nil }.to change{ Settings.count }.by(-1)
-  end
+  describe 'general' do
+    it 'not raises error on create new instance of Settings' do
+      expect{ Settings.new }.to_not raise_error
+    end
+    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
+      Settings.number = 100
+      expect( Settings.number ).to eq(100)
+    end
+    it 'returns same String' do
+      word = Faker::Lorem.word
+      Settings.hello = word
+      expect( Settings.hello ).to eq(word)
+    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)
+    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)
+    end
+    it 'not destroys record with nil value #1' do
+      word = Faker::Lorem.word
+      Settings.some = word
+      expect{ Settings.some = nil }.to change{ Settings.count }.by(0)
+    end
 
-  it 'destroys record with nil value #2' do
-    word = Faker::Lorem.word
-    Settings.some.hello = word
-    expect{ Settings.some.hello = nil }.to change{ Settings.count }.by(-1)
+    it 'not destroys record with nil value #2' do
+      Settings.some.hello = Faker::Lorem.word
+      expect{ Settings.some.hello = nil }.to change{ Settings.count }.by(0)
+    end
   end
 
   describe 'with empty value' do
@@ -70,28 +69,18 @@ describe Settings do
     end
   end
 
-  describe '::cached' do
-    it 'not raises error without params' do
-      expect{ Settings.cached }.to_not raise_error
-    end
-
-    it 'not raises error with params' do
-      expect{ Settings.cached(Random.rand(10)) }.to_not raise_error
-    end
-
-    it 'returns instance of self class' do
-      expect( Settings.cached ).to be_a(Settings)
+  describe 'caching' do
+    it 'delete key before destroy' do
+      Settings.some.hello = Faker::Lorem.word
+      Settings.all.each{|e| e.destroy! }
+      expect( Rails.cache.exist?('settingson_cache/some.hello') ).to be false
     end
 
-    it 'returns same value for complex key #1' do
-      word = Faker::Lorem.word
-      Settings.hello.hello = word
-      expect( Settings.cached.hello.hello ).to eq(word)
-    end
-    it 'returns same value for complex key #2' do
-      word = Faker::Lorem.word
-      Settings.i.hello = word
-      expect( Settings.cached.i.hello ).to eq(word)
+    it 'returns empty value after destroy' do
+      Settings.some.hello = Faker::Lorem.word
+      Settings.all.each{|e| e.destroy! }
+      expect( Settings.some.hello.to_s ).to be_empty
     end
   end
+
 end

data/spec/spec_helper.rb

@@ -38,6 +38,7 @@ RSpec.configure do |config|
 
   config.around(:each) do |example|
     DatabaseCleaner.cleaning do
+      Rails.cache.clear rescue nil
       example.run
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settingson
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.12
 platform: ruby
 authors:
 - dan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -141,6 +141,7 @@ files:
 - lib/generators/settingson/settingson_generator.rb
 - lib/generators/settingson/templates/migrations/rename_name_to_key_on_settings.rb
 - lib/settingson.rb
+- lib/settingson/config.rb
 - lib/settingson/engine.rb
 - lib/settingson/store.rb
 - lib/settingson/version.rb
@@ -214,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Settings management for Ruby on Rails 4 applications (ActiveRecord)