RubyGems - flipflop - Versions diffs - 2.6.0 → 2.7.0 - Mend

flipflop 2.6.0 → 2.7.0

Files changed (19) hide show

checksums.yaml +4 -4
data/CHANGES.md +6 -0
data/Gemfile +3 -0
data/README.md +11 -1
data/app/assets/config/manifest.js +3 -0
data/app/views/flipflop/stylesheets/{_flipflop.css → _flipflop.html.erb} +0 -0
data/app/views/layouts/flipflop.html.erb +1 -1
data/flipflop.gemspec +1 -0
data/lib/flipflop/engine.rb +15 -4
data/lib/flipflop/feature_set.rb +3 -4
data/lib/flipflop/version.rb +1 -1
data/lib/generators/flipflop/install/install_generator.rb +4 -0
data/lib/tasks/flipflop.rake +31 -0
data/lib/tasks/support/methods.rb +71 -0
data/test/test_helper.rb +2 -1
data/test/unit/configurable_test.rb +10 -20
data/test/unit/strategies/cookie_strategy_test.rb +1 -1
data/test/unit/tasks/support/methods_test.rb +68 -0
metadata +53 -9

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a26786a65478a45e78fe52884fd99b5a5a7e390bde362ce211832e57e3f66f9
-  data.tar.gz: 6a75c2816df20f8ead6f24bcab02f4c2460fad380f6fbcd2ef1a79c3f9234fb9
+  metadata.gz: 5d280de2ff4eb5a0d3437866c2f6d08e6069564183d670cb437cc7741e7eeac3
+  data.tar.gz: e16c3770910db3cfc4a442e2094acf44426651f0456235992f8ea0166e53e6d9
 SHA512:
-  metadata.gz: 47ecb8aeb5efb349c5a7366a559bd8eab2beb38dde0b19aa1202deae013072a3b158c1e77825241a372f2543287022d6a1d9e649755bf0130c3d823e6f604fdf
-  data.tar.gz: fba2c4ca6ab07e14623d06470f733f54f1415198586792e5aee6e2f81e896a5c02973c0b2efb550d10e63d861cb0d617e23fbd6b87e4681c289322a408838f27
+  metadata.gz: b2ab3024b4106125d0f67a6333c5d2fc6b6e32d744e3fca9775894e9291cca0e2ecb3b74d6343598fc91c44cf0077b7496e79dade91fa27ce6418bb7fb3a534a
+  data.tar.gz: 6c55c846ba7759fa595485283a8d7d5eeaeb919e238a5752310b8bbfb6915f486cf4f750ab96acef3ec94da4295dab144fd6673e5802a0b26d4b3481d16654ba

data/CHANGES.md CHANGED Viewed

@@ -1,3 +1,9 @@
+## 2.7.0
+* Removing .css extension from render partial and adding it to html handler to correctly render the erb file.
+  * Fixes Rails 6 & 7 deprecation: `Render file with extension is deprecated`
+  * Ruby 3.x compatible (Credits: https://github.com/voormedia/flipflop/pull/36)
 ## 2.6.0
 * Failure to load strategies in test environments will result in a warning instead of an error. This should aid in running Rake tasks.

data/Gemfile CHANGED Viewed

@@ -19,6 +19,9 @@ group :test do
   else
     gem "sqlite3", "~> 1.3.6", platform: :ruby
   end
+  if version >= "5.2" || Gem::Version.new(RUBY_VERSION) > Gem::Version.new("2.4.4")
+    gem 'sassc-rails'
+  end
   gem "activerecord-jdbcsqlite3-adapter", platform: :jruby,
     github: "jruby/activerecord-jdbc-adapter"

data/README.md CHANGED Viewed

@@ -8,6 +8,7 @@ application functionality at run-time. It is originally based on
 * simple configuration
 * ease of use for developers
 * an improved dashboard
+* manage features via console (using rake tasks)
 * thread safety
 * better database performance due to per-request caching, enabled by default
 * more strategies (Sequel, Redis, query strings, sessions, custom code)
@@ -32,9 +33,18 @@ 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)
+If you prefer, you can use the included rake tasks to enable or disable features.
+```
+rake flipflop:features                    # Shows features table
+rake flipflop:turn_on[feature,strategy]   # Enables a feature with the specified strategy
+rake flipflop:turn_off[feature,strategy]  # Disables a feature with the specified strategy
+rake flipflop:clear[feature,strategy]     # Clears a feature with the specified strategy
+```
 ## Rails requirements
-This gem requires Rails 4, 5 or 6. Using an ORM layer is entirely optional.
+This gem requires Rails 4, 5, 6 or 7. Using an ORM layer is entirely optional.
 ## Installation

data/app/assets/config/manifest.js ADDED Viewed

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/app/views/flipflop/stylesheets/{_flipflop.css → _flipflop.html.erb} RENAMED Viewed

File without changes

data/app/views/layouts/flipflop.html.erb CHANGED Viewed

@@ -2,7 +2,7 @@
 <html>
   <head>
     <title><%= yield :title -%></title>
-    <style><%= render partial: "flipflop/stylesheets/flipflop.css" %></style>
+    <style><%= render partial: "flipflop/stylesheets/flipflop" %></style>
   </head>
   <body><%= yield -%></body>
 </html>

data/flipflop.gemspec CHANGED Viewed

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.license  = "MIT"
   s.add_dependency("activesupport", ">= 4.0")
+  s.add_dependency('terminal-table', '>= 1.8')
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/lib/flipflop/engine.rb CHANGED Viewed

@@ -14,6 +14,12 @@ module Flipflop
     config.flipflop = ActiveSupport::OrderedOptions.new
+    initializer "flipflop.config" do |app|
+      raise_errors = config.flipflop.raise_strategy_errors
+      raise_errors = (ENV["RACK_ENV"] || ENV["RAILS_ENV"]) != "test" if raise_errors.nil?
+      FeatureSet.current.raise_strategy_errors = raise_errors
+    end
     initializer "flipflop.features_path" do |app|
       FeatureLoader.current.append(app)
     end
@@ -37,8 +43,13 @@ module Flipflop
     initializer "flipflop.request_interceptor" do |app|
       interceptor = Strategies::AbstractStrategy::RequestInterceptor
-      ActionController::Base.send(:include, interceptor)
-      ActionController::API.send(:include, interceptor) if defined?(ActionController::API)
+      ActiveSupport.on_load(:action_controller_base) do
+        ActionController::Base.send(:include, interceptor)
+      end
+      ActiveSupport.on_load(:action_controller_api) do
+        ActionController::API.send(:include, interceptor)
+      end
     end
     def run_tasks_blocks(app)
@@ -49,9 +60,9 @@ module Flipflop
     private
-    def to_prepare
+    def to_prepare(&block)
       klass = defined?(ActiveSupport::Reloader) ? ActiveSupport::Reloader : ActionDispatch::Reloader
-      klass.to_prepare(&Proc.new)
+      klass.to_prepare(&block)
     end
   end
 end

data/lib/flipflop/feature_set.rb CHANGED Viewed

@@ -28,18 +28,17 @@ module Flipflop
       private :new
     end
-    attr_reader :raise_strategy_errors
+    attr_accessor :raise_strategy_errors
     def initialize
-      @raise_strategy_errors = (ENV["RACK_ENV"] || ENV["RAILS_ENV"]) != "test"
       @features = {}
       @strategies = {}
     end
-    def configure
+    def configure(&block)
       Module.new do
         extend Configurable
-        instance_exec(&Proc.new)
+        instance_exec(&block)
       end
       self
     end

data/lib/flipflop/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Flipflop
-  VERSION = "2.6.0"
+  VERSION = "2.7.0"
 end

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

@@ -24,6 +24,10 @@ class Flipflop::InstallGenerator < Rails::Generators::Base
 # 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}
+# By default, when set to `nil`, strategy loading errors are suppressed in test
+# mode. Set to `true` to always raise errors, or `false` to always warn.
+config.flipflop.raise_strategy_errors = nil
 RUBY
   end

data/lib/tasks/flipflop.rake ADDED Viewed

@@ -0,0 +1,31 @@
+require_relative 'support/methods'
+namespace :flipflop do
+  # Encapsulates support methods to prevent name collision with global
+  # rake namespace
+  m = Object.new
+  m.extend Flipflop::Rake::SupportMethods
+  desc 'Enables a feature with the specified strategy.'
+  task :turn_on, %i[feature strategy] => :environment do |_task, args|
+    m.switch_feature! args[:feature], args[:strategy], true
+    puts "Feature :#{args[:feature]} enabled!"
+  end
+  desc 'Disables a feature with the specified strategy.'
+  task :turn_off, %i[feature strategy] => :environment do |_task, args|
+    m.switch_feature! args[:feature], args[:strategy], false
+    puts "Feature :#{args[:feature]} disabled!"
+  end
+  desc 'Clears a feature with the specified strategy.'
+  task :clear, %i[feature strategy] => :environment do |_task, args|
+    m.clear_feature! args[:feature], args[:strategy]
+    puts "Feature :#{args[:feature]} cleared!"
+  end
+  desc 'Shows features table'
+  task features: :environment do
+    puts m.build_features_table
+  end
+end

data/lib/tasks/support/methods.rb ADDED Viewed

@@ -0,0 +1,71 @@
+require 'terminal-table'
+module Flipflop
+  module Rake
+    module SupportMethods
+      def status_label(enabled)
+        enabled.nil? ? '' : (enabled ? 'ON' : 'OFF')
+      end
+      def switch_feature!(feature_name, strategy_name, value)
+        feature = find_feature_by_name(feature_name)
+        strategy = find_strategy_by_name(strategy_name)
+        if strategy.switchable?
+          strategy.switch!(feature.key, value)
+        else
+          raise "The :#{strategy_name} strategy doesn't support switching."
+        end
+      end
+      def clear_feature!(feature_name, strategy_name)
+        feature = find_feature_by_name(feature_name)
+        strategy = find_strategy_by_name(strategy_name)
+        strategy.clear!(feature.key)
+      end
+      def build_features_table
+        table_class.new(headings: table_header, rows: table_rows)
+      end
+      protected
+      def features
+        Flipflop.feature_set.features
+      end
+      def strategies
+        Flipflop.feature_set.strategies
+      end
+      def find_feature_by_name(name)
+        features.find { |f| f.name == name } || raise("Feature :#{name} is not defined.")
+      end
+      def find_strategy_by_name(name)
+        strategies.find { |s| s.name == name } || raise("Strategy :#{name} is not available.")
+      end
+      def table_header
+        %w[feature description] + strategies.map(&:name)
+      end
+      def table_class
+        Terminal::Table
+      end
+      def table_rows
+        features.inject([]) do |array, feature|
+          array << build_row_for(feature)
+        end
+      end
+      def build_row_for(feature)
+        strategies.inject([feature.name, feature.description]) do |row, strategy|
+          row << status_label(strategy.enabled?(feature.key))
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb CHANGED Viewed

@@ -181,8 +181,9 @@ class TestApp
     if defined?(ActiveRecord::Migrator.migrate)
       ActiveRecord::Migrator.migrate(Rails.application.paths["db/migrate"].to_a)
+    elsif ActiveRecord::Base.connection.respond_to?(:schema_migration)
+      ActiveRecord::MigrationContext.new(Rails.application.paths["db/migrate"], ActiveRecord::Base.connection.schema_migration).migrate
     else
-      # Rails 5.2+
       ActiveRecord::MigrationContext.new(Rails.application.paths["db/migrate"]).migrate
     end
   end

data/test/unit/configurable_test.rb CHANGED Viewed

@@ -108,29 +108,19 @@ describe Flipflop::Configurable do
         Flipflop::FeatureSet.current.strategies.map(&:description)
     end
-    it "should raise error when strategy fails to load" do
-      begin
-        rack_env, ENV["RACK_ENV"] = ENV["RACK_ENV"], nil
-        rails_env, ENV["RAILS_ENV"] = ENV["RAILS_ENV"], nil
-        assert_raises "Oops" do
-          subject.strategy(FailingStrategy)
-        end
-      ensure
-        ENV["RACK_ENV"] = rack_env
-        ENV["RAILS_ENV"] = rails_env
+    it "should raise error when strategy fails to load if unsuppressed" do
+      subject
+      Flipflop::FeatureSet.current.raise_strategy_errors = true
+      assert_raises "Oops" do
+        subject.strategy(FailingStrategy)
       end
     end
-    it "should not raise error when strategy fails to load in test mode" do
-      begin
-        rack_env, ENV["RACK_ENV"] = ENV["RACK_ENV"], "test"
-        rails_env, ENV["RAILS_ENV"] = ENV["RAILS_ENV"], "test"
-        assert_equal "WARNING: Unable to load Flipflop strategy FailingStrategy: Oops\n",
-          capture_stderr { subject.strategy(FailingStrategy) }
-      ensure
-        ENV["RACK_ENV"] = rack_env
-        ENV["RAILS_ENV"] = rails_env
-      end
+    it "should not raise error when strategy fails to load if suppressed" do
+      subject
+      Flipflop::FeatureSet.current.raise_strategy_errors = false
+      assert_equal "WARNING: Unable to load Flipflop strategy FailingStrategy: Oops\n",
+        capture_stderr { subject.strategy(FailingStrategy) }
     end
   end
 end

data/test/unit/strategies/cookie_strategy_test.rb CHANGED Viewed

@@ -112,7 +112,7 @@ describe Flipflop::Strategies::CookieStrategy do
         subject.switch!(:one, true)
         subject.clear!(:one)
         subject.send(:request).cookie_jar.write(headers = {})
-        assert_equal "my_cookie_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 GMT; HttpOnly",
           headers["Set-Cookie"]
       end
     end

data/test/unit/tasks/support/methods_test.rb ADDED Viewed

@@ -0,0 +1,68 @@
+require File.expand_path('../../../../test_helper', __FILE__)
+require File.expand_path('../../../../../lib/tasks/support/methods', __FILE__)
+describe Flipflop::Rake::SupportMethods do
+  subject do
+    object = Object.new
+    object.extend Flipflop::Rake::SupportMethods
+  end
+  describe '#status_label' do
+    it 'returns the "enabled" label when its argument is "true"' do
+      assert_equal 'ON', subject.status_label(true)
+    end
+    it 'returns the "disabled" label when its argument is "false"' do
+      assert_equal 'OFF', subject.status_label(false)
+    end
+    it 'returns the "unset" label when its argument is "nil"' do
+      assert_equal '', subject.status_label(nil)
+    end
+  end
+  def with_feature_and_strategy(strategy = 'Test')
+    # Stubs finder methods to avoid going into FeatureSet code.
+    feature = Flipflop::FeatureDefinition.new(:world_domination)
+    subject.stub :find_feature_by_name, feature do
+      classname = "#{strategy}Strategy"
+      strategy = Flipflop::Strategies.const_get(classname).new(name: strategy)
+      subject.stub :find_strategy_by_name, strategy do
+        yield(strategy, feature) if block_given?
+      end
+    end
+  end
+  describe '#switch_feature!' do
+    it 'enables a feature using a strategy' do
+      with_feature_and_strategy do |strategy, feature|
+        subject.switch_feature! 'world_domination', 'test', true
+        assert_equal true, strategy.enabled?(feature.key)
+      end
+    end
+    it 'disables a feature using a strategy' do
+      with_feature_and_strategy do |strategy, feature|
+        subject.switch_feature! 'world_domination', 'test', false
+        assert_equal false, strategy.enabled?(feature.key)
+      end
+    end
+    describe 'when the strategy is not switchable' do
+      it 'raises an error' do
+        with_feature_and_strategy 'Lambda' do |strategy, feature|
+          -> { subject.switch_feature!('world_domination', 'lambda', true) }.must_raise
+        end
+      end
+    end
+  end
+  describe '#clear_feature!' do
+    it 'clears a feature using a strategy' do
+      with_feature_and_strategy do |strategy, feature|
+        subject.clear_feature! 'world_domination', 'test'
+        assert_nil strategy.enabled?(feature.key)
+      end
+    end
+  end
+end

metadata CHANGED Viewed

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: flipflop
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Paul Annesley
 - Rolf Timmermans
 - Jippe Holwerda
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,6 +26,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: Declarative API for specifying features, switchable in declaration, database
   and cookies.
 email:
@@ -43,10 +57,11 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- app/assets/config/manifest.js
 - app/controllers/flipflop/features_controller.rb
 - app/controllers/flipflop/strategies_controller.rb
 - app/views/flipflop/features/index.html.erb
-- app/views/flipflop/stylesheets/_flipflop.css
+- app/views/flipflop/stylesheets/_flipflop.html.erb
 - app/views/layouts/flipflop.html.erb
 - config/features.rb
 - config/locales/en.yml
@@ -82,6 +97,8 @@ files:
 - lib/generators/flipflop/migration/templates/create_features.rb
 - lib/generators/flipflop/routes/USAGE
 - lib/generators/flipflop/routes/routes_generator.rb
+- lib/tasks/flipflop.rake
+- lib/tasks/support/methods.rb
 - src/stylesheets/_flipflop.scss
 - test/integration/app_test.rb
 - test/integration/dashboard_test.rb
@@ -109,11 +126,12 @@ files:
 - test/unit/strategies/session_strategy_test.rb
 - test/unit/strategies/test_strategy_test.rb
 - test/unit/strategies_controller_test.rb
+- test/unit/tasks/support/methods_test.rb
 homepage: https://github.com/voormedia/flipflop
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,9 +146,35 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.7
-signing_key:
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A feature flipflopper for Rails web applications.
-test_files: []
+test_files:
+- test/integration/app_test.rb
+- test/integration/dashboard_test.rb
+- test/templates/nl.yml
+- test/templates/test_app_features.rb
+- test/templates/test_engine.rb
+- test/templates/test_engine_features.rb
+- test/test_helper.rb
+- test/unit/configurable_test.rb
+- test/unit/feature_cache_test.rb
+- test/unit/feature_definition_test.rb
+- test/unit/feature_set_test.rb
+- test/unit/flipflop_test.rb
+- test/unit/group_definition_test.rb
+- test/unit/strategies/abstract_strategy_request_test.rb
+- test/unit/strategies/abstract_strategy_test.rb
+- test/unit/strategies/active_record_strategy_test.rb
+- test/unit/strategies/cookie_strategy_test.rb
+- test/unit/strategies/default_strategy_test.rb
+- test/unit/strategies/lambda_strategy_test.rb
+- 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
+- test/unit/tasks/support/methods_test.rb