flipflop 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d991f9cd5e93e4a837c0e6835da5ae2339498bf74a26fc6e21cee4503793ca6
-  data.tar.gz: 943ba8e6ea38bf2afbc45454890f8111a3b9029383018e5ddf3a76f8faac0732
+  metadata.gz: 2285d1f81e213c214eba67b891e72bd671b2dea7096759ba142bd8457197c671
+  data.tar.gz: d560e6dc20e028641bea194e4626b2103e0e4999e40308b3f3d9009574090c64
 SHA512:
-  metadata.gz: a81cbf3b37f9d91ec310bc971eec5c06b2d4b0581bd42191366503782bb8d95ef6b51fef33588bd28ec571a57ebc03f51cd1c5f9514ac8151f1a855e4072e085
-  data.tar.gz: 30a184287b36b7a346cc72fb0bf4f2ed4cb59083461f3859d70d1ec9908c37b3c1b65e54dc3536ed472fed85f94465ea191c6d4eeb7b049679b4056cb3585b05
+  metadata.gz: 31b1406c3ab135e4bf628040914ea4057ab37bef82909e180da668d60365abf480081819720d4d044baabea59940167f3353d2478ba3433a1867e035dce981e9
+  data.tar.gz: 2f78138c8de1ae3b96bdf511effbad20cf0e08b66764ce82b159f024c32868c78f9ced8c6918bc52ce316b7599a4301f03583006d58de441f72835a694aa4a09

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 cache: bundler
 rvm:
 - 2.5.0
-- 2.4.2
+- 2.4.4
 - 2.3.5
 - jruby-9.1.13.0
 - ruby-head
@@ -18,16 +18,12 @@ env:
 - RAILS_VERSION=5.0 RAILS_API_ONLY=1
 matrix:
   include:
-  - rvm: 2.3.5
-    env: RAILS_VERSION=4.2
   - rvm: 2.2.8
     env: RAILS_VERSION=4.2
   - rvm: 2.1.10
     env: RAILS_VERSION=4.2
   - rvm: 2.0.0
     env: RAILS_VERSION=4.2
-  - rvm: 2.3.5
-    env: RAILS_VERSION=4.1
   - rvm: 2.2.8
     env: RAILS_VERSION=4.1
   - rvm: 2.1.10
@@ -35,6 +31,10 @@ matrix:
   - rvm: 2.0.0
     env: RAILS_VERSION=4.1
   exclude:
+  - rvm: 2.4.4
+    env: RAILS_VERSION=master
+  - rvm: 2.4.4
+    env: RAILS_VERSION=master RAILS_API_ONLY=1
   - rvm: 2.3.5
     env: RAILS_VERSION=master
   - rvm: 2.3.5
@@ -52,4 +52,4 @@ deploy:
   on:
     tags: true
     repo: voormedia/flipflop
-    ruby: 2.3.5
+    ruby: 2.5.0

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 2.5.0
+
+* Add Sequel strategy. ActiveRecord/Sequel can be used side by side.
+* Rails 6 compatibility.
+
 ## 2.4.0
 
 * Add location of feature definition.

data/Gemfile

@@ -13,7 +13,13 @@ group :test do
   gem "bootstrap", "= 4.0.0.alpha6", require: false
 
   gem "fakeredis", require: false
-  gem "sqlite3", ">= 1.3", platform: :ruby
+
+  if version == "master" || version >= "6"
+    gem "sqlite3", "~> 1.4.0", platform: :ruby
+  else
+    gem "sqlite3", "~> 1.3.6", platform: :ruby
+  end
+
   gem "activerecord-jdbcsqlite3-adapter", platform: :jruby,
     github: "jruby/activerecord-jdbc-adapter"
 

data/LICENSE

@@ -1,7 +1,7 @@
 The MIT License
 
 Copyright (c) 2011-2013 Learnable Pty Ltd
-Copyright (c) 2016-2017 Voormedia
+Copyright (c) 2016-2019 Voormedia
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,11 +4,13 @@
 
 **Flipflop** provides a declarative, layered way of enabling and disabling
 application functionality at run-time. It is originally based on
-[Flip](https://github.com/pda/flip). Compared to the original gem **Flipflop** has:
+[Flip](https://github.com/pda/flip). **Flipflop** has the following features:
+* simple configuration
+* ease of use for developers
 * an improved dashboard
 * thread safety
 * better database performance due to per-request caching, enabled by default
-* more strategies (Redis, query strings, sessions, custom code)
+* more strategies (Sequel, Redis, query strings, sessions, custom code)
 * more strategy options (cookie options, strategy names and descriptions, custom database models)
 * the ability to use the same strategy twice, with different options
 * configuration in a fixed location (`config/features.rb`) that is usable even if you don't use the database strategy
@@ -21,7 +23,7 @@ application functionality at run-time. It is originally based on
 You can configure strategy layers that will evaluate if a feature is currently
 enabled or disabled. Available strategies are:
 * a per-feature default setting
-* database (with Active Record or Redis), to flipflop features site-wide for all users
+* database (with Active Record, Sequel, or Redis), to flipflop features site-wide for all users
 * cookie or session, to flipflop features for single users
 * query string parameters, to flipflop features occasionally (in development mode for example)
 * custom strategy code
@@ -30,6 +32,10 @@ Flipflop has a dashboard interface that's easy to understand and use.
 
 [<img src="https://raw.githubusercontent.com/voormedia/flipflop/screenshots/dashboard.png" alt="Dashboard">](https://raw.githubusercontent.com/voormedia/flipflop/screenshots/dashboard.png)
 
+## Rails requirements
+
+This gem requires Rails 4, 5 or 6. Using an ORM layer is entirely optional. 
+
 ## Installation
 
 Add the gem to your `Gemfile`:
@@ -58,7 +64,7 @@ Features and strategies are declared in `config/features.rb`:
 Flipflop.configure do
   # Strategies will be used in the order listed here.
   strategy :cookie
-  strategy :active_record
+  strategy :active_record # or :sequel, :redis
   strategy :default
 
   # Basic feature declaration:
@@ -86,8 +92,8 @@ Feature definitions support these options:
 ## Strategies
 
 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 `flipflop_features`). Honors `default_scope` when features are resolved or switched on/off.
+* `:active_record`/`:sequel` – Save feature settings in the database.
+    * `:class` – Provide the feature model. `Flipflop::Feature` by default (which is defined automatically and uses the table `flipflop_features`). The `ActiveRecord` version 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.

data/app/controllers/flipflop/features_controller.rb

@@ -25,7 +25,12 @@ module Flipflop
         @strategies = @feature_set.strategies.reject(&:hidden?)
         @grouped_features = @feature_set.features.group_by(&:group)
 
-        @application_name = Rails.application.class.parent_name.underscore.titleize
+        app_class = Rails.application.class
+        application_name = app_class.respond_to?(:module_parent_name) ?
+          app_class.module_parent_name :
+          app_class.parent_name
+
+        @application_name = application_name.underscore.titleize
       end
 
       def grouped?

data/lib/flipflop.rb

@@ -22,6 +22,7 @@ require "flipflop/strategies/lambda_strategy"
 require "flipflop/strategies/query_string_strategy"
 require "flipflop/strategies/redis_strategy"
 require "flipflop/strategies/session_strategy"
+require "flipflop/strategies/sequel_strategy"
 require "flipflop/strategies/test_strategy"
 
 require "flipflop/engine" if defined?(Rails)

data/lib/flipflop/facade.rb

@@ -1,3 +1,5 @@
+require "forwardable"
+
 module Flipflop
   module Facade
     extend Forwardable

data/lib/flipflop/strategies/active_record_strategy.rb

@@ -5,10 +5,17 @@ module Flipflop
         def default_description
           "Stores features in database. Applies to all users."
         end
+
+        def define_feature_class
+          return Flipflop::Feature if defined?(Flipflop::Feature)
+
+          model = Class.new(ActiveRecord::Base)
+          Flipflop.const_set(:Feature, model)
+        end
       end
 
       def initialize(**options)
-        @class = options.delete(:class) || ::Flipflop::Feature
+        @class = options.delete(:class) || self.class.define_feature_class
         if !@class.kind_of?(Class)
           @class = ActiveSupport::Inflector.constantize(@class.to_s)
         end

data/lib/flipflop/strategies/sequel_strategy.rb

@@ -0,0 +1,57 @@
+module Flipflop
+  module Strategies
+    class SequelStrategy < AbstractStrategy
+      class << self
+        def default_description
+          "Stores features in database. Applies to all users."
+        end
+
+        def define_feature_class
+          return Flipflop::Feature if defined?(Flipflop::Feature)
+
+          model = Class.new(Sequel::Model(:flipflop_features))
+          model.plugin(:timestamps, force: true, update_on_create: true)
+          model.raise_on_save_failure = true
+
+          Flipflop.const_set(:Feature, model)
+        end
+      end
+
+      def initialize(**options)
+        @class = options.delete(:class) || self.class.define_feature_class
+        if !@class.kind_of?(Class)
+          @class = ActiveSupport::Inflector.constantize(@class.to_s)
+        end
+        super(**options)
+      end
+
+      def switchable?
+        true
+      end
+
+      def enabled?(feature)
+        find(feature).try(:enabled?)
+      end
+
+      def switch!(feature, enabled)
+        record = find_or_new(feature)
+        record.enabled = enabled
+        record.save
+      end
+
+      def clear!(feature)
+        find(feature).try(:destroy)
+      end
+
+      protected
+
+      def find_or_new(feature)
+        find(feature) || @class.new(key: feature.to_s)
+      end
+
+      def find(feature)
+        @class.where(key: feature.to_s).first
+      end
+    end
+  end
+end

data/lib/flipflop/version.rb

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

data/lib/generators/flipflop/features/templates/features.rb

@@ -6,8 +6,10 @@ Flipflop.configure do
 
   # Other strategies:
   #
-  # strategy :query_string
+  # strategy :sequel
   # strategy :redis
+  #
+  # strategy :query_string
   # strategy :session
   #
   # strategy :my_strategy do |feature|

data/test/test_helper.rb

@@ -100,7 +100,11 @@ class TestApp
       quiet: true,
       api: ENV["RAILS_API_ONLY"].to_i.nonzero?,
       skip_active_job: true,
+      skip_active_storage: true,
+      skip_action_cable: true,
+      skip_bootsnap: true,
       skip_bundle: true,
+      skip_puma: true,
       skip_gemfile: true,
       skip_git: true,
       skip_javascript: true,
@@ -128,11 +132,26 @@ class TestApp
     require "rails"
     require "flipflop/engine"
 
+    ActiveSupport::Dependencies.autoloaded_constants.clear
     load File.expand_path("../../#{path}/config/application.rb", __FILE__)
     load File.expand_path("../../#{path}/config/environments/test.rb", __FILE__)
     Rails.application.config.cache_classes = false
     Rails.application.config.action_view.raise_on_missing_translations = true
     Rails.application.config.i18n.enforce_available_locales = false
+    Rails.application.config.autoloader = :classic # Disable Zeitwerk in Rails 6+
+
+    # Avoid Rails 6+ deprecation warning
+    if defined?(ActiveRecord::ConnectionAdapters::SQLite3Adapter) &&
+      ActiveRecord::ConnectionAdapters::SQLite3Adapter.respond_to?(:represent_boolean_as_integer=) &&
+      Rails.application.config.active_record.sqlite3.nil?
+      Rails.application.config.active_record.sqlite3 = ActiveSupport::OrderedOptions.new
+    end
+
+    # Avoid Rails 6+ deprecation warning
+    if defined?(ActionView::Railtie::NULL_OPTION)
+      Rails.application.config.action_view.finalize_compiled_template_methods = ActionView::Railtie::NULL_OPTION
+    end
+
     Rails.application.initialize!
 
     I18n.locale = :en

data/test/unit/strategies/active_record_strategy_test.rb

@@ -6,7 +6,7 @@ class ResultSet
   end
 
   def first_or_initialize
-    @results.first or My::Feature.new(@key, false)
+    @results.first or MyAr::Feature.new(@key, false)
   end
 
   def first
@@ -14,7 +14,7 @@ class ResultSet
   end
 end
 
-module My
+module MyAr
   class Feature < Struct.new(:key, :enabled)
     class << self
       attr_accessor :results
@@ -27,11 +27,11 @@ module My
     alias_method :enabled?, :enabled
 
     def destroy
-      My::Feature.results[key] = ResultSet.new(key)
+      MyAr::Feature.results[key] = ResultSet.new(key)
     end
 
     def save!
-      My::Feature.results[key] = ResultSet.new(key, [self])
+      MyAr::Feature.results[key] = ResultSet.new(key, [self])
     end
   end
 end
@@ -39,7 +39,7 @@ end
 describe Flipflop::Strategies::ActiveRecordStrategy do
   describe "with defaults" do
     subject do
-      Flipflop::Strategies::ActiveRecordStrategy.new(class: My::Feature).freeze
+      Flipflop::Strategies::ActiveRecordStrategy.new(class: MyAr::Feature).freeze
     end
 
     it "should have default name" do
@@ -65,8 +65,8 @@ describe Flipflop::Strategies::ActiveRecordStrategy do
 
     describe "with enabled feature" do
       before do
-        My::Feature.results = {
-          one: ResultSet.new(:one, [My::Feature.new(:one, true)]),
+        MyAr::Feature.results = {
+          one: ResultSet.new(:one, [MyAr::Feature.new(:one, true)]),
         }
       end
 
@@ -87,8 +87,8 @@ describe Flipflop::Strategies::ActiveRecordStrategy do
 
     describe "with disabled feature" do
       before do
-        My::Feature.results = {
-          two: ResultSet.new(:two, [My::Feature.new(:two, false)]),
+        MyAr::Feature.results = {
+          two: ResultSet.new(:two, [MyAr::Feature.new(:two, false)]),
         }
       end
 
@@ -109,7 +109,7 @@ describe Flipflop::Strategies::ActiveRecordStrategy do
 
     describe "with unsaved feature" do
       before do
-        My::Feature.results = {
+        MyAr::Feature.results = {
           three: ResultSet.new(:three),
         }
       end
@@ -127,12 +127,12 @@ describe Flipflop::Strategies::ActiveRecordStrategy do
 
   describe "with string class name" do
     subject do
-      Flipflop::Strategies::ActiveRecordStrategy.new(class: "My::Feature").freeze
+      Flipflop::Strategies::ActiveRecordStrategy.new(class: "MyAr::Feature").freeze
     end
 
     before do
-      My::Feature.results = {
-        one: ResultSet.new(:one, [My::Feature.new(:one, true)]),
+      MyAr::Feature.results = {
+        one: ResultSet.new(:one, [MyAr::Feature.new(:one, true)]),
       }
     end
 
@@ -144,12 +144,12 @@ describe Flipflop::Strategies::ActiveRecordStrategy do
 
   describe "with symbol class name" do
     subject do
-      Flipflop::Strategies::ActiveRecordStrategy.new(class: :"My::Feature").freeze
+      Flipflop::Strategies::ActiveRecordStrategy.new(class: :"MyAr::Feature").freeze
     end
 
     before do
-      My::Feature.results = {
-        one: ResultSet.new(:one, [My::Feature.new(:one, true)]),
+      MyAr::Feature.results = {
+        one: ResultSet.new(:one, [MyAr::Feature.new(:one, true)]),
       }
     end
 

data/test/unit/strategies/sequel_strategy_test.rb

@@ -0,0 +1,165 @@
+require File.expand_path("../../../test_helper", __FILE__)
+
+class ResultSet
+  def initialize(key, results = [])
+    @key, @results = key, results
+  end
+
+  def first
+    @results.first
+  end
+end
+
+module MySq
+  class Feature < Struct.new(:key, :enabled)
+    class << self
+      attr_accessor :results
+
+      def where(conditions)
+        results[conditions[:key].to_sym]
+      end
+    end
+
+    alias_method :enabled?, :enabled
+
+    def initialize(key, value = false)
+      if key.kind_of?(Hash)
+        key.each { |k, v| self[k] = v.to_sym }
+      else
+        super
+      end
+    end
+
+    def destroy
+      MySq::Feature.results[key] = ResultSet.new(key)
+    end
+
+    def save
+      MySq::Feature.results[key] = ResultSet.new(key, [self])
+    end
+  end
+end
+
+describe Flipflop::Strategies::SequelStrategy do
+  describe "with defaults" do
+    subject do
+      Flipflop::Strategies::SequelStrategy.new(class: MySq::Feature).freeze
+    end
+
+    it "should have default name" do
+      assert_equal "sequel", subject.name
+    end
+
+    it "should have title derived from name" do
+      assert_equal "Sequel", subject.title
+    end
+
+    it "should have default description" do
+      assert_equal "Stores features in database. Applies to all users.",
+        subject.description
+    end
+
+    it "should be switchable" do
+      assert_equal true, subject.switchable?
+    end
+
+    it "should have unique key" do
+      assert_match /^\w+$/, subject.key
+    end
+
+    describe "with enabled feature" do
+      before do
+        MySq::Feature.results = {
+          one: ResultSet.new(:one, [MySq::Feature.new(:one, true)]),
+        }
+      end
+
+      it "should have feature enabled" do
+        assert_equal true, subject.enabled?(:one)
+      end
+
+      it "should be able to switch feature off" do
+        subject.switch!(:one, false)
+        assert_equal false, subject.enabled?(:one)
+      end
+
+      it "should be able to clear feature" do
+        subject.clear!(:one)
+        assert_nil subject.enabled?(:one)
+      end
+    end
+
+    describe "with disabled feature" do
+      before do
+        MySq::Feature.results = {
+          two: ResultSet.new(:two, [MySq::Feature.new(:two, false)]),
+        }
+      end
+
+      it "should not have feature enabled" do
+        assert_equal false, subject.enabled?(:two)
+      end
+
+      it "should be able to switch feature on" do
+        subject.switch!(:two, true)
+        assert_equal true, subject.enabled?(:two)
+      end
+
+      it "should be able to clear feature" do
+        subject.clear!(:two)
+        assert_nil subject.enabled?(:two)
+      end
+    end
+
+    describe "with unsaved feature" do
+      before do
+        MySq::Feature.results = {
+          three: ResultSet.new(:three),
+        }
+      end
+
+      it "should not know feature" do
+        assert_nil subject.enabled?(:three)
+      end
+
+      it "should be able to switch feature on" do
+        subject.switch!(:three, true)
+        assert_equal true, subject.enabled?(:three)
+      end
+    end
+  end
+
+  describe "with string class name" do
+    subject do
+      Flipflop::Strategies::SequelStrategy.new(class: "MySq::Feature").freeze
+    end
+
+    before do
+      MySq::Feature.results = {
+        one: ResultSet.new(:one, [MySq::Feature.new(:one, true)]),
+      }
+    end
+
+    it "should be able to switch feature off" do
+      subject.switch!(:one, false)
+      assert_equal false, subject.enabled?(:one)
+    end
+  end
+
+  describe "with symbol class name" do
+    subject do
+      Flipflop::Strategies::SequelStrategy.new(class: :"MySq::Feature").freeze
+    end
+
+    before do
+      MySq::Feature.results = {
+        one: ResultSet.new(:one, [MySq::Feature.new(:one, true)]),
+      }
+    end
+
+    it "should be able to switch feature off" do
+      subject.switch!(:one, false)
+      assert_equal false, subject.enabled?(:one)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flipflop
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Paul Annesley
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-26 00:00:00.000000000 Z
+date: 2019-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,7 +45,6 @@ files:
 - Rakefile
 - app/controllers/flipflop/features_controller.rb
 - app/controllers/flipflop/strategies_controller.rb
-- app/models/flipflop/feature.rb
 - app/views/flipflop/features/index.html.erb
 - app/views/flipflop/stylesheets/_flipflop.css
 - app/views/layouts/flipflop.html.erb
@@ -70,6 +69,7 @@ files:
 - lib/flipflop/strategies/options_hasher.rb
 - lib/flipflop/strategies/query_string_strategy.rb
 - lib/flipflop/strategies/redis_strategy.rb
+- lib/flipflop/strategies/sequel_strategy.rb
 - lib/flipflop/strategies/session_strategy.rb
 - lib/flipflop/strategies/test_strategy.rb
 - lib/flipflop/version.rb
@@ -105,6 +105,7 @@ files:
 - test/unit/strategies/options_hasher_test.rb
 - test/unit/strategies/query_string_strategy_test.rb
 - test/unit/strategies/redis_strategy_test.rb
+- test/unit/strategies/sequel_strategy_test.rb
 - test/unit/strategies/session_strategy_test.rb
 - test/unit/strategies/test_strategy_test.rb
 - test/unit/strategies_controller_test.rb
@@ -127,8 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A feature flipflopper for Rails web applications.

data/app/models/flipflop/feature.rb

@@ -1,4 +0,0 @@
-if defined?(ActiveRecord)
-  class Flipflop::Feature < ActiveRecord::Base
-  end
-end