flipper-active_record 0.7.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b25aebfea175656f0350407f74bf953e0b7299ab
+  data.tar.gz: 897ead9429ae1558099308bd21445f32642348d8
+SHA512:
+  metadata.gz: 641ae8faae41d0cef4b8f011dff325d4edad00dedfbe4daff7a32f795505ff84b70bc48960f924464a288b667848b2ae4f2aab13a39b97aecbcf2dcc28e5449b
+  data.tar.gz: 41253500ac648a0322ffd3a1e278dac7f1cc6ea5d5ac7d3e6c02eab23740952b8d91fe149b701bafcbec092d2c01d84fe4491893df39d9cadb677709e6ef6324

data/docs/active_record/README.md

@@ -0,0 +1,158 @@
+# 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:
+
+    $ 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
+# [#<Flipper::Adapters::ActiveRecord::Feature:0x007fd259b47110
+#   id: 1,
+#   key: "stats",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Feature:0x007fd259b46cd8
+#   id: 2,
+#   key: "search",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>]
+puts
+
+puts 'all rows in gates table'
+pp Flipper::Adapters::ActiveRecord::Gate.all
+# [#<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0f0f8
+#   id: 1,
+#   feature_key: "stats",
+#   key: "boolean",
+#   value: "true",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0ebd0
+#   id: 2,
+#   feature_key: "stats",
+#   key: "groups",
+#   value: "admins",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0e748
+#   id: 3,
+#   feature_key: "stats",
+#   key: "groups",
+#   value: "early_access",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0e568
+#   id: 4,
+#   feature_key: "stats",
+#   key: "actors",
+#   value: "25",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0e0b8
+#   id: 5,
+#   feature_key: "stats",
+#   key: "actors",
+#   value: "90",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0da50
+#   id: 6,
+#   feature_key: "stats",
+#   key: "actors",
+#   value: "180",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0d3c0
+#   id: 7,
+#   feature_key: "stats",
+#   key: "percentage_of_time",
+#   value: "15",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0cdf8
+#   id: 8,
+#   feature_key: "stats",
+#   key: "percentage_of_actors",
+#   value: "45",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0cbf0
+#   id: 9,
+#   feature_key: "search",
+#   key: "boolean",
+#   value: "true",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>]
+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

data/examples/active_record/basic.rb

@@ -0,0 +1,35 @@
+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)
+
+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

data/examples/active_record/internals.rb

@@ -0,0 +1,123 @@
+require '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
+# [#<Flipper::Adapters::ActiveRecord::Feature:0x007fd259b47110
+#   id: 1,
+#   key: "stats",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Feature:0x007fd259b46cd8
+#   id: 2,
+#   key: "search",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>]
+puts
+
+puts 'all rows in gates table'
+pp Flipper::Adapters::ActiveRecord::Gate.all
+# [#<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0f0f8
+#   id: 1,
+#   feature_key: "stats",
+#   key: "boolean",
+#   value: "true",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0ebd0
+#   id: 2,
+#   feature_key: "stats",
+#   key: "groups",
+#   value: "admins",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0e748
+#   id: 3,
+#   feature_key: "stats",
+#   key: "groups",
+#   value: "early_access",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0e568
+#   id: 4,
+#   feature_key: "stats",
+#   key: "actors",
+#   value: "25",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0e0b8
+#   id: 5,
+#   feature_key: "stats",
+#   key: "actors",
+#   value: "90",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0da50
+#   id: 6,
+#   feature_key: "stats",
+#   key: "actors",
+#   value: "180",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0d3c0
+#   id: 7,
+#   feature_key: "stats",
+#   key: "percentage_of_time",
+#   value: "15",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0cdf8
+#   id: 8,
+#   feature_key: "stats",
+#   key: "percentage_of_actors",
+#   value: "45",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>,
+#  #<Flipper::Adapters::ActiveRecord::Gate:0x007fd259b0cbf0
+#   id: 9,
+#   feature_key: "search",
+#   key: "boolean",
+#   value: "true",
+#   created_at: 2015-12-21 16:26:29 UTC,
+#   updated_at: 2015-12-21 16:26:29 UTC>]
+puts
+
+puts 'flipper get of feature'
+pp adapter.get(flipper[:stats])
+# flipper get of feature

data/flipper-active_record.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flipper/version', __FILE__)
+
+flipper_mongo_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"
+
+  gem.files         = `git ls-files`.split("\n").select(&flipper_mongo_files) + ["lib/flipper/version.rb"]
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_mongo_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", "< 5"
+end

data/lib/flipper-active_record.rb

@@ -0,0 +1 @@
+require 'flipper/adapters/active_record'

data/lib/flipper/adapters/active_record.rb

@@ -0,0 +1,158 @@
+require '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.select(:key).map(&:key).to_set
+      end
+
+      # Public: Adds a feature to the set of known features.
+      def add(feature)
+        attributes = {key: feature.key}
+        # race condition, but add is only used by enable/disable which happen
+        # super rarely, so it shouldn't matter in practice
+        @feature_class.where(attributes).first || @feature_class.create!(attributes)
+        true
+      end
+
+      # Public: Removes a feature from the set of known features.
+      def remove(feature)
+        @feature_class.transaction do
+          @feature_class.delete_all(key: feature.key)
+          clear(feature)
+        end
+        true
+      end
+
+      # Public: Clears the gate values for a feature.
+      def clear(feature)
+        @gate_class.delete_all(feature_key: feature.key)
+        true
+      end
+
+      # Public: Gets the values for all gates for a given feature.
+      #
+      # Returns a Hash of Flipper::Gate#key => value.
+      def get(feature)
+        result = {}
+
+        db_gates = @gate_class.where(feature_key: feature.key)
+
+        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
+
+      # 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.create!({
+            feature_key: feature.key,
+            key: gate.key,
+            value: thing.value.to_s,
+          })
+        when :set
+          @gate_class.create!({
+            feature_key: feature.key,
+            key: gate.key,
+            value: thing.value.to_s,
+          })
+        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.create!({
+            feature_key: feature.key,
+            key: gate.key,
+            value: thing.value.to_s,
+          })
+        when :set
+          @gate_class.delete_all(feature_key: feature.key, key: gate.key, value: thing.value)
+        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
+    end
+  end
+end

data/lib/flipper/version.rb

@@ -0,0 +1,3 @@
+module Flipper
+  VERSION = "0.7.3"
+end

data/lib/generators/flipper/active_record_generator.rb

@@ -0,0 +1,20 @@
+require "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

data/spec/flipper/adapters/active_record_spec.rb

@@ -0,0 +1,29 @@
+require '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

data/test/generators/flipper/active_record_generator_test.rb

@@ -0,0 +1,38 @@
+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
+    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

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: flipper-active_record
+version: !ruby/object:Gem::Version
+  version: 0.7.3
+platform: ruby
+authors:
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flipper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: ActiveRecord adapter for Flipper
+email:
+- nunemaker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- docs/active_record/README.md
+- examples/active_record/basic.rb
+- examples/active_record/internals.rb
+- flipper-active_record.gemspec
+- lib/flipper-active_record.rb
+- lib/flipper/adapters/active_record.rb
+- lib/flipper/version.rb
+- lib/generators/flipper/active_record_generator.rb
+- spec/flipper/adapters/active_record_spec.rb
+- test/generators/flipper/active_record_generator_test.rb
+homepage: https://github.com/jnunemaker/flipper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveRecord adapter for Flipper
+test_files:
+- spec/flipper/adapters/active_record_spec.rb
+- test/generators/flipper/active_record_generator_test.rb