bit_toggle 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bit_toggle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Josh Schairbaum
+
+MIT License
+
+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,58 @@
+# BitToggle
+
+An elementary feature toggle implementation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bit_toggle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bit_toggle
+
+## Usage
+
+To enable a feature for a single object:
+
+```ruby
+user = User.find(username)
+BitToggle.enable(:my_new_feature, device)
+```
+
+To enable a bit toggle globally:
+
+```ruby
+BitToggle.enable_globally(:my_new_feature)
+```
+
+To verify if a feature is enabled:
+
+```ruby
+BitToggle.enabled?(:my_new_feature, user)
+```
+
+To implement this in your codebase:
+
+```ruby
+def perform
+  if BitToggle.enabled?(:my_new_feature, user)
+    do_the_new_feature
+  else
+    do_the_old_feature
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bit_toggle.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bit_toggle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bit_toggle"
+  spec.version       = BitToggle::VERSION
+  spec.authors       = ["Josh Schairbaum"]
+  spec.email         = ["josh.schairbaum@rackspace.com"]
+  spec.description   = %q{An elementary feature toggle implementation}
+  spec.summary       = %q{An elementary feature toggle implementation}
+  spec.homepage      = "https://github.com/rackerlabs/bit_toggle"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "redis"
+  spec.add_runtime_dependency "redis-namespace"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/bit_toggle.rb

@@ -0,0 +1,44 @@
+require "bit_toggle/version"
+require "redis"
+require "redis-namespace"
+
+module BitToggle
+  extend self
+
+  def disable(feature, object)
+    $redis.srem(feature_key(feature), object_key(object))
+  end
+
+  def disabled?(feature, object)
+    !enabled?(feature, object)
+  end
+
+  def enable(feature, object)
+    $redis.sadd(feature_key(feature), object_key(object))
+  end
+
+  def enable_globally(feature)
+    enable(feature, :global)
+  end
+
+  def enabled?(feature, object)
+    has_membership?(feature, object) || has_membership?(feature, :global)
+  end
+
+  def feature_key(feature)
+    "features:#{feature.to_s}"
+  end
+
+  def object_key(object)
+    "#{object.class}:#{object.to_s}"
+  end
+
+  def remove(feature)
+    $redis.del(feature_key(feature))
+  end
+
+  private
+  def has_membership?(feature, object)
+    $redis.sismember(feature_key(feature), object_key(object))
+  end
+end

data/lib/bit_toggle/version.rb

@@ -0,0 +1,3 @@
+module BitToggle
+  VERSION = "0.0.1"
+end

data/spec/bit_toggle_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe BitToggle do
+  after do
+    $redis.del set
+  end
+
+  before do
+    $redis.del set
+  end
+
+  let(:feature) { :new_hotness }
+  let(:object)  { double("object", to_s: "to_s")}
+  let(:set)     { BitToggle.feature_key(feature) }
+
+  describe ".disable" do
+    before do
+      BitToggle.enable(feature, object)
+    end
+
+    it "disables the feature for the device" do
+      BitToggle.disable(feature, object)
+      expect(BitToggle.enabled?(feature, object)).to be_false
+    end
+  end
+
+  describe ".enable" do
+    it "enables the feature for the device" do
+      BitToggle.enable(feature, object)
+      expect(BitToggle.enabled?(feature, object)).to be_true
+    end
+  end
+
+  describe ".enable_globally" do
+    it "enables the feature globally" do
+      BitToggle.enable_globally(feature)
+      expect(BitToggle.enabled?(feature, :global)).to be_true
+    end
+  end
+
+  describe ".enabled?" do
+    context "with a feature enabled" do
+      before do
+        BitToggle.enable(feature, object)
+      end
+
+      it "returns true" do
+        expect(BitToggle.enabled?(feature, object)).to be_true
+      end
+    end
+
+    context "with a feature enabled globally" do
+      before do
+        BitToggle.enable(feature, :global)
+      end
+
+      it "returns true" do
+        expect(BitToggle.enabled?(feature, object)).to be_true
+      end
+    end
+
+    context "without a feature enabled" do
+      it "returns false" do
+        expect(BitToggle.enabled?(feature, object)).to be_false
+      end
+    end
+  end
+
+  describe ".disabled?" do
+    it "returns the inverse of .enabled?" do
+      expect(!BitToggle.enabled?(feature, object)).
+        to eq(BitToggle.disabled?(feature, object))
+    end
+  end
+
+  describe ".feature_key" do
+    it "returns the key for the feature" do
+      expect(BitToggle.feature_key(feature)).to eq("features:#{feature.to_s}")
+    end
+  end
+
+  describe ".object_key" do
+    it "returns the key for the object" do
+      expect(BitToggle.object_key(object)).to eq("#{object.class.name}:#{object.to_s}")
+    end
+  end
+
+  describe ".remove" do
+    it "removes the feature completely" do
+      BitToggle.remove(feature)
+      expect($redis.exists(set)).to be_false
+    end
+  end
+end

data/spec/bit_toggler_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe BitToggle do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bit_toggle'
+
+client = Redis.new
+$redis = Redis::Namespace.new(:bit_toggle, redis: client)

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: bit_toggle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josh Schairbaum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-06 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An elementary feature toggle implementation
+email:
+- josh.schairbaum@rackspace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bit_toggle.gemspec
+- lib/bit_toggle.rb
+- lib/bit_toggle/version.rb
+- spec/bit_toggle_spec.rb
+- spec/bit_toggler_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rackerlabs/bit_toggle
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -827141383548800648
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -827141383548800648
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An elementary feature toggle implementation
+test_files:
+- spec/bit_toggle_spec.rb
+- spec/bit_toggler_spec.rb
+- spec/spec_helper.rb