flipper-active_record 0.16.2 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4039f5b7764d3f487c80d06f91e0b272abbf4e25
-  data.tar.gz: d40858b49ce9a4697a97b7f5b059dd2a20b30970
+SHA256:
+  metadata.gz: 3e08a444f2dc77250d2778470880417655887189faca0140f7943bb19898c6f8
+  data.tar.gz: 70a469cb0c4ca84d51278efbe882f54bb9c2e77853897cab31412f5726221d39
 SHA512:
-  metadata.gz: cbeb82ee800ebe3709e0f23e28c83b43cbe172256487bfd1d36d4c7204361e6c57aaa4756faec7c64ef0678179d80d8e5bf7973b9a935386e809bc6d42d4e673
-  data.tar.gz: 8df611d967c990cefbec545f5cd3b351de115f24f72e944d4a62573c886f035a2361cbc74ff1b76c176cd592360bdb25e56862d7f540a7f5de128b9e5bc5fce7
+  metadata.gz: 7654b4e38f19571c52d1d0aac2bb36d13212d4c73d303b571043c5e3294de151ca8e99ca6a61782200999f068b8b0211fdf8c58a61fdd8748ffe5b0bda7261c0
+  data.tar.gz: a7a36c4533c0a066a828ac2db5e4a666a13661c3f7b5cee46413432fad81129db70f1ab40feec3e7022db0078d40fcba879964bab66f17a29c7c6a1def4d39a0

data/docs/active_record/README.md

@@ -4,9 +4,8 @@ An ActiveRecord adapter for [Flipper](https://github.com/jnunemaker/flipper).
 
 Supported Active Record versions:
 
-* 3.2.x
-* 4.2.x
 * 5.0.x
+* 6.0.x
 
 ## Installation
 
@@ -37,6 +36,8 @@ flipper = Flipper.new(adapter)
 # profit...
 ```
 
+Note that the active record adapter requires the database tables to be created in order to work; failure to run the migration first will cause an exception to be raised when attempting to initialize the active record adapter.
+
 ## Internals
 
 Each feature is stored as a row in a features table. Each gate is stored as a row in a gates table, related to the feature by the feature's key.

data/flipper-active_record.gemspec

@@ -10,7 +10,6 @@ Gem::Specification.new do |gem|
   gem.authors       = ['John Nunemaker']
   gem.email         = ['nunemaker@gmail.com']
   gem.summary       = 'ActiveRecord adapter for Flipper'
-  gem.description   = 'ActiveRecord adapter for Flipper'
   gem.license       = 'MIT'
   gem.homepage      = 'https://github.com/jnunemaker/flipper'
 
@@ -26,5 +25,5 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
-  gem.add_dependency 'activerecord', '>= 3.2', '< 6'
+  gem.add_dependency 'activerecord', '>= 5.0', '< 7'
 end

data/lib/flipper-active_record.rb

@@ -1,3 +1,5 @@
+require 'active_support/lazy_load_hooks'
+
 ActiveSupport.on_load(:active_record) do
   require 'flipper/adapters/active_record'
 end

data/lib/flipper/adapters/active_record.rb

@@ -54,12 +54,16 @@ module Flipper
       # Public: Adds a feature to the set of known features.
       def add(feature)
         # race condition, but add is only used by enable/disable which happen
-        # super rarely, so it shouldn't matter in practice; additionally
-        # to_a.first is used instead of first because of a Ruby 2.4/Rails 3.2.21
-        # CI failure (https://travis-ci.org/jnunemaker/flipper/jobs/297274000).
-        unless @feature_class.where(key: feature.key).to_a.first
-          @feature_class.create! { |f| f.key = feature.key }
+        # super rarely, so it shouldn't matter in practice
+        @feature_class.transaction do
+          unless @feature_class.where(key: feature.key).first
+            begin
+              @feature_class.create! { |f| f.key = feature.key }
+            rescue ::ActiveRecord::RecordNotUnique
+            end
+          end
         end
+
         true
       end
 
@@ -97,7 +101,7 @@ module Flipper
       end
 
       def get_all
-        rows = ::ActiveRecord::Base.connection.select_all <<-SQL
+        rows = ::ActiveRecord::Base.connection.select_all <<-SQL.tr("\n", ' ')
           SELECT ff.key AS feature_key, fg.key, fg.value
           FROM #{@feature_class.table_name} ff
           LEFT JOIN #{@gate_class.table_name} fg ON ff.key = fg.feature_key
@@ -121,8 +125,10 @@ module Flipper
       # Returns true.
       def enable(feature, gate, thing)
         case gate.data_type
-        when :boolean, :integer
-          enable_single(feature, gate, thing)
+        when :boolean
+          set(feature, gate, thing, clear: true)
+        when :integer
+          set(feature, gate, thing)
         when :set
           enable_multi(feature, gate, thing)
         else
@@ -144,18 +150,7 @@ module Flipper
         when :boolean
           clear(feature)
         when :integer
-          @gate_class.transaction do
-            @gate_class.where(
-              feature_key: feature.key,
-              key: gate.key
-            ).destroy_all
-
-            @gate_class.create! do |g|
-              g.feature_key = feature.key
-              g.key = gate.key
-              g.value = thing.value.to_s
-            end
-          end
+          set(feature, gate, thing)
         when :set
           @gate_class.where(feature_key: feature.key, key: gate.key, value: thing.value).destroy_all
         else
@@ -172,8 +167,10 @@ module Flipper
 
       private
 
-      def enable_single(feature, gate, thing)
+      def set(feature, gate, thing, options = {})
+        clear_feature = options.fetch(:clear, false)
         @gate_class.transaction do
+          clear(feature) if clear_feature
           @gate_class.where(feature_key: feature.key, key: gate.key).destroy_all
           @gate_class.create! do |g|
             g.feature_key = feature.key
@@ -181,6 +178,8 @@ module Flipper
             g.value = thing.value.to_s
           end
         end
+
+        nil
       end
 
       def enable_multi(feature, gate, thing)
@@ -189,9 +188,10 @@ module Flipper
           g.key = gate.key
           g.value = thing.value.to_s
         end
+
+        nil
       rescue ::ActiveRecord::RecordNotUnique
-      rescue ::ActiveRecord::StatementInvalid => error
-        raise unless error.message =~ /unique/i
+        # already added so no need move on with life
       end
 
       def result_for_feature(feature, db_gates)
@@ -201,12 +201,12 @@ module Flipper
           result[gate.key] =
             case gate.data_type
             when :boolean
-              if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s }
-                db_gate.value
+              if detected_db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s }
+                detected_db_gate.value
               end
             when :integer
-              if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s }
-                db_gate.value
+              if detected_db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s }
+                detected_db_gate.value
               end
             when :set
               db_gates.select { |db_gate| db_gate.key == gate.key.to_s }.map(&:value).to_set

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.16.2'.freeze
+  VERSION = '0.19.1'.freeze
 end

data/lib/generators/flipper/active_record_generator.rb

@@ -13,11 +13,11 @@ module Flipper
       end
 
       def self.migration_version
-        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if rails5?
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if requires_migration_number?
       end
 
-      def self.rails5?
-        Rails.version.start_with?('5')
+      def self.requires_migration_number?
+        Rails::VERSION::MAJOR.to_i >= 5
       end
 
       def create_migration_file

data/spec/flipper/adapters/active_record_requires_spec.rb

@@ -0,0 +1,5 @@
+# This nominally-empty spec ensures that the file "flipper-active_record.rb" can be
+# required without error, and guards against regressions of the kind fixed in
+# https://github.com/jnunemaker/flipper/pull/437.
+
+require "flipper-active_record.rb"

data/test_rails/generators/flipper/active_record_generator_test.rb

@@ -0,0 +1,43 @@
+require 'helper'
+require 'active_record'
+require 'rails/generators/test_case'
+require 'generators/flipper/active_record_generator'
+
+class FlipperActiveRecordGeneratorTest < Rails::Generators::TestCase
+  tests Flipper::Generators::ActiveRecordGenerator
+  destination File.expand_path('../../../../tmp', __FILE__)
+  setup :prepare_destination
+
+  def test_generates_migration
+    run_generator
+    migration_version = if Rails::VERSION::MAJOR.to_i < 5
+                          ""
+                        else
+                          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+                        end
+    assert_migration 'db/migrate/create_flipper_tables.rb', <<~MIGRATION
+      class CreateFlipperTables < ActiveRecord::Migration#{migration_version}
+        def self.up
+          create_table :flipper_features do |t|
+            t.string :key, null: false
+            t.timestamps null: false
+          end
+          add_index :flipper_features, :key, unique: true
+
+          create_table :flipper_gates do |t|
+            t.string :feature_key, null: false
+            t.string :key, null: false
+            t.string :value
+            t.timestamps null: false
+          end
+          add_index :flipper_gates, [:feature_key, :key, :value], unique: true
+        end
+
+        def self.down
+          drop_table :flipper_gates
+          drop_table :flipper_features
+        end
+      end
+    MIGRATION
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.19.1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-20 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,35 +16,35 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
-description: ActiveRecord adapter for Flipper
+        version: '7'
+description: 
 email:
 - nunemaker@gmail.com
 executables: []
@@ -61,9 +61,10 @@ files:
 - lib/flipper/version.rb
 - lib/generators/flipper/active_record_generator.rb
 - lib/generators/flipper/templates/migration.erb
+- spec/flipper/adapters/active_record_requires_spec.rb
 - spec/flipper/adapters/active_record_spec.rb
 - test/adapters/active_record_test.rb
-- test/generators/flipper/active_record_generator_test.rb
+- test_rails/generators/flipper/active_record_generator_test.rb
 homepage: https://github.com/jnunemaker/flipper
 licenses:
 - MIT
@@ -84,12 +85,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ActiveRecord adapter for Flipper
 test_files:
+- spec/flipper/adapters/active_record_requires_spec.rb
 - spec/flipper/adapters/active_record_spec.rb
 - test/adapters/active_record_test.rb
-- test/generators/flipper/active_record_generator_test.rb

data/test/generators/flipper/active_record_generator_test.rb

@@ -1,43 +0,0 @@
-require 'helper'
-require 'active_record'
-require 'rails/generators/test_case'
-require 'generators/flipper/active_record_generator'
-
-class FlipperActiveRecordGeneratorTest < Rails::Generators::TestCase
-  tests Flipper::Generators::ActiveRecordGenerator
-  destination File.expand_path('../../../../tmp', __FILE__)
-  setup :prepare_destination
-
-  def test_generates_migration
-    run_generator
-    migration_version = if Rails::VERSION::MAJOR.to_i < 5
-                          ""
-                        else
-                          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
-                        end
-    assert_migration 'db/migrate/create_flipper_tables.rb', <<-EOM
-class CreateFlipperTables < ActiveRecord::Migration#{migration_version}
-  def self.up
-    create_table :flipper_features do |t|
-      t.string :key, null: false
-      t.timestamps null: false
-    end
-    add_index :flipper_features, :key, unique: true
-
-    create_table :flipper_gates do |t|
-      t.string :feature_key, null: false
-      t.string :key, null: false
-      t.string :value
-      t.timestamps null: false
-    end
-    add_index :flipper_gates, [:feature_key, :key, :value], unique: true
-  end
-
-  def self.down
-    drop_table :flipper_gates
-    drop_table :flipper_features
-  end
-end
-EOM
-  end
-end