flipper-redis 0.3.0 → 0.5.0

data/Gemfile

@@ -1,9 +1,9 @@
 source 'https://rubygems.org'
 gemspec
 
+gem 'redis-namespace', :require => false
 gem 'rake'
 gem 'rspec'
-gem 'redis'
 
 group(:guard) do
   gem 'guard'

data/README.md

@@ -1,6 +1,6 @@
 # Flipper Redis
 
-A redis adapter for [Flipper](https://github.com/jnunemaker/flipper), the feature flipping gems.
+A [Redis](https://github.com/redis/redis-rb) adapter for [Flipper](https://github.com/jnunemaker/flipper).
 
 ## Installation
 
@@ -26,6 +26,72 @@ flipper = Flipper.new(adapter)
 # profit...
 ```
 
+## Internals
+
+Each feature is stored in a redis hash, which means getting a feature is single query.
+
+```ruby
+require 'flipper/adapters/redis'
+require 'redis/namespace'
+
+client = Redis.new
+namespaced_client = Redis::Namespace.new(:flipper, :redis => client)
+adapter = Flipper::Adapters::Redis.new(namespaced_client)
+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 flipper.group(:admins)
+flipper[:stats].enable flipper.group(:early_access)
+flipper[:stats].enable User.new('25')
+flipper[:stats].enable User.new('90')
+flipper[:stats].enable User.new('180')
+flipper[:stats].enable flipper.random(15)
+flipper[:stats].enable flipper.actors(45)
+
+flipper[:search].enable
+
+print 'all keys: '
+pp namespaced_client.keys
+# all keys: ["stats", "flipper_features", "search"]
+
+print "known flipper features: "
+pp namespaced_client.smembers("flipper_features")
+# known flipper features: ["stats", "search"]
+
+puts 'stats keys'
+pp namespaced_client.hgetall('stats')
+# stats keys
+# {"boolean"=>"true",
+#  "groups/admins"=>"1",
+#  "actors/25"=>"1",
+#  "percentage_of_random"=>"15",
+#  "percentage_of_actors"=>"45",
+#  "groups/early_access"=>"1",
+#  "actors/90"=>"1",
+#  "actors/180"=>"1"}
+
+puts 'search keys'
+pp namespaced_client.hgetall('search')
+# search keys
+# {"boolean"=>"true"}
+
+puts 'flipper get of feature'
+pp adapter.get(flipper[:stats])
+# flipper get of feature
+# {:boolean=>"true",
+#  :groups=>#<Set: {"admins", "early_access"}>,
+#  :actors=>#<Set: {"25", "90", "180"}>,
+#  :percentage_of_actors=>"45",
+#  :percentage_of_random=>"15"}
+```
+
 ## Contributing
 
 1. Fork it

data/examples/basic.rb

@@ -0,0 +1,27 @@
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'flipper/adapters/redis'
+client = Redis.new
+adapter = Flipper::Adapters::Redis.new(client)
+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/internals.rb

@@ -0,0 +1,71 @@
+require 'pp'
+require 'pathname'
+require 'logger'
+
+root_path = Pathname(__FILE__).dirname.join('..').expand_path
+lib_path  = root_path.join('lib')
+$:.unshift(lib_path)
+
+require 'flipper/adapters/redis'
+require 'redis/namespace'
+
+client = Redis.new
+namespaced_client = Redis::Namespace.new(:flipper, :redis => client)
+adapter = Flipper::Adapters::Redis.new(namespaced_client)
+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 flipper.group(:admins)
+flipper[:stats].enable flipper.group(:early_access)
+flipper[:stats].enable User.new('25')
+flipper[:stats].enable User.new('90')
+flipper[:stats].enable User.new('180')
+flipper[:stats].enable flipper.random(15)
+flipper[:stats].enable flipper.actors(45)
+
+flipper[:search].enable
+
+print 'all keys: '
+pp namespaced_client.keys
+# all keys: ["stats", "flipper_features", "search"]
+puts
+
+print "known flipper features: "
+pp namespaced_client.smembers("flipper_features")
+# known flipper features: ["stats", "search"]
+puts
+
+puts 'stats keys'
+pp namespaced_client.hgetall('stats')
+# stats keys
+# {"boolean"=>"true",
+#  "groups/admins"=>"1",
+#  "actors/25"=>"1",
+#  "percentage_of_random"=>"15",
+#  "percentage_of_actors"=>"45",
+#  "groups/early_access"=>"1",
+#  "actors/90"=>"1",
+#  "actors/180"=>"1"}
+puts
+
+puts 'search keys'
+pp namespaced_client.hgetall('search')
+# search keys
+# {"boolean"=>"true"}
+puts
+
+puts 'flipper get of feature'
+pp adapter.get(flipper[:stats])
+# flipper get of feature
+# {:boolean=>"true",
+#  :groups=>#<Set: {"admins", "early_access"}>,
+#  :actors=>#<Set: {"25", "90", "180"}>,
+#  :percentage_of_actors=>"45",
+#  :percentage_of_random=>"15"}

data/flipper-redis.gemspec

@@ -2,17 +2,19 @@
 require File.expand_path('../lib/flipper/adapters/redis/version', __FILE__)
 
 Gem::Specification.new do |gem|
+  gem.name          = "flipper-redis"
+  gem.version       = Flipper::Adapters::Redis::VERSION
   gem.authors       = ["John Nunemaker"]
   gem.email         = ["nunemaker@gmail.com"]
   gem.description   = %q{Redis adapter for Flipper}
   gem.summary       = %q{Redis adapter for Flipper}
   gem.homepage      = "http://jnunemaker.github.com/flipper-redis"
-
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.name          = "flipper-redis"
   gem.require_paths = ["lib"]
-  gem.version       = Flipper::Adapters::Redis::VERSION
-  gem.add_dependency 'flipper', '~> 0.4'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.add_dependency 'flipper', '~> 0.5.0'
+  gem.add_dependency 'redis', '~> 3.0.0'
 end

data/lib/flipper-redis.rb

@@ -1,2 +1 @@
-require 'flipper'
 require 'flipper/adapters/redis'

data/lib/flipper/adapters/redis.rb

@@ -1,35 +1,126 @@
 require 'set'
 require 'redis'
+require 'flipper'
 
 module Flipper
   module Adapters
     class Redis
+      include Flipper::Adapter
+
+      # Private: The key that stores the set of known features.
+      FeaturesKey = :flipper_features
+
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Public: Initializes a Redis flipper adapter.
+      #
+      # client - The Redis client to use. Feel free to namespace it.
       def initialize(client)
         @client = client
+        @name = :redis
+      end
+
+      # Public: Gets the values for all gates for a given feature.
+      #
+      # Returns a Hash of Flipper::Gate#key => value.
+      def get(feature)
+        result = {}
+        doc = doc_for(feature)
+        fields = doc.keys
+
+        feature.gates.each do |gate|
+          result[gate.key] = case gate.data_type
+          when :boolean, :integer
+            doc[gate.key.to_s]
+          when :set
+            fields_to_gate_value fields, gate
+          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
+          @client.hset feature.key, gate.key, thing.value.to_s
+        when :set
+          @client.hset feature.key, to_field(gate, thing), 1
+        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
+          @client.del feature.key
+        when :integer
+          @client.hset feature.key, gate.key, thing.value.to_s
+        when :set
+          @client.hdel feature.key, to_field(gate, thing)
+        else
+          unsupported_data_type gate.data_type
+        end
+
+        true
       end
 
-      def read(key)
-        @client.get key.to_s
+      # Public: Adds a feature to the set of known features.
+      def add(feature)
+        @client.sadd FeaturesKey, feature.name
+        true
       end
 
-      def write(key, value)
-        @client.set key.to_s, value.to_s
+      # Public: The set of known features.
+      def features
+        @client.smembers(FeaturesKey).to_set
       end
 
-      def delete(key)
-        @client.del key.to_s
+      # Private: Gets a hash of fields => values for the given feature.
+      #
+      # Returns a Hash of fields => values.
+      def doc_for(feature)
+        @client.hgetall(feature.key)
       end
 
-      def set_add(key, value)
-        @client.sadd(key.to_s, value.to_s)
+      # Private: Converts gate and thing to hash key.
+      def to_field(gate, thing)
+        "#{gate.key}/#{thing.value}"
       end
 
-      def set_delete(key, value)
-        @client.srem(key.to_s, value.to_s)
+      # Private: Returns a set of values given an array of fields and a gate.
+      #
+      # Returns a Set of the values enabled for the gate.
+      def fields_to_gate_value(fields, gate)
+        regex = /^#{Regexp.escape(gate.key)}\//
+        keys = fields.grep(regex)
+        values = keys.map { |key| key.split('/', 2).last }
+        values.to_set
       end
 
-      def set_members(key)
-        @client.smembers(key.to_s).to_set
+      # Private
+      def unsupported_data_type(data_type)
+        raise "#{data_type} is not supported by this adapter"
       end
     end
   end

data/lib/flipper/adapters/redis/version.rb

@@ -1,7 +1,7 @@
 module Flipper
   module Adapters
     class Redis
-      VERSION = "0.3.0"
+      VERSION = "0.5.0"
     end
   end
 end

data/spec/flipper/redis_spec.rb

@@ -5,32 +5,11 @@ require 'flipper/spec/shared_adapter_specs'
 describe Flipper::Adapters::Redis do
   let(:client) { Redis.new }
 
-  subject { Flipper::Adapters::Redis.new(client) }
+  subject { described_class.new(client) }
 
   before do
     client.flushdb
   end
 
-  def read_key(key)
-    client.get key.to_s
-  rescue RuntimeError => e
-    if e.message =~ /wrong kind of value/
-      client.smembers(key.to_s).to_set
-    else
-      raise
-    end
-  end
-
-  def write_key(key, value)
-    case value
-    when Array, Set
-      value.each do |member|
-        client.sadd key.to_s, member.to_s
-      end
-    else
-      client.set key.to_s, value.to_s
-    end
-  end
-
   it_should_behave_like 'a flipper adapter'
 end

data/spec/helper.rb

@@ -22,4 +22,5 @@ RSpec.configure do |config|
   config.alias_example_to :fit, :focused => true
   config.alias_example_to :xit, :pending => true
   config.run_all_when_everything_filtered = true
+  config.fail_fast = true
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flipper-redis
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: Redis adapter for Flipper
 email:
 - nunemaker@gmail.com
@@ -41,6 +57,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/basic.rb
+- examples/internals.rb
 - flipper-redis.gemspec
 - lib/flipper-redis.rb
 - lib/flipper/adapters/redis.rb
@@ -61,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1698098931398913105
+      hash: -1629782830808389875
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -70,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1698098931398913105
+      hash: -1629782830808389875
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23