rack-redic 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9a51caf7a526f3dfc55bc760dd10149e94f6c30
-  data.tar.gz: e2200bfde0db21ed268b44574f16d4c5a548528a
+  metadata.gz: bf92c89449d8d8709de10c6764860f6bf170e5d0
+  data.tar.gz: bf999b9c9675ad376c52ae1eb6df3042f6c4d7a1
 SHA512:
-  metadata.gz: fab516c4d2811f99faa29e070516bd247ff8157aaf64b1d61dc83638e1723a9fe6b1fca13a55652b109b1dbf210d64c81348b14a65d5d57a6c4d48ab98ac8214
-  data.tar.gz: c0a8ec88652c525adbf60c4b576a1bd844715f89db7a2190c9209208a8c530e9f61a2bdee8d176e7883465f46a4f66d9ad45fe8418ae5b454b2a3f9dc7fe741c
+  metadata.gz: 245c12a951c0c0c395064a64ab594f2d5e8774979bdcb3feb23fc855666612e50db63eead26aa5df911287a7c1f184918ea1a2cc69ae01f07f52e8fa17c0807b
+  data.tar.gz: 5a0d6bff6ad7faae40884f75174d43728e87ea4526f73eb0b826ac414a2f05851b4c10f643ee0c53fb1bae5faa6ae6fe58f52f6222c1df731ff33d331b9f8e3a

data/.editorconfig

@@ -0,0 +1,24 @@
+# http://EditorConfig.org
+# This is the top most config file.
+root = true
+
+# All files
+[*]
+
+# Unix-style newlines with a newline ending every file
+end_of_line = lf
+insert_final_newline = true
+
+# Character set
+charset = utf-8
+
+# Trim extra whitespace.
+trim_trailing_whitespace = true
+
+# Soft tabs and 2 spaces.
+indent_style = space
+indent_size = 2
+
+# Makefiles use tabs
+[Makefile]
+indent_style = tab

data/Makefile

@@ -0,0 +1,18 @@
+.DEFAULT_GOAL := test
+.PHONY: test
+.SILENT: test
+
+BE := bundle exec
+
+# Run our test suite.
+#
+# To test an individual file, pass the "file" argument like so:
+#
+#   make test file=test/storage_test.rb
+#
+test:
+ifeq ($(origin file), undefined)
+	$(BE) ruby -r ./test/helper.rb test/all.rb
+else
+	$(BE) ruby -r ./test/helper.rb $(file)
+endif

data/Rakefile

@@ -1,3 +1,3 @@
+# encoding: UTF-8
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
-
-task default: :spec

data/lib/rack/session/redic.rb

@@ -78,7 +78,6 @@ module Rack
         end
       end
 
-      ##
       # A wrapper around Redic to simplify calls.
       class Storage
         # Redis commands.
@@ -91,20 +90,46 @@ module Rack
         # Assorted.
         ZERO = 0
 
+        # @param expires [Integer]
+        #   The number of seconds for Redis to retain keys.
+        # @param marshaller [#dump, #load]
+        #   The module or class used to marshal objects. It must respond to
+        #   #dump and #load.
+        # @param url [String]
+        #   The URL to access Redis at.
         def initialize(expires, marshaller, url)
           @expires = expires
           @marshaller = marshaller
           @storage = ::Redic.new(url)
         end
 
+        # Check for an identifier's existence.
+        #
+        # @param id [String]
+        #   The key to check for.
+        # @return [Boolean]
         def exists?(id)
           @storage.call(EXISTS, id) != ZERO
         end
 
+        # Retrieve an object.
+        #
+        # @param id [String]
+        #   The key in Redis to retrieve from.
+        # @return [Object, nil]
+        #   The object stored at the identifier provided, or nil.
         def get(id)
           deserialize(@storage.call(GET, id))
         end
 
+        # Store an object.
+        #
+        # @param id [String]
+        #   The key to use to store the object.
+        # @param object [Object]
+        #   Any object that can be serialized.
+        # @return [String]
+        #   See {https://redis.io/commands/set#return-value Redis' docs for more}.
         def set(id, object)
           arguments = [SET, id, serialize(object)]
           arguments += [EX, @expires] if @expires
@@ -112,18 +137,33 @@ module Rack
           @storage.call(*arguments)
         end
 
+        # Remove an object.
+        #
+        # @param id [String]
+        #   The key to delete.
+        # @return [Integer]
+        #   The number of keys that were deleted. See
+        #   {https://redis.io/commands/del#return-value Redis' docs for more}.
         def delete(id)
           @storage.call(DELETE, id)
         end
 
         private
 
-        # Should always return a string.
+        # Serialize an object using our marshaller.
+        #
+        # @param object [Object]
+        # @return [String]
+        #   The object serialized by the marshaller.
         def serialize(object)
           @marshaller.dump(object)
         end
 
-        # Should always return the session object.
+        # Deserialize a string back into an object.
+        #
+        # @param string [String]
+        # @return [Object, nil]
+        #   Returns the object as loaded by the marshaller, or nil.
         def deserialize(string)
           @marshaller.load(string) if string
 

data/rack-redic.gemspec

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 Gem::Specification.new do |spec|
   spec.name    = 'rack-redic'
-  spec.version = '1.2.0'
+  spec.version = '1.3.0'
   spec.authors = ['Evan Lecklider']
   spec.email   = ['evan@lecklider.com']
 
@@ -11,12 +11,12 @@ Gem::Specification.new do |spec|
   spec.homepage    = 'https://github.com/evanleck/rack-redic'
   spec.license     = 'MIT'
   spec.files       = `git ls-files`.split("\n")
-  spec.test_files  = spec.files.grep(/^spec/)
+  spec.test_files  = spec.files.grep(/^test/)
 
   spec.add_dependency 'rack'
   spec.add_dependency 'redic'
 
+  spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'msgpack'
   spec.add_development_dependency 'oj'
-  spec.add_development_dependency 'rspec'
 end

data/test/all.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+# Require all test files.
+Dir.glob('test/*.rb').each(&method(:require))

data/{spec/spec_helper.rb → test/helper.rb}

@@ -1,8 +1,14 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
+# Add our project folder to the root of our load path.
+$LOAD_PATH.unshift File.expand_path('../..', __FILE__)
+
 # Ensure we have this set before trying to initialize anything.
 ENV['REDIS_URL'] ||= 'redis://localhost:6379'
 
 # Require our core library.
 require 'rack/session/redic'
+
+# Kick off the tests.
+require 'minitest/autorun'

data/{spec/session_redic_spec.rb → test/session_redic_test.rb}

@@ -44,8 +44,8 @@ describe Rack::Session::Redic do
     redic = Rack::Session::Redic.new(incrementor)
     response = Rack::MockRequest.new(redic).get(ROOT)
 
-    expect(response[Rack::SET_COOKIE]).to include("#{ session_key }=")
-    expect(response.body).to eq('{"counter"=>1}')
+    assert_includes response[Rack::SET_COOKIE], "#{ session_key }="
+    assert_equal response.body, '{"counter"=>1}'
   end
 
   it 'determines session from a cookie' do
@@ -55,8 +55,8 @@ describe Rack::Session::Redic do
 
     cookie = response[Rack::SET_COOKIE]
 
-    expect(request.get(ROOT, Rack::HTTP_COOKIE => cookie).body).to eq('{"counter"=>2}')
-    expect(request.get(ROOT, Rack::HTTP_COOKIE => cookie).body).to eq('{"counter"=>3}')
+    assert_equal request.get(ROOT, Rack::HTTP_COOKIE => cookie).body, '{"counter"=>2}'
+    assert_equal request.get(ROOT, Rack::HTTP_COOKIE => cookie).body, '{"counter"=>3}'
   end
 
   it 'determines session only from a cookie by default' do
@@ -65,8 +65,8 @@ describe Rack::Session::Redic do
     response = request.get(ROOT)
     sid = response[Rack::SET_COOKIE][session_match, 1]
 
-    expect(request.get("/?rack.session=#{sid}").body).to eq('{"counter"=>1}')
-    expect(request.get("/?rack.session=#{sid}").body).to eq('{"counter"=>1}')
+    assert_equal request.get("/?rack.session=#{sid}").body, '{"counter"=>1}'
+    assert_equal request.get("/?rack.session=#{sid}").body, '{"counter"=>1}'
   end
 
   it 'determines session from params' do
@@ -75,8 +75,8 @@ describe Rack::Session::Redic do
     response = request.get(ROOT)
     sid = response[Rack::SET_COOKIE][session_match, 1]
 
-    expect(request.get("/?rack.session=#{sid}").body).to eq('{"counter"=>2}')
-    expect(request.get("/?rack.session=#{sid}").body).to eq('{"counter"=>3}')
+    assert_equal request.get("/?rack.session=#{sid}").body, '{"counter"=>2}'
+    assert_equal request.get("/?rack.session=#{sid}").body, '{"counter"=>3}'
   end
 
   it 'survives nonexistant cookies' do
@@ -85,29 +85,29 @@ describe Rack::Session::Redic do
     redic = Rack::Session::Redic.new(incrementor)
     response = Rack::MockRequest.new(redic).get(ROOT, Rack::HTTP_COOKIE => bad_cookie)
 
-    expect(response.body).to eq('{"counter"=>1}')
+    assert_equal response.body, '{"counter"=>1}'
 
     cookie = response[Rack::SET_COOKIE][session_match]
-    expect(cookie).not_to match(/#{ bad_cookie }/)
+    refute_match /#{ bad_cookie }/, cookie
   end
 
   it 'maintains freshness' do
     redic = Rack::Session::Redic.new(incrementor, expire_after: 3)
     response = Rack::MockRequest.new(redic).get(ROOT)
-    expect(response.body).to include('"counter"=>1')
+    assert_includes response.body, '"counter"=>1'
 
     cookie = response[Rack::SET_COOKIE]
     response = Rack::MockRequest.new(redic).get(ROOT, Rack::HTTP_COOKIE => cookie)
 
-    expect(response[Rack::SET_COOKIE]).to eq(cookie)
-    expect(response.body).to include('"counter"=>2')
+    assert_equal response[Rack::SET_COOKIE], cookie
+    assert_includes response.body, '"counter"=>2'
 
     puts 'Sleeping to expire session' if $DEBUG
     sleep 4
 
     response = Rack::MockRequest.new(redic).get(ROOT, Rack::HTTP_COOKIE => cookie)
-    expect(response[Rack::SET_COOKIE]).not_to eq(cookie)
-    expect(response.body).to include('"counter"=>1')
+    refute_equal response[Rack::SET_COOKIE], cookie
+    assert_includes response.body, '"counter"=>1'
   end
 
   it 'does not send the same session id if it did not change' do
@@ -116,15 +116,15 @@ describe Rack::Session::Redic do
 
     res0 = request.get(ROOT)
     cookie = res0[Rack::SET_COOKIE][session_match]
-    expect(res0.body).to eq('{"counter"=>1}')
+    assert_equal res0.body, '{"counter"=>1}'
 
     res1 = request.get(ROOT, Rack::HTTP_COOKIE => cookie)
-    expect(res1[Rack::SET_COOKIE]).to eq(nil)
-    expect(res1.body).to eq('{"counter"=>2}')
+    assert_nil res1[Rack::SET_COOKIE]
+    assert_equal res1.body, '{"counter"=>2}'
 
     res2 = request.get(ROOT, Rack::HTTP_COOKIE => cookie)
-    expect(res2[Rack::SET_COOKIE]).to eq(nil)
-    expect(res2.body).to eq('{"counter"=>3}')
+    assert_nil res2[Rack::SET_COOKIE]
+    assert_equal res2.body, '{"counter"=>3}'
   end
 
   it 'deletes cookies with :drop option' do
@@ -135,15 +135,15 @@ describe Rack::Session::Redic do
 
     res1 = request.get(ROOT)
     session = (cookie = res1[Rack::SET_COOKIE])[session_match]
-    expect(res1.body).to eq('{"counter"=>1}')
+    assert_equal res1.body, '{"counter"=>1}'
 
     res2 = dreq.get(ROOT, Rack::HTTP_COOKIE => cookie)
-    expect(res2[Rack::SET_COOKIE]).to eq(nil)
-    expect(res2.body).to eq('{"counter"=>2}')
+    assert_nil res2[Rack::SET_COOKIE]
+    assert_equal res2.body, '{"counter"=>2}'
 
     res3 = request.get(ROOT, Rack::HTTP_COOKIE => cookie)
-    expect(res3[Rack::SET_COOKIE][session_match]).not_to eq(session)
-    expect(res3.body).to eq('{"counter"=>1}')
+    refute_equal res3[Rack::SET_COOKIE][session_match], session
+    assert_equal res3.body, '{"counter"=>1}'
   end
 
   it 'provides new session id with :renew option' do
@@ -154,20 +154,20 @@ describe Rack::Session::Redic do
 
     res1 = request.get(ROOT)
     session = (cookie = res1[Rack::SET_COOKIE])[session_match]
-    expect(res1.body).to eq('{"counter"=>1}')
+    assert_equal res1.body, '{"counter"=>1}'
 
     res2 = renew_request.get(ROOT, Rack::HTTP_COOKIE => cookie)
     new_cookie = res2[Rack::SET_COOKIE]
     new_session = new_cookie[session_match]
-    expect(new_session).not_to eq(session)
-    expect(res2.body).to eq('{"counter"=>2}')
+    refute_equal new_session, session
+    assert_equal res2.body, '{"counter"=>2}'
 
     res3 = request.get(ROOT, Rack::HTTP_COOKIE => new_cookie)
-    expect(res3.body).to eq('{"counter"=>3}')
+    assert_equal res3.body, '{"counter"=>3}'
 
     # Old cookie was deleted
     res4 = request.get(ROOT, Rack::HTTP_COOKIE => cookie)
-    expect(res4.body).to eq('{"counter"=>1}')
+    assert_equal res4.body, '{"counter"=>1}'
   end
 
   it 'omits cookie with :defer option but still updates the state' do
@@ -178,14 +178,14 @@ describe Rack::Session::Redic do
     count_request = Rack::MockRequest.new(count)
 
     res0 = defer_request.get(ROOT)
-    expect(res0[Rack::SET_COOKIE]).to eq(nil)
-    expect(res0.body).to eq('{"counter"=>1}')
+    assert_nil res0[Rack::SET_COOKIE]
+    assert_equal res0.body, '{"counter"=>1}'
 
     res0 = count_request.get(ROOT)
     res1 = defer_request.get(ROOT, Rack::HTTP_COOKIE => res0[Rack::SET_COOKIE])
-    expect(res1.body).to eq('{"counter"=>2}')
+    assert_equal res1.body, '{"counter"=>2}'
     res2 = defer_request.get(ROOT, Rack::HTTP_COOKIE => res0[Rack::SET_COOKIE])
-    expect(res2.body).to eq('{"counter"=>3}')
+    assert_equal res2.body, '{"counter"=>3}'
   end
 
   it 'omits cookie and state update with :skip option' do
@@ -196,14 +196,14 @@ describe Rack::Session::Redic do
     count_request = Rack::MockRequest.new(count)
 
     res0 = skip_request.get(ROOT)
-    expect(res0[Rack::SET_COOKIE]).to eq(nil)
-    expect(res0.body).to eq('{"counter"=>1}')
+    assert_nil res0[Rack::SET_COOKIE]
+    assert_equal res0.body, '{"counter"=>1}'
 
     res0 = count_request.get(ROOT)
     res1 = skip_request.get(ROOT, Rack::HTTP_COOKIE => res0[Rack::SET_COOKIE])
-    expect(res1.body).to eq('{"counter"=>2}')
+    assert_equal res1.body, '{"counter"=>2}'
     res2 = skip_request.get(ROOT, Rack::HTTP_COOKIE => res0[Rack::SET_COOKIE])
-    expect(res2.body).to eq('{"counter"=>2}')
+    assert_equal res2.body, '{"counter"=>2}'
   end
 
   it 'updates deep hashes correctly' do
@@ -229,6 +229,6 @@ describe Rack::Session::Redic do
     request.get(ROOT, Rack::HTTP_COOKIE => cookie)
     ses1 = redic.storage.get(session_id)
 
-    expect(ses1).not_to eq(ses0)
+    refute_equal ses1, ses0
   end
 end

data/{spec/storage_msgpack_spec.rb → test/storage_msgpack_test.rb}

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 # frozen_string_literal: true
-require 'support/shared_examples/storage_marshaller'
 require 'msgpack'
+require_relative 'support/storage_marshaller_interface'
 
 MessagePack::DefaultFactory.register_type(0x00, Symbol)
 
@@ -18,11 +18,11 @@ module MessagePackMarshaller
 end
 
 describe Rack::Session::Redic::Storage do
-  context 'using the MessagePack as the marshaller' do
-    it_behaves_like 'a storage marshaller'
+  describe 'using the MessagePack as the marshaller' do
+    include StorageMarshallerInterface
 
-    subject do
-      described_class.new(nil, MessagePackMarshaller, ENV['REDIS_URL'])
+    before do
+      @store = Rack::Session::Redic::Storage.new(nil, MessagePackMarshaller, ENV['REDIS_URL'])
     end
   end
 end

data/test/storage_oj_test.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+require 'oj'
+require_relative 'support/storage_marshaller_interface'
+
+describe Rack::Session::Redic::Storage do
+  describe 'using the Oj as the marshaller' do
+    include StorageMarshallerInterface
+
+    before do
+      @store = Rack::Session::Redic::Storage.new(nil, Oj, ENV['REDIS_URL'])
+    end
+  end
+end

data/test/storage_test.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+require_relative 'support/storage_marshaller_interface'
+
+describe Rack::Session::Redic::Storage do
+  describe 'using the default marshaller' do
+    include StorageMarshallerInterface
+
+    before do
+      @store = Rack::Session::Redic::Storage.new(nil, Marshal, ENV['REDIS_URL'])
+    end
+  end
+end

data/test/support/storage_marshaller_interface.rb

@@ -0,0 +1,30 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+module StorageMarshallerInterface
+  def test_returns_nil_for_empty_keys
+    assert_nil @store.get('not-here')
+  end
+
+  def test_saves_objects
+    object = { saved: true }
+    @store.set('saving', object)
+
+    assert_equal @store.get('saving'), object
+  end
+
+  def test_existence_of_keys
+    @store.set('exists', false)
+
+    assert_equal @store.exists?('exists'), true
+  end
+
+  def test_deletes_objects
+    object = { deleted: true }
+    @store.set('deleted', object)
+
+    assert_equal @store.get('deleted'), object
+    @store.delete('deleted')
+
+    assert_nil @store.get('deleted')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-redic
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Evan Lecklider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-22 00:00:00.000000000 Z
+date: 2017-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: msgpack
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: oj
+  name: msgpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,21 +87,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
-- ".rspec"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - lib/rack/session/redic.rb
 - 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
+- test/all.rb
+- test/helper.rb
+- test/session_redic_test.rb
+- test/storage_msgpack_test.rb
+- test/storage_oj_test.rb
+- test/storage_test.rb
+- test/support/storage_marshaller_interface.rb
 homepage: https://github.com/evanleck/rack-redic
 licenses:
 - MIT
@@ -122,14 +124,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 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
+- test/all.rb
+- test/helper.rb
+- test/session_redic_test.rb
+- test/storage_msgpack_test.rb
+- test/storage_oj_test.rb
+- test/storage_test.rb
+- test/support/storage_marshaller_interface.rb

data/.rspec

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

data/spec/storage_oj_spec.rb

@@ -1,14 +0,0 @@
-# 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
-      described_class.new(nil, Oj, ENV['REDIS_URL'])
-    end
-  end
-end

data/spec/storage_spec.rb

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

data/spec/support/shared_examples/storage_marshaller.rb

@@ -1,31 +0,0 @@
-# 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