flipper-active_record 0.20.4 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64603c99add7840b0cbb3583e665de4e1d60f3b2a8c26f844521002188c7e414
-  data.tar.gz: 69786113e31245190f91e98b33b5e8d64111cfb4112fd46bd87a3bb3ff0556a1
+  metadata.gz: 4d6c72b579bf974d75846d8b6e149f0790736f16848fe4b0e54a7fa2907262c8
+  data.tar.gz: de4029f2a4a2e6c8a869cfc1c2eb15b65d97ae627844b22fdc0274c4c9bf8e83
 SHA512:
-  metadata.gz: 125595ff73002af3c0c3a0e6e571cc81c1c9aa6637fe4352c49fed96d53cc89f15226e9a32b1ac68ef7547a376d0f2c50776d98b8a345a80c2f4a574d95d4945
-  data.tar.gz: 282136e3f700b8d2232faaa6505d3293cd8e19a7e87fa7a0acfc6987938d3f3857a642d609c4c040577fb4394bb5c27f936eb9413f108f4724960fcb5b8a5b0d
+  metadata.gz: cf9efccca1b72b1ef7c99b822ad6507a8fb5040f1460b6a2ed4eacc4d62278f72c1419db54a05e0c2ad3348b6dde4d76f011c314b41bc6ffb9f35e07e1f08a18
+  data.tar.gz: b864b6658ef23db29a0f3007fb24b7f641f26d59be006473102b39c2c42e6905ec776df28e2a47e5ab6e8d780f41862aae1a3b7ef9f8a8ac80a693beb7000501

data/docs/active_record/README.md

@@ -23,30 +23,26 @@ 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.adapter { Flipper::Adapters::ActiveRecord.new }
+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 +50,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/examples/active_record/basic.rb

@@ -3,20 +3,17 @@ require_relative "./ar_setup"
 # Requires the flipper-active_record gem to be installed.
 require 'flipper/adapters/active_record'
 
-adapter = Flipper::Adapters::ActiveRecord.new
-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/active_record/internals.rb

@@ -2,8 +2,6 @@ require_relative "./ar_setup"
 
 # Requires the flipper-active_record gem to be installed.
 require 'flipper/adapters/active_record'
-adapter = Flipper::Adapters::ActiveRecord.new
-flipper = Flipper.new(adapter)
 
 # Register a few groups.
 Flipper.register(:admins) { |thing| thing.admin? }
@@ -12,16 +10,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[: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 rows in features table'
 pp Flipper::Adapters::ActiveRecord::Feature.all
@@ -105,5 +103,5 @@ pp Flipper::Adapters::ActiveRecord::Gate.all
 puts
 
 puts 'flipper get of feature'
-pp adapter.get(flipper[:stats])
+pp Flipper.adapter.get(Flipper[:stats])
 # flipper get of feature

data/flipper-active_record.gemspec

@@ -25,5 +25,5 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
-  gem.add_dependency 'activerecord', '>= 5.0', '< 7'
+  gem.add_dependency 'activerecord', '>= 4.2', '< 7'
 end

data/lib/flipper/adapters/active_record.rb

@@ -101,11 +101,12 @@ module Flipper
       end
 
       def get_all
-        rows = ::ActiveRecord::Base.connection.select_all <<-SQL.tr("\n", ' ')
-          SELECT ff.key AS feature_key, fg.key, fg.value
-          FROM #{@feature_class.table_name} ff
-          LEFT JOIN #{@gate_class.table_name} fg ON ff.key = fg.feature_key
-        SQL
+        features = ::Arel::Table.new(@feature_class.table_name.to_sym)
+        gates = ::Arel::Table.new(@gate_class.table_name.to_sym)
+        rows_query = features.join(gates, Arel::Nodes::OuterJoin)
+          .on(features[:key].eq(gates[:feature_key]))
+          .project(features[:key].as('feature_key'), gates[:key], gates[:value])
+        rows = ::ActiveRecord::Base.connection.select_all rows_query
         db_gates = rows.map { |row| Gate.new(row) }
         grouped_db_gates = db_gates.group_by(&:feature_key)
         result = Hash.new { |hash, key| hash[key] = default_config }
@@ -219,3 +220,7 @@ module Flipper
     end
   end
 end
+
+Flipper.configure do |config|
+  config.adapter { Flipper::Adapters::ActiveRecord.new }
+end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.4'.freeze
+  VERSION = '0.22.0'.freeze
 end

data/spec/flipper/adapters/active_record_spec.rb

@@ -45,4 +45,18 @@ 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/adapters/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
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 0.20.4
+  version: 0.22.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-06 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,21 +16,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.4
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.4
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
@@ -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
@@ -90,6 +89,5 @@ 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"