flipflop 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 79ce3ddc4c05be4f6b655519b73fc592b749177a
-  data.tar.gz: 9de114a7fa334e5689d9bb49e6b2c0e0189b59b4
+SHA256:
+  metadata.gz: 2d991f9cd5e93e4a837c0e6835da5ae2339498bf74a26fc6e21cee4503793ca6
+  data.tar.gz: 943ba8e6ea38bf2afbc45454890f8111a3b9029383018e5ddf3a76f8faac0732
 SHA512:
-  metadata.gz: d89175f3cdf7c36f31fa22ec6b3174bf3d69399ec2ad58d1c1c68bbb5e239456b85c3386144414e5e40ce87d4c504f49cdbc54293aa5b9659dedcba237b94e9c
-  data.tar.gz: d5a233ec2f53cdfb4d1aacd6afda3b385618887cfb524a6f7fc6de5eb0ad2ad05b949080a34e8e48eab5f4c18fd6dae571affee63ca576533ebf6277f153360c
+  metadata.gz: a81cbf3b37f9d91ec310bc971eec5c06b2d4b0581bd42191366503782bb8d95ef6b51fef33588bd28ec571a57ebc03f51cd1c5f9514ac8151f1a855e4072e085
+  data.tar.gz: 30a184287b36b7a346cc72fb0bf4f2ed4cb59083461f3859d70d1ec9908c37b3c1b65e54dc3536ed472fed85f94465ea191c6d4eeb7b049679b4056cb3585b05

data/.travis.yml

@@ -1,38 +1,49 @@
 language: ruby
+cache: bundler
 rvm:
-- 2.4.0
-- 2.3.0
-- jruby-9.1.2.0
+- 2.5.0
+- 2.4.2
+- 2.3.5
+- jruby-9.1.13.0
 - ruby-head
 - jruby-head
 env:
 - RAILS_VERSION=master
 - RAILS_VERSION=master RAILS_API_ONLY=1
+- RAILS_VERSION=5.2
+- RAILS_VERSION=5.2 RAILS_API_ONLY=1
+- RAILS_VERSION=5.1
+- RAILS_VERSION=5.1 RAILS_API_ONLY=1
 - RAILS_VERSION=5.0
 - RAILS_VERSION=5.0 RAILS_API_ONLY=1
 matrix:
   include:
-  - rvm: 2.3.0
+  - rvm: 2.3.5
     env: RAILS_VERSION=4.2
-  - rvm: 2.2.6
+  - rvm: 2.2.8
     env: RAILS_VERSION=4.2
-  - rvm: 2.1.9
+  - rvm: 2.1.10
     env: RAILS_VERSION=4.2
   - rvm: 2.0.0
     env: RAILS_VERSION=4.2
-  - rvm: 2.3.0
+  - rvm: 2.3.5
     env: RAILS_VERSION=4.1
-  - rvm: 2.2.6
+  - rvm: 2.2.8
     env: RAILS_VERSION=4.1
-  - rvm: 2.1.9
+  - rvm: 2.1.10
     env: RAILS_VERSION=4.1
   - rvm: 2.0.0
     env: RAILS_VERSION=4.1
+  exclude:
+  - rvm: 2.3.5
+    env: RAILS_VERSION=master
+  - rvm: 2.3.5
+    env: RAILS_VERSION=master RAILS_API_ONLY=1
   allow_failures:
-  - rvm: jruby-9.1.2.0
+  - rvm: jruby-9.1.13.0
   - rvm: ruby-head
   - rvm: jruby-head
-before_deploy: rake assets:compile
+before_deploy: bundle exec rake assets:compile
 deploy:
   provider: rubygems
   api_key:
@@ -41,4 +52,4 @@ deploy:
   on:
     tags: true
     repo: voormedia/flipflop
-    ruby: 2.3.0
+    ruby: 2.3.5

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 2.4.0
+
+* Add location of feature definition.
+* Raise error for undefined feature or strategy keys. This change can potentially break test cases that use dummy keys.
+
 ## 2.3.1
 
 * Fixed backwards compatibility of strategies controller. The incompatibility was introduced in 2.3.0. (@jcoyne)

data/Gemfile

@@ -15,7 +15,7 @@ group :test do
   gem "fakeredis", require: false
   gem "sqlite3", ">= 1.3", platform: :ruby
   gem "activerecord-jdbcsqlite3-adapter", platform: :jruby,
-    github: "jruby/activerecord-jdbc-adapter", branch: "rails-5"
+    github: "jruby/activerecord-jdbc-adapter"
 
   gem "minitest", ">= 4.2"
   gem "capybara", ">= 2.6"

data/README.md

@@ -78,6 +78,11 @@ end
 This file is automatically reloaded in development mode. No need to restart
 your server after making changes.
 
+Feature definitions support these options:
+* `:default` – The feature's default value. This is the value of the feature if no strategy configures an explicit value. Defaults to `false`.
+* `:description` – An optional description of the feature. Displayed on the dashboard if present.
+* `:title` – An optional title of the feature. This defaults to a humanized version of the feature name. Displayed on the dashboard.
+
 ## Strategies
 
 The following strategies are provided:

data/app/controllers/flipflop/strategies_controller.rb

@@ -3,12 +3,12 @@ module Flipflop
     include ActionController::RequestForgeryProtection
 
     def update
-      strategy.switch!(feature_key, enable?)
+      FeatureSet.current.switch!(feature_key, strategy_key, enable?)
       redirect_to(features_url)
     end
 
     def destroy
-      strategy.clear!(feature_key)
+      FeatureSet.current.clear!(feature_key, strategy_key)
       redirect_to(features_url)
     end
 
@@ -27,8 +27,8 @@ module Flipflop
       params[:feature_id].to_sym
     end
 
-    def strategy
-      FeatureSet.current.strategy(params[:id])
+    def strategy_key
+      params[:id]
     end
   end
 end

data/lib/flipflop/feature_definition.rb

@@ -1,14 +1,19 @@
 module Flipflop
   class FeatureDefinition
-    attr_reader :key, :name, :title, :description, :default, :group
+    attr_reader :key, :name, :title, :description, :default, :group, :location
 
     def initialize(key, **options)
       @key = key
       @name = @key.to_s.freeze
-      @title = @name.humanize.freeze
+      @title = options.delete(:title).freeze || @name.humanize.freeze
       @description = options.delete(:description).freeze
       @default = !!options.delete(:default) || false
       @group = options.delete(:group).freeze
+      @location = caller_locations(3, 1).first.freeze
+
+      if options.any?
+        raise FeatureError.new(name, "has unknown option #{options.keys.map(&:inspect) * ', '}")
+      end
     end
   end
 end

data/lib/flipflop/feature_set.rb

@@ -1,13 +1,19 @@
 module Flipflop
   class FeatureError < StandardError
-    def initialize(feature, error)
-      super("Feature '#{feature}' #{error}.")
+    def initialize(key, error)
+      super("Feature '#{key}' #{error}.")
     end
   end
 
   class StrategyError < StandardError
-    def initialize(strategy, error)
-      super("Strategy '#{strategy}' #{error}.")
+    def initialize(key, error)
+      super("Strategy '#{key}' #{error}.")
+    end
+  end
+
+  class Callback < StandardError
+    def initialize(key, error)
+      super("Callback '#{key}' #{error}.")
     end
   end
 
@@ -70,19 +76,22 @@ module Flipflop
       end
     end
 
-    def enabled?(feature)
-      FeatureCache.current.fetch(feature) do
+    def enabled?(feature_key)
+      FeatureCache.current.fetch(feature_key) do
+        feature = feature(feature_key)
+
         result = @strategies.each_value.inject(nil) do |status, strategy|
           break status unless status.nil?
-          strategy.enabled?(feature)
+          strategy.enabled?(feature_key)
         end
-        result.nil? ? feature(feature).default : result
+
+        result.nil? ? feature.default : result
       end
     end
 
-    def feature(feature)
-      @features.fetch(feature) do
-        raise FeatureError.new(feature, "unknown")
+    def feature(feature_key)
+      @features.fetch(feature_key) do
+        raise FeatureError.new(feature_key, "unknown")
       end
     end
 
@@ -90,14 +99,28 @@ module Flipflop
       @features.values
     end
 
-    def strategy(strategy)
-      @strategies.fetch(strategy) do
-        raise StrategyError.new(strategy, "unknown")
+    def strategy(strategy_key)
+      @strategies.fetch(strategy_key) do
+        raise StrategyError.new(strategy_key, "unknown")
       end
     end
 
     def strategies
       @strategies.values
     end
+
+    def switch!(feature_key, strategy_key, value)
+      strategy = strategy(strategy_key)
+      feature = feature(feature_key)
+
+      strategy.switch!(feature.key, value)
+    end
+
+    def clear!(feature_key, strategy_key)
+      strategy = strategy(strategy_key)
+      feature = feature(feature_key)
+
+      strategy.clear!(feature.key)
+    end
   end
 end

data/lib/flipflop/version.rb

@@ -1,3 +1,3 @@
 module Flipflop
-  VERSION = "2.3.1"
+  VERSION = "2.4.0"
 end

data/lib/generators/flipflop/install/install_generator.rb

@@ -10,26 +10,27 @@ class Flipflop::InstallGenerator < Rails::Generators::Base
   end
 
   def configure_dashboard
-    comment = <<-RUBY
-# Replace with a lambda or method name defined in ApplicationController
-# to implement access control for the Flipflop dashboard.
-RUBY
-
-    forbidden = <<-RUBY
-config.flipflop.dashboard_access_filter = -> { head :forbidden }
-RUBY
-
-    allowed = <<-RUBY
-config.flipflop.dashboard_access_filter = nil
-RUBY
+    app = tmpl("-> { head :forbidden }")
+    env_dev_test = tmpl("nil")
 
-    environment(indent(comment + forbidden + "\n", 4).lstrip)
-    environment(indent(comment + allowed + "\n", 2).lstrip, env: [:development, :test])
+    environment(indent(app + "\n", 4).lstrip)
+    environment(indent(env_dev_test + "\n", 2).lstrip, env: [:development, :test])
   end
 
   private
 
+  def tmpl(access_filter)
+    return <<-RUBY
+# Before filter for Flipflop dashboard. Replace with a lambda or method name
+# defined in ApplicationController to implement access control.
+config.flipflop.dashboard_access_filter = #{access_filter}
+RUBY
+  end
+
   def indent(content, multiplier = 2)
+    # Don't fix indentation if Rails already does this (5.2+).
+    return content if respond_to?(:optimize_indentation, true)
+
     spaces = " " * multiplier
     content.each_line.map {|line| line.blank? ? line : "#{spaces}#{line}" }.join
   end

data/test/integration/app_test.rb

@@ -14,6 +14,23 @@ describe Flipflop do
       @app
     end
 
+    describe "configuration" do
+      it "should be added to dev" do
+        assert_match %r{^  config\.flipflop\.dashboard_access_filter = nil$},
+          File.read("config/environments/development.rb")
+      end
+
+      it "should be added to test" do
+        assert_match %r{^  config\.flipflop\.dashboard_access_filter = nil$},
+          File.read("config/environments/test.rb")
+      end
+
+      it "should be added to app" do
+        assert_match %r{^    config\.flipflop\.dashboard_access_filter = -> \{ head :forbidden \}$},
+          File.read("config/application.rb")
+      end
+    end
+
     describe "middleware" do
       it "should include cache middleware" do
         middlewares = Rails.application.middleware.map(&:klass)

data/test/test_helper.rb

@@ -110,6 +110,10 @@ class TestApp
       skip_turbolinks: true,
     ).invoke_all
 
+    # Remove bootsnap if present, this interferes with reloading apps.
+    boot_path = File.expand_path("../../" + path + "/config/boot.rb", __FILE__)
+    File.write(boot_path, File.read(boot_path).gsub("require 'bootsnap/setup'", ""))
+
     Flipflop::InstallGenerator.new([],
       quiet: true,
     ).invoke_all
@@ -141,7 +145,13 @@ class TestApp
 
     silence_stdout { ActiveRecord::Tasks::DatabaseTasks.create_current }
     ActiveRecord::Migration.verbose = false
-    ActiveRecord::Migrator.migrate(Rails.application.paths["db/migrate"].to_a)
+
+    if defined?(ActiveRecord::Migrator.migrate)
+      ActiveRecord::Migrator.migrate(Rails.application.paths["db/migrate"].to_a)
+    else
+      # Rails 5.2+
+      ActiveRecord::MigrationContext.new(Rails.application.paths["db/migrate"]).migrate
+    end
   end
 
   def unload!

data/test/unit/feature_definition_test.rb

@@ -29,6 +29,11 @@ describe Flipflop::FeatureDefinition do
     it "should have no group" do
       assert_nil subject.group
     end
+
+    it "should have location" do
+      # Because we have no indirection via FeatureSet, the location is minitest.
+      assert_equal "instance_eval", subject.location.label
+    end
   end
 
   describe "with options" do
@@ -63,5 +68,26 @@ describe Flipflop::FeatureDefinition do
     it "should have specified group" do
       assert_equal :my_group, subject.group.key
     end
+
+    it "should have location" do
+      # Because we have no indirection via FeatureSet, the location is minitest.
+      assert_equal "instance_eval", subject.location.label
+    end
+  end
+
+  describe "with unknown options" do
+    subject do
+      Flipflop::FeatureDefinition.new(:my_key,
+        unknown: "one",
+        other: "two",
+      )
+    end
+
+    it "should raise error with message" do
+      error = assert_raises Flipflop::FeatureError do
+        subject
+      end
+      assert_equal "Feature 'my_key' has unknown option :unknown, :other.", error.message
+    end
   end
 end

data/test/unit/strategies/abstract_strategy_test.rb

@@ -51,7 +51,13 @@ describe Flipflop::Strategies::AbstractStrategy do
       it "should raise if request is missing in thread" do
         Flipflop::Strategies::AbstractStrategy::RequestInterceptor.request = 3
         assert_raises Flipflop::StrategyError do
-          Thread.new { subject.send(:request) }.value
+          Thread.new {
+            if Thread.current.respond_to?(:report_on_exception)
+              Thread.current.report_on_exception = false
+            end
+
+            subject.send(:request)
+          }.value
         end
       end
     end

data/test/unit/strategies_controller_test.rb

@@ -1,6 +1,14 @@
 require File.expand_path("../../test_helper", __FILE__)
 
 describe "Flipflop::StrategiesController" do
+  before do
+    @app = TestApp.new
+  end
+
+  after do
+    @app.unload!
+  end
+
   subject do
     Flipflop::StrategiesController.new
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flipflop
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Paul Annesley
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -82,8 +82,6 @@ files:
 - lib/generators/flipflop/migration/templates/create_features.rb
 - lib/generators/flipflop/routes/USAGE
 - lib/generators/flipflop/routes/routes_generator.rb
-- lib/test_engine/config/features.rb
-- lib/test_engine/test_engine.rb
 - src/stylesheets/_flipflop.scss
 - test/integration/app_test.rb
 - test/integration/dashboard_test.rb
@@ -130,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A feature flipflopper for Rails web applications.

data/lib/test_engine/config/features.rb

@@ -1,3 +0,0 @@
-Flipflop.configure do
-  feature :engine_feature
-end

data/lib/test_engine/test_engine.rb

@@ -1,7 +0,0 @@
-class TestEngine < Rails::Engine
-  config.root = "lib/test_engine"
-
-  initializer "features" do
-    Flipflop::FeatureLoader.current.append(self)
-  end
-end