dalli-keys-match 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b6875a0ca5dc289edfd2ee3a9000a2ac338558b
+  data.tar.gz: a89d71e02345a54730ff8d939f718ffe8320b626
+SHA512:
+  metadata.gz: 312ed9714d7ad958fba934410622a0702048b2e455948041235d4e32d25549e4f4aa2aba24c3f8a14666b034371275f100b257507fa28f34797f17eeee857116
+  data.tar.gz: 6bcd5241247222d179a2c3113a6f52a7ad7733a9994ec682edc8aa497af6bb3f0f8c54f94a38470e02162ba75ec24e1df611c4fd89581573fa4c6927df321c2e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4
+services:
+  - memcached

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/README.md

@@ -0,0 +1,53 @@
+# Dalli KeysMatch
+
+This gem add to the [Dalli::Client](https://github.com/petergoldstein/dalli) methods to list/filter/delete keys using regexp or string patterns.
+
+IMPORTANT: It's not recommended to use in production. Memcached binary protocol does not implement `stats cachedump` command. We are using telnet as workaround. And I recommend using it in the development environment or background jobs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dalli-keys-match'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dalli-keys-match
+
+## Usage
+```
+require 'dalli/keys_match'
+
+> client = Dalli::Client.new('localhost:11211')
+ => #<Dalli::Client:0x007fcb14afe830 @servers=["localhost:11211"], @options={}, @ring=nil>
+> client.set('dalli-keys-match-1' , 1)
+ => 10163216984091656192
+>  client.set('dalli-keys-match-2' , 2)
+ => 10235274578129584128
+> client.keys(/dalli-keys-match-\d/)
+ => ["dalli-keys-match-2", "dalli-keys-match-1"]
+> client.keys('dalli-keys-match-')
+ => ["dalli-keys-match-2", "dalli-keys-match-1"]
+> client.delete_matched(/dalli-keys-match-1/)
+ => 1
+> client.keys(/dalli-keys-match-\d/)
+ => ["dalli-keys-match-2"]
+```
+
+### Optional Configuration
+```
+Dalli::KeysMatch.config.telnet = {
+  'Timeout' => 30,
+  'Prompt' => /(^END$)/,
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcosgz/dalli-keys-match.

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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dalli/keys_match'
+require 'irb'
+
+IRB.start(__FILE__)

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/dalli-keys-match.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dalli/keys_match/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dalli-keys-match'
+  spec.version       = Dalli::KeysMatch::VERSION
+  spec.authors       = ['Marcos G. Zimmermann']
+  spec.email         = ['marcos@marcosz.com.br']
+  spec.license       = 'MIT'
+
+  spec.summary       = %q{Dalli::KeysMatch extends Dalli with functions to deal with keys}
+  spec.description   = %q{Dalli::KeysMatch extends Dalli with a function that allow you to list or remove keys using optional filters}
+  spec.homepage      = 'https://github.com/marcosgz/dalli-keys-match'
+
+  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_runtime_dependency 'net-telnet', '~> 0.1.1'
+  spec.add_runtime_dependency 'dalli', '>= 1.0.0'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 12.1', '>= 12.1.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+end

data/lib/dalli-keys-match.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'dalli/keys_match'

data/lib/dalli/keys_match.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+require 'net/telnet'
+require 'dalli'
+require 'dalli/keys_match/configuration'
+require 'dalli/keys_match/version'
+
+module Dalli
+  module KeysMatch
+
+    def config
+      @config ||= Configuration.new
+    end
+    module_function :config
+
+    module Server
+      # Memcached does not implement binary protocol for cachedump key. Using telnet as workaround
+      # https://github.com/memcached/memcached/wiki/BinaryProtocolRevamped#stat
+      def stats_cachedump(id, size, pattern = nil)
+        [].tap do |keys|
+          telnet.cmd("String" => "stats cachedump #{id} #{size}").split("\n").each do |line|
+            if /ITEM (.+) \[\d+ b; \d+ s\]/ =~ line
+              case pattern.class.name
+              when 'NilClass'
+                keys << $1
+              when 'Regexp'
+                cache_key = $1
+                keys << cache_key if cache_key =~ pattern
+              else
+                keys << $1 if $1[pattern.to_s]
+              end
+            end
+          end
+        end
+      end
+
+      def close_telnet!
+        return unless @telnet
+        @telnet.close
+        @telnet = nil
+      end
+
+      def telnet
+        @telnet ||= begin
+          configs = Dalli::KeysMatch.config.telnet(
+            'Host' => hostname,
+            'Port' => port
+          )
+          Net::Telnet.new(configs)
+        end
+      end
+    end
+
+    module Client
+      def keys(pattern = nil)
+        result = []
+        ring.servers.each do |server|
+          next unless server.alive?
+          items = server.request(:stats, 'items')
+          slabs = items.inject({}) do |r, (k,v)|
+            r[$1] = v if k =~ /items:(\d+):number/
+            r
+          end
+          slabs.each do |id, size|
+            result.push(*server.stats_cachedump(id, size, pattern))
+          end
+          server.close_telnet!
+        end
+        result
+      end
+
+      def delete_matched(pattern)
+        return 0 if pattern.nil?
+
+        matches = keys(pattern)
+        matches.map { |k| delete(k) }.select { |r| r }.size
+      end
+    end
+  end
+end
+
+Dalli::Server.send(:include, Dalli::KeysMatch::Server)
+Dalli::Client.send(:include, Dalli::KeysMatch::Client)

data/lib/dalli/keys_match/configuration.rb

@@ -0,0 +1,18 @@
+module Dalli
+  module KeysMatch
+    class Configuration
+      TELNET_DEFAULS = {
+        'Prompt' => /(^END$)/,
+        'Timeout' => 20
+      }.freeze
+
+      def initialize(options = {})
+        @telnet = TELNET_DEFAULS.merge options.fetch(:telnet, {})
+      end
+
+      def telnet(args = {})
+        @telnet.merge args
+      end
+    end
+  end
+end

data/lib/dalli/keys_match/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Dalli
+  module KeysMatch
+    VERSION = '0.2.0'
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: dalli-keys-match
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Marcos G. Zimmermann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-telnet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: Dalli::KeysMatch extends Dalli with a function that allow you to list
+  or remove keys using optional filters
+email:
+- marcos@marcosz.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dalli-keys-match.gemspec
+- lib/dalli-keys-match.rb
+- lib/dalli/keys_match.rb
+- lib/dalli/keys_match/configuration.rb
+- lib/dalli/keys_match/version.rb
+homepage: https://github.com/marcosgz/dalli-keys-match
+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: Dalli::KeysMatch extends Dalli with functions to deal with keys
+test_files: []