settingson 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bc944517c38509cc56dc881c8e0516b019f4a98
-  data.tar.gz: cc3effd4a6a30541a13c3eae25beec238571ceee
+  metadata.gz: fe05f0f361a5568a359fb45b6fa141efcc09b14a
+  data.tar.gz: 01c34a1af2329cc4eaa44f0384a7c508f4f643cf
 SHA512:
-  metadata.gz: 1874fc31728b47857277247b9c99edce5403a4222cbe38e8ae7ff70de7acb4b38cb3ef77ee88ba39e5818f7ad4488e41bd638b7189f3ec2c7410011628484454
-  data.tar.gz: 3e27762c7bba87480c3c9adc8bcd50140845d6d55f0d2dd97756b5188ad182080b8e0af9701110ff52b0c74c67f418b7de948644f3a4823e69a4156c8cad3ace
+  metadata.gz: f970836ba3dc03f7f711a9cf21a5c855bf920d6a1b095bdaba08ff9d34a18ad0a2722d3b416426afdcbf2432ff6cd1a89f7f79cd8a7c6ff95875d9acbc50ebc1
+  data.tar.gz: 4d566c47608e3f53eb34ca609e023d4f870191322deb298bb47d41986ad96b0e169defa470d4505d39e221968f0d47a88da7abda924906f169fc141ffd618ee6

data/.rspec

@@ -1,3 +1,4 @@
 --color
 --require spec_helper
---format doc
+--format doc
+--fail-fast

data/README.md

@@ -15,29 +15,56 @@ rake db:migrate
 
 code:
 ```ruby
-Settings.server.host = '127.0.0.1'
-Settings.server.port = '8888'
+Settings.server.host = '127.0.0.1'        # => '127.0.0.1'
+Settings.server.port = '8888'             # => '8888'
 
-Settings.server.host        # => '127.0.0.1'
-Settings.server.port        # => '8888'
+Settings.server.host                      # => '127.0.0.1'
+Settings.server.port                      # => '8888'
 
-Settings.server.smtp.host = '127.0.0.1'
-Settings.server.smtp.port = 25
+Settings.server.smtp.host = '127.0.0.1'   # => '127.0.0.1'
+Settings.server.smtp.port = 25            # => 25
 
-Settings.server.smtp.host   # => "127.0.0.1"
-Settings.server.smtp.port   # => 25
+Settings.server.smtp.host                 # => "127.0.0.1"
+Settings.server.smtp.port                 # => 25
 
 Settings.from_hash({hello: :world})
-Settings.hello              # => :world
+Settings.hello                            # => :world
 
-Settings.not_found          # => ""
-Settings.not_found.nil?     # => true
-Settings.not_found.empty?   # => true
-Settings.not_found.blank?   # => true
-Settings.not_found.present? # => false
+Settings.not_found                        # => ""
+Settings.not_found.nil?                   # => true
+Settings.not_found.empty?                 # => true
+Settings.not_found.blank?                 # => true
+Settings.not_found.present?               # => false
 
 # but
 Settings.not_found.class    # => Settings(id: integer, key: string, value: text, created_at: datetime, updated_at: datetime)
+
+Settings.all                # =>
+# [#<Settings id: 1, key: "server.host", value: "127.0.0.1", created_at: "2015-12-08 15:17:56", updated_at: "2015-12-08 15:17:56">,
+#  #<Settings id: 2, key: "server.port", value: "8888", created_at: "2015-12-08 15:17:56", updated_at: "2015-12-08 15:17:56">,
+#  #<Settings id: 3, key: "server.smtp.host", value: "127.0.0.1", created_at: "2015-12-08 15:18:21", updated_at: "2015-12-08 15:18:21">,
+#  #<Settings id: 4, key: "server.smtp.port", value: 25, created_at: "2015-12-08 15:18:22", updated_at: "2015-12-08 15:18:22">,
+#  #<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'
 ```
 
 ### Using with [Simple Form](https://github.com/plataformatec/simple_form) and [Haml](https://github.com/haml/haml)
@@ -65,16 +92,17 @@ end
 ```
 
 ## The initial values
+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
-  end
+Settings.defaults do
+  Settings.server.smtp.host? || Settings.server.smtp.host = 'host'
+  Settings.server.smtp.port? || Settings.server.smtp.port = 25
+end
 ```
 
 Old way:
+in config/initializers/settingson.rb
 ```ruby
 Rails.application.config.after_initialize do
   begin

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

@@ -25,6 +25,37 @@ 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 NoMethodError
@@ -32,35 +63,33 @@ module Settingson::Base
     case symbol.to_s
     when /(.+)=/  # setter
 
-      if not defined?(@settingson) or @settingson.blank?
-        @settingson = $1
-      else
-        @settingson += ".#{$1}"
-      end
+      _settingson_find_or_create($1)
 
-      if record = self.class.find_by(key: @settingson) and args.first.nil?
+      if args.first.nil? and record = _settingson_fresh_value
         record.destroy
-      elsif record
-        record.update(value: args.first)
+      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 = "#{@settingson}.#{$1}"
-      self.class.find_by(key: @settingson).present?
+
+      _settingson_find_or_create($1)
+      _settingson_value.present?
+
     when /(.+)\!$/  # returns self or nil
-      @settingson = "#{@settingson}.#{$1}"
-      self.class.find_by(key: @settingson)
+
+      _settingson_find_or_create($1)
+      _settingson_value
+
     else # returns values or self
 
-      if not defined?(@settingson) or @settingson.blank?
-          @settingson = "#{symbol.to_s}"
-      else
-          @settingson += ".#{symbol.to_s}"
-      end
+      _settingson_find_or_create(symbol.to_s)
 
-      if record = self.class.find_by(key: @settingson)
+      if record = _settingson_value
         record.value
       else
         self
@@ -109,7 +138,9 @@ module Settingson::Base
         elsif record
           record.update(value: args.first)
         else
-          create(key: @settingson, value: args.first, settingson: @settingson)
+          self.create(key: @settingson,
+                      value: args.first,
+                      settingson: @settingson)
         end
       when /(.+)\?$/  # returns boolean
         find_by(key: $1).present?
@@ -126,7 +157,10 @@ module Settingson::Base
       end
     end
 
+    def cached(expires_in = 10.seconds)
+      new._settingson_cached(expires_in: expires_in)
+    end
 
-  end
+  end # module ClassMethods
 
 end

data/lib/settingson/version.rb

@@ -1,3 +1,3 @@
 module Settingson
-  VERSION = "1.3.4"
+  VERSION = "1.4.0"
 end

data/spec/models/settings_spec.rb

@@ -69,4 +69,29 @@ describe Settings do
       expect( Settings.not_found.present? ).to be(false)
     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)
+    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)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: settingson
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.0
 platform: ruby
 authors:
 - dan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-08 00:00:00.000000000 Z
+date: 2015-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails