flip 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da01ea06aa9d7689818dfaa77f99757c190501bf
-  data.tar.gz: 416f3d9d8bbe884a0a3cc4b83ebce94b102d7f4f
+  metadata.gz: 02d991d1f3a6415ae4a80c82b7a55a10be509ce1
+  data.tar.gz: df57386343e6c19b21d2715d007dd2af5dc6e45b
 SHA512:
-  metadata.gz: 26350753c4fd704b07e713d03b057adb2e97c035ea75a0357e70900a0b1eaaa357227aba0591b1aea944c2e81bd62484da319496165deba00b8ef2a4cc5bf16b
-  data.tar.gz: fe1cc381d2d4684b9d429a41c53d1d54aa377507b2089b07c695b1703cd8e94c7d3b8a14d3b8c3a5f76e7e5c2e459695f248c403f59cc092e16c7f009fcc5a45
+  metadata.gz: 6acd5b58a68b952db77dae428b8f66f9c451286578f677a927d75f6f3e9d54d45c87779d9de3402f2aa28979a4f8810c0bc1f7d1b024644f84ee507160785eb1
+  data.tar.gz: e2658c0ff8d9a5fcefd12ba116b711e7f11a4ae4ab195c5ab6b6d74ca71df2c48bd2c48fb0fd92b80e65f5cdf8240bb3e3835879e347caefe931a6ba40aaf96f

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
-  - jruby-19mode
+  - 2.3.0
+  - 2.2.4
+  - jruby-9.0.5.0

data/README.md

@@ -21,7 +21,7 @@ There is also a configurable system-wide default - !Rails.env.production?` works
 
 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")
+![Feature Flipper Dashboard](https://cloud.githubusercontent.com/assets/828243/4934741/a5773568-65a4-11e4-98d8-5e9a32720b2e.png)
 
 Install
 -------
@@ -67,7 +67,7 @@ class Feature < ActiveRecord::Base
   # Provide a description, normally derived from the feature name.
   feature :something,
     default: true,
-    description: "Ability to purchase enrollments in courses",
+    description: "Ability to purchase enrollments in courses"
 
 end
 ```
@@ -100,7 +100,7 @@ Views and controllers use the `feature?(key)` method:
 Feature Flipping Controllers
 ----------------------------
 
-The `Flip::ControllerFilters` module is mixed into the base `ApplicationController` class.  The following controller will respond with 404 Page Not Found to all but the `index` action unless the :new_stuff feature is enabled:
+The `Flip::ControllerFilters` module is mixed into the base `ApplicationController` class.  The following controller will respond with 404 Page Not Found to all but the `index` action unless the `:something` feature is enabled:
 
 ```ruby
 class SampleController < ApplicationController
@@ -134,7 +134,7 @@ app/controllers/admin/features_controller.rb:
 
 ```ruby
 class Admin::FeaturesController < Flip::FeaturesController
-  before_filter :assert_authenticated_as_admin
+  before_action :assert_authenticated_as_admin
 end
 ```
 
@@ -142,7 +142,7 @@ app/controllers/admin/strategies_controller.rb:
 
 ```ruby
 class Admin::StrategiesController < Flip::StrategiesController
-  before_filter :assert_authenticated_as_admin
+  before_action :assert_authenticated_as_admin
 end
 ```
 
@@ -158,6 +158,23 @@ end
 mount Flip::Engine => "/admin/features"
 ```
 
+Cacheable
+---------
+
+You can optimize your feature to ensure that it doesn't make a ton of feature
+calls by adding Cacheable to your model.
+```ruby
+extend Flip::Cacheable
+```
+
+This will ensure that your features are eager loaded with one call to the database 
+instead of every call to Flip#on? generating a call to the database.  This is
+helpful if you have a larger Rails application and more than a few features
+defined.
+
+To start or reset the cache, just call #start_feature_cache.
+
+
 ----
 Created by Paul Annesley
 Copyright © 2011-2013 Learnable Pty Ltd, [MIT Licence](http://www.opensource.org/licenses/mit-license.php).

data/flip.gemspec

@@ -18,9 +18,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency("activesupport", ">= 3.0", "< 5")
+  s.add_dependency("activesupport", ">= 3.0", "< 5.1")
   s.add_dependency("i18n")
 
   s.add_development_dependency("rspec", "~> 2.5")
+  s.add_development_dependency("rspec-its")
   s.add_development_dependency("rake")
 end

data/lib/flip.rb

@@ -9,6 +9,7 @@
 # Flip files.
 %w{
   abstract_strategy
+  cacheable
   controller_filters
   cookie_strategy
   database_strategy

data/lib/flip/cacheable.rb

@@ -0,0 +1,25 @@
+module Flip
+  module Cacheable
+
+    def use_feature_cache=(value)
+      @use_feature_cache = value
+    end
+
+    def use_feature_cache
+      @use_feature_cache
+    end
+
+    def start_feature_cache
+      @use_feature_cache = true
+      @features = nil
+    end
+
+    def feature_cache
+      return @features if @features
+      @features = {}
+      all.each { |f| @features[f.key] = f }
+      @features
+    end
+
+  end
+end

data/lib/flip/controller_filters.rb

@@ -1,4 +1,7 @@
 module Flip
+  # ControllerFilters is a name that refers to the fact that Rails
+  # before_action and after_action used to be before_filter and
+  # after_filter.
   module ControllerFilters
 
     extend ActiveSupport::Concern
@@ -6,7 +9,7 @@ module Flip
     module ClassMethods
 
       def require_feature key, options = {}
-        before_filter options do
+        before_action options do
           flip_feature_disabled key unless Flip.on? key
         end
       end

data/lib/flip/cookie_strategy.rb

@@ -11,7 +11,9 @@ module Flip
     end
 
     def on? definition
-      cookies[cookie_name(definition)] === "true"
+      cookie = cookies[cookie_name(definition)]
+      cookie_value = cookie.is_a?(Hash) ? cookie['value'] : cookie
+      cookie_value === 'true'
     end
 
     def switchable?
@@ -19,7 +21,10 @@ module Flip
     end
 
     def switch! key, on
-      cookies[cookie_name(key)] = on ? "true" : "false"
+      cookies[cookie_name(key)] = {
+        'value' => (on ? "true" : "false"),
+        'domain' => :all
+      }
     end
 
     def delete! key
@@ -42,13 +47,13 @@ module Flip
     end
 
     # Include in ApplicationController to push cookies into CookieStrategy.
-    # Users before_filter and after_filter rather than around_filter to
+    # Uses before_action and after_action rather than around_action to
     # avoid pointlessly adding to stack depth.
     module Loader
       extend ActiveSupport::Concern
       included do
-        before_filter :flip_cookie_strategy_before
-        after_filter :flip_cookie_strategy_after
+        before_action :flip_cookie_strategy_before
+        after_action :flip_cookie_strategy_after
       end
       def flip_cookie_strategy_before
         CookieStrategy.cookies = cookies

data/lib/flip/database_strategy.rb

@@ -35,7 +35,11 @@ module Flip
     private
 
     def feature(definition)
-      @klass.where(key: definition.key.to_s).first
+      if @klass.respond_to?(:use_feature_cache) && @klass.use_feature_cache
+        @klass.feature_cache[definition.key.to_s]
+      else
+        @klass.where(key: definition.key.to_s).first
+      end
     end
 
   end

data/lib/flip/version.rb

@@ -1,3 +1,3 @@
 module Flip
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/generators/flip/migration/templates/create_features.rb

@@ -1,3 +1,4 @@
+# Created by the flip gem, see https://github.com/pda/flip
 class CreateFeatures < ActiveRecord::Migration
   def change
     create_table :features do |t|

data/spec/cacheable_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe Flip::Cacheable do
+
+  subject(:model_class) do
+    class Sample
+      attr_accessor :key
+    end
+
+    Class.new do
+      extend Flip::Declarable
+      extend Flip::Cacheable
+
+      strategy Flip::DeclarationStrategy
+      default false
+
+      feature :one
+      feature :two, description: "Second one."
+      feature :three, default: true
+
+      def self.all
+        list = []
+        i = 65
+        3.times do
+          list << Sample.new
+          list.last.key = i.chr()
+          i += 1
+        end
+        list
+      end
+    end
+  end
+
+  describe "with feature cache" do
+    context "initial context" do
+      it { should respond_to(:use_feature_cache) }
+      it { should respond_to(:start_feature_cache) }
+      it { should respond_to(:feature_cache) }
+      specify { model_class.use_feature_cache.should be_nil }
+    end
+
+    context "after a cache clear" do
+      before { model_class.start_feature_cache }
+      specify { model_class.use_feature_cache.should eq true }
+      specify { model_class.feature_cache.size == 3}
+    end
+  end
+
+end

data/spec/controller_filters_spec.rb

@@ -8,16 +8,16 @@ describe ControllerWithFlipFilters do
 
   describe ".require_feature" do
 
-    it "adds before_filter without options" do
+    it "adds before_action without options" do
       ControllerWithFlipFilters.tap do |klass|
-        klass.should_receive(:before_filter).with({})
+        klass.should_receive(:before_action).with({})
         klass.send(:require_feature, :testable)
       end
     end
 
-    it "adds before_filter with options" do
+    it "adds before_action with options" do
       ControllerWithFlipFilters.tap do |klass|
-        klass.should_receive(:before_filter).with({ only: [ :show ] })
+        klass.should_receive(:before_action).with({ only: [ :show ] })
         klass.send(:require_feature, :testable, only: [ :show ])
       end
     end

data/spec/cookie_strategy_spec.rb

@@ -2,8 +2,8 @@ require "spec_helper"
 
 class ControllerWithoutCookieStrategy; end
 class ControllerWithCookieStrategy
-  def self.before_filter(_); end
-  def self.after_filter(_); end
+  def self.before_action(_); end
+  def self.after_action(_); end
   def cookies; []; end
   include Flip::CookieStrategy::Loader
 end
@@ -26,26 +26,26 @@ describe Flip::CookieStrategy do
   describe "cookie interrogration" do
     context "enabled feature" do
       specify "#knows? is true" do
-        strategy.knows?(:one).should be_true
+        strategy.knows?(:one).should be true
       end
       specify "#on? is true" do
-        strategy.on?(:one).should be_true
+        strategy.on?(:one).should be true
       end
     end
     context "disabled feature" do
       specify "#knows? is true" do
-        strategy.knows?(:two).should be_true
+        strategy.knows?(:two).should be true
       end
       specify "#on? is false" do
-        strategy.on?(:two).should be_false
+        strategy.on?(:two).should be false
       end
     end
     context "feature with no cookie present" do
       specify "#knows? is false" do
-        strategy.knows?(:three).should be_false
+        strategy.knows?(:three).should be false
       end
       specify "#on? is false" do
-        strategy.on?(:three).should be_false
+        strategy.on?(:three).should be false
       end
     end
   end
@@ -53,20 +53,20 @@ describe Flip::CookieStrategy do
   describe "cookie manipulation" do
     it "can switch known features on" do
       strategy.switch! :one, true
-      strategy.on?(:one).should be_true
+      strategy.on?(:one).should be true
     end
     it "can switch unknown features on" do
       strategy.switch! :three, true
-      strategy.on?(:three).should be_true
+      strategy.on?(:three).should be true
     end
     it "can switch features off" do
       strategy.switch! :two, false
-      strategy.on?(:two).should be_false
+      strategy.on?(:two).should be false
     end
     it "can delete knowledge of a feature" do
       strategy.delete! :one
-      strategy.on?(:one).should be_false
-      strategy.knows?(:one).should be_false
+      strategy.on?(:one).should be false
+      strategy.knows?(:one).should be false
     end
   end
 
@@ -76,8 +76,8 @@ describe Flip::CookieStrategy::Loader do
 
   it "adds filters when included in controller" do
     ControllerWithoutCookieStrategy.tap do |klass|
-      klass.should_receive(:before_filter).with(:flip_cookie_strategy_before)
-      klass.should_receive(:after_filter).with(:flip_cookie_strategy_after)
+      klass.should_receive(:before_action).with(:flip_cookie_strategy_before)
+      klass.should_receive(:after_action).with(:flip_cookie_strategy_after)
       klass.send :include, Flip::CookieStrategy::Loader
     end
   end

data/spec/database_strategy_spec.rb

@@ -5,19 +5,39 @@ describe Flip::DatabaseStrategy do
   let(:definition) { double("definition", key: "one") }
   let(:strategy) { Flip::DatabaseStrategy.new(model_klass) }
   let(:model_klass) do
+    class Sample
+      attr_accessor :key
+
+      def enabled?
+        true
+      end
+    end
+
     Class.new do
+      extend Flip::Cacheable
       extend Flip::Declarable
       feature :one
       feature :two, description: "Second one."
       feature :three, default: true
+
+      def self.all
+        list = []
+        keys = ['one', 'two', 'three']
+        3.times do |i|
+          list << Sample.new
+          list.last.key = keys[i]
+        end
+        list
+      end
     end
   end
+
   let(:enabled_record) { model_klass.new.tap { |m| m.stub(:enabled?) { true } } }
   let(:disabled_record) { model_klass.new.tap { |m| m.stub(:enabled?) { false } } }
 
   subject { strategy }
 
-  its(:switchable?) { should be_true }
+  its(:switchable?) { should be true }
   its(:description) { should be_present }
 
   let(:db_result) { [] }
@@ -39,6 +59,16 @@ describe Flip::DatabaseStrategy do
     end
   end
 
+  describe "#on? with feature cache" do
+    before { model_klass.start_feature_cache }
+    context "for an enabled record" do
+      let(:db_result) { [enabled_record] }
+      it "returns true" do
+        expect(strategy.on?(definition)).to eq(true)
+      end
+    end
+  end
+
   describe "#on?" do
     context "for an enabled record" do
       let(:db_result) { [enabled_record] }

data/spec/declaration_strategy_spec.rb

@@ -8,16 +8,16 @@ describe Flip::DeclarationStrategy do
 
   describe "#knows?" do
     it "does not know definition with no default specified" do
-      subject.knows?(Flip::Definition.new :feature).should be_false
+      subject.knows?(Flip::Definition.new :feature).should be false
     end
     it "does not know definition with default of nil" do
-      subject.knows?(definition(nil)).should be_false
+      subject.knows?(definition(nil)).should be false
     end
     it "knows definition with default set to true" do
-      subject.knows?(definition(true)).should be_true
+      subject.knows?(definition(true)).should be true
     end
     it "knows definition with default set to false" do
-      subject.knows?(definition(false)).should be_true
+      subject.knows?(definition(false)).should be true
     end
   end
 

data/spec/feature_set_spec.rb

@@ -41,26 +41,26 @@ describe Flip::FeatureSet do
   describe "#default= and #on? with null strategy" do
     subject { feature_set_with_null_strategy }
     it "defaults to false" do
-      subject.on?(:feature).should be_false
+      subject.on?(:feature).should be false
     end
     it "can default to true" do
       subject.default = true
-      subject.on?(:feature).should be_true
+      subject.on?(:feature).should be true
     end
     it "accepts a proc returning true" do
       subject.default = proc { true }
-      subject.on?(:feature).should be_true
+      subject.on?(:feature).should be true
     end
     it "accepts a proc returning false" do
       subject.default = proc { false }
-      subject.on?(:feature).should be_false
+      subject.on?(:feature).should be false
     end
   end
 
   describe "feature set with null strategy then always-true strategy" do
     subject { feature_set_with_null_then_true_strategies }
     it "returns true due to second strategy" do
-      subject.on?(:feature).should be_true
+      subject.on?(:feature).should be true
     end
   end
 

data/spec/flip_spec.rb

@@ -18,16 +18,16 @@ describe Flip do
 
   describe ".on?" do
     it "returns true for enabled features" do
-      Flip.on?(:one).should be_true
+      Flip.on?(:one).should be true
     end
     it "returns false for disabled features" do
-      Flip.on?(:two).should be_false
+      Flip.on?(:two).should be false
     end
   end
 
   describe "dynamic predicate methods" do
-    its(:one?) { should be_true }
-    its(:two?) { should be_false }
+    its(:one?) { should be true }
+    its(:two?) { should be false }
   end
 
 end

data/spec/spec_helper.rb

@@ -1 +1,2 @@
-require "flip"
+require 'flip'
+require 'rspec/its'

metadata

@@ -1,75 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: flip
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Annesley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-19 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Declarative API for specifying features, switchable in declaration, database
@@ -80,9 +94,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - README.md
 - Rakefile
@@ -96,6 +110,7 @@ files:
 - flip.gemspec
 - lib/flip.rb
 - lib/flip/abstract_strategy.rb
+- lib/flip/cacheable.rb
 - lib/flip/controller_filters.rb
 - lib/flip/cookie_strategy.rb
 - lib/flip/database_strategy.rb
@@ -117,6 +132,7 @@ files:
 - lib/generators/flip/routes/USAGE
 - lib/generators/flip/routes/routes_generator.rb
 - spec/abstract_strategy_spec.rb
+- spec/cacheable_spec.rb
 - spec/controller_filters_spec.rb
 - spec/cookie_strategy_spec.rb
 - spec/database_strategy_spec.rb
@@ -136,22 +152,23 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: A feature flipper for Rails web applications.
 test_files:
 - spec/abstract_strategy_spec.rb
+- spec/cacheable_spec.rb
 - spec/controller_filters_spec.rb
 - spec/cookie_strategy_spec.rb
 - spec/database_strategy_spec.rb