simple_feature_flags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5ef1f22981517d9de71ff3dd332c76b355ea7711b23954f49a1ffe080bbbc3f
+  data.tar.gz: cd1df44c32ae4a3d320af005f34e08bee655e60912c9463069c112e926de2568
+SHA512:
+  metadata.gz: 653d6ad9e44a2700b20735feec5ae8e4a7a29ce1882c010ea8de203777579c0849dd32c5aa9660a66e9584d8ef63b806d1e3b883c09304bf51cf5674099887eb
+  data.tar.gz: 0c3d7c8cbd3a3e2175a80f01cdb4d6c202d108c172451fefcefc06d7d9e0db8a58a87a46b0f8c624ee78f1bab930037493dee7b1feb3c83ec482849e507758f6

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+my_examples

data/.rubocop.yml

@@ -0,0 +1,78 @@
+Style/StringLiterals:
+  Enabled: false
+
+Style/SingleArgumentDig:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+Style/ModuleFunction:
+  EnforcedStyle: 'extend_self'
+
+Style/MissingElse:
+  Enabled: false
+
+Lint/NumberConversion:
+  Enabled: false
+
+Lint/ConstantResolution:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/Copyright:
+  Enabled: false
+
+Style/StringHashKeys:
+  Enabled: false
+
+Style/InlineComment:
+  Enabled: false
+
+Layout/FirstHashElementLineBreak:
+  Enabled: false
+
+Layout/FirstMethodArgumentLineBreak:
+  Enabled: false
+
+Style/ConstantVisibility:
+  Enabled: false
+
+Layout/FirstArrayElementLineBreak:
+  Enabled: false
+
+Layout/MultilineMethodArgumentLineBreaks:
+  Enabled: false
+
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+
+Bundler/GemComment:
+  Enabled: false
+
+AllCops:
+  EnabledByDefault: true
+  Exclude:
+    - 'bin/*'
+    - 'spec/**/*'
+    - 'test/**/*'

data/.ruby-gemset

@@ -0,0 +1 @@
+simple_feature_flags

data/.ruby-version

@@ -0,0 +1 @@
+2.7.4

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.4
+before_install: gem install bundler -v 2.1.4

data/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "cSpell.words": [
+    "Espago",
+    "autorun",
+    "bindir",
+    "flushdb",
+    "optparse",
+    "solargraph",
+    "testtask"
+  ]
+}

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in simple_feature_flags.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    simple_feature_flags (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.1.1)
+    bundler-audit (0.8.0)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    nokogiri (1.12.3)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    redis (4.4.0)
+    redis-namespace (1.8.1)
+      redis (>= 3.0.4)
+    regexp_parser (2.1.1)
+    reverse_markdown (2.0.0)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.19.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.9.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    solargraph (0.43.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.1.0)
+    tilt (2.0.10)
+    unicode-display_width (2.0.0)
+    yard (0.9.26)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  bundler-audit
+  byebug
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  redis
+  redis-namespace
+  rubocop
+  simple_feature_flags!
+  solargraph
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Espago
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,189 @@
+# Simple Feature Flags
+
+Fast, simple and reliable feature flags using Redis or local memory in your Rails app.
+
+## Table of Contents
+[[_TOC_]]
+
+## Installation
+
+### Gem installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_feature_flags'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simple_feature_flags
+
+### Generate config files
+
+This gem uses it's custom generator to make configuration easier for you.
+
+#### Rails apps
+
+1. Navigate to the root directory of your Rails project
+1. Generate config files
+
+   ```sh
+    $ simple_feature_flags -g
+    # or
+    $ simple_feature_flags --generate
+   ```
+
+This should generate an initializer `config/initializers/simple_feature_flags.rb`
+
+```ruby
+# config/initializers/simple_feature_flags.rb
+
+# frozen_string_literal: true
+# Redis has 16 DBs (0 to 15)
+
+FEATURE_FLAGS = if ::Rails.env.test?
+                  # Use TestRamStorage in tests to make them faster
+                  ::SimpleFeatureFlags::TestRamStorage.new("#{::Rails.root.to_s}/config/simple_feature_flags.yml")
+                else
+                  redis = ::Redis.new(host: '127.0.0.1', port: 6379, db: 0)
+                  # We recommend using the `redis-namespace` gem to avoid key conflicts with Sidekiq or Resque
+                  # redis = ::Redis::Namespace.new(:simple_feature_flags, redis: redis)
+
+                  ::SimpleFeatureFlags::RedisStorage.new(redis, "#{::Rails.root.to_s}/config/simple_feature_flags.yml")
+                end
+```
+
+This initializer in turn makes use of the generated config file `config/simple_feature_flags.yml`
+
+```yaml
+---
+# Feature Flags that will be created if they don't exist already
+:mandatory:
+# example flag - it will be created with these properties if there is no such flag in Redis/RAM
+# - name: example
+#   active: 'true' # 'false' is the default value
+#   description: example
+
+- name: example_flag
+  description: This is an example flag which will be automatically added when you start your app (it will be disabled)
+
+- name: example_active_flag
+  active: 'true'
+  description: This is an example flag which will be automatically added when you start your app (it will be enabled)
+
+# nothing will happen if flag that is to be removed does not exist in Redis/RAM
+# An array of Feature Flag names that will be removed on app startup
+:remove:
+- flag_to_be_removed
+
+```
+
+#### Non-Rails apps
+
+1. Navigate to the root directory of your project
+1. Generate config files
+
+   ```sh
+    $ simple_feature_flags -g --no-rails
+    # or
+    $ simple_feature_flags --generate --no-rails
+   ```
+
+## Usage
+
+This gem provides an easy way of dealing with feature flags. At this point in time it only supports global feature flags stored either in RAM or Redis.
+
+### Storage types/Storage adapters
+
+All storage adapters have the same API for dealing with feature flags. The only difference is in how they store data.
+
+#### SimpleFeatureFlags::RedisStorage
+
+This class makes use of Redis to store feature flag data. You can make use of it like so:
+
+```ruby
+require 'redis'
+
+redis = ::Redis.new
+config_file = "#{::Rails.root.to_s}/config/simple_feature_flags.yml"
+
+FEATURE_FLAGS = ::SimpleFeatureFlags::RedisStorage.new(redis, config_file)
+```
+
+#### SimpleFeatureFlags::RamStorage
+
+This class stores all feature flag data in a simple Ruby `::Hash`. You can make use of it like so:
+
+```ruby
+config_file = "#{::Rails.root.to_s}/config/simple_feature_flags.yml"
+
+FEATURE_FLAGS = ::SimpleFeatureFlags::RamStorage.new(config_file)
+```
+
+### Functionality
+
+#### Adding feature flags
+
+You can add new feature flags programmatically, though we highly encourage you to use the generated `config/simple_feature_flags.yml` file instead. It will make it easier to add and/or remove feature flags automatically on app startup without having to add them manually after merging a branch with new feature flags.
+
+In case you'd like to add flags programmatically
+```ruby
+FEATURE_FLAGS.add(:feature_name, 'Description')
+FEATURE_FLAGS.active?(:feature_name) #=> false
+
+# add a new active flag
+FEATURE_FLAGS.add(:active_feature_name, 'Description', true)
+FEATURE_FLAGS.active?(:active_feature_name) #=> true
+```
+
+#### Removing feature flags
+
+You can remove feature flags programmatically, though we highly encourage you to use the generated `config/simple_feature_flags.yml` file instead. It will make it easier to add and/or remove feature flags automatically on app startup without having to add them manually after merging a branch with new feature flags.
+
+In case you'd like to remove flags programmatically
+```ruby
+FEATURE_FLAGS.remove(:feature_name)
+FEATURE_FLAGS.active?(:feature_name) #=> false
+```
+
+#### Run a block of code only when the flag is active
+
+There are two ways of running code only when the feature flag is active
+
+```ruby
+number = 1
+if FEATURE_FLAGS.active?(:feature_name)
+    number += 1
+end
+
+# or using a block
+
+# this code will run only when the :feature_name flag is active
+FEATURE_FLAGS.with_feature(:feature_name) do
+    number += 1
+end
+
+# feature flags that don't exist will return false
+FEATURE_FLAGS.active?(:non_existant) #=> false
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_feature_flags.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_feature_flags"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/simple_feature_flags

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'byebug'
+require 'simple_feature_flags'
+
+::SimpleFeatureFlags::Cli::Runner.new.run

data/lib/example_files/config/initializers/simple_feature_flags.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# Redis has 16 DBs (0 to 15)
+
+FEATURE_FLAGS = if ::Rails.env.test?
+                  # Use TestRamStorage in tests to make them faster
+                  ::SimpleFeatureFlags::TestRamStorage.new("#{::Rails.root.to_s}/config/simple_feature_flags.yml")
+                else
+                  redis = ::Redis.new(host: '127.0.0.1', port: 6379, db: 0)
+                  # We recommend using the `redis-namespace` gem to avoid key conflicts with Sidekiq or Resque
+                  # redis = ::Redis::Namespace.new(:simple_feature_flags, redis: redis)
+
+                  ::SimpleFeatureFlags::RedisStorage.new(redis, "#{::Rails.root.to_s}/config/simple_feature_flags.yml")
+                end

data/lib/example_files/config/simple_feature_flags.yml

@@ -0,0 +1,19 @@
+---
+# Feature Flags that will be created if they don't exist already
+:mandatory:
+# example flag - it will be created with these properties if there is no such flag in Redis/RAM
+# - name: example
+#   active: 'true' # 'false' is the default value
+#   description: example
+
+- name: example_flag
+  description: This is an example flag which will be automatically added when you start your app (it will be disabled)
+
+- name: example_active_flag
+  active: 'true'
+  description: This is an example flag which will be automatically added when you start your app (it will be enabled)
+
+# nothing will happen if flag that is to be removed does not exist in Redis/RAM
+# An array of Feature Flag names that will be removed on app startup
+:remove:
+- flag_to_be_removed

data/lib/example_files/config/simple_feature_flags.yml.example

@@ -0,0 +1,18 @@
+---
+# Feature Flags that will be created if they don't exist already
+:mandatory:
+# example flag - it will be created with these properties if there is no such flag in Redis/RAM
+# - name: example
+#   active: 'true' # 'false' is the default value
+#   description: example
+
+- name: example_flag
+  description: This is an example flag which will be automatically added when you start your app (it will be disabled)
+
+- name: example_active_flag
+  description: This is an example flag which will be automatically added when you start your app (it will be enabled)
+
+# nothing will happen if flag that is to be removed does not exist in Redis/RAM
+# An array of Feature Flag names that will be removed on app startup
+:remove:
+- flag_to_be_removed

data/lib/simple_feature_flags.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SimpleFeatureFlags
+  class NoSuchCommandError < StandardError; end
+
+  class IncorrectWorkingDirectoryError < StandardError; end
+
+  class FlagNotDefinedError < StandardError; end
+end
+
+Dir[File.expand_path('simple_feature_flags/*.rb', __dir__)].sort.each { |file| require file }

data/lib/simple_feature_flags/cli.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SimpleFeatureFlags
+  module Cli; end
+end
+
+Dir[File.expand_path('cli/*.rb', __dir__)].sort.each { |file| require file }

data/lib/simple_feature_flags/cli/command.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SimpleFeatureFlags
+  module Cli
+    module Command; end
+  end
+end
+
+Dir[File.expand_path('command/*.rb', __dir__)].sort.each { |file| require file }

data/lib/simple_feature_flags/cli/command/generate.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'byebug'
+
+module SimpleFeatureFlags
+  module Cli
+    module Command
+      class Generate
+        CONFIG_FILE = 'simple_feature_flags.yml'
+
+        attr_reader :options
+
+        def initialize(options)
+          @options = options
+        end
+
+        def run
+          if options.rails
+            generate_for_rails
+            return
+          end
+
+          ::FileUtils.cp example_config_file, destination_file
+
+          puts 'Generated:'
+          puts '----------'
+          puts "* #{destination_file}"
+        end
+
+        private
+
+        def generate_for_rails
+          ::FileUtils.cp_r example_config_dir, destination_dir
+
+          puts "Generated:"
+          puts '----------'
+          puts "- #{::File.join(destination_dir, 'config')}"
+          print_dir_tree(example_config_dir, 1)
+        end
+
+        def print_dir_tree(dir, embed_level = 0)
+          padding = ' ' * (embed_level * 2)
+
+          children = ::Dir.new(dir).entries.reject { |el| /^\.{1,2}$/ =~ el }
+
+          children.each do |child|
+            child_dir = ::File.join(dir, child)
+            ::Dir.new(::File.join(dir, child))
+            puts "#{padding}- #{child}"
+            print_dir_tree(child_dir, embed_level + 1)
+          rescue Errno::ENOTDIR
+            puts "#{padding}* #{child}"
+          end
+        end
+
+        def example_config_dir
+          ::File.join(::File.expand_path(__dir__), '..', '..', '..', 'example_files', 'config')
+        end
+
+        def example_config_file
+          ::File.join(example_config_dir, CONFIG_FILE)
+        end
+
+        def destination_dir
+          raise IncorrectWorkingDirectoryError, "You should enter the main directory of your Rails project!" if options.rails && !::Dir.new(::Dir.pwd).entries.include?('config')
+
+          ::Dir.pwd
+        end
+
+        def destination_file
+          @destination_file ||= ::File.join(destination_dir, CONFIG_FILE)
+        end
+      end
+    end
+  end
+end

data/lib/simple_feature_flags/cli/options.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module SimpleFeatureFlags
+  module Cli
+    class Options
+      attr_reader :opt_parser, :generate, :help, :rails
+
+      def initialize(args)
+        @rails = true
+
+        @opt_parser = ::OptionParser.new do |opts|
+          opts.banner = 'Usage: simple_feature_flags [options]'
+
+          opts.separator ''
+          opts.separator 'Commands:'
+
+          opts.on('-g', '--generate', 'Generate necessary config files') { @generate = true }
+
+          opts.on('-h', '--help', 'Display the manual') do
+            puts opts
+            exit
+          end
+
+          opts.on('-v', '--version', 'Show gem version') do
+            puts VERSION
+            exit
+          end
+
+          opts.separator ''
+          opts.separator 'Modifiers:'
+
+          opts.on('--[no-]rails', 'Use generators suited for Rails apps') { |r| @rails = r }
+        end
+
+        opt_parser.parse!(args)
+      end
+    end
+  end
+end

data/lib/simple_feature_flags/cli/runner.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SimpleFeatureFlags
+  module Cli
+    class Runner
+      attr_reader :options
+
+      def initialize(args = ARGV)
+        @options = Options.new(args)
+      end
+
+      def run
+        command_class = if @options.generate
+                          ::SimpleFeatureFlags::Cli::Command::Generate
+                        else
+                          raise NoSuchCommandError, 'No such command!'
+                        end
+
+        command_class.new(options).run
+      end
+    end
+  end
+end

data/lib/simple_feature_flags/ram_storage.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module SimpleFeatureFlags
+  class RamStorage
+    attr_reader :file, :mandatory_flags, :flags
+
+    def initialize(file)
+      @file = file
+      @redis = redis
+      @mandatory_flags = []
+      @flags = {}
+
+      import_flags_from_file
+    end
+
+    def active?(feature, _ignore_file = false)
+      __active__(feature)
+    end
+
+    def exists?(feature)
+      return false if [nil, ''].include? flags[feature.to_sym]
+
+      true
+    end
+
+    def description(feature)
+      flags.dig(feature.to_sym, 'description')
+    end
+
+    def with_feature(feature, ignore_file = false, &block)
+      return unless active?(feature, ignore_file)
+
+      block.call
+    end
+
+    def activate(feature)
+      return false unless exists?(feature)
+
+      flags[feature.to_sym]['active'] = 'true'
+
+      true
+    end
+
+    def deactivate(feature)
+      return false unless exists?(feature)
+
+      flags[feature.to_sym]['active'] = 'false'
+
+      true
+    end
+
+    def get(feature)
+      return unless exists?(feature)
+
+      hash = flags[feature.to_sym]
+      hash['mandatory'] = mandatory_flags.include?(feature.to_s)
+
+      hash
+    end
+
+    def add(feature, description, active = 'false')
+      return false if exists?(feature)
+
+      active = case active
+               when true, 'true'
+                 'true'
+               else
+                 'false'
+               end
+
+      hash = {
+        'name' => feature.to_s,
+        'active' => active,
+        'description' => description
+      }
+
+      flags[feature.to_sym] = hash
+    end
+
+    def remove(feature)
+      return false unless exists?(feature)
+
+      removed = get(feature)
+      flags.delete(feature.to_sym)
+
+      removed
+    end
+
+    def all
+      hashes = []
+
+      flags.each do |key, _val|
+        hashes << get(key)
+      end
+
+      hashes
+    end
+
+    def redis; end
+
+    def namespaced_redis; end
+
+    private
+
+    def __active__(feature)
+      flags.dig(feature.to_sym, 'active') == 'true'
+    end
+
+    def import_flags_from_file
+      changes = YAML.load_file(file)
+      changes = { mandatory: [], remove: [] } unless changes.is_a? Hash
+
+      changes[:mandatory].each do |el|
+        mandatory_flags << el['name']
+        add(el['name'], el['description'], el['active'])
+      end
+
+      changes[:remove].each do |el|
+        remove(el)
+      end
+    end
+  end
+end

data/lib/simple_feature_flags/redis_storage.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module SimpleFeatureFlags
+  class RedisStorage
+    attr_reader :file, :redis, :mandatory_flags
+
+    def initialize(redis, file)
+      @file = file
+      @redis = redis
+      @mandatory_flags = []
+
+      import_flags_from_file
+    end
+
+    def active?(feature, _ignore_file = false)
+      __active__(feature)
+    end
+
+    def exists?(feature)
+      return false if [nil, ''].include? redis.hget(feature.to_s, 'name')
+
+      true
+    end
+
+    def description(feature)
+      redis.hget(feature.to_s, 'description')
+    end
+
+    def with_feature(feature, _ignore_file = false, &block)
+      return unless active?(feature)
+
+      block.call
+    end
+
+    def activate(feature)
+      return false unless exists?(feature)
+
+      redis.hset(feature.to_s, 'active', 'true')
+
+      true
+    end
+
+    def deactivate(feature)
+      return false unless exists?(feature)
+
+      redis.hset(feature.to_s, 'active', 'false')
+
+      true
+    end
+
+    def get(feature)
+      return unless exists?(feature)
+
+      hash = redis.hgetall(feature.to_s)
+      hash['mandatory'] = mandatory_flags.include?(feature.to_s)
+
+      hash
+    end
+
+    def add(feature, description, active = 'false')
+      return false if exists?(feature)
+
+      active = case active
+               when true, 'true'
+                 'true'
+               else
+                 'false'
+               end
+
+      hash = {
+        'name' => feature.to_s,
+        'active' => active,
+        'description' => description
+      }
+
+      redis.hset(feature.to_s, hash)
+      hash
+    end
+
+    def remove(feature)
+      return false unless exists?(feature)
+
+      removed = get(feature)
+      redis.del(feature.to_s)
+
+      removed
+    end
+
+    def all
+      keys = []
+      hashes = []
+      redis.scan_each(match: "*") do |key|
+        next if keys.include?(key)
+
+        keys << key
+        hashes << get(key)
+      end
+
+      hashes
+    end
+
+    def namespaced_redis
+      redis
+    end
+
+    private
+
+    def __active__(feature)
+      case redis.hget(feature.to_s, 'active')
+      when 'true'
+        true
+      when 'false'
+        false
+      end
+    end
+
+    def import_flags_from_file
+      changes = YAML.load_file(file)
+      changes = { mandatory: [], remove: [] } unless changes.is_a? Hash
+
+      changes[:mandatory].each do |el|
+        mandatory_flags << el['name']
+        add(el['name'], el['description'], el['active'])
+      end
+
+      changes[:remove].each do |el|
+        remove(el)
+      end
+    end
+  end
+end

data/lib/simple_feature_flags/test_ram_storage.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SimpleFeatureFlags
+  class TestRamStorage < RamStorage
+    def active?(feature, ignore_file = false)
+      raise(FlagNotDefinedError, "Feature Flag `#{feature}` is not defined as mandatory in #{file}") if !ignore_file && !mandatory_flags.include?(feature.to_s)
+
+      __active__(feature)
+    end
+  end
+end

data/lib/simple_feature_flags/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleFeatureFlags
+  VERSION = "0.1.0"
+end

data/simple_feature_flags.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/simple_feature_flags/version'
+
+::Gem::Specification.new do |spec|
+  spec.name          = "simple_feature_flags"
+  spec.version       = ::SimpleFeatureFlags::VERSION
+  spec.authors       = ["Espago", "Mateusz Drewniak"]
+  spec.email         = ["m.drewniak@espago.com"]
+
+  spec.summary       = "Simple feature flag functionality for your Ruby/Rails/Sinatra app!"
+  spec.description   = "A simple Ruby gem which lets you dynamically enable/disable parts of your code using Redis or your server's RAM!"
+  spec.homepage      = "https://github.com/espago/simple_feature_flags"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ::Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/espago/simple_feature_flags"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = ::Dir.chdir(::File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = ['simple_feature_flags']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'bundler-audit'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'redis'
+  spec.add_development_dependency 'redis-namespace'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'solargraph'
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: simple_feature_flags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Espago
+- Mateusz Drewniak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple Ruby gem which lets you dynamically enable/disable parts of
+  your code using Redis or your server's RAM!
+email:
+- m.drewniak@espago.com
+executables:
+- simple_feature_flags
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- ".vscode/settings.json"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/simple_feature_flags
+- lib/example_files/config/initializers/simple_feature_flags.rb
+- lib/example_files/config/simple_feature_flags.yml
+- lib/example_files/config/simple_feature_flags.yml.example
+- lib/simple_feature_flags.rb
+- lib/simple_feature_flags/cli.rb
+- lib/simple_feature_flags/cli/command.rb
+- lib/simple_feature_flags/cli/command/generate.rb
+- lib/simple_feature_flags/cli/options.rb
+- lib/simple_feature_flags/cli/runner.rb
+- lib/simple_feature_flags/ram_storage.rb
+- lib/simple_feature_flags/redis_storage.rb
+- lib/simple_feature_flags/test_ram_storage.rb
+- lib/simple_feature_flags/version.rb
+- simple_feature_flags.gemspec
+homepage: https://github.com/espago/simple_feature_flags
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/espago/simple_feature_flags
+  source_code_uri: https://github.com/espago/simple_feature_flags
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Simple feature flag functionality for your Ruby/Rails/Sinatra app!
+test_files: []