flipflop 2.0.0 → 2.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Mjk5MWNkOGUyOGViMGIxOTJmZmY0NTc5NjU3Yjk3NjM0NWIyNDE1ZA==
+    YWY3YjRjMGU0YmZlNDljMWM5YTNjYTllZmQ3MDljZTU2NDE0NTVkZA==
   data.tar.gz: !binary |-
-    NjRiOGU3YTg3ZDAyYmMxM2RmZmEzZDcyOTBlZTNjZmRlMWI4YTdiNA==
+    MjUzZTE3MjY4MDFmY2MxZjE0YWIwZmViYTk4NjNkZjUwMTlkYTE3NA==
 SHA512:
   metadata.gz: !binary |-
-    YTRkOTdlMjAyMzVjYjdjOWJlMDkxOWYxZmYwMmUzMDMxYmE3YjcyNmI5ZWZk
-    MWMxYjY1ZTU2MTBiOWYxMDNlOGI0MDE2Y2RmYWQ3ZTZiMTUzNjE5ZDA2NmEw
-    YTViYjdmNzNkNTljZWFiMTUwOWZmNDhhMDgzYThiNGJmMTdlM2I=
+    ZTE1ZWM5ODgzZDM5NTA1MTllZGEyYTg3OWViYzAzOGE4YmZhMjFmYzg1NTZh
+    ZTkwOWQ0ODhhMzE3ZTI0YzIxMWQyYjI1MmFhN2ZjZWZmYjZhYmVhZGE5N2Mx
+    YWQzYWVkMzRkMTkxNTg1ODVhZDJmZGIzMWI3ODc0YmFjNjU2NTE=
   data.tar.gz: !binary |-
-    MTllZjMwYjA5YWZmMzVjNGM3YjRmMGE0Mjk0NTg3MGY4NmY2MTgwNjcxOWVk
-    NzE3NzllOWQwZDgzN2FkYjg2YThiMThlMDI4ZGMzODk5ZjFiYTIzYzQ3MGU5
-    NDU0OTcxYjdjYzJkZWIwNTI5OTdkOWIxMGRjYmJkZDVmYmM4OTI=
+    ZWI4YTJhZTg5ZWQ4NWI0ZDRmNWU4MDVmYTc2MzYyN2NmZjA3Mjg5YjVmNGE0
+    Nzg3YWJiMDY0MjBmMjljNjIyZDAzYzhlZmQwY2E2NTAxZDVlODJmNTMwZTY1
+    MGJlNzVlYTE3ZmE1ZDc3MjhkY2E0ZGQ1YjgyNWRjY2MzMjgzOWI=

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+*.css
 .bundle
 Gemfile.lock
 pkg/*

data/.travis.yml

@@ -40,6 +40,7 @@ notifications:
   email: false
   slack:
     secure: crOO1QGnFn9T1DpVgxkukTSiN8lQq09X8WF8oi1Eoa7Liex4gzWq7f8wlIXPrRFAsNjU47fSrz+L1C6Eg068Vd2df9pkqjW0pLNeqUViJ35TzpYISTtzJrX+x3nvCQLlvS4leP6lkijlsvlu1IN0xnXadW5cmcMoEcPo4Yma1RUklwlreSRIEmJiutYKVFRw3gIZA9vsnXNEcD408mvSY/8Kuw+hmRQupODUalXDpZo1q3HH+ZPQq+/rGuJ7XRf9sBtxjpUF0G4FJZQhVP4CrLNYVBE/83rHJ6HSf6u3SlYVIMiautq0nWpVLPHUrkOPJVeVh6EPtoFeI/cehH1NyoAVvL5a39wFRBlJ4jVPWUrrnihJT/6+P6GM9PSnYogxtIoTsdrYES2FgtWGgwG5uLyw8U6bW7G7rCzQwBP7enVHWVCbDgdSSjE1Mg1I9qhRuL6pHs5des4VKk6pfD3p+BRqLmOZR2jx4v8MFwakSFqQWOMxaD0U1lfxecqSx9OkwWEhCFSnHeXeHInEhY6qKCdZZzT+beYn0xppUMPJGMTqe5+po8gL+5MxQwI8Xs/5hSve5frfmuS7UQf5BnFMOzwoThQrXCFRz58wXvcZTD9eTdVBV44Hsi5OLdYn9K58sNUhgcxGfRgdE7Gy9P7DD4fHPGakD/Tz++HuCmCUXNs=
+before_deploy: rake assets:compile
 deploy:
   provider: rubygems
   api_key:

data/Gemfile

@@ -1,6 +1,10 @@
 source "https://rubygems.org"
 gemspec
 
+if ENV["CONTINUOUS_INTEGRATION"]
+  gem "bootstrap", "= 4.0.0.alpha3"
+end
+
 group :test do
   version = ENV["RAILS_VERSION"] || "master"
   if version == "master"

data/README.md

@@ -75,12 +75,15 @@ The following strategies are provided:
 * `:active_record` – Save feature settings in the database.
     * `:class` – Provide the feature model. `Flipflop::Feature` by default (which uses the table `features`). Honors `default_scope` when features are resolved or switched on/off.
 * `:cookie` – Save feature settings in browser cookies for the current user.
+    * `:prefix` – String prefix for all cookie names. Defaults to no prefix.
     * `:path` – The path for which the cookies apply. Defaults to the root of the application.
     * `:domain` – Cookie domain. Is `nil` by default (no specific domain). Can be `:all` to use the topmost domain. Can be an array of domains.
     * `:secure` – Only set cookies if the connection is secured with TLS. Default is `false`.
     * `:httponly` – Whether the cookies are accessible via scripting or only HTTP. Default is `false`.
 * `:query_string` – Interpret query string parameters as features. This strategy is only used for resolving. It does not allow switching features on/off.
+    * `:prefix` – String prefix for all query string parameters. Defaults to no prefix.
 * `:session` – Save feature settings in the current user's application session.
+    * `:prefix` – String prefix for all session variables. Defaults to no prefix.
 * `:default` – Not strictly needed, all feature defaults will be applied if no strategies match a feature. Include this strategy to determine the order of using the default value, and to make it appear in the dashboard.
 
 All strategies support these options, to change the appearance of the dashboard:

data/Rakefile

@@ -1,16 +1,39 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-Rake::TestTask.new("test") do |test|
+Rake::TestTask.new("test" => "assets:compile") do |test|
   test.pattern = "test/**/*_test.rb"
 end
 
-Rake::TestTask.new("test:unit") do |test|
+Rake::TestTask.new("test:unit" => "assets:compile") do |test|
   test.pattern = "test/unit/**/*_test.rb"
 end
 
-Rake::TestTask.new("test:integration") do |test|
+Rake::TestTask.new("test:integration" => "assets:compile") do |test|
   test.pattern = "test/integration/**/*_test.rb"
 end
 
 task default: :test
+
+namespace :assets do
+  stylesheets_path = "app/assets/stylesheets"
+  stylesheet_file = "flipflop.css"
+  stylesheet_path = stylesheets_path + "/" + stylesheet_file
+
+  task :compile do
+    require "bundler/setup"
+    require "flipflop"
+    require "sprockets"
+    require "bootstrap"
+
+    environment = Sprockets::Environment.new
+    environment.append_path stylesheets_path
+    environment.append_path Bootstrap.stylesheets_path
+    environment.css_compressor = :scss
+    File.write(stylesheet_path, environment[stylesheet_file])
+  end
+
+  task :clean do
+    FileUtils.rm(stylesheet_path)
+  end
+end

data/app/controllers/flipflop/features_controller.rb

@@ -1,5 +1,3 @@
-require "bootstrap"
-
 module Flipflop
   class FeaturesController < ApplicationController
     include EnvironmentFilters

data/app/models/flipflop/feature.rb

@@ -1,3 +1,2 @@
 class Flipflop::Feature < ActiveRecord::Base
-  self.table_name = "features"
 end

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

@@ -30,13 +30,13 @@
                   <%= submit_tag "on",
                     type: "submit",
                     class: @feature_set.strategy_status(strategy, feature) == "on" ? "active" : nil,
-                    disabled: strategy.switchable? ? false : true
+                    disabled: !strategy.switchable?
                   -%>
 
                   <%= submit_tag "off",
                     type: "submit",
                     class: @feature_set.strategy_status(strategy, feature) == "off" ? "active" : nil,
-                    disabled: strategy.switchable? ? false : true
+                    disabled: !strategy.switchable?
                   -%>
                 </div>
               <% end -%>

data/flipflop.gemspec

@@ -13,11 +13,14 @@ Gem::Specification.new do |s|
   s.description = %q{Declarative API for specifying features, switchable in declaration, database and cookies.}
   s.license  = "MIT"
 
+  s.add_dependency("activesupport", ">= 4.0")
+if ENV["CONTINUOUS_INTEGRATION"]
+  s.files         = `git ls-files`.split("\n").map { |f| f.sub(".scss", ".css") }
+else
+  s.add_dependency("bootstrap", "= 4.0.0.alpha3")
   s.files         = `git ls-files`.split("\n")
+end
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-
-  s.add_dependency("activesupport", ">= 4.0")
-  s.add_dependency("bootstrap", "~> 4.0.0.alpha3")
 end

data/lib/flipflop/engine.rb

@@ -1,5 +1,7 @@
 module Flipflop
   class Engine < ::Rails::Engine
+    attr_accessor :rake_task_executing
+
     isolate_namespace Flipflop
 
     config.app_middleware.insert_after ActionDispatch::Callbacks,
@@ -23,16 +25,12 @@ module Flipflop
     end
 
     initializer "flipflop.dashboard", after: "flipflop.features_reloader" do |app|
+      next if rake_task_executing
       if actions = config.flipflop.dashboard_access_filter
         to_prepare do
           Flipflop::FeaturesController.before_action(*actions)
           Flipflop::StrategiesController.before_action(*actions)
         end
-      else
-        unless defined?(Rails::Generators) or defined?(Rake)
-          warn("WARNING: You have not set `config.flipflop.dashboard_access_filter`; " +
-               "the Flipflop dashboard is now always public!")
-        end
       end
     end
 
@@ -41,6 +39,12 @@ module Flipflop
       ActionController::Base.send(:include, interceptor)
     end
 
+    def run_tasks_blocks(app)
+      # Skip initialization if we're in a rake task.
+      self.rake_task_executing = true
+      super
+    end
+
     private
 
     def feature_reloader(app)

data/lib/flipflop/strategies/cookie_strategy.rb

@@ -10,6 +10,7 @@ module Flipflop
       def initialize(**options)
         # TODO: Support :expires as a runtime-evaluated option?
         @options = options.extract!(:path, :domain, :secure, :httponly).freeze
+        @prefix = options.delete(:prefix).to_s.freeze
         super(**options)
       end
 
@@ -19,25 +20,25 @@ module Flipflop
 
       def enabled?(feature)
         return unless request?
-        return unless request.cookie_jar.has_key?(cookie_name(feature))
-        cookie = request.cookie_jar[cookie_name(feature)]
+        return unless request.cookie_jar.has_key?(cookie_key(feature))
+        cookie = request.cookie_jar[cookie_key(feature)]
         cookie_value = cookie.is_a?(Hash) ? cookie["value"] : cookie
         cookie_value === "1"
       end
 
       def switch!(feature, enabled)
         value = @options.merge(value: enabled ? "1" : "0")
-        request.cookie_jar[cookie_name(feature)] = value
+        request.cookie_jar[cookie_key(feature)] = value
       end
 
       def clear!(feature)
-        request.cookie_jar.delete(cookie_name(feature), **@options)
+        request.cookie_jar.delete(cookie_key(feature), **@options)
       end
 
       protected
 
-      def cookie_name(feature)
-        :"flipflop_#{feature}"
+      def cookie_key(feature)
+        @prefix + feature.to_s
       end
     end
   end

data/lib/flipflop/strategies/query_string_strategy.rb

@@ -7,10 +7,21 @@ module Flipflop
         end
       end
 
+      def initialize(**options)
+        @prefix = options.delete(:prefix).to_s.freeze
+        super(**options)
+      end
+
       def enabled?(feature)
         return unless request?
-        return unless request.params.has_key?(feature)
-        request.params[feature].to_s != "0"
+        return unless request.params.has_key?(param_key(feature))
+        request.params[param_key(feature)].to_s != "0"
+      end
+
+      protected
+
+      def param_key(feature)
+        @prefix + feature.to_s
       end
     end
   end

data/lib/flipflop/strategies/session_strategy.rb

@@ -7,22 +7,33 @@ module Flipflop
         end
       end
 
+      def initialize(**options)
+        @prefix = options.delete(:prefix).to_s.freeze
+        super(**options)
+      end
+
       def switchable?
         request?
       end
 
       def enabled?(feature)
         return unless request?
-        return unless request.session.has_key?(feature)
-        request.session[feature]
+        return unless request.session.has_key?(variable_key(feature))
+        request.session[variable_key(feature)] == true
       end
 
       def switch!(feature, enabled)
-        request.session[feature] = enabled
+        request.session[variable_key(feature)] = enabled
       end
 
       def clear!(feature)
-        request.session.delete(feature)
+        request.session.delete(variable_key(feature))
+      end
+
+      protected
+
+      def variable_key(feature)
+        @prefix + feature.to_s
       end
     end
   end

data/lib/flipflop/version.rb

@@ -1,3 +1,3 @@
 module Flipflop
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

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

@@ -1,6 +1,6 @@
 class CreateFeatures < ActiveRecord::Migration<%= Rails.version >= "5" ? "[#{ActiveRecord::Migration.current_version}]" : "" %>
   def change
-    create_table :features do |t|
+    create_table :flipflop_features do |t|
       t.string :key, null: false
       t.boolean :enabled, null: false, default: false
 

data/test/integration/app_test.rb

@@ -9,6 +9,10 @@ describe Flipflop do
     @app
   end
 
+  after do
+    Flipflop::Strategies::AbstractStrategy::RequestInterceptor.request = nil
+  end
+
   describe "middleware" do
     it "should include cache middleware" do
       middlewares = Rails.application.middleware.map(&:klass)

data/test/integration/dashboard_test.rb

@@ -13,6 +13,10 @@ describe Flipflop do
     @app
   end
 
+  after do
+    Flipflop::Strategies::AbstractStrategy::RequestInterceptor.request = nil
+  end
+
   describe "outside development and test" do
     before do
       Rails.env.stub(:test?, false) do

data/test/unit/strategies/cookie_strategy_test.rb

@@ -33,7 +33,7 @@ describe Flipflop::Strategies::CookieStrategy do
 
     describe "with enabled feature" do
       before do
-        subject.send(:request).cookie_jar[subject.send(:cookie_name, :one)] = "1"
+        subject.send(:request).cookie_jar["one"] = "1"
       end
 
       it "should have feature enabled" do
@@ -53,7 +53,7 @@ describe Flipflop::Strategies::CookieStrategy do
 
     describe "with disabled feature" do
       before do
-        subject.send(:request).cookie_jar[subject.send(:cookie_name, :two)] = "0"
+        subject.send(:request).cookie_jar["two"] = "0"
       end
 
       it "should not have feature enabled" do
@@ -88,13 +88,19 @@ describe Flipflop::Strategies::CookieStrategy do
           domain: :all,
           path: "/foo",
           httponly: true,
+          prefix: :my_cookie_,
         ).freeze
       end
 
+      it "should use prefix to resolve parameters" do
+        subject.send(:request).cookie_jar["my_cookie_one"] = "1"
+        assert_equal true, subject.enabled?(:one)
+      end
+
       it "should pass options when setting value" do
         subject.switch!(:one, true)
         subject.send(:request).cookie_jar.write(headers = {})
-        assert_equal "flipflop_one=1; domain=.example.com; path=/foo; HttpOnly",
+        assert_equal "my_cookie_one=1; domain=.example.com; path=/foo; HttpOnly",
           headers["Set-Cookie"]
       end
 
@@ -102,7 +108,7 @@ describe Flipflop::Strategies::CookieStrategy do
         subject.switch!(:one, true)
         subject.clear!(:one)
         subject.send(:request).cookie_jar.write(headers = {})
-        assert_equal "flipflop_one=; domain=.example.com; path=/foo; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000; HttpOnly",
+        assert_equal "my_cookie_one=; domain=.example.com; path=/foo; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 -0000; HttpOnly",
           headers["Set-Cookie"]
       end
     end

data/test/unit/strategies/query_string_strategy_test.rb

@@ -56,6 +56,22 @@ describe Flipflop::Strategies::QueryStringStrategy do
         assert_nil subject.enabled?(:three)
       end
     end
+
+    describe "with options" do
+      subject do
+        Flipflop::Strategies::QueryStringStrategy.new(
+          prefix: :my_feature_,
+        ).freeze
+      end
+
+      before do
+        subject.send(:request).params[:my_feature_one] = "1"
+      end
+
+      it "should use prefix to resolve parameters" do
+        assert_equal true, subject.enabled?(:one)
+      end
+    end
   end
 
   describe "outside request context" do

data/test/unit/strategies/session_strategy_test.rb

@@ -33,7 +33,7 @@ describe Flipflop::Strategies::SessionStrategy do
 
     describe "with enabled feature" do
       before do
-        subject.send(:request).session[:one] = true
+        subject.send(:request).session["one"] = true
       end
 
       it "should have feature enabled" do
@@ -53,7 +53,7 @@ describe Flipflop::Strategies::SessionStrategy do
 
     describe "with disabled feature" do
       before do
-        subject.send(:request).session[:two] = false
+        subject.send(:request).session["two"] = false
       end
 
       it "should not have feature enabled" do
@@ -81,6 +81,22 @@ describe Flipflop::Strategies::SessionStrategy do
         assert_equal true, subject.enabled?(:three)
       end
     end
+
+    describe "with options" do
+      subject do
+        Flipflop::Strategies::SessionStrategy.new(
+          prefix: :my_feature_,
+        ).freeze
+      end
+
+      before do
+        subject.send(:request).session["my_feature_one"] = true
+      end
+
+      it "should use prefix to resolve parameters" do
+        assert_equal true, subject.enabled?(:one)
+      end
+    end
   end
 
   describe "outside request context" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flipflop
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Paul Annesley
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,20 +26,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: bootstrap
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 4.0.0.alpha3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 4.0.0.alpha3
 description: Declarative API for specifying features, switchable in declaration, database
   and cookies.
 email:
@@ -56,7 +42,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- app/assets/stylesheets/flipflop.scss
+- app/assets/stylesheets/flipflop.css
 - app/controllers/concerns/flipflop/environment_filters.rb
 - app/controllers/flipflop/features_controller.rb
 - app/controllers/flipflop/strategies_controller.rb

data/app/assets/stylesheets/flipflop.scss

@@ -1,109 +0,0 @@
-$enable-transitions: true;
-@import "bootstrap";
-
-section.flipflop {
-  @extend .container-fluid;
-  margin: 5rem 0 0;
-
-  table {
-    @extend .table;
-    @extend .table-striped;
-
-    thead {
-      @extend .thead-inverse;
-
-      th {
-        position: relative;
-        cursor: default;
-
-        &[data-tooltip]:before, &[data-tooltip]:after {
-          @include transition(all 0.2s ease-out);
-          transform: translateY(0.2rem) translateZ(0);
-          opacity: 0;
-
-          display: block;
-          position: absolute;
-        }
-
-        &[data-tooltip]:before {
-          content: attr(data-tooltip);
-          width: 98%;
-          left: 0;
-          bottom: 3.75rem;
-          margin: 0;
-          padding: 0.5rem 0.75rem;
-          background: $gray;
-          border-radius: 0.2rem;
-          font-size: 0.875rem;
-          font-weight: normal;
-          pointer-events: none;
-        }
-
-        &[data-tooltip]:after {
-          content: " ";
-          width: 0;
-          height: 0;
-          left: 1rem;
-          bottom: 3.25rem;
-          border-left: solid transparent 0.5rem;
-          border-right: solid transparent 0.5rem;
-          border-top: solid $gray 0.5rem;
-        }
-
-        &:hover {
-          &[data-tooltip]:before, &[data-tooltip]:after {
-            transform: translateY(0) translateZ(0);
-            opacity: 1;
-          }
-        }
-      }
-    }
-
-    tbody {
-      td.status {
-        width: 2rem;
-        font-size: 1.1rem;
-
-        span {
-          width: 2rem;
-          @extend .label;
-          @extend .label-pill;
-          &.on { @extend .label-success; }
-          &.off { @extend .label-default; }
-        }
-      }
-
-      td.name {
-        min-width: 11rem;
-        padding-top: 0.9rem;
-        font-weight: bold;
-      }
-
-      td.description {
-        min-width: 11rem;
-        padding-top: 0.9rem;
-      }
-
-      td.toggle {
-        min-width: 11rem;
-
-        div.toolbar {
-          @extend .btn-toolbar;
-          margin-left: 0;
-
-          div.group {
-            @extend .btn-group;
-            @extend .btn-group-sm;
-
-            input[type=submit] {
-              @extend .btn;
-              @extend .btn-sm;
-              &.active { @extend .btn-primary; }
-              &:not(.active) { @extend .btn-secondary; }
-            }
-          }
-        }
-      }
-    }
-  }
-}