redis_key_manager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 115535b16c16ab46fca148c745c83178aa527c5d
+  data.tar.gz: 470f7967052c7d34226d287ac6d009c22ca9b27e
+SHA512:
+  metadata.gz: c5fb8bd8ff69de30bb78b3841d585e2499441d14b749af5dbef3592324e0e4e8b3614e70321b63ca48c4cef669ec258b61fd7a12d26c04dca6e040e76ba9ff54
+  data.tar.gz: 66569756bb9540d1fd7e59b122c4ef6f311b86e0fcf7a489aa2f9ec17f3a015f68f7be82300ebdcceb2e3f81dac50347490aba355c44dee290752dd323f5f8c5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Oneflare Pty Ltd
+
+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,87 @@
+# RedisKeyManager
+
+[![Gem Version][GV img]][Gem Version]
+[![Coverage Status][CS img]][Coverage Status]
+[![Build Status][BS img]][Build Status]
+
+RedisKeyManager provides a simple Ruby DSL for declaring the Redis key patterns used by your
+application. Instead of repeating the same string literals and manual interpolations throughout your
+application—with the corresponding risk of error and silent failure—RedisKeyManager
+generates methods that return those keys, accepting named parameters corresponding to the
+substitutions specified in each pattern.
+
+## Installation
+
+```ruby
+# Gemfile
+gem "redis_key_manager"
+```
+
+```
+$ bundle
+```
+
+## Example Usage
+
+```ruby
+require "redis_key_manager"
+
+# Declare your key patterns like this:
+
+class MyRedisKeys
+  include RedisKeyManager::Manager
+
+  key :hits, "hits"
+  key :user, "user:[user_id]"
+  key :foo, "foo:[name]:bar:[boom]:[bam]"
+end
+
+# Use your keys like this:
+
+key = MyRedisKeys.hits  # => "hits"
+Redis.current.incr(key)
+
+key = MyRedisKeys.foo(name: "BOB", boom: 5, bam: 9)  # => "foo:BOB:bar:5:9"
+Redis.current.zadd(key, 1.3, 500)
+```
+
+The methods generated by `key` declarations helpfully raise exceptions if you don't pass the named
+arguments they expect, or if the values you pass are nil.
+
+```ruby
+MyRedisKeys.foo(name: "BOB", boom: 5, blop: 6)
+# ArgumentError: Invalid arguments for MyRedisKeys.foo
+
+MyRedisKeys.foo(name: "BOB", boom: 5)
+# ArgumentError: Invalid arguments for MyRedisKeys.foo
+
+MyRedisKeys.foo(name: "BOB", boom: 5, bam: nil)
+# RedisKeyManager::InvalidKeyComponentError: Invalid Redis key component passed to MyRedisKeys.foo
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Please ensure that you write tests for any commits, and that tests pass locally before you submit a PR.
+To run tests, run `bundle exec rake spec`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Oneflare/redis_key_manager.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[Gem Version]: https://rubygems.org/gems/redis_key_manager
+[Coverage Status]: https://coveralls.io/r/Oneflare/redis_key_manager
+[Build Status]: https://circleci.com/gh/Oneflare/redis_key_manager
+
+[GV img]: https://img.shields.io/gem/v/redis_key_manager.svg
+[CS img]: https://img.shields.io/coveralls/matt-harvey/tabulo.svg
+[BS img]: https://img.shields.io/circleci/project/github/Oneflare/redis_key_manager.svg

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis_key_manager"
+
+# 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/circle.yml

@@ -0,0 +1,17 @@
+machine:
+  timezone: Australia/Sydney
+  ruby:
+    version: 2.3.1
+
+database:
+  override:
+    - echo "Skipping DB section as DB is not needed"
+
+dependencies:
+  override:
+    - bundle check --path=/home/ubuntu/.bundle || bundle install --path=/home/ubuntu/.bundle --jobs=4 --retry=3
+
+test:
+  override:
+    - bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml
+

data/lib/redis_key_manager.rb

@@ -0,0 +1,3 @@
+require "redis_key_manager/version"
+require "redis_key_manager/exceptions"
+require "redis_key_manager/manager"

data/lib/redis_key_manager/exceptions.rb

@@ -0,0 +1,3 @@
+module RedisKeyManager
+  class InvalidKeyComponentError < StandardError; end
+end

data/lib/redis_key_manager/manager.rb

@@ -0,0 +1,29 @@
+module RedisKeyManager::Manager
+
+  def self.included(base)
+
+    # Set up `.key` class method on the including class/module, enabling us to do one-liner declarations of
+    # named key patterns at the top of that class/module.
+    def base.key(key, pattern)
+      class_name = self.name
+      placeholders = pattern.scan(/(?<=\[)[^\]]+(?=\])/).uniq.map(&:to_sym)
+
+      # Set up a singleton method on the including class/module, with which the key can be retrieved.
+      define_singleton_method(key) do |options = {}|
+        passed_option_keys = options.keys
+        required_option_keys = placeholders
+        if passed_option_keys.sort != required_option_keys.sort
+          raise ArgumentError, "Invalid arguments for #{class_name}.#{key}"
+        end
+
+        placeholders.inject(pattern) do |revised_pattern, placeholder|
+          value = options[placeholder]
+          if value.nil?
+            raise RedisKeyManager::InvalidKeyComponentError, "Invalid Redis key component passed to #{class_name}.#{key}"
+          end
+          revised_pattern.gsub("[#{placeholder}]", value.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/redis_key_manager/version.rb

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

data/redis_key_manager.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redis_key_manager/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_key_manager"
+  spec.version       = RedisKeyManager::VERSION
+  spec.authors       = ["Matthew Harvey"]
+  spec.email         = ["matthewh@oneflare.com"]
+
+  spec.summary       = "Redis key manager"
+  spec.description   = "Programmatically declare and enforce the Redis key patterns used by your project"
+  spec.homepage      = "https://github.com/Oneflare/redis_key_manager"
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.2"
+  spec.add_development_dependency "simplecov", "~> 0.10.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: redis_key_manager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Harvey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-15 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: Programmatically declare and enforce the Redis key patterns used by your
+  project
+email:
+- matthewh@oneflare.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/redis_key_manager.rb
+- lib/redis_key_manager/exceptions.rb
+- lib/redis_key_manager/manager.rb
+- lib/redis_key_manager/version.rb
+- redis_key_manager.gemspec
+homepage: https://github.com/Oneflare/redis_key_manager
+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.0
+signing_key: 
+specification_version: 4
+summary: Redis key manager
+test_files: []