flipper-active-record-0.10.2/0000755000175000017500000000000013154730657015017 5ustar pravipraviflipper-active-record-0.10.2/examples/0000755000175000017500000000000013154730657016635 5ustar pravipraviflipper-active-record-0.10.2/examples/active_record/0000755000175000017500000000000013154730657021446 5ustar pravipraviflipper-active-record-0.10.2/examples/active_record/basic.rb0000644000175000017500000000122513154730657023054 0ustar pravipravirequire 'pathname' require 'logger' root_path = Pathname(__FILE__).dirname.join('..').expand_path lib_path = root_path.join('lib') $:.unshift(lib_path) require 'active_record' ActiveRecord::Base.establish_connection({ adapter: 'sqlite3', database: ':memory:', }) require 'generators/flipper/templates/migration' CreateFlipperTables.up require 'flipper/adapters/active_record' adapter = Flipper::Adapters::ActiveRecord.new flipper = Flipper.new(adapter) flipper[:stats].enable if flipper[:stats].enabled? puts "Enabled!" else puts "Disabled!" end flipper[:stats].disable if flipper[:stats].enabled? puts "Enabled!" else puts "Disabled!" end flipper-active-record-0.10.2/examples/active_record/internals.rb0000644000175000017500000000711613154730657023777 0ustar pravipravirequire 'pp' require 'pathname' require 'logger' root_path = Pathname(__FILE__).dirname.join('..').expand_path lib_path = root_path.join('lib') $:.unshift(lib_path) require 'active_record' ActiveRecord::Base.establish_connection({ adapter: 'sqlite3', database: ':memory:', }) require 'generators/flipper/templates/migration' CreateFlipperTables.up require 'flipper/adapters/active_record' adapter = Flipper::Adapters::ActiveRecord.new flipper = Flipper.new(adapter) # Register a few groups. Flipper.register(:admins) { |thing| thing.admin? } Flipper.register(:early_access) { |thing| thing.early_access? } # Create a user class that has flipper_id instance method. User = Struct.new(:flipper_id) flipper[:stats].enable flipper[:stats].enable_group :admins flipper[:stats].enable_group :early_access flipper[:stats].enable_actor User.new('25') flipper[:stats].enable_actor User.new('90') flipper[:stats].enable_actor User.new('180') flipper[:stats].enable_percentage_of_time 15 flipper[:stats].enable_percentage_of_actors 45 flipper[:search].enable puts 'all rows in features table' pp Flipper::Adapters::ActiveRecord::Feature.all # [#, # #] puts puts 'all rows in gates table' pp Flipper::Adapters::ActiveRecord::Gate.all # [#, # #, # #, # #, # #, # #, # #, # #, # #] puts puts 'flipper get of feature' pp adapter.get(flipper[:stats]) # flipper get of feature flipper-active-record-0.10.2/flipper-active_record.gemspec0000644000175000017500000000201213154730657022627 0ustar pravipravi# -*- encoding: utf-8 -*- require File.expand_path('../lib/flipper/version', __FILE__) flipper_active_record_files = lambda { |file| file =~ /active_record/ } 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" extra_files = [ "lib/generators/flipper/templates/migration.rb", "lib/flipper/version.rb", ] gem.files = `git ls-files`.split("\n").select(&flipper_active_record_files) + extra_files gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_active_record_files) gem.name = "flipper-active_record" gem.require_paths = ["lib"] gem.version = Flipper::VERSION gem.add_dependency 'flipper', "~> #{Flipper::VERSION}" gem.add_dependency 'activerecord', ">= 3.2", "< 6" end flipper-active-record-0.10.2/lib/0000755000175000017500000000000013154730657015565 5ustar pravipraviflipper-active-record-0.10.2/lib/flipper-active_record.rb0000644000175000017500000000013013154730657022354 0ustar pravipraviActiveSupport.on_load(:active_record) do require 'flipper/adapters/active_record' end flipper-active-record-0.10.2/lib/flipper/0000755000175000017500000000000013154730657017226 5ustar pravipraviflipper-active-record-0.10.2/lib/flipper/version.rb0000644000175000017500000000005713154730657021242 0ustar pravipravimodule Flipper VERSION = "0.10.2".freeze end flipper-active-record-0.10.2/lib/flipper/adapters/0000755000175000017500000000000013154730657021031 5ustar pravipraviflipper-active-record-0.10.2/lib/flipper/adapters/active_record.rb0000644000175000017500000001310413154730657024166 0ustar pravipravirequire 'set' require 'flipper' require 'active_record' module Flipper module Adapters class ActiveRecord include ::Flipper::Adapter # Private: Do not use outside of this adapter. class Feature < ::ActiveRecord::Base self.table_name = "flipper_features" end # Private: Do not use outside of this adapter. class Gate < ::ActiveRecord::Base self.table_name = "flipper_gates" end # Public: The name of the adapter. attr_reader :name # Public: Initialize a new ActiveRecord adapter instance. # # name - The Symbol name for this adapter. Optional (default :active_record) # feature_class - The AR class responsible for the features table. # gate_class - The AR class responsible for the gates table. # # Allowing the overriding of name is so you can differentiate multiple # instances of this adapter from each other, if, for some reason, that is # a thing you do. # # Allowing the overriding of the default feature/gate classes means you # can roll your own tables and what not, if you so desire. def initialize(options = {}) @name = options.fetch(:name, :active_record) @feature_class = options.fetch(:feature_class) { Feature } @gate_class = options.fetch(:gate_class) { Gate } end # Public: The set of known features. def features @feature_class.all.map(&:key).to_set end # 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 unless @feature_class.where(key: feature.key).first @feature_class.create! { |f| f.key = feature.key } end true end # Public: Removes a feature from the set of known features. def remove(feature) @feature_class.transaction do @feature_class.where(key: feature.key).delete_all clear(feature) end true end # Public: Clears the gate values for a feature. def clear(feature) @gate_class.where(feature_key: feature.key).delete_all true end # Public: Gets the values for all gates for a given feature. # # Returns a Hash of Flipper::Gate#key => value. def get(feature) db_gates = @gate_class.where(feature_key: feature.key) result_for_feature(feature, db_gates) end def get_multi(features) db_gates = @gate_class.where(feature_key: features.map(&:key)) grouped_db_gates = db_gates.group_by { |gate| gate.feature_key } result = {} features.each do |feature| result[feature.key] = result_for_feature(feature, grouped_db_gates[feature.key]) end result end # Public: Enables a gate for a given thing. # # feature - The Flipper::Feature for the gate. # gate - The Flipper::Gate to disable. # thing - The Flipper::Type being disabled for the gate. # # Returns true. def enable(feature, gate, thing) case gate.data_type when :boolean, :integer @gate_class.transaction do @gate_class.where( feature_key: feature.key, key: gate.key ).delete_all @gate_class.create! do |g| g.feature_key = feature.key g.key = gate.key g.value = thing.value.to_s end end when :set @gate_class.create! do |g| g.feature_key = feature.key g.key = gate.key g.value = thing.value.to_s end else unsupported_data_type gate.data_type end true end # Public: Disables a gate for a given thing. # # feature - The Flipper::Feature for the gate. # gate - The Flipper::Gate to disable. # thing - The Flipper::Type being disabled for the gate. # # Returns true. def disable(feature, gate, thing) case gate.data_type when :boolean clear(feature) when :integer @gate_class.transaction do @gate_class.where( feature_key: feature.key, key: gate.key ).delete_all @gate_class.create! do |g| g.feature_key = feature.key g.key = gate.key g.value = thing.value.to_s end end when :set @gate_class.where(feature_key: feature.key, key: gate.key, value: thing.value).delete_all else unsupported_data_type gate.data_type end true end # Private def unsupported_data_type(data_type) raise "#{data_type} is not supported by this adapter" end private def result_for_feature(feature, db_gates) db_gates ||= [] result = {} feature.gates.each do |gate| 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 end when :integer if db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s } db_gate.value end when :set db_gates.select { |db_gate| db_gate.key == gate.key.to_s }.map(&:value).to_set else unsupported_data_type gate.data_type end end result end end end end flipper-active-record-0.10.2/lib/generators/0000755000175000017500000000000013154730657017736 5ustar pravipraviflipper-active-record-0.10.2/lib/generators/flipper/0000755000175000017500000000000013154730657021377 5ustar pravipraviflipper-active-record-0.10.2/lib/generators/flipper/active_record_generator.rb0000644000175000017500000000107713154730657026610 0ustar pravipravirequire "rails/generators/active_record" module Flipper module Generators class ActiveRecordGenerator < ::Rails::Generators::Base include ::Rails::Generators::Migration desc "Generates migration for flipper tables" source_paths << File.join(File.dirname(__FILE__), "templates") def create_migration_file migration_template "migration.rb", "db/migrate/create_flipper_tables.rb" end def self.next_migration_number(dirname) ::ActiveRecord::Generators::Base.next_migration_number(dirname) end end end end flipper-active-record-0.10.2/lib/generators/flipper/templates/0000755000175000017500000000000013154730657023375 5ustar pravipraviflipper-active-record-0.10.2/lib/generators/flipper/templates/migration.rb0000644000175000017500000000110013154730657025703 0ustar pravipraviclass CreateFlipperTables < ActiveRecord::Migration 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 flipper-active-record-0.10.2/spec/0000755000175000017500000000000013154730657015751 5ustar pravipraviflipper-active-record-0.10.2/spec/flipper/0000755000175000017500000000000013154730657017412 5ustar pravipraviflipper-active-record-0.10.2/spec/flipper/adapters/0000755000175000017500000000000013154730657021215 5ustar pravipraviflipper-active-record-0.10.2/spec/flipper/adapters/active_record_spec.rb0000644000175000017500000000113513154730657025365 0ustar pravipravirequire 'helper' require 'flipper/adapters/active_record' require 'flipper/spec/shared_adapter_specs' # Turn off migration logging for specs ActiveRecord::Migration.verbose = false require 'generators/flipper/templates/migration' RSpec.describe Flipper::Adapters::ActiveRecord do subject { described_class.new } before(:all) do ActiveRecord::Base.establish_connection({ adapter: "sqlite3", database: ":memory:", }) end before(:each) do CreateFlipperTables.up end after(:each) do CreateFlipperTables.down end it_should_behave_like 'a flipper adapter' end flipper-active-record-0.10.2/test/0000755000175000017500000000000013154730657015776 5ustar pravipraviflipper-active-record-0.10.2/test/adapters/0000755000175000017500000000000013154730657017601 5ustar pravipraviflipper-active-record-0.10.2/test/adapters/active_record_test.rb0000644000175000017500000000102113154730657023770 0ustar pravipravirequire 'test_helper' require 'flipper/adapters/active_record' require 'generators/flipper/templates/migration' # Turn off migration logging for specs ActiveRecord::Migration.verbose = false class ActiveRecordTest < MiniTest::Test prepend Flipper::Test::SharedAdapterTests ActiveRecord::Base.establish_connection({ adapter: "sqlite3", database: ":memory:", }) def setup @adapter = Flipper::Adapters::ActiveRecord.new CreateFlipperTables.up end def teardown CreateFlipperTables.down end end flipper-active-record-0.10.2/test/generators/0000755000175000017500000000000013154730657020147 5ustar pravipraviflipper-active-record-0.10.2/test/generators/flipper/0000755000175000017500000000000013154730657021610 5ustar pravipraviflipper-active-record-0.10.2/test/generators/flipper/active_record_generator_test.rb0000644000175000017500000000203013154730657030046 0ustar pravipravirequire '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 assert_migration "db/migrate/create_flipper_tables.rb", <<-EOM class CreateFlipperTables < ActiveRecord::Migration 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 flipper-active-record-0.10.2/docs/0000755000175000017500000000000013154730657015747 5ustar pravipraviflipper-active-record-0.10.2/docs/active_record/0000755000175000017500000000000013154730657020560 5ustar pravipraviflipper-active-record-0.10.2/docs/active_record/README.md0000644000175000017500000001077513154730657022051 0ustar pravipravi# Flipper ActiveRecord An ActiveRecord adapter for [Flipper](https://github.com/jnunemaker/flipper). Supported Active Record versions: * 3.2.x * 4.2.x ## Installation Add this line to your application's Gemfile: gem 'flipper-active_record' And then execute: $ bundle Or install it yourself with: $ gem install flipper-active_record ## Usage For your convenience a migration generator is provided to create the necessary migrations for using the active record adapter. By default this generates a migration that will create two database tables - flipper_features and flipper_gates. $ rails g flipper:active_record Once you have created and executed the migration, you can use the active record adapter like so: ```ruby require 'flipper/adapters/active_record' adapter = Flipper::Adapters::ActiveRecord.new flipper = Flipper.new(adapter) # profit... ``` ## 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. ```ruby require 'flipper/adapters/active_record' adapter = Flipper::Adapters::ActiveRecord.new flipper = Flipper.new(adapter) # Register a few groups. Flipper.register(:admins) { |thing| thing.admin? } Flipper.register(:early_access) { |thing| thing.early_access? } # Create a user class that has flipper_id instance method. User = Struct.new(:flipper_id) flipper[:stats].enable flipper[:stats].enable_group :admins flipper[:stats].enable_group :early_access flipper[:stats].enable_actor User.new('25') flipper[:stats].enable_actor User.new('90') flipper[:stats].enable_actor User.new('180') flipper[:stats].enable_percentage_of_time 15 flipper[:stats].enable_percentage_of_actors 45 flipper[:search].enable puts 'all rows in features table' pp Flipper::Adapters::ActiveRecord::Feature.all # [#, # #] puts puts 'all rows in gates table' pp Flipper::Adapters::ActiveRecord::Gate.all # [#, # #, # #, # #, # #, # #, # #, # #, # #] puts puts 'flipper get of feature' pp adapter.get(flipper[:stats]) # flipper get of feature ``` ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Added some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request