feature_toggles 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ced315883f27c7dfa71e43d3b04a2e0c6111d7e3ab24ebb2d96b309880349abc
-  data.tar.gz: 2567a6b58344a5b1b05c2380374ef85e1325119a243af0310003b2ad170838bf
+  metadata.gz: de5be65d90b2486463f37deb065af002bf6ccb012a2d0430fb26e29ba50349c9
+  data.tar.gz: 47699f6cb92c4e8f438132964c17070f7b0af6510cf8d16fd80f41232462be65
 SHA512:
-  metadata.gz: f3d9058efacee049c3feed1bc5878e3ba301d2e1d424954e8f871e802d2e31f110503a870b6f7dc90a92a84cca9012e02cacc5eb8c3ca52c2af912547fc05e20
-  data.tar.gz: 6f80548653e6f6f6792ef1a0b42c385d9def25c730a91d10d41e3b1d13d49442ecd8e799d7a0d66ac3e591366f207c7723b685b314a2ce670251ef5c0495f9c3
+  metadata.gz: 68ecaccea419ea6ac0080419f68f16e2c9d22a849128f5889eb3600dd254dea0c0ec220c42223079edcff316dd0e34854270f6200a8d85a756019a3baccd60b1
+  data.tar.gz: a3e5227b603b3ddc1fe09715479aa390c4cae2df7a92317b2f529b5d6c55ee58d843810e25111fb113623dc5ab1a6f807d719d07be81848f8f048e3dcafdbde0

data/README.md

@@ -73,10 +73,10 @@ end
 
 **Step 1. Define features**
 
-Features from file `<rails-root-or-engine>/config/initializers/features.rb` are loaded by convention.
+Features from file `<rails-root-or-engine>/config/features.rb` are loaded by convention.
 
 ```ruby
-# config/initializers/features.rb
+# config/features.rb
 env "FEATURE"
 
 feature :chat do |user: nil|
@@ -123,6 +123,24 @@ class ChatController < ApplicationController
 end
 ```
 
+### Metadata
+
+You can add arbitrary metadata to features:
+
+```ruby
+feature :manual_quantity_backsync, icon: :updated, description: "Manual quantity sync for imported products" do |user: nil|
+  !!user&.features&.fetch("manual_quantity_backsync", false)
+end
+```
+
+That metadata can be later programmatically accessed and exposed into admin panels, API documentation, etc.
+
+```ruby
+Rails.features.first.metadata
+# => { icon: :updated, description: "Manual quantity sync for imported products" }
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/feature_toggles/feature.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module FeatureToggles
+  class Feature
+    def initialize(name, resolver, **metadata)
+      @name = name
+      @resolver = resolver
+      @metadata = metadata
+    end
+
+    attr_reader :name, :resolver, :metadata
+
+    def [](key)
+      @metadata[key]
+    end
+  end
+end

data/lib/feature_toggles/mechatronic.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 require_relative "proxy"
+require_relative "feature"
 
 module FeatureToggles
   class Mechatronic
+    include Enumerable
+
     # Which env variables should be considered truthy
-    POSSIBLE_ENABLING_VALUES = %w(true on yes 1).freeze
+    POSSIBLE_ENABLING_VALUES = %w[true on yes 1].freeze
 
     def initialize(definition_file_paths = nil, &block)
       @features = {}
@@ -14,41 +17,49 @@ module FeatureToggles
         instance_eval(File.read(file), file)
       end
 
-      instance_eval(&block) if block_given?
+      instance_eval(&block) if block
     end
 
     def env(val)
       @env_prefix = val
     end
 
-    def feature(name, &block)
+    def feature(name, **metadata, &block)
       raise(ArgumentError, "Flag #{name} already exists") if @features.key?(name)
 
-      features[name] = block
+      features[name] = Feature.new(name, block, **metadata)
     end
 
     def names
       features.keys
     end
 
-    def enabled?(feature, *args)
-      enabled_globally?(feature) || !!features.fetch(feature).call(*args)
+    def enabled?(feature, *args, **kwargs)
+      enabled_globally?(feature) || !!features.fetch(feature).resolver.call(*args, **kwargs)
     end
 
-    def for(*args)
-      Proxy.new(self, *args)
+    def for(*args, **kwargs)
+      Proxy.new(self, *args, **kwargs)
     end
 
-    def to_a(*args)
+    def to_a(*args, **kwargs)
       names.map do |feature|
-        {feature: feature, enabled: enabled?(feature, *args)}
+        {feature: feature, enabled: enabled?(feature, *args, **kwargs)}
       end
     end
 
-    def to_h(*args)
-      Hash[features.map do |feature, _|
-        [feature, enabled?(feature, *args)]
-      end]
+    def to_h(*args, **kwargs)
+      features.map do |feature, _|
+        [feature, enabled?(feature, *args, **kwargs)]
+      end.to_h
+    end
+
+    def each
+      if block_given?
+        features.values.each { |f| yield f }
+      else
+        features.values.to_enum
+      end
     end
 
     private

data/lib/feature_toggles/proxy.rb

@@ -2,25 +2,26 @@
 
 module FeatureToggles
   class Proxy
-    def initialize(toggle, *args)
+    def initialize(toggle, *args, **kwargs)
       @toggle = toggle
       @args = args
+      @kwargs = kwargs
     end
 
     def enabled?(feature)
-      toggle.enabled?(feature, *args)
+      toggle.enabled?(feature, *args, **kwargs)
     end
 
     def to_a
-      toggle.to_a(*args)
+      toggle.to_a(*args, **kwargs)
     end
 
     def to_h
-      toggle.to_h(*args)
+      toggle.to_h(*args, **kwargs)
     end
 
     private
 
-    attr_reader :toggle, :args
+    attr_reader :toggle, :args, :kwargs
   end
 end

data/lib/feature_toggles/railtie.rb

@@ -26,7 +26,7 @@ module FeatureToggles
       file = ::Rails.root.join("config", "features.rb")
       paths << file.to_s if file.exist?
 
-      Rails.application.config.features = FeatureToggles.build(paths)
+      Rails.application.config.features = FeatureToggles.build(paths.uniq)
     end
   end
 end

data/lib/feature_toggles/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FeatureToggles
-  VERSION = "1.0.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: feature_toggles
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Michael Merkushin
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -58,43 +58,43 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
-description: 
+        version: '1.1'
+description:
 email:
 - merkushin.m.s@gmail.com
 executables: []
@@ -104,6 +104,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/feature_toggles.rb
+- lib/feature_toggles/feature.rb
 - lib/feature_toggles/mechatronic.rb
 - lib/feature_toggles/proxy.rb
 - lib/feature_toggles/railtie.rb
@@ -113,24 +114,23 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: This gem provides a mechanism for pending features.
 test_files: []