Refactor feature and group management to include descriptions (#19)

Author: afuno

examples/usual/example1/d_feature.rb

@@ -11,13 +11,13 @@ class DFeature < Usual::Example1::Base
       condition ->(resources:) { resources.record.id == "123" }
 
       # full » :usual_example_1_d_i
+      feature :i, description: "D I feature"
+
       # full » :usual_example_1_d_ii
+      feature :ii, description: "D II feature"
+
       # full » :usual_example_1_d_iii
-      features(
-        :i,
-        :ii,
-        :iii
-      )
+      feature :iii, description: "D III feature"
     end
   end
 end

examples/usual/example1/e_feature.rb

@@ -10,13 +10,13 @@ class EFeature < Usual::Example1::Base
       condition ->(resources:) { resources.record.id == "123" }
 
       # full » :usual_example_1_e_i
+      feature :i, description: "E I feature"
+
       # full » :usual_example_1_e_ii
+      feature :ii, description: "E II feature"
+
       # full » :usual_example_1_e_iii
-      features(
-        :i,
-        :ii,
-        :iii
-      )
+      feature :iii, description: "E III feature"
     end
   end
 end

examples/usual/example1/main_feature.rb

@@ -14,18 +14,16 @@ class MainFeature < Usual::Example1::Base
       condition ->(resources:) { resources.record.id == "123" }
 
       # full » :usual_example_1_a
+      feature :a, description: "A feature"
+
       # full » :usual_example_1_b
+      feature :b, description: "B feature"
+
       # full » :usual_example_1_c
-      features(
-        :a,
-        :b,
-        :c
-      )
-
-      groups(
-        Usual::Example1::DFeature,
-        Usual::Example1::EFeature
-      )
+      feature :c, description: "C feature"
+
+      group Usual::Example1::DFeature, description: "D feature group"
+      group Usual::Example1::EFeature, description: "E feature group"
     end
   end
 end

lib/featury/actions/service/factory.rb

@@ -65,7 +65,7 @@ def features_are_true
                 [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 +74,7 @@ def groups_are_true
               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

lib/featury/callbacks/workspace.rb

@@ -9,15 +9,15 @@ def call!(action:, collection_of_callbacks:, collection_of_features:, **) # rubo
         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
 
         Featury::Callbacks::Service.call!(
           action: action.name,
           callbacks: collection_of_callbacks.after,
-          features: collection_of_features.full_names
+          features: collection_of_features.names
         )
 
         result

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
 
       def initialize(collection = Set.new)
         @collection = collection
       end
 
-      def full_names
-        map(&:full_name)
+      def names
+        map(&:name)
       end
     end
   end

lib/featury/features/dsl.rb

@@ -20,12 +20,22 @@ def prefix(prefix)
           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

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

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?
 
       def initialize(collection = Set.new)
         @collection = collection

lib/featury/groups/dsl.rb

@@ -16,12 +16,22 @@ def inherited(child)
 
         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