flipper-sequel 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df1b81f95974a8a3031d8eec88dab17e58a431d6
+  data.tar.gz: ce60bc0a29724c2ffe4792cddc7dd5288846674d
+SHA512:
+  metadata.gz: 8ba64fd21841b4a4aa4df29b065d7b3bfbc06948d83d3645a6fee421401847f9c8ac70864c264983db625bd8cd441301edde1a4c62b517bc700248e537028266
+  data.tar.gz: ce08d6d9f7f6cc3f8686fa1f29b803f5afbb61a3b75f87a11facc91fdd675a79e5017aa0979967366f71bb9b4dabafa028d6b8e2c99fbb465c43676ca760f04a

data/docs/sequel/README.md

@@ -0,0 +1,98 @@
+# Flipper Sequel
+
+A Sequel adapter for [Flipper](https://github.com/jnunemaker/flipper).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flipper-sequel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install flipper-sequel
+
+## Usage
+
+For your convenience, a sequel migration is provided to create the necessary tables. This migration will create two database tables - flipper_features and flipper_gates.
+
+```ruby
+require 'generators/flipper/templates/sequel_migration'
+CreateFlipperTablesSequel.new(Sequel::Model.db).up
+```
+
+Once you have created and executed the migration, you can use the sequel adapter like so:
+
+```ruby
+require 'flipper/adapters/sequel'
+adapter = Flipper::Adapters::Sequel.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/sequel'
+adapter = Flipper::Adapters::Sequel.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::Sequel::Feature.all
+#[#<Flipper::Adapters::Sequel::Feature @values={:key=>"stats", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+# #<Flipper::Adapters::Sequel::Feature @values={:key=>"search", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>]
+puts
+
+puts 'all rows in gates table'
+pp Flipper::Adapters::Sequel::Gate.all
+# [#<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"boolean", :value=>"true", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"groups", :value=>"admins", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"groups", :value=>"early_access", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"actors", :value=>"25", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"actors", :value=>"90", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"actors", :value=>"180", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"percentage_of_time", :value=>"15", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"percentage_of_actors", :value=>"45", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"search", :key=>"boolean", :value=>"true", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>]
+puts
+
+puts 'flipper get of feature'
+pp adapter.get(flipper[:stats])
+# {:boolean=>"true",
+#  :groups=>#<Set: {"admins", "early_access"}>,
+#  :actors=>#<Set: {"180", "25", "90"}>,
+#  :percentage_of_actors=>"45",
+#  :percentage_of_time=>"15"}
+```
+
+## 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/sequel/basic.rb

@@ -0,0 +1,33 @@
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'sequel'
+Sequel::Model.db =  Sequel.sqlite(':memory:')
+Sequel.extension :migration, :core_extensions
+
+require 'generators/flipper/templates/sequel_migration'
+CreateFlipperTablesSequel.new(Sequel::Model.db).up
+
+require 'flipper/adapters/sequel'
+adapter = Flipper::Adapters::Sequel.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/sequel/internals.rb

@@ -0,0 +1,63 @@
+require 'pp'
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'sequel'
+Sequel::Model.db =  Sequel.sqlite(':memory:')
+Sequel.extension :migration, :core_extensions
+
+require 'generators/flipper/templates/sequel_migration'
+CreateFlipperTablesSequel.new(Sequel::Model.db).up
+
+require 'flipper/adapters/sequel'
+adapter = Flipper::Adapters::Sequel.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::Sequel::Feature.all
+#[#<Flipper::Adapters::Sequel::Feature @values={:key=>"stats", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+# #<Flipper::Adapters::Sequel::Feature @values={:key=>"search", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>]
+puts
+
+puts 'all rows in gates table'
+pp Flipper::Adapters::Sequel::Gate.all
+# [#<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"boolean", :value=>"true", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"groups", :value=>"admins", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"groups", :value=>"early_access", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"actors", :value=>"25", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"actors", :value=>"90", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"actors", :value=>"180", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"percentage_of_time", :value=>"15", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"stats", :key=>"percentage_of_actors", :value=>"45", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>,
+#  #<Flipper::Adapters::Sequel::Gate @values={:feature_key=>"search", :key=>"boolean", :value=>"true", :created_at=>2016-11-19 13:57:48 -0500, :updated_at=>2016-11-19 13:57:48 -0500}>]
+puts
+
+puts 'flipper get of feature'
+pp adapter.get(flipper[:stats])
+# {:boolean=>"true",
+#  :groups=>#<Set: {"admins", "early_access"}>,
+#  :actors=>#<Set: {"180", "25", "90"}>,
+#  :percentage_of_actors=>"45",
+#  :percentage_of_time=>"15"}

data/flipper-sequel.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/flipper/version', __FILE__)
+
+flipper_sequel_files = lambda { |file| file =~ /sequel/ }
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["John Nunemaker"]
+  gem.email         = ["nunemaker@gmail.com"]
+  gem.summary       = "Sequel adapter for Flipper"
+  gem.description   = "Sequel adapter for Flipper"
+  gem.license       = "MIT"
+  gem.homepage      = "https://github.com/jnunemaker/flipper"
+
+  extra_files = [
+    "lib/flipper/version.rb",
+  ]
+  gem.files         = `git ls-files`.split("\n").select(&flipper_sequel_files) + extra_files
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n").select(&flipper_sequel_files)
+  gem.name          = "flipper-sequel"
+  gem.require_paths = ["lib"]
+  gem.version       = Flipper::VERSION
+
+  gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
+  gem.add_dependency 'sequel', ">= 4.0.0", "< 5"
+end

data/lib/flipper-sequel.rb

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

data/lib/flipper/adapters/sequel.rb

@@ -0,0 +1,167 @@
+require 'set'
+require 'flipper'
+require 'sequel'
+
+module Flipper
+  module Adapters
+    class Sequel
+      include ::Flipper::Adapter
+
+      # Private: Do not use outside of this adapter.
+      class Feature < ::Sequel::Model(:flipper_features)
+        plugin :timestamps, update_on_create: true
+      end
+
+      # Private: Do not use outside of this adapter.
+      class Gate < ::Sequel::Model(:flipper_gates)
+        plugin :timestamps, update_on_create: true
+      end
+
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Public: Initialize a new Sequel 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, :sequel)
+        @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
+        @feature_class.find_or_create(key: feature.key.to_s)
+        true
+      end
+
+      # Public: Removes a feature from the set of known features.
+      def remove(feature)
+        @feature_class.db.transaction do
+          @feature_class.where(key: feature.key.to_s).delete
+          clear(feature)
+        end
+        true
+      end
+
+      # Public: Clears the gate values for a feature.
+      def clear(feature)
+        @gate_class.where(feature_key: feature.key.to_s).delete
+        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.to_s).all
+
+        feature.gates.each_with_object({}) do |gate, result|
+          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
+      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.db.transaction do
+            args = {
+              feature_key: feature.key,
+              key: gate.key.to_s
+            }
+            @gate_class.where(args).delete
+
+            @gate_class.create(gate_attrs(feature, gate, thing))
+          end
+        when :set
+          @gate_class.create(gate_attrs(feature, gate, thing))
+        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.db.transaction do
+            args = {
+              feature_key: feature.key.to_s,
+              key: gate.key.to_s
+            }
+            @gate_class.where(args).delete
+
+            @gate_class.create(gate_attrs(feature, gate, thing))
+          end
+        when :set
+          @gate_class.where(gate_attrs(feature, gate, thing))
+                     .delete
+        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
+
+      def gate_attrs(feature, gate, thing)
+        {
+          feature_key: feature.key.to_s,
+          key: gate.key.to_s,
+          value: thing.value.to_s
+        }
+      end
+    end
+  end
+end

data/lib/flipper/version.rb

@@ -0,0 +1,3 @@
+module Flipper
+  VERSION = "0.10.0".freeze
+end

data/lib/generators/flipper/templates/sequel_migration.rb

@@ -0,0 +1,24 @@
+class CreateFlipperTablesSequel < Sequel::Migration
+  def up
+    create_table :flipper_features do |t|
+      String :key, null: false
+      DateTime :created_at, null: false
+      DateTime :updated_at, null: false
+    end
+    add_index :flipper_features, :key, unique: true
+
+    create_table :flipper_gates do |t|
+      String :feature_key, null: false
+      String :key, null: false
+      String :value
+      DateTime :created_at, null: false
+      DateTime :updated_at, null: false
+    end
+    add_index :flipper_gates, [:feature_key, :key, :value], unique: true
+  end
+
+  def down
+    drop_table :flipper_gates
+    drop_table :flipper_features
+  end
+end

data/spec/flipper/adapters/sequel_spec.rb

@@ -0,0 +1,31 @@
+require 'helper'
+require 'sequel'
+
+Sequel::Model.db =  Sequel.sqlite(':memory:')
+Sequel.extension :migration, :core_extensions
+
+require 'flipper/adapters/sequel'
+require 'generators/flipper/templates/sequel_migration'
+require 'flipper/spec/shared_adapter_specs'
+
+RSpec.describe Flipper::Adapters::Sequel do
+  subject do
+    described_class.new(feature_class: feature_class,
+                        gate_class: gate_class)
+  end
+
+  let(:feature_class) { Flipper::Adapters::Sequel::Feature }
+  let(:gate_class) { Flipper::Adapters::Sequel::Gate }
+
+  before(:each) do
+    CreateFlipperTablesSequel.new(Sequel::Model.db).up
+    feature_class.dataset = feature_class.dataset
+    gate_class.dataset = gate_class.dataset
+  end
+
+  after(:each) do
+    CreateFlipperTablesSequel.new(Sequel::Model.db).down
+  end
+
+  it_should_behave_like 'a flipper adapter'
+end

data/test/adapters/sequel_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+require 'sequel'
+
+Sequel::Model.db =  Sequel.sqlite(':memory:')
+Sequel.extension :migration, :core_extensions
+
+require 'flipper/adapters/sequel'
+require 'generators/flipper/templates/sequel_migration'
+
+class SequelTest < MiniTest::Test
+  prepend Flipper::Test::SharedAdapterTests
+
+  def feature_class
+    Flipper::Adapters::Sequel::Feature
+  end
+
+  def gate_class
+    Flipper::Adapters::Sequel::Gate
+  end
+
+  def setup
+    CreateFlipperTablesSequel.new(Sequel::Model.db).up
+    feature_class.dataset = feature_class.dataset
+    gate_class.dataset = gate_class.dataset
+    @adapter = Flipper::Adapters::Sequel.new
+  end
+
+  def teardown
+    CreateFlipperTablesSequel.new(Sequel::Model.db).down
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: flipper-sequel
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+platform: ruby
+authors:
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flipper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Sequel adapter for Flipper
+email:
+- nunemaker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- docs/sequel/README.md
+- examples/sequel/basic.rb
+- examples/sequel/internals.rb
+- flipper-sequel.gemspec
+- lib/flipper-sequel.rb
+- lib/flipper/adapters/sequel.rb
+- lib/flipper/version.rb
+- lib/generators/flipper/templates/sequel_migration.rb
+- spec/flipper/adapters/sequel_spec.rb
+- test/adapters/sequel_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: Sequel adapter for Flipper
+test_files:
+- spec/flipper/adapters/sequel_spec.rb
+- test/adapters/sequel_test.rb