ohm-expire 0.1.1 → 0.1.2

data/README.md

@@ -1,4 +1,53 @@
 ohm-expire
 ==========
 
-Ohm plugin that exposes ttl control over modules
+Ohm plugin that exposes ttl control over modules
+
+Getting started
+---------------
+
+Install gem by running:
+
+    $ [sudo] gem install ohm-expire
+
+On your source code add:
+
+    require "ohm/expire"
+
+After this you need to tell your Ohm Model that it needs to use this extension. Here is an example of a module:
+
+    class Model < Ohm::Model
+
+        include Ohm::Expire
+
+        TTL = 5
+
+        attribute :hash
+        index :hash
+
+        expire Model::TTL
+
+        attribute :data
+    end
+
+This will create this Ohm Model class with an expire of 5 seconds
+
+Updating TTL
+------------
+
+It's easy to update the TTL after creating a Model.
+There is also the possibility to simple update the ttl with the default value (the one that was defined on the Model)
+
+Taking the example above:
+
+    m = Model.create(:hash => "123")
+    m.update_ttl 30 # Updated to 30 seconds
+    m.update_ttl # Updated to 5 seconds (Model::TTL)
+
+Getting TTL
+-----------
+
+To get the TTL of a given model:
+
+    m = Model.create(:hash => "123")
+    m.get_ttl

data/lib/ohm/expire.rb

@@ -49,6 +49,7 @@ module Ohm
             #
             # * self
             def create(*args)
+                args.first.merge!(:_default_expire => @expire)
                 object = super(*args)
                 if !object.new? && @expire
                     Ohm.redis.expire(object.key, @expire)
@@ -64,11 +65,14 @@ module Ohm
     # Extends Ohm::Model with new methods
     class Model
 
+        attribute :_default_expire
+
         # Update the ttl of a given Model
         #
         # ==== Attributes
         #
-        # * +model <i>Ohm::Model</i>+ - A Ohm model that will be used to update its ttl
+        # * +model <i>Ohm::Model</i>+ - A Ohm model that will be used to update its ttl. If nil, value will fallback
+        #                               to default expire
         # * +new_ttl <i>Fixnum</i>+ - The new expire amount
         #
         # ==== Returns
@@ -79,7 +83,7 @@ module Ohm
         #
         #   d = Model.create(:hash => "123")
         #   Model.update_ttl(d, 30)
-        def self.update_ttl(model, new_ttl)
+        def self.update_ttl(model, new_ttl=nil)
             unless model.respond_to? :update_ttl
                 model.update_ttl new_ttl
             end
@@ -89,7 +93,7 @@ module Ohm
         #
         # ==== Attributes
         #
-        # * +new_ttl <i>Fixnum</i>+ - The new expire amount
+        # * +new_ttl <i>Fixnum</i>+ - The new expire amount. If nil, value will fallback to default expire
         #
         # ==== Returns
         #
@@ -99,7 +103,9 @@ module Ohm
         #
         #   d = Model.create(:hash => "123")
         #   d.update_ttl(30)
-        def update_ttl new_ttl
+        def update_ttl new_ttl=nil
+            # Load default if no new ttl is specified
+            new_ttl = self._default_expire if new_ttl.nil?
             # Make sure we have a valid value
             new_ttl = -1 if !new_ttl.to_i.is_a?(Fixnum) || new_ttl.to_i < 0
             # Update indices

data/test/expire-test.rb

@@ -1,15 +1,16 @@
 require_relative "helper"
 require "ohm/expire"
 
-
 class Model < Ohm::Model
 
     include Ohm::Expire
 
+    TTL = 5
+
     attribute :hash
     index :hash
 
-    expire 5
+    expire TTL
 
     attribute :data
 end
@@ -18,17 +19,21 @@ test do
     Ohm.flush
 
     m = Model.create(:hash => "123")
-    assert_equal 5, m.get_ttl
+    assert_equal Model::TTL, m.get_ttl
 
-    m.update_ttl 2
-    assert_equal 2, m.get_ttl
+    m.update_ttl 3
+    assert_equal 3, m.get_ttl
 
     sleep 1
 
     m = Model.find(:hash => "123").first
     assert !m.hash.nil?
 
-    sleep 2
+    # Update with default expire
+    m.update_ttl
+    assert_equal Model::TTL, m.get_ttl
+
+    sleep 6
 
     m = Model.find(:hash => "123").first
     assert m.hash.nil?

metadata

@@ -2,7 +2,7 @@
 name: ohm-expire
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
   - "Jos\xC3\xA9 P. Airosa"