ar_redis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a15374d7f8e3c5015ac2fcd4213345b3b7fdde3e
+  data.tar.gz: dd765a699ce6db97a8d4f7b8e189c19deede15f8
+SHA512:
+  metadata.gz: cefadb4f221d15f461a7652e1c1c35967674601f012b2da1d33d585887e6c7f250eb6d8c8c48fe6328c33c246c02d29e3d36a9f6537b48241f76f299d978b0a6
+  data.tar.gz: 475ac05fa76e64bb2867cc134ea846b62fb9a12f626e2d3e96541bb299c58e69583518f5ed9e19b384838acc4c749a6231d05c4ef973616997a62ddf07fce8df

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Nick Weiland
+
+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,80 @@
+# ArRedis
+ArRedis allows you to easily create and remove nested, namespaced Redis keys under ActiveRecord objects and classes. The functionality is inspired by [this RailsConf presentation](https://www.youtube.com/watch?v=dH6VYRMRQFw) by Obie Fernandez.  Also, [Nest](https://github.com/soveran/nest) is a similar gem that does not hook into ActiveRecord.
+
+## Installation
+Add this line to the Gemfile of an application that uses ActiveRecord:
+
+```ruby
+gem 'ar_redis'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+If you are not using Redis in you application yet, setup the [redis-rb gem](https://github.com/redis/redis-rb).
+
+## Usage
+
+All ActiveRecord models will be provided with the method ```#redis```.
+
+Given:
+
+```ruby
+class TestModel < ActiveRecord::Base
+end
+```
+
+You can now create nested, namespaced Redis keys that have access to all [Redis commands](https://redis.io/commands).
+
+```ruby
+>> test_model = TestModel.create
+>> #<TestModel:0x007fc08a466890 id: 1>
+
+>> test_model.redis.key
+=> "TestModel:1"
+
+>> test_model.redis[:reports]["01/2018"].key
+=> "TestModel:1:reports:01/2018"
+
+>> test_model.redis[:reports]["01/2018"].call(:set, { clicks: 12, views: 100 }.to_json)
+=> "OK"
+
+>> JSON.parse(test_model.redis[:reports]["01/2018"].call(:get))
+=> { clicks: 12, views: 100 }
+```
+
+### Configuring your Redis Client
+Here's an example of how you can pass a specific Redis client to ArRedis
+
+```ruby
+# initializers/redis.rb
+$redis = Redis.new(host: "10.0.1.1", port: 6380, db: 15)
+ArRedis.redis = $redis
+```
+
+## Contributing
+
+Write some code!
+
+1. [Fork](https://help.github.com/articles/fork-a-repo) ArRedis
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create a [Pull Request](http://help.github.com/pull-requests/) from your
+   branch
+5. That's it!
+
+If you're not doing some sort of refactoring, a CHANGELOG entry is appropriate.
+Please include them in pull requests adding features or fixing bugs.
+
+Tests
+-----
+
+We use rspec for testing.
+
+A simple `bundle exec rspec` will run all the tests. Make sure they pass when
+you submit a pull request.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task default: :spec

data/lib/ar_redis.rb

@@ -0,0 +1,21 @@
+require "redis"
+require "active_support"
+require "ar_redis/version"
+require "ar_redis/base"
+require "ar_redis/active_record_ext"
+
+module ArRedis
+  extend self
+
+  def redis
+    return @redis if @redis
+    self.redis = Redis.new
+    self.redis
+  end
+
+  def redis=(server)
+    if server.is_a?(Redis)
+      @redis = server
+    end
+  end
+end

data/lib/ar_redis/active_record_ext.rb

@@ -0,0 +1,11 @@
+ActiveSupport.on_load(:active_record) do
+  ::ActiveRecord::Base.class_eval do
+    def redis
+      ArRedis::Base.new(self.class.name)[id]
+    end
+
+    def self.redis
+      ArRedis::Base.new(name)
+    end
+  end
+end

data/lib/ar_redis/base.rb

@@ -0,0 +1,30 @@
+module ArRedis
+  class Base
+    attr_reader :key, :redis_client
+
+    def initialize(key)
+      @key = key.to_s
+      @redis_client = ArRedis.redis
+    end
+
+    def [](next_key)
+      ArRedis::Base.new("#{key}:#{next_key}")
+    end
+
+    def call(command, *arguments)
+      redis_client.call(command, key, *arguments)
+    end
+
+    def delete_all
+      keys = redis_client.keys("#{self}*")
+
+      unless keys.blank?
+        redis_client.del(keys)
+      end
+    end
+
+    def to_s
+      key
+    end
+  end
+end

data/lib/ar_redis/version.rb

@@ -0,0 +1,3 @@
+module ArRedis
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: ar_redis
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Weiland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-23 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: 3.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: sqlite3
+  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: 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: pry
+  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: Adds out-of-the-box namespaced and nested Redis keys for ActiveRecord
+  objects.
+email:
+- nickweiland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/ar_redis.rb
+- lib/ar_redis/active_record_ext.rb
+- lib/ar_redis/base.rb
+- lib/ar_redis/version.rb
+homepage: https://github.com/weilandia/ar_redis
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveRecord keys for Redis.
+test_files: []