redis-prescription 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4c70dac256ca079b9af76b03cefc189db30507860c0a6816ddd519da7bdd75a
+  data.tar.gz: a1c5e2fe3645bd592f26a00a16accf2be1d0340468c4f824e06c7da51f1d29eb
+SHA512:
+  metadata.gz: a1f3988eb35db89865af75881b7bd0e33cb4a922fa468589f8f9de3396ac88118405b400ac8999995648ed92a224f768f2fc88a19d3a75d6c54145c9f01488b1
+  data.tar.gz: 19a72258d2adf1bef91b436965ebcea477a886cc4c9e269e81f5cffe489b406811f9fc7c46088bfc02071c720fecc016c819b48e297bd8b602e6ce11d21d31fd

data/.gitignore

@@ -0,0 +1,10 @@
+/Gemfile.lock
+
+/.autoenv.zsh
+/.bundle
+/.yardoc
+/_yardoc
+/coverage
+/doc
+/pkg
+/tmp

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,40 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+
+
+## Layout ######################################################################
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+
+## Metrics #####################################################################
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+
+## Style #######################################################################
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Style/RescueStandardError:
+  EnforcedStyle: implicit
+
+Style/SafeNavigation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/YodaCondition:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,28 @@
+language: ruby
+sudo: false
+
+services:
+  - redis-server
+
+cache: bundler
+
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+
+matrix:
+  fast_finish: true
+  include:
+    - rvm: 2.4
+      env: TEST_SUITE="rubocop"
+
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler --no-rdoc --no-ri
+  - bundle --version
+
+install: bundle install --without development doc
+
+script: bundle exec rake $TEST_SUITE

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/Gemfile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+ruby RUBY_VERSION
+
+gem "rake"
+gem "rspec"
+gem "rubocop", "~> 0.52.0", :require => false
+
+gem "redis"
+gem "redis-namespace"
+
+group :development do
+  gem "guard",         :require => false
+  gem "guard-rspec",   :require => false
+  gem "guard-rubocop", :require => false
+  gem "pry",           :require => false
+end
+
+group :test do
+  gem "codecov",    :require => false
+  gem "simplecov",  :require => false
+end
+
+group :doc do
+  gem "redcarpet"
+  gem "yard"
+end
+
+# Specify your gem's dependencies in redis-prescription.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+guard :rspec, :cmd => "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexey Zapparov
+
+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,89 @@
+# Redis::Prescription
+
+Redis LUA stored procedure runner. Preloads (and reloads when needed, e.g. when
+scripts were flushed away) script and then runs it with `EVALSHA`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "redis-prescription"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-prescription
+
+
+## Usage
+
+``` ruby
+script = Redis::Prescription.new <<~LUA
+  return tonumber(redis.call('GET', KEYS[1]) or 42)
+LUA
+
+script.eval(Redis.current, :xxx) # => 42
+
+Redis.current.set(:xxx, 123)
+script.eval(Redis.current, :xxx) # => 123
+```
+
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][1] the following Ruby
+versions:
+
+* Ruby 2.3.x
+* Ruby 2.4.x
+* Ruby 2.5.x
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions,
+however support will only be provided for the versions listed above.
+
+If you would like this library to support another Ruby version or
+implementation, you may volunteer to be a maintainer. Being a maintainer
+entails making sure all tests run and pass on that implementation. When
+something breaks on your implementation, you will be responsible for providing
+patches in a timely fashion. If critical issues for a particular implementation
+exist at the time of a major release, support for that Ruby version may be
+dropped.
+
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `bundle exec rake spec` to run the tests with ruby-rb client.
+
+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][2].
+
+
+## Contributing
+
+* Fork sidekiq-throttled on GitHub
+* Make your changes
+* Ensure all tests pass (`bundle exec rake`)
+* Send a pull request
+* If we like them we'll merge them
+* If we've accepted a patch, feel free to ask for commit access!
+
+
+## Copyright
+
+Copyright (c) 2018 SensorTower Inc.
+See LICENSE.md for further details.
+
+
+[1]: http://travis-ci.org/sensortower/redis-prescription
+[2]: https://rubygems.org

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+if ENV["CI"]
+  task :default => :spec
+else
+  task :default => %i[rubocop spec]
+end

data/lib/redis/prescription.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "prescription/version"
+
+# @see https://github.com/redis/redis-rb
+class Redis
+  # Lua script executor for redis.
+  #
+  # Instead of executing script with `EVAL` everytime - loads script once
+  # and then runs it with `EVALSHA`.
+  #
+  # @example Usage
+  #
+  #     script = Redis::Prescription.new("return ARGV[1] + ARGV[2]")
+  #     script.eval(Redis.current, :argv => [2, 2]) # => 2
+  class Prescription
+    # Script load command.
+    LOAD = "load"
+    private_constant :LOAD
+
+    # Redis error fired when script ID is unkown.
+    NOSCRIPT = "NOSCRIPT"
+    private_constant :NOSCRIPT
+
+    # LUA script source.
+    # @return [String]
+    attr_reader :source
+
+    # LUA script SHA1 digest.
+    # @return [String]
+    attr_reader :digest
+
+    # @param source [#to_s] Lua script.
+    def initialize(source)
+      @source = source.to_s.strip.freeze
+      @digest = Digest::SHA1.hexdigest(@source).freeze
+    end
+
+    # Loads script to redis.
+    # @param redis (see #namespaceless)
+    # @return [void]
+    def bootstrap!(redis)
+      digest = namespaceless(redis).script(LOAD, @source)
+      return if @digest == digest
+
+      # XXX: this may happen **ONLY** if script digesting will be
+      #   changed in redis, which is not likely gonna happen.
+      warn "[#{self.class}] Unexpected digest: " \
+        "#{digest.inspect} (expected: #{@digest.inspect})"
+
+      @digest = digest.freeze
+    end
+
+    # Executes script and returns result of execution.
+    # @param redis (see #namespaceless)
+    # @param keys [Array] keys to pass to the script
+    # @param argv [Array] arguments to pass to the script
+    # @return depends on the script
+    def eval(redis, keys: [], argv: [])
+      redis.evalsha(@digest, keys, argv)
+    rescue => e
+      raise unless e.message.include? NOSCRIPT
+
+      bootstrap!(redis)
+      redis.evalsha(@digest, keys, argv)
+    end
+
+    # Reads given file and returns new {Prescription} with its contents.
+    # @param file [String]
+    # @return [Prescription]
+    def self.read(file)
+      new File.read file
+    end
+
+    private
+
+    # Yields real namespace-less redis client.
+    # @param redis [Redis, Redis::Namespace]
+    # @return [Redis]
+    def namespaceless(redis)
+      if redis.is_a?(Redis)
+        redis
+      elsif defined?(Redis::Namespace) && redis.is_a?(Redis::Namespace)
+        redis.redis
+      else
+        raise TypeError, "Unsupported redis client type: #{redis.class}"
+      end
+    end
+  end
+end

data/lib/redis/prescription/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Redis
+  class Prescription
+    # Gem version.
+    VERSION = "1.0.0"
+  end
+end

data/redis-prescription.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "redis/prescription/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-prescription"
+  spec.version       = Redis::Prescription::VERSION
+  spec.authors       = ["Alexey Zapparov"]
+  spec.email         = ["ixti@member.fsf.org"]
+
+  spec.summary       = "Redis LUA stored procedure runner."
+  spec.description   = <<~DESCRIPTION
+    Preloads (and reloads when needed, e.g. when scripts
+    were flushed away) script and then runs it with `EVALSHA`.
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/ixti/redis-prescription"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: redis-prescription
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexey Zapparov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: |
+  Preloads (and reloads when needed, e.g. when scripts
+  were flushed away) script and then runs it with `EVALSHA`.
+email:
+- ixti@member.fsf.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis/prescription.rb
+- lib/redis/prescription/version.rb
+- redis-prescription.gemspec
+homepage: https://github.com/ixti/redis-prescription
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Redis LUA stored procedure runner.
+test_files: []