flipper-active_record 1.3.2 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75b48b94a5b6100e328025853743e12db745d9d862421035821e4a2a351355bc
-  data.tar.gz: a02ebf011fa0786f273a2279ac7f55cffe41f7869b84db61ff16e6eb9d3de2a6
+  metadata.gz: ae15abe1a25ef415ec5f7783b24192ae52cbf86b6d8e8026a7b23d3182db2ea3
+  data.tar.gz: 92c793efbd0539545f73d363f61df2f3a43d949aafb0bb303ecb5d8a747e660a
 SHA512:
-  metadata.gz: 490824ee74e62f12e676c76368e8f4746339909ed77208be8b0686ced9f8d4bdc0ee8c0c4be110ba1dd94de172bdd0baf05edfcec0344a240a0ffa05ee3a6352
-  data.tar.gz: a1eddef416ddf2ea95b02b09b018958dd488da5d04fb0aae04f3ce31b789e1072eaae1e2763b495f1e795880667dabcfcf24adb5baf69ddb47209c8e3fa5da4c
+  metadata.gz: a01ae2b84eea1af1a46ed86a0727a38418ec88682fddf0e8829e340f39e368adf7e3451e07b05efc423d874cc6bf70910bfc7afe61267db84c6e8ef90d6f1764
+  data.tar.gz: 280adedbab88143432826be99f65e17673f9bc0012ddb4c89392b32c6dd2c6ec9ce71a68bf1f79dce2347a631afc5d0f3804092ddbd2d6ef6906fb2af6142534

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/version.rb

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

data/spec/flipper/adapters/active_record_spec.rb

@@ -9,9 +9,10 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
 
   before(:all) do
     # 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')))
+    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(binding) # defines CreateFlipperTables
+    eval migration.result_with_hash(migration_version: migration_version) # defines CreateFlipperTables
   end
 
   [
@@ -52,8 +53,10 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
         end
 
         before(:each) do
-          ActiveRecord::Tasks::DatabaseTasks.purge(config)
-          CreateFlipperTables.migrate(:up)
+          silence do
+            ActiveRecord::Tasks::DatabaseTasks.purge(config)
+            CreateFlipperTables.migrate(:up)
+          end
         end
 
         after(:all) do

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.4
 platform: ruby
 authors:
 - John Nunemaker
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-19 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: 1.3.2
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +43,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
-description:
 email: support@flippercloud.io
 executables: []
 extensions: []
@@ -56,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
@@ -74,8 +73,8 @@ 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.2
-post_install_message:
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.4
+  funding_uri: https://github.com/sponsors/flippercloud
 rdoc_options: []
 require_paths:
 - lib
@@ -90,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: ActiveRecord feature flag adapter for Flipper
 test_files: