redis_collection 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07e47b0f3e2daa373237c88cd56023e9d9ce2406
+  data.tar.gz: 1e744dadcd3429875218d9c7cf3a4fcf2fe0e560
+SHA512:
+  metadata.gz: ad0579ff02defb74a9bb335e352ab5cafbd085b8ac3fc2c232c125d914b8476846f8ae1dffb9358c61f48dd814a53b75fcc3d446addad155f6079fc43624c571
+  data.tar.gz: d07d7822a1a1b22c4a6c75f9f734855515ba96753ae7d53830cda12b77eb5b583987a6ebfbd18fa329a7e4ddf7f470554b4109b2cb4f325f411f10f3cd5013bd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.2
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at max@crossfield.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Maxim Chernyak
+
+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,79 @@
+# RedisCollection
+
+Easily sync an iterable ruby object with a redis namespace.
+
+This tool DOES NOT:
+
+- integrate with anything
+- help retrieve data back from redis
+- handle redis connection issues
+- make birds in 5 mile radius attack you
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_collection'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_collection
+
+## Usage
+
+```ruby
+books = [
+  { 'id' => 1, 'title' => 'Programming Elixir' },
+  { 'id' => 2, 'title' => 'Programming Phoenix' }
+]
+
+redis = Redis.new(url: ENV['REDIS_URL'])
+redis_collection = RedisCollection.new(redis, namespace: 'books_')
+redis_collection.sync(books)
+redis.mget('books_1', 'books_2')
+# => ["\x04\b{\aI\"\aid\x06:\x06ETi\x06I\"\ntitle\x06;\x00TI\"\x17Programming Elixir\x06;\x00T", "\x04\b{\aI\"\aid\x06:\x06ETi\aI\"\ntitle\x06;\x00TI\"\x18Programming Phoenix\x06;\x00T"]
+```
+
+By default each object in the collection is serialized via `Marshal.dump` and loaded via `Marshal.load`. Identity of each object is determined by calling `['id']` by default. To change these defaults you can provide procs to `RedisCollection.new`.
+
+```ruby
+redis_collection = RedisCollection.new(redis,
+  namespace: 'books_',
+  load: -> string { JSON.parse(string) },
+  dump: -> object { object.to_json },
+  make_key: -> object { object.special_id }
+)
+redis_collection.sync(books)
+```
+
+In the above example objects are converted to/from JSON and must respond to `special_id` to be identified.
+
+Method `sync` always overwrites keys that already exist in Redis, and deletes keys that are in Redis but not in collection.
+
+## Benchmark
+
+Method `sync` returns a hash of stats containing 3 pieces of information:
+
+1. `:mset_cnt` - how many strings were [mset](http://redis.io/commands/mset)
+2. `:del_cnt` - how many strings were [del](http://redis.io/commands/del)
+3. `:time` - the result of `Benchmark.measure {}` on the redis call
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/crossfield/redis_collection. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis_collection"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redis_collection.rb

@@ -0,0 +1,98 @@
+require 'redis_collection/version'
+require 'set'
+require 'benchmark'
+
+class RedisCollection
+  def initialize(redis,
+    namespace: '',
+    load:     -> string { Marshal.load(string) },
+    dump:     -> object { Marshal.dump(object) },
+    make_key: -> object { object['id'] }
+  )
+
+    @redis         = redis
+    @namespace     = namespace
+    @load_proc     = load
+    @dump_proc     = dump
+    @make_key_proc = make_key
+
+    clear_args
+  end
+
+  attr_reader :redis, :namespace, :load_proc, :dump_proc, :make_key_proc
+
+  ##
+  # Sync values under a redis namespace with the given collection by
+  #
+  #   - overwriting existing values
+  #   - deleting what's not in collection
+  #
+  def sync(collection)
+    clear_args
+    updated_namespaced_keys = Set.new
+
+    each_with_key(collection) do |object, key|
+      updated_namespaced_keys << "#{namespace}#{key}"
+      add_mset "#{namespace}#{key}", dump(object)
+    end
+
+    redis.scan_each(match: "#{namespace}*") do |namespaced_key|
+      unless updated_namespaced_keys.include?(namespaced_key)
+        add_del namespaced_key
+      end
+    end
+
+    exec!
+  end
+
+  private
+
+  def exec!
+    stats = {
+      mset_cnt: @mset_args.size / 2,
+      del_cnt:  @del_args.size
+    }
+
+    stats[:time] = Benchmark.measure {
+      redis.multi do |multi|
+        multi.mset(*@mset_args) unless @mset_args.empty?
+        multi.del(*@del_args)   unless @del_args.empty?
+      end
+    }
+
+    stats
+  end
+
+  def each_with_key(collection)
+    collection.each do |object|
+      yield object, make_key(object)
+    end
+  end
+
+  def add_mset(key, value)
+    @mset_args << key << value
+  end
+
+  def add_del(key)
+    @del_args << key
+  end
+
+  def load(string)
+    load_proc.(string)
+  end
+
+  def dump(object)
+    dump_proc.(object)
+  end
+
+  def make_key(object)
+    make_key_proc.(object)
+  end
+
+  private
+
+  def clear_args
+    @mset_args = []
+    @del_args  = []
+  end
+end

data/lib/redis_collection/version.rb

@@ -0,0 +1,3 @@
+class RedisCollection
+  VERSION = "0.1.0"
+end

data/redis_collection.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_collection/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_collection"
+  spec.version       = RedisCollection::VERSION
+  spec.authors       = ["Maxim Chernyak"]
+  spec.email         = ["max@crossfield.com"]
+
+  spec.summary       = %q{Sync an iterable ruby object with a redis namespace.}
+  spec.homepage      = "https://github.com/crossfield/redis_collection"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mock_redis", "~> 0.17"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: redis_collection
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maxim Chernyak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+description: 
+email:
+- max@crossfield.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis_collection.rb
+- lib/redis_collection/version.rb
+- redis_collection.gemspec
+homepage: https://github.com/crossfield/redis_collection
+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.2
+signing_key: 
+specification_version: 4
+summary: Sync an iterable ruby object with a redis namespace.
+test_files: []
+has_rdoc: