flag 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d92ca5beee75e55334375129bf62b0836adf5f7
-  data.tar.gz: 868a270b5142903ef440f22fd6385a380fcc4bf3
+  metadata.gz: aaf08d31ce04248717ab95bcb04f05e040c9dad9
+  data.tar.gz: 7bcf051376520b23c40e8d2b80d2539cdad47567
 SHA512:
-  metadata.gz: c8f3b6480ce579aa163eea68559385b6790bd02072fc08089a8bc26d6aca6e18b6e45a53920c7a6ad3cd45353b5a6cd5b353d1a0cb8a0508d730faa8b0a49020
-  data.tar.gz: 7b064e5d80901a1b77d80b50f74cea3c91a681b089d570f596d9d958bc7016be866d6e7bba33d22587b1616d1746546d33aa2cd5adaad3208cc679ea9f993a41
+  metadata.gz: 1a67ef9024c6f14362ff7ac9b71b4931ccc7408c32aa92f81d70aa48ae6cd3fff5811a610842fe7566da770ac3e1e5d55df892159ca71e4c92601c380226ffea
+  data.tar.gz: 7f549faf4fcb3309e8529157ae9a073f6dfa09810ff1af36774bd3f4c5abc0e724af6658042d1c07b53499e32e21150a6f46e078a8ab1565a828a7757e7b6d54

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.4.0
+services:
+  - "redis-server"

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    flag (1.0.0)
+      redic (~> 1.5.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    clap (1.0.0)
+    cutest (1.2.3)
+      clap
+    hiredis (0.6.1)
+    rake (12.0.0)
+    redic (1.5.0)
+      hiredis
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cutest (~> 1.2.3)
+  flag!
+  rake
+
+BUNDLED WITH
+   1.14.4

data/README.md

@@ -1,4 +1,5 @@
 # Flag
+[![Build Status](https://travis-ci.org/elcuervo/flag.svg?branch=master)](https://travis-ci.org/elcuervo/flag)
 
 Simple feature flags for any app
 
@@ -37,6 +38,18 @@ Flag(:something).on!("uuid")
 Flag(:something).on!(:group)
 ```
 
+## Quiet mode
+
+Sometimes you don't want to have your server down when doing flag checks:
+
+```ruby
+Flag.quiet!
+# Now everything fails silently
+
+Flag.store = Redic.new("redis://localhost:5433/123")
+Flag(:quack).on!
+```
+
 ## Enable/Check feature flags
 
 ### Ids

data/Rakefile

@@ -1,11 +1,7 @@
 require "rake/testtask"
 
-Rake::TestTask.new("spec") do |t|
-  t.libs << "lib"
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
+task :test do
+  exec "cutest test/*.rb"
 end
 
-task :default => [:test]
-task :all     => [:test, :bench]
-task :test    => [:spec]
+task :default => :test

data/flag.gemspec

@@ -1,17 +1,15 @@
 Gem::Specification.new do |s|
   s.name              = "flag"
-  s.version           = "0.0.2"
+  s.version           = "1.0.0"
   s.summary           = "Simple feature flags"
   s.description       = "Feature flags for the humans and the coders"
   s.authors           = ["elcuervo"]
   s.licenses          = ["MIT", "HUGWARE"]
-  s.email             = ["yo@brunoaguirre.com"]
+  s.email             = ["elcuervo@elcuervo.net"]
   s.homepage          = "http://github.com/elcuervo/flag"
   s.files             = `git ls-files`.split("\n")
   s.test_files        = `git ls-files test`.split("\n")
 
-  s.add_dependency("redic", "~> 1.4.1")
-
-  s.add_development_dependency("minitest",        "~> 5.3.0")
-  s.add_development_dependency("minitest-given",  "~> 3.0.0")
+  s.add_dependency("redic", "~> 1.5.0")
+  s.add_development_dependency("cutest", "~> 1.2.3")
 end

data/lib/flag.rb

@@ -4,15 +4,19 @@ require "redic"
 module Flag
   FEATURES = "_flag:features".freeze
 
+  RedisGoneError = StandardError
+
   Members = Struct.new(:name) do
     USERS  = "users".freeze
     GROUPS = "groups".freeze
 
     def <<(item)
-      if item.to_s.end_with?("%")
-        Flag.store.call("HSET", Flag::FEATURES, name, item[0...-1])
-      else
-        Flag.store.call("SADD", subkey(item), item)
+      Flag.execute do |store|
+        if item.to_s.end_with?("%")
+          store.call("HSET", Flag::FEATURES, name, item[0...-1])
+        else
+          store.call("SADD", subkey(item), item)
+        end
       end
     end
 
@@ -24,28 +28,39 @@ module Flag
       { percentage: percentage, users: users, groups: groups }
     end
 
-    def groups; members_for(GROUPS).map(&:to_sym) end
-    def users;  members_for(USERS) end
+    def groups
+      members_for(GROUPS).map(&:to_sym)
+    end
+
+    def users
+      members_for(USERS)
+    end
 
     def include?(item)
       return percentage == item.to_i if item.to_s.end_with?("%")
       return true if Zlib.crc32(item.to_s) % 100 < percentage
 
-      Flag.store.call("SISMEMBER", subkey(item), item).to_i == 1
+      Flag.execute do |store|
+        store.call("SISMEMBER", subkey(item), item).to_i == 1
+      end
     end
 
     def reset
-      [USERS, GROUPS].each { |k| Flag.store.call("DEL", "#{key}:#{k}") }
+      [USERS, GROUPS].each do |k|
+        Flag.execute { |store| store.call("DEL", "#{key}:#{k}") }
+      end
     end
 
     def percentage
-      Flag.store.call("HGET", Flag::FEATURES, name).to_i
+      Flag.execute { |store| store.call("HGET", Flag::FEATURES, name).to_i }
     end
 
     private
 
     def members_for(type)
-      Flag.store.call("SMEMBERS", "#{key}:#{type}") || []
+      Flag.execute do |store|
+        store.call("SMEMBERS", "#{key}:#{type}") || []
+      end
     end
 
     def subkey(item)
@@ -55,7 +70,7 @@ module Flag
     def subgroup(item)
       case item
       when Integer, Fixnum, String then USERS
-      when Symbol then GROUPS
+      when Symbol                  then GROUPS
       end
     end
   end
@@ -69,11 +84,21 @@ module Flag
       @members = Members.new(name)
     end
 
-    def reset;     @members.reset     end
-    def key;       @members.key       end
-    def activated; @members.activated end
+    def reset
+      @members.reset
+    end
+
+    def key
+      @members.key
+    end
+
+    def activated
+      @members.activated
+    end
 
-    def off?; !active? end
+    def off?
+      !active?
+    end
 
     def on?(what = false)
       return active? if !what
@@ -103,31 +128,58 @@ module Flag
   end
 
   class << self
-    attr_accessor :store
+    attr_accessor :store, :quiet
 
     def flush
       @_group = nil
       features.each { |_, f| f.reset }
-      self.store.call("DEL", FEATURES)
+      self.execute { |store| store.call("DEL", FEATURES) }
     end
 
     def enabled
       features.select { |k, v| v.on? }.keys
     end
 
-    def store; @store  ||= Redic.new end
-    def group; @_group ||= Hash.new { |h, k| h[k] = lambda { |id| } } end
+    def quiet!
+      @quiet = true
+    end
+
+    def quiet?
+      @quiet == true
+    end
+
+    def execute
+      yield(store)
+    rescue Errno::ECONNREFUSED, Errno::EINVAL => e
+      raise RedisGoneError unless quiet?
+    end
 
-    def groups; group.keys end
+    def store
+      @store ||= Redic.new
+    end
+
+    def group
+      @_group ||= Hash.new do |h, k|
+        h[k] = lambda { |id| }
+      end
+    end
+
+    def groups
+      group.keys
+    end
 
     def features
       @_features ||= Hash.new { |h, k| h[k] = Feature.new(k) }
 
-      self.store.call("HKEYS", FEATURES).each { |k| @_features[k.to_sym] }
+      self.execute do |store|
+        store.call("HKEYS", FEATURES).each { |k| @_features[k.to_sym] }
+      end
 
       @_features
     end
   end
 end
 
-def Flag(feature); Flag.features[feature] end
+def Flag(feature)
+  Flag.features[feature]
+end

data/test/fallback_test.rb

@@ -0,0 +1,32 @@
+require_relative "./spec_helper"
+
+scope "fallback" do
+  setup do
+    Flag.store = Redic.new("redis://localhost:6380/23")
+  end
+
+  scope "normal mode" do
+    test "fail when Redis is gone" do
+      Flag.quiet = false
+
+      assert Flag.quiet? == false
+      assert_raise(Flag::RedisGoneError) do
+        Flag(:fallback).on!
+      end
+    end
+  end
+
+  scope "quiet mode" do
+    setup do
+      Flag.quiet!
+    end
+
+    test "do not fail when Redis is gone" do
+      assert Flag.quiet? == true
+
+      Flag(:fallback).on!
+
+      assert Flag(:fallback).on? == false
+    end
+  end
+end

data/test/features_test.rb

@@ -0,0 +1,39 @@
+require_relative "./spec_helper"
+
+prepare do
+  Flag.flush
+end
+
+scope "features" do
+  test "empty" do
+    assert_equal [], Flag.enabled
+  end
+
+  test "having one" do
+    Flag(:test).on!
+    assert_equal [:test], Flag.enabled
+  end
+
+  test "turning them off" do
+    Flag(:test).on!
+    Flag(:test).off!
+    Flag(:test2).on!
+
+    assert_equal [:test2], Flag.enabled
+    assert_equal [:test, :test2], Flag.features.keys
+  end
+
+  test "get feature info" do
+    Flag(:test).on!("50%")
+    Flag(:test).on!("25")
+    Flag(:test).on!("UUID")
+    Flag(:test).on!(:staff)
+
+    assert Flag(:test).activated.is_a?(Hash)
+    assert Flag(:test).activated[:percentage] == 50
+    assert Flag(:test).activated[:users].size == 2
+    assert Flag(:test).activated[:users].include?("25")
+    assert Flag(:test).activated[:users].include?("UUID")
+    assert Flag(:test).activated[:groups] == [:staff]
+  end
+end

data/test/groups_test.rb

@@ -0,0 +1,35 @@
+require_relative "./spec_helper"
+
+prepare do
+  Flag.flush
+end
+
+scope "groups" do
+  setup do
+    Flag.group[:staff] = lambda { |id| id > 1 }
+  end
+
+  test "adding groups" do
+    assert_equal [:staff], Flag.groups
+  end
+
+  test "testing if feature is activated for a group" do
+    Flag(:test).on!(:staff)
+
+    assert Flag(:test).on?(:staff)
+  end
+
+  test "trying to check for an empty group" do
+    Flag(:test).on!(:bogus)
+
+    assert_equal false, Flag(:test).on?(1)
+  end
+
+  test "testing if a user beloging to a group get stuff activated" do
+    Flag(:test).on!(:staff)
+
+    assert Flag(:test).on?(1) == false
+    assert Flag(:test).on?(2) == true
+    assert Flag(:test).on?(3) == true
+  end
+end

data/test/keys_test.rb

@@ -0,0 +1,11 @@
+require_relative "./spec_helper"
+
+prepare do
+  Flag.flush
+end
+
+scope "keys" do
+  test "uses the correct namespace" do
+    assert_equal  "_flag:features:test_the_key", Flag(:test_the_key).key
+  end
+end

data/test/percentage_test.rb

@@ -0,0 +1,16 @@
+require_relative "./spec_helper"
+
+prepare do
+  Flag.flush
+end
+
+scope "percentage" do
+  test "only half" do
+    Flag(:test).on!("50%")
+
+    assert Flag(:test).on?(1) == false
+    assert Flag(:test).on?(2) == true
+    assert Flag(:test).on?("49%") == false
+    assert Flag(:test).on?("50%") == true
+  end
+end

data/test/spec_helper.rb

@@ -1,7 +1,4 @@
 $:.unshift File.dirname(__FILE__) + '/../lib'
 
-require "minitest/autorun"
-require "minitest/spec"
-require "minitest/pride"
-require "minitest/given"
+require "cutest"
 require "flag"

data/test/users_test.rb

@@ -0,0 +1,20 @@
+require_relative "./spec_helper"
+
+prepare do
+  Flag.flush
+end
+
+scope "users" do
+  test "enabled only for a user" do
+    Flag(:test).on!(1)
+
+    assert Flag(:test).on?(1) == true
+    assert Flag(:test).on?(2) == false
+  end
+
+  test "using any kind of id" do
+    Flag(:test).on!("ImARandomUUID")
+
+    assert Flag(:test).on?("ImARandomUUID")
+  end
+end

metadata

@@ -1,71 +1,65 @@
 --- !ruby/object:Gem::Specification
 name: flag
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - elcuervo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2017-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: cutest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.3.0
+        version: 1.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.3.0
-- !ruby/object:Gem::Dependency
-  name: minitest-given
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 1.2.3
 description: Feature flags for the humans and the coders
 email:
-- yo@brunoaguirre.com
+- elcuervo@elcuervo.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - SPEC.md
 - flag.gemspec
 - lib/flag.rb
-- test/flag_test.rb
+- test/fallback_test.rb
+- test/features_test.rb
+- test/groups_test.rb
+- test/keys_test.rb
+- test/percentage_test.rb
 - test/spec_helper.rb
+- test/users_test.rb
 homepage: http://github.com/elcuervo/flag
 licenses:
 - MIT
@@ -77,20 +71,25 @@ 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.0.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple feature flags
 test_files:
-- test/flag_test.rb
+- test/fallback_test.rb
+- test/features_test.rb
+- test/groups_test.rb
+- test/keys_test.rb
+- test/percentage_test.rb
 - test/spec_helper.rb
+- test/users_test.rb

data/test/flag_test.rb

@@ -1,101 +0,0 @@
-require "spec_helper"
-
-describe Flag do
-  after { Flag.flush }
-
-  context "features" do
-
-    context "empty" do
-      Given(:features) { Flag.enabled }
-      Then { features == [] }
-    end
-
-    context "having one" do
-      Given { Flag(:test).on! }
-      Then  { Flag.enabled == [:test] }
-    end
-
-    context "turning them off" do
-      Given { Flag(:test).on! }
-      When  { Flag(:test).off! }
-      When  { Flag(:test2).on! }
-
-      Then  { Flag.enabled  == [:test2] }
-      And   { Flag.features.keys == [:test, :test2] }
-    end
-
-  end
-
-  context "groups" do
-    Given do
-      Flag.group[:staff] = lambda { |id| id > 1 }
-    end
-
-    context "adding groups" do
-      When(:groups) { Flag.groups }
-      Then { groups == [:staff] }
-    end
-
-    context "testing if feature is activated for a group" do
-      Given { Flag(:test).on!(:staff) }
-      When(:feature) { Flag(:test).on?(:staff) }
-      Then { feature == true }
-    end
-
-    context "trying to check for an empty group" do
-      Given { Flag(:test).on!(:bogus) }
-      When(:feature) { Flag(:test).on?(1) }
-      Then { feature == false }
-    end
-
-    context "testing if a user beloging to a group get stuff activated" do
-      Given { Flag(:test).on!(:staff) }
-
-      Then { Flag(:test).on?(1) == false }
-      And  { Flag(:test).on?(2) == true }
-      And  { Flag(:test).on?(3) == true }
-    end
-  end
-
-  context "users" do
-    context "enabled only for a user" do
-      When { Flag(:test).on!(1) }
-
-      Then { Flag(:test).on?(1) == true }
-      And  { Flag(:test).on?(2) == false }
-    end
-
-    context "with non numeric users" do
-      When { Flag(:test).on!("ImARandomUUID") }
-      Then { Flag(:test).on?("ImARandomUUID") == true }
-    end
-  end
-
-  context "keys" do
-    Given(:feature) { Flag(:test_the_key) }
-    Then { feature.key == "_flag:features:test_the_key" }
-  end
-
-  context "percentage" do
-    Given { Flag(:test).on!("50%") }
-
-    Then { Flag(:test).on?(1) == false }
-    And  { Flag(:test).on?(2) == true }
-    And  { Flag(:test).on?("49%") == false }
-    And  { Flag(:test).on?("50%") == true }
-  end
-
-  context "get feature info" do
-    Given { Flag(:test).on!("50%") }
-    Given { Flag(:test).on!("25") }
-    Given { Flag(:test).on!("UUID") }
-    Given { Flag(:test).on!(:staff) }
-
-    Then { Flag(:test).activated.is_a?(Hash) }
-    And  { Flag(:test).activated[:percentage] == 50 }
-    And  { Flag(:test).activated[:users].size == 2 }
-    And  { Flag(:test).activated[:users].include?("25") }
-    And  { Flag(:test).activated[:users].include?("UUID") }
-    And  { Flag(:test).activated[:groups] == [:staff] }
-  end
-end