fflags 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5268321d568d3ff52cecb10111988e1d0574901
-  data.tar.gz: b7f9586ecb6eafb4ba8492e1303dde0d6ec9803f
+  metadata.gz: 5d1389be1843e51448d44241e0ad68dca1cfa88c
+  data.tar.gz: 9bf7ce3976e7d2fb5604b3a36e23ed3b1cfe78f7
 SHA512:
-  metadata.gz: 5482d73658767d5b23864b159bd44439c921510ba2c5d40931c5244297d4baadd93cf4a7dfd003f56217b73e80e22520da9cf93a182123f6bccd02470969a96b
-  data.tar.gz: df7018b9489c7bd55e6d9c11a70d597f8bee8a35b16506f6923307b561fa944235e61420c40dc8d58dcdd54c454ca3a86648bec673a9ca71c254057ffb48531b
+  metadata.gz: 7a72393c11306763e0314b4007e90fb7108188efd380dd451ec8df36817addca0da376c8b8ba30551e4a84fc86f7e8c4cf9029f9d05d33cf76a4582e34ab6c9f
+  data.tar.gz: a80092d308cf47f2b3d364d62ebfaeafdc36872d097a518190b95f5c167791c3e580912043fce0f3873cd680225b448f46e2b8dc76d5b54c83f2e55873101143

data/Gemfile.lock

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

data/README.md

@@ -1,5 +1,9 @@
 # FFlags
 
+Feature flags that can be overwritten on the fly. It could be per instance or per environment. Depending on how you set your key, either dynamically per instance or constant per environment.
+
+It uses Redis to store the information, and the size should be very small, depending on how many flags you need to track.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -15,28 +19,62 @@ And then execute:
 Or install it yourself as:
 
     $ gem install fflags
+    
+    
+## How to Configure FFlags
 
-## Usage
+To configure the FFlags, 
 
 ```ruby
-require 'socket'
+FFlags.config { |config .. }
+```
+
+#### Supported Configs
+
+| Config    | Description       | Default |
+|-----------|-------------------|---------|
+| key       | Key to store the flags, in Redis, it would look something like, `{ key: <flags as a Hash> }` | code3.io |
+| flags     | Flags to be tracked as a Hash, and value as a boolean) | {} |
+| redis_url | Redis url, where the flags will be stored | redis://127.0.0.1:6379 |
+| debug     | For debugging, NOT BEING USED RIGHT NOW | false |
 
+## Example of Usage
+
+- If you want the flags to be unique per instance, you can use hostname of the instance as such:
+
+```ruby
 FFlags.config do |config|
   config.key   = Socket.gethostname
   config.flags = { new_view: true }
 end
 ```
 
+- If you want the flags to be unique per environment, you can use the key as such:
+
+```ruby
+FFlags.config do |config|
+  config.key   = Rails.environment,
+  config.flags = { new_view: true }
+end
+```
+
 Then in the code,
 
 ```ruby
 # Verify if the flag is enabled
-FFlags.enabled?(:new_view)
+if FFlags.enabled?(:new_view)
+  # Do something
+end
+# or
+if FFlags.new_view?
+  # Do something
+end
+
 
 # Overwrite flag
 FFlags.toggle(:new_view)
 # or
-FFlags.set_flag(:new_view, false)
+FFlags.set(:new_view, false)
 
 # To reset, and get back to the default settings.
 FFlags.reset

data/lib/fflags/version.rb

@@ -0,0 +1,3 @@
+module FFlags
+  VERSION = '0.3.2'.freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fflags
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Faizal Zakaria
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-26 00:00:00.000000000 Z
+date: 2017-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -97,11 +97,11 @@ files:
 - README.md
 - Rakefile
 - fflags.gemspec
-- lib/FFlags/version.rb
 - lib/fflags.rb
 - lib/fflags/api.rb
 - lib/fflags/configuration.rb
 - lib/fflags/redis_client.rb
+- lib/fflags/version.rb
 homepage: https://faizalzakaria.github.com
 licenses:
 - MIT

data/lib/FFlags/version.rb

@@ -1,3 +0,0 @@
-module FFlags
-  VERSION = '0.3.1'.freeze
-end