flipper 1.1.0 → 1.1.2

data/Gemfile

@@ -25,6 +25,8 @@ gem 'benchmark-ips'
 gem 'stackprof-webnav'
 gem 'flamegraph'
 gem 'climate_control'
+gem 'mysql2'
+gem 'pg'
 
 group(:guard) do
   gem 'guard'

data/README.md

@@ -4,14 +4,14 @@
 
 # Flipper
 
-> Beautiful, performant feature flags for Ruby.
+> Beautiful, performant feature flags for Ruby and Rails.
 
 Flipper gives you control over who has access to features in your app.
 
-* Enable or disable features for everyone, specific actors, groups of actors, a percentage of actors, or a percentage of time.
-* Configure your feature flags from the console or a web UI.
-* Regardless of what data store you are using, Flipper can performantly store your feature flags.
-* Use [Flipper Cloud](#flipper-cloud) to cascade features from multiple environments, share settings with your team, control permissions, keep an audit history, and rollback.
+- Enable or disable features for everyone, specific actors, groups of actors, a percentage of actors, or a percentage of time.
+- Configure your feature flags from the console or a web UI.
+- Regardless of what data store you are using, Flipper can performantly store your feature flags.
+- Use [Flipper Cloud](#flipper-cloud) to cascade features from multiple environments, share settings with your team, control permissions, keep an audit history, and rollback.
 
 Control your software — don't let it control you.
 
@@ -72,13 +72,13 @@ Read more about [getting started with Flipper](https://flippercloud.io/docs?utm_
 
 Like Flipper and want more? Check out [Flipper Cloud](https://www.flippercloud.io?utm_source=oss&utm_medium=readme&utm_campaign=check_out), which comes with:
 
-* **multiple environments** — production, staging, per continent, whatever you need. Every environment inherits from production by default and every project comes with a [project overview page](https://blog.flippercloud.io/project-overview/) that shows each feature and its status in each environment.
-* **personal environments** — everyone on your team gets a personal environment (that inherits from production) which they can modify however they want without stepping on anyone else's toes.
-* **permissions** — grant access to everyone in your organization or lockdown each project to particular people. You can even limit access to a particular environment (like production) to specific people.
-* **audit history** — every feature change and who made it.
-* **rollbacks** — enable or disable a feature accidentally? No problem. You can roll back to any point in the audit history with a single click.
-* **maintenance** — we'll keep the lights on for you. We also have handy webhooks and background polling for keeping your app in sync with Cloud, so **our availability won't affect yours**. All your feature flag reads are local to your app.
-* **everything in one place** — no need to bounce around from different application UIs or IRB consoles.
+- **multiple environments** — production, staging, per continent, whatever you need. Every environment inherits from production by default and every project comes with a [project overview page](https://blog.flippercloud.io/project-overview/) that shows each feature and its status in each environment.
+- **personal environments** — everyone on your team gets a personal environment (that inherits from production) which they can modify however they want without stepping on anyone else's toes.
+- **permissions** — grant access to everyone in your organization or lockdown each project to particular people. You can even limit access to a particular environment (like production) to specific people.
+- **audit history** — every feature change and who made it.
+- **rollbacks** — enable or disable a feature accidentally? No problem. You can roll back to any point in the audit history with a single click.
+- **maintenance** — we'll keep the lights on for you. We also have handy webhooks and background polling for keeping your app in sync with Cloud, so **our availability won't affect yours**. All your feature flag reads are local to your app.
+- **everything in one place** — no need to bounce around from different application UIs or IRB consoles.
 
 [![Flipper Cloud Screenshot](docs/images/flipper_cloud.png)](https://www.flippercloud.io?utm_source=oss&utm_medium=readme&utm_campaign=screenshot)
 
@@ -103,11 +103,11 @@ We also have a [free plan](https://www.flippercloud.io?utm_source=oss&utm_medium
 
 ## Brought To You By
 
-| pic | @mention | area |
-|---|---|---|
-| ![@jnunemaker](https://avatars3.githubusercontent.com/u/235?s=64) | [@jnunemaker](https://github.com/jnunemaker) | most things |
-| ![@bkeepers](https://avatars3.githubusercontent.com/u/173?s=64) | [@bkeepers](https://github.com/bkeepers) | most things |
-| ![@dpep](https://avatars3.githubusercontent.com/u/918804?s=64) | [@dpep](https://github.com/dpep) | tbd |
-| ![@alexwheeler](https://avatars3.githubusercontent.com/u/3260042?s=64) | [@alexwheeler](https://github.com/alexwheeler) | api |
-| ![@thetimbanks](https://avatars1.githubusercontent.com/u/471801?s=64) | [@thetimbanks](https://github.com/thetimbanks) | ui |
-| ![@lazebny](https://avatars1.githubusercontent.com/u/6276766?s=64) | [@lazebny](https://github.com/lazebny) | docker |
+| pic                                                                    | @mention                                       | area        |
+| ---------------------------------------------------------------------- | ---------------------------------------------- | ----------- |
+| ![@jnunemaker](https://avatars3.githubusercontent.com/u/235?s=64)      | [@jnunemaker](https://github.com/jnunemaker)   | most things |
+| ![@bkeepers](https://avatars3.githubusercontent.com/u/173?s=64)        | [@bkeepers](https://github.com/bkeepers)       | most things |
+| ![@dpep](https://avatars3.githubusercontent.com/u/918804?s=64)         | [@dpep](https://github.com/dpep)               | tbd         |
+| ![@alexwheeler](https://avatars3.githubusercontent.com/u/3260042?s=64) | [@alexwheeler](https://github.com/alexwheeler) | api         |
+| ![@thetimbanks](https://avatars1.githubusercontent.com/u/471801?s=64)  | [@thetimbanks](https://github.com/thetimbanks) | ui          |
+| ![@lazebny](https://avatars1.githubusercontent.com/u/6276766?s=64)     | [@lazebny](https://github.com/lazebny)         | docker      |

data/flipper.gemspec

@@ -23,7 +23,7 @@ ignored_test_files.flatten!.uniq!
 Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
   gem.email         = 'support@flippercloud.io'
-  gem.summary       = 'Beautiful, performant feature flags for Ruby.'
+  gem.summary       = 'Beautiful, performant feature flags for Ruby and Rails.'
   gem.homepage      = 'https://www.flippercloud.io/docs'
   gem.license       = 'MIT'
 

data/lib/flipper/engine.rb

@@ -15,9 +15,8 @@ module Flipper
     end
 
     initializer "flipper.properties" do
-      require "flipper/model/active_record"
-
       ActiveSupport.on_load(:active_record) do
+        require "flipper/model/active_record"
         ActiveRecord::Base.include Flipper::Model::ActiveRecord
       end
     end
@@ -71,7 +70,7 @@ module Flipper
       !!ENV["FLIPPER_CLOUD_TOKEN"]
     end
 
-    def default_strict_value
+    def self.default_strict_value
       value = ENV["FLIPPER_STRICT"]
       if value.in?(["warn", "raise", "noop"])
         value.to_sym

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.1.0'.freeze
+  VERSION = '1.1.2'.freeze
 end

data/lib/generators/flipper/templates/update/migrations/01_create_flipper_tables.rb.erb

@@ -0,0 +1,22 @@
+class CreateFlipperTables < ActiveRecord::Migration<%= migration_version %>
+  def up
+    create_table :flipper_features do |t|
+      t.string :key, null: false
+      t.timestamps null: false
+    end
+    add_index :flipper_features, :key, unique: true
+
+    create_table :flipper_gates do |t|
+      t.string :feature_key, null: false
+      t.string :key, null: false
+      t.string :value
+      t.timestamps null: false
+    end
+    add_index :flipper_gates, [:feature_key, :key, :value], unique: true
+  end
+
+  def down
+    drop_table :flipper_gates
+    drop_table :flipper_features
+  end
+end

data/lib/generators/flipper/templates/update/migrations/02_change_flipper_gates_value_to_text.rb.erb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class ChangeFlipperGatesValueToText < ActiveRecord::Migration<%= migration_version %>
+  def up
+    # Ensure this incremental update migration is idempotent
+    return unless connection.column_exists? :flipper_gates, :value, :string
+
+    if index_exists? :flipper_gates, [:feature_key, :key, :value]
+      remove_index :flipper_gates, [:feature_key, :key, :value]
+    end
+    change_column :flipper_gates, :value, :text
+    add_index :flipper_gates, [:feature_key, :key, :value], unique: true, length: { value: 255 }
+  end
+
+  def down
+    change_column :flipper_gates, :value, :string
+  end
+end

data/lib/generators/flipper/update_generator.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Flipper
+  module Generators
+    #
+    # Rails generator used for updating Flipper in a Rails application.
+    # Run it with +bin/rails g flipper:update+ in your console.
+    #
+    class UpdateGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      TEMPLATES = File.join(File.dirname(__FILE__), 'templates/update')
+      source_paths << TEMPLATES
+
+      # Generates incremental migration files unless they already exist.
+      # All migrations should be idempotent e.g. +add_index+ is guarded with +if_index_exists?+
+      def update_migration_files
+        migration_templates = Dir.children(File.join(TEMPLATES, 'migrations')).sort
+        migration_templates.each do |template_file|
+          destination_file = template_file.match(/^\d*_(.*\.rb)/)[1] # 01_create_flipper_tables.rb.erb => create_flipper_tables.rb
+          migration_template "migrations/#{template_file}", File.join(db_migrate_path, destination_file), skip: true
+        end
+      end
+
+      private
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::STRING.to_f}]"
+      end
+    end
+  end
+end

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_rails/generators/flipper/update_generator_test.rb

@@ -0,0 +1,96 @@
+require "helper"
+require "generators/flipper/update_generator"
+
+class UpdateGeneratorTest < Rails::Generators::TestCase
+  tests Flipper::Generators::UpdateGenerator
+  ROOT = File.expand_path("../../../../tmp/generators", __FILE__)
+  destination ROOT
+  setup :prepare_destination
+
+  setup do
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+  end
+
+  teardown do
+    ActiveRecord::Base.connection.close
+  end
+
+  test "generates migrations" do
+    run_generator
+
+    assert_migration "db/migrate/create_flipper_tables.rb" do |migration|
+      assert_method :up, migration do |up|
+        assert_match(/create_table :flipper_features/, up)
+        assert_match(/create_table :flipper_gates/, up)
+      end
+
+      assert_method :down, migration do |down|
+        assert_match(/drop_table :flipper_features/, down)
+        assert_match(/drop_table :flipper_gates/, down)
+      end
+    end
+
+    assert_migration "db/migrate/change_flipper_gates_value_to_text.rb" do |migration|
+      [:up, :down].each do |dir|
+        assert_method :up, migration do |method|
+          assert_match(/change_column/, method)
+        end
+      end
+    end
+
+    require_migrations
+
+    silence { CreateFlipperTables.migrate(:up) }
+    assert ActiveRecord::Base.connection.table_exists?(:flipper_features)
+    assert ActiveRecord::Base.connection.table_exists?(:flipper_gates)
+
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :string)
+    silence { ChangeFlipperGatesValueToText.migrate(:up) }
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :text)
+
+    silence { ChangeFlipperGatesValueToText.migrate(:down) }
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :string)
+
+    silence { CreateFlipperTables.migrate(:down) }
+    refute ActiveRecord::Base.connection.table_exists?(:flipper_features)
+    refute ActiveRecord::Base.connection.table_exists?(:flipper_gates)
+  end
+
+  test "ChangeFlipperGatesValueToText is a noop if value is already text" do
+    self.class.generator_class = Flipper::Generators::ActiveRecordGenerator
+    run_generator
+
+    self.class.generator_class = Flipper::Generators::UpdateGenerator
+    run_generator
+
+    assert_migration "db/migrate/create_flipper_tables.rb" do |migration|
+      assert_method :up, migration do |up|
+        assert_match /text :value/, up
+      end
+    end
+
+    assert_migration "db/migrate/change_flipper_gates_value_to_text.rb"
+
+    require_migrations
+
+    silence { CreateFlipperTables.migrate(:up) }
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :text)
+
+    assert_nothing_raised do
+      silence { ChangeFlipperGatesValueToText.migrate(:up) }
+    end
+    assert ActiveRecord::Base.connection.column_exists?(:flipper_gates, :value, :text)
+  end
+
+  def require_migrations
+    # If these are not reloaded, then test order can cause failures
+    Object.send(:remove_const, :CreateFlipperTables) if defined?(::CreateFlipperTables)
+    Object.send(:remove_const, :ChangeFlipperGatesValueToText) if defined?(::ChangeFlipperGatesValueToText)
+
+    Dir.glob("#{ROOT}/db/migrate/*.rb").each do |file|
+      assert_nothing_raised do
+        load file
+      end
+    end
+  end
+end

data/test_rails/helper.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
-require 'bundler'
-Bundler.setup(:default)
+require 'bundler/setup'
+require 'minitest/autorun'
 require 'rails'
 require 'rails/test_help'
 
@@ -9,3 +9,20 @@ begin
 rescue NoMethodError
   # no biggie, means we are on older version of AS that doesn't have this option
 end
+
+def silence
+  # Store the original stderr and stdout in order to restore them later
+  original_stderr = $stderr
+  original_stdout = $stdout
+
+  # Redirect stderr and stdout
+  output = $stderr = $stdout = StringIO.new
+
+  yield
+
+  $stderr = original_stderr
+  $stdout = original_stdout
+
+  # Return output
+  output.string
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -169,6 +169,7 @@ files:
 - lib/flipper/metadata.rb
 - lib/flipper/middleware/memoizer.rb
 - lib/flipper/middleware/setup_env.rb
+- lib/flipper/model/active_record.rb
 - lib/flipper/poller.rb
 - lib/flipper/registry.rb
 - lib/flipper/serializers/gzip.rb
@@ -184,6 +185,9 @@ files:
 - lib/flipper/types/percentage_of_actors.rb
 - lib/flipper/types/percentage_of_time.rb
 - lib/flipper/version.rb
+- lib/generators/flipper/templates/update/migrations/01_create_flipper_tables.rb.erb
+- lib/generators/flipper/templates/update/migrations/02_change_flipper_gates_value_to_text.rb.erb
+- lib/generators/flipper/update_generator.rb
 - spec/fixtures/feature.json
 - spec/fixtures/flipper_pstore_1679087600.json
 - spec/flipper/actor_spec.rb
@@ -258,6 +262,7 @@ files:
 - spec/flipper/instrumenters/noop_spec.rb
 - spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/middleware/setup_env_spec.rb
+- spec/flipper/model/active_record_spec.rb
 - spec/flipper/poller_spec.rb
 - spec/flipper/registry_spec.rb
 - spec/flipper/serializers/gzip_spec.rb
@@ -282,6 +287,7 @@ files:
 - test/adapters/memory_test.rb
 - test/adapters/pstore_test.rb
 - test/test_helper.rb
+- test_rails/generators/flipper/update_generator_test.rb
 - test_rails/helper.rb
 homepage: https://www.flippercloud.io/docs
 licenses:
@@ -310,7 +316,7 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Beautiful, performant feature flags for Ruby.
+summary: Beautiful, performant feature flags for Ruby and Rails.
 test_files:
 - spec/fixtures/feature.json
 - spec/fixtures/flipper_pstore_1679087600.json
@@ -386,6 +392,7 @@ test_files:
 - spec/flipper/instrumenters/noop_spec.rb
 - spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/middleware/setup_env_spec.rb
+- spec/flipper/model/active_record_spec.rb
 - spec/flipper/poller_spec.rb
 - spec/flipper/registry_spec.rb
 - spec/flipper/serializers/gzip_spec.rb