redstruct 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2af38a102227eedaa6ed3d2f8efd91b02dcae8a0
-  data.tar.gz: 49041b97b9b1074aaac1986b792ea2ba72b7e3cc
+  metadata.gz: ba26d3bd5b2d46e3f499125f7e6ec6166afade9d
+  data.tar.gz: 6616843bccefb369e2a9d3b1a4e40c7b8f48b6d4
 SHA512:
-  metadata.gz: 9f1b9391762f28ec0686ce2f5b54b756b31e6640d63c51448b26d6d8948564a55916ff78f419edcba8310bdb3b79f91ad680fe5d17ad842e14fdda2528139823
-  data.tar.gz: 0abdd88f1387ea57ef1546ef35bae91fc783c631287c412705867ebbc148c093f9d5293aa208aec6b5f1fb964f8b0feedb2f3364c9f7338a6fef3f6f26d29fa0
+  metadata.gz: f01736c5c824bf2e5e7c3cf5487c8886cfcfefba0c6cfcb258c499427d933ad382292f330931ce5d54ad03fef34262fa3039ce69055fe61cf7bf0b696dcec584
+  data.tar.gz: ae8f90b885b9f7ce20fc4b7fb2e7fec7744d9783fb75a22ed398c08ebcba9be959a42f6be6b6afe2adc9f827efd11cbc23de3a37968ea4cc6c569ca7f8ff34d5

data/lib/redstruct/list.rb

@@ -277,7 +277,7 @@ module Redstruct
       local index = tonumber(ARGV[2])
       local pivot = redis.call('lindex', KEYS[1], index - 1)
 
-      if pivot ~= nil then
+      if pivot then
         return redis.call('linsert', KEYS[1], 'AFTER', pivot, value)
       end
 

data/lib/redstruct/script.rb

@@ -11,7 +11,7 @@ module Redstruct
   # are not used anymore.
   class Script
     # Redis returns an error starting with NOSCRIPT when we try to evaluate am unknown script using its sha1.
-    ERROR_MESSAGE_PREFIX = 'NOSCRIPT'
+    ERROR_MESSAGE_PATTERN = /^NOSCRIPT.*$/
 
     # @return [String] the Lua script to evaluate
     attr_reader :script
@@ -80,7 +80,7 @@ module Redstruct
 
       @connection.evalsha(self.sha1, keys, argv)
     rescue Redis::CommandError => err
-      raise unless err.message.start_with?(ERROR_MESSAGE_PREFIX)
+      raise unless ERROR_MESSAGE_PATTERN.match(err.message)
       @connection.eval(@script, keys, argv)
     end
 

data/lib/redstruct/struct.rb

@@ -51,13 +51,18 @@ module Redstruct
 
     # @return [String] the underlying redis type
     def type
-      self.connection.type(@key)
+      name = self.connection.type(@key)
+      return nil if name == 'none'
+      return name
     end
 
     # Returns the time to live of the key
-    # @return [Float] time to live in seconds as a float where 0.001 == 1 ms
+    # @return [Float, nil time nil if the key does not exist or has no expiry, or the time to live in seconds
     def ttl
-      return self.connection.pttl(@key) / 1000.0
+      value = self.connection.pttl(@key)
+
+      return nil if [-1, -2].include?(value)
+      return value.to_f / 1000
     end
 
     # Returns a serialized representation of the key, which can be used to store a value externally, and restored to
@@ -71,7 +76,7 @@ module Redstruct
 
     # Restores the struct to its serialized value as given
     # @param [String] serialized serialized representation of the value
-    # @param [#to_f] ttl the time to live for the struct; defaults to 0 (meaning no expiry). 0.001 == 1ms
+    # @param [#to_f] ttl the time to live (in seconds) for the struct; defaults to 0 (meaning no expiry)
     # @raise [Redis::CommandError] raised if the serialized value is incompatible or the key already exists
     # @return [Boolean] true if restored, false otherwise
     def restore(serialized, ttl: 0)

data/lib/redstruct/version.rb

@@ -2,5 +2,5 @@
 
 module Redstruct
   # Current version
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/test/helpers/test_case.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'redstruct/utils/atomic_counter'
+
+module Redstruct
+  # Base class for all Redstruct tests. Configures the gem, provides a default factory, and makes sure to clean it up
+  # at the end
+  class TestCase < Minitest::Test
+    # rubocop: disable Style/ClassVars
+    @@counter = Redstruct::Utils::AtomicCounter.new
+    @@factory = Redstruct::Factory.new
+
+    parallelize_me!
+    make_my_diffs_pretty!
+
+    # Use this helper to create a factory that the test class will keep track of and remove at the end
+    def create_factory(namespace = nil)
+      namespace ||= @@counter.increment.to_s
+      return @@factory.factory(namespace)
+    end
+
+    # Helper when trying to ensure a particular redis-rb command was called
+    # while still calling it. This allows for testing things outside of our
+    # control (e.g. srandmember returning random items)
+    # The reason we don't simply just mock the return value is to ensure
+    # that tests will break if a command (e.g. srandmember) changes its return
+    # value
+    def ensure_command_called(object, command, *args, allow: true)
+      mock = flexmock(object.connection).should_receive(command).with(object.key, *args)
+      mock = mock.pass_thru if allow
+
+      return mock
+    end
+  end
+end

data/test/redstruct/configuration_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 module Redstruct
-  class ConfigurationTest < Redstruct::Test
+  class ConfigurationTest < Redstruct::TestCase
     def test_initialize
       @config = Redstruct::Configuration.new
       assert_nil @config.default_connection, 'Should have no default connection initially'

data/test/redstruct/connection_proxy_test.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 
 module Redstruct
   # TODO: not quite sure if this test suite is good enough
-  class ConnectionProxyTest < Redstruct::Test
+  class ConnectionProxyTest < Redstruct::TestCase
     def test_initialize
       assert_raises(ArgumentError, 'should fail to initialize without a proxy object') { Redstruct::ConnectionProxy.new }
     end

data/test/redstruct/counter_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 module Redstruct
-  class CounterTest < Redstruct::Test
+  class CounterTest < Redstruct::TestCase
     def setup
       super
       @factory = create_factory

data/test/redstruct/factory/object_test.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 
 module Redstruct
   class Factory
-    class ObjectTest < Redstruct::Test
+    class ObjectTest < Redstruct::TestCase
       def test_initialize
         factory = create_factory
         object = Redstruct::Factory::Object.new(factory: factory)

data/test/redstruct/factory_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 module Redstruct
-  class FactoryTest < Redstruct::Test
+  class FactoryTest < Redstruct::TestCase
     def test_initialize_default
       flexmock(Redstruct::ConnectionProxy).should_receive(:new).with(Redstruct.config.default_connection).once.pass_thru
       factory = Redstruct::Factory.new

data/test/redstruct/hash_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 module Redstruct
-  class HashTest < Redstruct::Test
+  class HashTest < Redstruct::TestCase
     def setup
       super
       @factory = create_factory

data/test/redstruct/list_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 module Redstruct
-  class ListTest < Redstruct::Test
+  class ListTest < Redstruct::TestCase
     def setup
       super
       @factory = create_factory
@@ -34,9 +34,6 @@ module Redstruct
 
     def test_insert_single
       initial = SecureRandom.hex(4)
-      assert_raises(Redis::CommandError, 'should fail (out of bounds)') do
-        @list.insert(initial, 1)
-      end
 
       assert @list.insert(initial, 0), 'should insert correctly first element'
       assert_equal initial, @list[0]

data/test/redstruct/lock_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 module Redstruct
-  class LockTest < Redstruct::Test
+  class LockTest < Redstruct::TestCase
     def setup
       super
       @factory = create_factory

data/test/redstruct/script_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 module Redstruct
-  class ScriptTest < Redstruct::Test
+  class ScriptTest < Redstruct::TestCase
     def setup
       super
       @value = @@counter.increment

data/test/redstruct/set_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 module Redstruct
-  class SetTest < Redstruct::Test
+  class SetTest < Redstruct::TestCase
     def setup
       super
       @factory = create_factory

data/test/redstruct/sorted_set/slice_test.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 
 module Redstruct
   class SortedSet
-    class SliceTest < Redstruct::Test
+    class SliceTest < Redstruct::TestCase
     end
   end
 end

data/test/redstruct/sorted_set_test.rb

@@ -3,7 +3,7 @@
 require 'test_helper'
 
 module Redstruct
-  class SortedTest < Redstruct::Test
+  class SortedTest < Redstruct::TestCase
     def setup
       super
       @factory = create_factory

data/test/redstruct/string_test.rb

@@ -3,6 +3,6 @@
 require 'test_helper'
 
 module Redstruct
-  class StringTest < Redstruct::Test
+  class StringTest < Redstruct::TestCase
   end
 end

data/test/redstruct/struct_test.rb

@@ -4,7 +4,7 @@ require 'securerandom'
 require 'test_helper'
 
 module Redstruct
-  class StructTest < Redstruct::Test
+  class StructTest < Redstruct::TestCase
     def setup
       super
       @factory = create_factory
@@ -42,11 +42,40 @@ module Redstruct
       refute @struct.exists?, 'should not exist since it was marked to be expired 1 second after 1970-01-01'
     end
 
-    def test_persist; end
+    def test_persist
+      refute @struct.persist, 'should not be able to persist non existent keys'
+      write_struct
+      refute @struct.persist, 'should not be able to persist keys with no expiry'
+
+      @struct.expire(1)
+      assert @struct.ttl.positive?, 'should now have a ttl'
+      assert @struct.persist, 'should be able to persist keys with expiry'
+      assert_nil @struct.ttl, 'should not have a ttl anymore'
+    end
 
-    def test_type; end
+    def test_type
+      assert_nil @struct.type, 'should have no type when it does not exist'
+
+      # to avoid writing tests for each possible type, we simply ensure we return
+      # whatever redis returned
+      type = SecureRandom.hex(8)
+      write_struct
+      ensure_command_called(@struct, :type, allow: false).once.and_return(type)
+      assert_equal type, @struct.type, 'should return whatever redis returns'
+    end
 
-    def test_ttl; end
+    def test_ttl
+      assert_nil @struct.ttl, 'should have no ttl initially'
+
+      write_struct
+      assert_nil @struct.ttl, 'should still have no ttl even if it exists'
+
+      @struct.expire(1)
+      assert @struct.ttl.positive?, 'should have a ttl > 0'
+
+      @struct.persist
+      assert_nil @struct.ttl, 'should now have no ttl again'
+    end
 
     def test_dump; end
 

data/test/redstruct/utils/coercion_test.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 
 module Redstruct
   module Utils
-    class CoercionTest < Redstruct::Test
+    class CoercionTest < Redstruct::TestCase
       def test_coerce_bool
         refute Redstruct::Utils::Coercion.coerce_bool(nil), 'nil should be coerced to false'
         refute Redstruct::Utils::Coercion.coerce_bool(false), 'false should be coerced to false'

data/test/redstruct/utils/inspectable_test.rb

@@ -5,7 +5,7 @@ require 'flexmock/minitest'
 
 module Redstruct
   module Utils
-    class InspectableTest < Redstruct::Test
+    class InspectableTest < Redstruct::TestCase
       def test_inspect
         child = flexmock('test')
         child.should_receive(:inspect).and_return('child').once

data/test/redstruct/utils/iterable_test.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 
 module Redstruct
   module Utils
-    class IterableTest < Redstruct::Test
+    class IterableTest < Redstruct::TestCase
       def test_to_enum_bad_impl
         assert_raises(NotImplementedError, 'should fail and raise not implemented on missing implementations') do
           BadIterator.new.to_enum

data/test/redstruct/utils/scriptable_test.rb

@@ -6,7 +6,7 @@ require 'test_helper'
 
 module Redstruct
   module Utils
-    class ScriptableTest < Redstruct::Test
+    class ScriptableTest < Redstruct::TestCase
       def test_defscript
         script = <<~LUA
           local sum = 0
@@ -42,8 +42,6 @@ module Redstruct
         klass = Class.new { include Redstruct::Utils::Scriptable }
         klass.const_set('SCRIPT_TEST', true)
 
-        stdout, = capture_subprocess_io { klass.defscript('test', 'return 0') }
-        assert_match(/WARN/, stdout, 'should produce a warning if the constant is already defined')
         refute klass.method_defined?('test')
         assert_equal true, klass::SCRIPT_TEST, 'should still be the old value'
       end
@@ -57,8 +55,6 @@ module Redstruct
           end
         end
 
-        stdout, = capture_subprocess_io { klass.defscript('test', 'return 0') }
-        assert_match(/WARN/, stdout, 'should produce a warning if the method is already defined')
         refute klass.const_defined?('SCRIPT_TEST')
         assert_equal true, klass.new.test, 'should still be the old value'
       end

data/test/redstruct_test.rb

@@ -2,7 +2,7 @@
 
 require 'test_helper'
 
-class RedstructTest < Redstruct::Test
+class RedstructTest < Redstruct::TestCase
   # Test singleton property of the config
   def test_config
     config = Redstruct.config

data/test/test_helper.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'securerandom'
-require 'bundler/setup'
-require 'minitest/autorun'
-require 'flexmock/minitest'
-require 'redstruct/utils/atomic_counter'
-
+# Environment
 ci_build = ENV['CI_BUILD'].to_i.positive?
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
+# Bundler setup
+require 'bundler/setup'
 bundler_groups = %i[default test]
 bundler_groups << (ci_build ? :ci : :debug)
 Bundler.require(*bundler_groups)
@@ -23,7 +20,11 @@ Redstruct.config.default_connection = ConnectionPool.new(size: 5, timeout: 2) do
   Redis.new(host: ENV.fetch('REDIS_HOST', '127.0.0.1'), port: ENV.fetch('REDIS_PORT', 6379).to_i, db: ENV.fetch('REDIS_DB', 0).to_i)
 end
 
-# Setup cleanup hook
+# Setup Minitest
+require 'minitest/autorun'
+require 'flexmock/minitest'
+require 'minitest/reporters'
+Minitest::Reporters.use!([Minitest::Reporters::SpecReporter.new])
 Minitest.after_run do
   Redstruct.config.default_connection.with do |conn|
     conn.flushdb
@@ -31,32 +32,6 @@ Minitest.after_run do
   end
 end
 
-module Redstruct
-  # Base class for all Redstruct tests. Configures the gem, provides a default factory, and makes sure to clean it up
-  # at the end
-  class Test < Minitest::Test
-    @@counter = Redstruct::Utils::AtomicCounter.new # rubocop: disable Style/ClassVars
-
-    parallelize_me!
-    make_my_diffs_pretty!
-
-    # Use this helper to create a factory that the test class will keep track of and remove at the end
-    def create_factory(namespace = nil)
-      namespace ||= "#{Redstruct.config.default_namespace}:#{@@counter.increment}"
-      return Redstruct::Factory.new(namespace: namespace)
-    end
-
-    # Helper when trying to ensure a particular redis-rb command was called
-    # while still calling it. This allows for testing things outside of our
-    # control (e.g. srandmember returning random items)
-    # The reason we don't simply just mock the return value is to ensure
-    # that tests will break if a command (e.g. srandmember) changes its return
-    # value
-    def ensure_command_called(object, command, *args, allow: true)
-      mock = flexmock(object.connection).should_receive(command).with(object.key, *args)
-      mock = mock.pass_thru if allow
-
-      return mock
-    end
-  end
-end
+# Require everything else
+require 'securerandom'
+require 'helpers/test_case'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redstruct
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Nicolas Pepin-Perreault
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -120,6 +120,7 @@ files:
 - lib/redstruct/utils/scriptable.rb
 - lib/redstruct/version.rb
 - lib/yard/defscript_handler.rb
+- test/helpers/test_case.rb
 - test/redstruct/configuration_test.rb
 - test/redstruct/connection_proxy_test.rb
 - test/redstruct/counter_test.rb
@@ -165,6 +166,7 @@ signing_key:
 specification_version: 4
 summary: Higher level data structures for Redis.
 test_files:
+- test/helpers/test_case.rb
 - test/redstruct/configuration_test.rb
 - test/redstruct/connection_proxy_test.rb
 - test/redstruct/counter_test.rb