featury 1.0.0.rc22 → 1.0.0.rc24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 978b872baf023c8de159d5ecfa2928e59d1d28d950fd26c9ec9ca3dc43d116b8
-  data.tar.gz: 326784e9821c20af6dc91f765b069ae1574624b6035dabca6b76dc5331501492
+  metadata.gz: 0c1b72f8275c2ade5b4e3716b598937fa8c4f243dfa142c17c9cc675523b9f70
+  data.tar.gz: 6112766f0f732d53a04b807e6f5af30f5125077a41a5ca043f43c0145bbba708
 SHA512:
-  metadata.gz: 18cd733daf8b0208364b6733d737b9720ca02f446cf899d486737d26fb2bee962cb748f642586bfbe06fbe9ed9d405c7453525493aced50a85da3f759200ecc2
-  data.tar.gz: 5f5cde128bbc8a04706c72b5cc560f0f5c9b033d92e53298f601c0bf849938b79bd313a92d2419dc1111a85de5adde6541e5d545e03f40e66e859221635a8bba
+  metadata.gz: 4d3f21be19cfb9090f9c79ac9ce52d060eaea14ea014384ed2a3f1911f962058d58e87e796c36a28575b24841bf610dd0c2565d16f7a3c0a73a7343f6273b866
+  data.tar.gz: 38df69d5f0c94cef5213279b39966c79c006dc1ddff5ccb54f715e51b07c4e42bd2d84858659e3273fe3ddf48efcbd08d244afa40908b5fbefb8a0d1bfb3cd58

data/README.md

@@ -56,7 +56,7 @@ class ApplicationFeature < Featury::Base
     features.all? { |feature| Flipper.disable(feature, *options.values) }
   end
 
-  action :add do |features:, **options|
+  action :add, web: :regular do |features:, **options|
     features.all? { |feature| Flipper.add(feature, *options.values) }
   end
 
@@ -90,10 +90,10 @@ class User::OnboardingFeature < ApplicationFeature
 
   condition ->(resources:) { resources.user.onboarding_awaiting? }
 
-  features :passage # => :user_onboarding_passage
+  feature :passage, description: "User onboarding passage feature" # => :user_onboarding_passage
 
-  groups BillingFeature,
-         PaymentSystemFeature
+  group BillingFeature, description: "Billing functionality group"
+  group PaymentSystemFeature, description: "Payment system functionality group"
 end
 ```
 
@@ -101,8 +101,8 @@ end
 class BillingFeature < ApplicationFeature
   prefix :billing
 
-  features :api,        # => :billing_api
-           :webhooks    # => :billing_webhooks
+  feature :api, description: "Billing API feature"        # => :billing_api
+  feature :webhooks, description: "Billing webhooks feature"    # => :billing_webhooks
 end
 ```
 
@@ -110,8 +110,8 @@ end
 class PaymentSystemFeature < ApplicationFeature
   prefix :payment_system
 
-  features :api,      # => :payment_system_api
-           :webhooks  # => :payment_system_webhooks
+  feature :api, description: "Payment system API feature"      # => :payment_system_api
+  feature :webhooks, description: "Payment system webhooks feature"  # => :payment_system_webhooks
 end
 ```
 
@@ -161,6 +161,20 @@ 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:
+
+```ruby
+# 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
 
 ```ruby
@@ -168,11 +182,27 @@ info = User::OnboardingFeature.info
 ```
 
 ```ruby
-info.actions      # Feature actions (all, web) of the current class.
-info.resources    # Feature resources 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.
+# 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

data/lib/featury/actions/service/factory.rb

@@ -31,10 +31,25 @@ module Featury
 
             input :action, type: Featury::Actions::Action
 
-            input :collection_of_resources, type: Featury::Resources::Collection
-            input :collection_of_conditions, type: Featury::Conditions::Collection
-            input :collection_of_features, type: Featury::Features::Collection
-            input :collection_of_groups, type: Featury::Groups::Collection
+            input :collection_of_resources,
+                  type: Featury::Resources::Collection,
+                  required: false,
+                  default: Featury::Resources::Collection.new
+
+            input :collection_of_conditions,
+                  type: Featury::Conditions::Collection,
+                  required: false,
+                  default: Featury::Conditions::Collection.new
+
+            input :collection_of_features,
+                  type: Featury::Features::Collection,
+                  required: false,
+                  default: Featury::Features::Collection.new
+
+            input :collection_of_groups,
+                  type: Featury::Groups::Collection,
+                  required: false,
+                  default: Featury::Groups::Collection.new
 
             output :all_true, type: [TrueClass, FalseClass]
 
@@ -65,7 +80,7 @@ module Featury
                 [resource.name, inputs.public_send(resource.name)]
               end
 
-              inputs.action.block.call(features: inputs.collection_of_features.full_names, **options)
+              inputs.action.block.call(features: inputs.collection_of_features.names, **options)
             end
 
             def groups_are_true
@@ -74,7 +89,7 @@ module Featury
               end
 
               inputs.collection_of_groups.all? do |group|
-                group.group.public_send(inputs.action.name, **arguments)
+                group.group_class.public_send(inputs.action.name, **arguments)
               end
             end
           end

data/lib/featury/callbacks/workspace.rb

@@ -9,7 +9,7 @@ module Featury
         Featury::Callbacks::Service.call!(
           action: action.name,
           callbacks: collection_of_callbacks.before,
-          features: collection_of_features.full_names
+          features: collection_of_features.names
         )
 
         result = super
@@ -17,7 +17,7 @@ module Featury
         Featury::Callbacks::Service.call!(
           action: action.name,
           callbacks: collection_of_callbacks.after,
-          features: collection_of_features.full_names
+          features: collection_of_features.names
         )
 
         result

data/lib/featury/features/collection.rb

@@ -4,14 +4,14 @@ module Featury
   module Features
     class Collection
       extend Forwardable
-      def_delegators :@collection, :<<, :each, :map, :merge
+      def_delegators :@collection, :<<, :each, :map, :merge, :to_a, :empty?
 
       def initialize(collection = Set.new)
         @collection = collection
       end
 
-      def full_names
-        map(&:full_name)
+      def names
+        map(&:name)
       end
     end
   end

data/lib/featury/features/dsl.rb

@@ -20,12 +20,22 @@ module Featury
           self.feature_prefix = prefix
         end
 
+        # DEPRECATED: Need to use the `feature` method instead of `features`.
         def features(*names)
+          Kernel.warn "DEPRECATION WARNING: " \
+                      "Method `features` is deprecated; " \
+                      "use `feature` instead. " \
+                      "It will be removed in one of the next releases."
+
           names.each do |name|
-            collection_of_features << Feature.new(feature_prefix, name)
+            collection_of_features << Feature.new(prefix: feature_prefix, name:, description: nil)
           end
         end
 
+        def feature(name, description: nil)
+          collection_of_features << Feature.new(prefix: feature_prefix, name:, description:)
+        end
+
         def feature_prefix=(value)
           @feature_prefix = value
         end

data/lib/featury/features/feature.rb

@@ -3,13 +3,12 @@
 module Featury
   module Features
     class Feature
-      def initialize(prefix, name)
-        @prefix = prefix
-        @name = name
-      end
+      attr_reader :name,
+                  :description
 
-      def full_name
-        :"#{@prefix}_#{@name}"
+      def initialize(prefix:, name:, description:)
+        @name = :"#{prefix}_#{name}"
+        @description = description
       end
     end
   end

data/lib/featury/groups/collection.rb

@@ -4,7 +4,7 @@ module Featury
   module Groups
     class Collection
       extend Forwardable
-      def_delegators :@collection, :<<, :each, :map, :filter, :to_h, :merge, :all?
+      def_delegators :@collection, :<<, :each, :map, :flat_map, :filter, :to_h, :merge, :to_a, :all?, :empty?
 
       def initialize(collection = Set.new)
         @collection = collection

data/lib/featury/groups/dsl.rb

@@ -16,12 +16,22 @@ module Featury
 
         private
 
+        # DEPRECATED: Need to use the `group` method instead of `groups`.
         def groups(*groups)
+          Kernel.warn "DEPRECATION WARNING: " \
+                      "Method `groups` is deprecated; " \
+                      "use `group` instead. " \
+                      "It will be removed in one of the next releases."
+
           groups.each do |group|
-            collection_of_groups << Group.new(group)
+            collection_of_groups << Group.new(group:, description: nil)
           end
         end
 
+        def group(group, description: nil)
+          collection_of_groups << Group.new(group:, description:)
+        end
+
         def collection_of_groups
           @collection_of_groups ||= Collection.new
         end

data/lib/featury/groups/group.rb

@@ -3,10 +3,12 @@
 module Featury
   module Groups
     class Group
-      attr_reader :group
+      attr_reader :group_class,
+                  :description
 
-      def initialize(group)
-        @group = group
+      def initialize(group:, description:)
+        @group_class = group
+        @description = description
       end
     end
   end

data/lib/featury/info/dsl.rb

@@ -8,17 +8,13 @@ module Featury
       end
 
       module ClassMethods
-        def info # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def info
           Featury::Info::Result.new(
             actions: Featury::Info::Result::Actions.new(collection_of_actions),
-            resources: collection_of_resources.names,
-            features: collection_of_features.full_names,
-            groups: collection_of_groups.map(&:group),
-            tree: collection_of_features.full_names.concat(
-              collection_of_groups.map do |group|
-                group.group.info.tree
-              end
-            )
+            resources: Featury::Info::Result::Resources.new(collection_of_resources).all.names,
+            features: Featury::Info::Result::Features.new(collection_of_features).all,
+            groups: Featury::Info::Result::Groups.new(collection_of_groups).all,
+            tree: Featury::Info::Result::Tree.new(collection_of_features, collection_of_groups).all
           )
         end
 

data/lib/featury/info/result.rb

@@ -27,6 +27,74 @@ module Featury
         end
       end
 
+      class Resources
+        attr_reader :all
+
+        def initialize(collection_of_resources)
+          @all = collection_of_resources
+        end
+      end
+
+      class Features
+        attr_reader :all
+
+        def initialize(collection_of_features)
+          @all = collection_of_features
+        end
+      end
+
+      class Groups
+        attr_reader :all
+
+        def initialize(collection_of_groups)
+          @all = collection_of_groups
+        end
+      end
+
+      class Tree
+        attr_reader :all
+
+        class Features
+          attr_reader :features,
+                      :groups
+
+          def initialize(features, groups)
+            @features = features.map do |feature|
+              Feature.new(
+                name: feature.name,
+                description: feature.description
+              )
+            end
+
+            @groups = groups.flat_map do |group|
+              group.group_class.info.tree
+            end
+          end
+
+          class Feature
+            attr_reader :name,
+                        :description
+
+            def initialize(name:, description:)
+              @name = name
+              @description = description
+            end
+          end
+        end
+
+        def initialize(features, groups)
+          @all = Features.new(features, groups)
+
+          # @groups = groups.flat_map do |group|
+          #   group.group_class.info.tree
+          # end
+        end
+
+        # nested: @groups.flat_map do |group|
+        #   group.group_class.info.tree
+        # end
+      end
+
       attr_reader :actions,
                   :resources,
                   :features,

data/lib/featury/version.rb

@@ -5,7 +5,7 @@ module Featury
     MAJOR = 1
     MINOR = 0
     PATCH = 0
-    PRE = "rc22"
+    PRE = "rc24"
 
     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.rc22
+  version: 1.0.0.rc24
 platform: ruby
 authors:
 - Anton Sokolov