Purpose

Featury is designed to group and manage multiple features within a project. It provides the flexibility to utilize any pre-existing solution or create your own. It's easily adjustable to align with the unique needs and objectives of your project.

Quick Start

Installation

gem "featury"

Usage

Basic class for your features

For instance, assume that you are utilizing Flipper for managing features. In such a scenario, the base class could potentially be structured as follows:

class ApplicationFeature < Featury::Base
  action :enabled?, web: :enabled? do |features:, **options|
    features.all? { |feature| Flipper.enabled?(feature, *options.values) }
  end

  action :disabled?, web: :regular do |features:, **options|
    features.any? { |feature| !Flipper.enabled?(feature, *options.values) }
  end

  action :enable, web: :enable do |features:, **options|
    features.all? { |feature| Flipper.enable(feature, *options.values) }
  end

  action :disable, web: :disable do |features:, **options|
    features.all? { |feature| Flipper.disable(feature, *options.values) }
  end

  action :add, web: :regular do |features:, **options|
    features.all? { |feature| Flipper.add(feature, *options.values) }
  end

  before do |action:, features:|
    Slack::API::Notify.call!(action:, features:)
  end

  after :enabled?, :disabled? do |action:, features:|
    Slack::API::Notify.call!(action:, features:)
  end
end

About the web: key

The web: key in the action definition allows you to specify which method will be used for web interactions. This is useful for mapping internal action names to external endpoints or UI actions. For example:

• enabled? — the method that will be used in the web context to check the state of a feature flag;
• enable — the method that will be used in the web context to enable a feature flag;
• disable — the method that will be used in the web context to disable a feature flag.

This mapping helps you clearly separate internal logic from the interface exposed to web clients.

Features of your project

class User::OnboardingFeature < ApplicationFeature
  prefix :user_onboarding

  resource :user, type: User

  condition ->(resources:) { resources.user.onboarding_awaiting? }

  feature :passage, description: "User onboarding passage feature" # => :user_onboarding_passage

  group BillingFeature, description: "Billing functionality group"
  group PaymentSystemFeature, description: "Payment system functionality group"
end

class BillingFeature < ApplicationFeature
  prefix :billing

  feature :api, description: "Billing API feature"        # => :billing_api
  feature :webhooks, description: "Billing webhooks feature"    # => :billing_webhooks
end

class PaymentSystemFeature < ApplicationFeature
  prefix :payment_system

  feature :api, description: "Payment system API feature"      # => :payment_system_api
  feature :webhooks, description: "Payment system webhooks feature"  # => :payment_system_webhooks
end

The resource method provides an indication of how the transmitted information ought to be processed. Besides the options provided by Servactory, additional ones are available for stipulating the processing mode of the transmitted data.

If a resource needs to be conveyed as a feature flag option, utilize the option parameter:

resource :user, type: User, option: true

To transfer a resource to a nested group, utilize the nested option:

resource :user, type: User, nested: true

Working with the features of your project

Each of these actions will be applied to every feature flag. Subsequently, the outcome of these actions will be contingent upon the combined results of all feature flags.

User::OnboardingFeature.enabled?(user:) # => true
User::OnboardingFeature.disabled?(user:) # => false
User::OnboardingFeature.enable(user:) # => true
User::OnboardingFeature.disable(user:) # => true

You can also utilize the with method to pass necessary arguments.

feature = User::OnboardingFeature.with(user:)

feature.enabled? # => true
feature.disabled? # => false
feature.enable # => true
feature.disable # => true

If a feature flag is deactivated, possibly via automation processes, the primary feature class subsequently responds with false when queried about its enablement status.

In the preceding example, there might be a scenario where the payment system is undergoing technical maintenance and therefore is temporarily shut down. Consequently, the onboarding process for new users will be halted until further notice.

Feature and Group descriptions

When defining features and groups, you can provide descriptions to add more context about what they do:

# Adding a feature with description
feature :api, description: "External API integration"

# Adding a group with description
group PaymentSystemFeature, description: "Payment processing functionality"

These descriptions are preserved in the feature tree and can be accessed via the info method.

Information about features

info = User::OnboardingFeature.info

# Feature actions information (all actions and web actions)
info.actions.all          # All actions: [:enabled?, :disabled?, :enable, :disable, :add]
info.actions.web.all      # Web actions: [:enabled?, :disabled?, :enable, :disable, :add]

# Access specific web actions by their web: option name
info.actions.web.enabled  # Returns the method name (:enabled?) that was defined with `web: :enabled?`
info.actions.web.enable   # Returns the method name (:enable) that was defined with `web: :enable`
info.actions.web.disable  # Returns the method name (:disable) that was defined with `web: :disable`

# Feature resources information
info.resources            # Feature resources of the current class.

# Feature flags information (with descriptions)
info.features             # Feature flags of the current class with their names and descriptions.

# Feature groups information (with descriptions)
info.groups               # Feature groups of the current class with their class references and descriptions.

# Complete feature tree (features and nested groups)
info.tree.features        # Direct features of the current class.
info.tree.groups          # Features from nested groups.

Contributing

This project is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the Contributor Covenant code of conduct. We recommend reading the contributing guide as well.

License

Featury is available as open source under the terms of the MIT License.