flipper-active_record 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f11ba9f2e7fa94ab06ddddfc753ccb1b398ffc19023ab6b2f5a980ccb55bd974
-  data.tar.gz: 2566b337548372d8d080f732dbb2824b771f5c58e429ac350ceb0afb5455fea8
+  metadata.gz: 4c4aa6610a01147dbc81d8e256344ecb508ee59fa87b74d6ad746de90d4306c5
+  data.tar.gz: a5c419782f0d82df4a417a5d5c89200fcc8322a8251f1cbba8c5628c40322aa2
 SHA512:
-  metadata.gz: 40e29c142239ff3a5f474f2f0dd6019d3bc60fcc4aaa76021715cf1dcb241c50c2d2dbf1e669cd5b2efcfa5f6740b40bea477988e25d6b5445ff4fcddd111173
-  data.tar.gz: 6d9c313e0402d1bd197a1abc17a1aa930296f8f854c132773bebc08c6dbf5fab49a2978a4df196267ca0e29af8b5277868458ba4a7d7a35feb4efdcdb44ed1e0
+  metadata.gz: 9fb31e98eb30ac6323ed1f9662ef49df1ba44c71e6006aade9b7c55c2d236be1e2b608e2e2c3a12c8ab5ba9e748fc5d56fd63d0f663a009820fee37184a26ff5
+  data.tar.gz: bc3fa0ec74c8af61b1e5b537d1fc16c973d555de8f3d75238c6e620a33527af65e143d8ceee9999666950d6bcc5b2110c481c4ad4036c7dc9d01d3b097fab420

data/lib/flipper/adapters/active_record.rb

@@ -19,6 +19,8 @@ module Flipper
           "flipper_features",
           Model.table_name_suffix,
         ].join
+
+        has_many :gates, foreign_key: "feature_key", primary_key: "key"
       end
 
       # Private: Do not use outside of this adapter.
@@ -30,8 +32,10 @@ module Flipper
         ].join
       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.
+        See https://github.com/flippercloud/flipper/issues/557
+      EOS
 
       # Public: Initialize a new ActiveRecord adapter instance.
       #
@@ -49,6 +53,8 @@ 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.
@@ -156,6 +162,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 +186,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,15 +208,20 @@ 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
             clear(feature) if clear_feature
+            delete(feature, gate)
             @gate_class.where(feature_key: feature.key, key: gate.key).destroy_all
             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
@@ -218,6 +233,10 @@ 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|
@@ -238,13 +257,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 +274,12 @@ 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
+      end
+
       def with_connection(model = @feature_class, &block)
         model.connection_pool.with_connection(&block)
       end

data/lib/flipper/model/active_record.rb

@@ -0,0 +1,23 @@
+module Flipper
+  module Model
+    module ActiveRecord
+      # The id of the record when used as an actor.
+      #
+      #   class User < ActiveRecord::Base
+      #   end
+      #
+      #   user = User.first
+      #   Flipper.enable :some_feature, user
+      #   Flipper.enabled? :some_feature, user #=> true
+      #
+      def flipper_id
+        "#{self.class.base_class.name};#{id}"
+      end
+
+      # Properties used to evaluate expressions
+      def flipper_properties
+        {"type" => self.class.name}.merge(attributes)
+      end
+    end
+  end
+end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

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

@@ -9,7 +9,7 @@ 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

data/spec/flipper/adapters/active_record_spec.rb

@@ -1,4 +1,5 @@
 require 'flipper/adapters/active_record'
+require 'active_support/core_ext/kernel'
 
 # Turn off migration logging for specs
 ActiveRecord::Migration.verbose = false
@@ -15,7 +16,7 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
     ActiveRecord::Base.connection.execute <<-SQL
       CREATE TABLE flipper_features (
         id integer PRIMARY KEY,
-        key text NOT NULL UNIQUE,
+        key string NOT NULL UNIQUE,
         created_at datetime NOT NULL,
         updated_at datetime NOT NULL
       )
@@ -25,7 +26,7 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
       CREATE TABLE flipper_gates (
         id integer PRIMARY KEY,
         feature_key text NOT NULL,
-        key text NOT NULL,
+        key string NOT NULL,
         value text DEFAULT NULL,
         created_at datetime NOT NULL,
         updated_at datetime NOT NULL
@@ -44,13 +45,24 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
 
   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
 
-      load 'flipper/adapters/active_record.rb'
-      ActiveSupport.run_load_hooks(:active_record, ActiveRecord::Base)
+      silence_warnings { load 'flipper/adapters/active_record.rb' }
     end
 
     it 'configures itself' do

data/spec/flipper/model/active_record_spec.rb

@@ -0,0 +1,61 @@
+require 'active_record'
+require 'flipper/model/active_record'
+
+# Turn off migration logging for specs
+ActiveRecord::Migration.verbose = false
+
+RSpec.describe Flipper::Model::ActiveRecord do
+  before(:all) do
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+  end
+
+  before(:each) do
+    ActiveRecord::Base.connection.execute <<-SQL
+      CREATE TABLE users (
+        id integer PRIMARY KEY,
+        name string NOT NULL,
+        age integer,
+        is_confirmed boolean,
+        created_at datetime NOT NULL,
+        updated_at datetime NOT NULL
+      )
+    SQL
+  end
+
+  after(:each) do
+    ActiveRecord::Base.connection.execute("DROP table IF EXISTS `users`")
+  end
+
+  class User < ActiveRecord::Base
+    include Flipper::Model::ActiveRecord
+  end
+
+  class Admin < User
+  end
+
+  describe "flipper_id" do
+    it "returns class name and id" do
+      expect(User.new(id: 1).flipper_id).to eq("User;1")
+    end
+
+    it "uses base class name" do
+      expect(Admin.new(id: 2).flipper_id).to eq("User;2")
+    end
+  end
+
+  describe "flipper_properties" do
+    subject { User.create!(name: "Test", age: 22, is_confirmed: true) }
+
+    it "includes all attributes" do
+      expect(subject.flipper_properties).to eq({
+        "type" => "User",
+        "id" => subject.id,
+        "name" => "Test",
+        "age" => 22,
+        "is_confirmed" => true,
+        "created_at" => subject.created_at,
+        "updated_at" => subject.updated_at
+      })
+    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

data/test_rails/generators/flipper/active_record_generator_test.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'active_record'
 require 'rails/generators/test_case'
 require 'generators/flipper/active_record_generator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-23 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -60,10 +60,12 @@ files:
 - flipper-active_record.gemspec
 - lib/flipper-active_record.rb
 - lib/flipper/adapters/active_record.rb
+- lib/flipper/model/active_record.rb
 - lib/flipper/version.rb
 - lib/generators/flipper/active_record_generator.rb
 - lib/generators/flipper/templates/migration.erb
 - spec/flipper/adapters/active_record_spec.rb
+- spec/flipper/model/active_record_spec.rb
 - test/adapters/active_record_test.rb
 - test_rails/generators/flipper/active_record_generator_test.rb
 homepage: https://www.flippercloud.io/docs/adapters/active-record
@@ -96,4 +98,5 @@ specification_version: 4
 summary: ActiveRecord adapter for Flipper
 test_files:
 - spec/flipper/adapters/active_record_spec.rb
+- spec/flipper/model/active_record_spec.rb
 - test/adapters/active_record_test.rb