featury 1.0.0.rc16 → 1.0.0.rc20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cd98a4235a1f9d9340fa5636436c54a70a7fc5fa54948d13ceaf311d9facd13
-  data.tar.gz: c392d9f3cde18aa65a60078335040b52b1fa43d6e152e133929e4de2bb3fa26c
+  metadata.gz: 89e31c544583912d5448fd9fffbed08f5460691a921fdd3a6722dff1c6549ad1
+  data.tar.gz: bcc393cbf53897b0b1168f1d125b22c8d725450a2952817c1e29a3e83c12d787
 SHA512:
-  metadata.gz: e807ae55d5679f89ab50cdf2a68384eb82d100f0902f0b262e051eccfb0e13fe2b10178204a2e0cf6fd6a4702f9f74a5b8f0d2e2287f46f7ac667415e2c89dc2
-  data.tar.gz: '0198b0a0a4c9efe3dc5ad9d44b7f619b98950c86607cb13ef133f759a84faca48df9f07782ff51b1874d93403a8d6f5eb71b592f63407b62866d03fa90987e0d'
+  metadata.gz: 554318ae7d5d7b0727e0e9ef262fb020178cf5e1602a87d7800e2ad798691d9581f02f2b1975ccaf9f5d168915dca91a6b10eb2c2d201d51e730aa48d2aadb0a
+  data.tar.gz: 6c1cf235e2cd4d217f0a9c05140c70dd60f4c8d8615e8cce36e7e9be87298d6f970911c79a472085ca65271f48be00815c7cdf02c3ee6ffca8b8075f90a0c54e

data/README.md

@@ -1,3 +1,13 @@
+<p align="center">
+  <a href="https://servactory.com" target="_blank">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/servactory/featury/main/.github/logo-dark.svg">
+      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/servactory/featury/main/.github/logo-light.svg">
+      <img alt="Featury" src="https://raw.githubusercontent.com/servactory/featury/main/.github/logo-light.svg" width="350" height="70" style="max-width: 100%;">
+    </picture>
+  </a>
+</p>
+
 <p align="center">
   <a href="https://rubygems.org/gems/featury"><img src="https://img.shields.io/gem/v/featury?logo=rubygems&logoColor=fff" alt="Gem version"></a>
   <a href="https://github.com/servactory/featury/releases"><img src="https://img.shields.io/github/release-date/servactory/featury" alt="Release Date"></a>
@@ -30,22 +40,26 @@ In such a scenario, the base class could potentially be structured as follows:
 
 ```ruby
 class ApplicationFeature < Featury::Base
-  action :enabled? do |features:, **options|
+  action :enabled?, web: :enabled? do |features:, **options|
     features.all? { |feature| Flipper.enabled?(feature, *options.values) }
   end
 
-  action :disabled? do |features:, **options|
+  action :disabled?, web: :regular do |features:, **options|
     features.any? { |feature| !Flipper.enabled?(feature, *options.values) }
   end
 
-  action :enable do |features:, **options|
+  action :enable, web: :enable do |features:, **options|
     features.all? { |feature| Flipper.enable(feature, *options.values) }
   end
 
-  action :disable do |features:, **options|
+  action :disable, web: :disable do |features:, **options|
     features.all? { |feature| Flipper.disable(feature, *options.values) }
   end
 
+  action :add do |features:, **options|
+    features.all? { |feature| Flipper.add(feature, *options.values) }
+  end
+
   before do |action:, features:|
     Slack::API::Notify.call!(action:, features:)
   end
@@ -56,6 +70,16 @@ class ApplicationFeature < Featury::Base
 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
 
 ```ruby
@@ -144,9 +168,10 @@ info = User::OnboardingFeature.info
 ```
 
 ```ruby
-info.features # Feature flags within one class.
-info.groups   # Feature groups within one class.
-info.tree     # Tree of feature flags starting from the current class.
+info.actions      # Feature actions (all, web) of the current class.
+info.features     # Feature flags of the current class.
+info.groups       # Feature flag groups of the current class.
+info.tree         # Tree of feature flags from the current class.
 ```
 
 ## Contributing

data/lib/featury/actions/action.rb

@@ -3,12 +3,31 @@
 module Featury
   module Actions
     class Action
-      attr_reader :name, :block
+      attr_reader :name,
+                  :web,
+                  :block
 
-      def initialize(name, block:)
+      def initialize(name, web:, block:)
         @name = name
+        @web = web
         @block = block
       end
+
+      def web_enabled?
+        @web == :enabled?
+      end
+
+      def web_enable?
+        @web == :enable
+      end
+
+      def web_disable?
+        @web == :disable
+      end
+
+      def web_regular?
+        @web == :regular
+      end
     end
   end
 end

data/lib/featury/actions/collection.rb

@@ -4,16 +4,39 @@ module Featury
   module Actions
     class Collection
       extend Forwardable
-      def_delegators :@collection, :<<, :each, :map, :merge, :find
+      def_delegators :@collection, :<<, :filter, :each, :map, :merge, :find
 
       def initialize(collection = Set.new)
         @collection = collection
       end
 
+      def for_web
+        Collection.new(
+          filter do |action|
+            action.web_enabled? ||
+              action.web_enable? ||
+              action.web_disable? ||
+              action.web_regular?
+          end
+        )
+      end
+
       def names
         map(&:name)
       end
 
+      def web_enabled
+        find(&:web_enabled?)
+      end
+
+      def web_enable
+        find(&:web_enable?)
+      end
+
+      def web_disable
+        find(&:web_disable?)
+      end
+
       def find_by(name:)
         find { |action| action.name == name }
       end

data/lib/featury/actions/dsl.rb

@@ -17,9 +17,10 @@ module Featury
 
         private
 
-        def action(name)
+        def action(name, web: nil)
           collection_of_actions << Action.new(
             name,
+            web:,
             block: ->(features:, **options) { yield(features:, **options) }
           )
         end

data/lib/featury/info/dsl.rb

@@ -10,6 +10,7 @@ module Featury
       module ClassMethods
         def info
           Featury::Info::Result.new(
+            actions: Featury::Info::Result::Actions.new(collection_of_actions),
             features: collection_of_features.full_names,
             groups: collection_of_groups.map(&:group),
             tree: collection_of_features.full_names.concat(
@@ -19,6 +20,11 @@ module Featury
             )
           )
         end
+
+        # API: Featury Web
+        def featury?
+          true
+        end
       end
     end
   end

data/lib/featury/info/result.rb

@@ -3,9 +3,37 @@
 module Featury
   module Info
     class Result
-      attr_reader :features, :groups, :tree
+      class Actions
+        class Web
+          attr_reader :all,
+                      :enabled,
+                      :enable,
+                      :disable
 
-      def initialize(features:, groups:, tree:)
+          def initialize(collection_of_actions)
+            @all = collection_of_actions.names
+            @enabled = collection_of_actions.web_enabled&.name
+            @enable = collection_of_actions.web_enable&.name
+            @disable = collection_of_actions.web_disable&.name
+          end
+        end
+
+        attr_reader :all,
+                    :web
+
+        def initialize(collection_of_actions)
+          @all = collection_of_actions.names
+          @web = Web.new(collection_of_actions.for_web)
+        end
+      end
+
+      attr_reader :actions,
+                  :features,
+                  :groups,
+                  :tree
+
+      def initialize(actions:, features:, groups:, tree:)
+        @actions = actions
         @features = features
         @groups = groups
         @tree = tree

data/lib/featury/version.rb

@@ -5,7 +5,7 @@ module Featury
     MAJOR = 1
     MINOR = 0
     PATCH = 0
-    PRE = "rc16"
+    PRE = "rc20"
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: featury
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc16
+  version: 1.0.0.rc20
 platform: ruby
 authors:
 - Anton Sokolov
@@ -49,14 +49,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -212,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A set of tools for building reliable services of any complexity
 test_files: []