flip 0.0.4 → 0.1.0

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -1,21 +1,29 @@
 Flip — flip your features
 ================
 
-[Learnable](https://learnable.com) uses feature flippers ([so does Flickr](http://code.flickr.com/blog/2009/12/02/flipping-out/)) as a tool to help achieve [continuous deployment](http://timothyfitz.wordpress.com/2009/02/10/continuous-deployment-at-imvu-doing-the-impossible-fifty-times-a-day/).
+**Flip** provides a declarative, layered way of enabling and disabling application functionality at run-time.
 
-**Flip** gives us a declarative, layered mechanism to enable and disable features. There's a configurable system-wide default (`default: !Rails.env.production?` works nicely), plus three layers of strategies to determine status per-feature:
+This gem optimizes for:
 
-* The declared default, e.g. `feature :world_domination, default: true`,
-* A database-backed strategy, for flipping features site-wide for all users.
-* A cookie-backed strategy, for privately previewing features in your own browser only.
+* developer ease-of-use,
+* visibility and control for other stakeholders (like marketing); and
+* run-time performance
 
-(Hint: that last one is a a killer feature..)
+There are three layers of strategies per feature:
+
+* default
+* database, to flip features site-wide for all users
+* cookie, to flip features just for you (or someone else)
+
+There is also a configurable system-wide default - !Rails.env.production?` works nicely.
+
+Flip has a dashboard UI that's easy to understand and use.
+
+![Feature Flipper Dashboard](https://dl.dropbox.com/u/13833591/flip-gem-dashboard.png "Feature Flipper Dashboard")
 
 Install
 -------
 
-Note: the alpha version number indicates Flip is currently being extracted from its host application. **The process described here is currently fictional.** But it does have a happy ending.
-
 **Rails 3.0 and 3.1+**
 
     # Gemfile
@@ -27,8 +35,6 @@ Note: the alpha version number indicates Flip is currently being extracted from
     # Run the migration
     > rake db:migrate
 
-    # They lived happily ever after.
-
 
 Declaring Features
 ------------------
@@ -64,7 +70,7 @@ Declaring Features
 Checking Features
 -----------------
 
-Feature status can be checked by any code using `on?` or using the dynamic predicate methods:
+`Flip.on?` or the dynamic predicate methods are used to check feature state:
 
     Flip.on? :world_domination   # true
     Flip.world_domination?       # true
@@ -72,7 +78,7 @@ Feature status can be checked by any code using `on?` or using the dynamic predi
     Flip.on? :shiny_things       # false
     Flip.shiny_things?           # false
 
-Within view and controller methods, the `FlipHelper` module provides a `feature?(key)` method:
+Views and controllers use the `feature?(key)` method:
 
     <div>
       <% if feature? :world_domination %>
@@ -98,15 +104,40 @@ The `Flip::ControllerFilters` module is mixed into the base `ApplicationControll
     
     end
 
-Note that conditionally declared routes require a server restart to notice changes to feature flags, so they're not a good idea; database/cookie feature flipping will be ignored.
+Dashboard
+---------
+
+The dashboard provides visibility and control over the features.
+
+The gem includes some basic styles:
+
+    = content_for :stylesheets_head do
+      = stylesheet_link_tag "flip"
 
+You probably don't want the dashboard to be public.  Here's one way of implementing access control.
 
-Command Center
---------------
+app/controllers/admin/features_controller.rb:
 
-A dashboard allows you to view the current state of the feature set, and flip any switchable strategies (database, cookie). *Screenshot coming&hellip;*
+    class Admin::FeaturesController < Flip::FeaturesController
+      before_filter :assert_authenticated_as_admin
+    end
+
+app/controllers/admin/feature_strategies_controller.rb:
+
+    class Admin::FeatureStrategiesController < Flip::FeaturesController
+      before_filter :assert_authenticated_as_admin
+    end
+
+routes.rb:
+
+    namespace :admin do
+      resources :features, only: [ :index ] do
+        resources :feature_strategies, only: [ :update, :destroy ]
+      end
+    end
 
+    mount Flip::Engine => "/admin/features"
 
 ----
-Created by Paul Annesley  
-Copyright © 2011 Learnable Pty Ltd, [MIT Licence](http://www.opensource.org/licenses/mit-license.php).
+Created by Paul Annesley
+Copyright © 2011-2013 Learnable Pty Ltd, [MIT Licence](http://www.opensource.org/licenses/mit-license.php).

data/app/assets/stylesheets/flip.css

@@ -1,64 +1,70 @@
 /* Flip */
 
 .flip {
-  margin: 2em 1em 4em 1em;
+  margin: 0;
+}
+
+.flip h1 {
+  color:#666666;
+  font-size: 229%;
+  line-height: 44.928px;
+  margin: 13.5px 0;
 }
 
 .flip th.name, .flip th.description, .flip th.status {
-	visibility: hidden;
+  visibility: hidden;
 }
 
 .flip td.name {
-	font-family: Monaco, sans-serif;
-	font-weight: bold;
+  font-family: Monaco, sans-serif;
+  font-weight: bold;
 }
 
 .flip td.name, .flip td.description {
-	vertical-align: top;
+  vertical-align: top;
 }
 
 .flip th {
-	font-weight: normal;
-	text-align: left;
-	vertical-align: top;
+  font-weight: normal;
+  text-align: left;
+  vertical-align: top;
 }
 
 .flip th .description {
-	font-weight: normal;
-	display: block;
-	font-size: 80%;
+  font-weight: normal;
+  display: block;
+  font-size: 80%;
 }
 
 .flip th, .flip td {
-	padding: 5px 10px;
-	width: 160px;
-	height: 40px;
+  padding: 5px 10px;
+  width: 160px;
+  height: 40px;
 }
 
 .flip td.off, .flip td.on, .flip td.pass {
-	text-align: center;
-	text-transform: capitalize;
+  text-align: center;
+  text-transform: capitalize;
 }
 
 .flip td.off {
-	background-color: #fbb;
+  background-color: #fbb;
 }
 
 .flip td.on {
-	background-color: #cfc;
+  background-color: #cfc;
 }
 
 .flip td.pass {
-	background-color: #eef;
+  background-color: #eef;
 }
 
 .flip form {
-	display: inline;
+  display: inline;
 }
 
 .flip form input[type=submit] {
-	font-size: 80%;
-	padding: 2px 5px;
-	margin: 0;
+  font-size: 80%;
+  padding: 2px 5px;
+  margin: 0;
 }
-

data/app/views/flip/features/index.html.erb

@@ -1,60 +1,62 @@
-<h1>Feature Flippers</h1>
-
-<table class="flip">
-  <thead>
-    <th class="name">Feature Name</th>
-    <th class="description">Description</th>
-    <th class="status">Status</th>
-    <% @p.strategies.each do |strategy| %>
+<div class="flip">
+  <h1>Feature Flippers</h1>
+
+  <table>
+    <thead>
+      <th class="name">Feature Name</th>
+      <th class="description">Description</th>
+      <th class="status">Status</th>
+      <% @p.strategies.each do |strategy| %>
+        <th>
+          <%= strategy.name %>
+          <span class="description"><%= strategy.description %></span>
+        </th>
+      <% end %>
       <th>
-        <%= strategy.name %>
-        <span class="description"><%= strategy.description %></span>
+        Default
+        <span class="description">The system default when no strategies match.</span>
       </th>
-    <% end %>
-    <th>
-      Default
-      <span class="description">The system default when no strategies match.</span>
-    </th>
-  </thead>
-  <tbody>
-  <% @p.definitions.each do |definition| %>
-    <tr>
-      <td class="name"><%= definition.name %></td>
-
-      <td class="description"><%= definition.description %></td>
-
-      <%= content_tag :td, class: @p.status(definition) do %>
-        <%= @p.status definition %>
-      <% end %>
+    </thead>
+    <tbody>
+    <% @p.definitions.each do |definition| %>
+      <tr>
+        <td class="name"><%= definition.name %></td>
 
-      <% @p.strategies.each do |strategy| %>
-        <%= content_tag :td, class: @p.strategy_status(strategy, definition) || "pass" do %>
-          <%= @p.strategy_status strategy, definition %>
+        <td class="description"><%= definition.description %></td>
+
+        <%= content_tag :td, class: @p.status(definition) do %>
+          <%= @p.status definition %>
+        <% end %>
 
-          <% if strategy.switchable? %>
-            <%= form_tag(@p.switch_url(strategy, definition), method: :put) do %>
-              <% unless @p.strategy_status(strategy, definition) == "on" %>
-                <%= submit_tag "Switch On" %>
+        <% @p.strategies.each do |strategy| %>
+          <%= content_tag :td, class: @p.strategy_status(strategy, definition) || "pass" do %>
+            <%= @p.strategy_status strategy, definition %>
+
+            <% if strategy.switchable? %>
+              <%= form_tag(@p.switch_url(strategy, definition), method: :put) do %>
+                <% unless @p.strategy_status(strategy, definition) == "on" %>
+                  <%= submit_tag "Switch On" %>
+                <% end %>
+                <% unless @p.strategy_status(strategy, definition) == "off" %>
+                  <%= submit_tag "Switch Off" %>
+                <% end %>
               <% end %>
-              <% unless @p.strategy_status(strategy, definition) == "off" %>
-                <%= submit_tag "Switch Off" %>
+              <% unless @p.strategy_status(strategy, definition).blank? %>
+                <%= form_tag(@p.switch_url(strategy, definition), method: :delete) do %>
+                  <%= submit_tag "Delete" %>
+                <% end %>
               <% end %>
             <% end %>
-            <% unless @p.strategy_status(strategy, definition).blank? %>
-              <%= form_tag(@p.switch_url(strategy, definition), method: :delete) do %>
-                <%= submit_tag "Delete" %>
-              <% end %>
-            <% end %>
-          <% end %>
 
+          <% end %>
         <% end %>
-      <% end %>
 
-      <%= content_tag :td, class: @p.default_status(definition) do %>
-        <%= @p.default_status definition %>
-      <% end %>
+        <%= content_tag :td, class: @p.default_status(definition) do %>
+          <%= @p.default_status definition %>
+        <% end %>
 
-    </tr>
-  <% end %>
-  </tbody>
-</table>
+      </tr>
+    <% end %>
+    </tbody>
+  </table>
+</div>

data/lib/flip/version.rb

@@ -1,3 +1,3 @@
 module Flip
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flip
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,52 +9,72 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-04 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70160385209800 !ruby/object:Gem::Requirement
-    none: false
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+    none: false
   type: :runtime
-  prerelease: false
-  version_requirements: *70160385209800
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    none: false
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70160385207660 !ruby/object:Gem::Requirement
-    none: false
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :runtime
-  prerelease: false
-  version_requirements: *70160385207660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70160380032000 !ruby/object:Gem::Requirement
-    none: false
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
+    none: false
   type: :development
-  prerelease: false
-  version_requirements: *70160380032000
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    none: false
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70160380031580 !ruby/object:Gem::Requirement
-    none: false
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
-  version_requirements: *70160380031580
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
 description: Declarative API for specifying features, switchable in declaration, database
   and cookies.
 email:
@@ -114,20 +134,20 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: flip
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A feature flipper for Rails web applications.
@@ -142,3 +162,4 @@ test_files:
 - spec/feature_set_spec.rb
 - spec/flip_spec.rb
 - spec/spec_helper.rb
+has_rdoc: