flipper-mongo 0.20.2 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2437daf52f4312492d9fedcd89fc801654e9f92b9724a272dee43a395d6d0bd
-  data.tar.gz: 6f781f5a864a17caac88cd714d9ec0488a611958e13aad66418340551f889a1e
+  metadata.gz: 656ce494cea1f36610fece84fe1557426d4843b430d4b845170632a4dd621615
+  data.tar.gz: 487e7251d6f36477ba2eb8696675ae2acbeddf21d1b3185f91887a8b27982164
 SHA512:
-  metadata.gz: 630bcb2a27e50283d9cfe2bb73d29c9baa9f33951be8be339b5dcc3a98abb02e629d106fc4b4cd53dcbdcbcfd99eac975a658683ecabf4e68742f0de28c6a392
-  data.tar.gz: c8dd4bec128d4b24be92d1227272721818b078e9364365a7b461dff8e83b60f98e854294773ccc78207e43217c69ec59afb195ca3ba083f13c8ffadd4dc8771d
+  metadata.gz: ca358dde4ef62bcb98feb576dc64244366aa82e9e5a57d40ebdeb66e707e8fb316480906c74f77766aef8e2e396b42047023d95a34c4995f591abe56bcb4d823
+  data.tar.gz: de6d0e904fbdc71fb00cac63d0474b9da3b2ee8124964020c0f6119ee6895c3ca286f2080af5c0098af20f09fdf374b227dcb5ead87691dfaad19c5bb18b312d

data/docs/mongo/README.md

@@ -18,12 +18,21 @@ Or install it yourself with:
 
 ## Usage
 
+In most cases, all you need to do is require the adapter. You must set the `MONGO_URL` or `FLIPPER_MONGO_URL` environment vairable to specify which Mongo database to connect to.
+
 ```ruby
-require 'flipper/adapters/mongo'
-collection = Mongo::Client.new(["127.0.0.1:27017"], database: 'testing')['flipper']
-adapter = Flipper::Adapters::Mongo.new(collection)
-flipper = Flipper.new(adapter)
-# profit...
+require 'flipper-mongo`
+```
+
+**If you need to customize the adapter**, you can add this to an initializer:
+
+```ruby
+Flipper.configure do |config|
+  config.adapter do
+    collection = Mongo::Client.new(ENV["MONGO_URL"])["flipper"]
+    Flipper::Adapters::Mongo.new(collection)
+  end
+end
 ```
 
 ## Internals

data/examples/mongo/basic.rb

@@ -1,27 +1,20 @@
-require 'pathname'
+require 'bundler/setup'
 require 'logger'
 
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-
+ENV["FLIPPER_MONGO_URL"] ||= "mongodb://127.0.0.1:#{ENV["MONGODB_PORT"] || 27017}"
 require 'flipper/adapters/mongo'
-Mongo::Logger.logger.level = Logger::INFO
-collection = Mongo::Client.new(["127.0.0.1:#{ENV["MONGODB_PORT"] || 27017}"], :database => 'testing')['flipper']
-adapter = Flipper::Adapters::Mongo.new(collection)
-flipper = Flipper.new(adapter)
 
-flipper[:stats].enable
+Flipper[:stats].enable
 
-if flipper[:stats].enabled?
+if Flipper[:stats].enabled?
   puts "Enabled!"
 else
   puts "Disabled!"
 end
 
-flipper[:stats].disable
+Flipper[:stats].disable
 
-if flipper[:stats].enabled?
+if Flipper[:stats].enabled?
   puts "Enabled!"
 else
   puts "Disabled!"

data/examples/mongo/internals.rb

@@ -1,16 +1,9 @@
+require 'bundler/setup'
 require 'pp'
-require 'pathname'
 require 'logger'
 
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-
+ENV["FLIPPER_MONGO_URL"] ||= "mongodb://127.0.0.1:#{ENV["MONGODB_PORT"] || 27017}"
 require 'flipper/adapters/mongo'
-Mongo::Logger.logger.level = Logger::INFO
-collection = Mongo::Client.new(["127.0.0.1:#{ENV["MONGODB_PORT"] || 27017}"], :database => 'testing')['flipper']
-adapter = Flipper::Adapters::Mongo.new(collection)
-flipper = Flipper.new(adapter)
 
 # Register a few groups.
 Flipper.register(:admins) { |thing| thing.admin? }
@@ -19,19 +12,19 @@ Flipper.register(:early_access) { |thing| thing.early_access? }
 # Create a user class that has flipper_id instance method.
 User = Struct.new(:flipper_id)
 
-flipper[:stats].enable
-flipper[:stats].enable_group :admins
-flipper[:stats].enable_group :early_access
-flipper[:stats].enable_actor User.new('25')
-flipper[:stats].enable_actor User.new('90')
-flipper[:stats].enable_actor User.new('180')
-flipper[:stats].enable_percentage_of_time 15
-flipper[:stats].enable_percentage_of_actors 45
+Flipper[:stats].enable
+Flipper[:stats].enable_group :admins
+Flipper[:stats].enable_group :early_access
+Flipper[:stats].enable_actor User.new('25')
+Flipper[:stats].enable_actor User.new('90')
+Flipper[:stats].enable_actor User.new('180')
+Flipper[:stats].enable_percentage_of_time 15
+Flipper[:stats].enable_percentage_of_actors 45
 
-flipper[:search].enable
+Flipper[:search].enable
 
 puts 'all docs in collection'
-pp collection.find.to_a
+pp Flipper.adapter.adapter.collection.find.to_a
 # all docs in collection
 # [{"_id"=>"stats",
 #   "actors"=>["25", "90", "180"],
@@ -44,7 +37,7 @@ pp collection.find.to_a
 puts
 
 puts 'flipper get of feature'
-pp adapter.get(flipper[:stats])
+pp Flipper.adapter.get(Flipper[:stats])
 # flipper get of feature
 # {:boolean=>"true",
 #  :groups=>#<Set: {"admins", "early_access"}>,

data/lib/flipper/adapters/mongo.rb

@@ -13,6 +13,9 @@ module Flipper
       # Public: The name of the adapter.
       attr_reader :name
 
+      # Public: The name of the collection storing the feature data.
+      attr_reader :collection
+
       def initialize(collection)
         @collection = collection
         @name = :mongo
@@ -173,3 +176,16 @@ module Flipper
     end
   end
 end
+
+Flipper.configure do |config|
+  config.adapter do
+    url = ENV["FLIPPER_MONGO_URL"] || ENV["MONGO_URL"]
+    collection = ENV["FLIPPER_MONGO_COLLECTION"] || "flipper"
+
+    unless url
+      raise ArgumentError, "The MONGO_URL environment variable must be set. For example: mongodb://127.0.0.1:27017/flipper"
+    end
+
+    Flipper::Adapters::Mongo.new(Mongo::Client.new(url)[collection])
+  end
+end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.2'.freeze
+  VERSION = '0.21.0'.freeze
 end

data/spec/flipper/adapters/mongo_spec.rb

@@ -11,17 +11,30 @@ RSpec.describe Flipper::Adapters::Mongo do
   let(:port) { ENV['MONGODB_PORT'] || 27017 }
 
   let(:client) do
-    Mongo::Client.new(["#{host}:#{port}"], server_selection_timeout: 1, database: 'testing')
+    logger = Logger.new('/dev/null')
+    Mongo::Client.new(["#{host}:#{port}"], server_selection_timeout: 0.01, database: 'testing', logger: logger)
   end
   let(:collection) { client['testing'] }
 
   before do
     begin
       collection.drop
+    rescue Mongo::Error::NoServerAvailable
+      ENV['CI'] ? raise : skip('Mongo not available')
     rescue Mongo::Error::OperationFailure
     end
     collection.create
   end
 
   it_should_behave_like 'a flipper adapter'
+
+  it 'configures itself on load' do
+    Flipper.configuration = nil
+    Flipper.instance = nil
+
+    load 'flipper/adapters/mongo.rb'
+
+    ENV["MONGO_URL"] ||= "mongodb://127.0.0.1:27017/testing"
+    expect(Flipper.adapter.adapter).to be_a(Flipper::Adapters::Mongo)
+  end
 end

data/test/adapters/mongo_test.rb

@@ -9,13 +9,15 @@ class MongoTest < MiniTest::Test
     port = '27017'
     logger = Logger.new('/dev/null')
     client = Mongo::Client.new(["#{host}:#{port}"],
-                               server_selection_timeout: 1,
+                               server_selection_timeout: 0.01,
                                database: 'testing',
                                logger: logger)
     collection = client['testing']
     begin
       collection.drop
       collection.create
+    rescue Mongo::Error::NoServerAvailable
+      ENV['CI'] ? raise : skip('Mongo not available')
     rescue Mongo::Error::OperationFailure
     end
     @adapter = Flipper::Adapters::Mongo.new(collection)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-mongo
 version: !ruby/object:Gem::Version
-  version: 0.20.2
+  version: 0.21.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-08 00:00:00.000000000 Z
+date: 2021-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.2
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.2
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: mongo
   requirement: !ruby/object:Gem::Requirement