Class Moneta::Transformer
In: lib/moneta/transformer/config.rb
lib/moneta/transformer/helper.rb
lib/moneta/transformer.rb
Parent: Object

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

Methods

new  

Classes and Modules

Module Moneta::Transformer::Helper

Constants

TRANSFORMER = { # Name => [ Type, Load, Dump, Library ], :bencode => [ :serialize, '::BEncode.load(%s)', '::BEncode.dump(%s)', 'bencode' ], :bert => [ :serialize, '::BERT.decode(%s)', '::BERT.encode(%s)', 'bert' ], :bson => [ :serialize, "::BSON.deserialize(%s)['v']", "::BSON.serialize('v'=>%s).to_s", 'bson' ], :json => [ :serialize, '::MultiJson.load(%s)', '::MultiJson.dump(%s)', 'multi_json' ], :marshal => [ :serialize, '::Marshal.load(%s)', '::Marshal.dump(%s)' ], :msgpack => [ :serialize, '::MessagePack.unpack(%s)', '::MessagePack.pack(%s)', 'msgpack' ], :ox => [ :serialize, '::Ox.parse_obj(%s)', '::Ox.dump(%s)', 'ox' ], :php => [ :serialize, '::PHP.unserialize(%s)', '::PHP.serialize(%s)', 'php_serialize' ], :tnet => [ :serialize, '::TNetstring.parse(%s).first', '::TNetstring.dump(%s)', 'tnetstring' ], :yaml => [ :serialize, '::YAML.load(%s)', '::YAML.dump(%s)', 'yaml' ], :bzip2 => [ :compress, '::Bzip2.uncompress(%s)', '::Bzip2.compress(%s)', 'bzip2' ], :lz4 => [ :compress, '::LZ4.uncompress(%s)', '::LZ4.compress(%s)', 'lz4-ruby' ], :lzma => [ :compress, '::LZMA.decompress(%s)', '::LZMA.compress(%s)', 'lzma' ], :lzo => [ :compress, '::LZO.decompress(%s)', '::LZO.compress(%s)', 'lzoruby' ], :snappy => [ :compress, '::Snappy.inflate(%s)', '::Snappy.deflate(%s)', 'snappy' ], :quicklz => [ :compress, '::QuickLZ.decompress(%s)', '::QuickLZ.compress(%s)', 'qlzruby' ], :zlib => [ :compress, '::Zlib::Inflate.inflate(%s)', '::Zlib::Deflate.deflate(%s)', 'zlib' ], :base64 => RUBY_VERSION > '1.9' ? [ :encode, "%s.unpack('m0').first", "[%s].pack('m0')" ] : [ :encode, "%s.unpack('m').first", "[%s].pack('m').gsub(\"\n\", '')" ], :escape => [ :encode, 'Helper.unescape(%s)', 'Helper.escape(%s)' ], :hex => [ :encode, "[%s].pack('H*')", "%s.unpack('H*').first" ], :qp => [ :encode, "%s.unpack('M').first", "[%s].pack('M')" ], :uuencode => [ :encode, "%s.unpack('u').first", "[%s].pack('u')" ], :hmac => [ :hmac, 'Helper.hmacverify(%s, options[:secret] || @secret)', 'Helper.hmacsign(%s, options[:secret] || @secret)', 'openssl' ], :truncate => [ :truncate, nil, 'Helper.truncate(%s, @maxlen)', 'digest/md5' ], :md5 => [ :digest, nil, '::Digest::MD5.hexdigest(%s)', 'digest/md5' ], :rmd160 => [ :digest, nil, '::Digest::RMD160.hexdigest(%s)', 'digest/rmd160' ], :sha1 => [ :digest, nil, '::Digest::SHA1.hexdigest(%s)', 'digest/sha1' ], :sha256 => [ :digest, nil, '::Digest::SHA256.hexdigest(%s)', 'digest/sha2' ], :sha384 => [ :digest, nil, '::Digest::SHA384.hexdigest(%s)', 'digest/sha2' ], :sha512 => [ :digest, nil, '::Digest::SHA512.hexdigest(%s)', 'digest/sha2' ], :city32 => [ :digest, nil, '::CityHash.hash32(%s).to_s(16)', 'cityhash' ], :city64 => [ :digest, nil, '::CityHash.hash64(%s).to_s(16)', 'cityhash' ], :city128 => [ :digest, nil, '::CityHash.hash128(%s).to_s(16)', 'cityhash' ], :prefix => [ :prefix, nil, '(options[:prefix] || @prefix)+%s' ], :spread => [ :spread, nil, 'Helper.spread(%s)' ], :to_s => [ :string, nil, '%s.to_s' ], :inspect => [ :string, nil, '%s.inspect' ], }   Available key/value transformers
VALUE_TRANSFORMER = 'serialize? compress? hmac? encode?'   Allowed value transformers (Read it like a regular expression!)
KEY_TRANSFORMER = '(serialize | string)? prefix? ((encode? truncate?) | (digest spread?))?'   Allowed key transformers (Read it like a regular expression!)

External Aliases

new -> original_new

Public Class methods

new(adapter, options = {})

@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)

[Validate]