flipper-active_record 0.20.0 → 0.21.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de81a55c8c1e6342eb75dfe50aa091e66683ec6f3010fefa25d94ea6a402401b
-  data.tar.gz: 0accb079f0f7e8d21ef94e9d4973f08d7b9b25689ef142e8a162bd87f325a689
+  metadata.gz: 10540b212a4437f26f70a34fb2c172208194cdc610aaf9d7a5cf7f4b8e0f7c49
+  data.tar.gz: 5b7f5cb7baa50a1729f230d4ec8962e162e697f5023b73fd6aecd2eb91485fd6
 SHA512:
-  metadata.gz: 4d9a7f725bfda72154224599235432fd1b6b4b9478a7e13d2cbbf9265c39cb0fb5a7eb0f0f22b21b5baab2382d649f292746dd773bab8545cbe33c3ceebcbc2e
-  data.tar.gz: df60418d9825f5ff40ab94167267fd7c2eb7f785ddbb0777cc6a1c2e3dddadde5c0f2fb40346a2f282c2b36d3b5960df350ba319a08c134f23d1ddfce1c04457
+  metadata.gz: 38b1110e99668682f51f606f7e08ebde6c03336e7912eef0ecf829ccc784584361b6d1298234739e654b68b18ef6c6ecd1c8cc3102e2d4930b8f60deba0a3e2f
+  data.tar.gz: f6ca4e9da379fe7aeb3d3aa58a027f883c30f480ab019a13806f4f378427b742b8ecccf9451f586a46e57b73b3584a4bf7f4d16709af119e17d95c544975c274

data/docs/active_record/README.md

@@ -23,30 +23,28 @@ Or install it yourself with:
 
 ## Usage
 
-For your convenience a migration generator is provided to create the necessary migrations for using the active record adapter. By default this generates a migration that will create two database tables - flipper_features and flipper_gates.
+For your convenience a migration generator is provided to create the necessary migrations for using the active record adapter. By default this generates a migration that will create two database tables - `flipper_features` and `flipper_gates`.
 
     $ rails g flipper:active_record
 
-Once you have created and executed the migration, you can use the active record adapter like so:
+Note that the active record adapter requires the database tables to be created in order to work; failure to run the migration first will cause an exception to be raised when attempting to initialize the active record adapter.
+
+Flipper will be configured to use the ActiveRecord adapter when `flipper-active_record` is loaded. But **if you need to customize the adapter**, you can add this to an initializer:
 
 ```ruby
 require 'flipper/adapters/active_record'
-adapter = Flipper::Adapters::ActiveRecord.new
-flipper = Flipper.new(adapter)
-# profit...
+Flipper.configure do |config|
+  config.default do
+    Flipper.new(Flipper::Adapters::ActiveRecord.new)
+  end
+end
 ```
 
-Note that the active record adapter requires the database tables to be created in order to work; failure to run the migration first will cause an exception to be raised when attempting to initialize the active record adapter.
-
 ## Internals
 
 Each feature is stored as a row in a features table. Each gate is stored as a row in a gates table, related to the feature by the feature's key.
 
 ```ruby
-require 'flipper/adapters/active_record'
-adapter = Flipper::Adapters::ActiveRecord.new
-flipper = Flipper.new(adapter)
-
 # Register a few groups.
 Flipper.register(:admins) { |thing| thing.admin? }
 Flipper.register(:early_access) { |thing| thing.early_access? }
@@ -54,16 +52,16 @@ 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.enable :stats
+Flipper.enable_group :stats, :admins
+Flipper.enable_group :stats, :early_access
+Flipper.enable_actor :stats, User.new('25')
+Flipper.enable_actor :stats, User.new('90')
+Flipper.enable_actor :stats, User.new('180')
+Flipper.enable_percentage_of_time :stats, 15
+Flipper.enable_percentage_of_actors :stats, 45
 
-flipper[:search].enable
+Flipper.enable :search
 
 puts 'all rows in features table'
 pp Flipper::Adapters::ActiveRecord::Feature.all

data/examples/active_record/ar_setup.rb

@@ -1,10 +1,4 @@
-require 'pathname'
-require 'logger'
-
-root_path = Pathname(__FILE__).dirname.join('..').expand_path
-lib_path  = root_path.join('lib')
-$:.unshift(lib_path)
-
+require 'bundler/setup'
 require 'active_record'
 ActiveRecord::Base.establish_connection({
   adapter: 'sqlite3',

data/lib/flipper-active_record.rb

@@ -2,4 +2,12 @@ require 'active_support/lazy_load_hooks'
 
 ActiveSupport.on_load(:active_record) do
   require 'flipper/adapters/active_record'
+
+  Flipper.configure do |config|
+    config.default do
+      Flipper.new(Flipper::Adapters::ActiveRecord.new)
+    end
+  end
+
+  ActiveRecord::Base.include Flipper::Identifier
 end

data/lib/flipper/version.rb

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

data/spec/flipper/adapters/active_record_spec.rb

@@ -45,4 +45,22 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
   end
 
   it_should_behave_like 'a flipper adapter'
+
+  context 'requiring "flipper-active_record"' do
+    before do
+      Flipper.configuration = nil
+      Flipper.instance = nil
+
+      load 'flipper-active_record.rb'
+      ActiveSupport.run_load_hooks(:active_record, ActiveRecord::Base)
+    end
+
+    it 'configures itself' do
+      expect(Flipper.adapter.adapter).to be_a(Flipper::Adapters::ActiveRecord)
+    end
+
+    it "defines #flipper_id on AR::Base" do
+      expect(ActiveRecord::Base.ancestors).to include(Flipper::Identifier)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0.rc1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-20 00:00:00.000000000 Z
+date: 2021-05-01 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.0
+        version: 0.21.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.21.0.rc1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -61,7 +61,6 @@ files:
 - lib/flipper/version.rb
 - lib/generators/flipper/active_record_generator.rb
 - lib/generators/flipper/templates/migration.erb
-- spec/flipper/adapters/active_record_requires_spec.rb
 - spec/flipper/adapters/active_record_spec.rb
 - test/adapters/active_record_test.rb
 - test_rails/generators/flipper/active_record_generator_test.rb
@@ -81,15 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ActiveRecord adapter for Flipper
 test_files:
-- spec/flipper/adapters/active_record_requires_spec.rb
 - spec/flipper/adapters/active_record_spec.rb
 - test/adapters/active_record_test.rb

data/spec/flipper/adapters/active_record_requires_spec.rb

@@ -1,5 +0,0 @@
-# This nominally-empty spec ensures that the file "flipper-active_record.rb" can be
-# required without error, and guards against regressions of the kind fixed in
-# https://github.com/jnunemaker/flipper/pull/437.
-
-require "flipper-active_record.rb"