sapling 0.1.1 → 0.2.0

data/README.md

@@ -10,3 +10,111 @@ 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.
+
+Setup
+-----
+
+Add a route to your routes file. Feel free to change the 'sapling/stylesheet.css' to whatever you want.
+
+    map.sapling_script 'sapling/script.js', :controller => 'sapling', :action => 'script'
+
+After including your javascript library, add this:
+    
+    <%= javascript_include_tag sapling_script_path, :id => 'sapling_script' %>
+
+Run the `db/create.sql` file to create the sapling_settings table on your DB
+
+Ensure you have a current_user method to your application controller, which returns a user object, or nil if no active user.
+
+    class ApplicationController < ActionController::Base
+      ...
+      def current_user
+        # Return your current user
+        # This is already done for you in Devise, RestfulAuthentication, and other authentication lib
+      end
+      ...
+    end
+    
+
+    
+For a given feature `space_chat`,
+
+Server-side Usage
+-----------------
+
+To check if a feature is enabled for a user in rails controllers or views: use
+  
+    feature_active?(:space_chat [, :user => the current user])
+  
+  *Note*: sapling will automatically populate the user argument by calling `current_user`
+  
+To enable a feature for a specific user, in the rails console:
+  
+    Sapling::ActiveRecord.new.activate_user(:space_chat, space_admin)
+  
+To disable a feature for a specific user, in the rails console:
+  
+    Sapling::ActiveRecord.new.deactivate_user(:space_chat, space_admin)
+  
+To enable a feature for 50% of the users, in the rails console:
+
+    Sapling::ActiveRecord.new.activate_percentage(:space_chat, 50)`
+
+To disable a feature activated for anyone but individually-activated users, in the rails console:
+
+    Sapling::ActiveRecord.new.deactivate_percentage(:space_chat)
+  
+*Note*: Individually-activated users are always activated, regardless of the percentage setting.  A deactivated user
+may still have access to a feature if they fall within an active percentage.
+
+Client-side Usage
+-----------------
+
+Sapling include a javascript helper which add and remove classes on the HTML element for a given user, based upon the
+features available to that user.
+
+Given the feature `space_chat`, if it is enabled for the given user, the html root will get an class `sapling_feature_space_chat_on`.  If disabled for the given user, the class will be `sapling_feature_space_chat_off`.
+
+To retrieve the class name for a given feature, you can use the `sapling_js_generator.css_container_class(feature)` and `sapling_js_generator.css_toggle_class(feature, on? (boolean) )` helpers in your ERB files.
+
+Using the client-side tools, you can define CSS classes which will be visible/invisible when a feature is enabled/disabled.  For example:
+
+CSS:
+
+    /* Chat Defaults to being hidden for everyone */
+    .sapling_feature_chat.enabled {
+      display: none;
+    }
+    .sapling_feature_chat.disabled {
+      display: block;
+    }
+
+    /* When chat is enabled, we hide the disabled container, and show the enabled container */
+    html.sapling_feature_chat_on .sapling_feature_chat.enabled {
+      display: block;
+    }
+    html.sapling_feature_chat_on .sapling_feature_chat.disabled {
+      display: none;
+    }
+
+
+ERB:
+
+    <div class="<%= feature_class(:chat) %> enabled">
+      REJOICE - SPIFF CHAT ENABLED FOR YOU
+    </div>
+
+    <div class="<%= feature_class(:chat) %> disabled">
+      DESPAIR - SPIFF CHAT NOT ENABLED FOR YOU
+    </div>
+    
+    
+*Note* Currently, the javascript generated depends on MooTools being loaded first.
+
+TODO
+----
+
+* Rails 3 compatibility
+* Remove mootools dependency
+* CSS generator
+* Database migration generator

data/lib/sapling/generators/javascript_generator.rb

@@ -0,0 +1,47 @@
+require "set"
+
+class Sapling::JavascriptGenerator
+  attr_accessor :sapling
+
+  def initialize(sapling)
+    @sapling=sapling
+  end
+
+  def prefix
+    "sapling_feature"
+  end
+    
+  # Use these classes on the container elements of your features
+  def css_container_class(feature)
+    "#{prefix}_#{feature.to_s}"
+  end
+
+  # Put these on the html element to turn on/off features
+  def css_toggle_class(feature, on)
+    "#{css_container_class(feature)}_#{on ? 'on' : 'off'}"
+  end
+
+
+  # see Sapling::API::Client for options
+  
+  def mootools_for_feature(feature, on)
+    "html.removeClass('" + css_toggle_class(feature,!on) + "');html.addClass('" + css_toggle_class(feature,on) + "');"
+  end
+  
+  def generate(options={})
+    features = Set.new @sapling.features
+    active_features = Set.new @sapling.active_features options
+    inactive_features = features - active_features
+
+    
+    <<-END
+(function() {
+  if (window.MooTools) {
+    html = $$('html')[0];
+    #{inactive_features.map{|f| mootools_for_feature(f,false) }.join}
+    #{active_features.map{|f| mootools_for_feature(f,true) }.join}    
+  }
+})();
+END
+  end
+end

data/lib/sapling/rails/action_controller.rb

@@ -11,13 +11,13 @@ module Sapling::ActionControllerExt
     @@sapling ||= Sapling::ActiveRecord.new
   end
   
-  def sapling_css_generator
-    @@sapling_css_generator ||= Sapling::CssGenerator.new(sapling)
+  def sapling_js_generator
+    @@sapling_js_generator ||= Sapling::JavascriptGenerator.new(sapling)
   end
   
 end
 
 class ActionController::Base
   include Sapling::ActionControllerExt
-  helper_method :feature_active?, :sapling, :sapling_css_generator
+  helper_method :feature_active?, :sapling, :sapling_js_generator
 end

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

@@ -1,7 +1,6 @@
-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'
+class SaplingController < ApplicationController  
+  def script
+    js = sapling_js_generator.generate(:user => current_user, :context_id => (request.session_options[:id] if request.session))
+    render :text => js, :content_type => 'text/javascript'
   end
 end

data/lib/sapling/rails/view_helpers.rb

@@ -2,21 +2,9 @@ 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)
+    def feature_class(feature)
+      sapling_js_generator.css_container_class(feature)
     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
-
+end

data/lib/sapling/version.rb

@@ -1,3 +1,3 @@
 module Sapling
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/sapling.rb

@@ -4,6 +4,7 @@ require "sapling/base"
 require "sapling/memory"
 require "sapling/model"
 require "sapling/active_record"
+require "sapling/generators/javascript_generator"
 require "sapling/generators/css_generator"
 
 module Sapling

data/spec/javascript_generator_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Sapling::JavascriptGenerator" 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 js" do
+    before do
+      @sapling.activate_user(:chat, stub(:id => 1))
+    end
+
+    it "outputs js" do
+      Sapling::JavascriptGenerator.new(@sapling).generate(:user => stub(:id => 1)).should include 'html.addClass(\'sapling_feature_chat_on\');'
+    end
+  end
+
+  describe "creating more complex js" 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::JavascriptGenerator.new(@sapling).generate(:user => stub(:id => 102))
+      expected_features = {
+        'bicycle' => true,
+        'chat'    => false,
+        'juggle'  => false,
+        'pwn'     => true
+      }
+      expected_features.each_pair do |key, enabled|
+        output.should include "html.addClass('sapling_feature_#{key}_#{enabled ? 'on' : 'off'}');"
+        output.should include "html.removeClass('sapling_feature_#{key}_#{!enabled ? 'on' : 'off'}');"
+      end
+    end
+  
+    it "test chat & juggle user" do
+      output = Sapling::JavascriptGenerator.new(@sapling).generate(:user => stub(:id => 115))
+      expected_features = {
+        'bicycle' => false,
+        'chat'    => true,
+        'juggle'  => true,
+        'pwn'     => false
+      }
+      expected_features.each_pair do |key, enabled|
+        output.should include "html.addClass('sapling_feature_#{key}_#{enabled ? 'on' : 'off'}');"
+        output.should include "html.removeClass('sapling_feature_#{key}_#{!enabled ? 'on' : 'off'}');"
+      end
+    end
+  end
+end

data/spec/rails_app/app/views/layouts/spaceman_spiffs.html.erb

@@ -6,7 +6,9 @@
   <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
   <title>SpacemanSpiffs: <%= controller.action_name %></title>
   <%= stylesheet_link_tag 'scaffold' %>
-  <%= stylesheet_link_tag sapling_stylesheet_path %>
+  <%= stylesheet_link_tag 'sapling_features' %>
+  <%= javascript_include_tag 'https://ajax.googleapis.com/ajax/libs/mootools/1.4.1/mootools.js' %>
+  <%= javascript_include_tag sapling_script_path %>
 </head>
 <body>
 

data/spec/rails_app/app/views/spaceman_spiffs/multiple_features.html.erb

@@ -1,7 +1,7 @@
-<% feature_on(:chat) do %>
-  SPIFF CHAT ENABLED
-<% end %>
+<div class="<%= feature_class(:chat) %> enabled">
+  REJOICE - SPIFF CHAT ENABLED FOR YOU
+</div>
 
-<% feature_off(:chat) do %>
-  SPIFF CHAT FORSAKEN
-<% end %>
+<div class="<%= feature_class(:chat) %> disabled">
+  DESPAIR - SPIFF CHAT NOT ENABLED FOR YOU
+</div>

data/spec/rails_app/config/routes.rb

@@ -2,7 +2,7 @@ ActionController::Routing::Routes.draw do |map|
   map.resources :spaceman_spiffs, :collection => {:multiple_features => :get }
   map.resource :user_sessions, :collection => {:set_manually => :get }
   
-  # map.sapling_stylesheet 'sapling/stylesheet.css', :controller => 'sapling', :action => 'stylesheet'
+  map.sapling_script 'sapling/script.js', :controller => 'sapling', :action => 'script'
 
   # The priority is based upon order of creation: first created -> highest priority.
 

data/spec/rails_app/public/stylesheets/sapling_features.css

@@ -0,0 +1,15 @@
+/* Chat Defaults */
+.sapling_feature_chat.enabled {
+  display: none;
+}
+.sapling_feature_chat.disabled {
+  display: block;
+}
+
+/* Chat Enabled */
+html.sapling_feature_chat_on .sapling_feature_chat.enabled {
+  display: block;
+}
+html.sapling_feature_chat_on .sapling_feature_chat.disabled {
+  display: none;
+}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sapling
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Shane Brinkman-Davis
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-13 00:00:00 -08:00
+date: 2011-12-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -117,6 +117,7 @@ files:
 - lib/sapling/api.rb
 - lib/sapling/base.rb
 - lib/sapling/generators/css_generator.rb
+- lib/sapling/generators/javascript_generator.rb
 - lib/sapling/memory.rb
 - lib/sapling/model.rb
 - lib/sapling/rails.rb
@@ -130,6 +131,7 @@ files:
 - sapling.gemspec
 - spec/active_record_spec.rb
 - spec/css_generator_spec.rb
+- spec/javascript_generator_spec.rb
 - spec/memory_feature_spec.rb
 - spec/memory_spec.rb
 - spec/rails_app/README
@@ -178,6 +180,7 @@ files:
 - spec/rails_app/public/javascripts/effects.js
 - spec/rails_app/public/javascripts/prototype.js
 - spec/rails_app/public/robots.txt
+- spec/rails_app/public/stylesheets/sapling_features.css
 - spec/rails_app/public/stylesheets/scaffold.css
 - spec/rails_app/script/about
 - spec/rails_app/script/console
@@ -196,8 +199,6 @@ files:
 - spec/rails_app/test/performance/browsing_test.rb
 - spec/rails_app/test/test_helper.rb
 - spec/rails_app/test/unit/helpers/spaceman_spiffs_helper_test.rb
-- spec/rails_app/test/unit/spaceman_spiff_test.rb
-- spec/rails_app/test/unit/user_test.rb
 - spec/sapling_examples.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -238,6 +239,7 @@ summary: Incrementally roll out your features. Uses ActiveRecord to store config
 test_files: 
 - spec/active_record_spec.rb
 - spec/css_generator_spec.rb
+- spec/javascript_generator_spec.rb
 - spec/memory_feature_spec.rb
 - spec/memory_spec.rb
 - spec/rails_app/README
@@ -286,6 +288,7 @@ test_files:
 - spec/rails_app/public/javascripts/effects.js
 - spec/rails_app/public/javascripts/prototype.js
 - spec/rails_app/public/robots.txt
+- spec/rails_app/public/stylesheets/sapling_features.css
 - spec/rails_app/public/stylesheets/scaffold.css
 - spec/rails_app/script/about
 - spec/rails_app/script/console
@@ -304,8 +307,6 @@ test_files:
 - spec/rails_app/test/performance/browsing_test.rb
 - spec/rails_app/test/test_helper.rb
 - spec/rails_app/test/unit/helpers/spaceman_spiffs_helper_test.rb
-- spec/rails_app/test/unit/spaceman_spiff_test.rb
-- spec/rails_app/test/unit/user_test.rb
 - spec/sapling_examples.rb
 - spec/spec.opts
 - spec/spec_helper.rb

data/spec/rails_app/test/unit/spaceman_spiff_test.rb

@@ -1,8 +0,0 @@
-require 'test_helper'
-
-class SpacemanSpiffTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
-  end
-end

data/spec/rails_app/test/unit/user_test.rb

@@ -1,8 +0,0 @@
-require 'test_helper'
-
-class UserTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
-  end
-end