feature_cop 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f90532fb87a21090eb99cc8122997d0ce462b08
-  data.tar.gz: 01ddaf927a04082461a1227fd34941f0b2b751cb
+  metadata.gz: 9e1f95a32775c436171633f817e7e76822c29286
+  data.tar.gz: 60e06e3dd10ed4ca78b65818ace9589589bd982d
 SHA512:
-  metadata.gz: d4e7f3ec3d361dd151e489e865b84d1f0c31e23e139c0db122a8f41cbf05553f1020063bed47f3897f760a702bf54361a51d5c7e6cf1b53da6db7a1d52ae69a3
-  data.tar.gz: 3fcd97b89c919e3491ae224bfca305b27d2073b97f92b273b9fb75ef6e87b45d67a3b82247f91133ce8e201d907f46aae3bdc988a2309c24e30ff34e01d65d3b
+  metadata.gz: a5813436e352897917ae79feab51cea416782fd8a5c8756702eb869db5c04fcb3a3d853c869972ee182639e4d26dd4717e6eab6802f3e028f1bf0b53cd48a93a
+  data.tar.gz: 9731ccc6a042b404048ef56ad720035421aa6f41a060c533de60632de81ef99ddbe50cf83e69cdab8c79a60c3fe6e236e98ffab84c28848db3d1640bae2f1ce5

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+*.gem

data/README.md

@@ -1,6 +1,17 @@
 # FeatureCop
 
-Feature cop is a simple feature toggling system for Ruby. All features are configured in the ENV, following the guidelines of a [12-Factor App](http://12factor.net/config)
+FeatureCop is a simple feature toggling system for Ruby. It provides progressive roll out of features. A common (and my opinion, bad) practice is for developers to use branching as feature control.  Feature Branching leads to humongous pull requests, messy merges, and long integrations.  With continous integration and feature toggling everyone can make small, short lived branches off the mainline, continually merge code, and get code in production even when it isn't ready for launch. 
+
+The following roll out strategies is available:
+
+1. **disabled** - during development, a feature can completely disabled so it isn't seen or executed.
+2. **whitelist_only** - features can be turned on for specific users or groups.  For example, QA users can be whitelisted, then a small group of customers, etc.
+3. **sample10** - feature is enabled for roughly 10% of users
+4. **sample25** - feature is enabled for rougly 25% of users
+5. **sample50** - feature is enabled for rougly 50% of users
+6. **all_except_blacklist** - feature is enabled for everyone except for a specified list of customers.  These customers could be enterprise clients that must be notified before enabling new features, etc.
+6. **enabled** - enabled for all customers.  At this point it is recommended to remove the feature flag from the system as the roll out is complete.
+
 
 ## Installation
 
@@ -17,7 +28,7 @@ Or install it yourself as:
 
 ## Basic Usage - Ruby
 
-Add features definitions to your ENV
+Features are configured in your applications ENV per [12-Factor App](http://12factor.net/config) guidelines.
 
 ```
 MY_COOL_FEATURE = enabled
@@ -39,6 +50,16 @@ else
 end
 ```
 
+You can also pass a string identifier to FeatureCop.  Identifiers can be anything but are typicall a user_id or a group_id.  Identifiers are used for the whitelist, sample10, sample25, sample50, and blacklist feature types.
+
+```ruby
+
+if FeatureCop.allows?(:my_cool_feature, "USERID_123")
+   # execute new feature code
+else
+   # execute old feature code
+end
+```
 
 ## Basic Usage - Javascript
 
@@ -58,6 +79,20 @@ FeatureCop.to_json
 
 ```
 
+You can pass an identifier to the to_json method and it will output the correct feature values for that identifier.
+
+```
+FeatureCop.to_json("USERID_1234")
+#=>
+{
+
+  "myCoolFeature"     : true
+  "loginV1Feature"    : false
+   "menubarV3Feature" : true
+}
+
+```
+
 Because javascript patterns & frameworks vary wildly and change often, we have opted not to provide any furtuer javascript helpers.  The easiset way to use FeatureCop in your client side is to get features into window.env, then you can use simple if statements to control features.
 
 ```javascript

data/lib/feature_cop/version.rb

@@ -1,3 +1,3 @@
 module FeatureCop
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/feature_cop/whitelist.rb

@@ -8,13 +8,14 @@ module FeatureCop
     module ClassMethods
 
       def whitelist_from_yaml(file = "feature_cop_whitelist.yml")
+
         if ::File.exists?(file)
           absolute_path = file       
-        else
-          absolute_path = ::File.expand_path(::File.join("config", file))
-          raise "#{file} not found!" unless ::File.exists?(absolute_path)
+        elsif defined?(Rails)
+          absolute_path = ::File.join(Rails.root, "config", file)
         end
 
+        raise "#{file} not found!" unless ::File.exists?(absolute_path)
         self.whitelist = ::YAML.load_file(absolute_path)[env]      
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feature_cop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Brett Allred