flipper-sequel 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9edc87b55cd1a0a7581687a82a5f00508735a2c97984f4c489b10c1e14900ca9
-  data.tar.gz: 29abd2bb586f0fbaa3078576bbe62cecfb4ca665585320f908ee44aa229a409a
+  metadata.gz: 3519a5c581ad82919b61c95bf34cbd7a49175dac13264c7af7d45d0430619ba2
+  data.tar.gz: eb1ef47eab6e6e7d253a2aa066ac1aae9c8ef7e32f3d964fcec2749f9894ac58
 SHA512:
-  metadata.gz: be28416559c7acb7a951e32a328340eb26644024c4a04b90f78ff5635da668ee92770fb4e62473a8d71ff4f893f30cbc10ac47d7bb5692604e13413785165602
-  data.tar.gz: 752e9f662dde7b2b6c68863e0e791cfcb34dc07613b316a1f79428bf2210bf85676d14d7baa3b8dc2453d318922a7644c764553ad0a9f85aea62f2584150b1af
+  metadata.gz: c7167b1b5af764176e44702c78f7a8c3994588eef2c47670aa6614908f2cda14d66b9e881f49f9b35ba8f853f5b1ae8c11c004ca7a9fb701e66887f2a935a219
+  data.tar.gz: dc2607e6ecc423924b5886a3bcaef3a58f9ba9f220dbcbeb3297178f6b4ca0214ad62f72528044df07bcac9850c8c25110ee248c1ea728350be780f87cba8f04

data/lib/flipper/adapters/sequel.rb

@@ -1,6 +1,7 @@
 require 'set'
 require 'flipper'
 require 'sequel'
+require 'flipper/model/sequel'
 
 module Flipper
   module Adapters
@@ -28,12 +29,14 @@ module Flipper
         ::Sequel::Model.require_valid_table = old
       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 Sequel adapter instance.
       #
-      # name - The Symbol name for this adapter. Optional (default :active_record)
+      # name - The Symbol name for this adapter. Optional (default :sequel)
       # feature_class - The AR class responsible for the features table.
       # gate_class - The AR class responsible for the gates table.
       #
@@ -47,6 +50,8 @@ module Flipper
         @name = options.fetch(:name, :sequel)
         @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.
@@ -129,10 +134,9 @@ module Flipper
         when :integer
           set(feature, gate, thing)
         when :set
-          begin
-            @gate_class.create(gate_attrs(feature, gate, thing))
-          rescue ::Sequel::UniqueConstraintViolation
-          end
+          enable_multi(feature, gate, thing)
+        when :json
+          set(feature, gate, thing, json: true)
         else
           unsupported_data_type gate.data_type
         end
@@ -153,9 +157,10 @@ module Flipper
           clear(feature)
         when :integer
           set(feature, gate, thing)
+        when :json
+          delete(feature, gate)
         when :set
-          @gate_class.where(gate_attrs(feature, gate, thing))
-                     .delete
+          @gate_class.where(gate_attrs(feature, gate, thing, json: gate.data_type == :json)).delete
         else
           unsupported_data_type gate.data_type
         end
@@ -171,27 +176,37 @@ module Flipper
 
       def set(feature, gate, thing, options = {})
         clear_feature = options.fetch(:clear, false)
-        args = {
-          feature_key: feature.key,
-          key: gate.key.to_s,
-        }
+        json_feature = options.fetch(:json, false)
+
+        raise VALUE_TO_TEXT_WARNING if json_feature && value_not_text?
 
         @gate_class.db.transaction do
           clear(feature) if clear_feature
-          @gate_class.where(args).delete
+          delete(feature, gate)
 
           begin
-            @gate_class.create(gate_attrs(feature, gate, thing))
+            @gate_class.create(gate_attrs(feature, gate, thing, json: json_feature))
           rescue ::Sequel::UniqueConstraintViolation
           end
         end
       end
 
-      def gate_attrs(feature, gate, thing)
+      def delete(feature, gate)
+        @gate_class.where(feature_key: feature.key, key: gate.key.to_s).delete
+      end
+
+      def enable_multi(feature, gate, thing)
+        begin
+          @gate_class.create(gate_attrs(feature, gate, thing, json: gate.data_type == :json))
+        rescue ::Sequel::UniqueConstraintViolation
+        end
+      end
+
+      def gate_attrs(feature, gate, thing, json: false)
         {
           feature_key: feature.key.to_s,
           key: gate.key.to_s,
-          value: thing.value.to_s,
+          value: json ? Typecast.to_json(thing.value) : thing.value.to_s,
         }
       end
 
@@ -210,11 +225,21 @@ module Flipper
               end
             when :set
               db_gates.select { |db_gate| db_gate.key == gate.key.to_s }.map(&:value).to_set
+            when :json
+              if detected_db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s }
+                Typecast.from_json(detected_db_gate.value)
+              end
             else
               unsupported_data_type gate.data_type
             end
         end
       end
+
+      # Check if value column is text instead of string
+      # See https://github.com/flippercloud/flipper/pull/692
+      def value_not_text?
+        "text".casecmp(@gate_class.db_schema[:value][:db_type]) != 0
+      end
     end
   end
 end
@@ -223,4 +248,4 @@ Flipper.configure do |config|
   config.adapter { Flipper::Adapters::Sequel.new }
 end
 
-Sequel::Model.include Flipper::Identifier
+Sequel::Model.include Flipper::Model::Sequel

data/lib/flipper/model/sequel.rb

@@ -0,0 +1,12 @@
+module Flipper
+  module Model
+    module Sequel
+      include Flipper::Identifier
+
+      # Properties used to evaluate expressions
+      def flipper_properties
+        {"type" => self.class.name}.update(to_hash.transform_keys(&:to_s))
+      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/sequel_migration.rb

@@ -9,7 +9,7 @@ class CreateFlipperTablesSequel < Sequel::Migration
     create_table :flipper_gates do |_t|
       String :feature_key, null: false
       String :key, null: false
-      String :value
+      String :value, text: true
       DateTime :created_at, null: false
       DateTime :updated_at, null: false
       primary_key [:feature_key, :key, :value]

data/spec/flipper/adapters/sequel_spec.rb

@@ -42,5 +42,9 @@ RSpec.describe Flipper::Adapters::Sequel do
     it "defines #flipper_id on Sequel::Model" do
       expect(Sequel::Model.ancestors).to include(Flipper::Identifier)
     end
+
+    it "defines #flipper_properties on Sequel::Model" do
+      expect(Sequel::Model.ancestors).to include(Flipper::Model::Sequel)
+    end
   end
 end

data/spec/flipper/model/sequel_spec.rb

@@ -0,0 +1,46 @@
+require 'flipper/model/sequel'
+
+RSpec.describe Flipper::Model::Sequel do
+  before(:each) do
+    Sequel::Model.db.run <<-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
+
+    @User = Class.new(::Sequel::Model(:users)) do
+      include Flipper::Model::Sequel
+      plugin :timestamps, update_on_create: true
+
+
+      def self.name
+        'User'
+      end
+    end
+  end
+
+  after(:each) do
+    Sequel::Model.db.run("DROP table IF EXISTS `users`")
+  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/spec/support/sequel_setup.rb

@@ -0,0 +1,5 @@
+# Setup sequel for sequel adapter and model specs. We don't want this to happen
+# multiple times or it causes failures. So it lives here.
+require "sequel"
+Sequel::Model.db = Sequel.sqlite(':memory:')
+Sequel.extension :migration, :core_extensions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-sequel
 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: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -55,9 +55,12 @@ files:
 - flipper-sequel.gemspec
 - lib/flipper-sequel.rb
 - lib/flipper/adapters/sequel.rb
+- lib/flipper/model/sequel.rb
 - lib/flipper/version.rb
 - lib/generators/flipper/templates/sequel_migration.rb
 - spec/flipper/adapters/sequel_spec.rb
+- spec/flipper/model/sequel_spec.rb
+- spec/support/sequel_setup.rb
 - test/adapters/sequel_test.rb
 homepage: https://www.flippercloud.io/docs/adapters/sequel
 licenses:
@@ -89,4 +92,6 @@ specification_version: 4
 summary: Sequel adapter for Flipper
 test_files:
 - spec/flipper/adapters/sequel_spec.rb
+- spec/flipper/model/sequel_spec.rb
+- spec/support/sequel_setup.rb
 - test/adapters/sequel_test.rb