moneta 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9aebec0b5bcf8b12d295aff540c30c453e88883e5d5d498f92f3666adcbf4eeb
-  data.tar.gz: f62cbb548556e6d4a36e0465edb468a7421262620469d7329c34cb7d160553bc
+  metadata.gz: 667e187cf3e0d0ce7e721e07036f70e0b65f1b52818fc09eb87311872896ce95
+  data.tar.gz: 7e9063dfa4ea6f1bfbe4bee54821c75e9a82d0f54f3f820c6e396fafeeba006a
 SHA512:
-  metadata.gz: e9544cff0b2b3550776646d83131b8c7db4c3a9e79083ddb56af23a4cffaa9ce5a3de4a8c1db2db3571e768fe00c409692c3a2787ac9e7e8312a3f145d36f270
-  data.tar.gz: 96cf85c80a0dbb86c820351e711470f873139e6544ec450e427a5cba92cf23f615bedd7f2ff5fda7eca8f005631e0dbcb5e79550ef001234b6d231fcaa71c924
+  metadata.gz: 5e2d3880c0d3fed1ee66cb57f5ebba13a83dd7e4447ec1e99e601a85ff9bc454cf7bf4e9d62c8672324faddf9f396e4488c08400a08e1c1dd0181056655142b5
+  data.tar.gz: 4be30ddd9249b7222c2354984815efde88ca3c8cfe65db26c13df1585bd80425cc8f55f68b869d07016183be29b4ae8495a3408fe3b67e0f27d21ef2f6de6a83

data/.rubocop.yml

@@ -6,11 +6,7 @@ AllCops:
     - script/**/*
     - vendor/**/*
 
-Layout/AlignArray:
-  Exclude:
-    - lib/moneta/transformer/config.rb
-
-Layout/AlignHash:
+Layout/ArrayAlignment:
   Exclude:
     - lib/moneta/transformer/config.rb
 
@@ -25,6 +21,13 @@ Layout/ExtraSpacing:
     - lib/moneta.rb
     - lib/moneta/transformer/config.rb
 
+Layout/HashAlignment:
+  Exclude:
+    - lib/moneta/transformer/config.rb
+
+Layout/LineLength:
+  Max: 160
+
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 
@@ -38,12 +41,18 @@ Layout/SpaceInsideArrayLiteralBrackets:
 Lint/AssignmentInCondition:
   Enabled: false
 
+Lint/RaiseException:
+  Enabled: true
+
 Lint/ShadowedException:
   Enabled: false
 
 Lint/ShadowingOuterLocalVariable:
   Enabled: false
 
+Lint/StructNewOverride:
+  Enabled: true
+
 Lint/UnusedMethodArgument:
   Enabled: false
 
@@ -67,12 +76,12 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
-Metrics/LineLength:
-  Max: 160
-
 Metrics/MethodLength:
   Enabled: false
 
+Metrics/ModuleLength:
+  Enabled: false
+
 Metrics/ParameterLists:
   Enabled: false
 
@@ -117,6 +126,15 @@ Style/FormatString:
 Style/GuardClause:
   Enabled: false
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Style/IfUnlessModifier:
   Enabled: false
 

data/CHANGES

@@ -1,3 +1,9 @@
+1.4.0
+
+* Adapters::Mongo - drop support for moped gem (#182)
+* Adapters::Redis - use #exists? where available (#189)
+* Some reorganisation of code into more separate files (#177)
+
 1.3.0
 
 * Transformer - add :each_key support (#170)

data/CONTRIBUTORS

@@ -5,8 +5,8 @@ Alessio Signorini <alessio@signorini.us>
 Anthony Eden <anthonyeden@gmail.com>
 Atoxhybrid <atoxhybrid@gmail.com>
 AtoxIO <atoxhybrid@gmail.com>
-Benjamin Yu <benjaminlyu@gmail.com>
 Ben Schwarz <ben.schwarz@gmail.com>
+Benjamin Yu <benjaminlyu@gmail.com>
 Daniel Mendler <mail@daniel-mendler.de>
 Denis Defreyne <denis.defreyne@stoneship.org>
 Derek Kastner <dkastner@gmail.com>
@@ -18,6 +18,7 @@ Jari Bakken <jari.bakken@gmail.com>
 Jay Mitchell <jaybmitchell@gmail.com>
 Jeremy Voorhis <jvoorhis@gmail.com>
 Jon Crosby <jon@joncrosby.me>
+Jonathan Gnagy <jonathan.l.gnagy@sherwin.com>
 lakshan <lakshan@web2media.net>
 Mal McKay <mal.mckay@gmail.com>
 Marek Skrobacki <skrobul@skrobul.com>

data/Gemfile

@@ -14,7 +14,7 @@ gem 'bert', platforms: :ruby, group: :bert
 gem 'php-serialize', group: :php
 
 group :bson do
-  gem 'bson', '>= 2.0.0'
+  gem 'bson', '>= 4.0.0'
 end
 
 group :msgpack do
@@ -38,7 +38,6 @@ gem 'daybreak', group: :daybreak
 gem 'activerecord', '~> 5.2', group: :activerecord
 gem 'redis', '~> 4.0.0', group: :redis
 gem 'mongo', '>= 2', group: :mongo_official
-gem 'moped', '>= 2', group: :mongo_moped
 gem 'sequel', group: :sequel
 gem 'dalli', group: :memcached_dalli
 gem 'riak-client', group: :riak
@@ -94,9 +93,7 @@ end
 
 # Rails integration testing
 group :rails do
-  git 'https://github.com/rails/rails.git', branch: '5-2-stable' do
-    gem 'actionpack'
-  end
+  gem 'actionpack', '~> 5.2.0'
   gem 'minitest', '~> 5.0'
 end
 
@@ -105,3 +102,8 @@ group :doc, optional: true do
   gem 'kramdown', '~> 1.17.0'
   gem 'yard', '~> 0.9.20'
 end
+
+# Used for running a dev console
+group :console, optional: true do
+  gem 'irb'
+end

data/README.md

@@ -120,7 +120,7 @@ Out of the box, it supports the following backends. Use the backend name symbol
     * [Simple Samba database TDB](http://tdb.samba.org/) (`:TDB`)
 * Document databases:
     * [CouchDB](http://couchdb.apache.org/) (`:Couch`)
-    * [MongoDB](http://www.mongodb.org/) (`:Mongo`, `:MongoOffical` or `:MongoMoped`)
+    * [MongoDB](http://www.mongodb.org/) (`:Mongo`)
 * Moneta network protocols:
     * Moneta key/value client (`:Client` works with `Moneta::Server`)
     * Moneta HTTP/REST client (`:RestClient` works with `Rack::MonetaRest`)
@@ -142,11 +142,7 @@ __NOTE:__ <a name="backend-matrix"></a>The backend matrix is much more readable
 
 <tr><th colspan="2">Persistent stores</th><th colspan="12"></th></tr>
 
-<tr><td>Mongo</td><td>mongo or moped</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td><a href="http://www.mongodb.org/">MongoDB</a> database</td></tr>
-
-<tr><td>MongoOfficial</td><td>mongo</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td><a href="http://www.mongodb.org/">MongoDB</a> database</td></tr>
-
-<tr><td>MongoMoped</td><td>moped</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td><a href="http://www.mongodb.org/">MongoDB</a> database</td></tr>
+<tr><td>Mongo</td><td>mongo</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td><a href="http://www.mongodb.org/">MongoDB</a> database</td></tr>
 
 <tr><td>Redis</td><td>redis</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td style="text-align:center;background:#5F5">✓</td><td><a href="http://redis.io/">Redis</a> database</td></tr>
 

data/feature_matrix.yaml

@@ -8,20 +8,10 @@ notes:
     server if you want multiprocess concurrency!
 backends:
   - adapter: Mongo
-    platforms: [ MRI, JRuby ]
-    gems: mongo or moped
-    features: [ threadsafe, multiprocess, increment, create, expires, each_key, bulk_read, bulk_write ]
-    description: "[MongoDB](http://www.mongodb.org/) database"
-  - adapter: MongoOfficial
     platforms: [ MRI, JRuby ]
     gems: mongo
     features: [ threadsafe, multiprocess, increment, create, expires, each_key, bulk_read, bulk_write ]
     description: "[MongoDB](http://www.mongodb.org/) database"
-  - adapter: MongoMoped
-    platforms: [ MRI, JRuby ]
-    gems: moped
-    features: [ threadsafe, multiprocess, increment, create, expires, each_key, bulk_read, bulk_write ]
-    description: "[MongoDB](http://www.mongodb.org/) database"
   - adapter: Redis
     platforms: [ MRI, JRuby ]
     gems: redis

data/lib/moneta.rb

@@ -5,20 +5,22 @@
 module Moneta
   autoload :Builder,           'moneta/builder'
   autoload :Cache,             'moneta/cache'
-  autoload :CreateSupport,     'moneta/mixins'
-  autoload :Defaults,          'moneta/mixins'
-  autoload :EachKeySupport,    'moneta/mixins'
+  autoload :CreateSupport,     'moneta/create_support'
+  autoload :DBMAdapter,        'moneta/dbm_adapter'
+  autoload :Defaults,          'moneta/defaults'
+  autoload :EachKeySupport,    'moneta/each_key_support'
   autoload :Enumerable,        'moneta/enumerable'
-  autoload :ExpiresSupport,    'moneta/mixins'
+  autoload :ExpiresSupport,    'moneta/expires_support'
   autoload :Expires,           'moneta/expires'
   autoload :Fallback,          'moneta/fallback'
-  autoload :HashAdapter,       'moneta/mixins'
-  autoload :IncrementSupport,  'moneta/mixins'
+  autoload :HashAdapter,       'moneta/hash_adapter'
+  autoload :IncrementSupport,  'moneta/increment_support'
   autoload :Lock,              'moneta/lock'
   autoload :Logger,            'moneta/logger'
   autoload :Mutex,             'moneta/synchronize'
+  autoload :NilValues,         'moneta/nil_values'
   autoload :OptionMerger,      'moneta/optionmerger'
-  autoload :OptionSupport,     'moneta/mixins'
+  autoload :OptionSupport,     'moneta/option_support'
   autoload :Pool,              'moneta/pool'
   autoload :Proxy,             'moneta/proxy'
   autoload :Semaphore,         'moneta/synchronize'
@@ -58,8 +60,6 @@ module Moneta
     autoload :MemcachedNative, 'moneta/adapters/memcached/native'
     autoload :Memory,          'moneta/adapters/memory'
     autoload :Mongo,           'moneta/adapters/mongo'
-    autoload :MongoMoped,      'moneta/adapters/mongo/moped'
-    autoload :MongoOfficial,   'moneta/adapters/mongo/official'
     autoload :Null,            'moneta/adapters/null'
     autoload :PStore,          'moneta/adapters/pstore'
     autoload :Redis,           'moneta/adapters/redis'

data/lib/moneta/adapters/mongo.rb

@@ -1,12 +1,261 @@
+require 'mongo'
+
 module Moneta
-  # @api private
   module Adapters
-    begin
-      require 'moneta/adapters/mongo/official'
-      Mongo = MongoOfficial
-    rescue LoadError
-      require 'moneta/adapters/mongo/moped'
-      Mongo = MongoMoped
+    # MongoDB backend
+    #
+    # Supports expiration, documents will be automatically removed starting
+    # with mongodb >= 2.2 (see {http://docs.mongodb.org/manual/tutorial/expire-data/}).
+    #
+    # You can store hashes directly using this adapter.
+    #
+    # @example Store hashes
+    #     db = Moneta::Adapters::MongoOfficial.new
+    #     db['key'] = {a: 1, b: 2}
+    #
+    # @api public
+    class Mongo
+      include Defaults
+      include ExpiresSupport
+
+      supports :each_key, :create, :increment
+      attr_reader :backend
+
+      DEFAULT_PORT = 27017
+
+      # @param [Hash] options
+      # @option options [String] :collection ('moneta') MongoDB collection name
+      # @option options [String] :host ('127.0.0.1') MongoDB server host
+      # @option options [String] :user Username used to authenticate
+      # @option options [String] :password Password used to authenticate
+      # @option options [Integer] :port (MongoDB default port) MongoDB server port
+      # @option options [String] :db ('moneta') MongoDB database
+      # @option options [Integer] :expires Default expiration time
+      # @option options [String] :expires_field ('expiresAt') Document field to store expiration time
+      # @option options [String] :value_field ('value') Document field to store value
+      # @option options [String] :type_field ('type') Document field to store value type
+      # @option options [::Mongo::Client] :backend Use existing backend instance
+      # @option options Other options passed to `Mongo::MongoClient#new`
+      def initialize(options = {})
+        self.default_expires = options.delete(:expires)
+        @expires_field = options.delete(:expires_field) || 'expiresAt'
+        @value_field = options.delete(:value_field) || 'value'
+        @type_field = options.delete(:type_field) || 'type'
+
+        collection = options.delete(:collection) || 'moneta'
+        db = options.delete(:db) || 'moneta'
+        @backend = options[:backend] ||
+          begin
+            host = options.delete(:host) || '127.0.0.1'
+            port = options.delete(:port) || DEFAULT_PORT
+            options[:logger] ||= ::Logger.new(STDERR).tap do |logger|
+              logger.level = ::Logger::ERROR
+            end
+            ::Mongo::Client.new(["#{host}:#{port}"], options)
+          end
+        @backend.use(db)
+        @collection = @backend[collection]
+        if @backend.command(buildinfo: 1).documents.first['version'] >= '2.2'
+          @collection.indexes.create_one({ @expires_field => 1 }, expire_after: 0)
+        else
+          warn 'Moneta::Adapters::Mongo - You are using MongoDB version < 2.2, expired documents will not be deleted'
+        end
+      end
+
+      # (see Proxy#load)
+      def load(key, options = {})
+        view = @collection.find(:$and => [
+                                  { _id: to_binary(key) },
+                                  not_expired
+                                ])
+
+        doc = view.limit(1).first
+
+        if doc
+          update_expiry(options, nil) do |expires|
+            view.update_one(:$set => { @expires_field => expires })
+          end
+
+          doc_to_value(doc)
+        end
+      end
+
+      # (see Proxy#store)
+      def store(key, value, options = {})
+        key = to_binary(key)
+        @collection.replace_one({ _id: key },
+                                value_to_doc(key, value, options),
+                                upsert: true)
+        value
+      end
+
+      # (see Proxy#each_key)
+      def each_key
+        return enum_for(:each_key) unless block_given?
+        @collection.find.each { |doc| yield from_binary(doc[:_id]) }
+        self
+      end
+
+      # (see Proxy#delete)
+      def delete(key, options = {})
+        key = to_binary(key)
+        if doc = @collection.find(_id: key).find_one_and_delete and
+            !doc[@expires_field] || doc[@expires_field] >= Time.now
+          doc_to_value(doc)
+        end
+      end
+
+      # (see Proxy#increment)
+      def increment(key, amount = 1, options = {})
+        @collection.find_one_and_update({ :$and => [{ _id: to_binary(key) }, not_expired] },
+                                        { :$inc => { @value_field => amount } },
+                                        return_document: :after,
+                                        upsert: true)[@value_field]
+      end
+
+      # (see Proxy#create)
+      def create(key, value, options = {})
+        key = to_binary(key)
+        @collection.insert_one(value_to_doc(key, value, options))
+        true
+      rescue ::Mongo::Error::OperationFailure => ex
+        raise unless ex.message =~ /^E11000 / # duplicate key error
+        false
+      end
+
+      # (see Proxy#clear)
+      def clear(options = {})
+        @collection.delete_many
+        self
+      end
+
+      # (see Proxy#close)
+      def close
+        @backend.close
+        nil
+      end
+
+      # (see Proxy#slice)
+      def slice(*keys, **options)
+        view = @collection.find(:$and => [
+                                  { _id: { :$in => keys.map(&method(:to_binary)) } },
+                                  not_expired
+                                ])
+        pairs = view.map { |doc| [from_binary(doc[:_id]), doc_to_value(doc)] }
+
+        update_expiry(options, nil) do |expires|
+          view.update_many(:$set => { @expires_field => expires })
+        end
+
+        pairs
+      end
+
+      # (see Proxy#merge!)
+      def merge!(pairs, options = {})
+        existing = Hash[slice(*pairs.map { |key, _| key })]
+        update_pairs, insert_pairs = pairs.partition { |key, _| existing.key?(key) }
+
+        @collection.insert_many(insert_pairs.map do |key, value|
+          value_to_doc(to_binary(key), value, options)
+        end)
+
+        update_pairs.each do |key, value|
+          value = yield(key, existing[key], value) if block_given?
+          binary = to_binary(key)
+          @collection.replace_one({ _id: binary }, value_to_doc(binary, value, options))
+        end
+
+        self
+      end
+
+      # (see Proxy#fetch_values)
+      def fetch_values(*keys, **options)
+        return values_at(*keys, **options) unless block_given?
+        hash = Hash[slice(*keys, **options)]
+        keys.map do |key|
+          if hash.key?(key)
+            hash[key]
+          else
+            yield key
+          end
+        end
+      end
+
+      # (see Proxy#values_at)
+      def values_at(*keys, **options)
+        hash = Hash[slice(*keys, **options)]
+        keys.map { |key| hash[key] }
+      end
+
+      private
+
+      def doc_to_value(doc)
+        case doc[@type_field]
+        when 'Hash'
+          doc = doc.dup
+          doc.delete('_id')
+          doc.delete(@type_field)
+          doc.delete(@expires_field)
+          doc
+        when 'Number'
+          doc[@value_field]
+        else
+          # In ruby_bson version 2 (and probably up), #to_s no longer returns the binary data
+          from_binary(doc[@value_field])
+        end
+      end
+
+      def value_to_doc(key, value, options)
+        case value
+        when Hash
+          value.merge('_id' => key,
+                      @type_field => 'Hash',
+                      # @expires_field must be a Time object (BSON date datatype)
+                      @expires_field => expires_at(options) || nil)
+        when Float, Integer
+          { '_id' => key,
+            @type_field => 'Number',
+            @value_field => value,
+            # @expires_field must be a Time object (BSON date datatype)
+            @expires_field => expires_at(options) || nil }
+        when String
+          intvalue = value.to_i
+          { '_id' => key,
+            @type_field => 'String',
+            @value_field => intvalue.to_s == value ? intvalue : to_binary(value),
+            # @expires_field must be a Time object (BSON date datatype)
+            @expires_field => expires_at(options) || nil }
+        else
+          raise ArgumentError, "Invalid value type: #{value.class}"
+        end
+      end
+
+      # BSON will use String#force_encoding to make the string 8-bit
+      # ASCII.  This could break unicode text so we should dup in this
+      # case, and it also fails with frozen strings.
+      def to_binary(str)
+        str = str.dup if str.frozen? || str.encoding != Encoding::ASCII_8BIT
+        ::BSON::Binary.new(str)
+      end
+
+      def from_binary(binary)
+        binary.is_a?(::BSON::Binary) ? binary.data : binary.to_s
+      end
+
+      def not_expired
+        {
+          :$or => [
+            { @expires_field => nil },
+            { @expires_field => { :$gte => Time.now } }
+          ]
+        }
+      end
+
+      def update_expiry(options, default)
+        if (expires = expires_at(options, default)) != nil
+          yield(expires || nil)
+        end
+      end
     end
   end
 end