File: //lib/ruby/vendor_ruby/moneta/transformer.rb
module Moneta
# Transforms keys and values (Marshal, YAML, JSON, Base64, MD5, ...).
# You can bypass the transformer (e.g. serialization) by using the `:raw` option.
#
# @example Add `Moneta::Transformer` to proxy stack
# Moneta.build do
# transformer key: [:marshal, :escape], value: [:marshal]
# adapter :File, dir: 'data'
# end
#
# @example Bypass serialization
# store.store('key', 'value', raw: true)
# store['key'] # raises an Exception
# store.load('key', raw: true) # returns 'value'
#
# store['key'] = 'value'
# store.load('key', raw: true) # returns "\x04\bI\"\nvalue\x06:\x06ET"
#
# @api public
class Transformer < Proxy
class << self
alias_method :original_new, :new
# @param [Moneta store] adapter The underlying store
# @param [Hash] options
# @return [Transformer] new Moneta transformer
# @option options [Array] :key List of key transformers in the order in which they should be applied
# @option options [Array] :value List of value transformers in the order in which they should be applied
# @option options [String] :prefix Prefix string for key namespacing (Used by the :prefix key transformer)
# @option options [String] :secret HMAC secret to verify values (Used by the :hmac value transformer)
# @option options [Integer] :maxlen Maximum key length (Used by the :truncate key transformer)
def new(adapter, options = {})
keys = [options[:key]].flatten.compact
values = [options[:value]].flatten.compact
raise ArgumentError, 'Option :key or :value is required' if keys.empty? && values.empty?
options[:prefix] ||= '' if keys.include?(:prefix)
name = class_name(keys, values)
const_set(name, compile(keys, values)) unless const_defined?(name)
const_get(name).original_new(adapter, options)
end
private
def compile(keys, values)
@key_validator ||= compile_validator(KEY_TRANSFORMER)
@value_validator ||= compile_validator(VALUE_TRANSFORMER)
raise ArgumentError, 'Invalid key transformer chain' if @key_validator !~ keys.map(&:inspect).join
raise ArgumentError, 'Invalid value transformer chain' if @value_validator !~ values.map(&:inspect).join
klass = Class.new(self)
klass.class_eval <<-end_eval, __FILE__, __LINE__
def initialize(adapter, options = {})
super
#{compile_initializer('key', keys)}
#{compile_initializer('value', values)}
end
end_eval
key, key_opts = compile_transformer(keys, 'key')
dump, dump_opts = compile_transformer(values, 'value')
load, load_opts = compile_transformer(values.reverse, 'value', 1)
if values.empty?
compile_key_transformer(klass, key, key_opts)
elsif keys.empty?
compile_value_transformer(klass, load, load_opts, dump, dump_opts)
else
compile_key_value_transformer(klass, key, key_opts, load, load_opts, dump, dump_opts)
end
klass
end
def without(*options)
options = options.flatten.uniq
options.empty? ? 'options' : "Utils.without(options, #{options.map(&:to_sym).map(&:inspect).join(', ')})"
end
def compile_key_transformer(klass, key, key_opts)
klass.class_eval <<-end_eval, __FILE__, __LINE__
def key?(key, options = {})
@adapter.key?(#{key}, #{without key_opts})
end
def increment(key, amount = 1, options = {})
@adapter.increment(#{key}, amount, #{without key_opts})
end
def load(key, options = {})
@adapter.load(#{key}, #{without :raw, key_opts})
end
def store(key, value, options = {})
@adapter.store(#{key}, value, #{without :raw, key_opts})
end
def delete(key, options = {})
@adapter.delete(#{key}, #{without :raw, key_opts})
end
def create(key, value, options = {})
@adapter.create(#{key}, value, #{without :raw, key_opts})
end
end_eval
end
def compile_value_transformer(klass, load, load_opts, dump, dump_opts)
klass.class_eval <<-end_eval, __FILE__, __LINE__
def load(key, options = {})
value = @adapter.load(key, #{without :raw, load_opts})
value && !options[:raw] ? #{load} : value
end
def store(key, value, options = {})
@adapter.store(key, options[:raw] ? value : #{dump}, #{without :raw, dump_opts})
value
end
def delete(key, options = {})
value = @adapter.delete(key, #{without :raw, load_opts})
value && !options[:raw] ? #{load} : value
end
def create(key, value, options = {})
@adapter.create(key, options[:raw] ? value : #{dump}, #{without :raw, dump_opts})
end
end_eval
end
def compile_key_value_transformer(klass, key, key_opts, load, load_opts, dump, dump_opts)
klass.class_eval <<-end_eval, __FILE__, __LINE__
def key?(key, options = {})
@adapter.key?(#{key}, #{without key_opts})
end
def increment(key, amount = 1, options = {})
@adapter.increment(#{key}, amount, #{without key_opts})
end
def load(key, options = {})
value = @adapter.load(#{key}, #{without :raw, key_opts, load_opts})
value && !options[:raw] ? #{load} : value
end
def store(key, value, options = {})
@adapter.store(#{key}, options[:raw] ? value : #{dump}, #{without :raw, key_opts, dump_opts})
value
end
def delete(key, options = {})
value = @adapter.delete(#{key}, #{without :raw, key_opts, load_opts})
value && !options[:raw] ? #{load} : value
end
def create(key, value, options = {})
@adapter.create(#{key}, options[:raw] ? value : #{dump}, #{without :raw, key_opts, dump_opts})
end
end_eval
end
# Compile option initializer
def compile_initializer(type, transformers)
transformers.map do |name|
t = TRANSFORMER[name]
(t[1].to_s + t[2].to_s).scan(/@\w+/).uniq.map do |opt|
"raise ArgumentError, \"Option #{opt[1..-1]} is required for #{name} #{type} transformer\" unless #{opt} = options[:#{opt[1..-1]}]\n"
end
end.join("\n")
end
def compile_validator(s)
Regexp.new('\A' + s.gsub(/\w+/) do
'(' + TRANSFORMER.select {|k,v| v.first.to_s == $& }.map {|v| ":#{v.first}" }.join('|') + ')'
end.gsub(/\s+/, '') + '\Z')
end
# Returned compiled transformer code string
def compile_transformer(transformer, var, i = 2)
value, options = var, []
transformer.each do |name|
raise ArgumentError, "Unknown transformer #{name}" unless t = TRANSFORMER[name]
require t[3] if t[3]
code = t[i]
options += code.scan(/options\[:(\w+)\]/).flatten
value =
if t[0] == :serialize && var == 'key'
"(tmp = #{value}; String === tmp ? tmp : #{code % 'tmp'})"
else
code % value
end
end
return value, options
end
def class_name(keys, values)
(keys.empty? ? '' : keys.map(&:to_s).map(&:capitalize).join + 'Key') +
(values.empty? ? '' : values.map(&:to_s).map(&:capitalize).join + 'Value')
end
end
end
end
require 'moneta/transformer/helper'
require 'moneta/transformer/config'