fflags 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fc3fda9bba9167cddbb98a303939e34afd02bfb
-  data.tar.gz: fb86663e91208f86cb779f54e6f33e76bca378bd
+  metadata.gz: d4473f7c614ad41d5c5e4d2e1df559278c20a200
+  data.tar.gz: 6b61fdfd07f57f0a580a4b51d74f9a028e95e6ed
 SHA512:
-  metadata.gz: c7257ecf830e6eb41c8c3fe21087c94c09a794e9bad4235c1ee0f12f857789e0b053199f67f3b20ef1a44674b5a7f0c00af851881db73eefedf535297747ff38
-  data.tar.gz: 07d5ddca50a961399945aed7e235ecd22c8f26765880a172ba2d2ed143c9c9525d60ebb59e38af297b16eacb9a641095614143981e675e31e1961eef946b9c73
+  metadata.gz: b0a4880777a7f39c28b1dfa8b9148a336289e1d75414e115d9f3317c19250d6cfe3e65b06c35366f8ecba0205cff072837ef60b52ca42bc11ba384c2569c3b55
+  data.tar.gz: a3b7fc42322093bedfb9ae164fabb37f47eda40951ef7a6ba6805cb2b91710c92ea5e9b3f64824a830c9081e4a4d0e89ce5369633adbe1b15b1db0e2c4e63e35

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fflags (0.4.2)
+    fflags (0.4.3)
       redis (>= 3.0.0)
 
 GEM

data/README.md

@@ -87,6 +87,82 @@ FFlags.reset
 FFlags.all
 ```
 
+## To use in Rails
+
+- Add the gem in Gemfile.
+
+```ruby
+# Gemfile.rb
+
+gem 'fflags'
+```
+
+- Add the initializer.
+
+```ruby
+# config/initializer/fflags.rb
+
+FFlags.config do |config|
+  config.flags = { new_feature: true }
+  ..
+end
+```
+
+- Use the feature anywhere in your code.
+
+```ruby
+if FFlags.new_feature?
+  puts 'Enabled'
+end
+```
+
+## Template
+
+Sometimes you need to set a set of flags in 1 go. Ex. Staging to have an exact same flag configuration as in Production.
+You can use template for this.
+
+Ex.
+
+In the config,
+
+```ruby
+FFlags.config do |config|
+  config.flags = { feature1: true, feature2: true, feature3: true }
+  config.templates = { production: { feature1: false, feature2: false, feature3: false } }
+end
+```
+
+Then in your code,
+
+```ruby
+FFlags.set_as_template(:production)
+
+# To view all the templates
+FFlags.templates
+```
+
+## Testing
+
+Sometimes you need to test flag with different value in your test. You can set block for that.
+
+Ex. in `rspec`
+
+```ruby
+describe "#eat_tofu" do
+  context 'new feature enabled' do
+    FFlags.set(new_feature: true) do
+      # Do something
+    end
+  end
+  
+  context 'new feature disabled' do
+    FFlags.set(new_feature: false) do
+      # Do something
+    end
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests.

data/lib/fflags.rb

@@ -20,6 +20,15 @@ module FFlags
     api.load_flags
   end
 
+  # Reset the whole config to the default values
+  #
+  # Ex.
+  #   FFlags.reset_config
+  def reset_config
+    @configuration = nil
+    reset
+  end
+
   # Returns all supported flags.
   #
   # Ex.
@@ -28,6 +37,32 @@ module FFlags
     api.flags
   end
 
+  # Returns all templates.
+  #
+  # Ex.
+  #    FFlags.templates
+  def templates
+    configuration.templates
+  end
+
+  # Sets as given template.
+  # It will returns false if the template doesn't exists
+  #
+  # Ex.
+  #    FFlags.set_as_template(:template_name)
+  def set_as_template(template)
+    template = templates[template.to_sym] || templates[template.to_s]
+
+    return false unless template
+
+    status = true
+    template.each_pair do |key, value|
+      status &&= set(key, value)
+    end
+
+    status
+  end
+
   # Check if the flag is enabled,
   # it returns true | false.
   #

data/lib/fflags/configuration.rb

@@ -1,7 +1,7 @@
 module FFlags
   # Configuration Class
   class Configuration
-    attr_accessor :key, :redis_url, :debug, :flags
+    attr_accessor :key, :redis_url, :debug, :flags, :templates
 
     def initialize
       set_default_values
@@ -14,6 +14,7 @@ module FFlags
       @redis_url = 'redis://127.0.0.1:6379'
       @debug     = false
       @flags     = {}
+      @templates = {}
     end
   end
 end

data/lib/fflags/version.rb

@@ -1,3 +1,3 @@
 module FFlags
-  VERSION = '0.4.2'.freeze
+  VERSION = '0.4.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fflags
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Faizal Zakaria
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-07 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis