flipper-active_record 0.28.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc8217d866ba4e5e348943be13ebb76c50d7d90ff0ce39c49b1dfd721d2f6da3
-  data.tar.gz: 8ba526732ad0786ccfb682fb3732d4226b5f357466cd52a08dbfa3534c853ade
+  metadata.gz: ae15abe1a25ef415ec5f7783b24192ae52cbf86b6d8e8026a7b23d3182db2ea3
+  data.tar.gz: 92c793efbd0539545f73d363f61df2f3a43d949aafb0bb303ecb5d8a747e660a
 SHA512:
-  metadata.gz: 8edffe9b5b277baaea8ea0b81bcc2e28b84b09317bf597865344487a5cb36f7a7117759baf31d9e215459775e64af99d778181fb5bd20764d7afb36071587f0c
-  data.tar.gz: 77f3fe7f0bb0873f52e5fe4a80b5e8a5beec83dd3baaa73cbeeb90e24f924dce9dd23f48f3a9406ba394a6d6a6990b11f9daea9103590a8cfb3dc994d44d76b6
+  metadata.gz: a01ae2b84eea1af1a46ed86a0727a38418ec88682fddf0e8829e340f39e368adf7e3451e07b05efc423d874cc6bf70910bfc7afe61267db84c6e8ef90d6f1764
+  data.tar.gz: 280adedbab88143432826be99f65e17673f9bc0012ddb4c89392b32c6dd2c6ec9ce71a68bf1f79dce2347a631afc5d0f3804092ddbd2d6ef6906fb2af6142534

data/benchmark/active_record_adapter_ips.rb

@@ -6,10 +6,13 @@ require 'benchmark/ips'
 
 flipper = Flipper.new(Flipper::Adapters::ActiveRecord.new)
 
-2000.times do |i|
-  flipper.enable_actor :foo, Flipper::Actor.new("User;#{i}")
+10.times do |n|
+  2000.times do |i|
+    flipper.enable_actor 'feature' + n.to_s, Flipper::Actor.new("User;#{i}")
+  end
 end
 
 Benchmark.ips do |x|
   x.report("get_all") { flipper.preload_all }
+  x.report("features") { flipper.features }
 end

data/examples/active_record/ar_setup.rb

@@ -28,3 +28,18 @@ SQL
 ActiveRecord::Base.connection.execute <<-SQL
   CREATE UNIQUE INDEX index_gates_on_keys_and_value on flipper_gates (feature_key, key, value)
 SQL
+
+ActiveRecord::Base.connection.execute <<-SQL
+  CREATE TABLE users (
+    id integer PRIMARY KEY,
+    name string NOT NULL,
+    influencer boolean,
+    created_at datetime NOT NULL,
+    updated_at datetime NOT NULL
+  )
+SQL
+
+require 'flipper/model/active_record'
+class User < ActiveRecord::Base
+  include Flipper::Model::ActiveRecord
+end

data/examples/active_record/group_migration.rb

@@ -0,0 +1,68 @@
+# This is an example script that shows how to migrate from a bunch of individual
+# actors to a group. Should be useful for those who have ended up with large
+# actor sets and want to slim them down for performance reasons.
+
+require_relative "./ar_setup"
+require 'flipper/adapters/active_record'
+require 'active_support/all'
+
+# 1. enable feature for 100 actors, make 80 influencers
+users = 100.times.map do |n|
+  influencer = n < 80 ? true : false
+  user = User.create(name: n, influencer: influencer)
+  Flipper.enable :stats, user
+  user
+end
+
+# check enabled, should all be because individual actors are enabled
+print 'Should be [[true, 100]]: '
+print users.group_by { |user| Flipper.enabled?(:stats, user) }.map { |result, users| [result, users.size]}
+puts
+
+# 2. register a group so flipper knows what to do with it
+Flipper.register(:influencers) do |actor, context|
+  actor.respond_to?(:influencer) && actor.influencer
+end
+
+# 3. enable group for feature, THIS IS IMPORTANT
+Flipper.enable :stats, :influencers
+
+# check enabled again, should all still be true because individual actors are
+# enabled, but also the group gate would return true for 80 influencers. At this
+# point, it's kind of double true but flipper just cares if any gate returns true.
+print 'Should be [[true, 100]]: '
+print users.group_by { |user| Flipper.enabled?(:stats, user) }.map { |result, users| [result, users.size]}
+puts
+
+# 4. now we want to clean up the actors that are covered by the group to slim down
+# the actor set size. So we loop through actors and remove them if group returns
+# true for the provided actor and context.
+Flipper[:stats].actors_value.each do |flipper_id|
+  # Hydrate the flipper_id into an active record object. Modify this based on
+  # your flipper_id's if you use anything other than active record models and
+  # the default flipper_id provided by flipper.
+  class_name, id = flipper_id.split(';')
+  klass = class_name.constantize
+  user = klass.find(id)
+
+  # if user is in group then disable for actor because they'll still get the feature
+  context = Flipper::FeatureCheckContext.new(
+    feature_name: :stats,
+    values: Flipper[:stats].gate_values,
+    actors: [Flipper::Types::Actor.wrap(user)]
+  )
+
+  if Flipper::Gates::Group.new.open?(context)
+    Flipper.disable(:stats, user)
+  end
+end
+
+# check enabled again, should be the same result as previous checks
+print 'Should be [[true, 100]]: '
+print users.group_by { |user| Flipper.enabled?(:stats, user) }.map { |result, users| [result, users.size]}
+puts
+
+puts "Actors enabled: #{Flipper[:stats].actors_value.size}"
+puts "Groups enabled: #{Flipper[:stats].groups_value.size}"
+
+puts "All actors that could be migrated to groups were migrated. Yay!"

data/flipper-active_record.gemspec

@@ -1,17 +1,24 @@
 # -*- encoding: utf-8 -*-
 require File.expand_path('../lib/flipper/version', __FILE__)
 require File.expand_path('../lib/flipper/metadata', __FILE__)
+require "set"
+
+# Files that should exist in main flipper gem.
+main_flipper_active_record_files = Set[
+  "lib/flipper/model/active_record.rb",
+  "spec/flipper/model/active_record_spec.rb",
+]
 
 flipper_active_record_files = lambda do |file|
-  file =~ /active_record/
+  file =~ /active_record/ && !main_flipper_active_record_files.include?(file)
 end
 
 Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
-  gem.email         = ['nunemaker@gmail.com']
-  gem.summary       = 'ActiveRecord adapter for Flipper'
+  gem.email         = 'support@flippercloud.io'
+  gem.summary       = 'ActiveRecord feature flag adapter for Flipper'
   gem.license       = 'MIT'
-  gem.homepage      = 'https://github.com/jnunemaker/flipper'
+  gem.homepage      = 'https://www.flippercloud.io/docs/adapters/active-record'
 
   extra_files = [
     'lib/generators/flipper/templates/migration.erb',
@@ -25,5 +32,5 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
-  gem.add_dependency 'activerecord', '>= 4.2', '< 8'
+  gem.add_dependency 'activerecord', '>= 4.2', '< 9'
 end

data/lib/flipper/adapters/active_record.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'securerandom'
 require 'flipper'
 require 'active_record'
 
@@ -7,31 +8,42 @@ module Flipper
     class ActiveRecord
       include ::Flipper::Adapter
 
-      # Abstract base class for internal models
-      class Model < ::ActiveRecord::Base
-        self.abstract_class = true
-      end
+      ActiveSupport.on_load(:active_record) do
+        # Abstract base class for internal models
+        class Model < ::ActiveRecord::Base
+          self.abstract_class = true
+        end
 
-      # Private: Do not use outside of this adapter.
-      class Feature < Model
-        self.table_name = [
-          Model.table_name_prefix,
-          "flipper_features",
-          Model.table_name_suffix,
-        ].join
-      end
+        # Private: Do not use outside of this adapter.
+        class Feature < Model
+          self.table_name = [
+            Model.table_name_prefix,
+            "flipper_features",
+            Model.table_name_suffix,
+          ].join
+
+          has_many :gates, foreign_key: "feature_key", primary_key: "key"
+
+          validates :key, presence: true
+        end
+
+        # Private: Do not use outside of this adapter.
+        class Gate < Model
+          self.table_name = [
+            Model.table_name_prefix,
+            "flipper_gates",
+            Model.table_name_suffix,
+          ].join
 
-      # Private: Do not use outside of this adapter.
-      class Gate < Model
-        self.table_name = [
-          Model.table_name_prefix,
-          "flipper_gates",
-          Model.table_name_suffix,
-        ].join
+          validates :feature_key, presence: true
+          validates :key, presence: true
+        end
       end
 
-      # Public: The name of the adapter.
-      attr_reader :name
+      VALUE_TO_TEXT_WARNING = <<-EOS
+        Your database needs migrated to use the latest Flipper features.
+        Run `rails generate flipper:update` and `rails db:migrate`.
+      EOS
 
       # Public: Initialize a new ActiveRecord adapter instance.
       #
@@ -49,24 +61,27 @@ module Flipper
         @name = options.fetch(:name, :active_record)
         @feature_class = options.fetch(:feature_class) { Feature }
         @gate_class = options.fetch(:gate_class) { Gate }
+
+        warn VALUE_TO_TEXT_WARNING if value_not_text?
       end
 
       # Public: The set of known features.
       def features
-        with_connection(@feature_class) { @feature_class.all.map(&:key).to_set }
+        with_connection(@feature_class) { @feature_class.distinct.pluck(:key).to_set }
       end
 
       # Public: Adds a feature to the set of known features.
       def add(feature)
         with_connection(@feature_class) do
-          # race condition, but add is only used by enable/disable which happen
-          # super rarely, so it shouldn't matter in practice
-          @feature_class.transaction do
-            unless @feature_class.where(key: feature.key).first
-              begin
-                @feature_class.create! { |f| f.key = feature.key }
-              rescue ::ActiveRecord::RecordNotUnique
+          @feature_class.transaction(requires_new: true) do
+            begin
+              # race condition, but add is only used by enable/disable which happen
+              # super rarely, so it shouldn't matter in practice
+              unless @feature_class.where(key: feature.key).exists?
+                @feature_class.create!(key: feature.key)
               end
+            rescue ::ActiveRecord::RecordNotUnique
+              # already added
             end
           end
         end
@@ -117,14 +132,14 @@ module Flipper
       end
 
       def get_all
-        with_connection(@feature_class) do
+        with_connection(@feature_class) do |connection|
           # query the gates from the db in a single query
           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])
-          gates = @feature_class.connection.select_rows(rows_query)
+          gates = connection.select_rows(rows_query)
 
           # group the gates by feature key
           grouped_gates = gates.inject({}) do |hash, (feature_key, key, value)|
@@ -156,6 +171,8 @@ module Flipper
           set(feature, gate, thing, clear: true)
         when :integer
           set(feature, gate, thing)
+        when :json
+          set(feature, gate, thing, json: true)
         when :set
           enable_multi(feature, gate, thing)
         else
@@ -178,6 +195,8 @@ module Flipper
           clear(feature)
         when :integer
           set(feature, gate, thing)
+        when :json
+          delete(feature, gate)
         when :set
           with_connection(@gate_class) do
             @gate_class.where(feature_key: feature.key, key: gate.key, value: thing.value).destroy_all
@@ -198,19 +217,23 @@ module Flipper
 
       def set(feature, gate, thing, options = {})
         clear_feature = options.fetch(:clear, false)
+        json_feature = options.fetch(:json, false)
+
+        raise VALUE_TO_TEXT_WARNING if json_feature && value_not_text?
+
         with_connection(@gate_class) do
-          @gate_class.transaction do
+          @gate_class.transaction(requires_new: true) do
             clear(feature) if clear_feature
-            @gate_class.where(feature_key: feature.key, key: gate.key).destroy_all
+            delete(feature, gate)
             begin
               @gate_class.create! do |g|
                 g.feature_key = feature.key
                 g.key = gate.key
-                g.value = thing.value.to_s
+                g.value = json_feature ? Typecast.to_json(thing.value) : thing.value.to_s
               end
             rescue ::ActiveRecord::RecordNotUnique
               # assume this happened concurrently with the same thing and its fine
-              # see https://github.com/jnunemaker/flipper/issues/544
+              # see https://github.com/flippercloud/flipper/issues/544
             end
           end
         end
@@ -218,18 +241,26 @@ module Flipper
         nil
       end
 
+      def delete(feature, gate)
+        @gate_class.where(feature_key: feature.key, key: gate.key).destroy_all
+      end
+
       def enable_multi(feature, gate, thing)
-        with_connection(@gate_class) do
-          @gate_class.create! do |g|
-            g.feature_key = feature.key
-            g.key = gate.key
-            g.value = thing.value.to_s
+        with_connection(@gate_class) do |connection|
+          begin
+            connection.transaction(requires_new: true) do
+              @gate_class.create! do |g|
+                g.feature_key = feature.key
+                g.key = gate.key
+                g.value = thing.value.to_s
+              end
+            end
+          rescue ::ActiveRecord::RecordNotUnique
+            # already added so move on with life
           end
         end
 
         nil
-      rescue ::ActiveRecord::RecordNotUnique
-        # already added so no need move on with life
       end
 
       def result_for_gates(feature, gates)
@@ -238,13 +269,13 @@ module Flipper
         feature.gates.each do |gate|
           result[gate.key] =
             case gate.data_type
-            when :boolean
+            when :boolean, :integer
               if row = gates.detect { |key, value| !key.nil? && key.to_sym == gate.key }
                 row.last
               end
-            when :integer
+            when :json
               if row = gates.detect { |key, value| !key.nil? && key.to_sym == gate.key }
-                row.last
+                Typecast.from_json(row.last)
               end
             when :set
               gates.select { |key, value| !key.nil? && key.to_sym == gate.key }.map(&:last).to_set
@@ -255,6 +286,15 @@ module Flipper
         result
       end
 
+      # Check if value column is text instead of string
+      # See https://github.com/flippercloud/flipper/pull/692
+      def value_not_text?
+        @gate_class.column_for_attribute(:value).type != :text
+      rescue ::ActiveRecord::ActiveRecordError => error
+        # If the table doesn't exist, the column doesn't exist either
+        warn "#{error.message}. You likely need to run `rails g flipper:active_record` and/or `rails db:migrate`."
+      end
+
       def with_connection(model = @feature_class, &block)
         model.connection_pool.with_connection(&block)
       end

data/lib/flipper/version.rb

@@ -1,3 +1,13 @@
 module Flipper
-  VERSION = '0.28.3'.freeze
+  VERSION = '1.3.4'.freeze
+
+  REQUIRED_RUBY_VERSION = '2.6'.freeze
+  NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze
+
+  REQUIRED_RAILS_VERSION = '5.2'.freeze
+  NEXT_REQUIRED_RAILS_VERSION = '6.1.0'.freeze
+
+  def self.deprecated_ruby_version?
+    Gem::Version.new(RUBY_VERSION) < Gem::Version.new(NEXT_REQUIRED_RUBY_VERSION)
+  end
 end

data/lib/generators/flipper/templates/migration.erb

@@ -1,5 +1,5 @@
 class CreateFlipperTables < ActiveRecord::Migration<%= migration_version %>
-  def self.up
+  def up
     create_table :flipper_features do |t|
       t.string :key, null: false
       t.timestamps null: false
@@ -9,13 +9,13 @@ class CreateFlipperTables < ActiveRecord::Migration<%= migration_version %>
     create_table :flipper_gates do |t|
       t.string :feature_key, null: false
       t.string :key, null: false
-      t.string :value
+      t.text :value
       t.timestamps null: false
     end
-    add_index :flipper_gates, [:feature_key, :key, :value], unique: true
+    add_index :flipper_gates, [:feature_key, :key, :value], unique: true, length: { value: 255 }
   end
 
-  def self.down
+  def down
     drop_table :flipper_gates
     drop_table :flipper_features
   end

data/spec/flipper/adapters/active_record_spec.rb

@@ -1,181 +1,267 @@
-require 'flipper/adapters/active_record'
+SpecHelpers.silence { require 'flipper/adapters/active_record' }
 
 # Turn off migration logging for specs
 ActiveRecord::Migration.verbose = false
+ActiveRecord::Tasks::DatabaseTasks.root = File.dirname(__FILE__)
 
 RSpec.describe Flipper::Adapters::ActiveRecord do
   subject { described_class.new }
 
   before(:all) do
-    ActiveRecord::Base.establish_connection(adapter: 'sqlite3',
-                                            database: ':memory:')
+    # Eval migration template so we can run migration against each database
+    template_path = File.join(File.dirname(__FILE__), '../../../lib/generators/flipper/templates/migration.erb')
+    migration = ERB.new(File.read(template_path))
+    migration_version = "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+    eval migration.result_with_hash(migration_version: migration_version) # defines CreateFlipperTables
   end
 
-  before(:each) do
-    ActiveRecord::Base.connection.execute <<-SQL
-      CREATE TABLE flipper_features (
-        id integer PRIMARY KEY,
-        key text NOT NULL UNIQUE,
-        created_at datetime NOT NULL,
-        updated_at datetime NOT NULL
-      )
-    SQL
-
-    ActiveRecord::Base.connection.execute <<-SQL
-      CREATE TABLE flipper_gates (
-        id integer PRIMARY KEY,
-        feature_key text NOT NULL,
-        key text NOT NULL,
-        value text DEFAULT NULL,
-        created_at datetime NOT NULL,
-        updated_at datetime NOT NULL
-      )
-    SQL
-
-    ActiveRecord::Base.connection.execute <<-SQL
-      CREATE UNIQUE INDEX index_gates_on_keys_and_value on flipper_gates (feature_key, key, value)
-    SQL
-  end
+  [
+    {
+      "adapter" => "sqlite3",
+      "database" => ":memory:"
+    },
 
-  after(:each) do
-    ActiveRecord::Base.connection.execute("DROP table IF EXISTS `flipper_features`")
-    ActiveRecord::Base.connection.execute("DROP table IF EXISTS `flipper_gates`")
-  end
+    {
+      "adapter" => "mysql2",
+      "encoding" => "utf8mb4",
+      "host" => ENV["MYSQL_HOST"],
+      "username" => ENV["MYSQL_USER"] || "root",
+      "password" => ENV["MYSQL_PASSWORD"] || "",
+      "database" => ENV["MYSQL_DATABASE"] || "flipper_test",
+      "port" => ENV["DB_PORT"] || 3306
+    },
 
-  it_should_behave_like 'a flipper adapter'
+    {
+      "adapter" => "postgresql",
+      "encoding" => "unicode",
+      "host" => "127.0.0.1",
+      "username" => ENV["POSTGRES_USER"] || "",
+      "password" => ENV["POSTGRES_PASSWORD"] || "",
+      "database" => ENV["POSTGRES_DATABASE"] || "flipper_test",
+    }
+  ].each do |config|
+    context "with #{config['adapter']}" do
+      context "with tables created" do
+        before(:all) do
+          skip_on_error(ActiveRecord::ConnectionNotEstablished, "#{config['adapter']} not available") do
+            silence do
+              ActiveRecord::Tasks::DatabaseTasks.create(config)
+            end
+          end
 
-  context 'requiring "flipper-active_record"' do
-    before do
-      Flipper.configuration = nil
-      Flipper.instance = nil
+          Flipper.configuration = nil
+        end
 
-      load 'flipper/adapters/active_record.rb'
-      ActiveSupport.run_load_hooks(:active_record, ActiveRecord::Base)
-    end
+        before(:each) do
+          silence do
+            ActiveRecord::Tasks::DatabaseTasks.purge(config)
+            CreateFlipperTables.migrate(:up)
+          end
+        end
 
-    it 'configures itself' do
-      expect(Flipper.adapter.adapter).to be_a(Flipper::Adapters::ActiveRecord)
-    end
-  end
+        after(:all) do
+          silence { ActiveRecord::Tasks::DatabaseTasks.drop(config) } unless $skip
+        end
 
-  context "ActiveRecord connection_pool" do
-    before do
-      ActiveRecord::Base.clear_active_connections!
-    end
+        it_should_behave_like 'a flipper adapter'
 
-    context "#features" do
-      it "does not hold onto connections" do
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-        subject.features
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-      end
+        it "should load actor ids fine" do
+          flipper.enable_percentage_of_time(:foo, 1)
 
-      it "does not release previously held connection" do
-        ActiveRecord::Base.connection # establish a new connection
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-        subject.features
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-      end
-    end
+          Flipper::Adapters::ActiveRecord::Gate.create!(
+            feature_key: "foo",
+            key: "actors",
+            value: "Organization;4",
+          )
 
-    context "#get_all" do
-      it "does not hold onto connections" do
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-        subject.get_all
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-      end
+          flipper = Flipper.new(subject)
+          flipper.preload([:foo])
+        end
 
-      it "does not release previously held connection" do
-        ActiveRecord::Base.connection # establish a new connection
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-        subject.get_all
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-      end
-    end
+        it 'should not poison wrapping transactions' do
+          flipper = Flipper.new(subject)
 
-    context "#add / #remove / #clear" do
-      let(:feature) { Flipper::Feature.new(:search, subject) }
-
-      it "does not hold onto connections" do
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-        subject.add(feature)
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-        subject.remove(feature)
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-        subject.clear(feature)
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-      end
+          actor = Struct.new(:flipper_id).new('flipper-id-123')
+          flipper.enable_actor(:foo, actor)
 
-      it "does not release previously held connection" do
-        ActiveRecord::Base.connection # establish a new connection
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-        subject.add(feature)
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-        subject.remove(feature)
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-        subject.clear(feature)
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-      end
-    end
+          ActiveRecord::Base.transaction do
+            flipper.enable_actor(:foo, actor)
+            # any read on the next line is fine, just need to ensure that
+            # poisoned transaction isn't raised
+            expect(Flipper::Adapters::ActiveRecord::Gate.count).to eq(1)
+          end
+        end
 
-    context "#get_multi" do
-      let(:feature) { Flipper::Feature.new(:search, subject) }
+        context "ActiveRecord connection_pool" do
+          before do
+            ActiveRecord::Base.connection_handler.clear_active_connections!
+          end
 
-      it "does not hold onto connections" do
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-        subject.get_multi([feature])
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-      end
+          context "#features" do
+            it "does not hold onto connections" do
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              subject.features
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+            end
 
-      it "does not release previously held connection" do
-        ActiveRecord::Base.connection # establish a new connection
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-        subject.get_multi([feature])
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-      end
-    end
+            it "does not release previously held connection" do
+              ActiveRecord::Base.connection # establish a new connection
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              subject.features
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+            end
+          end
 
-    context "#enable/#disable boolean" do
-      let(:feature) { Flipper::Feature.new(:search, subject) }
-      let(:gate) { feature.gate(:boolean)}
+          context "#get_all" do
+            it "does not hold onto connections" do
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              subject.get_all
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+            end
 
-      it "does not hold onto connections" do
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-        subject.enable(feature, gate, gate.wrap(true))
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-        subject.disable(feature, gate, gate.wrap(false))
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-      end
+            it "does not release previously held connection" do
+              ActiveRecord::Base.connection # establish a new connection
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              subject.get_all
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+            end
+          end
 
-      it "does not release previously held connection" do
-        ActiveRecord::Base.connection # establish a new connection
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-        subject.enable(feature, gate, gate.wrap(true))
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-        subject.disable(feature, gate, gate.wrap(false))
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-      end
-    end
+          context "#add / #remove / #clear" do
+            let(:feature) { Flipper::Feature.new(:search, subject) }
+
+            it "does not hold onto connections" do
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              subject.add(feature)
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              subject.remove(feature)
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              subject.clear(feature)
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+            end
+
+            it "does not release previously held connection" do
+              ActiveRecord::Base.connection # establish a new connection
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              subject.add(feature)
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              subject.remove(feature)
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              subject.clear(feature)
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+            end
+          end
+
+          context "#get_multi" do
+            let(:feature) { Flipper::Feature.new(:search, subject) }
+
+            it "does not hold onto connections" do
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              subject.get_multi([feature])
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+            end
+
+            it "does not release previously held connection" do
+              ActiveRecord::Base.connection # establish a new connection
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              subject.get_multi([feature])
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+            end
+          end
+
+          context "#enable/#disable boolean" do
+            let(:feature) { Flipper::Feature.new(:search, subject) }
+            let(:gate) { feature.gate(:boolean)}
+
+            it "does not hold onto connections" do
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              subject.enable(feature, gate, gate.wrap(true))
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              subject.disable(feature, gate, gate.wrap(false))
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+            end
+
+            it "does not release previously held connection" do
+              ActiveRecord::Base.connection # establish a new connection
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              subject.enable(feature, gate, gate.wrap(true))
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              subject.disable(feature, gate, gate.wrap(false))
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+            end
+          end
+
+          context "#enable/#disable set" do
+            let(:feature) { Flipper::Feature.new(:search, subject) }
+            let(:gate) { feature.gate(:group) }
 
-    context "#enable/#disable set" do
-      let(:feature) { Flipper::Feature.new(:search, subject) }
-      let(:gate) { feature.gate(:group) }
+            it "does not hold onto connections" do
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              subject.enable(feature, gate, gate.wrap(:admin))
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              subject.disable(feature, gate, gate.wrap(:admin))
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+            end
 
-      it "does not hold onto connections" do
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-        subject.enable(feature, gate, gate.wrap(:admin))
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
-        subject.disable(feature, gate, gate.wrap(:admin))
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+            it "does not release previously held connection" do
+              ActiveRecord::Base.connection # establish a new connection
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              subject.enable(feature, gate, gate.wrap(:admin))
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              subject.disable(feature, gate, gate.wrap(:admin))
+              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+            end
+          end
+        end
+
+        context 'requiring "flipper-active_record"' do
+          before do
+            Flipper.configuration = nil
+            Flipper.instance = nil
+
+            silence { load 'flipper/adapters/active_record.rb' }
+          end
+
+          it 'configures itself' do
+            expect(Flipper.adapter.adapter).to be_a(Flipper::Adapters::ActiveRecord)
+          end
+        end
       end
 
-      it "does not release previously held connection" do
-        ActiveRecord::Base.connection # establish a new connection
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-        subject.enable(feature, gate, gate.wrap(:admin))
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
-        subject.disable(feature, gate, gate.wrap(:admin))
-        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+      context "without tables created" do
+        before(:all) do
+          skip_on_error(ActiveRecord::ConnectionNotEstablished, "#{config['adapter']} not available") do
+            silence do
+              ActiveRecord::Tasks::DatabaseTasks.create(config)
+            end
+          end
+
+          Flipper.configuration = nil
+        end
+
+        before(:each) do
+          ActiveRecord::Base.establish_connection(config)
+        end
+
+        after(:each) do
+          ActiveRecord::Base.connection.close
+        end
+
+        after(:all) do
+          silence { ActiveRecord::Tasks::DatabaseTasks.drop(config) } unless $skip
+        end
+
+        it "does not raise an error" do
+          Flipper.configuration = nil
+          Flipper.instance = nil
+
+          silence do
+            expect {
+              load 'flipper/adapters/active_record.rb'
+              Flipper::Adapters::ActiveRecord.new
+            }.not_to raise_error
+          end
+        end
       end
     end
   end

data/test/adapters/active_record_test.rb

@@ -11,8 +11,6 @@ class ActiveRecordTest < MiniTest::Test
                                           database: ':memory:')
 
   def setup
-    @adapter = Flipper::Adapters::ActiveRecord.new
-
     ActiveRecord::Base.connection.execute <<-SQL
       CREATE TABLE flipper_features (
         id integer PRIMARY KEY,
@@ -36,6 +34,8 @@ class ActiveRecordTest < MiniTest::Test
     ActiveRecord::Base.connection.execute <<-SQL
       CREATE UNIQUE INDEX index_gates_on_keys_and_value on flipper_gates (feature_key, key, value)
     SQL
+
+    @adapter = Flipper::Adapters::ActiveRecord.new
   end
 
   def teardown
@@ -47,8 +47,7 @@ class ActiveRecordTest < MiniTest::Test
     ActiveRecord::Base.table_name_prefix = :foo_
     ActiveRecord::Base.table_name_suffix = :_bar
 
-    Flipper::Adapters::ActiveRecord.send(:remove_const, :Feature)
-    Flipper::Adapters::ActiveRecord.send(:remove_const, :Gate)
+    Flipper::Adapters.send(:remove_const, :ActiveRecord)
     load("flipper/adapters/active_record.rb")
 
     assert_equal "foo_flipper_features_bar", Flipper::Adapters::ActiveRecord::Feature.table_name
@@ -58,8 +57,7 @@ class ActiveRecordTest < MiniTest::Test
     ActiveRecord::Base.table_name_prefix = ""
     ActiveRecord::Base.table_name_suffix = ""
 
-    Flipper::Adapters::ActiveRecord.send(:remove_const, :Feature)
-    Flipper::Adapters::ActiveRecord.send(:remove_const, :Gate)
+    Flipper::Adapters.send(:remove_const, :ActiveRecord)
     load("flipper/adapters/active_record.rb")
   end
 end

data/test_rails/generators/flipper/active_record_generator_test.rb

@@ -1,6 +1,4 @@
 require 'helper'
-require 'active_record'
-require 'rails/generators/test_case'
 require 'generators/flipper/active_record_generator'
 
 class FlipperActiveRecordGeneratorTest < Rails::Generators::TestCase
@@ -17,7 +15,7 @@ class FlipperActiveRecordGeneratorTest < Rails::Generators::TestCase
                         end
     assert_migration 'db/migrate/create_flipper_tables.rb', <<~MIGRATION
       class CreateFlipperTables < ActiveRecord::Migration#{migration_version}
-        def self.up
+        def up
           create_table :flipper_features do |t|
             t.string :key, null: false
             t.timestamps null: false
@@ -27,13 +25,13 @@ class FlipperActiveRecordGeneratorTest < Rails::Generators::TestCase
           create_table :flipper_gates do |t|
             t.string :feature_key, null: false
             t.string :key, null: false
-            t.string :value
+            t.text :value
             t.timestamps null: false
           end
-          add_index :flipper_gates, [:feature_key, :key, :value], unique: true
+          add_index :flipper_gates, [:feature_key, :key, :value], unique: true, length: { value: 255 }
         end
 
-        def self.down
+        def down
           drop_table :flipper_gates
           drop_table :flipper_features
         end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 0.28.3
+  version: 1.3.4
 platform: ruby
 authors:
 - John Nunemaker
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-21 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.3
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.28.3
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -33,7 +32,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,10 +42,8 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
-description:
-email:
-- nunemaker@gmail.com
+        version: '9'
+email: support@flippercloud.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -57,6 +54,7 @@ files:
 - examples/active_record/ar_setup.rb
 - examples/active_record/basic.rb
 - examples/active_record/cached.rb
+- examples/active_record/group_migration.rb
 - examples/active_record/internals.rb
 - flipper-active_record.gemspec
 - lib/flipper-active_record.rb
@@ -67,12 +65,16 @@ files:
 - spec/flipper/adapters/active_record_spec.rb
 - test/adapters/active_record_test.rb
 - test_rails/generators/flipper/active_record_generator_test.rb
-homepage: https://github.com/jnunemaker/flipper
+homepage: https://www.flippercloud.io/docs/adapters/active-record
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/jnunemaker/flipper/blob/main/Changelog.md
-post_install_message:
+  documentation_uri: https://www.flippercloud.io/docs
+  homepage_uri: https://www.flippercloud.io
+  source_code_uri: https://github.com/flippercloud/flipper
+  bug_tracker_uri: https://github.com/flippercloud/flipper/issues
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.4
+  funding_uri: https://github.com/sponsors/flippercloud
 rdoc_options: []
 require_paths:
 - lib
@@ -87,10 +89,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
-summary: ActiveRecord adapter for Flipper
+summary: ActiveRecord feature flag adapter for Flipper
 test_files:
 - spec/flipper/adapters/active_record_spec.rb
 - test/adapters/active_record_test.rb