binflip 0.0.1

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.2@binflip --create --verbose

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+ 
+gemspec
+
+gem 'rake'
+gem 'mocha'
+gem 'pry'
+gem 'redis', :require => false
+gem 'rollout', :require => false

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    binflip (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.5)
+    metaclass (0.0.1)
+    method_source (0.7.1)
+    mocha (0.11.0)
+      metaclass (~> 0.0.1)
+    pry (0.9.8.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7)
+      slop (>= 2.4.4, < 3)
+    rake (0.9.2.2)
+    redis (2.2.2)
+    rollout (1.1.0)
+    slop (2.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  binflip!
+  mocha
+  pry
+  rake
+  redis
+  rollout

data/README.md

@@ -0,0 +1,95 @@
+Binflip
+=======
+
+Simple environmental feature toggling (that works well with Rollout)
+
+
+Description
+===========
+
+Keeping true to twelve-factor application principles <http://12factor.net>, this simple library uses environment variables, with a straightforward naming convention, to specify feature toggles.  
+
+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.
+
+Rationale
+=========
+
+When using a continuous delivery process, it is important to try to get all code integrated into the mainline as soon as possible.  Feature toggles are favored over feature branches (<http://www.infoq.com/interviews/jez-humble-martin-fowler-cd>, <http://martinfowler.com/bliki/FeatureToggle.html>, <http://fournines.wordpress.com/2011/11/20/feature-branches-vs-feature-toggles/>, and <http://blog.jayfields.com/2010/10/experience-report-feature-toggle-over.html>) during the dev process (to guard against incomplete features being deployed to production).  
+
+Twelve-factor tells us to keep app configuration setting in environment variables.  Hence this libaray adds a tiny bit of convention on how feature toggle env vars are spelled.
+
+As the ultimate acceptance of a feature is the market response, this library has been designed to work with rollout.
+
+Installation
+============
+
+Add this line to your application's Gemfile:
+
+    gem 'binflip'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install binflip
+
+
+
+Usage
+=====
+
+Set an environment variable following a FEATURE_[name] pattern:
+
+Procfile
+
+    FEATURE_CHAT = 1
+    FEATURE_UPLOAD_VIDEO = 1
+
+(Or set the ENV vars manually)
+
+Then in application setup / initialization:
+
+    $toggle = Binflip.new
+
+
+Check for toggles, using just the [name]:
+
+    $toggle.active?(:chat)
+    $toggle.active?(:upload_video)
+
+NOTE: Absence of feature toggle env variable means the feature is not active.
+
+Usage with Rollout
+==================
+
+Procfile
+
+    FEATURE_CHAT = 1
+    FEATURE_UPLOAD_VIDEO = 1
+
+(Or set the ENV vars manually)
+
+Then in application setup / initialization:
+
+    $redis = Redis.new
+    $toggle = Binflip.new($redis)
+
+
+Check for toggles:
+
+    $toggle.active?(:chat, @user)
+    $toggle.active?(:upload_video, @user)
+
+If Rollout is present, Binflip delegates all methods to it (such as `activate_user`).
+
+License
+=======
+
+Copyright (c) 2012 Brian Kaney
+
+MIT License

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/binflip.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "binflip"
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brian Kaney"]
+  s.email       = ["brian@vermonster.com"]
+  s.homepage    = ""
+  s.summary     = %q{Kanban Flipper}
+  s.description = %q{Environment-based feature flipper.  Compatiable with rollout.}
+
+  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", "tools"]
+end

data/lib/binflip/cucumber.rb

@@ -0,0 +1,56 @@
+require 'binflip'
+
+module Binflip
+  module Cucumber
+    
+    def self.toggle_bin!(current_bin, scenario)
+      # Toggle bin
+      Binflip.module_eval <<-RUBY
+        def self.current_bin
+          return '#{current_bin}'
+        end
+      RUBY
+
+      # Toggle RAILS_ENV
+      ENV["RAILS_ENV"] = Rails.env = "cucumber_#{current_bin}"
+      ActiveRecord::Base.configurations = Rails.application.config.database_configuration
+      ActiveRecord::Base.establish_connection
+
+
+      # Reload routes
+      reload_routes_if_new_bin(scenario)
+    end
+        
+    def self.current_tags(scenario) 
+      [ scenario.instance_variable_get(:@tags).tag_names + 
+        scenario.instance_variable_get(:@feature).instance_variable_get(:@tags).tag_names 
+      ].flatten
+    end
+
+    def self.rails_app
+      raise NotImplementedError
+    end
+
+    def self.reload_routes_if_new_bin(scenario)
+      if current_tags(scenario) != $tags
+        rails_app.reload_routes!
+      end
+    end
+
+  end
+end
+
+Before do |scenario|
+  tags = Binflip::Cucumber.current_tags(scenario)
+
+  if tags.size <= 1
+    bin = tags.first.try(:gsub, '@', '')
+    bin = bin.nil? ? Binflip::DEPLOYED_BIN : bin
+    Binflip::Cucumber.toggle_bin!(bin, scenario)
+  end
+
+end
+
+After do |scenario|
+  $tags = Binflip::Cucumber.current_tags(scenario)
+end

data/lib/binflip/rails/active_support.rb

@@ -0,0 +1,53 @@
+module ActiveRecord
+  # This patch all adds a #skip? method on the migration classes.  It is 
+  # mainly intended to be used with feature toggles.
+  #
+  #    class FauxMigration < ActiveRecord::Migration
+  #
+  #      def skip?
+  #        Feature.active?('178_feature_x')
+  #      end
+  #
+  #      def up
+  #        add_column :patients, :foob, :string
+  #      end
+  #
+  #      def down
+  #        remove_column :patients, :foob
+  #      end
+  #    end
+  #
+  class Migration
+
+    def skip?
+      false
+    end
+
+    def migrate_with_skip(direction)
+      if skip?
+        announce "Skipping Migration, skip? returned true."
+      else
+        migrate_without_skip(direction)
+      end
+    end
+    alias_method :migrate_without_skip, :migrate
+    alias_method :migrate, :migrate_with_skip
+  end
+ 
+  class MigrationProxy
+    delegate :skip?, :to => :migration
+  end
+
+  class Migrator
+    def record_version_state_after_migrating_with_skip(version)
+      current = migrations.detect { |m| m.version == version } # This is actually the proxy for the migration
+      unless current.skip?
+        record_version_state_after_migrating_without_skip(version)
+      end
+    end
+
+    alias_method :record_version_state_after_migrating_without_skip, :record_version_state_after_migrating
+    alias_method :record_version_state_after_migrating, :record_version_state_after_migrating_with_skip
+  end
+
+end

data/lib/binflip/rails/tasks/db.rake

@@ -0,0 +1,29 @@
+require 'binflip'
+
+namespace :db do
+  namespace :test do
+    task :prepare_with_kanban do
+      Binflip::BINS.each do |bin|
+        # Toggle bin
+
+        ENV['RAILS_ENV'] = Rails.env = "cucumber_#{bin}"
+        puts "=== prepare for #{Rails.env}"
+        
+        Binflip.module_eval <<-RUBY
+          def self.current_bin
+            return '#{bin}'
+          end
+        RUBY
+
+        Rake::Task['db:drop'].execute
+        Rake::Task['db:create'].execute
+        Rake::Task['db:migrate'].execute
+        Rake::Task['db:schema:dump'].execute
+        Rake::Task['db:test:prepare_without_kanban'].execute
+      end
+    end
+  end
+end
+
+alias_task('db:test:prepare_without_kanban', 'db:test:prepare')
+alias_task('db:test:prepare', 'db:test:prepare_with_kanban')

data/lib/binflip/rails.rb

@@ -0,0 +1 @@
+require 'binflip/rails/active_support' #if defined?(ActiveSupport::Base)

data/lib/binflip.rb

@@ -0,0 +1,40 @@
+require 'delegate'
+
+class Binflip
+
+  def self.rollout?
+    defined?(Rollout) == 'constant'
+  end
+
+  def initialize(redis=nil)
+    if Binflip.rollout?
+      @source = SimpleDelegator.new(Rollout.new(redis))
+    end
+  end
+
+  def active?(feature, user=nil)
+    if environment_active?(feature) && @source
+      @source.active?(feature, user)
+    else
+      environment_active?(feature)
+    end
+  end
+
+  def method_missing(meth, *args, &block)
+    if @source
+      @source.send(meth, *args, &block)
+    else
+      super
+    end
+  end
+
+  private
+
+  def environment_key(feature)
+    ("FEATURE_%s" % feature).upcase
+  end
+
+  def environment_active?(feature)
+    ENV[environment_key(feature)] == '1'
+  end
+end

data/lib/core_ext/rake.rb

@@ -0,0 +1,14 @@
+# This is an alias method, e.g.:
+#
+#     alias_task(:alias_task, :original_task)
+#
+def alias_task(name, old_name)
+  t = Rake::Task[old_name]
+  desc t.full_comment if t.full_comment
+  task name, *t.arg_names do |_, args|
+    # values_at is broken on Rake::TaskArguments
+    args = t.arg_names.map { |a| args[a] }
+    t.invoke(args)
+  end
+end
+

data/test/binflip_test.rb

@@ -0,0 +1,64 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require 'bundler/setup'
+require 'mocha'
+require 'pry'
+require 'rollout'
+require 'redis'
+require 'binflip'
+
+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"
+    end
+
+    it "should be active" do
+      @binflip.active?(:x).must_equal true
+    end
+
+    it "should not be active" do
+      @binflip.active?(:y).must_equal false
+    end
+
+    it "should not be active for unspecified" do
+      @binflip.active?(:z).must_equal false
+    end
+
+    describe "with Rollout" do
+      before do
+        Binflip.expects(:rollout?).returns(true)
+        Redis.new.flushdb
+
+        @redis = Redis.new
+        @binflip = Binflip.new(@redis)
+        ENV['FEATURE_X'] = "1"
+        ENV['FEATURE_Y'] = "0"
+      end
+
+      it "must be true if the environment is true and rollout is true" do
+        @binflip.activate_user(:x, stub(:id => 51))
+        @binflip.active?(:x, stub(:id => 51)).must_equal true
+      end
+
+      it "must be true if the environment is true and rollout is false" do
+        @binflip.active?(:x, stub(:id => 51)).must_equal false
+      end
+
+      it "must be false if the environment is false" do
+        @binflip.activate_user(:x, stub(:id => 51))
+        @binflip.active?(:y, stub(:id => 51)).must_equal false
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: binflip
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Kaney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-20 00:00:00.000000000 Z
+dependencies: []
+description: Environment-based feature flipper.  Compatiable with rollout.
+email:
+- brian@vermonster.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- binflip.gemspec
+- lib/binflip.rb
+- lib/binflip/cucumber.rb
+- lib/binflip/rails.rb
+- lib/binflip/rails/active_support.rb
+- lib/binflip/rails/tasks/db.rake
+- lib/core_ext/rake.rb
+- test/binflip_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- tools
+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: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Kanban Flipper
+test_files:
+- test/binflip_test.rb