redis_attr 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis_attr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Haruska
+
+MIT License
+
+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,39 @@
+# RedisAttr
+
+RedisAttr builds on the great Redis::Objects project. It provides more meta-
+programming info around the redis attributes, some nice helper methods for
+grabbing the values, and ability to auto-cleanup redis on destroy of the 
+object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_attr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_attr
+
+## Usage
+
+To use on any ruby object, just include `RedisAttr::Model`. It will then
+provide you with enhanced Redis::Objects.
+
+    class MyObj
+      include RedisAttr::Model
+
+      counter :num_calls
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/redis_attr.rb

@@ -0,0 +1,5 @@
+require 'redis_attr/version'
+require 'redis_attr/model'
+
+module RedisAttr
+end

data/lib/redis_attr/model.rb

@@ -0,0 +1,53 @@
+require 'active_support/concern'
+require 'redis-objects'
+
+module RedisAttr
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      after_destroy :clean_redis_attributes if respond_to?(:after_destroy)
+    end
+
+    def redis_attributes
+      self.class.redis_attributes
+    end
+
+    def set_redis_keys_expire(seconds = 3.days)
+      self.redis_attributes.each do |attr|
+        send(attr).expire(seconds)
+      end
+    end
+
+    def clean_redis_attributes
+      set_redis_keys_expire(1.minute)
+    end
+
+    module ClassMethods
+      attr_writer :redis_attributes
+      def redis_attributes
+        @redis_attributes ||=[]
+      end
+
+
+      def counter(name, opts={})
+        counter_name = "#{name}_counter".to_sym
+        super counter_name, opts
+        define_method(name) { send(counter_name).to_i }
+
+        self.redis_attributes << counter_name
+      end
+
+      def hash_key(name, opts={})
+        super name, opts
+        self.redis_attributes << name
+      end
+
+      def value(name, opts={})
+        super name, opts
+        self.redis_attributes << name
+      end
+    end
+  end
+end
+

data/lib/redis_attr/version.rb

@@ -0,0 +1,3 @@
+module RedisAttr
+  VERSION = "0.0.1"
+end

data/redis_attr.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_attr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_attr"
+  spec.version       = RedisAttr::VERSION
+  spec.authors       = ["Jason Haruska"]
+  spec.email         = ["jason@haruska.com"]
+  spec.description   = %q{Ruby model attributes backed by redis}
+  spec.summary       = %q{An opinionated Redis::Objects}
+  spec.homepage      = "https://github.com/haruska/redis_attr"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ">= 3.0.2", "< 4.1"
+  spec.add_runtime_dependency "redis-objects"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "shoulda-context"
+  spec.add_development_dependency "factory_girl"
+  spec.add_development_dependency "active_attr"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "minitest"
+end

data/test/test_helper.rb

@@ -0,0 +1,41 @@
+require 'bundler/setup'
+
+require 'test/unit'
+require 'shoulda-context'
+require 'factory_girl'
+require 'active_attr'
+require 'active_attr/model'
+require 'faker'
+require 'active_record'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'unit'))
+
+require 'redis_attr'
+
+ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => File.expand_path(File.dirname(__FILE__) + '/testing_redis_attr.sqlite3')
+)
+
+ActiveRecord::Schema.define do
+  create_table :my_runs, :force => true
+end
+
+class MyRun < ActiveRecord::Base
+  include Redis::Objects
+  include RedisAttr::Model
+
+  counter :jobs_remaining
+  hash_key :next_high_watermark
+  value :still_active, :default => true
+end
+
+FactoryGirl.define do
+  factory :my_run do
+    after(:create) do |r|
+      r.jobs_remaining_counter.incr(rand(5))
+      r.next_high_watermark[Faker::Lorem.word] = Faker::Lorem.sentence
+    end
+  end
+end

data/test/unit/model_test.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper.rb'))
+
+module RedisAttr
+  class ModelTest < Test::Unit::TestCase
+    setup do
+      @run = FactoryGirl.create(:my_run)
+    end
+
+    teardown do
+      @run.set_redis_keys_expire(1)
+    end
+
+    should 'keep track of redis attribute names' do
+      [:jobs_remaining_counter, :next_high_watermark, :still_active].each do |attr|
+        assert @run.redis_attributes.include?(attr), "#{attr} not included in #{@run.redis_attributes}"
+      end
+    end
+
+    should 'add helper method for counters that returns current integer value' do
+      assert_equal @run.jobs_remaining_counter.value.to_i, @run.jobs_remaining
+    end
+
+    should 'clean redis attributes' do
+      @run.redis_attributes.each {|a| assert_equal -1, @run.send(a).ttl}
+
+      @run.clean_redis_attributes
+
+      @run.redis_attributes.each do |a|
+        assert @run.send(a).ttl > 0
+        assert @run.send(a).ttl <= 60
+      end
+    end
+
+    should 'hook into after_destroy if exists' do
+      @run.redis_attributes.each {|a| assert_equal -1, @run.send(a).ttl}
+
+      @run.destroy
+
+      @run.redis_attributes.each do |a|
+        assert @run.send(a).ttl > 0
+        assert @run.send(a).ttl <= 60
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,258 @@
+--- !ruby/object:Gem::Specification
+name: redis_attr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jason Haruska
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: activesupport
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: redis-objects
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: bundler
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: test-unit
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: shoulda-context
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: factory_girl
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: active_attr
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: activerecord
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: sqlite3
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: faker
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  type: :development
+  name: minitest
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Ruby model attributes backed by redis
+email:
+- jason@haruska.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_attr.rb
+- lib/redis_attr/model.rb
+- lib/redis_attr/version.rb
+- redis_attr.gemspec
+- test/test_helper.rb
+- test/unit/model_test.rb
+homepage: https://github.com/haruska/redis_attr
+licenses:
+- MIT
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An opinionated Redis::Objects
+test_files:
+- test/test_helper.rb
+- test/unit/model_test.rb
+has_rdoc: