feature_creep 0.0.1

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+*~
+\#*
+.\#*
+
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    feature_creep (0.0.1)
+      redis
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bourne (1.0)
+      mocha (= 0.9.8)
+    coderay (1.0.7)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    method_source (0.8)
+    mocha (0.9.8)
+      rake
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (0.9.2.2)
+    redis (3.0.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    slop (3.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bourne (= 1.0)
+  bundler (>= 1.0.0)
+  feature_creep!
+  jeweler (~> 1.6.4)
+  mocha (= 0.9.8)
+  pry (= 0.9.10)
+  rspec (~> 2.10.0)

data/License

@@ -0,0 +1,21 @@
+Copyright (c) 2009 James Golick
+Copyright (c) 2012 Christian Trosclair
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,25 @@
+feature_creep
+=============
+
+I've got your feature flags implementation right here.
+
+This is a fork/rewrite of James Golick's Rollout with messy and incomplete docs.
+
+So far, the specs are green and are mostly inherited from Rollout.
+This is not a drop in replacement. The API has aleadey changed.
+
+Namely, `groups` are now `scopes` and `users` are `agent_ids`.
+Agent_ids are expected to be uuids, not the object itself.
+
+The class constructor now takes a datastore and an options hash.
+
+options[:info] should be a lambda that returns a hash when called
+
+options[:warden] is also a lambda that encapsulates the business logic for FeatureCreep#active?
+
+options[:scopes] is a hash that expects a string key and a lambda that encapsulates the business logic for membership in a scope
+
+
+At this point it should be easy to extend.
+I would expect the API to stablize over the next couple of weeks.
+

data/feature_creep.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "feature_creep/version"
+
+Gem::Specification.new do |s|
+  s.name = "feature_creep"
+  s.version = FeatureCreep::VERSION
+  s.authors = ["Christian Trosclair"]
+  s.email       = ["xn@gotham.us"]
+  s.description = "Feature Flag implementation"
+  s.summary = "Extensible Feature Flags"
+  s.homepage = "https://github.com/xn/feature_creep"
+
+  s.require_paths = ["lib"]
+
+  s.rubyforge_project = "feature_creep"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec", "~> 2.10.0"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "jeweler", "~> 1.6.4"
+  s.add_development_dependency "bourne", "1.0"
+  s.add_development_dependency "mocha", "0.9.8"
+  s.add_development_dependency "pry", "0.9.10"
+
+  s.add_runtime_dependency "redis"
+end

data/lib/feature_creep.rb

@@ -0,0 +1,131 @@
+class FeatureCreep
+
+  attr_accessor :scopes, :info, :warden
+
+  def initialize(datastore, options = {})
+    @datastore = datastore
+    @scopes = {"all" => lambda { |agent_id| true }}
+    if options.has_key?(:scopes)
+      options[:scopes].each do |name,membership_block|
+        @scopes[name.to_s] = membership_block
+      end
+    end
+    @warden = if options.has_key?(:warden)
+      options[:warden]
+    else
+      lambda { |feature,agent_id|
+        if agent_id
+          active_globally?(feature) ||
+            agent_id_in_active_scope?(feature, agent_id) ||
+            agent_id_active?(feature, agent_id) ||
+            agent_id_within_active_percentage?(feature, agent_id)
+        else
+          active_globally?(feature)
+        end
+      }
+    end
+    @info = if options.has_key?(:info)
+      options[:info]
+    else lambda { |feature|
+        if feature
+          {
+            :percentage => (active_percentage(feature) || 0).to_i,
+            :scopes     => active_scopes(feature).map { |g| g.to_sym },
+            :agent_ids      => active_agent_id_ids(feature),
+            :global     => active_global_features
+          }
+        else
+          {
+            :global     => active_global_features
+          }
+        end
+      }
+    end
+  end
+
+  def activate_globally(feature)
+    @datastore.activate_globally(feature)
+  end
+
+  def deactivate_globally(feature)
+    @datastore.deactivate_globally(feature)
+  end
+
+  def activate_scope(feature, scope)
+    @datastore.activate_scope(feature, scope)
+  end
+
+  def deactivate_scope(feature, scope)
+    @datastore.deactivate_scope(feature, scope)
+  end
+
+  def deactivate_all(feature)
+    @datastore.deactivate_all(feature)
+  end
+
+  def activate_agent_id(feature, agent_id)
+    @datastore.activate_agent_id(feature, agent_id)
+  end
+
+  def deactivate_agent_id(feature, agent_id)
+    @datastore.deactivate_agent_id(feature, agent_id)
+  end
+
+  def active?(feature, agent_id = nil)
+    @warden.call(feature,agent_id)
+  end
+
+  def activate_percentage(feature, percentage)
+    @datastore.activate_percentage(feature, percentage)
+  end
+
+  def deactivate_percentage(feature)
+    @datastore.deactivate_percentage(feature)
+  end
+
+  def current_features
+    @datastore.current_features
+  end
+
+  def add_feature(feature)
+    @datastore.add_feature(feature)
+  end
+
+  def info(feature = nil)
+    @info.call(feature)
+  end
+
+  def active_scopes(feature)
+    @datastore.active_scopes(feature)
+  end
+
+  def active_agent_id_ids(feature)
+    @datastore.active_agent_id_ids(feature)
+  end
+
+  def active_global_features
+    @datastore.active_global_features
+  end
+
+  def active_percentage(feature)
+    @datastore.active_percentage(feature)
+  end
+
+  def active_globally?(feature)
+    @datastore.active_globally?(feature)
+  end
+
+  def agent_id_in_active_scope?(feature, agent_id)
+    active_scopes(feature).any? do |scope|
+      @scopes.key?(scope) && @scopes[scope].call(agent_id)
+    end
+  end
+
+  def agent_id_active?(feature, agent_id)
+    @datastore.agent_id_active?(feature, agent_id)
+  end
+
+  def agent_id_within_active_percentage?(feature, agent_id)
+    @datastore.agent_id_within_active_percentage?(feature, agent_id)
+  end
+end

data/lib/feature_creep/redis_datastore.rb

@@ -0,0 +1,133 @@
+class FeatureCreep
+  class RedisDataStore
+
+    def initialize(datastore = nil, key_prefix = "feature_creep")
+      @key_prefix = key_prefix
+      @redis = datastore || Redis.new
+    end
+
+    def activate_globally(feature)
+      @redis.sadd(global_key, feature)
+    end
+
+    def deactivate_globally(feature)
+      @redis.srem(global_key, feature)
+    end
+
+    def activate_scope(feature, scope)
+      @redis.sadd(scope_key(feature), scope)
+    end
+
+    def deactivate_scope(feature, scope)
+      @redis.srem(scope_key(feature), scope)
+    end
+
+    def deactivate_all(feature)
+      @redis.del(scope_key(feature))
+      @redis.del(agent_id_key(feature))
+      @redis.del(percentage_key(feature))
+      deactivate_globally(feature)
+    end
+
+    def activate_agent_id(feature, agent_id)
+      @redis.sadd(agent_id_key(feature), agent_id)
+    end
+
+    def deactivate_agent_id(feature, agent_id)
+      @redis.srem(agent_id_key(feature), agent_id)
+    end
+
+    def active?(feature, agent_id = nil)
+      if agent_id
+        active_globally?(feature) ||
+          agent_id_in_active_scope?(feature, agent_id) ||
+          agent_id_active?(feature, agent_id) ||
+          agent_id_within_active_percentage?(feature, agent_id)
+      else
+        active_globally?(feature)
+      end
+    end
+
+    def activate_percentage(feature, percentage)
+      @redis.set(percentage_key(feature), percentage)
+    end
+
+    def deactivate_percentage(feature)
+      @redis.del(percentage_key(feature))
+    end
+
+    def info(feature = nil)
+      if feature
+        {
+          :percentage => (active_percentage(feature) || 0).to_i,
+          :scopes     => active_scopes(feature).map { |g| g.to_sym },
+          :agent_ids  => active_agent_id_ids(feature),
+          :global     => active_global_features
+        }
+      else
+        {
+          :features   => current_features
+        }
+      end
+    end
+
+    def active_scopes(feature)
+      @redis.smembers(scope_key(feature)) || []
+    end
+
+    def active_agent_id_ids(feature)
+      @redis.smembers(agent_id_key(feature)).map { |id| id.to_i }
+    end
+
+    def active_global_features
+      (@redis.smembers(global_key) || []).map(&:to_sym)
+    end
+
+    def active_percentage(feature)
+      @redis.get(percentage_key(feature))
+    end
+
+    def active_globally?(feature)
+      @redis.sismember(global_key, feature)
+    end
+
+    def agent_id_active?(feature, agent_id)
+      @redis.sismember(agent_id_key(feature), agent_id)
+    end
+
+    def agent_id_within_active_percentage?(feature, agent_id)
+      percentage = active_percentage(feature)
+      return false if percentage.nil?
+      agent_id % 100 < percentage.to_i
+    end
+
+    def current_features
+      @redis.smembers(@key_prefix)
+    end
+
+    def add_feature(feature)
+      redis.sadd(@key_prefix, feature)
+    end
+
+    private
+    def key(name)
+      "#{@key_prefix}:#{name}"
+    end
+
+    def scope_key(name)
+      "#{key(name)}:scopes"
+    end
+
+    def agent_id_key(name)
+      "#{key(name)}:agent_ids"
+    end
+
+    def percentage_key(name)
+      "#{key(name)}:percentage"
+    end
+
+    def global_key
+      "#{@key_prefix}:__global__"
+    end
+  end
+end

data/lib/feature_creep/version.rb

@@ -0,0 +1,3 @@
+class FeatureCreep
+  VERSION = "0.0.1"
+end

data/spec/feature_creep_spec.rb

@@ -0,0 +1,222 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FeatureCreep" do
+  before do
+    @datastore = FeatureCreep::RedisDataStore.new
+    scopes = {
+      :fivesonly => lambda { |agent_id| agent_id == 5 }
+    }
+    @feature_creep = FeatureCreep.new(@datastore, {:scopes => scopes})
+  end
+
+  describe "when a scope is activated" do
+    before do
+      @feature_creep.activate_scope(:chat, :fivesonly)
+    end
+
+    it "the feature is active for agent_ids for which the block evaluates to true" do
+      @feature_creep.should be_active(:chat, 5)
+    end
+
+    it "is not active for agent_ids for which the block evaluates to false" do
+      @feature_creep.should_not be_active(:chat, 1)
+    end
+
+    it "is not active if a scope is found in Redis but not defined in FeatureCreep" do
+      @feature_creep.activate_scope(:chat, :fake)
+      @feature_creep.should_not be_active(:chat, 1)
+    end
+  end
+
+  describe "the default all scope" do
+    before do
+      @feature_creep.activate_scope(:chat, :all)
+    end
+
+    it "evaluates to true no matter what" do
+      @feature_creep.should be_active(:chat, 0)
+    end
+  end
+
+  describe "deactivating a scope" do
+    before do
+      @feature_creep.activate_scope(:chat, :all)
+      @feature_creep.activate_scope(:chat, :fivesonly)
+      @feature_creep.deactivate_scope(:chat, :all)
+    end
+
+    it "deactivates the rules for that scope" do
+      @feature_creep.should_not be_active(:chat, 10)
+    end
+
+    it "leaves the other scopes active" do
+      @feature_creep.should be_active(:chat, 5)
+    end
+  end
+
+  describe "deactivating a feature completely" do
+    before do
+      @feature_creep.activate_scope(:chat, :all)
+      @feature_creep.activate_scope(:chat, :fivesonly)
+      @feature_creep.activate_agent_id(:chat, 51)
+      @feature_creep.activate_percentage(:chat, 100)
+      @feature_creep.activate_globally(:chat)
+      @feature_creep.deactivate_all(:chat)
+    end
+
+    it "removes all of the scopes" do
+      @feature_creep.should_not be_active(:chat, 0)
+    end
+
+    it "removes all of the agent_ids" do
+      @feature_creep.should_not be_active(:chat, 51)
+    end
+
+    it "removes the percentage" do
+      @feature_creep.should_not be_active(:chat, 24)
+    end
+
+    it "removes globally" do
+      @feature_creep.should_not be_active(:chat)
+    end
+  end
+
+  describe "activating a specific agent_id" do
+    before do
+      @feature_creep.activate_agent_id(:chat, 42)
+    end
+
+    it "is active for that agent_id" do
+      @feature_creep.should be_active(:chat, 42)
+    end
+
+    it "remains inactive for other agent_ids" do
+      @feature_creep.should_not be_active(:chat, 24)
+    end
+  end
+
+  describe "deactivating a specific agent_id" do
+    before do
+      @feature_creep.activate_agent_id(:chat, 42)
+      @feature_creep.activate_agent_id(:chat, 24)
+      @feature_creep.deactivate_agent_id(:chat, 42)
+    end
+
+    it "that agent_id should no longer be active" do
+      @feature_creep.should_not be_active(:chat, 42)
+    end
+
+    it "remains active for other active agent_ids" do
+      @feature_creep.should be_active(:chat, 24)
+    end
+  end
+
+  describe "activating a feature globally" do
+    before do
+      @feature_creep.activate_globally(:chat)
+    end
+
+    it "activates the feature" do
+      @feature_creep.should be_active(:chat)
+    end
+  end
+
+  describe "activating a feature for a percentage of agent_ids" do
+    before do
+      @feature_creep.activate_percentage(:chat, 20)
+    end
+
+    it "activates the feature for that percentage of the agent_ids" do
+      (1..120).select { |id| @feature_creep.active?(:chat, id) }.length.should == 39
+    end
+  end
+
+  describe "activating a feature for a percentage of agent_ids" do
+    before do
+      @feature_creep.activate_percentage(:chat, 20)
+    end
+
+    it "activates the feature for that percentage of the agent_ids" do
+      (1..200).select { |id| @feature_creep.active?(:chat, id) }.length.should == 40
+    end
+  end
+
+  describe "activating a feature for a percentage of agent_ids" do
+    before do
+      @feature_creep.activate_percentage(:chat, 5)
+    end
+
+    it "activates the feature for that percentage of the agent_ids" do
+      (1..100).select { |id| @feature_creep.active?(:chat, id) }.length.should == 5
+    end
+  end
+
+
+  describe "deactivating the percentage of agent_ids" do
+    before do
+      @feature_creep.activate_percentage(:chat, 100)
+      @feature_creep.deactivate_percentage(:chat)
+    end
+
+    it "becomes inactivate for all agent_ids" do
+      @feature_creep.should_not be_active(:chat, 24)
+    end
+  end
+
+  describe "deactivating the feature globally" do
+    before do
+      @feature_creep.activate_globally(:chat)
+      @feature_creep.deactivate_globally(:chat)
+    end
+
+    it "becomes inactivate" do
+      @feature_creep.should_not be_active(:chat)
+    end
+  end
+
+  describe "#info" do
+    context "global features" do
+      let(:features) { [:signup, :chat, :table] }
+
+      before do
+        features.each do |f|
+          @feature_creep.activate_globally(f)
+        end
+      end
+
+      it "returns all global features" do
+        @feature_creep.info.should eq({ :global => features.reverse })
+      end
+    end
+
+    describe "with a percentage set" do
+      before do
+        @feature_creep.activate_percentage(:chat, 10)
+        @feature_creep.activate_scope(:chat, :caretakers)
+        @feature_creep.activate_scope(:chat, :greeters)
+        @feature_creep.activate_globally(:signup)
+        @feature_creep.activate_agent_id(:chat, 42)
+      end
+
+      it "returns info about all the activations" do
+        @feature_creep.info(:chat).should == {
+          :percentage => 10,
+          :scopes     => [:greeters, :caretakers],
+          :agent_ids      => [42],
+          :global     => [:signup]
+        }
+      end
+    end
+
+    describe "without a percentage set" do
+      it "defaults to 0" do
+        @feature_creep.info(:chat).should == {
+          :percentage => 0,
+          :scopes     => [],
+          :agent_ids      => [],
+          :global     => []
+        }
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'feature_creep'
+require 'feature_creep/redis_datastore'
+require 'rspec'
+require 'bourne'
+require 'redis'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.before { Redis.new.flushdb }
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: feature_creep
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christian Trosclair
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: bourne
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Feature Flag implementation
+email:
+- xn@gotham.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- License
+- README.md
+- feature_creep.gemspec
+- lib/feature_creep.rb
+- lib/feature_creep/redis_datastore.rb
+- lib/feature_creep/version.rb
+- spec/feature_creep_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/xn/feature_creep
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: feature_creep
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Extensible Feature Flags
+test_files:
+- spec/feature_creep_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb