ruby_event_store-flipper 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c5ce25aa870798086c39153c8efdb84eb4d69b935058e42e61c1f4d11ce8c92
+  data.tar.gz: d2fc3133da101956ad78fc420fb96e62d09f31e32b5bfe794d4b4464831eaef7
+SHA512:
+  metadata.gz: be360a15e185b781ea62d3b1ab887e8ad0c56d06d8680dbd5c80042798d71ef47aea4ee12fc60afea8defb8b024862c458475f6d13d064122f656039159ada02
+  data.tar.gz: 01e936c68c6094938e9b47d2fb215cecd032fccc8c586d07af04f69464ec98d04f71c06b8485ea00eb4f6074cf1a6abe5bfb66a024919afa263919ceb9ef5591

data/README.md

@@ -0,0 +1,62 @@
+# RubyEventStore::Flipper
+
+Flipper integration for RubyEventStore.
+
+
+## Installation
+
+1. Ensure that your Flipper has instrumentation enabled
+2. Enable RubyEventStore subscriber via `RubyEventStore::Flipper.enable(event_store_instance)`
+
+Example:
+
+```ruby
+Flipper.configure do |config|
+  config.default do
+    # ... adapter configuration
+
+    # Enable instrumentation in Flipper
+    Flipper.new(adapter, instrumenter: ActiveSupport::Notifications)
+  end
+end
+
+# Enable RubyEventStore instrumentation for Flipper
+RubyEventStore::Flipper.enable(Rails.configuration.event_store)
+```
+
+## Customize stream pattern
+
+By default, stream name for toggle `foobar` is `FeatureToggle$foobar`. You can customize it via `stream_pattern` argument:
+
+```ruby
+RubyEventStore::Flipper.enable(Rails.configuration.event_store, stream_pattern: ->(feature_name) { "feature_toggle-#{feature_name}" })
+```
+
+## Customize notifications component
+
+Anything with the same API as `ActiveSupport::Notifications` is supported.
+
+```ruby
+RubyEventStore::Flipper.enable(Rails.configuration.event_store, instrumenter: AS::Notifications)
+```
+
+## Customize events being used
+
+You can pass your own events to be used instead of default ones. Example:
+
+```
+Flipper.enable(event_store, custom_events: {
+  "ToggleAdded" => CustomModule::ToggleAdded,
+  "ToggleRemoved" => CustomModule::ToggleRemoved,
+  "ToggleGloballyEnabled" => CustomModule::ToggleGloballyEnabled,
+  "ToggleEnabledForActor" => CustomModule::ToggleEnabledForActor,
+  "ToggleEnabledForGroup" => CustomModule::ToggleEnabledForGroup,
+  "ToggleEnabledForPercentageOfActors" => CustomModule::ToggleEnabledForPercentageOfActors,
+  "ToggleEnabledForPercentageOfTime" => CustomModule::ToggleEnabledForPercentageOfTime,
+  "ToggleGloballyDisabled" => CustomModule::ToggleGloballyDisabled,
+  "ToggleDisabledForActor" => CustomModule::ToggleDisabledForActor,
+  "ToggleDisabledForGroup" => CustomModule::ToggleDisabledForGroup,
+  "ToggleDisabledForPercentageOfActors" => CustomModule::ToggleDisabledForPercentageOfActors,
+  "ToggleDisabledForPercentageOfTime" => CustomModule::ToggleDisabledForPercentageOfTime,
+})
+```

data/lib/generators/ruby_event_store/flipper/events_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+begin
+  require 'rails/generators'
+rescue LoadError
+end
+
+module RubyEventStore
+  module Flipper
+    class EventsGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), './templates'))
+
+      def create_migration
+        template "events.rb", "app/models/ruby_event_store/flipper/events.rb"
+      end
+    end
+  end
+end if defined?(Rails::Generators::Base)

data/lib/generators/ruby_event_store/flipper/templates/events.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RubyEventStore
+  module Flipper
+    module Events
+      class ToggleAdded < RubyEventStore::Event
+      end
+
+      class ToggleRemoved < RubyEventStore::Event
+      end
+
+      class ToggleGloballyEnabled < RubyEventStore::Event
+      end
+
+      class ToggleGloballyDisabled < RubyEventStore::Event
+      end
+
+      class ToggleEnabledForActor < RubyEventStore::Event
+      end
+
+      class ToggleDisabledForActor < RubyEventStore::Event
+      end
+
+      class ToggleEnabledForGroup < RubyEventStore::Event
+      end
+
+      class ToggleDisabledForGroup < RubyEventStore::Event
+      end
+
+      class ToggleEnabledForPercentageOfActors < RubyEventStore::Event
+      end
+
+      class ToggleDisabledForPercentageOfActors < RubyEventStore::Event
+      end
+
+      class ToggleEnabledForPercentageOfTime < RubyEventStore::Event
+      end
+
+      class ToggleDisabledForPercentageOfTime < RubyEventStore::Event
+      end
+    end
+  end
+end

data/lib/ruby_event_store/flipper/events.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RubyEventStore
+  module Flipper
+    module Events
+      class ToggleAdded < RubyEventStore::Event
+      end
+
+      class ToggleRemoved < RubyEventStore::Event
+      end
+
+      class ToggleGloballyEnabled < RubyEventStore::Event
+      end
+
+      class ToggleGloballyDisabled < RubyEventStore::Event
+      end
+
+      class ToggleEnabledForActor < RubyEventStore::Event
+      end
+
+      class ToggleDisabledForActor < RubyEventStore::Event
+      end
+
+      class ToggleEnabledForGroup < RubyEventStore::Event
+      end
+
+      class ToggleDisabledForGroup < RubyEventStore::Event
+      end
+
+      class ToggleEnabledForPercentageOfActors < RubyEventStore::Event
+      end
+
+      class ToggleDisabledForPercentageOfActors < RubyEventStore::Event
+      end
+
+      class ToggleEnabledForPercentageOfTime < RubyEventStore::Event
+      end
+
+      class ToggleDisabledForPercentageOfTime < RubyEventStore::Event
+      end
+    end
+  end
+end

data/lib/ruby_event_store/flipper/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RubyEventStore
+  module Flipper
+    VERSION = "0.2.0"
+  end
+end

data/lib/ruby_event_store/flipper.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative "flipper/version"
+require "ruby_event_store"
+require_relative "flipper/events"
+
+module RubyEventStore
+  module Flipper
+    DEFAULT_STREAM_PATTERN = ->(feature_name) { "FeatureToggle$#{feature_name}" }
+
+    def self.enable(event_store, instrumenter: ActiveSupport::Notifications, stream_pattern: DEFAULT_STREAM_PATTERN, custom_events: nil)
+      instrumenter.subscribe("feature_operation.flipper", NotificationHandler.new(event_store, stream_pattern, custom_events))
+    end
+
+    class NotificationHandler
+      def initialize(event_store, stream_pattern, custom_events)
+        @event_store = event_store
+        @stream_pattern = stream_pattern
+        @custom_events = {
+          "ToggleAdded" => Events::ToggleAdded,
+          "ToggleRemoved" => Events::ToggleRemoved,
+          "ToggleGloballyEnabled" => Events::ToggleGloballyEnabled,
+          "ToggleEnabledForActor" => Events::ToggleEnabledForActor,
+          "ToggleEnabledForGroup" => Events::ToggleEnabledForGroup,
+          "ToggleEnabledForPercentageOfActors" => Events::ToggleEnabledForPercentageOfActors,
+          "ToggleEnabledForPercentageOfTime" => Events::ToggleEnabledForPercentageOfTime,
+          "ToggleGloballyDisabled" => Events::ToggleGloballyDisabled,
+          "ToggleDisabledForActor" => Events::ToggleDisabledForActor,
+          "ToggleDisabledForGroup" => Events::ToggleDisabledForGroup,
+          "ToggleDisabledForPercentageOfActors" => Events::ToggleDisabledForPercentageOfActors,
+          "ToggleDisabledForPercentageOfTime" => Events::ToggleDisabledForPercentageOfTime,
+        }.merge(custom_events || {})
+      end
+
+      def call(_name, _start, _finish, _id, payload)
+        feature_name = payload.fetch(:feature_name).to_s
+        operation = payload.fetch(:operation)
+        common_payload = { feature_name: feature_name }
+        event_store.publish(build_domain_event(common_payload, operation, payload), stream_name: stream_pattern.(feature_name))
+      end
+
+      private
+
+      attr_reader :event_store, :stream_pattern, :custom_events
+
+      def build_domain_event(common_payload, operation, payload)
+        case operation
+        when :add
+          event_klass("ToggleAdded").new(data: common_payload)
+        when :remove
+          event_klass("ToggleRemoved").new(data: common_payload)
+        when :enable
+          gate_name = payload.fetch(:gate_name)
+          thing = payload.fetch(:thing)
+          case gate_name
+          when :boolean
+            event_klass("ToggleGloballyEnabled").new(data: common_payload)
+          when :actor
+            event_klass("ToggleEnabledForActor").new(data: common_payload.merge(
+              actor: thing.value,
+            ))
+          when :group
+            event_klass("ToggleEnabledForGroup").new(data: common_payload.merge(
+              group: thing.value.to_s,
+            ))
+          when :percentage_of_actors
+            event_klass("ToggleEnabledForPercentageOfActors").new(data: common_payload.merge(
+              percentage: thing.value,
+            ))
+          when :percentage_of_time
+            event_klass("ToggleEnabledForPercentageOfTime").new(data: common_payload.merge(
+              percentage: thing.value,
+            ))
+          end
+        when :disable
+          gate_name = payload.fetch(:gate_name)
+          thing = payload.fetch(:thing)
+          case gate_name
+          when :boolean
+            event_klass("ToggleGloballyDisabled").new(data: common_payload)
+          when :actor
+            event_klass("ToggleDisabledForActor").new(data: common_payload.merge(
+              actor: thing.value,
+            ))
+          when :group
+            event_klass("ToggleDisabledForGroup").new(data: common_payload.merge(
+              group: thing.value.to_s,
+            ))
+          when :percentage_of_actors
+            event_klass("ToggleDisabledForPercentageOfActors").new(data: common_payload)
+          when :percentage_of_time
+            event_klass("ToggleDisabledForPercentageOfTime").new(data: common_payload)
+          end
+        end
+      end
+
+      def event_klass(event_name)
+        custom_events.fetch(event_name)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: ruby_event_store-flipper
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Arkency
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_event_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description:
+email: dev@arkency.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/generators/ruby_event_store/flipper/events_generator.rb
+- lib/generators/ruby_event_store/flipper/templates/events.rb
+- lib/ruby_event_store/flipper.rb
+- lib/ruby_event_store/flipper/events.rb
+- lib/ruby_event_store/flipper/version.rb
+homepage: https://railseventstore.org
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://railseventstore.org
+  source_code_uri: https://github.com/RailsEventStore/rails_event_store
+  bug_tracker_uri: https://github.com/RailsEventStore/rails_event_store/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Flipper integration for RubyEventStore
+test_files: []