sapling 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

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

data/README.md

@@ -0,0 +1,12 @@
+Sapling Gem
+===========
+
+Sapling lets you seed your new features to just a few users at a time. You can change which and how many users are
+seeded for a feature dynamically by updating the database via the Sapling API. Core features are the ability to
+seed a feature for specific users and/or a percentage of users.
+
+Heritage
+--------
+
+This is a port of the [rollout gem](https://github.com/jamesgolick/rollout) for
+use with ActiveRecord instead of Redis. We dropped the groups functionality, but otherwise we mirrored the API.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.verbose = true    
+end
+
+task :default => :spec

data/db/create.sql

@@ -0,0 +1,6 @@
+CREATE TABLE `sapling_settings` (
+  feature varchar(255),
+  percentage integer, -- 0 to 100 or NULL
+  user_id integer -- user's ID or NULL
+);
+

data/lib/sapling.rb

@@ -0,0 +1,10 @@
+require "sapling/version"
+require "sapling/util"
+require "sapling/base"
+require "sapling/memory"
+require "sapling/active_record_model"
+require "sapling/active_record"
+
+module Sapling
+  # Your code goes here...
+end

data/lib/sapling/active_record.rb

@@ -0,0 +1,53 @@
+module Sapling
+  class ActiveRecord < Base
+
+    def table_name
+      Model.table_name
+    end
+
+    module ClientAPI
+      # see Sapling::API::Client
+      def active?(feature, options={})
+        options = Util.normalized_options options
+        v =Model.count(:conditions => [
+          "feature = ? AND ((user_id IS NOT NULL AND user_id = ?) OR (percentage IS NOT NULL AND ? < percentage)) ",
+          feature,
+          (u=options[:user]) && u.id,
+          ((c=options[:context_id]) && c%100) || 100
+        ])
+        v > 0
+      end
+    end
+    include ClientAPI
+
+    module AdminAPI
+
+      def activate_user(feature, user)
+        Model.transaction do
+          deactivate_user(feature, user)
+          Model.create(:feature => feature, :user_id => user.id)
+        end
+      end
+
+      def deactivate_user(feature, user)
+        Model.delete_all ["feature = ? AND percentage IS NULL and user_id = ?",feature,user.id]
+      end
+
+      def activate_percentage(feature, percentage)
+        raise "invalid percentage #{percentage.inspect}" unless percentage.kind_of?(Integer) && percentage>=0 && percentage<=100
+        Model.transaction do
+          deactivate_percentage(feature)
+          Model.create(:feature => feature, :percentage => percentage)
+        end
+      end
+
+      def deactivate_percentage(feature)
+        Model.delete_all ["feature = ? AND percentage IS NOT NULL AND user_id IS NULL",
+          feature
+        ]
+      end
+    end
+
+    include AdminAPI
+  end
+end

data/lib/sapling/active_record_model.rb

@@ -0,0 +1,8 @@
+require "active_record"
+module Sapling
+  class ActiveRecord < Base
+    class Model < ::ActiveRecord::Base
+      set_table_name "sapling_settings"
+    end
+  end
+end

data/lib/sapling/api.rb

@@ -0,0 +1,12 @@
+module Sapling::API
+  module Client
+    # options.kind_of? Hash
+    #   :user => user
+    #   :context_id => Integer
+    # options.kind_of? Integer
+    #   {:context_id => options}
+    # else
+    #   {:user => options}
+    def active?(feature, options={}) {}
+  end
+end

data/lib/sapling/base.rb

@@ -0,0 +1,4 @@
+module Sapling
+  class Base
+  end
+end

data/lib/sapling/memory.rb

@@ -0,0 +1,82 @@
+module Sapling
+  class Memory < Base
+
+    class Feature
+      attr_accessor :users,:percentage
+
+      def initialize
+        @users={}
+        self.percentage = 0
+      end
+
+      # see Sapling::API::Client
+      def active?(options={})
+        options = Util::normalized_options(options)
+        individually_active?(options[:user]) || percentage_active?(options)
+      end
+
+      def percentage_active?(options={})
+        (Util.context_id(options) % 100) < percentage
+      end
+
+      def individually_active?(user)
+        user && users[user.id]
+      end
+
+      def activate_user(user)
+        users[user.id]=true
+      end
+
+      def deactivate_user(user)
+        users.delete(user.id)
+      end
+
+      def activate_percentage(percentage)
+        @percentage=percentage
+      end
+
+      def deactivate_percentage
+        @percentage=0
+      end
+    end
+
+    attr_accessor :features
+
+    def initialize
+      @features={}
+    end
+
+    module ClientAPI
+      # see Sapling::API::Client
+      def active?(feature, options={})
+        options = Util::normalized_options(options)
+        (f = @features[feature]) && f.active?(options)
+      end
+    end
+
+    module AdminAPI
+      def activate_feature(feature)
+        features[feature]||=Feature.new
+      end
+
+      def activate_user(feature, user)
+        activate_feature(feature).activate_user(user)
+      end
+
+      def deactivate_user(feature, user)
+        (f=features[feature]) && f.deactivate_user(user)
+      end
+
+      def activate_percentage(feature, percentage)
+        activate_feature(feature).activate_percentage(percentage)
+      end
+
+      def deactivate_percentage(feature)
+        activate_feature(feature).deactivate_percentage
+      end
+    end
+
+    include ClientAPI
+    include AdminAPI
+  end
+end

data/lib/sapling/util.rb

@@ -0,0 +1,22 @@
+module Sapling
+  class Util
+    class << self
+      def context_id(options)
+        options[:context_id] || options[:user].id
+      end
+
+      def normalized_options(options)
+        case options
+        when Hash then
+          options[:context_id] ||= options[:user].id
+          options
+        when Integer then
+          {:context_id => options}
+        else
+          user=options
+          {:user => user, :context_id => user.id}
+        end
+      end
+    end
+  end
+end

data/lib/sapling/version.rb

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

data/sapling.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sapling/version"
+
+Gem::Specification.new do |s|
+  s.name        = "sapling"
+  s.version     = Sapling::VERSION
+  s.authors     = ["Shane Brinkman-Davis", "Jason Strutz"]
+  s.email       = ["shanebdavis@imikimi.com", "jason@cumuluscode.com"]
+  s.homepage    = ""
+  s.summary     = %q{A gem expressing if a feature is seeded for a user}
+  s.description = %q{}
+
+  s.rubyforge_project = "sapling"
+
+  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.7.0"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "activerecord", "~>3.1.1"  
+  s.add_development_dependency "sqlite3", "~>1.3.4"
+end

data/spec/active_record_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'active_record'
+
+describe "Sapling::ActiveRecord" do
+  it_behaves_like Sapling do
+    before do
+      ActiveRecord::Base.establish_connection(
+        :adapter  => 'sqlite3',
+        :database => ':memory:'
+      )
+      sql = File.read(File.expand_path(File.dirname(__FILE__) + '/../db/create.sql'))
+      ActiveRecord::Base.connection.execute sql
+      @sapling = Sapling::ActiveRecord.new
+    end
+    
+  end
+  # 
+  # it "should init" do
+  #   Sapling::Memory.new
+  # end
+  # 
+  # it "should support activating users" do
+  #   mem = Sapling::Memory.new
+  #   user = UserMock.new
+  # 
+  #   mem.active?(:my_feature, user).should be_false
+  # 
+  #   mem.activate_user(:my_feature, user)
+  #   mem.active?(:my_feature, user).should be_true
+  # end
+  # 
+  # it "should support deactivating users" do
+  #   mem = Sapling::Memory.new
+  #   user = UserMock.new
+  # 
+  #   mem.activate_user(:my_feature, user)
+  #   mem.active?(:my_feature, user).should be_true
+  # 
+  #   mem.deactivate_user(:my_feature, user)
+  #   mem.active?(:my_feature, user).should be_false
+  # end
+end

data/spec/memory_feature_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Sapling::Memory::Feature" do
+  it "should support activating users" do
+    f=Sapling::Memory::Feature.new
+    u=UserMock.new
+
+    f.active?(u).should be_false
+    f.activate_user(u)
+
+    f.active?(u).should be_true
+  end
+end

data/spec/memory_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Sapling::Memory" do
+  it_behaves_like Sapling do
+    before do
+      @sapling = Sapling::Memory.new
+    end
+    
+  end
+  # 
+  # it "should init" do
+  #   Sapling::Memory.new
+  # end
+  # 
+  # it "should support activating users" do
+  #   mem = Sapling::Memory.new
+  #   user = UserMock.new
+  # 
+  #   mem.active?(:my_feature, user).should be_false
+  # 
+  #   mem.activate_user(:my_feature, user)
+  #   mem.active?(:my_feature, user).should be_true
+  # end
+  # 
+  # it "should support deactivating users" do
+  #   mem = Sapling::Memory.new
+  #   user = UserMock.new
+  # 
+  #   mem.activate_user(:my_feature, user)
+  #   mem.active?(:my_feature, user).should be_true
+  # 
+  #   mem.deactivate_user(:my_feature, user)
+  #   mem.active?(:my_feature, user).should be_false
+  # end
+end

data/spec/sapling_examples.rb

@@ -0,0 +1,86 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+shared_examples_for Sapling do
+
+  describe "features default to being disabled" do
+    it "is not active for a specific user by default" do
+      @sapling.should_not be_active(:chat, stub(:id => 5))
+    end
+  end
+
+  describe "activating a percentage" do
+    before do
+      @sapling.activate_percentage(:chat, 20)
+    end
+
+    it "activates the feature for that percentage of users" do
+      (1..1000).select { |id| @sapling.active?(:chat, UserMock.new(id)) }.length.should == 200
+    end
+  end
+
+  describe "deactivating a percentage" do
+    before do
+      @sapling.activate_percentage(:chat, 100)
+      @sapling.deactivate_percentage(:chat)
+    end
+
+    it "becomes inactive for all users" do
+      @sapling.should_not be_active(:chat, stub(:id => 24))
+    end
+  end
+
+  describe "activating a specific user" do
+    before do
+      @sapling.activate_user(:chat, stub(:id => 2))
+    end
+
+    it "activates the feature for that user" do
+      @sapling.should be_active(:chat, stub(:id => 2))
+    end
+  end
+
+  describe "deactivating a specific user" do
+    before do
+      @sapling.activate_user(:chat, stub(:id => 2))
+      @sapling.deactivate_user(:chat, stub(:id => 2))
+    end
+
+    it "deactivates the feature for that user" do
+      @sapling.should_not be_active(:chat, stub(:id => 2))
+    end
+  end
+
+  describe "activate percentage consider a generic integer" do
+    before do
+      @sapling.activate_percentage(:chat, 20)
+    end
+
+    it "activates a context_id" do
+      @sapling.should_not be_active(:chat, 60)
+    end
+  end
+
+end
+#
+#
+# feature :string
+# user_id :integer
+# group :string
+# percentage :integer
+#
+#
+# select count(*) from saplingawfwefwef where feature = 'aabce'
+# and percentage < #{user_id % 100}
+#
+# select count(*) from saplingawfwefwef where feature = 'aabce'
+# and group = 'admins'
+#
+# select count(*) from saplingawfwefwef where feature = 'aabce'
+# and user_id = 123
+#
+# select feature from sapling where user_id = id or precentage < userid% 100 or group in (#{groups.join(',')})
+#
+# def current_features
+#   @features ||=
+# end
+#

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'sapling'
+require 'rspec'
+require 'rspec/autorun'
+require 'sapling_examples'
+
+class UserMock
+  def initialize(i=1)
+    @id=i
+  end
+  def id;@id;end
+end
+
+RSpec.configure do |config|
+  # config.mock_with :mocha
+  config.before { }
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: sapling
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Shane Brinkman-Davis
+- Jason Strutz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-02 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 7
+        - 0
+        version: 2.7.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 1
+        - 1
+        version: 3.1.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 3
+        - 4
+        version: 1.3.4
+  type: :development
+  version_requirements: *id004
+description: ""
+email: 
+- shanebdavis@imikimi.com
+- jason@cumuluscode.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- db/create.sql
+- lib/sapling.rb
+- lib/sapling/active_record.rb
+- lib/sapling/active_record_model.rb
+- lib/sapling/api.rb
+- lib/sapling/base.rb
+- lib/sapling/memory.rb
+- lib/sapling/util.rb
+- lib/sapling/version.rb
+- sapling.gemspec
+- spec/active_record_spec.rb
+- spec/memory_feature_spec.rb
+- spec/memory_spec.rb
+- spec/sapling_examples.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: sapling
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: A gem expressing if a feature is seeded for a user
+test_files: 
+- spec/active_record_spec.rb
+- spec/memory_feature_spec.rb
+- spec/memory_spec.rb
+- spec/sapling_examples.rb
+- spec/spec.opts
+- spec/spec_helper.rb