flipper-mongo 0.1.1 → 0.2.0

data/flipper-mongo.gemspec

@@ -14,5 +14,5 @@ Gem::Specification.new do |gem|
   gem.name          = "flipper-mongo"
   gem.require_paths = ["lib"]
   gem.version       = Flipper::Adapters::Mongo::VERSION
-  gem.add_dependency 'flipper', '~> 0.1.1'
+  gem.add_dependency 'flipper', '~> 0.2'
 end

data/lib/flipper/adapters/mongo.rb

@@ -1,64 +1,55 @@
 require 'set'
+require 'forwardable'
 require 'mongo'
 
 module Flipper
   module Adapters
     class Mongo
-      DefaultId = 'flipper'
+      extend Forwardable
 
-      def initialize(collection, options = {})
+      def initialize(collection)
         @collection = collection
-        @options = options
-        @mongo_criteria = {:_id => id}
-        @mongo_options = {:upsert => true, :safe => true}
+        @update_options = {:safe => true, :upsert => true}
       end
 
       def read(key)
-        read_key(key)
+        find_one key
       end
 
       def write(key, value)
-        update '$set' => {key => value}
+        update key, {'$set' => {'v' => value}}
       end
 
       def delete(key)
-        update '$unset' => {key => 1}
+        @collection.remove criteria(key)
       end
 
-      def set_add(key, value)
-        update '$addToSet' => {key => value}
+      def set_members(key)
+        (find_one(key) || Set.new).to_set
       end
 
-      def set_delete(key, value)
-        update '$pull' => {key => value}
+      def set_add(key, value)
+        update key, {'$addToSet' => {'v' => value}}
       end
 
-      def set_members(key)
-        read_key(key) { Set.new }.to_set
+      def set_delete(key, value)
+        update key, {'$pull' => {'v' => value}}
       end
 
       private
 
-      def id
-        @id ||= @options.fetch(:id) { DefaultId }
-      end
-
-      def update(updates)
-        @collection.update(@mongo_criteria, updates, @mongo_options)
+      def find_one(key)
+        if (doc = @collection.find_one(criteria(key)))
+          doc['v']
+        end
       end
 
-      def read_key(key, &block)
-        load
-
-        if block_given?
-          @document.fetch(key, &block)
-        else
-          @document[key]
-        end
+      def update(key, updates)
+        @collection.update criteria(key), updates, @update_options
       end
 
-      def load
-        @document = @collection.find_one(@mongo_criteria) || {}
+      def criteria(key)
+        {:_id => key}
       end
     end
   end

data/lib/flipper/adapters/mongo/document.rb

@@ -0,0 +1,77 @@
+require 'set'
+require 'mongo'
+
+module Flipper
+  module Adapters
+    class MongoSingleDocument
+      class Document
+        DefaultId = 'flipper'
+
+        def initialize(collection, options = {})
+          @collection = collection
+          @options = options
+          @id = @options.fetch(:id) { DefaultId }
+          @source = @options.fetch(:source) { {} }
+          @criteria = {:_id => @id}
+          @mongo_options = {:safe => true, :upsert => true}
+        end
+
+        def read(key)
+          source[key]
+        end
+
+        def write(key, value)
+          @collection.update @criteria, {'$set' => {key => value}}, @mongo_options
+          @source[key] = value
+        end
+
+        def delete(key)
+          @collection.update @criteria, {'$unset' => {key => 1}}, @mongo_options
+          @source.delete key
+        end
+
+        def set_members(key)
+          members = source.fetch(key) { @source[key] = Set.new }
+
+          if members.is_a?(Array)
+            @source[key] = members.to_set
+          else
+            members
+          end
+        end
+
+        def set_add(key, value)
+          @collection.update @criteria, {'$addToSet' => {key => value}}, @mongo_options
+          set_members(key).add(value)
+        end
+
+        def set_delete(key, value)
+          @collection.update @criteria, {'$pull' => {key => value}}, @mongo_options
+          set_members(key).delete(value)
+        end
+
+        def clear
+          @loaded = nil
+          @source.clear
+        end
+
+        def loaded?
+          @loaded == true
+        end
+
+        private
+
+        def source
+          load unless loaded?
+          @source
+        end
+
+        def load
+          @loaded = true
+          @source.clear
+          @source.update @collection.find_one(@criteria) || {}
+        end
+      end
+    end
+  end
+end

data/lib/flipper/adapters/mongo/version.rb

@@ -1,7 +1,7 @@
 module Flipper
   module Adapters
     class Mongo
-      VERSION = "0.1.1"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/flipper/adapters/mongo_single_document.rb

@@ -0,0 +1,25 @@
+require 'set'
+require 'forwardable'
+require 'mongo'
+require 'flipper/adapters/mongo/document'
+
+module Flipper
+  module Adapters
+    class MongoSingleDocument
+      extend Forwardable
+
+      def initialize(collection, options = {})
+        @collection = collection
+        @options = options
+      end
+
+      def_delegators :document, :read, :write, :delete, :set_members, :set_add, :set_delete
+
+      private
+
+      def document
+        Document.new(@collection, :id => @options[:id])
+      end
+    end
+  end
+end

data/spec/flipper/adapters/mongo/document_spec.rb

@@ -0,0 +1,275 @@
+require 'helper'
+require 'flipper/adapters/mongo/document'
+
+describe Flipper::Adapters::MongoSingleDocument::Document do
+  subject          { described_class.new(collection, :id => id, :source => source) }
+  let(:collection) { Mongo::Connection.new.db('testing')['testing'] }
+  let(:id)         { described_class::DefaultId }
+  let(:source)     { {} }
+  let(:criteria)   { {:_id => id} }
+  let(:options)    { {:safe => true, :upsert => true} }
+
+  def document
+    collection.find_one(criteria)
+  end
+
+  before do
+    collection.remove(criteria)
+  end
+
+  it "defaults id to flipper" do
+    described_class.new(collection).instance_variable_get("@id").should eq('flipper')
+  end
+
+  describe "loading document" do
+    before do
+      collection.update(criteria, {'$set' => {'foo' => 'bar', 'people' => [1, 2, 3]}}, options)
+    end
+
+    it "only happens once" do
+      collection.should_receive(:find_one).with(criteria).once.and_return({})
+      subject.read('foo')
+      subject.set_members('people')
+    end
+
+    it "happens again if document is cleared" do
+      collection.should_receive(:find_one).with(criteria)
+      subject.read('foo')
+      subject.set_members('people')
+
+      subject.clear
+
+      collection.should_receive(:find_one).with(criteria)
+      subject.read('foo')
+      subject.set_members('people')
+    end
+  end
+
+  describe "#read" do
+    context "existing key" do
+      before do
+        source['baz'] = 'wick'
+        collection.update(criteria, {'$set' => {'foo' => 'bar'}}, options)
+        @result = subject.read('foo')
+      end
+
+      it "returns value" do
+        @result.should eq('bar')
+      end
+
+      it "clears and loads source hash" do
+        source.should eq({
+          '_id' => id,
+          'foo' => 'bar',
+        })
+      end
+    end
+
+    context "missing key" do
+      before do
+        collection.update(criteria, {'$set' => {'foo' => 'bar'}}, options)
+        @result = subject.read('apple')
+      end
+
+      it "returns nil" do
+        @result.should be_nil
+      end
+    end
+
+    context "missing document" do
+      before do
+        @result = subject.read('foo')
+      end
+
+      it "returns nil" do
+        @result.should be_nil
+      end
+    end
+  end
+
+  describe "#write" do
+    context "existing key" do
+      before do
+        collection.update(criteria, {'$set' => {'foo' => 'bar'}}, options)
+        subject.write('foo', 'new value')
+      end
+
+      it "sets key" do
+        document.fetch('foo').should eq('new value')
+        source.fetch('foo').should eq('new value')
+      end
+    end
+
+    context "missing key" do
+      before do
+        collection.update(criteria, {'$set' => {'foo' => 'bar'}}, options)
+        subject.write('apple', 'orange')
+      end
+
+      it "sets key" do
+        document.fetch('apple').should eq('orange')
+        source.fetch('apple').should eq('orange')
+      end
+    end
+
+    context "missing document" do
+      before do
+        subject.write('foo', 'bar')
+      end
+
+      it "creates document" do
+        document.should_not be_nil
+      end
+
+      it "sets key" do
+        document.fetch('foo').should eq('bar')
+        source.fetch('foo').should eq('bar')
+      end
+    end
+  end
+
+  describe "#delete" do
+    before do
+      collection.update(criteria, {'$set' => {'foo' => 'bar', 'apple' => 'orange'}}, options)
+      @result = subject.delete('foo')
+    end
+
+    it "removes the key" do
+      document.key?('foo').should be_false
+      source.key?('foo').should be_false
+    end
+
+    it "does not remove other keys" do
+      document.fetch('apple').should eq('orange')
+    end
+  end
+
+  describe "#set_members" do
+    context "existing key" do
+      before do
+        collection.update(criteria, {'$set' => {'people' => [1, 2, 3], 'foo' => 'bar'}}, options)
+        @result = subject.set_members('people')
+      end
+
+      it "returns set" do
+        @result.should eq(Set[1, 2, 3])
+      end
+
+      it "loads source hash" do
+        source.should eq({
+          '_id'    => id,
+          'people' => Set[1, 2, 3],
+          'foo'    => 'bar',
+        })
+      end
+    end
+
+    context "missing key" do
+      before do
+        collection.update(criteria, {'$set' => {'people' => [1, 2, 3]}}, options)
+        @result = subject.set_members('users')
+      end
+
+      it "returns empty set" do
+        @result.should eq(Set.new)
+      end
+    end
+
+    context "missing document" do
+      it "returns empty set" do
+        subject.set_members('people').should eq(Set.new)
+      end
+    end
+  end
+
+  describe "#set_add" do
+    context "existing key" do
+      before do
+        collection.update(criteria, {'$set' => {'people' => [1, 2, 3]}}, options)
+        subject.set_add('people', 4)
+      end
+
+      it "adds value to set" do
+        document.fetch('people').should eq([1, 2, 3, 4])
+        source.fetch('people').should eq(Set[1, 2, 3, 4])
+      end
+    end
+
+    context "missing key" do
+      before do
+        collection.update(criteria, {'$set' => {'people' => [1, 2, 3]}}, options)
+        subject.set_add('users', 1)
+      end
+
+      it "adds value to set" do
+        document.fetch('users').should eq([1])
+        source.fetch('users').should eq(Set[1])
+      end
+    end
+
+    context "missing document" do
+      before do
+        subject.set_add('people', 1)
+      end
+
+      it "creates document" do
+        document.should_not be_nil
+      end
+
+      it "adds value to set" do
+        document.fetch('people').should eq([1])
+        source.fetch('people').should eq(Set[1])
+      end
+    end
+  end
+
+  describe "#set_delete" do
+    context "existing key" do
+      before do
+        collection.update(criteria, {'$set' => {'people' => [1, 2, 3]}}, options)
+        subject.set_delete 'people', 3
+      end
+
+      it "removes value to key" do
+        document.fetch('people').should eq([1, 2])
+        source.fetch('people').should eq(Set[1, 2])
+      end
+    end
+
+    context "missing key" do
+      before do
+        collection.update(criteria, {'$set' => {'people' => [1, 2, 3]}}, options)
+      end
+
+      it "does not error" do
+        expect { subject.set_delete 'foo', 1 }.to_not raise_error
+      end
+    end
+
+    context "missing document" do
+      it "does not error" do
+        expect { subject.set_delete 'foo', 1 }.to_not raise_error
+      end
+    end
+  end
+
+  describe "#clear" do
+    before do
+      collection.update(criteria, {'$set' => {'foo' => 'bar'}}, options)
+      subject.read('foo') # load the source hash
+      subject.clear
+    end
+
+    it "clears the source hash" do
+      source.should be_empty
+    end
+
+    it "does not remove the document" do
+      document.should_not be_empty
+    end
+
+    it "marks the document as not loaded" do
+      subject.loaded?.should be_false
+    end
+  end
+end

data/spec/flipper/adapters/mongo_single_document_spec.rb

@@ -0,0 +1,39 @@
+require 'helper'
+require 'flipper/adapters/mongo_single_document'
+require 'flipper/spec/shared_adapter_specs'
+
+describe Flipper::Adapters::MongoSingleDocument do
+  let(:collection) { Mongo::Connection.new.db('testing')['testing'] }
+  let(:criteria)   { {:_id => id} }
+  let(:id)         { 'flipper' }
+
+  subject { described_class.new(collection, :id => id) }
+
+  before do
+    collection.remove(criteria)
+  end
+
+  def read_key(key)
+    if (doc = collection.find_one(criteria))
+      value = doc[key]
+
+      if value.is_a?(::Array)
+        value = value.to_set
+      end
+
+      value
+    end
+  end
+
+  def write_key(key, value)
+    if value.is_a?(::Set)
+      value = value.to_a
+    end
+
+    options = {:upsert => true}
+    updates = {'$set' => {key => value}}
+    collection.update criteria, updates, options
+  end
+
+  it_should_behave_like 'a flipper adapter'
+end

data/spec/flipper/adapters/mongo_spec.rb

@@ -4,18 +4,17 @@ require 'flipper/spec/shared_adapter_specs'
 
 describe Flipper::Adapters::Mongo do
   let(:collection) { Mongo::Connection.new.db('testing')['testing'] }
-  let(:criteria)   { {:_id => id} }
-  let(:id)         { described_class::DefaultId }
+  let(:id)         { 'flipper' }
 
-  subject { Flipper::Adapters::Mongo.new(collection) }
+  subject { described_class.new(collection) }
 
   before do
-    collection.remove(criteria)
+    collection.remove
   end
 
   def read_key(key)
-    if (doc = collection.find_one(criteria))
-      value = doc[key]
+    if (doc = collection.find_one(:_id => key))
+      value = doc['v']
 
       if value.is_a?(::Array)
         value = value.to_set
@@ -30,8 +29,9 @@ describe Flipper::Adapters::Mongo do
       value = value.to_a
     end
 
-    options = {:upsert => true}
-    updates = {'$set' => {key => value}}
+    criteria = {:_id => key}
+    updates  = {'$set' => {'v' => value}}
+    options  = {:upsert => true}
     collection.update criteria, updates, options
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flipper-mongo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-03 00:00:00.000000000 Z
+date: 2012-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
-  requirement: &70164043485300 !ruby/object:Gem::Requirement
+  requirement: &70285634449460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70164043485300
+  version_requirements: *70285634449460
 description: Mongo adapter for Flipper
 email:
 - nunemaker@gmail.com
@@ -38,10 +38,12 @@ files:
 - flipper-mongo.gemspec
 - lib/flipper-mongo.rb
 - lib/flipper/adapters/mongo.rb
+- lib/flipper/adapters/mongo/document.rb
 - lib/flipper/adapters/mongo/version.rb
-- lib/flipper/adapters/mongo_with_ttl.rb
+- lib/flipper/adapters/mongo_single_document.rb
+- spec/flipper/adapters/mongo/document_spec.rb
+- spec/flipper/adapters/mongo_single_document_spec.rb
 - spec/flipper/adapters/mongo_spec.rb
-- spec/flipper/adapters/mongo_with_ttl_spec.rb
 - spec/helper.rb
 - spec/support/accessor_helpers.rb
 homepage: http://jnunemaker.github.com/flipper-mongo
@@ -58,7 +60,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3074058746914182371
+      hash: -10539439190267456
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -67,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3074058746914182371
+      hash: -10539439190267456
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -75,7 +77,8 @@ signing_key:
 specification_version: 3
 summary: Mongo adapter for Flipper
 test_files:
+- spec/flipper/adapters/mongo/document_spec.rb
+- spec/flipper/adapters/mongo_single_document_spec.rb
 - spec/flipper/adapters/mongo_spec.rb
-- spec/flipper/adapters/mongo_with_ttl_spec.rb
 - spec/helper.rb
 - spec/support/accessor_helpers.rb

data/lib/flipper/adapters/mongo_with_ttl.rb

@@ -1,36 +0,0 @@
-require 'set'
-require 'mongo'
-require 'flipper/adapters/mongo'
-
-module Flipper
-  module Adapters
-    class MongoWithTTL < Mongo
-      private
-
-      # Override Mongo adapter's load
-      def load
-        if expired?
-          @document = fresh_load
-        end
-      end
-
-      def fresh_load
-        @last_load_at = Time.now.to_i
-        @collection.find_one(@mongo_criteria) || {}
-      end
-
-      def ttl
-        @options.fetch(:ttl) { 0 }
-      end
-
-      def expired?
-        return true if never_loaded?
-        Time.now.to_i >= (@last_load_at + ttl)
-      end
-
-      def never_loaded?
-        @last_load_at.nil?
-      end
-    end
-  end
-end

data/spec/flipper/adapters/mongo_with_ttl_spec.rb

@@ -1,44 +0,0 @@
-require 'helper'
-require 'flipper/adapters/mongo_with_ttl'
-require 'flipper/spec/shared_adapter_specs'
-
-describe Flipper::Adapters::MongoWithTTL do
-  let(:collection) { Mongo::Connection.new.db('testing')['testing'] }
-  let(:criteria)   { {:_id => id} }
-  let(:id)         { described_class::DefaultId }
-
-  subject { Flipper::Adapters::MongoWithTTL.new(collection) }
-
-  before do
-    collection.remove(criteria)
-  end
-
-  it_should_behave_like 'a flipper adapter'
-
-  it "can cache document in process for a number of seconds" do
-    options = {:ttl => 10}
-    adapter = Flipper::Adapters::MongoWithTTL.new(collection, options)
-    adapter.write('foo', 'bar')
-    now = Time.now
-    Timecop.freeze(now)
-
-    collection.should_receive(:find_one).with(:_id => id)
-    adapter.read('foo')
-
-    adapter.read('foo')
-    adapter.read('bar')
-
-    Timecop.travel(3)
-    adapter.read('foo')
-
-    Timecop.travel(6)
-    adapter.read('foo')
-
-    collection.should_receive(:find_one).with(:_id => id)
-    Timecop.travel(1)
-    adapter.read('foo')
-
-    Timecop.travel(4)
-    adapter.read('foo')
-  end
-end