restruct 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bd75f82dde2f17f7b562be3a8fe5b264028eaba
-  data.tar.gz: ed15597cbf0b1487d4ab9697649dd3575ff01e75
+  metadata.gz: b6ca1588dcf0f6ebcb9c04d2e13c5883c03c0264
+  data.tar.gz: 943e2124112da6248e3dced1ddd043fdeb980701
 SHA512:
-  metadata.gz: f5febc64be1599503c84a16a66a1e3fd0d447c99db365f620d67043117a3f49a92f6aeb37b75e11e3df1b8ccd75059d076f2aebfd61c4052eaa0b429a8c34b53
-  data.tar.gz: 22c7f357f209ee553c05699a1f3e252b65da9378596c1002da42a161ab2b29504215bbf6818d25547160fe0dc38794bba2e48bf0f3d9bac0b5e3a60ce3323cfe
+  metadata.gz: f3ca286a4dd746fa4edf2bdeae09bc014cab33895b8a799dfd893fd9934499a3797a230b901b7a75b220d989e60594cc1027685b102d2dffd2e2f2d57d024847
+  data.tar.gz: a82d2e756549aa096ef6399875628570051d49ba2359e05ca081622a717843b53c73b729e1044ac7e6d45bf24a3345f15adb055a195ae7dd54931de246bdfe91

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+
 rvm:
   - 1.9.3
   - 2.0
@@ -6,8 +7,20 @@ rvm:
   - 2.2
   - 2.3.0
   - 2.4.0
-  - jruby
+  - 2.5.0
+  - jruby-1.7.25
+  - jruby-9.1.7.0
+  - ruby-head
+  - jruby-head
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+
 before_install:
   - gem install bundler
+
 services:
-  - redis-server
+  - redis-server

data/README.md

@@ -14,6 +14,7 @@ Redis structures
 - NestedHash
 - Queue
 - Locker
+- Cache
 
 ## Installation
 

data/lib/restruct.rb

@@ -12,12 +12,14 @@ require_relative 'restruct/array'
 require_relative 'restruct/set'
 require_relative 'restruct/hash'
 require_relative 'restruct/queue'
+require_relative 'restruct/cache'
 require_relative 'restruct/nested_hash'
 require_relative 'restruct/marshalizable'
 require_relative 'restruct/marshal_array'
 require_relative 'restruct/marshal_set'
 require_relative 'restruct/marshal_hash'
 require_relative 'restruct/marshal_queue'
+require_relative 'restruct/marshal_cache'
 require_relative 'restruct/locker'
 require_relative 'restruct/connection'
 

data/lib/restruct/cache.rb

@@ -0,0 +1,94 @@
+module Restruct
+  class Cache < Structure
+
+    include Enumerable
+
+    attr_reader :ttl
+
+    def initialize(options={})
+      super options
+      @ttl = options[:ttl]
+    end
+
+    def key?(key)
+      connection.call('EXISTS', id[key]) == 1
+    end
+    alias_method :has_key?, :key?
+
+    def keys
+      sections = id.sections.count + 1
+      connection.call('KEYS', id['*']).map do |k| 
+        Id.new(k).sections.take(sections).last
+      end.uniq.sort
+    end
+
+    def [](key)
+      deserialize connection.call('GET', id[key])
+    end
+
+    def []=(key, value)
+      connection.lazy 'SET', id[key], serialize(value)
+      connection.lazy 'EXPIRE', id[key], ttl if ttl
+    end
+
+    def delete(key)
+      value = self[key]
+      connection.lazy 'DEL', id[key]
+      value
+    end
+
+    def fetch(key, &block)
+      if key? key
+        connection.lazy 'EXPIRE', id[key], ttl if ttl
+        self[key]
+      else
+        value = block.call
+        self[key] = value
+        value
+      end
+    end
+
+    def each
+      keys.each { |key| yield key, self[key] }
+    end
+
+    def size
+      keys.count
+    end
+    alias_method :count, :size
+    alias_method :length, :size
+
+    def empty?
+      size == 0
+    end
+
+    def to_h
+      keys.each_with_object({}) do |key, hash|
+        hash[key] = self[key]
+      end
+    end
+    alias_method :to_primitive, :to_h
+    alias_method :dump, :to_h
+
+    def restore(dump)
+      dump.each { |k,v| self[k] = v }
+    end
+
+    def destroy
+      keys.each { |k| connection.lazy 'DEL', id[k] }
+      self
+    end
+    alias_method :clear, :destroy
+
+    private
+
+    def serialize(string)
+      string
+    end
+
+    def deserialize(string)
+      string
+    end
+
+  end
+end

data/lib/restruct/marshal_cache.rb

@@ -0,0 +1,5 @@
+module Restruct
+  class MarshalCache < Cache
+    include Marshalizable
+  end
+end

data/lib/restruct/marshalizable.rb

@@ -6,7 +6,7 @@ module Restruct
     end
     
     def deserialize(element)
-      Marshal.load element if element
+      Marshal.load element unless element.nil?
     end
 
   end

data/lib/restruct/version.rb

@@ -1,3 +1,3 @@
 module Restruct
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/cache_spec.rb

@@ -0,0 +1,157 @@
+require 'minitest_helper'
+
+[Restruct::Cache, Restruct::MarshalCache].each do |klass|
+
+  describe klass do
+
+    let(:sample_cache) { klass.new }
+
+    def fill(data)
+      data.each do |k,v|
+        connection.call 'SET', sample_cache.id[k], sample_cache.send(:serialize, v)
+      end
+    end
+
+    describe 'Getters' do
+      
+      it '[]' do
+        fill a: 'x', b: 'y'
+
+        sample_cache[:a].must_equal 'x'
+        sample_cache[:b].must_equal 'y'
+        sample_cache[:c].must_be_nil
+      end
+
+      it 'fetch' do
+        fill a: 'x', b: 'y'
+
+        sample_cache.fetch(:a) { 'z' }.must_equal 'x'
+        sample_cache.fetch(:b) { 'z' }.must_equal 'y'
+        sample_cache.fetch(:c) { 'z' }.must_equal 'z'
+      end
+
+      it 'keys' do
+        fill a: 'x', b: 'y', c: 'z'
+        sample_cache.keys.must_equal %w(a b c)
+      end
+
+      it 'TTL' do
+        sample_cache = klass.new ttl: 1
+        sample_cache[:a] = 'x'
+
+        sample_cache[:a].must_equal 'x'
+        sleep 1.1
+        sample_cache[:a].must_be_nil
+      end
+
+    end
+
+    describe 'Setters' do
+      
+      it 'delete' do
+        fill a: 'x', b: 'y'
+
+        sample_cache.delete(:b).must_equal 'y'
+        sample_cache.to_h.must_equal 'a' => 'x'
+        
+        sample_cache.delete(:c).must_be_nil
+        sample_cache.to_h.must_equal 'a' => 'x'
+      end
+      
+      it 'clear' do
+        fill a: 'x', b: 'y'
+
+        sample_cache.clear.must_equal sample_cache
+        sample_cache.must_be_empty
+      end
+
+    end
+
+    describe 'Info' do
+
+      %w(size count length).each do |method|
+        it method do
+          fill a: 'x', b: 'y'
+          sample_cache.send(method).must_equal 2
+        end
+      end
+      
+      it 'empty?' do
+        sample_cache.must_be :empty?
+        fill a: 'x', b: 'y'
+        sample_cache.wont_be :empty?
+      end
+
+      %w(key? has_key?).each do |method|
+        it method do
+          fill a: 'x', b: 'y'
+
+          assert sample_cache.send(method, :a)
+          refute sample_cache.send(method, :c)
+        end
+      end
+
+    end
+
+    describe 'Transformations' do
+
+      %w(to_h to_primitive).each do |method|
+        it method do
+          fill a: 'x', b: 'y'
+          sample_cache.send(method).must_equal 'a' => 'x', 'b' => 'y'
+        end
+      end
+
+    end
+
+    describe 'Enumerable' do
+
+      it 'included module' do
+        assert Restruct::Hash.included_modules.include? Enumerable
+      end
+
+      it 'each' do
+        fill a: 'x', b: 'y'
+
+        hash = sample_cache.each_with_object({}) { |(k,v), h| h[k] = v }
+
+        hash.must_equal sample_cache.to_h
+      end
+
+    end
+
+    it 'Equality' do
+      copy = klass.new id: sample_cache.id
+      assert sample_cache == copy
+      assert sample_cache.eql? copy
+      refute sample_cache.equal? copy
+    end
+
+    it 'Dump/Restore' do
+      fill a: 'x', b: 'y'
+      
+      dump = sample_cache.dump
+      other = klass.new
+      other.restore dump
+
+      other.id.wont_equal sample_cache.id
+      other.to_primitive.must_equal sample_cache.to_primitive
+    end
+
+    it 'Batch' do
+      fill a: 'x', b: 'y', c: 'z'
+
+      sample_cache.connection.batch do
+        sample_cache[:d] = 'w'
+        sample_cache.delete :a
+        sample_cache[:b] = 'x'
+        
+        sample_cache.to_h.must_equal 'a' => 'x', 'b' => 'y', 'c' => 'z'    
+      end
+
+      sample_cache.to_h.must_equal 'b' => 'x', 'c' => 'z', 'd' => 'w'
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restruct
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Gabriel Naiman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-08 00:00:00.000000000 Z
+date: 2018-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redic
@@ -196,12 +196,14 @@ files:
 - Rakefile
 - lib/restruct.rb
 - lib/restruct/array.rb
+- lib/restruct/cache.rb
 - lib/restruct/connection.rb
 - lib/restruct/errors.rb
 - lib/restruct/hash.rb
 - lib/restruct/id.rb
 - lib/restruct/locker.rb
 - lib/restruct/marshal_array.rb
+- lib/restruct/marshal_cache.rb
 - lib/restruct/marshal_hash.rb
 - lib/restruct/marshal_queue.rb
 - lib/restruct/marshal_set.rb
@@ -215,6 +217,7 @@ files:
 - lua/unregister.lua
 - restruct.gemspec
 - spec/array_spec.rb
+- spec/cache_spec.rb
 - spec/connection_spec.rb
 - spec/coverage_helper.rb
 - spec/hash_spec.rb
@@ -250,6 +253,7 @@ specification_version: 4
 summary: Redis structures
 test_files:
 - spec/array_spec.rb
+- spec/cache_spec.rb
 - spec/connection_spec.rb
 - spec/coverage_helper.rb
 - spec/hash_spec.rb