ffe 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd421a2265cc4254c4f11d652831e595994412dc411adbb8d6082b0cebd354de
-  data.tar.gz: a93f928f0810704b1fb5837719753a58d23567220065fb15e41ef705e24b1bc1
+  metadata.gz: 8714db1c7883a34c1d3d855f04531060fe1dfe11b568bee0508570f4e4c1942a
+  data.tar.gz: e781c9895aeeb7ccc047b684805216d81ee4e3adc1eece5e7ee3fe9078f4a715
 SHA512:
-  metadata.gz: 19f5e63d4a2c7616cd418b143c161850fa3329e0dce8fcb3118ed11f7cccd272ffa955d14fa0ce1e1b08d7e3a92ca3c87d46929eedfe9b037ac8e4dbe3c3bf22
-  data.tar.gz: 18f38bf47143ca87795e04163afd2d6f02b05c5ebed3d25949b89dc3195777fb7822847cf60855cfd5f8f6a86c3685adf6356f9f437034a4c2afe8236c0a7a47
+  metadata.gz: 5ca29b54bfe343aa8dd8fee221a0921bf8ce349b177e759d65efecdabe69d8c824a439d507b687d7bfd42bf72ab0492ed38365cad0febc90ef0c4f7239908002
+  data.tar.gz: 792f322fe595ec922daf165dee955ee7550a02ab6ef0354ef007fdb60ac44248f48b1c878ee0d324161a43b1b5d43c3a6e7dd42eabbefd45322be00734158f9b

data/README.md

@@ -3,6 +3,7 @@
 A minimalistic Feature Flag engine, cause i was bored of unleash and other overloaded ones.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -28,6 +29,9 @@ config.env_variable = 'RAILS_ENV'
 config.queue_adapter = :solid_queue 
 ```
 
+It also adds a loader for `feature_flags.json`, so you can easily load feature flags from a file.
+But to this later under `Scenarios`.
+
 Install the migration with:
 ```bash
 $ bin/rails ffe:install:migrations
@@ -52,17 +56,50 @@ Run your app and go to [http://localhost:3000/ffe/feature_flags](http://localhos
 
 1. general usage, respecting only the environment
     ```rb
-   FeatureFlag.enabled?(:flag)
+   Ffe::FeatureFlag.enabled?(:flag)
    # or
-   FeatureFlag.disabled?(:flag)
+   Ffe::FeatureFlag.disabled?(:flag)
    ```
   
 
 2. check if a user is allowed
     ```rb
-    FeatureFlag.enabled_for?(:flag, user: current_user)
+    Ffe::FeatureFlag.enabled_for?(:flag, user: current_user)
     ```
 
+## Usage Scenarios
+
+
+**Use Case**: Cleaning-Up -- The functionality is available to everyone.
+
+> Please don't forget to remove feature flags after its use isn't needed anymore.
+
+> Every unused feature flag, makes the code noisy and uncomfortable to read and understand.
+
+1. Clean up the code after the feature flag has been disabled, or doesn't changed over a long time!
+
+**Use Case**: A new functionality is to be developed that is accessible to specific users and/or environments via a feature flag.
+
+1. Create a feature flag in production
+2. Dump the flags, then replace the `config/feature_flags.json` file locally and commit it.
+3. Continue developing against the feature as before.
+
+**Use Case**: Functionality is available to only a small number of users.
+
+1. Create a feature flag in production, and add allowed users.
+2. Dump the flags, then replace the `config/feature_flags.json` file locally and commit it.
+3. Edit the flag locally and specify a corresponding user.
+4. Continue developing against the feature as before.
+
+**Use Case**: Set a feature flag for an announcement, or something similar, for a specific period of time.
+
+> This requires the use of ActiveJob; currently, only `SolidQueue` and `Sidekiq` are supported. But feel free to add more.
+
+1. Create a feature flag in production, but without setting the expires date.
+2. Dump the flags, then replace the `config/feature_flags.json` file locally and commit it.
+3. Continue developing against the feature as before.
+4. After deployment to production, set the expiration date on the flag -- the flag will be automatically disabled after the expiration date.
+
 
 ## Contributing
 

data/app/controllers/ffe/feature_flags_controller.rb

@@ -5,19 +5,19 @@ module Ffe
     before_action :set_ffe, only: %i[show edit update destroy]
 
     def index
-      @feature_flags = ::Ffe::FeatureFlag.order(created_at: :desc)
+      @feature_flags = Ffe::FeatureFlag.order(created_at: :desc)
     end
 
     def show; end
 
     def new
-      @feature_flag = ::Ffe::FeatureFlag.new
+      @feature_flag = Ffe::FeatureFlag.new
     end
 
     def edit; end
 
     def create
-      @feature_flag = ::Ffe::FeatureFlag.new(feature_flag_params.except(:milieus, :clear_expires_at))
+      @feature_flag = Ffe::FeatureFlag.new(feature_flag_params.except(:milieus, :clear_expires_at))
 
       if @feature_flag.save
         redirect_to feature_flag_path(@feature_flag), notice: 'FFE wurde erstellt.'
@@ -39,18 +39,23 @@ module Ffe
       redirect_to feature_flags_path, notice: 'FFE wurde gelöscht.'
     end
 
+    def dump
+      render json: Ffe::FeatureFlag.order(:name).map { |ff| ff.attributes.slice('name', 'description', 'enabled', 'milieu', 'expires_at', 'percentage') }
+    end
+
     private
 
     def set_ffe
-      @feature_flag = ::Ffe::FeatureFlag.find(params.expect(:id))
+      @feature_flag = Ffe::FeatureFlag.find(params.expect(:id))
     end
 
     def feature_flag_params
       params.expect(
-        feature_flag: [:name, :description, :enabled, :expires_at, :clear_expires_at, { milieus: {} }]
+        feature_flag: [:name, :description, :enabled, :expires_at, :clear_expires_at, { user_ids: [], milieus: {} }]
       ).tap do |params|
         params[:milieu] = params[:milieus].values.join.ljust(Ffe.config.bitlength, '0') if params[:milieus].present?
         params[:expires_at] = nil if params[:clear_expires_at] == '1'
+        params[:user_ids]&.delete_if(&:blank?)
       end
     end
   end

data/app/views/ffe/feature_flags/_form.html.erb

@@ -43,6 +43,11 @@
     <% end %>
   </div>
 
+  <div>
+    <%= form.label :user_ids %>
+    <%= form.collection_select :user_ids, Ffe::User.all, :id, :name, { include_blank: true, multiple: true } %>
+  </div>
+
   <div>
     <%= form.submit %>
   </div>

data/app/views/ffe/feature_flags/index.html.erb

@@ -1,6 +1,7 @@
 <h1>Feature Flags</h1>
 
-<p><%= link_to "Neues Feature Flag anlegen", new_feature_flag_path %></p>
+<div><%= link_to 'Neues Feature Flag anlegen', new_feature_flag_path %></div>
+<div><%= link_to 'dump', dump_feature_flags_path, download: 'feature_flags.json' %></div>
 
 <table>
   <thead>
@@ -22,8 +23,8 @@
         <td><%= feature_flag.expires_at&.strftime('%Y-%m-%dT%H:%M') %></td>
         <td><%= feature_flag.readable_milieus %></td>
         <td>
-          <%= link_to "Bearbeiten", edit_feature_flag_path(feature_flag) %>
-          <%= button_to "Löschen", feature_flag_path(feature_flag), method: :delete %>
+          <%= link_to 'Bearbeiten', edit_feature_flag_path(feature_flag) %>
+          <%= button_to 'Löschen', feature_flag_path(feature_flag), method: :delete %>
         </td>
       </tr>
     <% end %>

data/app/views/ffe/feature_flags/show.html.erb

@@ -17,5 +17,10 @@
   <%= @feature_flag.readable_milieus %>
 </div>
 
+<div>
+  <strong>User IDs:</strong>
+  <%= @feature_flag.user_ids %>
+</div>
+
 <p><%= link_to "Bearbeiten", edit_feature_flag_path(@feature_flag) %></p>
 <p><%= link_to "Zurück", feature_flags_path %></p>

data/config/routes.rb

@@ -1,3 +1,5 @@
 Ffe::Engine.routes.draw do
-  resources :feature_flags
+  resources :feature_flags do
+    get :dump, on: :collection
+  end
 end

data/lib/ffe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ffe
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

data/lib/generators/ffe/install/install_generator.rb

@@ -11,6 +11,7 @@ module Ffe
 
       def copy_initializer
         template 'ffe_initializer.rb.tt', 'config/initializers/ffe.rb'
+        template 'feature_flags.json.tt', 'config/feature_flags.json'
       end
     end
   end

data/lib/generators/ffe/templates/feature_flags.json.tt

@@ -0,0 +1,9 @@
+[
+  {
+    "name": "x_dummy_testing",
+    "description": "A general testing FF.",
+    "enabled": true,
+    "milieu": "1000",
+    "expires_at": null,
+  }
+]

data/lib/generators/ffe/templates/ffe_initializer.rb.tt

@@ -29,3 +29,19 @@ Ffe.configure do |config|
   # actual supported: :solid_queue, :sidekiq
   config.queue_adapter = ActiveJob::Base.queue_adapter_name.to_sym
 end
+
+
+Rails.configuration.after_initialize do
+  if ActiveRecord::Base.connection.table_exists?(:feature_flags)
+    path = Rails.root.join('config/feature_flags.json')
+    next unless File.exist?(path)
+
+    data = JSON.load_file(path)
+    data.each do |flag|
+      name = flag.delete('name')
+      next if Ffe::FeatureFlag.exists?(name: name)
+
+      Ffe::FeatureFlag.create_with(flag).find_or_create_by(name: name)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ffe
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - LeFnord
@@ -59,6 +59,7 @@ files:
 - lib/ffe/engine.rb
 - lib/ffe/version.rb
 - lib/generators/ffe/install/install_generator.rb
+- lib/generators/ffe/templates/feature_flags.json.tt
 - lib/generators/ffe/templates/ffe_initializer.rb.tt
 - lib/tasks/ffe_tasks.rake
 homepage: https://github.com/LeFnord/ffe