flipper-active_record 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7440c16ba96d1af13b04d53af4a794f2b2721ac9073f3be79399542d35f0e8b
-  data.tar.gz: 3bf38ab6f14dcf13cfaa53e1d8cfba1622be76cbd0cbb26313c2b135d9681b64
+  metadata.gz: 81713d8d766224017cb63e42f5a918a061db77d9ad23f5b6ccf2b864244413c9
+  data.tar.gz: 4d81bac025f6d0374f6b7cfd147a6df93991635efd394b21b8aede593471ccda
 SHA512:
-  metadata.gz: ae73ab2931ebaa6ab45e8f12d75fd16859b7c35fe83c09311b51c3dd43243106db50588dd7605f9e98a8d1611305861fcf3f082561b06dceab042d21f67e56fd
-  data.tar.gz: 707051b6ad52cbbe0a50e817ba06d39ddb30cc42c1f7585e890d4c4f378bbd8775e519212cf38c43fe49907245c3e25da618e3644081dc5afcca3056d7b90b8b
+  metadata.gz: ed4dd08828325e647bff16e2696cf19810912b9c79f962742eac51789c63b262bbc268f2720d4668d6c9e39f8670494fc65d827e0b745b0b7a5c1edab184d692
+  data.tar.gz: c3f61cf9f06ee4eeb563927115ceb127ec2fd8484c78eb7049b71f8e53ad0456f82df4b40d415e64017a92293a8509f437d597756afd55ff1fb3ed5463eec3b1

data/flipper-active_record.gemspec

@@ -16,7 +16,7 @@ end
 Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
   gem.email         = 'support@flippercloud.io'
-  gem.summary       = 'ActiveRecord adapter for Flipper'
+  gem.summary       = 'ActiveRecord feature flag adapter for Flipper'
   gem.license       = 'MIT'
   gem.homepage      = 'https://www.flippercloud.io/docs/adapters/active-record'
 

data/lib/flipper/adapters/active_record.rb

@@ -34,7 +34,7 @@ module Flipper
 
       VALUE_TO_TEXT_WARNING = <<-EOS
         Your database needs migrated to use the latest Flipper features.
-        See https://github.com/flippercloud/flipper/issues/557
+        Run `rails generate flipper:update` and `rails db:migrate`.
       EOS
 
       # Public: Initialize a new ActiveRecord adapter instance.
@@ -278,6 +278,9 @@ module Flipper
       # 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)

data/lib/flipper/version.rb

@@ -1,3 +1,13 @@
 module Flipper
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'.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
@@ -12,10 +12,10 @@ class CreateFlipperTables < ActiveRecord::Migration<%= migration_version %>
       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,193 +1,229 @@
-require 'flipper/adapters/active_record'
+SpecHelpers.silence { require 'flipper/adapters/active_record' }
 require 'active_support/core_ext/kernel'
 
 # 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
+    migration = ERB.new(File.read(File.join(File.dirname(__FILE__), '../../../lib/generators/flipper/templates/migration.erb')))
+    migration_version = "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+    eval migration.result(binding) # defines CreateFlipperTables
   end
 
-  before(:each) do
-    ActiveRecord::Base.connection.execute <<-SQL
-      CREATE TABLE flipper_features (
-        id integer PRIMARY KEY,
-        key string 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 string 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
-
-  after(:each) do
-    ActiveRecord::Base.connection.execute("DROP table IF EXISTS `flipper_features`")
-    ActiveRecord::Base.connection.execute("DROP table IF EXISTS `flipper_gates`")
-  end
-
-  it_should_behave_like 'a flipper adapter'
-
-  it "should load actor ids fine" do
-    flipper.enable_percentage_of_time(:foo, 1)
-
-    ActiveRecord::Base.connection.execute <<-SQL
-      INSERT INTO flipper_gates (feature_key, key, value, created_at, updated_at)
-      VALUES ("foo", "actors", "Organization;4", time(), time())
-    SQL
-
-    flipper = Flipper.new(subject)
-    flipper.preload([:foo])
-  end
-
-  context 'requiring "flipper-active_record"' do
-    before do
-      Flipper.configuration = nil
-      Flipper.instance = nil
-
-      silence_warnings { load 'flipper/adapters/active_record.rb' }
-    end
-
-    it 'configures itself' do
-      expect(Flipper.adapter.adapter).to be_a(Flipper::Adapters::ActiveRecord)
-    end
-  end
-
-  context "ActiveRecord connection_pool" do
-    before do
-      ActiveRecord::Base.clear_active_connections!
-    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)
+  [
+    {
+      adapter: "sqlite3",
+      database: ":memory:"
+    },
+
+    {
+      adapter: "mysql2",
+      encoding: "utf8mb4",
+      username: ENV["MYSQL_USER"] || "root",
+      password: ENV["MYSQL_PASSWORD"] || "",
+      database: ENV["MYSQL_DATABASE"] || "flipper_test",
+      port: ENV["DB_PORT"] || 3306
+    },
+
+    {
+      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|
+    config = config.with_indifferent_access
+
+    context "with #{config[:adapter]}" do
+      before(:all) do
+        silence { ActiveRecord::Tasks::DatabaseTasks.create(config) }
       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)
+      before(:each) do
+        skip_on_error(ActiveRecord::ConnectionNotEstablished, "#{config[:adapter]} not available") do
+          ActiveRecord::Base.establish_connection(config)
+          CreateFlipperTables.migrate(:up)
+        end
       end
-    end
 
-    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)
+      after(:each) do
+        ActiveRecord::Tasks::DatabaseTasks.purge(config)
+        ActiveRecord::Base.connection.close
       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)
+      after(:all) do
+        silence { ActiveRecord::Tasks::DatabaseTasks.drop(config) }
       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_should_behave_like 'a flipper adapter'
 
-      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
+      it "works when table doesn't exist" do
+        CreateFlipperTables.migrate(:down)
 
-    context "#get_multi" do
-      let(:feature) { Flipper::Feature.new(:search, subject) }
+        Flipper.configuration = nil
+        Flipper.instance = nil
 
-      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)
+        expect {
+          silence do
+            load 'flipper/adapters/active_record.rb'
+            Flipper::Adapters::ActiveRecord.new
+          end
+        }.not_to raise_error
       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 "should load actor ids fine" do
+        flipper.enable_percentage_of_time(:foo, 1)
 
-    context "#enable/#disable boolean" do
-      let(:feature) { Flipper::Feature.new(:search, subject) }
-      let(:gate) { feature.gate(:boolean)}
+        Flipper::Adapters::ActiveRecord::Gate.create!(
+          feature_key: "foo",
+          key: "actors",
+          value: "Organization;4",
+        )
 
-      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)
+        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.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 'requiring "flipper-active_record"' do
+        before do
+          Flipper.configuration = nil
+          Flipper.instance = nil
 
-    context "#enable/#disable set" do
-      let(:feature) { Flipper::Feature.new(:search, subject) }
-      let(:gate) { feature.gate(:group) }
+          silence { load 'flipper/adapters/active_record.rb' }
+        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 'configures itself' do
+          expect(Flipper.adapter.adapter).to be_a(Flipper::Adapters::ActiveRecord)
+        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 "ActiveRecord connection_pool" do
+        before do
+          ActiveRecord::Base.clear_active_connections!
+        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.features
+            expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+          end
+        end
+
+        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 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
+
+        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) }
+
+          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 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
     end
   end

data/test/adapters/active_record_test.rb

@@ -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,5 +1,4 @@
-require 'active_record'
-require 'rails/generators/test_case'
+require 'helper'
 require 'generators/flipper/active_record_generator'
 
 class FlipperActiveRecordGeneratorTest < Rails::Generators::TestCase
@@ -16,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
@@ -26,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,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-09 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ metadata:
   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/blob/main/Changelog.md
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.2.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -90,10 +90,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 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