sapling 0.0.1 → 0.1.0

data/.gitignore

@@ -3,3 +3,5 @@
 Gemfile.lock
 pkg/*
 .rvmrc
+*.log
+*.sqlite3

data/lib/sapling.rb

@@ -4,6 +4,7 @@ require "sapling/base"
 require "sapling/memory"
 require "sapling/active_record_model"
 require "sapling/active_record"
+require "sapling/generators/css_generator"
 
 module Sapling
   # Your code goes here...

data/lib/sapling/active_record.rb

@@ -5,18 +5,40 @@ module Sapling
       Model.table_name
     end
 
+    private
+    def query_conditions(feature,normalized_options={})
+      ret=[
+        "#{'feature = ? AND ' if feature} ((user_id IS NOT NULL AND user_id = ?) OR (percentage IS NOT NULL AND ? < percentage)) "
+      ]
+      ret<<feature.to_s if feature
+      ret+=[
+        normalized_options[:user_id],
+        Util::modded_context_id(normalized_options)
+      ]
+      ret
+    end
+    public
+
     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 = Model.count(:conditions => query_conditions(feature,options))
         v > 0
       end
+
+      def features
+        features = Model.find :all, :select => "feature", :group => "feature", :order => "feature"
+        features.map {|record| record.feature.to_sym}
+      end
+
+      # returns a list of features enabled for a user
+      # see Sapling::API::Client
+      def active_features(options={})
+        options = Util.normalized_options options
+        features = Model.find :all, :conditions => query_conditions(nil,options)
+        features.map {|record| record.feature.to_sym}.uniq
+      end
     end
     include ClientAPI
 
@@ -25,25 +47,25 @@ module Sapling
       def activate_user(feature, user)
         Model.transaction do
           deactivate_user(feature, user)
-          Model.create(:feature => feature, :user_id => user.id)
+          Model.create(:feature => feature.to_s, :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]
+        Model.delete_all ["feature = ? AND percentage IS NULL and user_id = ?",feature.to_s,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)
+          Model.create(:feature => feature.to_s, :percentage => percentage)
         end
       end
 
       def deactivate_percentage(feature)
         Model.delete_all ["feature = ? AND percentage IS NOT NULL AND user_id IS NULL",
-          feature
+          feature.to_s
         ]
       end
     end

data/lib/sapling/generators/css_generator.rb

@@ -0,0 +1,31 @@
+require "set"
+
+module Sapling
+class CssGenerator
+  attr_accessor :sapling
+
+  def initialize(sapling)
+    @sapling=sapling
+  end
+
+  def prefix
+    "sapling_css"
+  end
+  
+  def css_class(feature, on)
+    "#{prefix}_#{feature.to_s}_#{on ? 'on' : 'off'}"
+  end
+
+  # see Sapling::API::Client for options
+  def to_s(options={})
+    features = Set.new @sapling.features
+    active_features = Set.new @sapling.active_features options
+    inactive_features = features - active_features
+
+    [
+    active_features.collect   {|f|".#{css_class(f, false)} { display:none !important; }"},
+    inactive_features.collect {|f|".#{css_class(f, true)} { display:none !important; }"},
+    ].flatten.join("\n")
+  end
+end
+end

data/lib/sapling/memory.rb

@@ -11,12 +11,12 @@ module Sapling
 
       # see Sapling::API::Client
       def active?(options={})
-        options = Util::normalized_options(options)
+        options = Util.normalized_options(options)
         individually_active?(options[:user]) || percentage_active?(options)
       end
 
       def percentage_active?(options={})
-        (Util.context_id(options) % 100) < percentage
+        (Util.modded_context_id(options)) < percentage
       end
 
       def individually_active?(user)
@@ -40,8 +40,6 @@ module Sapling
       end
     end
 
-    attr_accessor :features
-
     def initialize
       @features={}
     end
@@ -49,14 +47,23 @@ module Sapling
     module ClientAPI
       # see Sapling::API::Client
       def active?(feature, options={})
-        options = Util::normalized_options(options)
+        options = Util.normalized_options(options)
         (f = @features[feature]) && f.active?(options)
       end
+
+      def features
+        @features.keys.sort_by {|k| k.to_s}
+      end
+
+      # see Sapling::API::Client
+      def active_features(options={})
+        features.select {|feature| active?(feature,options)}
+      end
     end
 
     module AdminAPI
       def activate_feature(feature)
-        features[feature]||=Feature.new
+        @features[feature]||=Feature.new
       end
 
       def activate_user(feature, user)
@@ -64,7 +71,7 @@ module Sapling
       end
 
       def deactivate_user(feature, user)
-        (f=features[feature]) && f.deactivate_user(user)
+        (f=@features[feature]) && f.deactivate_user(user)
       end
 
       def activate_percentage(feature, percentage)

data/lib/sapling/rails.rb

@@ -0,0 +1,17 @@
+require 'sapling/rails/action_controller'
+require 'sapling/rails/view_helpers'
+
+ActiveSupport::Dependencies.autoload_paths << File.expand_path(File.join(File.dirname(__FILE__), "rails", "controllers"))
+
+ActionController::Routing::Routes.draw do |map|
+  map.sapling_stylesheet 'sapling/stylesheet.css', :controller => 'sapling', :action => 'stylesheet'
+end
+
+if defined?(Rails)
+  if Rails.version =~ /^3\./
+    # Haven't tested this
+    require 'sapling/rails/railtie'
+  else
+    ActionView::Base.send :include, Sapling::ViewHelpers
+  end
+end

data/lib/sapling/rails/action_controller.rb

@@ -0,0 +1,23 @@
+require 'action_controller'
+
+module Sapling::ActionControllerExt
+  def feature_active?(feature, options={})
+    options[:user] ||= current_user
+    sapling.active?(feature, options)
+  end
+  
+  
+  def sapling
+    @@sapling ||= Sapling::ActiveRecord.new
+  end
+  
+  def sapling_css_generator
+    @@sapling_css_generator ||= Sapling::CssGenerator.new(sapling)
+  end
+  
+end
+
+class ActionController::Base
+  include Sapling::ActionControllerExt
+  helper_method :feature_active?, :sapling, :sapling_css_generator
+end

data/lib/sapling/rails/controllers/sapling_controller.rb

@@ -0,0 +1,7 @@
+class SaplingController < ApplicationController
+  def stylesheet
+    styles = sapling_css_generator.to_s(:user => current_user, :context_id => (request.session_options[:id] if request.session))
+    # styles = "boo"
+    render :text => styles, :content_type => 'text/css'
+  end
+end

data/lib/sapling/rails/railtie.rb

@@ -0,0 +1,7 @@
+module Sapling
+  class Railtie < Rails::Railtie
+    initializer "sapling.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end    
+  end
+end

data/lib/sapling/rails/view_helpers.rb

@@ -0,0 +1,22 @@
+module Sapling
+  module ViewHelpers
+
+    # include ActionView::Helpers::CaptureHelper
+    def feature_on(feature, &block)
+      feature_block(sapling_css_generator.css_class(feature, "style=\"display:none;\"", true), &block)
+    end
+
+    def feature_off(feature, &block)
+      feature_block(sapling_css_generator.css_class(feature, nil, false), &block)    
+    end
+
+    private
+    def feature_block(css_class, params, &block)
+      concat "<span class=\"#{css_class}\" #{params}>"
+      block.call 
+      concat "</span>"
+    end
+
+  end
+end
+

data/lib/sapling/util.rb

@@ -1,21 +1,19 @@
 module Sapling
   class Util
+    CONTEXT_ID_ONLY_ENABLED_IF_100_PERCENT_ENABLED = 99
+
     class << self
       def context_id(options)
-        options[:context_id] || options[:user].id
+        options[:context_id] || ((u=options[:user]) && u.id)
+      end
+      def modded_context_id(options)
+        ((cid=context_id(options)) && (cid%100)) || CONTEXT_ID_ONLY_ENABLED_IF_100_PERCENT_ENABLED
       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
+        options[:user_id] ||= options[:user].id if options[:user]
+        options[:context_id] ||= options[:user_id]
+        options
       end
     end
   end

data/lib/sapling/version.rb

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

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'sapling'
+require 'sapling/rails'

data/sapling.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   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.summary     = %q{Incrementally roll out your features. Uses ActiveRecord to store configuration and supports client-side roll-out of cached pages.}
+  s.description = %q{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.}
 
   s.rubyforge_project = "sapling"
 
@@ -19,8 +19,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
+  s.add_runtime_dependency "activerecord", ">2.3"
   s.add_development_dependency "rspec", "~>2.7.0"
+  s.add_development_dependency "rails", "2.3.12"
   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

@@ -12,31 +12,5 @@ describe "Sapling::ActiveRecord" do
       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/css_generator_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Sapling::CssGenerator" 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
+
+  describe "creating basic css" do
+    before do
+      @sapling.activate_user(:chat, stub(:id => 1))
+    end
+
+    it "outputs css" do
+      Sapling::CssGenerator.new(@sapling).to_s(:user => stub(:id => 1)).should == ".sapling_css_chat_off { display:none !important; }"
+    end
+  end
+
+  describe "creating more complex css" do
+    before do
+      @sapling.activate_percentage(:bicycle, 10)
+      @sapling.activate_user(:chat, stub(:id => 115))
+      @sapling.activate_user(:pwn, stub(:id => 102))
+      @sapling.activate_user(:juggle, stub(:id => 115))
+    end
+
+    it "test user bicycle & pwn user" do
+      output = Sapling::CssGenerator.new(@sapling).to_s(:user => stub(:id => 102))
+      %w{ bicycle_off chat_on juggle_on pwn_off }.each do |key|
+        output.should =~ /#{key}[^}]+?display:none/
+      end
+    end
+
+    it "test chat & juggle user" do
+      output = Sapling::CssGenerator.new(@sapling).to_s(:user => stub(:id => 115))
+      %w{ bicycle_on chat_off juggle_off pwn_on }.each do |key|
+        output.should =~ /#{key}[^}]+?display:none/
+      end
+    end
+  end
+end

data/spec/memory_feature_spec.rb

@@ -5,9 +5,9 @@ describe "Sapling::Memory::Feature" do
     f=Sapling::Memory::Feature.new
     u=UserMock.new
 
-    f.active?(u).should be_false
+    f.active?(:user=>u).should be_false
     f.activate_user(u)
 
-    f.active?(u).should be_true
+    f.active?(:user=>u).should be_true
   end
 end

data/spec/memory_spec.rb

@@ -5,31 +5,5 @@ describe "Sapling::Memory" 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