rack-redic 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7388b15ad5d8202290edcce2053f32936fdf40b
-  data.tar.gz: 9ac2661f1aa0a23d9095da3aaaee5cbe50b466c0
+  metadata.gz: 31b7b5e5ddf6c0f5af1dc51b50b983c568428064
+  data.tar.gz: 944984d8fae344465740ff0094f6eef441d003f9
 SHA512:
-  metadata.gz: 6615da5238d30709de9ac9a9f8638f904b944897055035b886a55754c73846f146b9f7f0ae63334254008568f5bd1efb7a97379a2fd0b0730b01f34c5034fe03
-  data.tar.gz: 69abbdd2fd1251dd90bd2cf9c88ba1b4af383c4b7d36d91f6268cfd4622bda423bcb8db1db0b40e0aac429e414143502d513fa25bc01c5214d928c08c9a06ef9
+  metadata.gz: b647e0e9e43738c92a7d9cfe79939ed966e8edbe5d223b1ab0af7014bc08b55c215c0d295000d4331c5ce3c23049894353f498f69dea919e746749e77fc91ad5
+  data.tar.gz: 72e4feb916be67b959ceff0c7fd5472b0717e2c99b9c60f6dab508d4855abebf9db916d74fe7939bc11a315a7d9029d75876e7409ffd9c34475b4789a32e99e8

data/README.md

@@ -46,6 +46,45 @@ use Rack::Session::Redic, marshaller: Oj, url: 'redis://host:port'
 use Rack::Session::Redic, marshaller: Oj, url: 'redis://host:port', expire_after: 1_800
 ```
 
+### Custom Marshallers
+
+Since the class/module passed as `:marshaller` only needs to respond to the methods `load` and `dump` you can create any kind of marshaller you would like. I've included examples for MessagePack and Oj here as reference.
+
+#### [MessagePack](https://github.com/msgpack/msgpack-ruby)
+
+```ruby
+require 'msgpack'
+
+MessagePack::DefaultFactory.register_type(0x00, Symbol)
+
+module MessagePackMarshaller
+  def dump(object)
+    MessagePack.pack(object)
+  end
+  module_function :dump
+
+  def load(string)
+    MessagePack.unpack(string)
+  end
+  module_function :load
+end
+```
+
+Then, while adding it your Rack application.
+
+```ruby
+use Rack::Session::Redic, marshaller: MessagePackMarshaller
+```
+
+**NOTE:** MessagePack [serializes symbols as strings by default](https://github.com/msgpack/msgpack-ruby#serializing-and-deserializing-symbols) so I suggest customizing that behavior per their instructions. You can [read more about MessagePack's extension formats here](https://github.com/msgpack/msgpack/blob/master/spec.md#types-extension-type).
+
+#### [Oj](https://github.com/ohler55/oj)
+
+Oj responds to `load` and `dump` by default so there's no adapter method needed.
+
+```ruby
+use Rack::Session::Redic, marshaller: Oj
+```
 
 ## Contributing
 

data/rack-redic.gemspec

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 Gem::Specification.new do |spec|
   spec.name    = 'rack-redic'
-  spec.version = '0.7.0'
+  spec.version = '0.8.0'
   spec.authors = ['Evan Lecklider']
   spec.email   = ['evan@lecklider.com']
 
@@ -16,5 +16,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack'
   spec.add_dependency 'redic'
 
+  spec.add_development_dependency 'msgpack'
+  spec.add_development_dependency 'oj'
   spec.add_development_dependency 'rspec'
 end

data/spec/spec_helper.rb

@@ -4,4 +4,5 @@
 # Ensure we have this set before trying to initialize anything.
 ENV['REDIS_URL'] ||= 'redis://localhost:6379'
 
+# Require our core library.
 require 'rack/session/redic'

data/spec/storage_msgpack_spec.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+require 'support/shared_examples/storage_marshaller'
+require 'msgpack'
+
+MessagePack::DefaultFactory.register_type(0x00, Symbol)
+
+module MessagePackMarshaller
+  def dump(object)
+    MessagePack.pack(object)
+  end
+  module_function :dump
+
+  def load(string)
+    MessagePack.unpack(string)
+  end
+  module_function :load
+end
+
+describe Rack::Session::Redic::Storage do
+  context 'using the MessagePack as the marshaller' do
+    it_behaves_like 'a storage marshaller'
+
+    subject do
+      Rack::Session::Redic::Storage.new(nil, MessagePackMarshaller, ENV['REDIS_URL'])
+    end
+  end
+end

data/spec/storage_oj_spec.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+require 'support/shared_examples/storage_marshaller'
+require 'oj'
+
+describe Rack::Session::Redic::Storage do
+  context 'using the Oj as the marshaller' do
+    it_behaves_like 'a storage marshaller'
+
+    subject do
+      Rack::Session::Redic::Storage.new(nil, Oj, ENV['REDIS_URL'])
+    end
+  end
+end

data/spec/storage_spec.rb

@@ -1,36 +1,13 @@
 # encoding: UTF-8
 # frozen_string_literal: true
+require 'support/shared_examples/storage_marshaller'
 
 describe Rack::Session::Redic::Storage do
-  subject do
-    Rack::Session::Redic::Storage.new(nil, Marshal, ENV['REDIS_URL'])
-  end
-
-  it 'returns nil for empty keys' do
-    expect(subject.get('not-here')).to eq(nil)
-  end
-
-  it 'saves objects' do
-    object = { saved: true }
-    subject.set('saving', object)
-
-    expect(subject.get('saving')).to eq(object)
-    subject.delete('saving') # Cleanup.
-  end
-
-  it 'checks the existence of keys' do
-    subject.set('exists', false)
-
-    expect(subject.exists?('exists')).to eq(true)
-  end
-
-  it 'deletes objects' do
-    object = { deleted: true }
-    subject.set('deleted', object)
-
-    expect(subject.get('deleted')).to eq(object)
-    subject.delete('deleted')
+  context 'using the default marshaller' do
+    it_behaves_like 'a storage marshaller'
 
-    expect(subject.get('deleted')).to eq(nil)
+    subject do
+      Rack::Session::Redic::Storage.new(nil, Marshal, ENV['REDIS_URL'])
+    end
   end
 end

data/spec/support/shared_examples/storage_marshaller.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+RSpec.shared_examples 'a storage marshaller' do
+  it 'returns nil for empty keys' do
+    expect(subject.get('not-here')).to eq(nil)
+  end
+
+  it 'saves objects' do
+    object = { saved: true }
+    subject.set('saving', object)
+
+    expect(subject.get('saving')).to eq(object)
+    subject.delete('saving') # Cleanup.
+  end
+
+  it 'checks the existence of keys' do
+    subject.set('exists', false)
+
+    expect(subject.exists?('exists')).to eq(true)
+  end
+
+  it 'deletes objects' do
+    object = { deleted: true }
+    subject.set('deleted', object)
+
+    expect(subject.get('deleted')).to eq(object)
+    subject.delete('deleted')
+
+    expect(subject.get('deleted')).to eq(nil)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-redic
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Evan Lecklider
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -70,7 +98,10 @@ files:
 - rack-redic.gemspec
 - spec/session_redic_spec.rb
 - spec/spec_helper.rb
+- spec/storage_msgpack_spec.rb
+- spec/storage_oj_spec.rb
 - spec/storage_spec.rb
+- spec/support/shared_examples/storage_marshaller.rb
 homepage: https://github.com/evanleck/rack-redic
 licenses:
 - MIT
@@ -98,4 +129,7 @@ summary: Rack::Session in Redis via Redic
 test_files:
 - spec/session_redic_spec.rb
 - spec/spec_helper.rb
+- spec/storage_msgpack_spec.rb
+- spec/storage_oj_spec.rb
 - spec/storage_spec.rb
+- spec/support/shared_examples/storage_marshaller.rb