sapling 0.3.0 → 0.4.1

data/README.md

@@ -19,7 +19,7 @@ Add a route to your routes file. Feel free to change the 'sapling/stylesheet.css
     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
@@ -34,34 +34,34 @@ Ensure you have a current_user method to your application controller, which retu
       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
-  
+
     sapling.active?(:space_chat [, :user => the current user])
-    
-  
+
+
   *Note*: sapling will automatically populate the user argument by calling `current_user`
-  
+
 To get the css classes the javascript adds to the HTML element for a feature:
 
     sapling.css_class(:space_chat)
-    sapling.css_toggle_class(:space_chat)    
-  
+    sapling.css_toggle_class(:space_chat)
+
 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)`
@@ -69,7 +69,7 @@ To enable a feature for 50% of the users, in the rails console:
 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.
 
@@ -78,15 +78,21 @@ Custom Feature-Active Tests
 
 You can optionally inject your own code for testing if a feature is active. In rails, just added methods of the following form to your ApplicationController:
 
-    # Example: override feature-active? for feature :new_homepage                                                         
-    # options:                                                                                                        
+    # Example: override feature-active? for feature :new_homepage
+    #
+    # options:
     #   :feature => object of type Sapling::Feature
     #       (current settings for the feature from the database)
-    #   :user => user to test for feature-active                                                                                                             
+    #   :active => true if the feature would be active without the override
+    #
+    # remaining options are those passed to 'sapling.active?'
+    #   :user => user to test for feature-active
+    #   :context_id => Integer
+    #
     # return true if the feature is active.
-    def new_homepage_active?(options={})                                                                            
+    def new_homepage_active?(options={})
       # your test here
-    end                                                                                                             
+    end
 
 *Note* If you are using Sapling manually, when you create a Sapling instance, you can pass in an any object which responds to "current_user" and implements zero or more of your feature-active overrides.
 
@@ -130,8 +136,8 @@ ERB:
     <div class="<%= sapling.css_class(:chat) %> disabled">
       DESPAIR - SPIFF CHAT NOT ENABLED FOR YOU
     </div>
-    
-    
+
+
 *Note* Currently, the javascript generated depends on MooTools being loaded first.
 
 TODO

data/changelog.md

@@ -8,3 +8,12 @@ When using Sapling in rails, there are some api changes:
 
   old: feature_class(feature_name)
   new: sapling.css_class(feature_name)
+
+0.4.1
+=====
+
+Added option value for overrides. The hash value :active is now passed into
+every override method called. This indicates if the feature would be active
+without the override.
+
+Fixed fatal bug in the Sapling+Rails controller javascript generation.

data/lib/sapling/base.rb

@@ -11,22 +11,15 @@ module Sapling
     private
     def active_internal(feature_name,options)
       feature_method = "#{feature_name}_active?".to_sym
+      base_active = (f=features[feature_name]) && f.active?(options)
       if controller && controller.respond_to?(feature_method)
         # use override
-        controller.send(feature_method,options.merge(:feature => features[feature_name]))
+        controller.send(feature_method,options.merge(:feature => features[feature_name],:active => base_active))
       else
-        (f=features[feature_name]) && f.active?(options)
+        base_active
       end
     end
 
-    # override feature test example for feature :new_homepage
-    # options:
-    #   feature is of type Feature
-    #   :user
-    # returns true if the feature is enabled
-    # def new_homepage_active?(options={})
-    #  # your test here
-    # end
     public
 
     # see Sapling::API::Client
@@ -45,7 +38,7 @@ module Sapling
     end
 
     def js_generator
-      @js_generator ||= JavascriptGenerator.new
+      @js_generator ||= JavascriptGenerator.new(self)
     end
 
     def css_class_prefix

data/lib/sapling/version.rb

@@ -1,3 +1,3 @@
 module Sapling
-  VERSION = "0.3.0"
+  VERSION = "0.4.1"
 end

data/spec/rails_app/test/integration/feature_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require File.join(File.dirname(__FILE__),"..",'test_helper')
 
 class FeatureTest < ActionController::IntegrationTest
   fixtures :all
@@ -10,6 +10,13 @@ class FeatureTest < ActionController::IntegrationTest
     assert_equal '1', response.body
   end
 
+  # Replace this with your real tests.
+  test "js generation works" do
+    post user_sessions_path, :user_id => 1
+    get "/sapling/script.js"
+    assert response.body['sapling_feature_my_custom_test_feature_on']
+  end
+
   test "users cant use 'my_custom_test_feature'" do
     # user1 is listed, user2 is not
     assert Sapling::ActiveRecord.new.features[:my_custom_test_feature].users[1]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sapling
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 13
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 0
-  version: 0.3.0
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Shane Brinkman-Davis
@@ -16,7 +16,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-03 00:00:00 Z
+date: 2012-02-03 00:00:00 -08:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -201,6 +202,7 @@ files:
 - spec/sapling_examples.rb
 - spec/spec.opts
 - spec/spec_helper.rb
+has_rdoc: true
 homepage: https://github.com/imikimi/sapling
 licenses: []
 
@@ -230,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: sapling
-rubygems_version: 1.8.10
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Incrementally roll out your features. Uses ActiveRecord to store configuration and supports client-side roll-out of cached pages.