feature_toggles 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ced315883f27c7dfa71e43d3b04a2e0c6111d7e3ab24ebb2d96b309880349abc
-  data.tar.gz: 2567a6b58344a5b1b05c2380374ef85e1325119a243af0310003b2ad170838bf
+  metadata.gz: c5c7424620e5960a2af091b3c18324fbbe8c67b26d6c76a66c1ff5a565f470fd
+  data.tar.gz: 821a7d830e4b917b621067dd81e3dcffd2db9ae36dd2f40ffd337da4fe5f2043
 SHA512:
-  metadata.gz: f3d9058efacee049c3feed1bc5878e3ba301d2e1d424954e8f871e802d2e31f110503a870b6f7dc90a92a84cca9012e02cacc5eb8c3ca52c2af912547fc05e20
-  data.tar.gz: 6f80548653e6f6f6792ef1a0b42c385d9def25c730a91d10d41e3b1d13d49442ecd8e799d7a0d66ac3e591366f207c7723b685b314a2ce670251ef5c0495f9c3
+  metadata.gz: b2fc3fcb95576f873f56b4a693a9a4e62c78c18c3aad6c4fbb264920640d785f72818ba1dfdbb03a06df01371ea9f0efa80ff859b5a4ba96e61f210f2f544f27
+  data.tar.gz: 11304a728a27e23dd7cbf3c7766c674e95c299e229761d80d1bf49b1b6b4386f7cb58fe3b1e2a08cf110b60f6e47fe063c029b669306cddc7a9e10c7c8be3c5b

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,9 +1,12 @@
 # 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
 
@@ -21,10 +24,10 @@ module FeatureToggles
       @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
@@ -32,7 +35,7 @@ module FeatureToggles
     end
 
     def enabled?(feature, *args)
-      enabled_globally?(feature) || !!features.fetch(feature).call(*args)
+      enabled_globally?(feature) || !!features.fetch(feature).resolver.call(*args)
     end
 
     def for(*args)
@@ -51,6 +54,14 @@ module FeatureToggles
       end]
     end
 
+    def each
+      if block_given?
+        features.values.each { |f| yield f }
+      else
+        features.values.to_enum
+      end
+    end
+
     private
 
     attr_reader :features, :env_prefix

data/lib/feature_toggles/version.rb

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

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: feature_toggles
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Michael Merkushin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2019-11-06 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
@@ -58,14 +58,14 @@ 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
@@ -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
@@ -128,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: This gem provides a mechanism for pending features.