flip_fab 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ea3fd649b489b75844fc35dd2716d541abf34ca
+  data.tar.gz: 0680f0288b3f0a64673affb0d55466351c10478e
+SHA512:
+  metadata.gz: a4244a1f9a56503cf8a2978e22211502cc0c4ac7ab630cfc8abc79c1c4f61aa155a463eebc85dc75beb284d79c475fa1a824c01e4df85444896b84d9bfa2e0b3
+  data.tar.gz: c4073fe2c728d9e7f61fe6edf88903345f297d76c4e39d2116a6c7215dfb323a0f20da89e96f03a68c2f6945d2458809227612446d9d6f88069dabefc7c0db71

data/.rspec

@@ -0,0 +1,5 @@
+-r rutabaga
+--order rand
+--color
+--require spec_helper
+--format doc

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flip_fab.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry-plus'
+end
+
+group :test do
+  gem 'rack'
+  gem 'rack-test'
+  gem 'rspec'
+  gem 'rutabaga'
+  gem 'timecop'
+end

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    flip_fab (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    binding_of_caller (0.7.2)
+      debug_inspector (>= 0.0.1)
+    bond (0.5.1)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    debug_inspector (0.0.2)
+    debugger (1.6.8)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.5)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.8)
+    diff-lcs (1.2.5)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    interception (0.5)
+    jist (1.5.1)
+      json
+    json (1.8.2)
+    method_source (0.8.2)
+    multi_json (1.10.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-debugger (0.2.3)
+      debugger (~> 1.3)
+      pry (>= 0.9.10, < 0.11.0)
+    pry-doc (0.6.0)
+      pry (~> 0.9)
+      yard (~> 0.8)
+    pry-docmore (0.1.1)
+      pry
+      pry-doc
+    pry-plus (1.0.0)
+      bond
+      jist
+      pry-debugger
+      pry-doc
+      pry-docmore
+      pry-rescue
+      pry-stack_explorer
+    pry-rescue (1.4.1)
+      interception (>= 0.5)
+      pry
+    pry-stack_explorer (0.4.9.2)
+      binding_of_caller (>= 0.7)
+      pry (>= 0.9.11)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.1)
+    rutabaga (0.1.1)
+      turnip (>= 1.1.0, < 2.0)
+    slop (3.6.0)
+    timecop (0.7.3)
+    turnip (1.2.4)
+      gherkin (>= 2.5)
+      rspec (>= 2.14.0, < 4.0)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flip_fab!
+  pry-plus
+  rack
+  rack-test
+  rspec
+  rutabaga
+  timecop

data/LICENSE.txt

@@ -0,0 +1,9 @@
+Copyright (c) 2015 Simply Business
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,168 @@
+Flip Fab
+--------
+
+**Feature flipping... Made FaBuLoUs!**
+
+A gem providing persistent (via cookie store) feature flipping to Rack applications.
+
+This allows you to...
+
+* Define features that can be used to modify the behaviour of an application
+* Persist the features' states in a user's cookie so that they see a consistent feature set for all applications in a domain
+* Define your own custom persistence adapters to persist features in your own data store
+
+## Usage
+
+Add the following to your `Gemfile`
+
+```ruby
+gem 'flip_fab', git: 'git@github.com:simplybusiness/flip_fab.git'
+```
+
+### Rails
+
+The helper will be included in `ActionController::Base` as a view helper method when the gem is loaded.
+
+### Sinatra
+
+Add the following to `Sinatra::Base`
+
+```ruby
+require 'flip_fab'
+helpers FlipFab::Helper
+```
+
+## Defining a feature
+
+For Rails, this could go in `config/initializers/flip_fab.rb`
+
+```ruby
+FlipFab.define_feature(:name_of_feature) # default state: :disabled
+FlipFab.define_feature(:name_of_other_feature, { default: :enabled }) # default state: :enabled
+```
+
+## Enabling/disabling a feature for a user
+
+### Within the context of a controller
+
+```ruby
+features[:name_of_feature].enable # Enable the feature for the user
+features[:name_of_feature].enabled? # => true
+features[:name_of_feature].disable # Disable the feature for the user
+features[:name_of_feature].disabled? # => true
+```
+
+* If the feature is not defined, `features[:name_of_feature]` will raise an error
+* The enabled/disabled feature will be stored in the user's cookie
+
+### Outside of a controller
+
+Outside of a controller, features cannot be enabled/disabled for individual users.
+
+### From URL params
+
+You can explicitely request a feature to be enabled or disabled in your session by passing the desired state of a feature in the parameters of your request:
+
+`http://localhost:3000?name_of_feature=enabled&name_of_other_feature=disabled`
+
+* The features' states specified in the URL will take precendence over those specified in the controller
+* The enabled/disabled features will be stored in the user's cookie
+* Smoke tests could enable or disable features using this mechanism
+
+_Note: This will enable users of a production system to show/hide features in their session. While this allows automated tests to be run against staging/production environment against a particular set of features, this will allow users to 'customize' their experience, so consider what types of features a user could be switching on and off i.e. authentication, security, etc._
+
+## Checking if a feature is enabled
+
+### From within a controller or view
+
+```ruby
+# With the feature having been enabled for the user:
+features[:name_of_feature].enable # Enable the feature for the user
+
+features[:name_of_feature].enabled? # => true
+features[:name_of_feature].disabled? # => false
+```
+
+### Outside of a controller/view
+
+```ruby
+# With the feature defined like this:
+FlipFab.define_feature(:name_of_feature) # default state: :disabled
+
+FlipFab.features[:name_of_feature].enabled? # => false
+FlipFab.features[:name_of_feature].disabled? # => true
+```
+
+### Precedence of feature lookup
+
+1. URL parameter
+1. Code (e.g. `features[:name_of_feature].enable`)
+1. Cookie
+1. Default
+
+## Cookie persistence
+
+Out of the box, the features a user receives can be persisted in their cookie. The cookie will have the following parameters:
+
+| Parameter | Value |
+| --------- | ----- |
+| Name      | `flip_fab.[name of feature]` |
+| Value     | `enabled|disabled` |
+| Path      | `/` |
+| Expires   | One year from now |
+| Domain    | The top-level domain |
+
+To persist the features in a user's cookie, do any of the following operations
+
+```ruby
+features[:name_of_feature].enable # Enable the feature for the user
+features[:name_of_feature].disable # Disable the feature for the user
+features[:name_of_feature].persist # Persist the feature for the user
+```
+
+## Defining a custom persistence adapter
+
+1. Create a class that extends the `FlipFab::Persistence` class
+
+  ```ruby
+  class ExamplePersistence < FlipFab::Persistence
+
+    def initialize feature_name, context
+      super
+    end
+
+    def read
+      # lookup the state of the feature
+    end
+
+    def write state
+      # write the state of the feature
+    end
+  end
+  ```
+
+1. Implement the `read` and `write` operations. The following variables will be available from `FlipFab::Persistence`
+  1. `feature_name` - the name of the feature to be read/written
+  1. `context` - the controller context (whatever class has included `FlipFab::Helper`)
+
+1. Include your persistence class when defining the feature
+
+  ```ruby
+  FlipFab.define_feature(:name_of_other_feature, { persistence_adapters: [ExamplePersistence] })
+  ```
+
+Note that you can define multiple custom adapters that will be read in precedence of the order specified
+
+## Example app
+
+There is an example app that demonstrates the use of FlipFlab in `example/rails_app`. The app has a feature called `:justin_beaver` that allows you to flip the image on the page between a beaver and a 'justin beaver'.
+
+
+Perform the following to try the example:
+
+1. Go into the app: `cd example/rails_app`
+1. Install the gems: `bundle install`
+1. Run the migrations: `bundle exec rake db:migrate`
+1. Start rails: `bundle exec rails s`
+1. View the page with the feature disabled: `open 'http://localhost:3000/beavers?justin_beaver=disabled'`
+1. View the page with the feature enabled: `open 'http://localhost:3000/beavers?justin_beaver=enabled'`

data/example/rails_app/.gitignore

@@ -0,0 +1,17 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and temp files.
+/log/*.log
+/tmp/cache
+/tmp/pids/*.pid

data/example/rails_app/Gemfile

@@ -0,0 +1,36 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.2.0'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.3'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer',  platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0',          group: :doc
+
+# Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+gem 'spring',        group: :development
+
+# Use unicorn as the app server
+gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+gem 'flip_fab', path: '../../'
+
+gem 'rspec-rails', group: :test

data/example/rails_app/Gemfile.lock

@@ -0,0 +1,178 @@
+PATH
+  remote: ../../
+  specs:
+    flip_fab (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.0)
+      actionview (= 4.2.0)
+      activesupport (= 4.2.0)
+      rack (~> 1.6.0)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activejob (4.2.0)
+      activesupport (= 4.2.0)
+      globalid (>= 0.3.0)
+    activemodel (4.2.0)
+      activesupport (= 4.2.0)
+      builder (~> 3.1)
+    activerecord (4.2.0)
+      activemodel (= 4.2.0)
+      activesupport (= 4.2.0)
+      arel (~> 6.0)
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    builder (3.2.2)
+    coffee-rails (4.0.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.0)
+    coffee-script (2.3.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.1)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    execjs (2.3.0)
+    globalid (0.3.3)
+      activesupport (>= 4.1.0)
+    hike (1.2.3)
+    i18n (0.7.0)
+    jbuilder (2.2.8)
+      activesupport (>= 3.0.0, < 5)
+      multi_json (~> 1.2)
+    jquery-rails (4.0.3)
+      rails-dom-testing (~> 1.0)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.2)
+    kgio (2.9.3)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    mime-types (2.4.3)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    multi_json (1.10.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.0)
+      actionmailer (= 4.2.0)
+      actionpack (= 4.2.0)
+      actionview (= 4.2.0)
+      activejob (= 4.2.0)
+      activemodel (= 4.2.0)
+      activerecord (= 4.2.0)
+      activesupport (= 4.2.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.0)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.5)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.1)
+      loofah (~> 2.0)
+    railties (4.2.0)
+      actionpack (= 4.2.0)
+      activesupport (= 4.2.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    raindrops (0.13.0)
+    rake (10.4.2)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    rspec-core (3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-rails (3.2.0)
+      actionpack (>= 3.0, <= 4.2)
+      activesupport (>= 3.0, <= 4.2)
+      railties (>= 3.0, <= 4.2)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.1)
+    sass (3.2.19)
+    sass-rails (4.0.5)
+      railties (>= 4.0.0, < 5.0)
+      sass (~> 3.2.2)
+      sprockets (~> 2.8, < 3.0)
+      sprockets-rails (~> 2.0)
+    sdoc (0.4.1)
+      json (~> 1.7, >= 1.7.7)
+      rdoc (~> 4.0)
+    spring (1.3.2)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.2.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    turbolinks (2.5.3)
+      coffee-rails
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uglifier (2.7.0)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+    unicorn (4.8.3)
+      kgio (~> 2.6)
+      rack
+      raindrops (~> 0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-rails (~> 4.0.0)
+  flip_fab!
+  jbuilder (~> 2.0)
+  jquery-rails
+  rails (= 4.2.0)
+  rspec-rails
+  sass-rails (~> 4.0.3)
+  sdoc (~> 0.4.0)
+  spring
+  sqlite3
+  turbolinks
+  uglifier (>= 1.3.0)
+  unicorn

data/example/rails_app/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/example/rails_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/example/rails_app/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/example/rails_app/app/assets/javascripts/beavers.js.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/example/rails_app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/example/rails_app/app/assets/stylesheets/beavers.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the Beavers controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/example/rails_app/app/assets/stylesheets/scaffolds.css.scss

@@ -0,0 +1,69 @@
+body {
+  background-color: #fff;
+  color: #333;
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+  &:visited {
+    color: #666;
+  }
+  &:hover {
+    color: #fff;
+    background-color: #000;
+  }
+}
+
+div {
+  &.field, &.actions {
+    margin-bottom: 10px;
+  }
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+  h2 {
+    text-align: left;
+    font-weight: bold;
+    padding: 5px 5px 5px 15px;
+    font-size: 12px;
+    margin: -7px;
+    margin-bottom: 0px;
+    background-color: #c00;
+    color: #fff;
+  }
+  ul li {
+    font-size: 12px;
+    list-style: square;
+  }
+}