flipper 1.1.2 → 1.2.2

data/spec/flipper/instrumentation/log_subscriber_spec.rb

@@ -1,6 +1,6 @@
 require 'logger'
-require 'flipper/adapters/instrumented'
 require 'flipper/instrumentation/log_subscriber'
+require 'flipper/adapters/instrumented'
 
 begin
   require 'active_support/isolated_execution_state'
@@ -8,6 +8,9 @@ rescue LoadError
   # ActiveSupport::IsolatedExecutionState is only available in Rails 5.2+
 end
 
+# Don't log in other tests, we'll manually re-attach when this one starts
+Flipper::Instrumentation::LogSubscriber.detach
+
 RSpec.describe Flipper::Instrumentation::LogSubscriber do
   let(:adapter) do
     memory = Flipper::Adapters::Memory.new
@@ -32,8 +35,12 @@ RSpec.describe Flipper::Instrumentation::LogSubscriber do
     described_class.logger = nil
   end
 
+  before(:all) do
+    described_class.attach
+  end
+
   after(:all) do
-    ActiveSupport::Notifications.unsubscribe("flipper")
+    described_class.detach
   end
 
   let(:log) { @io.string }

data/spec/flipper_spec.rb

@@ -241,7 +241,7 @@ RSpec.describe Flipper do
       stub = stub_request(:get, "https://www.flippercloud.io/adapter/features?exclude_gate_names=true").
         with({
           headers: {
-            'Flipper-Cloud-Token'=>'asdf',
+            'flipper-cloud-token'=>'asdf',
           },
         }).to_return(status: 200, body: '{"features": {}}', headers: {})
       cloud_configuration = Flipper::Cloud::Configuration.new({

data/spec/spec_helper.rb

@@ -18,6 +18,7 @@ require 'flipper'
 require 'flipper/api'
 require 'flipper/spec/shared_adapter_specs'
 require 'flipper/ui'
+require 'flipper/test_help'
 
 Dir[FlipperRoot.join('spec/support/**/*.rb')].sort.each { |f| require f }
 

data/spec/support/spec_helpers.rb

@@ -3,6 +3,8 @@ require 'json'
 require 'rack/test'
 
 module SpecHelpers
+  extend self
+
   def self.included(base)
     base.let(:flipper) { build_flipper }
     base.let(:app) { build_app(flipper) }
@@ -27,7 +29,11 @@ module SpecHelpers
   end
 
   def json_response
-    JSON.parse(last_response.body)
+    body = last_response.body
+    if last_response["content-encoding"] == 'gzip'
+      body = Flipper::Typecast.from_gzip(body)
+    end
+    JSON.parse(body)
   end
 
   def api_error_code_reference_url
@@ -76,11 +82,11 @@ module SpecHelpers
 
     yield
 
-    $stderr = original_stderr
-    $stdout = original_stdout
-
     # Return output
     output.string
+  ensure
+    $stderr = original_stderr
+    $stdout = original_stdout
   end
 end
 

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/system/test_help_test.rb

@@ -0,0 +1,51 @@
+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, options: { process_timeout: 30 }
+
+  setup do
+    # Reconfigure Flipper since other tests change the adapter.
+    flipper_configure
+
+    # Ensure this test uses this app instance
+    Rails.application = TestApp.instance
+  end
+
+  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.2
+  version: 1.2.2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2024-01-19 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,9 +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
@@ -196,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
@@ -208,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
@@ -278,7 +286,6 @@ files:
 - spec/flipper_spec.rb
 - spec/spec_helper.rb
 - spec/support/actor_names.yml
-- spec/support/climate_control.rb
 - spec/support/descriptions.yml
 - spec/support/fake_backoff_policy.rb
 - spec/support/fake_udp_socket.rb
@@ -287,8 +294,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
@@ -297,7 +306,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.2
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -306,18 +315,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 and Rails.
 test_files:
+- spec/fixtures/environment.rb
 - spec/fixtures/feature.json
 - spec/fixtures/flipper_pstore_1679087600.json
 - spec/flipper/actor_spec.rb
@@ -326,6 +336,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
@@ -338,6 +349,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
@@ -408,7 +420,6 @@ test_files:
 - spec/flipper_spec.rb
 - spec/spec_helper.rb
 - spec/support/actor_names.yml
-- spec/support/climate_control.rb
 - spec/support/descriptions.yml
 - spec/support/fake_backoff_policy.rb
 - spec/support/fake_udp_socket.rb

data/spec/support/climate_control.rb

@@ -1,7 +0,0 @@
-require 'climate_control'
-
-RSpec.configure do |config|
-  def with_env(options = {}, &block)
-    ClimateControl.modify(options, &block)
-  end
-end