moneta 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a202106a03e55e35500188da66bf1509b5759c5d202ef0b6b84e731247d8fa62
-  data.tar.gz: 964762ceafae4fafa65f0a07e2ac6d90f8d1bc43b1d74d5428736eb9a23a86f0
+  metadata.gz: 67e7a85926fad89dd255f180a3455b67c923d0194d447a8fe82cca0dbb546bbe
+  data.tar.gz: 51e15e0e3e1bafd312ee62d807afb72836e4f5c3cc036dc8c1ee0dcb8d51f80a
 SHA512:
-  metadata.gz: 18e5417ed780ae397000d539e8d7f1d5e51dfce856fb7913f11f2ff5f53a1c5f52a50ba3a2bccaca5572d894f8fd1adf77a73f1b446323e00b7c0cf0814c3710
-  data.tar.gz: c8f781706f5cd8022a9b728a2d9948d7a14e08c875ee6c1b75d4df7faefb94ebf54a0192733b5c0af05d1b879296dcf687aedaf40125daad234aaa44429cb540
+  metadata.gz: cc4340a0c94ce262108361a3ed49116980cc0ee94838810babe5015bb43d3084875fa3e76f232b182470dda6a5ab9ac7e09fe9917a97082047ec9d0b7112a02a
+  data.tar.gz: a0f1c197e3222848e246bf0535805b4dd47bf8dbf9b3a383c619e187cb9b6d64ac6de4f711190630b4befac1e820061fd66a04d83a529a01bee519fbcde4af23

data/.github/workflows/ruby.yml

@@ -2,9 +2,9 @@ name: Ruby CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   adapters:
@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
 
       matrix:
-        ruby-version: [2.7, 2.6, 2.5, 2.4, 2.3, jruby]
+        ruby-version: [2.7, 2.6, 2.5, 2.4, jruby]
         adapter:
           - Client
           - Cookie
@@ -42,7 +42,7 @@ jobs:
           - YAML
 
     env:
-      BUNDLE_WITHOUT: activerecord riak couch cassandra postgresql mysql datamapper memcached_native
+      BUNDLE_WITH: ${{ matrix.adapter }} snappy
 
     steps:
     - uses: actions/checkout@v2
@@ -51,7 +51,7 @@ jobs:
       run: sudo apt-get update
 
     - name: Apt install dependencies
-      run: sudo apt-get install -y libkyotocabinet-dev libleveldb-dev liblzo2-dev libtdb-dev libtokyocabinet-dev tokyotyrant libgdbm-dev
+      run: sudo apt-get install -y libkyotocabinet-dev libleveldb-dev libtdb-dev libtokyocabinet-dev tokyotyrant libgdbm-dev
 
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
@@ -61,7 +61,7 @@ jobs:
         bundler-cache: true
 
     - name: Rspec
-      run: bundle exec rspec -t ~unstable -t adapter:${{ matrix.adapter }}
+      run: bundle exec rspec -t ~unstable -t adapter:${{ matrix.adapter }} -- spec/moneta
 
   couch:
     name: "Couch adapter"
@@ -83,10 +83,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.7, 2.3, jruby]
+        ruby-version: [2.7, 2.4, jruby]
 
     env:
-      BUNDLE_WITHOUT: activerecord riak cassandra postgresql mysql datamapper memcached_native leveldb lzo tdb
+      BUNDLE_WITH: RestClient
 
     steps:
     - uses: actions/checkout@v2
@@ -99,7 +99,7 @@ jobs:
         bundler-cache: true
 
     - name: Rspec
-      run: bundle exec rspec -t adapter:Couch
+      run: bundle exec rspec -t adapter:Couch -- spec/moneta
 
   cassandra:
     name: "Cassandra adapter"
@@ -111,17 +111,17 @@ jobs:
         options: >-
           --health-cmd "cqlsh -e \"SELECT cql_version FROM system.local\""
           --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
+          --health-timeout 10s
+          --health-retries 10
         ports:
           - 9042:9042
 
     strategy:
       matrix:
-        ruby-version: [2.7, 2.3, jruby]
+        ruby-version: [2.7, 2.4, jruby]
 
     env:
-      BUNDLE_WITHOUT: activerecord riak couch postgresql mysql datamapper memcached_native leveldb lzo tdb
+      BUNDLE_WITH: Cassandra
 
     steps:
     - uses: actions/checkout@v2
@@ -134,7 +134,7 @@ jobs:
         bundler-cache: true
 
     - name: Rspec
-      run: bundle exec rspec -t adapter:Cassandra
+      run: bundle exec rspec -t adapter:Cassandra -- spec/moneta
 
   mysql-adapters:
     name: "MySQL adapters"
@@ -158,7 +158,7 @@ jobs:
         ruby-version: [2.7, 2.4, jruby]
 
     env:
-      BUNDLE_WITHOUT: riak couch cassandra postgresql memcached_native leveldb
+      BUNDLE_WITH: ActiveRecord Sequel DataMapper mysql
       MYSQL_HOST: 127.0.0.1
       MONETA_MYSQL_PASSWORD: moneta
 
@@ -189,7 +189,7 @@ jobs:
         bundler-cache: true
 
     - name: Rspec
-      run: bundle exec rspec -t mysql
+      run: bundle exec rspec -t mysql -- spec/moneta
 
   postgres-adapters:
     name: "Postgres adapters"
@@ -197,7 +197,7 @@ jobs:
 
     services:
       postgres:
-        image: postgres
+        image: postgres:13.6
         env:
           POSTGRES_PASSWORD: moneta
         options: >-
@@ -210,10 +210,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.7, 2.3, jruby]
+        ruby-version: [2.7, 2.4, jruby]
 
     env:
-      BUNDLE_WITHOUT: riak couch cassandra mysql memcached_native leveldb
+      BUNDLE_WITH: ActiveRecord Sequel DataMapper postgresql
       PGHOST: localhost
       PGUSER: postgres
       PGPASSWORD: moneta
@@ -238,7 +238,7 @@ jobs:
         bundler-cache: true
 
     - name: Rspec
-      run: bundle exec rspec -t postgres
+      run: bundle exec rspec -t postgres -- spec/moneta
 
   sqlite-adapters:
     name: "SQLite adapters"
@@ -246,10 +246,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.7, 2.3, jruby]
+        ruby-version: [2.7, 2.4, jruby]
 
     env:
-      BUNDLE_WITHOUT: riak couch cassandra mysql postgres memcached_native leveldb
+      BUNDLE_WITH: ActiveRecord Sequel DataMapper sqlite
 
     steps:
     - uses: actions/checkout@v2
@@ -262,7 +262,7 @@ jobs:
         bundler-cache: true
 
     - name: Rspec
-      run: bundle exec rspec -t sqlite
+      run: bundle exec rspec -t sqlite -- spec/moneta
 
   redis:
     name: "Redis adapters"
@@ -281,10 +281,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.7, 2.3, jruby]
+        ruby-version: [2.7, 2.4, jruby]
 
     env:
-      BUNDLE_WITHOUT: activerecord riak couch cassandra postgresql mysql datamapper memcached_native leveldb
+      BUNDLE_WITH: Redis
 
     steps:
     - uses: actions/checkout@v2
@@ -297,7 +297,7 @@ jobs:
         bundler-cache: true
 
     - name: Rspec
-      run: bundle exec rspec -t adapter:Redis -t redis
+      run: bundle exec rspec -t adapter:Redis -t redis -- spec/moneta
 
   memcached:
     name: "Memcached adapters"
@@ -305,10 +305,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.7, 2.3, jruby]
+        ruby-version: [2.7, 2.4, jruby]
 
     env:
-      BUNDLE_WITHOUT: activerecord riak couch cassandra postgresql mysql datamapper leveldb lzo tdb
+      BUNDLE_WITH: Memcached
 
     steps:
     - uses: actions/checkout@v2
@@ -327,7 +327,7 @@ jobs:
         bundler-cache: true
 
     - name: Rspec
-      run: bundle exec rspec -t ~unstable -t adapter:Memcached -t memcached
+      run: bundle exec rspec -t ~unstable -t adapter:Memcached -t memcached -- spec/moneta
 
   mongo:
     name: "Mongo adapter"
@@ -346,10 +346,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.7, 2.3] #, jruby] - FIXME reenable once https://github.com/mongodb/mongo-ruby-driver/pull/2143 is released
+        ruby-version: [2.7, 2.4] #, jruby] - FIXME reenable once https://github.com/mongodb/mongo-ruby-driver/pull/2143 is released
 
     env:
-      BUNDLE_WITHOUT: activerecord riak couch cassandra postgresql mysql datamapper memcached_native leveldb
+      BUNDLE_WITH: Mongo
 
     steps:
     - uses: actions/checkout@v2
@@ -362,7 +362,7 @@ jobs:
         bundler-cache: true
 
     - name: Rspec
-      run: bundle exec rspec -t adapter:Mongo
+      run: bundle exec rspec -t adapter:Mongo -- spec/moneta
 
   residual-specs:
     name: "Proxies and other specs"
@@ -370,10 +370,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.7, 2.3, jruby]
+        ruby-version: [2.7, 2.4, jruby]
 
     env:
-      BUNDLE_WITHOUT: activerecord riak couch cassandra postgresql mysql datamapper memcached_native redis leveldb
+      BUNDLE_WITH: transformers GDBM Fog
 
     steps:
     - uses: actions/checkout@v2
@@ -382,7 +382,7 @@ jobs:
       run: sudo apt-get update
 
     - name: Apt install dependencies
-      run: sudo apt-get install -y libgdbm-dev
+      run: sudo apt-get install -y libgdbm-dev liblzo2-dev
 
     - name: Set up Ruby ${{ matrix.ruby-version }}
       uses: ruby/setup-ruby@v1
@@ -401,9 +401,6 @@ jobs:
     name: "Rubocop"
     runs-on: ubuntu-latest
 
-    env:
-      BUNDLE_WITHOUT: activerecord riak couch cassandra postgresql mysql datamapper memcached_native redis leveldb
-
     steps:
     - uses: actions/checkout@v2
 

data/CHANGES

@@ -1,3 +1,12 @@
+1.5.0
+
+* Adapters - internally, most (all?) adapters now inherit from a base Adapter class
+* Adapters - adapter configuration is now accessed via a `config` method on
+             each adapter - see the code for examples.  This shouldn't affect
+             users unless they were directly modifying adapters' attributes.
+* Redis - fix deprecation warnings for Redis 4.6+ multi/pipelined handling (#215)
+* Mongo - slight improvement to error handling
+
 1.4.2
 
 * Pool - fix busy-loop issue (#197)

data/CONTRIBUTORS

@@ -3,6 +3,7 @@ Alastair Pharo <me@asph.dev>
 Alejandro Crosa <acrosa@sharing.local>
 Alessio Signorini <alessio@signorini.us>
 Anthony Eden <anthonyeden@gmail.com>
+Antonio Terceiro <terceiro@debian.org>
 Atoxhybrid <atoxhybrid@gmail.com>
 AtoxIO <atoxhybrid@gmail.com>
 Ben Schwarz <ben.schwarz@gmail.com>
@@ -32,6 +33,7 @@ Potapov Sergey <blake131313@gmail.com>
 Quin Hoxie <quin@aboutus.org>
 Ryan T. Hosford <tad.hosford@gmail.com>
 Scott Wadden <scott.wadden@gmail.com>
+Sven Riedel <sr@gimp.org>
 Timo Goebel <timo.goebel@dm.de>
 Tom Meier <ozmeier@yahoo.co.uk>
 Tony Han <h.bing612@gmail.com>

data/Gemfile

@@ -1,86 +1,174 @@
 source 'https://rubygems.org'
 gemspec
 
-# Used by multiple backends / transformers
-gem 'multi_json', groups: %i{json couch cassandra}
-gem 'faraday', groups: %i{couch restclient}
-gem 'manticore', groups: %i{couch restclient}, platforms: :jruby
+group :transformers, optional: true do
+  group :tnet, optional: true do
+    gem 'tnetstring'
+  end
+
+  group :bencode, optional: true do
+    gem 'bencode'
+  end
+
+  group :ox, optional: true do
+    gem 'ox', platforms: :ruby
+  end
+
+  group :bert, optional: true do
+    gem 'bert', platforms: :ruby
+  end
+
+  group :php, optional: true do
+    gem 'php-serialize'
+  end
+
+  group :bson, optional: true do
+    gem 'bson', '>= 4.0.0'
+  end
+
+  group :msgpack, optional: true do
+    gem 'msgpack', platforms: :ruby
+    gem 'msgpack-jruby', platforms: :jruby
+  end
+
+  # Compressors used by Transformer
+  group :bzip2, optional: true do
+    gem 'rbzip2', '>= 0.3.0'
+  end
+
+  group :lz4, optional: true do
+    gem 'lz4-ruby', platforms: :ruby
+  end
+
+  group :lzma, optional: true do
+    gem 'ruby-lzma', platforms: :ruby
+  end
+
+  group :lzo, optional: true do
+    gem 'lzoruby', platforms: :ruby
+  end
+
+  group :snappy, optional: true do
+    gem 'snappy', platforms: :ruby
+  end
+
+  group :quicklz, optional: true do
+    gem 'qlzruby', platforms: :ruby
+  end
+
+  # Hash transformer library
+  group :city, optional: true do
+    gem 'cityhash', platforms: :ruby
+  end
+end
 
-# Serializers used by Transformer
-gem 'tnetstring', group: :tnet
-gem 'bencode', group: :bencode
-gem 'ox', platforms: :ruby, group: :ox
-gem 'bert', platforms: :ruby, group: :bert
-gem 'php-serialize', group: :php
+# Backends
+group :Daybreak, optional: true do
+  gem 'daybreak'
+end
 
-group :bson do
-  gem 'bson', '>= 4.0.0'
+group :ActiveRecord, optional: true do
+  gem 'activerecord', '~> 5.2'
 end
 
-group :msgpack do
-  gem 'msgpack', platforms: :ruby
-  gem 'msgpack-jruby', platforms: :jruby
+group :Redis, optional: true do
+  gem 'redis', '~> 4.2'
 end
 
-# Compressors used by Transformer
-gem 'rbzip2', '>= 0.3.0', group: :bzip2
-gem 'lz4-ruby', platforms: :ruby, group: :lz4
-gem 'ruby-lzma', platforms: :ruby, group: :lzma
-gem 'lzoruby', platforms: :ruby, group: :lzo
-gem 'snappy', platforms: :ruby, group: :snappy
-gem 'qlzruby', platforms: :ruby, group: :quicklz
+group :Mongo, optional: true do
+  gem 'mongo', '>= 2'
+end
 
-# Hash transformer library
-gem 'cityhash', platforms: :ruby, group: :city
+group :Sequel, optional: true do
+  gem 'sequel', '5.52.0'
+end
 
-# Backends
-gem 'daybreak', group: :daybreak
-gem 'activerecord', '~> 5.2', group: :activerecord
-gem 'redis', '~> 4.2', group: :redis
-gem 'mongo', '>= 2', group: :mongo_official
-gem 'sequel', group: :sequel
-gem 'dalli', group: :memcached_dalli
-gem 'riak-client', group: :riak
-gem 'cassandra-driver', group: :cassandra
-gem 'tokyotyrant', group: :tokyotyrant
-gem 'hbaserb', group: :hbase
-gem 'localmemcache', platforms: :ruby, group: :localmemcache
-gem 'tdb', platforms: :ruby, group: :tdb
-gem 'leveldb-ruby', platforms: :ruby, group: :leveldb
-gem 'lmdb', platforms: :mri, group: :lmdb
-gem 'tokyocabinet', platforms: :ruby, group: :tokyocabinet
-gem 'kyotocabinet-ruby-reanimated', platforms: [:ruby_23, :ruby_24, :ruby_25, :ruby_26], group: :kyotocabinet
-gem 'memcached', platforms: :ruby, group: :memcached_native
-gem 'jruby-memcached', platforms: :jruby, group: :memcached_native
-gem 'activerecord-jdbch2-adapter', platforms: :jruby, group: :h2, github: 'jruby/activerecord-jdbc-adapter', glob: 'activerecord-jdbch2-adapter/*.gemspec', branch: '52-stable'
-gem 'ffi-gdbm', platforms: :jruby, group: :gdbm
-group :restclient do
-  gem 'fishwife', platforms: :jruby
-  gem 'rjack-logback', platforms: :jruby
-end
-
-group :datamapper do
+group :Memcached, optional: true do
+  group :MemcachedDalli, optional: true do
+    gem 'dalli', '~> 2.7.11'
+  end
+
+  group :MemcachedNative, optional: true do
+    gem 'memcached', platforms: :ruby
+    gem 'jruby-memcached', platforms: :jruby
+  end
+end
+
+group :Riak, optional: true do
+  gem 'riak-client'
+end
+
+group :Cassandra, optional: true do
+  gem 'cassandra-driver'
+end
+
+group :TokyoTyrant, optional: true do
+  gem 'tokyotyrant'
+end
+
+group :HBase, optional: true do
+  gem 'hbaserb'
+end
+
+group :LocalMemCache, optional: true do
+  gem 'localmemcache', platforms: :ruby
+end
+
+group :TDB, optional: true do
+  gem 'tdb', platforms: :ruby
+end
+
+group :LevelDB, optional: true do
+  gem 'leveldb-ruby', platforms: :ruby
+end
+
+group :LMDB, optional: true do
+  gem 'lmdb', platforms: :mri
+end
+
+group :TokyoCabinet, optional: true do
+  gem 'tokyocabinet', platforms: :ruby
+end
+
+group :KyotoCabinet, optional: true do
+  gem 'kyotocabinet-ruby-reanimated', platforms: [:ruby_23, :ruby_24, :ruby_25, :ruby_26]
+end
+
+group :H2, optional: true do
+  gem 'activerecord-jdbch2-adapter', platforms: :jruby, github: 'jruby/activerecord-jdbc-adapter', glob: 'activerecord-jdbch2-adapter/*.gemspec', branch: '52-stable'
+end
+
+group :GDBM, optional: true do
+  gem 'ffi-gdbm', platforms: :jruby
+end
+
+group :RestClient do
+  gem 'faraday'
+  gem 'webrick'
+end
+
+group :DataMapper, optional: true do
   gem 'dm-core'
   gem 'dm-migrations'
   gem 'dm-mysql-adapter'
 end
 
-group :fog do
+group :Fog, optional: true do
   gem 'fog-aws', '>= 1.11.1'
   gem 'mime-types'
 end
 
-group :mysql do
+group :mysql, optional: true do
   gem 'activerecord-jdbcmysql-adapter', platforms: :jruby
   gem 'mysql2', platforms: :ruby
 end
 
-group :sqlite do
+group :sqlite, optional: true do
   gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
   gem 'sqlite3', '~> 1.3.6', platforms: :ruby
 end
 
-group :postgresql do
+group :postgresql, optional: true do
   gem 'activerecord-jdbcpostgresql-adapter', platforms: :jruby
   gem 'pg', platforms: :ruby
 end

data/README.md

@@ -77,8 +77,8 @@ store.close
 * Tests and benchmarks: <https://github.com/moneta-rb/moneta/actions>
 * API documentation:
     * Latest Gem: <http://rubydoc.info/gems/moneta/frames>
-    * GitHub master: <http://rubydoc.info/github/moneta-rb/moneta/master/frames>
-* Changelog: <https://github.com/moneta-rb/moneta/blob/master/CHANGES>
+    * GitHub main: <http://rubydoc.info/github/moneta-rb/moneta/main/frames>
+* Changelog: <https://github.com/moneta-rb/moneta/blob/main/CHANGES>
 
 In case you are wondering, Moneta uses [Semantic Versioning](https://semver.org/) since v1.0.0.
 
@@ -135,7 +135,7 @@ to upgrade to a real key/value store.
 
 ### Backend feature matrix
 
-__NOTE:__ <a name="backend-matrix"></a>The backend matrix is much more readable on rubydoc.info than on github. [Go there!](http://rubydoc.info/github/moneta-rb/moneta/master/file/README.md#backend-matrix)
+__NOTE:__ <a name="backend-matrix"></a>The backend matrix is much more readable on rubydoc.info than on github. [Go there!](http://rubydoc.info/github/moneta-rb/moneta/main/file/README.md#backend-matrix)
 
 <table>
 <tr><th>Adapter</th><th>Required gems</th><th style="writing-mode:tb">MRI support<sup>1</sup></th><th style="writing-mode:tb">JRuby support<sup>1</sup></th><th style="writing-mode:tb">Multi-thread safe<sup>2</sup></th><th style="writing-mode:tb">Multi-process safe<sup>3</sup></th><th style="writing-mode:tb">Atomic increment<sup>4</sup></th><th style="writing-mode:tb">Atomic create<sup>5</sup></th><th style="writing-mode:tb">Native expires<sup>6</sup></th><th style="writing-mode:tb">Persistent</th><th style="writing-mode:tb">Key Traversal</th><th style="writing-mode:tb">Bulk read<sup>7</sup></th><th style="writing-mode:tb">Bulk write<sup>8</sup></th><th>Description</th></tr>
@@ -912,7 +912,8 @@ Person.adapter :memory, Moneta.new(:Redis)
 ## Testing and Benchmarks
 
 Testing is done using [GitHub Actions](https://github.com/moneta-rb/moneta/actions).
-Currently we support MRI Ruby >= 2.3.0 and the JRuby >= 9.2.9.0.
+Currently we support MRI Ruby >= 2.4.0 (but not yet 3.x) and the JRuby >=
+9.2.9.0. MRI 2.3.0 should mostly still work, but is no longer tested in CI.
 
 ~~Benchmarks for each store are done on
 [Travis-CI](http://travis-ci.org/moneta-rb/moneta) for each build.~~  At the

data/lib/moneta/adapter.rb

@@ -0,0 +1,52 @@
+module Moneta
+  # Adapter base class
+  # @api public
+  class Adapter
+    include Defaults
+    include Config
+
+    attr_reader :backend
+
+    class << self
+      # Define a block used to build this adapter's backend.  The block will
+      # receive as keyword arguments any options passed to the adapter during
+      # initialization that are not config settings.
+      #
+      # If the adapter is initialized with a `:backend` option, this will be used
+      # instead, and the block won't be called.
+      #
+      # @param [Boolean] required
+      # @yield [**options] options passed to the adapter's initialize method
+      # @yieldreturn [Object] The backend to use
+      def backend(required: true, &block)
+        raise "backend block already set" if class_variables(false).include?(:@@backend_block)
+        class_variable_set(:@@backend_block, block)
+        class_variable_set(:@@backend_required, true) if required
+      end
+
+      def backend_block
+        class_variable_get(:@@backend_block) if class_variable_defined?(:@@backend_block)
+      end
+
+      def backend_required?
+        class_variable_defined?(:@@backend_required)
+      end
+    end
+
+    # @param [Hash] options
+    def initialize(options = {})
+      set_backend(**configure(**options))
+    end
+
+    private
+
+    def set_backend(backend: nil, **options)
+      @backend = backend ||
+        if backend_block = self.class.backend_block
+          instance_exec(**options, &backend_block)
+        end
+
+      raise ArgumentError, 'backend needs to be set - refer to adapter documentation' if !@backend && self.class.backend_required?
+    end
+  end
+end