redis_field 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92ca1df1cd3b11678cf1b4b5c69192f61c51cddb
+  data.tar.gz: 23ebf3789852b1db989db9b038fdfbb08094a444
+SHA512:
+  metadata.gz: 7bbbe4accc45ab56acd0cae5ee5f0a3e1426d53e200b08c93e3e489a833b3e52dbeebf8c34a932245dfc4483035efd0fa63f444048789d95956e5c61e51946ea
+  data.tar.gz: 8926f8e07a10ce0aa970d49a0abbfda1a19a63a76a6e3ca6294d4b265eb2123b5ba93552a93e4f45ac53016c891d790d97b1d4c95d499d95c765339bdb3935e8

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby-1.7.9
+services:
+  - redis-server

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'activerecord-3.2' do
+  gem "activerecord", "~> 3.2"
+end
+
+appraise 'activerecord-4.0' do
+  gem "activerecord", "~> 4.0"
+end

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem "appraisal"
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Theodore Konukhov
+
+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,74 @@
+# RedisField [![Build Status](https://travis-ci.org/konukhov/redis_field.svg?branch=master)](https://travis-ci.org/konukhov/redis_field) [![Code Climate](https://codeclimate.com/github/konukhov/redis_field.png)](https://codeclimate.com/github/konukhov/redis_field)
+
+RedisField is a simple Ruby gem that stores model-specific data to Redis just like normal ActiveRecord attributes.
+
+Great for caches, API responses etc.
+
+## Installation
+
+You will need ActiveRecord 3.2+ (oops, gotta test it).
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'redis_field', github: 'konukhov/redis_field'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+### 1. Specify field names in your model
+
+```ruby
+  class User < ActiveRecord::Base
+    redis_field :some_data
+
+    # redis_fields is just an alias to redis_field
+    redis_fields :facebook_friend_ids, :last_logged_in
+  end
+```
+
+### 2. Use these fields just like normal AR attributes
+
+```ruby
+  user = User.last
+```
+
+```ruby
+  user.some_data = "Testing redis_field"
+  user.save
+  user.reload.some_data # -> "Testing redis_field"
+```
+
+```ruby
+  user.update_attributes(last_logged_in: Time.now)
+  user.reload.last_logged_in # -> 2014-04-05 01:00:00 +0000
+```
+
+
+
+**NB** This library is not an ORM for Redis, so it simply marshalls data before storing to Redis. There's no types coercion or anything like that.
+
+More docs and features soon. :heart:
+
+## Testing
+
+Just run
+
+```
+$ rake spec
+```
+
+See [Appraisal](https://github.com/thoughtbot/appraisal) for testing against different ActiveRecord versions.
+
+## 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,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+desc 'Default: run specs'
+task :default => :spec  
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+Bundler::GemHelper.install_tasks

data/lib/redis_field.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+require 'redis'
+require 'redis/namespace'
+
+require 'redis_field/base'
+require 'redis_field/active_record'
+require 'redis_field/version'
+
+module RedisField
+  # more detailed explanation
+  class NotCompatibleError < StandardError; end
+end
+
+if defined?(ActiveRecord::Base)
+  # railtie?
+  ActiveRecord::Base.send :include, RedisField::ActiveRecord
+else
+  raise RedisField::NotCompatibleError
+end

data/lib/redis_field/active_record.rb

@@ -0,0 +1,29 @@
+require 'redis_field/active_record/class_methods'
+
+module RedisField
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+    end
+
+    def redis_fields
+      self.class.redis_fields
+    end
+
+    def get_redis_fields
+      redis_fields.each do |field_name|
+        send "#{field_name}=", Base.new(self, field_name).get
+      end
+    end
+
+    def sync_redis_fields!
+      redis_fields.each do |field_name|
+        if send(field_name).present?
+          Base.new(self, field_name).set send(field_name)
+        end
+      end
+    end
+  end
+end

data/lib/redis_field/active_record/class_methods.rb

@@ -0,0 +1,46 @@
+require 'redis_field/dirty_field_set'
+
+module RedisField
+  module ActiveRecord
+    module ClassMethods
+
+      def redis_fields
+        @redis_fields ||= DirtyFieldSet.new
+      end
+
+      def has_redis_fields(*field_names)
+        redis_fields.add(*field_names)
+
+        init_redis_field_callbacks
+        init_redis_field_accessors
+      end 
+      alias_method :has_redis_field, :has_redis_fields
+
+      private
+
+      def init_redis_field_callbacks
+        unless @_redis_fields_callbacks_initted
+          class_eval do
+            after_save       :sync_redis_fields!
+            after_initialize :get_redis_fields
+          end
+          @_redis_fields_callbacks_initted = true
+        end
+      end
+
+      def init_redis_field_accessors
+        redis_fields.changes.each do |field_name|
+          method_name = :"#{field_name}_redis_value"
+
+          class_eval do 
+            attr_accessor method_name
+          end
+
+          alias_method :"#{field_name}", method_name
+          alias_method :"#{field_name}=", :"#{method_name}="
+        end
+      end
+
+    end
+  end
+end

data/lib/redis_field/base.rb

@@ -0,0 +1,64 @@
+module RedisField
+  class Base
+    class_attribute :redis, :path_prefix, :env
+    attr_writer     :model_id
+
+    # TODO: move to config class
+    class << self
+      def path_prefix
+        @@path_prefix ||= 'ar_redis_field'
+      end
+
+      def redis
+        @@redis ||= Redis.new
+      end
+
+      def env
+        @@env ||= ENV['RAILS_ENV'] || "development"
+      end      
+    end
+
+    def initialize(object, field_name)
+      @object, @field_name = object, field_name
+    end
+
+    def set(value)
+      redis.set @field_name, Marshal.dump(value)
+    end
+
+    def get
+      Marshal.load field_path if field_path
+    end
+
+    private
+
+    def object_model_name
+      @object_model_name ||= @object.class.model_name.param_key
+    end
+
+    def model_id
+      @model_id ||= @object.id
+    end
+
+    def redis
+      @redis ||= Redis::Namespace.new(redis_path, redis: self.class.redis)
+    end
+
+    def redis_path
+      [
+        self.class.path_prefix, 
+        env, 
+        object_model_name, 
+        model_id
+      ].join ':'
+    end
+
+    def field_path
+      redis[@field_name]
+    end
+
+    def env
+      self.class.env
+    end
+  end
+end

data/lib/redis_field/dirty_field_set.rb

@@ -0,0 +1,28 @@
+require 'set'
+
+module RedisField
+  class DirtyFieldSet
+    def initialize
+      @changes     = Set.new
+      @field_names = Set.new
+    end
+
+    def field_names
+      @field_names.to_a
+    end
+
+    def changes
+      @changes.to_a
+    end
+
+    def each(&block)
+      field_names.each(&block)
+    end
+
+    def add(*new_field_names)
+      new_field_names  = Set.new(new_field_names)
+      @changes         = new_field_names - @field_names
+      @field_names     = @field_names + new_field_names
+    end
+  end
+end

data/lib/redis_field/testing.rb

@@ -0,0 +1,15 @@
+module RedisField
+  module Testing
+    extend self
+
+    def reset_keys!
+      unless Base.env == 'test'
+        raise 'Keys could be resetted only in test environment'
+      end
+
+      path = [Base.path_prefix, Base.env].join ':'
+      keys = Base.redis.keys.grep(/^#{path}.+/)
+      Base.redis.del *keys if keys.any?
+    end
+  end
+end

data/lib/redis_field/version.rb

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

data/redis_field.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_field/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_field"
+  spec.version       = RedisField::VERSION
+  spec.authors       = ["Theodore Konukhov"]
+  spec.email         = ["komolov.f@gmail.com"]
+  spec.summary       = %q{Redis attributes in ActiveRecord models}
+  spec.description   = %q{This gem allows you to easily use Redis to store data as regular ActiveRecord attributes}
+  spec.homepage      = "http://theodore.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord', '>= 3.2'
+  spec.add_dependency 'redis'
+  spec.add_dependency 'redis-namespace'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+end

data/spec/redis_field_spec.rb

@@ -0,0 +1,87 @@
+require_relative './spec_helper.rb'
+
+describe RedisField do
+  describe RedisField::ActiveRecord do
+   TestUser.has_redis_fields :test_field1, :test_field2
+   TestUser.has_redis_field :test_field3
+
+    def get_from_redis(id, key)
+      data = Redis::Namespace.new("ar_redis_field:test:test_user:#{id}", redis: RedisField::Base.redis)[key]
+      Marshal.load data if data
+    end
+
+    let(:klass) { TestUser }
+    subject { klass.new }
+
+    after(:all) do
+      RedisField::Testing.reset_keys!
+    end
+
+    it 'klass has redis fields' do
+      expect(
+        klass.instance_variable_get('@redis_fields').field_names
+      ).to eq([:test_field1, :test_field2, :test_field3])
+    end
+
+    it 'klass\' redis fields are an instance of DirtyFieldSet' do
+      expect(
+        klass.instance_variable_get('@redis_fields')
+      ).to be_instance_of(RedisField::DirtyFieldSet)
+    end 
+
+    it { should respond_to :test_field1 }
+    it { should respond_to :test_field2 }
+    it { should respond_to :test_field3 }
+    it { should respond_to :test_field1= }
+    it { should respond_to :test_field2= }
+    it { should respond_to :test_field3= }
+    it { should respond_to :test_field1_redis_value }
+    it { should respond_to :test_field2_redis_value }
+    it { should respond_to :test_field3_redis_value }
+    it { should respond_to :test_field1_redis_value= }
+    it { should respond_to :test_field2_redis_value= }
+    it { should respond_to :test_field3_redis_value= }
+    it { should respond_to :sync_redis_fields! }
+    it { should respond_to :get_redis_fields }
+
+    it 'runs save callbacks' do
+      subject.run_callbacks(:save) do
+        subject.should_receive :sync_redis_fields!
+      end
+    end
+
+    it 'runs initialize callbacks' do
+      subject.run_callbacks(:initialize) do
+        subject.should_receive :get_redis_fields
+      end
+    end
+
+    describe 'saving' do
+      before(:each) do
+        subject.save
+        @user = subject
+      end
+
+      it 'should not save in redis until the record is saved' do
+        @user.test_field1 = 'test'
+        get_from_redis(@user, 'test_field1').should be_nil
+      end
+
+      it 'should save to redis when the record is saved' do
+        @user.test_field1 = 'test1'
+        @user.test_field2 = 'test2'
+        @user.test_field3 = 'test3'
+
+        @user.save
+
+        get_from_redis(@user.id, 'test_field1').should eq('test1')
+        get_from_redis(@user.id, 'test_field2').should eq('test2')
+        get_from_redis(@user.id, 'test_field3').should eq('test3')
+
+        @user.reload.test_field1.should eq('test1')
+        @user.reload.test_field2.should eq('test2')
+        @user.reload.test_field3.should eq('test3')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler.setup
+
+require 'redis_field'
+require 'redis_field/testing'
+
+RedisField::Base.redis = Redis.new db: 15
+ENV['RAILS_ENV'] = 'test'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define do
+  create_table :test_users do |t|
+    t.string :name
+    t.timestamps
+  end
+end
+
+class TestUser < ActiveRecord::Base; end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: redis_field
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Theodore Konukhov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem allows you to easily use Redis to store data as regular ActiveRecord
+  attributes
+email:
+- komolov.f@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_field.rb
+- lib/redis_field/active_record.rb
+- lib/redis_field/active_record/.keep
+- lib/redis_field/active_record/class_methods.rb
+- lib/redis_field/base.rb
+- lib/redis_field/dirty_field_set.rb
+- lib/redis_field/testing.rb
+- lib/redis_field/version.rb
+- redis_field.gemspec
+- spec/redis_field_spec.rb
+- spec/spec_helper.rb
+homepage: http://theodore.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Redis attributes in ActiveRecord models
+test_files:
+- spec/redis_field_spec.rb
+- spec/spec_helper.rb