ohm-expire 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 José P. Airosa
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+ohm-expire
+==========
+
+Ohm plugin that exposes ttl control over modules

data/Rakefile

@@ -0,0 +1,31 @@
+require "rake/testtask"
+
+REDIS_DIR = File.expand_path(File.join("..", "test"), __FILE__)
+REDIS_CNF = File.join(REDIS_DIR, "test.conf")
+REDIS_PID = File.join(REDIS_DIR, "db", "redis.pid")
+
+task :default => :run
+
+desc "Run tests and manage server start/stop"
+task :run => [:start, :test, :stop]
+
+desc "Start the Redis server"
+task :start do
+    unless File.exists?(REDIS_PID)
+        system "redis-server #{REDIS_CNF}"
+    end
+end
+
+desc "Stop the Redis server"
+task :stop do
+    if File.exists?(REDIS_PID)
+        system "kill #{File.read(REDIS_PID)}"
+        File.delete(REDIS_PID)
+    end
+end
+
+task :test do
+    require File.expand_path("./test/helper", File.dirname(__FILE__))
+
+    Cutest.run(Dir["test/*.rb"])
+end

data/lib/ohm/expire.rb

@@ -0,0 +1,145 @@
+module Ohm
+    # Main expire module
+    # ==== Examples
+    #
+    #   Model < Ohm::Model
+    #       include Ohm::Expire
+    #   end
+    module Expire
+
+        # Extend this module with Ohm
+        def self.included(base)
+            base.send(:extend, ClassMethods)
+        end
+
+        # Extends Ohm::Model with new class methods
+        module ClassMethods
+
+            # Set expire for this model
+            #
+            # ==== Attributes
+            #
+            # * +ttl <i>Fixnum</i>+ - The expire amount in seconds
+            #
+            # ==== Returns
+            #
+            # * nil
+            #
+            # ==== Examples
+            #
+            #   Model < Ohm::Model
+            #       include Ohm::Expire
+            #
+            #       attribute :hash
+            #       index :hash
+            #
+            #       expire 30
+            #   end
+            def expire(ttl)
+                @expire = ttl.to_i
+            end
+
+            # Callback that is called everytime a new Model is created. This will initialize the export parameters.
+            #
+            # ==== Attributes
+            #
+            # * +args <i>Array</i>+ - The arguments supplied on the create method
+            #
+            # ==== Returns
+            #
+            # * self
+            def create(*args)
+                object = super(*args)
+                if !object.new? && @expire
+                    Ohm.redis.expire(object.key, @expire)
+                    Ohm.redis.expire("#{object.key}:_indices", @expire)
+                end
+                object
+            end
+        end
+    end
+end
+
+module Ohm
+    # Extends Ohm::Model with new methods
+    class Model
+
+        # Update the ttl of a given Model
+        #
+        # ==== Attributes
+        #
+        # * +model <i>Ohm::Model</i>+ - A Ohm model that will be used to update its ttl
+        # * +new_ttl <i>Fixnum</i>+ - The new expire amount
+        #
+        # ==== Returns
+        #
+        # * nil
+        #
+        # ==== Examples
+        #
+        #   d = Model.create(:hash => "123")
+        #   Model.update_ttl(d, 30)
+        def self.update_ttl(model, new_ttl)
+            unless model.respond_to? :update_ttl
+                model.update_ttl new_ttl
+            end
+        end
+
+        # Update the ttl
+        #
+        # ==== Attributes
+        #
+        # * +new_ttl <i>Fixnum</i>+ - The new expire amount
+        #
+        # ==== Returns
+        #
+        # * nil
+        #
+        # ==== Examples
+        #
+        #   d = Model.create(:hash => "123")
+        #   d.update_ttl(30)
+        def update_ttl new_ttl
+            # 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
+            Ohm.redis.expire(self.key, new_ttl)
+            Ohm.redis.expire("#{self.key}:_indices", new_ttl)
+        end
+
+        # Get ttl for a given Model
+        #
+        # ==== Attributes
+        #
+        # * +model <i>Ohm::Model</i>+ - A Ohm model that will be used to retrieve its ttl
+        #
+        # ==== Returns
+        #
+        # * nil
+        #
+        # ==== Examples
+        #
+        #   d = Model.create(:hash => "123")
+        #   Model.get_ttl(d)
+        def self.get_ttl model
+            unless model.respond_to? :get_ttl
+                model.get_ttl
+            end
+        end
+
+        # Get ttl for a given Model
+        #
+        # ==== Returns
+        #
+        # * nil
+        #
+        # ==== Examples
+        #
+        #   d = Model.create(:hash => "123")
+        #   d.get_ttl
+        def get_ttl
+            Ohm.redis.ttl(self.key)
+        end
+
+    end
+end

data/test/expire-test.rb

@@ -0,0 +1,35 @@
+require_relative "helper"
+require "ohm/expire"
+
+
+class Model < Ohm::Model
+
+    include Ohm::Expire
+
+    attribute :hash
+    index :hash
+
+    expire 5
+
+    attribute :data
+end
+
+test do
+    Ohm.flush
+
+    m = Model.create(:hash => "123")
+    assert_equal 5, m.get_ttl
+
+    m.update_ttl 2
+    assert_equal 2, m.get_ttl
+
+    sleep 1
+
+    m = Model.find(:hash => "123").first
+    assert !m.hash.nil?
+
+    sleep 2
+
+    m = Model.find(:hash => "123").first
+    assert m.hash.nil?
+end

data/test/helper.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+begin
+  require "ruby-debug"
+rescue LoadError
+end
+
+require "rubygems"
+require "cutest"
+
+def silence_warnings
+  original_verbose, $VERBOSE = $VERBOSE, nil
+  yield
+ensure
+  $VERBOSE = original_verbose
+end
+
+$VERBOSE = true
+
+require "ohm"
+
+prepare do
+  Ohm.redis.flushall
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: ohm-expire
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.1.0
+platform: ruby
+authors:
+- José P. Airosa
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-05-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ohm
+  version_requirements: &2056 !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    none: false
+  requirement: *2056
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: cutest
+  version_requirements: &2074 !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    none: false
+  requirement: *2074
+  prerelease: false
+  type: :development
+description: A simple but useful plugin for Ohm that enables control over Redis TTL through Ohm
+email: me@joseairosa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ohm/expire.rb
+- README.md
+- LICENSE
+- Rakefile
+- test/expire-test.rb
+- test/helper.rb
+homepage: http://i.am.joseairosa.com/gems/ohm-expire
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: ohm-expire
+rubygems_version: 1.8.15
+signing_key:
+specification_version: 3
+summary: Ohm Expire Plugin
+test_files: []
+has_rdoc:
+...