feature_guard 0.1.2 → 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac443b4c9e81abf91976dd0bc5ab802b7ea2b11f
+  data.tar.gz: 5e95d160aa879d4867bd33274f035c0690c1ff22
+SHA512:
+  metadata.gz: 435e28575454290cc3da192e53a3a84c8f5c008ee504a11fe9d195774c1562e26ad3f1dee945191064d6b3c4e18ac5746c8b29813e6469aee76b6e59992005b2
+  data.tar.gz: 8d7898ad67a3b76ad8aa33767b12a1f3113114001a30798d6e5ed58a84a352fb4ad67bc60e5910170ad71f815a422d713ad352467a60e1a25bcd2869e691600e

data/README.md

@@ -60,6 +60,25 @@ FeatureGuard.allow? :my_feature
 
 The optional second argument to`.allow?` can be of any type (e.g., user ID or name or even an object). It is hashed with the feature name to create a reproducible numeric value for checking whether to return true or false based on the current ramp-up value. With no second argument, `.allow?` uses a new random value on every call.
 
+To retrieve information on all binary-enabled/disabled features, use `.all_flags`:
+
+```ruby
+FeatureGuard.enable :my_feature
+FeatureGuard.enable :another_feature
+FeatureGuard.toggle :my_feature
+FeatureGuard.all_flags
+# {"my_feature"=>false, "another_feature"=>true}
+```
+
+To retrieve information on all ramp values, use `.all_ramps`:
+
+```ruby
+FeatureGuard.set_ramp :my_feature, 50
+FeatureGuard.set_ramp :another_feature, 30
+FeatureGuard.all_ramps
+# {"my_feature"=>50.0, "another_feature"=>30.0}
+```
+
 ## Configuration
 
 Optionally change the Redis client with:

data/feature_guard.gemspec

@@ -3,7 +3,7 @@ require File.expand_path('../lib/feature_guard/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Ted Dumitrescu"]
-  gem.email         = ["miscmisc@cmme.org"]
+  gem.email         = ["webdev@cmme.org"]
   gem.summary       = %q{Simple Redis-based feature-flagging}
   gem.description   = <<end
 Feature flags made simple: turn code on or off with Redis controls, allowing
@@ -22,5 +22,5 @@ end
   gem.add_dependency "redis", "~> 3.0"
 
   gem.add_development_dependency "fakeredis", "~> 0.4"
-  gem.add_development_dependency "rspec",     "~> 2.13"
+  gem.add_development_dependency "rspec",     "~> 2.99"
 end

data/lib/feature_guard.rb

@@ -7,11 +7,30 @@ module FeatureGuard
   class << self
     attr_writer :redis
 
+    def all_flags
+      redis.hgetall(flags_hkey).keys.inject({}) { |h, f| h[f] = enabled? f; h }
+    end
+
+    def all_ramps
+      redis.hgetall(ramps_hkey).keys.inject({}) { |h, f| h[f] = ramp_val f; h }
+    end
+
+    def flags_hkey
+      "featureguard_flags"
+    end
+
+    def ramps_hkey
+      "featureguard_ramps"
+    end
+
     def redis
       @redis ||= Redis.new
     end
 
-    [:allow?, :bump_ramp, :disable, :enable, :toggle, :enabled?, :ramp_val, :set_ramp].each do |mname|
+    [
+      :allow?, :bump_ramp, :disable, :enable, :toggle, :enabled?,
+      :ramp_val, :set_ramp
+    ].each do |mname|
       define_method(mname) do |key, *args|
         Guard.new(key).send(mname, *args)
       end

data/lib/feature_guard/guard.rb

@@ -7,15 +7,15 @@ module FeatureGuard; class Guard
 
   # binary flag methods (enabled/disabled)
   def disable
-    redis.set(flag_key, 0)
+    redis.hset(FeatureGuard.flags_hkey, feature_name, 0)
   end
 
   def enable
-    redis.set(flag_key, 1)
+    redis.hset(FeatureGuard.flags_hkey, feature_name, 1)
   end
 
   def enabled?
-    redis.get(flag_key).tap { |v| return (!v.nil? && v.to_i > 0) }
+    redis.hget(FeatureGuard.flags_hkey, feature_name).tap { |v| return (!v.nil? && v.to_i > 0) }
   rescue
     false
   end
@@ -35,7 +35,7 @@ module FeatureGuard; class Guard
   end
 
   def ramp_val
-    redis.get(ramp_key).to_f
+    redis.hget(FeatureGuard.ramps_hkey, feature_name).to_f
   end
 
   def set_ramp(new_val)
@@ -43,26 +43,14 @@ module FeatureGuard; class Guard
     new_val = 100.0 if new_val > 100.0
     new_val = 0.0   if new_val < 0.0
 
-    redis.set(ramp_key, new_val)
+    redis.hset(FeatureGuard.ramps_hkey, feature_name, new_val)
     new_val
   end
 
   private
 
-  def feature_key
-    @feature_key ||= feature_name.to_s.split.join('_')
-  end
-
-  def flag_key
-    @flag_key ||= "fgf_#{feature_key}"
-  end
-
-  def ramp_key
-    @ramp_key ||= "fgr_#{feature_key}"
-  end
-
   def hashed_val(s)
-    (Digest::MD5.hexdigest("#{ramp_key}_#{s}").to_i(16) % 10000).to_f / 100.0
+    (Digest::MD5.hexdigest("#{feature_name}_#{s}").to_i(16) % 10000).to_f / 100.0
   end
 
   def random_val

data/lib/feature_guard/version.rb

@@ -1,3 +1,3 @@
 module FeatureGuard
-  VERSION = "0.1.2"
+  VERSION = "0.2.1"
 end

data/spec/feature_guard/guard_spec.rb

@@ -12,7 +12,7 @@ describe FeatureGuard::Guard do
 
       it 'uses a random value' do
         expect(guard).to receive(:random_val).and_return(29.9)
-        expect(subject).to be_true
+        expect(subject).to eq(true)
       end
     end
 
@@ -21,7 +21,7 @@ describe FeatureGuard::Guard do
 
       it 'hashes the value together with the feature name' do
         expect(guard).to receive(:hashed_val).and_return(30.1)
-        expect(subject).to be_false
+        expect(subject).to eq(false)
       end
     end
   end
@@ -42,13 +42,13 @@ describe FeatureGuard::Guard do
     subject { guard.enabled? }
 
     context 'for a non-existent flag' do
-      it { should be_false }
+      it { is_expected.to eq(false) }
     end
 
     context 'for an enabled flag' do
       before { guard.enable }
 
-      it { should be_true }
+      it { is_expected.to eq(true) }
     end
   end
 

data/spec/feature_guard_spec.rb

@@ -41,13 +41,53 @@ describe FeatureGuard do
     subject { FeatureGuard.enabled? feature }
 
     context 'for a non-existent flag' do
-      it { should be_false }
+      it { is_expected.to eq(false) }
     end
 
     context 'when the Redis client blows up or is non-existent' do
       before { FeatureGuard.stub(redis: nil) }
 
-      it { should be_false }
+      it { is_expected.to eq(false) }
+    end
+  end
+
+  describe '.all_flags' do
+    subject { FeatureGuard.all_flags }
+
+    it 'returns information on enabled flags' do
+      expect {
+        FeatureGuard.enable feature
+      }.to change {
+        FeatureGuard.all_flags
+      }.from({}).to({feature.to_s => true})
+    end
+
+    it 'returns information on multiple flags' do
+      FeatureGuard.enable feature
+      FeatureGuard.enable 'another feature'
+      expect(subject.keys.size).to eq(2)
+      expect(subject.keys).to include(feature.to_s)
+      expect(subject.keys).to include('another feature')
+    end
+  end
+
+  describe '.all_ramps' do
+    subject { FeatureGuard.all_ramps }
+
+    it 'returns information on ramped flags' do
+      expect {
+        FeatureGuard.set_ramp feature, 50
+      }.to change {
+        FeatureGuard.all_ramps
+      }.from({}).to({feature.to_s => 50.0})
+    end
+
+    it 'returns information on multiple flags' do
+      FeatureGuard.set_ramp feature, 99
+      FeatureGuard.set_ramp 'another feature', 33
+      expect(subject.keys.size).to eq(2)
+      expect(subject.keys).to include(feature.to_s)
+      expect(subject.keys).to include('another feature')
     end
   end
 end

metadata

@@ -1,57 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: feature_guard
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors:
 - Ted Dumitrescu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-01 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2164445320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2164445320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: fakeredis
-  requirement: &2164444580 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *2164444580
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2164444120 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '2.99'
   type: :development
   prerelease: false
-  version_requirements: *2164444120
-description: ! 'Feature flags made simple: turn code on or off with Redis controls,
-  allowing
-
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.99'
+description: |
+  Feature flags made simple: turn code on or off with Redis controls, allowing
   plain enabled/disabled states as well as finer-grained percentage-based control.
-
-'
 email:
-- miscmisc@cmme.org
+- webdev@cmme.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -72,30 +77,28 @@ files:
 homepage: https://github.com/tdumitrescu/feature_guard
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple Redis-based feature-flagging
 test_files:
 - spec/feature_guard/guard_spec.rb
 - spec/feature_guard_spec.rb
 - spec/spec_helper.rb
-has_rdoc: