featury 1.0.0.rc13 → 1.0.0.rc16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97cc910762d980a170b075f98d2b5fe4cff87af8680477a06805fd31f0f9576b
-  data.tar.gz: 14ebb9a2d462b8414d5291a64b1a8d7c4b3957a3ad3669ebd88fc39c821c5ec4
+  metadata.gz: 2cd98a4235a1f9d9340fa5636436c54a70a7fc5fa54948d13ceaf311d9facd13
+  data.tar.gz: c392d9f3cde18aa65a60078335040b52b1fa43d6e152e133929e4de2bb3fa26c
 SHA512:
-  metadata.gz: 6ddf5182c50a1476a46d5ab336a0cb11baf3e0c9c72d27c71e51b5b5b1134376972aede1c3b0d334f3dc5b621096695ca45cc9e058b14a31816c3e11b946bf57
-  data.tar.gz: 8584f3fec8b9bdf944923754fe27ffcb54ac3b13b9ed5e4393449ce6c2505b6760418f3c84651e55ce80a9c276e95a8c8df9d8f702b2fb039051973d48036148
+  metadata.gz: e807ae55d5679f89ab50cdf2a68384eb82d100f0902f0b262e051eccfb0e13fe2b10178204a2e0cf6fd6a4702f9f74a5b8f0d2e2287f46f7ac667415e2c89dc2
+  data.tar.gz: '0198b0a0a4c9efe3dc5ad9d44b7f619b98950c86607cb13ef133f759a84faca48df9f07782ff51b1874d93403a8d6f5eb71b592f63407b62866d03fa90987e0d'

data/README.md

@@ -26,7 +26,7 @@ gem "featury"
 #### Basic class for your features
 
 For instance, assume that you are utilizing Flipper for managing features.
-In such scenario, the base class could potentially be structured as follows:
+In such a scenario, the base class could potentially be structured as follows:
 
 ```ruby
 class ApplicationFeature < Featury::Base
@@ -45,19 +45,27 @@ class ApplicationFeature < Featury::Base
   action :disable do |features:, **options|
     features.all? { |feature| Flipper.disable(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
 ```
 
 #### Features of your project
 
 ```ruby
-class UserFeature::Onboarding < ApplicationFeature
+class User::OnboardingFeature < ApplicationFeature
+  prefix :user_onboarding
+
   resource :user, type: User
 
   condition ->(resources:) { resources.user.onboarding_awaiting? }
 
-  prefix :user_onboarding
-
   features :passage # => :user_onboarding_passage
 
   groups BillingFeature,
@@ -104,16 +112,16 @@ 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.
 
 ```ruby
-UserFeature::Onboarding.enabled?(user:) # => true
-UserFeature::Onboarding.disabled?(user:) # => false
-UserFeature::Onboarding.enable(user:) # => true
-UserFeature::Onboarding.disable(user:) # => true
+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.
 
 ```ruby
-feature = UserFeature::Onboarding.with(user:)
+feature = User::OnboardingFeature.with(user:)
 
 feature.enabled? # => true
 feature.disabled? # => false
@@ -129,6 +137,18 @@ 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.
 
+#### Information about features
+
+```ruby
+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.
+```
+
 ## Contributing
 
 This project is intended to be a safe, welcoming space for collaboration. 

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

@@ -65,7 +65,7 @@ module Featury
                 [resource.name, inputs.public_send(resource.name)]
               end
 
-              inputs.action.block.call(features: inputs.collection_of_features.list, **options)
+              inputs.action.block.call(features: inputs.collection_of_features.full_names, **options)
             end
 
             def groups_are_true

data/lib/featury/base.rb

@@ -2,6 +2,7 @@
 
 module Featury
   class Base
+    include Info::DSL
     include Context::DSL
     include Actions::DSL
     include Callbacks::DSL

data/lib/featury/callbacks/callback.rb

@@ -3,10 +3,11 @@
 module Featury
   module Callbacks
     class Callback
-      attr_reader :block
+      attr_reader :desired_actions, :block
 
-      def initialize(stage, block:)
+      def initialize(stage:, desired_actions:, block:)
         @stage = stage.to_sym
+        @desired_actions = desired_actions
         @block = block
       end
 

data/lib/featury/callbacks/collection.rb

@@ -10,12 +10,21 @@ module Featury
         @collection = collection
       end
 
+      def desired_actions(include:)
+        Collection.new(
+          filter do |callback|
+            callback.desired_actions.blank? ||
+              callback.desired_actions.include?(include)
+          end
+        )
+      end
+
       def before
-        @before ||= Collection.new(filter(&:before?))
+        Collection.new(filter(&:before?))
       end
 
       def after
-        @after ||= Collection.new(filter(&:after?))
+        Collection.new(filter(&:after?))
       end
     end
   end

data/lib/featury/callbacks/dsl.rb

@@ -17,17 +17,19 @@ module Featury
 
         private
 
-        def before
+        def before(*actions)
           collection_of_callbacks << Callback.new(
-            :before,
-            block: ->(action:, features:) { yield(action:, features:) }
+            stage: :before,
+            desired_actions: actions,
+            block: ->(**arguments) { yield(**arguments) }
           )
         end
 
-        def after
+        def after(*actions)
           collection_of_callbacks << Callback.new(
-            :after,
-            block: ->(action:, features:) { yield(action:, features:) }
+            stage: :after,
+            desired_actions: actions,
+            block: ->(**arguments) { yield(**arguments) }
           )
         end
 

data/lib/featury/callbacks/service.rb

@@ -8,13 +8,13 @@ module Featury
       end
 
       def initialize(action:, callbacks:, features:)
-        @callbacks = callbacks
         @action = action
+        @callbacks = callbacks
         @features = features
       end
 
       def call!
-        @callbacks.each do |callback|
+        @callbacks.desired_actions(include: @action).each do |callback|
           callback.block.call(action: @action, features: @features)
         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.list
+          features: collection_of_features.full_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.list
+          features: collection_of_features.full_names
         )
 
         result

data/lib/featury/features/collection.rb

@@ -10,8 +10,8 @@ module Featury
         @collection = collection
       end
 
-      def list
-        @list ||= map { |feature| :"#{feature.prefix}_#{feature.name}" }
+      def full_names
+        map(&:full_name)
       end
     end
   end

data/lib/featury/features/dsl.rb

@@ -40,6 +40,7 @@ module Featury
                 .gsub(/([a-z])(\d+)/, '\1_\2')
                 .gsub(/(\d+)([a-z])/, '\1_\2')
                 .tr("/", "_")
+                .delete_suffix("_feature")
                 .to_sym
         end
 

data/lib/featury/features/feature.rb

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

data/lib/featury/info/dsl.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Featury
+  module Info
+    module DSL
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def info
+          Featury::Info::Result.new(
+            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
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/featury/info/result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Featury
+  module Info
+    class Result
+      attr_reader :features, :groups, :tree
+
+      def initialize(features:, groups:, tree:)
+        @features = features
+        @groups = groups
+        @tree = tree
+      end
+    end
+  end
+end

data/lib/featury/version.rb

@@ -5,7 +5,7 @@ module Featury
     MAJOR = 1
     MINOR = 0
     PATCH = 0
-    PRE = "rc13"
+    PRE = "rc16"
 
     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.rc13
+  version: 1.0.0.rc16
 platform: ruby
 authors:
 - Anton Sokolov
@@ -179,6 +179,8 @@ files:
 - lib/featury/groups/collection.rb
 - lib/featury/groups/dsl.rb
 - lib/featury/groups/group.rb
+- lib/featury/info/dsl.rb
+- lib/featury/info/result.rb
 - lib/featury/resources/collection.rb
 - lib/featury/resources/dsl.rb
 - lib/featury/resources/resource.rb