rollout-redis 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b85cb7955ab58bf0ede95038078e71e534db5e477af94d9af605b3c3f48aee3
-  data.tar.gz: a210b3007e3cc5f1bad76c3574b9729d138c5eec19df5ef4b620b29c56f7ba72
+  metadata.gz: '09b02bf812a6d2bf771a7d9b3d299113d6600c43d88516e40ff43d724c6681b9'
+  data.tar.gz: d18a8829c7ded0e56c2c9f43da26a73e2011d28a7aee15a9011d6246bcc5a166
 SHA512:
-  metadata.gz: eb078df42c0404c25f3439635391751cc83b3ad90a3647fac163d42240cac7afefe376d4c7de50bd9eb8565bf724bf8288fec7823f81ae10d8eb894643cad852
-  data.tar.gz: f6a3a0c1da29db894c75fbb3b5516f9975ae6031fe0569b158ca3e5707dfa0bdd3fffe924da8bdaf6720501d75ac0073b99eea66bfb937393367f5a431e6a2e1
+  metadata.gz: 8da06a204a6133487f43c52c013485476391b1ff8d2d5680eda8ef9f419aa6b516a63a27fbae3627f0b747b7515fff2347b0594802252ab8b05f78a8b9988154
+  data.tar.gz: 2850a4238642e603504ea4034bd036d09649d319127d99eae4afbe2903f099c7af6d6cc49e50248bfff4b01354982ce93b4b8e58468fdbf7c37dae6801bd0f10

data/CHANGELOG.md

@@ -5,6 +5,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## [0.3.0] - 2023-10-24
+
+### Added
+- Providing some rake tasks to the consumers of the gem for allowing them to easily manage their feature flags in their applications:
+    - `bundle exec rake rollout:on` rake task for activating feature flags
+    - `bundle exec rake rollout:off` rake task for deactivating feature flags
+    - `bundle exec rake rollout:list` rake task for listing stored feature flags
+
 ## [0.2.0] - 2023-10-23
 
 ### Added

data/README.md

@@ -9,12 +9,13 @@ Based on the discontinued [rollout](https://github.com/fetlife/rollout) project,
 Topics covered in this README:
 
 - [Install it](#install-it)
-- [Quick Start](#quick-start-💨)
-- [Advanced features](#advanced-features-🦾)
+- [Quick Start](#quick-start-)
+- [Advanced features](#advanced-features-)
   - [Gradual activation based on percentages](#gradual-activation-based-on-percentages)
   - [Caching Feature Flags](#caching-feature-flags)
   - [Auto-deactivating flags](#auto-deactivating-flags)
-- [Migrating from rollout gem](#migrating-from-rollout-gem-🚨)
+- [Rake tasks](#rake-tasks)
+- [Migrating from rollout gem](#migrating-from-rollout-gem-)
 - [Changelog](#changelog)
 - [Contributing](#contributing)
 
@@ -146,7 +147,7 @@ If you want to allow the gem to deactivate your feature flag automatically when
 ```ruby
 @rollout ||= Rollout.new(redis)
               .with_cache
-              .with_degrade(sample: 5000, min: 100, threshold: 0.1)
+              .with_degrade(min: 100, threshold: 0.1)
 ```
 
 So now, instead of using the `active?` method, you need to wrap your new code under the `with_feature` method.
@@ -159,6 +160,46 @@ end
 
 When any unexpected error appears during the wrapped code execution, the Rollout gem will take it into account for automatically deactivating the feature flag if the threshold of errors is reached. All the managed or captured errors inside the wrapped code will not be taken into consideration.
 
+## Rake tasks
+
+In order to have access to the rollout rakes, you have to load manually the task definitions. For doing so load the rollout rake task:
+
+```ruby
+require 'rollout'
+
+load 'rollout/tasks/rollout.rake'
+```
+
+Also, for using the rake tasks, you must set the following env variables
+
+```shell
+ROLLOUT_REDIS_HOST=localhost
+ROLLOUT_REDIS_PORT=6379
+```
+
+### Usage
+
+To activate/deactivate features, execute the following rake tasks:
+
+```shell
+bundle exec rake rollout:on[feature_name]
+bundle exec rake rollout:off[feature_name]
+```
+
+To a gradual activation based on percentages, pass the percentage as the second parameter when executing the `on` task.
+
+```shell
+bundle exec rake rollout:on[feature_name,50]
+```
+
+_NOTE_: In both cases, `feature_name` **must not** include quotes e.g. `bundle exec rake rollout:on['feature_name']`, as the gem will be unable to fetch its activation status if so.
+
+For listing all the stored feature flags, do:
+
+```shell
+bundle exec rake rollout:list
+```
+
 ## Migrating from rollout gem 🚨
 
 If you are currently using the unmaintained [rollout](https://github.com/fetlife/rollout) gem, you should consider checking this [migration guide](https://github.com/jcagarcia/rollout-redis/blob/main/MIGRATING_FROM_ROLLOUT_GEM.md) for start using the new `rollout-redis` gem.

data/lib/rollout/tasks/rollout.rake

@@ -0,0 +1,63 @@
+
+namespace :rollout do
+  desc "Activate a feature"
+  task :on, [:feature, :percentage] => :environment do |task, args|
+    if args.feature
+      puts "Activating feature #{args.feature}..."
+      if args.percentage
+        activated = rollout.activate(args.feature, args.percentage.to_i)
+      else
+        activated = rollout.activate(args.feature)
+      end
+
+      if activated
+        puts "Feature flag #{args.feature} has been activated! :)"
+      else
+        puts "Feature flag #{args.feature} has NOT been activated! :("
+      end
+    end
+  end
+
+  desc "Deactivate a feature"
+  task :off, [:feature] => :environment do |task, args|
+    if args.feature
+      puts "Deactivating feature #{args.feature}..."
+      deactivated = rollout.deactivate(args.feature)
+      if deactivated
+        puts "Feature flag #{args.feature} has been deactivated! :)"
+      else
+        puts "Feature flag #{args.feature} has NOT been deactivated! :("
+      end
+    end
+  end
+
+  desc "List features"
+  task list: :environment do
+    features = rollout.features
+    puts "This is the list of all the available features:"
+    puts ""
+    if !features.empty?
+      puts features
+    else
+      puts "- No feature flags stored"
+    end
+  end
+
+  private
+
+  def rollout
+    @rollout ||= Rollout.new(storage)
+  end
+
+  def storage
+    begin
+      @storage ||= Redis.new(
+        host: ENV.fetch('ROLLOUT_REDIS_HOST'),
+        port: ENV.fetch('ROLLOUT_REDIS_PORT')
+      )
+    rescue KeyError => e
+      puts "ROLLOUT_REDIS_HOST and ROLLOUT_REDIS_PORT are mandatory env variables to define in order to run rollout rake tasks"
+      raise e
+    end
+  end
+end

data/lib/rollout/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Rollout
-  VERSION = '0.2.0'
+  VERSION = '0.3.1'
 end

data/rollout-redis.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 2.4'
   spec.add_development_dependency 'rspec', '~> 3.12'
   spec.add_development_dependency 'mock_redis', '~> 0.37'
+  spec.add_development_dependency 'rake', '~> 13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollout-redis
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Juan Carlos García
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.37'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
 description: Fast and easy feature flags based on the latest Redis versions.
 email:
 - jugade92@gmail.com
@@ -84,6 +98,7 @@ files:
 - Rakefile
 - lib/rollout.rb
 - lib/rollout/feature.rb
+- lib/rollout/tasks/rollout.rake
 - lib/rollout/version.rb
 - rollout-redis.gemspec
 homepage: https://github.com/jcagarcia/rollout-redis