flipper 0.26.0 → 0.27.0

data/spec/flipper/feature_check_context_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe Flipper::FeatureCheckContext do
   end
 
   it 'initializes just fine' do
-    instance = described_class.new(options)
+    instance = described_class.new(**options)
     expect(instance.feature_name).to eq(feature_name)
     expect(instance.values).to eq(values)
     expect(instance.thing).to eq(thing)
@@ -20,46 +20,46 @@ RSpec.describe Flipper::FeatureCheckContext do
   it 'requires feature_name' do
     options.delete(:feature_name)
     expect do
-      described_class.new(options)
-    end.to raise_error(KeyError)
+      described_class.new(**options)
+    end.to raise_error(ArgumentError)
   end
 
   it 'requires values' do
     options.delete(:values)
     expect do
-      described_class.new(options)
-    end.to raise_error(KeyError)
+      described_class.new(**options)
+    end.to raise_error(ArgumentError)
   end
 
   it 'requires thing' do
     options.delete(:thing)
     expect do
-      described_class.new(options)
-    end.to raise_error(KeyError)
+      described_class.new(**options)
+    end.to raise_error(ArgumentError)
   end
 
   it 'knows actors_value' do
     args = options.merge(values: Flipper::GateValues.new(actors: Set['User;1']))
-    expect(described_class.new(args).actors_value).to eq(Set['User;1'])
+    expect(described_class.new(**args).actors_value).to eq(Set['User;1'])
   end
 
   it 'knows groups_value' do
     args = options.merge(values: Flipper::GateValues.new(groups: Set['admins']))
-    expect(described_class.new(args).groups_value).to eq(Set['admins'])
+    expect(described_class.new(**args).groups_value).to eq(Set['admins'])
   end
 
   it 'knows boolean_value' do
-    instance = described_class.new(options.merge(values: Flipper::GateValues.new(boolean: true)))
+    instance = described_class.new(**options.merge(values: Flipper::GateValues.new(boolean: true)))
     expect(instance.boolean_value).to eq(true)
   end
 
   it 'knows percentage_of_actors_value' do
     args = options.merge(values: Flipper::GateValues.new(percentage_of_actors: 14))
-    expect(described_class.new(args).percentage_of_actors_value).to eq(14)
+    expect(described_class.new(**args).percentage_of_actors_value).to eq(14)
   end
 
   it 'knows percentage_of_time_value' do
     args = options.merge(values: Flipper::GateValues.new(percentage_of_time: 41))
-    expect(described_class.new(args).percentage_of_time_value).to eq(41)
+    expect(described_class.new(**args).percentage_of_time_value).to eq(41)
   end
 end

data/spec/flipper/gate_values_spec.rb

@@ -80,13 +80,13 @@ RSpec.describe Flipper::GateValues do
   it 'raises argument error for percentage of time value that cannot be converted to an integer' do
     expect do
       described_class.new(percentage_of_time: ['asdf'])
-    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to an integer))
+    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a percentage))
   end
 
   it 'raises argument error for percentage of actors value that cannot be converted to an int' do
     expect do
       described_class.new(percentage_of_actors: ['asdf'])
-    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to an integer))
+    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a percentage))
   end
 
   it 'raises argument error for actors value that cannot be converted to a set' do
@@ -100,35 +100,4 @@ RSpec.describe Flipper::GateValues do
       described_class.new(groups: 'asdf')
     end.to raise_error(ArgumentError, %("asdf" cannot be converted to a set))
   end
-
-  describe '#[]' do
-    it 'can read the boolean value' do
-      expect(described_class.new(boolean: true)[:boolean]).to be(true)
-      expect(described_class.new(boolean: true)['boolean']).to be(true)
-    end
-
-    it 'can read the actors value' do
-      expect(described_class.new(actors: Set[1, 2])[:actors]).to eq(Set[1, 2])
-      expect(described_class.new(actors: Set[1, 2])['actors']).to eq(Set[1, 2])
-    end
-
-    it 'can read the groups value' do
-      expect(described_class.new(groups: Set[:admins])[:groups]).to eq(Set[:admins])
-      expect(described_class.new(groups: Set[:admins])['groups']).to eq(Set[:admins])
-    end
-
-    it 'can read the percentage of time value' do
-      expect(described_class.new(percentage_of_time: 15)[:percentage_of_time]).to eq(15)
-      expect(described_class.new(percentage_of_time: 15)['percentage_of_time']).to eq(15)
-    end
-
-    it 'can read the percentage of actors value' do
-      expect(described_class.new(percentage_of_actors: 15)[:percentage_of_actors]).to eq(15)
-      expect(described_class.new(percentage_of_actors: 15)['percentage_of_actors']).to eq(15)
-    end
-
-    it 'returns nil for value that is not present' do
-      expect(described_class.new({})['not legit']).to be(nil)
-    end
-  end
 end

data/spec/flipper/gates/percentage_of_actors_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Flipper::Gates::PercentageOfActors do
     Flipper::FeatureCheckContext.new(
       feature_name: feature,
       values: Flipper::GateValues.new(percentage_of_actors: percentage_of_actors_value),
-      thing: thing || Flipper::Types::Actor.new(Flipper::Actor.new(1))
+      thing: Flipper::Types::Actor.new(thing || Flipper::Actor.new(1))
     )
   end
 

data/spec/flipper/instrumentation/log_subscriber_spec.rb

@@ -2,6 +2,12 @@ require 'logger'
 require 'flipper/adapters/instrumented'
 require 'flipper/instrumentation/log_subscriber'
 
+begin
+  require 'active_support/isolated_execution_state'
+rescue LoadError
+  # ActiveSupport::IsolatedExecutionState is only available in Rails 5.2+
+end
+
 RSpec.describe Flipper::Instrumentation::LogSubscriber do
   let(:adapter) do
     memory = Flipper::Adapters::Memory.new
@@ -26,6 +32,10 @@ RSpec.describe Flipper::Instrumentation::LogSubscriber do
     described_class.logger = nil
   end
 
+  after(:all) do
+    ActiveSupport::Notifications.unsubscribe("flipper")
+  end
+
   let(:log) { @io.string }
 
   context 'feature enabled checks' do

data/spec/flipper/instrumentation/statsd_subscriber_spec.rb

@@ -2,6 +2,12 @@ require 'flipper/adapters/instrumented'
 require 'flipper/instrumentation/statsd'
 require 'statsd'
 
+begin
+  require 'active_support/isolated_execution_state'
+rescue LoadError
+  # ActiveSupport::IsolatedExecutionState is only available in Rails 5.2+
+end
+
 RSpec.describe Flipper::Instrumentation::StatsdSubscriber do
   let(:statsd_client) { Statsd.new }
   let(:socket) { FakeUDPSocket.new }
@@ -25,6 +31,10 @@ RSpec.describe Flipper::Instrumentation::StatsdSubscriber do
     Thread.current[:statsd_socket] = nil
   end
 
+  after(:all) do
+    ActiveSupport::Notifications.unsubscribe("flipper")
+  end
+
   def assert_timer(metric)
     regex = /#{Regexp.escape metric}\:\d+\|ms/
     result = socket.buffer.detect { |op| op.first =~ regex }

data/spec/flipper/poller_spec.rb

@@ -0,0 +1,47 @@
+require "flipper/poller"
+
+RSpec.describe Flipper::Poller do
+  let(:remote_adapter) { Flipper::Adapters::Memory.new }
+  let(:remote) { Flipper.new(remote_adapter) }
+  let(:local) { Flipper.new(subject.adapter) }
+
+  subject do
+    described_class.new(
+      remote_adapter: remote_adapter,
+      start_automatically: false,
+      interval: Float::INFINITY
+    )
+  end
+
+  before do
+    allow(subject).to receive(:loop).and_yield # Make loop just call once
+    allow(subject).to receive(:sleep)          # Disable sleep
+    allow(Thread).to receive(:new).and_yield   # Disable separate thread
+  end
+
+  describe "#adapter" do
+    it "always returns same memory adapter instance" do
+      expect(subject.adapter).to be_a(Flipper::Adapters::Memory)
+      expect(subject.adapter.object_id).to eq(subject.adapter.object_id)
+    end
+  end
+
+  describe "#sync" do
+    it "syncs remote adapter to local adapter" do
+      remote.enable :polling
+
+      expect(local.enabled?(:polling)).to be(false)
+      subject.sync
+      expect(local.enabled?(:polling)).to be(true)
+    end
+  end
+
+  describe "#start" do
+    it "starts the poller thread" do
+      expect(Thread).to receive(:new).and_yield
+      expect(subject).to receive(:loop).and_yield
+      expect(subject).to receive(:sync)
+      subject.start
+    end
+  end
+end

data/spec/flipper/typecast_spec.rb

@@ -56,7 +56,7 @@ RSpec.describe Flipper::Typecast do
     nil => 0,
     '' => 0,
     0 => 0,
-    0.0 => 0.0,
+    0.0 => 0,
     1 => 1,
     1.1 => 1.1,
     '0.01' => 0.01,
@@ -100,13 +100,13 @@ RSpec.describe Flipper::Typecast do
   it 'raises argument error for bad integer percentage' do
     expect do
       described_class.to_percentage(['asdf'])
-    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to an integer))
+    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a percentage))
   end
 
   it 'raises argument error for bad float percentage' do
     expect do
       described_class.to_percentage(['asdf.0'])
-    end.to raise_error(ArgumentError, %(["asdf.0"] cannot be converted to a float))
+    end.to raise_error(ArgumentError, %(["asdf.0"] cannot be converted to a percentage))
   end
 
   it 'raises argument error for set value that cannot be converted to a set' do
@@ -114,4 +114,83 @@ RSpec.describe Flipper::Typecast do
       described_class.to_set('asdf')
     end.to raise_error(ArgumentError, %("asdf" cannot be converted to a set))
   end
+
+  describe "#features_hash" do
+    it "returns new hash" do
+      hash = {
+        "search" => {
+          boolean: nil,
+        }
+      }
+      result = described_class.features_hash(hash)
+      expect(result).not_to be(hash)
+      expect(result["search"]).not_to be(hash["search"])
+    end
+
+    it "converts gate value arrays to sets" do
+      hash = {
+        "search" => {
+          boolean: nil,
+          groups: ['a', 'b'],
+          actors: ['User;1'],
+          percentage_of_actors: nil,
+          percentage_of_time: nil,
+        },
+      }
+      result = described_class.features_hash(hash)
+      expect(result).to eq({
+        "search" => {
+          boolean: nil,
+          groups: Set['a', 'b'],
+          actors: Set['User;1'],
+          percentage_of_actors: nil,
+          percentage_of_time: nil,
+        },
+      })
+    end
+
+    it "converts gate value boolean and integers to strings" do
+      hash = {
+        "search" => {
+          boolean: true,
+          groups: Set.new,
+          actors: Set.new,
+          percentage_of_actors: 10,
+          percentage_of_time: 15,
+        },
+      }
+      result = described_class.features_hash(hash)
+      expect(result).to eq({
+        "search" => {
+          boolean: "true",
+          groups: Set.new,
+          actors: Set.new,
+          percentage_of_actors: "10",
+          percentage_of_time: "15",
+        },
+      })
+    end
+
+    it "converts string gate keys to symbols" do
+      hash = {
+        "search" => {
+          "boolean" => nil,
+          "groups" => Set.new,
+          "actors" => Set.new,
+          "percentage_of_actors" => nil,
+          "percentage_of_time" => nil,
+        },
+      }
+      result = described_class.features_hash(hash)
+      expect(result).to eq({
+        "search" => {
+          boolean: nil,
+          groups: Set.new,
+          actors: Set.new,
+          percentage_of_actors: nil,
+          percentage_of_time: nil,
+        },
+      })
+    end
+  end
 end

data/spec/flipper_spec.rb

@@ -202,6 +202,12 @@ RSpec.describe Flipper do
       expect(described_class.enabled?(:search)).to be(true)
     end
 
+    it 'delegates export to instance' do
+      described_class.enable(:search)
+      expect(described_class.export).to eq(described_class.adapter.export)
+      expect(described_class.export(format: :json)).to eq(described_class.adapter.export(format: :json))
+    end
+
     it 'delegates adapter to instance' do
       expect(described_class.adapter).to eq(described_class.instance.adapter)
     end
@@ -222,7 +228,7 @@ RSpec.describe Flipper do
     end
 
     it 'delegates sync stuff to instance for Flipper::Cloud' do
-      stub = stub_request(:get, "https://www.flippercloud.io/adapter/features").
+      stub = stub_request(:get, "https://www.flippercloud.io/adapter/features?exclude_gate_names=true").
         with({
           headers: {
             'Flipper-Cloud-Token'=>'asdf',

data/spec/spec_helper.rb

@@ -22,7 +22,7 @@ Dir[FlipperRoot.join('spec/support/**/*.rb')].sort.each { |f| require f }
 
 RSpec.configure do |config|
   config.before(:example) do
-    Flipper::Adapters::Poll::Poller.reset if defined?(Flipper::Adapters::Poll::Poller)
+    Flipper::Poller.reset if defined?(Flipper::Poller)
     Flipper.unregister_groups
     Flipper.configuration = nil
   end

data/spec/support/skippable.rb

@@ -0,0 +1,18 @@
+RSpec.configure do |config|
+  config.before(:all) do
+    $skip = false
+  end
+
+  def skip_on_error(error, message, &block)
+    # Premptively skip if we've already skipped
+    skip(message) if $skip
+    block.call
+  rescue error
+    if ENV["CI"]
+      raise
+    else
+      $skip = true
+      skip(message)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -35,7 +35,6 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/examples.yml"
-- ".github/workflows/release.yml"
 - ".rspec"
 - ".tool-versions"
 - CODE_OF_CONDUCT.md
@@ -45,6 +44,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- benchmark/enabled_ips.rb
+- benchmark/enabled_profile.rb
+- benchmark/instrumentation_ips.rb
+- benchmark/typecast_ips.rb
 - docker-compose.yml
 - docs/DockerCompose.md
 - docs/README.md
@@ -93,6 +96,10 @@ files:
 - lib/flipper/configuration.rb
 - lib/flipper/dsl.rb
 - lib/flipper/errors.rb
+- lib/flipper/export.rb
+- lib/flipper/exporter.rb
+- lib/flipper/exporters/json/export.rb
+- lib/flipper/exporters/json/v1.rb
 - lib/flipper/feature.rb
 - lib/flipper/feature_check_context.rb
 - lib/flipper/gate.rb
@@ -112,6 +119,7 @@ files:
 - lib/flipper/metadata.rb
 - lib/flipper/middleware/memoizer.rb
 - lib/flipper/middleware/setup_env.rb
+- lib/flipper/poller.rb
 - lib/flipper/railtie.rb
 - lib/flipper/registry.rb
 - lib/flipper/spec/shared_adapter_specs.rb
@@ -126,6 +134,7 @@ files:
 - lib/flipper/types/percentage_of_time.rb
 - lib/flipper/version.rb
 - spec/fixtures/feature.json
+- spec/fixtures/flipper_pstore_1679087600.json
 - spec/flipper/actor_spec.rb
 - spec/flipper/adapter_spec.rb
 - spec/flipper/adapters/dual_write_spec.rb
@@ -144,6 +153,10 @@ files:
 - spec/flipper/adapters/sync_spec.rb
 - spec/flipper/configuration_spec.rb
 - spec/flipper/dsl_spec.rb
+- spec/flipper/export_spec.rb
+- spec/flipper/exporter_spec.rb
+- spec/flipper/exporters/json/export_spec.rb
+- spec/flipper/exporters/json/v1_spec.rb
 - spec/flipper/feature_check_context_spec.rb
 - spec/flipper/feature_spec.rb
 - spec/flipper/gate_spec.rb
@@ -160,6 +173,7 @@ files:
 - spec/flipper/instrumenters/noop_spec.rb
 - spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/middleware/setup_env_spec.rb
+- spec/flipper/poller_spec.rb
 - spec/flipper/railtie_spec.rb
 - spec/flipper/registry_spec.rb
 - spec/flipper/typecast_spec.rb
@@ -174,6 +188,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/descriptions.yml
 - spec/support/fake_udp_socket.rb
+- spec/support/skippable.rb
 - spec/support/spec_helpers.rb
 - test/adapters/memory_test.rb
 - test/adapters/pstore_test.rb
@@ -205,6 +220,7 @@ specification_version: 4
 summary: Feature flipper for ANYTHING
 test_files:
 - spec/fixtures/feature.json
+- spec/fixtures/flipper_pstore_1679087600.json
 - spec/flipper/actor_spec.rb
 - spec/flipper/adapter_spec.rb
 - spec/flipper/adapters/dual_write_spec.rb
@@ -223,6 +239,10 @@ test_files:
 - spec/flipper/adapters/sync_spec.rb
 - spec/flipper/configuration_spec.rb
 - spec/flipper/dsl_spec.rb
+- spec/flipper/export_spec.rb
+- spec/flipper/exporter_spec.rb
+- spec/flipper/exporters/json/export_spec.rb
+- spec/flipper/exporters/json/v1_spec.rb
 - spec/flipper/feature_check_context_spec.rb
 - spec/flipper/feature_spec.rb
 - spec/flipper/gate_spec.rb
@@ -239,6 +259,7 @@ test_files:
 - spec/flipper/instrumenters/noop_spec.rb
 - spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/middleware/setup_env_spec.rb
+- spec/flipper/poller_spec.rb
 - spec/flipper/railtie_spec.rb
 - spec/flipper/registry_spec.rb
 - spec/flipper/typecast_spec.rb
@@ -253,6 +274,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/descriptions.yml
 - spec/support/fake_udp_socket.rb
+- spec/support/skippable.rb
 - spec/support/spec_helpers.rb
 - test/adapters/memory_test.rb
 - test/adapters/pstore_test.rb

data/.github/workflows/release.yml

@@ -1,44 +0,0 @@
-# https://andrewm.codes/blog/automating-ruby-gem-releases-with-github-actions/
-name: release
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  release-please:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: google-github-actions/release-please-action@v3
-        id: release
-        with:
-          release-type: ruby
-          package-name: flipper
-          bump-minor-pre-major: true
-          version-file: "lib/flipper/version.rb"
-      # Checkout code if release was created
-      - uses: actions/checkout@v3
-        if: ${{ steps.release.outputs.release_created }}
-      # Setup ruby if a release was created
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.0.0
-        if: ${{ steps.release.outputs.release_created }}
-      # Bundle install
-      - run: bundle install
-        if: ${{ steps.release.outputs.release_created }}
-      # Publish
-      - name: publish gem
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push *.gem
-        env:
-          # Make sure to update the secret name
-          # if yours isn't named RUBYGEMS_AUTH_TOKEN
-          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
-        if: ${{ steps.release.outputs.release_created }}