flipper-active_record 1.3.3 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45c10d391c587e3416261de98fd324e912f4406d1f436fc44acadf3720ab6bd0
-  data.tar.gz: d150526b605738b91bc37a0c7dab8964ad4b2ddcfa07bc5400739074e39af73b
+  metadata.gz: 6db1458b33ebce656ac2fd6a0aadeb5e2547b5cd346644ec64cf54034f93a461
+  data.tar.gz: ab9c8dee420bef036736f998a99411a89c70cdc794cdb96ec0af355a5a682902
 SHA512:
-  metadata.gz: 72806c21616f5fe5abc4696898b8e0071ab23930c5789c88e235f71f5aa578e8814b19d1a292c8a58863a6666a2b50e00e79034b1277708896ae2f9f44099b99
-  data.tar.gz: b6f5e80ea899277afcb0cde6b1ffeaed61171a2dc82ade9cc732dfb51f6f055bda327e8f9bacb5bbfb7f1e03fc33ad89e99c1c9fe863a21a5385049cc3cd00c0
+  metadata.gz: 4f8a73e94ebfdb0b1547ec276880c3c57e1b79320036af3f75c34bf6e8a1743b3a245351f5eaed5f4f4ed643a9bec6c8cec8954d1e2ac91ae71660b00c5a079d
+  data.tar.gz: a39fbf5b9517806fbaf22e303663ddd33e0a974d7e9913f5793c4ac3ef74cf9aa23782d4dacdad256b672c3a4dcc65b12aabb8520c30490147bf10449039631b

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/lib/flipper/adapters/active_record.rb

@@ -8,40 +8,37 @@ module Flipper
     class ActiveRecord
       include ::Flipper::Adapter
 
-      ActiveSupport.on_load(:active_record) do
-        # Abstract base class for internal models
-        class Model < ::ActiveRecord::Base
-          self.abstract_class = true
-        end
+      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
+      # 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"
+        has_many :gates, foreign_key: "feature_key", primary_key: "key"
 
-          validates :key, presence: true
-        end
+        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
+        validates :feature_key, presence: true
+        validates :key, presence: true
       end
 
       VALUE_TO_TEXT_WARNING = <<-EOS
-        Your database needs migrated to use the latest Flipper features.
+        Your database needs to be migrated to use the latest Flipper features.
         Run `rails generate flipper:update` and `rails db:migrate`.
       EOS
 
@@ -59,10 +56,8 @@ module Flipper
       # can roll your own tables and what not, if you so desire.
       def initialize(options = {})
         @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?
+        @feature_class = options.fetch(:feature_class) { Flipper::Adapters::ActiveRecord::Feature }
+        @gate_class = options.fetch(:gate_class) { Flipper::Adapters::ActiveRecord::Gate }
       end
 
       # Public: The set of known features.
@@ -289,15 +284,23 @@ module Flipper
       # 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
+        with_connection(@gate_class) do |connection|
+          @gate_class.column_for_attribute(:value).type != :text
+        end
       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)
+        warn VALUE_TO_TEXT_WARNING if !warned_about_value_not_text? && value_not_text?
         model.connection_pool.with_connection(&block)
       end
+
+      def warned_about_value_not_text?
+        return @warned_about_value_not_text if defined?(@warned_about_value_not_text)
+        @warned_about_value_not_text = true
+      end
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,5 +1,5 @@
 module Flipper
-  VERSION = '1.3.3'.freeze
+  VERSION = '1.3.5'.freeze
 
   REQUIRED_RUBY_VERSION = '2.6'.freeze
   NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.5
 platform: ruby
 authors:
 - John Nunemaker
 bindir: bin
 cert_chain: []
-date: 2025-02-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: 1.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.3
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -54,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
@@ -72,7 +73,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/releases/tag/v1.3.3
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.5
   funding_uri: https://github.com/sponsors/flippercloud
 rdoc_options: []
 require_paths:
@@ -88,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.9
 specification_version: 4
 summary: ActiveRecord feature flag adapter for Flipper
 test_files: