RubyGems - binflip - Versions diffs - 0.0.2 → 0.0.3 - Mend

binflip 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

data/Gemfile +1 -0
data/Gemfile.lock +32 -1
data/README.md +32 -2
data/Rakefile +10 -1
data/binflip.gemspec +1 -1
data/lib/binflip.rb +94 -10
data/lib/binflip_rails.rb +6 -0
data/spec/javascripts/BinflipSpec.js +20 -0
data/spec/javascripts/support/jasmine.yml +73 -0
data/test/binflip_test.rb +2 -4
data/vendor/assets/javascripts/binflip.js +32 -0
metadata +15 -3

data/Gemfile CHANGED Viewed

@@ -5,5 +5,6 @@ gemspec
 gem 'rake'
 gem 'mocha'
 gem 'pry'
+gem 'jasmine'
 gem 'redis', :require => false
 gem 'rollout', :require => false

data/Gemfile.lock CHANGED Viewed

@@ -1,23 +1,53 @@
 PATH
   remote: .
   specs:
-    binflip (0.0.1)
+    binflip (0.0.3)
 GEM
   remote: http://rubygems.org/
   specs:
+    addressable (2.2.8)
+    childprocess (0.3.2)
+      ffi (~> 1.0.6)
     coderay (1.0.5)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    jasmine (1.2.0)
+      jasmine-core (>= 1.2.0)
+      rack (~> 1.0)
+      rspec (>= 1.3.1)
+      selenium-webdriver (>= 0.1.3)
+    jasmine-core (1.2.0)
+    libwebsocket (0.1.3)
+      addressable
     metaclass (0.0.1)
     method_source (0.7.1)
     mocha (0.11.0)
       metaclass (~> 0.0.1)
+    multi_json (1.3.5)
     pry (0.9.8.2)
       coderay (~> 1.0.5)
       method_source (~> 0.7)
       slop (>= 2.4.4, < 3)
+    rack (1.4.1)
     rake (0.9.2.2)
     redis (2.2.2)
     rollout (1.1.0)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.0)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    rubyzip (0.9.8)
+    selenium-webdriver (2.21.2)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
+      rubyzip
     slop (2.4.4)
 PLATFORMS
@@ -25,6 +55,7 @@ PLATFORMS
 DEPENDENCIES
   binflip!
+  jasmine
   mocha
   pry
   rake

data/README.md CHANGED Viewed

@@ -12,7 +12,7 @@ Keeping true to twelve-factor application principles <http://12factor.net>, this
 Rollout Compatibility
 ======================
-If Rollout <https://github.com/jamesgolick/rollout> is present, it will delegate all methods, adding to `active?` a preliminary test to see if the environment toggle is on before checking rollout.
+If Rollout <https://github.com/jamesgolick/rollout> is present, it will pass through most rollout methods except `active?`, where a preliminary test is done to see if the environment toggle is active first.
 Rationale
 =========
@@ -64,6 +64,23 @@ Check for toggles, using just the [name]:
 NOTE: Absence of feature toggle env variable means the feature is not active.
+binflip.js
+=========
+To use binflip.js, you need to include `vendor/assets/javascripts/binflip.js`, and have `JSON.parse` available (use https://github.com/douglascrockford/JSON-js/blob/master/json2.js if you are using an old browser).  If you are using Rails 3.1 or higher, including the Binflip gem will make it available, just require 'binflip' in your application.js manifest.
+The javascript pattern is to build the feature set (for the current user) once during page load, and store the set of features as a data attribute in the `<body>` tag.
+So in your `<body>` tag, do something like this:
+    <body data-features='<%= $binflip.active_features(current_user).to_json %>'>
+Then you can test for features in your javascript with:
+    if (Binflip.isActive('feature')) {
+      alert("Feature is active");
+    }
 Usage with Rollout
 ==================
@@ -77,7 +94,8 @@ Procfile
 Then in application setup / initialization:
     $redis = Redis.new
-    $toggle = Binflip.new($redis)
+    $rollout = Rollout.new($redis)
+    $toggle = Binflip.new($rollout)
 Check for toggles:
@@ -87,6 +105,18 @@ Check for toggles:
 If Rollout is present, Binflip delegates all methods to it (such as `activate_user`).
+Environment Keys and Case Sensitivity
+=====================================
+As it is customary to set `ENVIRONMENT_VARS` in all upcase, environment feature keys are upcase'd.  So you *must* set your env keys to all upcase -- e.g. `FEATURE_MY_COOL_FEATURE`.  But you can test with upcase, lowercase or as a symbol:
+    $binflip.active?(:my_cool_feature)
+    $binflip.active?('my_cool_feature')
+    $binflip.active?('MY_COOL_FEATURE')
+These are all equivalent and will test for `FEATURE_MY_COOL_FEATURE` in the `ENV` hash.  NOTE: this convention is only for `ENV` and not for rollout.
 License
 =======

data/Rakefile CHANGED Viewed

@@ -6,4 +6,13 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
-task :default => :test
+task :default => [ :test, "jasmine:ci" ]
+begin
+  require 'jasmine'
+  load 'jasmine/tasks/jasmine.rake'
+rescue LoadError
+  task :jasmine do
+    abort "Jasmine is not available. In order to run jasmine, you must: (sudo) gem install jasmine"
+  end
+end

data/binflip.gemspec CHANGED Viewed

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   s.name        = "binflip"
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Brian Kaney"]
   s.email       = ["brian@vermonster.com"]

data/lib/binflip.rb CHANGED Viewed

@@ -1,28 +1,74 @@
-require 'delegate'
+require 'set'
+if defined?(Rails) && defined?(Rails::Engine)
+  require 'binflip_rails'
+end
+class FauxRedis
+  def smembers(*_); []; end
+  def sadd(*_); true; end
+  def srem(*_); true; end
+  def del(*_); 0; end
+end
 class Binflip
+  @rollout = false
-  def self.rollout?
-    defined?(Rollout) == 'constant'
+  def initialize(rollout=nil)
+    if rollout && rollout.is_a?(Rollout)
+      @rollout = rollout
+    end
   end
-  def initialize(redis=nil)
-    if Binflip.rollout?
-      @source = SimpleDelegator.new(Rollout.new(redis))
+  def rollout?
+    !! @rollout
+  end
+  def redis
+    @redis ||= if rollout?
+      @rollout.instance_variable_get(:@redis)
+    else
+      FauxRedis.new
     end
   end
   def active?(feature, user=nil)
-    if environment_active?(feature) && @source
-      @source.active?(feature, user)
+    if environment_active?(feature) && rollout? && user
+      @rollout.active?(feature, user)
     else
       environment_active?(feature)
     end
   end
+  def active_features(user=nil)
+    active_features ||= {}
+    features.each do |feature|
+      active_features[feature] = active?(feature, user)
+    end
+    active_features
+  end
+  def activate_group(feature, group)
+    @rollout.activate_group(feature, group)
+    feature_set_add(feature)
+  end
+  def activate_user(feature, user)
+    @rollout.activate_user(feature, user)
+    feature_set_add(feature)
+  end
+  def cleanup_feature_set!
+    features_rollout.each do |feature|
+      unused_feature = { :percentage => 0, :groups => [], :users => [] }
+      feature_set_del(feature) if (@source.info(feature) == unused_feature)
+    end
+  end
   def method_missing(meth, *args, &block)
-    if @source
-      @source.send(meth, *args, &block)
+    if rollout?
+      @rollout.send(meth, *args, &block)
+      cleanup_feature_set! if (meth =~ /(:de)?activate/)
     else
       super
     end
@@ -30,6 +76,10 @@ class Binflip
   private
+  def environment_key_pattern
+    /^FEATURE_(.*)$/
+  end
   def environment_key(feature)
     ("FEATURE_%s" % feature).upcase
   end
@@ -37,4 +87,38 @@ class Binflip
   def environment_active?(feature)
     ENV[environment_key(feature)] == '1'
   end
+  def feature_set_purge
+    redis.del(feature_set_key)
+  end
+  def feature_set_del(feature)
+    redis.srem(feature_set_key, feature)
+  end
+  def feature_set_add(feature)
+    redis.sadd(feature_set_key, feature)
+  end
+  def feature_set_key
+    'features'
+  end
+  # Set of all feature keys
+  def features
+    features_environment + features_rollout
+  end
+  def features_rollout
+    redis.smembers(feature_set_key).to_set
+  end
+  def features_environment
+    ENV.keys.reduce(Set.new) do |s,k|
+      s << $1 if (k =~ environment_key_pattern)
+      s
+    end
+  end
 end

data/lib/binflip_rails.rb ADDED Viewed

@@ -0,0 +1,6 @@
+module BinflipRails
+  if defined?(Rails) && defined?(Rails::Engine)
+    class Engine < Rails::Engine
+    end
+  end
+end

data/spec/javascripts/BinflipSpec.js ADDED Viewed

@@ -0,0 +1,20 @@
+describe("Binflip", function () {
+  beforeEach(function () {
+    var body = document.getElementsByTagName('body')[0];
+    body.setAttribute("data-features", '{"feature_on":true, "feature_off":false}');
+  });
+  it("should be true", function () {
+    expect(Binflip.isActive("feature_on")).toEqual(true);
+  });
+  it("should be false", function () {
+    expect(Binflip.isActive("feature_off")).toEqual(false);
+  });
+  it("should be false", function () {
+    expect(Binflip.isActive("feature_unknown")).toEqual(false);
+  });
+});

data/spec/javascripts/support/jasmine.yml ADDED Viewed

@@ -0,0 +1,73 @@
+# src_files
+#
+# Return an array of filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# src_files:
+#   - lib/source1.js
+#   - lib/source2.js
+#   - dist/**/*.js
+#
+src_files:
+    - vendor/assets/javascripts/**/*.js
+# stylesheets
+#
+# Return an array of stylesheet filepaths relative to src_dir to include before jasmine specs.
+# Default: []
+#
+# EXAMPLE:
+#
+# stylesheets:
+#   - css/style.css
+#   - stylesheets/*.css
+#
+stylesheets:
+# helpers
+#
+# Return an array of filepaths relative to spec_dir to include before jasmine specs.
+# Default: ["helpers/**/*.js"]
+#
+# EXAMPLE:
+#
+# helpers:
+#   - helpers/**/*.js
+#
+helpers:
+# spec_files
+#
+#  Return an array of filepaths relative to spec_dir to include.
+# Default: ["**/*[sS]pec.js"]
+#
+# EXAMPLE:
+#
+# spec_files:
+#   - **/*[sS]pec.js
+#
+spec_files:
+# src_dir
+#
+# Source directory path. Your src_files must be returned relative to this path. Will use root if left blank.
+# Default: project root
+#
+# EXAMPLE:
+#
+# src_dir: public
+#
+src_dir:
+# spec_dir
+#
+# Spec directory path. Your spec_files must be returned relative to this path.
+# Default: spec/javascripts
+#
+# EXAMPLE:
+#
+# spec_dir: spec/javascripts
+#
+spec_dir:

data/test/binflip_test.rb CHANGED Viewed

@@ -13,8 +13,6 @@ describe Binflip do
   describe "without rollout" do
     before do
-      Binflip.stubs(:rollout?).returns(false)
       @binflip = Binflip.new
       ENV['FEATURE_X'] = "1"
       ENV['FEATURE_Y'] = "0"
@@ -34,11 +32,11 @@ describe Binflip do
     describe "with Rollout" do
       before do
-        Binflip.expects(:rollout?).returns(true)
         Redis.new.flushdb
         @redis = Redis.new
-        @binflip = Binflip.new(@redis)
+        @rollout = Rollout.new(@redis)
+        @binflip = Binflip.new(@rollout)
         ENV['FEATURE_X'] = "1"
         ENV['FEATURE_Y'] = "0"
       end

data/vendor/assets/javascripts/binflip.js ADDED Viewed

@@ -0,0 +1,32 @@
+/**
+ * Usage:
+ *
+ * Set data-features in the <body> tag -- i.e.:
+ *
+ *    <body data-features='{"feature_a":true}'>
+ *
+ * Then in JS, access the Binflip.isActive(feature_name) function:
+ *
+ *    if (Binflip.isActive("feature_a")) {
+ *      // feature is on
+ *    }
+ *
+ */
+var Binflip = {
+  isActive: function (feature) {
+    var els = document.getElementsByTagName('body');
+    if (els.length != 1) {
+      throw new Error("Can't find one and onlye one <body> element!");
+    }
+    try {
+      if (JSON.parse(els[0].getAttribute('data-features'))[feature]) {
+        return true;
+      }
+    } catch(err) {
+      throw new Error("Could not parse attribute data-features: " + err.message);
+    }
+    return false;
+  }
+}

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binflip
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease:
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-04-20 00:00:00.000000000 Z
+date: 2012-05-21 00:00:00.000000000Z
 dependencies: []
 description: Environment-based feature flipper.  Compatiable with rollout.
 email:
@@ -27,7 +27,11 @@ files:
 - Rakefile
 - binflip.gemspec
 - lib/binflip.rb
+- lib/binflip_rails.rb
+- spec/javascripts/BinflipSpec.js
+- spec/javascripts/support/jasmine.yml
 - test/binflip_test.rb
+- vendor/assets/javascripts/binflip.js
 homepage: ''
 licenses: []
 post_install_message:
@@ -41,17 +45,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2883555097750050300
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2883555097750050300
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.15
+rubygems_version: 1.8.10
 signing_key:
 specification_version: 3
 summary: Kanban Flipper
 test_files:
+- spec/javascripts/BinflipSpec.js
+- spec/javascripts/support/jasmine.yml
 - test/binflip_test.rb