fflags 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80793af98a867433e83929b5672b2132aa8cba78
-  data.tar.gz: 01e50393546f7e80b9cd90485e47d2ce7669e835
+  metadata.gz: dcb8c6e2437f6545882deca349f45e3c5dec4869
+  data.tar.gz: f1b3341891da9c719adb9252c7cce0ca1d940d82
 SHA512:
-  metadata.gz: fdfe4e7d1103bf7b83bd0539e5f430638d18c81b8b4182e3b269cd739f76f70bdd3c07e2d15aebd7e8633993bfc5d3c925ccb276adb451e81be8b31eb38e3f71
-  data.tar.gz: f7b628615e600a2a6852fdb8eb6c133593671ccc292c02a4d5cc268fb3a6c0b79599803864b0a6b9cba605f753030b29ca87a031709aa5601b91fab3f55d7913
+  metadata.gz: 334336c321d12e3c21b7043e3a4843982c0aa7ea8ebc4e86744c71fdfdfc389fadadf0c14515f8a7acf578cca60424dcb0d6f0a4784cd094d80116c960bfaee2
+  data.tar.gz: 99f4018c40ea65fdb3fcd26f33099327bae8dbfa09a0f532b8f21e98ae31e73229559a8bd0b963849345156f20ad5845643658fea0ff73bb5fabdd6b79c78951

data/.circleci/config.yml

@@ -26,6 +26,12 @@ jobs:
           # fallback to using the latest cache if no exact match is found
           - v1-dependencies-
 
+      # Code Climate test reporter
+      - run:
+          name: install codeclimate test reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
 
       - run:
           name: install redis
@@ -61,11 +67,12 @@ jobs:
           command: |
             mkdir /tmp/test-results
             TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
-            
+            ./cc-test-reporter before-build
             bundle exec rspec --format progress \
                             --out /tmp/test-results/rspec.xml \
                             --format progress \
                             "${TEST_FILES}"
+            ./cc-test-reporter after-build --exit-code $?
 
       # collect reports
       - store_test_results:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fflags (0.4.0)
+    fflags (0.4.1)
       redis (>= 3.0.0)
 
 GEM

data/README.md

@@ -1,5 +1,6 @@
 [![CircleCI](https://circleci.com/gh/faizalzakaria/fflags/tree/master.svg?style=svg)](https://circleci.com/gh/faizalzakaria/fflags/tree/master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/2c8af5d2a0560570a5b7/maintainability)](https://codeclimate.com/github/faizalzakaria/fflags/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/2c8af5d2a0560570a5b7/test_coverage)](https://codeclimate.com/github/faizalzakaria/fflags/test_coverage)
 
 # FFlags
 

data/lib/fflags.rb

@@ -8,31 +8,78 @@ require 'fflags/api'
 module FFlags
   module_function
 
+  # Sets FFlags configuration using a block that
+  # will be invoked on initialization.
+  #
+  # Ex.
+  #   FFlags.config do |config|
+  #     config.flags = { flag_1: true, flag_2: false }
+  #   end
   def config
     yield configuration
     api.load_flags
   end
 
+  # Returns all supported flags.
+  #
+  # Ex.
+  #    FFlags.all
   def all
     api.flags
   end
 
+  # Check if the flag is enabled,
+  # it returns true | false.
+  #
+  # Ex.
+  #    FFlags.enabled?(:new_flag)
   def enabled?(flag_name)
     api.enabled?(flag_name)
   end
 
+  # Sets flag.
+  #
+  # Ex.
+  #   FFlags.set(:new_flag, true)
+  #
+  #   (Not thread safe)
+  #   FFlags.set(:new_flag, true) do
+  #     puts 'hello'
+  #   end
   def set(flag_name, bool)
-    api.set_flag(flag_name, bool)
+    if block_given?
+      prev_flag = get(flag_name)
+      api.set_flag(flag_name, bool)
+      yield
+      api.set_flag(flag_name, prev_flag)
+    else
+      api.set_flag(flag_name, bool)
+    end
   end
 
+  # Gets value (as String) of a given flag.
+  #
+  # Ex.
+  #   FFlags.get(:new_flag)
   def get(flag_name)
     api.get_flag(flag_name)
   end
 
+  # Toggle the given flag.
+  # If its true, then the flag would be set to false.
+  # If its false, then the flag would be set to true.
+  #
+  # Ex.
+  #   FFlags.toggle(:new_flag)
   def toggle(flag_name)
     api.toggle_flag(flag_name)
   end
 
+  # Reset all the flags to the default value.
+  # The default values are as defined in the config under flags attribute.
+  #
+  # Ex.
+  #   FFlags.reset
   def reset
     api.reset
   end

data/lib/fflags/api.rb

@@ -14,7 +14,8 @@ module FFlags
     end
 
     def set_flag(flag_name, bool)
-      client.set(key, flag_name, bool)
+      supported_flag?(flag_name) &&
+        client.set(key, flag_name, bool)
     end
 
     def get_flag(flag_name)
@@ -30,19 +31,24 @@ module FFlags
       load_flags
     end
 
-    def flag_exist?(flag_name)
-      !get_flag(flag_name).nil?
-    end
-
     def load_flags
       default_flags.each do |flag, bool|
-        next if flag_exist?(flag)
+        next if flag_is_not_nil?(flag)
         set_flag(flag, bool)
       end
     end
 
     private
 
+    def supported_flag?(flag_name)
+      default_flags.include?(flag_name.to_sym) ||
+        default_flags.include?(flag_name.to_s)
+    end
+
+    def flag_is_not_nil?(flag_name)
+      !get_flag(flag_name).nil?
+    end
+
     def truthy?(value)
       value == true || value == 'true'
     end

data/lib/fflags/version.rb

@@ -1,3 +1,3 @@
 module FFlags
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fflags
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Faizal Zakaria
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-28 00:00:00.000000000 Z
+date: 2017-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis