flipper 1.1.1 → 1.2.0

data/test_rails/generators/flipper/setup_generator_test.rb

@@ -0,0 +1,64 @@
+require "helper"
+require "generators/flipper/setup_generator"
+
+class SetupGeneratorTest < Rails::Generators::TestCase
+  tests Flipper::Generators::SetupGenerator
+  ROOT = File.expand_path("../../../tmp/generators", __dir__)
+  destination ROOT
+  setup :prepare_destination
+
+  test "invokes flipper:active_record generator if ActiveRecord adapter defined" do
+    begin
+      load 'flipper/adapters/active_record.rb'
+      run_generator
+      assert_migration "db/migrate/create_flipper_tables.rb"
+    ensure
+      Flipper::Adapters.send(:remove_const, :ActiveRecord)
+    end
+  end
+
+  test "does not invoke flipper:active_record generator if ActiveRecord adapter not defined" do
+    # Ensure adapter not defined
+    Flipper::Adapters.send(:remove_const, :ActiveRecord) rescue nil
+
+    run_generator
+    assert_no_migration "db/migrate/create_flipper_tables.rb"
+  end
+
+  %w(.env.development .env.local .env).each do |file|
+    test "configures Flipper Cloud token in #{file} if it exists" do
+      File.write("#{ROOT}/#{file}", "")
+      run_generator %w(--token abc123)
+      assert_file file, /^FLIPPER_CLOUD_TOKEN=abc123$/m
+    end
+  end
+
+  test "configures Flipper Cloud token in .env.development before .env" do
+    File.write("#{ROOT}/.env.development", "")
+    File.write("#{ROOT}/.env", "")
+
+    run_generator %w(--token abc123)
+    assert_file ".env.development", /^FLIPPER_CLOUD_TOKEN=abc123$/m
+    assert_file ".env", ""
+  end
+
+  test "does not write to .env if no token provided" do
+    File.write("#{ROOT}/.env", "")
+    run_generator
+    assert_file ".env", ""
+  end
+
+  test "configures Flipper Cloud token in config/credentials.yml.enc if credentials.yml.enc exist" do
+    Dir.chdir(ROOT) do
+      FileUtils.mkdir_p("config")
+      ENV["RAILS_MASTER_KEY"] = "a" * 32
+      Rails.application = Class.new(Rails::Application)
+      Rails.application.credentials.write("")
+
+      run_generator %w(--token abc123)
+      assert_file "config/credentials.yml.enc"
+      expected_config = { flipper: { cloud_token: "abc123" } }
+      assert_equal expected_config, Rails.application.credentials.config
+    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

data/test_rails/system/test_help_test.rb

@@ -0,0 +1,46 @@
+require_relative "../helper"
+
+# Not worth trying to test on old Rails versions
+return unless Rails::VERSION::MAJOR >= 7
+
+require "capybara/cuprite"
+require "flipper"
+require "flipper/test_help"
+
+require 'action_dispatch/system_testing/server'
+ActionDispatch::SystemTesting::Server.silence_puma = true
+
+class TestApp < Rails::Application
+  config.load_defaults "#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}"
+  config.eager_load = false
+  config.logger = ActiveSupport::Logger.new(StringIO.new)
+  routes.append do
+    root to: "features#index"
+  end
+end
+
+TestApp.initialize!
+
+class FeaturesController < ActionController::Base
+  def index
+    render json: Flipper.enabled?(:test) ? "Enabled" : "Disabled"
+  end
+end
+
+class TestHelpTest < ActionDispatch::SystemTestCase
+  # Any driver that runs the app in a separate thread will test what we want here.
+  driven_by :cuprite
+
+  # Ensure this test uses this app instance
+  setup { Rails.application = TestApp.instance }
+
+  test "configures a shared adapter between tests and app" do
+    Flipper.disable(:test)
+    visit "/"
+    assert_selector "*", text: "Disabled"
+
+    Flipper.enable(:test)
+    visit "/"
+    assert_selector "*", text: "Enabled"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-12-09 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -26,7 +26,8 @@ dependencies:
         version: '2'
 description:
 email: support@flippercloud.io
-executables: []
+executables:
+- flipper
 extensions: []
 extra_rdoc_files: []
 files:
@@ -82,6 +83,7 @@ files:
 - examples/percentage_of_actors_group.rb
 - examples/percentage_of_time.rb
 - examples/strict.rb
+- exe/flipper
 - flipper-cloud.gemspec
 - flipper.gemspec
 - lib/flipper.rb
@@ -107,6 +109,7 @@ files:
 - lib/flipper/adapters/sync/feature_synchronizer.rb
 - lib/flipper/adapters/sync/interval_synchronizer.rb
 - lib/flipper/adapters/sync/synchronizer.rb
+- lib/flipper/cli.rb
 - lib/flipper/cloud.rb
 - lib/flipper/cloud/configuration.rb
 - lib/flipper/cloud/dsl.rb
@@ -176,6 +179,7 @@ files:
 - lib/flipper/serializers/json.rb
 - lib/flipper/spec/shared_adapter_specs.rb
 - lib/flipper/test/shared_adapter_test.rb
+- lib/flipper/test_help.rb
 - lib/flipper/type.rb
 - lib/flipper/typecast.rb
 - lib/flipper/types/actor.rb
@@ -185,6 +189,11 @@ files:
 - lib/flipper/types/percentage_of_actors.rb
 - lib/flipper/types/percentage_of_time.rb
 - lib/flipper/version.rb
+- lib/generators/flipper/setup_generator.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/environment.rb
 - spec/fixtures/feature.json
 - spec/fixtures/flipper_pstore_1679087600.json
 - spec/flipper/actor_spec.rb
@@ -193,6 +202,7 @@ files:
 - spec/flipper/adapters/dual_write_spec.rb
 - spec/flipper/adapters/failover_spec.rb
 - spec/flipper/adapters/failsafe_spec.rb
+- spec/flipper/adapters/http/client_spec.rb
 - spec/flipper/adapters/http_spec.rb
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb
@@ -205,6 +215,7 @@ files:
 - spec/flipper/adapters/sync/interval_synchronizer_spec.rb
 - spec/flipper/adapters/sync/synchronizer_spec.rb
 - spec/flipper/adapters/sync_spec.rb
+- spec/flipper/cli_spec.rb
 - spec/flipper/cloud/configuration_spec.rb
 - spec/flipper/cloud/dsl_spec.rb
 - spec/flipper/cloud/message_verifier_spec.rb
@@ -284,7 +295,10 @@ files:
 - test/adapters/memory_test.rb
 - test/adapters/pstore_test.rb
 - test/test_helper.rb
+- test_rails/generators/flipper/setup_generator_test.rb
+- test_rails/generators/flipper/update_generator_test.rb
 - test_rails/helper.rb
+- test_rails/system/test_help_test.rb
 homepage: https://www.flippercloud.io/docs
 licenses:
 - MIT
@@ -293,7 +307,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/blob/main/Changelog.md
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.2.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -302,18 +316,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 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/environment.rb
 - spec/fixtures/feature.json
 - spec/fixtures/flipper_pstore_1679087600.json
 - spec/flipper/actor_spec.rb
@@ -322,6 +337,7 @@ test_files:
 - spec/flipper/adapters/dual_write_spec.rb
 - spec/flipper/adapters/failover_spec.rb
 - spec/flipper/adapters/failsafe_spec.rb
+- spec/flipper/adapters/http/client_spec.rb
 - spec/flipper/adapters/http_spec.rb
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb
@@ -334,6 +350,7 @@ test_files:
 - spec/flipper/adapters/sync/interval_synchronizer_spec.rb
 - spec/flipper/adapters/sync/synchronizer_spec.rb
 - spec/flipper/adapters/sync_spec.rb
+- spec/flipper/cli_spec.rb
 - spec/flipper/cloud/configuration_spec.rb
 - spec/flipper/cloud/dsl_spec.rb
 - spec/flipper/cloud/message_verifier_spec.rb