bastet 0.0.2 → 0.1.0

data/README.markdown

@@ -1,31 +1,30 @@
-# Bastet - The unstable beast
-
-Goddess associated with war, protection of Lower Egypt and the pharaoh, the sun, perfumes, ointments and embalming
+# Bastet - The group based feature rollout beast
 
 ## Gemfile
 
-    gem "bastet", "~> 0.0.1"
+    gem "bastet"
 
 ## Configuration
 
     redis = Redis.new
-    $bastet = Bastet.setup(redis)
+    bastet = Bastet.setup(redis) #=> Bastet::Base.instance ...
 
 ## Usage
 
-    $bastet.activate(:crazy_feature, current_user)
-    $bastet.active?(:crazy_feature, current_user) #=> true
+    group = Bastet::Group.new('admin_users') { |user| user.admin? }
+    bastet.activate("admin_only_feature", group)
+
+    user = User.new(admin: true)
+    bastet.active?("admin_only_feature", user) #=> true
 
-    $bastet.active?(:scary_feature, :admins) #=> false
-    $bastet.activate(:scary_feature, :admins)
-    $bastet.active?(:scary_feature, :admins) #=> true
+    bastet.deactivate("admin_only_feature", group)
+    bastet.inactive?("admin_only_feature", user) #=> true
 
 ## To do
 
-1. Support activating/deactivating all features for groups/users
-2. Support activating/deactivating for multiple users/groups at once
-3. Percentage support
-4. Logging
+1. Support activating/deactivating for multiple users/groups at once
+2. Percentage support
+3. Logging
 
 ## Contibuting
 

data/lib/bastet/base.rb

@@ -1,49 +1,23 @@
-class Bastet::Base
-  attr_accessor :redis
+require 'singleton'
 
-  def initialize redis
-    @redis = redis
-  end
+class Bastet::Base
+  include Singleton
 
-  def activate feature, target
-    act :sadd, feature, target
+  def activate feature, group
+    Bastet.redis.sadd("feature_#{feature}", group.name)
   end
 
-  def deactivate feature, target
-    act :srem, feature, target
+  def deactivate feature, group
+    Bastet.redis.srem("feature_#{feature}", group.name)
   end
 
-  def active? feature, target
-    act :sismember, feature, target
+  def active? feature, entity
+    group_names = Bastet.redis.smembers("feature_#{feature}")
+    groups = Bastet.groups.select { |group| group_names.include?(group.name) }
+    groups.any? { |group| group.criteria.call(entity) }
   end
 
-  def inactive? feature, target
-    !active? feature, target
+  def inactive? feature, entity
+    !active? feature, entity
   end
-
-  private
-
-    def act method, feature, target
-      @redis.send(method, key(feature, target), val(target))
-    end
-
-    def key feature, target
-      [].tap do |key|
-        key << "feature"
-        key << feature.to_s
-        key << namespace(target)
-      end.join(":")
-    end
-
-    def val target
-     instance?(target) ? target.id : target.to_s
-    end
-
-    def namespace target
-      instance?(target) ? "users" : "groups"
-    end
-
-    def instance? target
-      target.respond_to?(:id)
-    end
 end

data/lib/bastet/group.rb

@@ -0,0 +1,31 @@
+class Bastet::Group
+  attr_accessor :name, :criteria
+
+  def initialize name, &block
+    raise ArgumentError.new("Need to pass a criteria") unless block_given?
+    validate_name!(name.to_s)
+
+    @name = name.to_s
+    @criteria = block
+
+    persist!
+  end
+
+  def contains? entity
+    criteria.call(entity)
+  end
+
+  private
+
+    def validate_name! name
+      if Bastet.redis.sismember('bastet_groups', name)
+        raise ArgumentError.new("#{name} is already initialized as a group.")
+      else
+        Bastet.redis.sadd('bastet_groups', name)
+      end
+    end
+
+    def persist!
+      Bastet.groups << self
+    end
+end

data/lib/bastet/version.rb

@@ -1,3 +1,3 @@
 module Bastet
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/bastet.rb

@@ -1,9 +1,24 @@
-require "bastet/version"
+require 'bastet/version'
+require 'bastet/base'
+require 'bastet/group'
 
 module Bastet
-  autoload "Base", "bastet/base"
+  class << self
+    def redis
+      @@redis
+    end
 
-  def self.setup redis
-    Bastet::Base.new(redis)
+    def redis=(redis)
+      @@redis = redis
+    end
+
+    def groups
+      @@groups ||= []
+    end
+
+    def setup(redis)
+      self.redis = redis
+      Bastet::Base.instance
+    end
   end
 end

data/spec/bastet/base_spec.rb

@@ -2,49 +2,29 @@ require 'spec_helper'
 
 describe Bastet::Base do
   before do
-    @redis = Redis.new
-    @bastet = Bastet::Base.new(@redis)
-  end
-
-  describe "initialization" do
-    it "should configure the Redis instance" do
-      Bastet::Base.new(@redis).redis.should == @redis
-    end
+    @bastet = Bastet.setup(@redis)
   end
 
   describe "activate" do
-    it "should activate the :banana for the user" do
-      user = mock('user')
-      user.expects(:id).at_least(2).returns(100)
+    it "should activate the :banana for the group" do
+      group = Bastet::Group.new("admins") { |entity| entity.admin? }
+      user = mock('user', admin?: true)
 
-      @bastet.activate(:banana, user)
+      @bastet.activate(:banana, group)
       @bastet.active?(:banana, user).should be_true
     end
-
-    it "should activate the :banana for the group" do
-      @bastet.activate(:banana, :admins)
-      @bastet.active?(:banana, :admins).should be_true
-    end
   end
 
   describe "deactivate" do
-    it "should deactivate the :banana for the user" do
-      user = mock('user')
-      user.expects(:id).at_least(2).returns(100)
+    it "should deactive :banana for the group" do
+      group = Bastet::Group.new("admins") { |entity| entity.admin? }
+      user = mock('user', admin?: true)
 
-      @bastet.activate(:banana, user)
+      @bastet.activate(:banana, group)
       @bastet.active?(:banana, user).should be_true
 
-      @bastet.deactivate(:banana, user)
+      @bastet.deactivate(:banana, group)
       @bastet.inactive?(:banana, user).should be_true
     end
-
-    it "should deactivate the :banana for the group" do
-      @bastet.activate(:banana, :admins)
-      @bastet.active?(:banana, :admins).should be_true
-
-      @bastet.deactivate(:banana, :admins)
-      @bastet.inactive?(:banana, :admins).should be_true
-    end
   end
 end

data/spec/bastet/group_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Bastet::Group do
+  before do
+    @bastet = Bastet.setup(@redis)
+  end
+
+  describe "initializer" do
+    it "should take a group name" do
+      Bastet::Group.new('cool_feature') { }.name.should == "cool_feature"
+    end
+
+    it "should always return a string" do
+      Bastet::Group.new('cooler_feature') { }.name.should be_a(String)
+    end
+
+    it "should take a required criteria block" do
+      Bastet::Group.new('bananas') { }.criteria.should be_a(Proc)
+    end
+
+    it "should raise an argument error if there is no block" do
+      lambda {
+        Bastet::Group.new('cooler_feature')
+      }.should raise_exception(ArgumentError)
+    end
+
+    it "should make sure the name is unique" do
+      Bastet::Group.new('cooler_feature') { }
+      ['cooler_feature', :cooler_feature].each do |name|
+        lambda {
+          Bastet::Group.new(name) { }
+        }.should raise_exception(ArgumentError)
+      end
+    end
+
+    it "should add the group to the groups" do
+      lambda {
+        Bastet::Group.new('banana') { }
+      }.should change(Bastet.groups, :count).by(1)
+    end
+  end
+
+  describe "contains?" do
+    it "should be true if the criteria matches" do
+      group = Bastet::Group.new('admins_only') { |entity| entity.admin? }
+      group.contains?(mock(admin?: true)).should be_true
+    end
+
+    it "should be false if the criteria doesn't match" do
+      group = Bastet::Group.new('people_named_bill') { |entity| entity.name == "Bill" }
+      group.contains?(mock(name: 'Joe')).should be_false
+    end
+
+    it "should be true for all" do
+      group = Bastet::Group.new('all') { |entity| true }
+      group.contains?(mock).should be_true
+    end
+
+    it "should be false for all" do
+      group = Bastet::Group.new('none') { |entity| false }
+      group.contains?(mock).should be_false
+    end
+  end
+end

data/spec/bastet_spec.rb

@@ -1,13 +1,15 @@
 require 'spec_helper'
 
 describe Bastet do
-  before do
-    @redis = Redis.new
-  end
-
   describe "::setup" do
     it "should return a new Bastet::Base object" do
-      Bastet.setup(@redis).should be_a(Bastet::Base)
+      Bastet.setup(@redis).should == Bastet::Base.instance
+    end
+  end
+
+  describe "::groups" do
+    it "should have no groups" do
+      Bastet.groups.should be_empty
     end
   end
 end

data/spec/spec_helper.rb

@@ -9,4 +9,12 @@ Bundler.setup
 
 RSpec.configure do |config|
   config.mock_with :mocha
+
+  config.before(:each) do
+    @redis = Redis.new
+  end
+
+  config.after(:each) do
+    @redis.flushdb
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bastet
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-24 00:00:00.000000000 Z
+date: 2011-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70170044063740 !ruby/object:Gem::Requirement
+  requirement: &70334749774580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70170044063740
+  version_requirements: *70334749774580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70170044062960 !ruby/object:Gem::Requirement
+  requirement: &70334749774080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70170044062960
+  version_requirements: *70334749774080
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70170044061900 !ruby/object:Gem::Requirement
+  requirement: &70334749773620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *70170044061900
+  version_requirements: *70334749773620
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70170044061420 !ruby/object:Gem::Requirement
+  requirement: &70334749773160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 2.2.2
   type: :development
   prerelease: false
-  version_requirements: *70170044061420
+  version_requirements: *70334749773160
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70170044060960 !ruby/object:Gem::Requirement
+  requirement: &70334749772660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170044060960
+  version_requirements: *70334749772660
 description: Simple feature rollout for users, and groups
 email:
 - itsmeduncan@gmail.com
@@ -84,8 +84,10 @@ files:
 - bastet.gemspec
 - lib/bastet.rb
 - lib/bastet/base.rb
+- lib/bastet/group.rb
 - lib/bastet/version.rb
 - spec/bastet/base_spec.rb
+- spec/bastet/group_spec.rb
 - spec/bastet_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/itsmeduncan/bastet
@@ -114,5 +116,6 @@ specification_version: 3
 summary: Simple feature rollout for users, and groups
 test_files:
 - spec/bastet/base_spec.rb
+- spec/bastet/group_spec.rb
 - spec/bastet_spec.rb
 - spec/spec_helper.rb