ffe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4a4f8d7608dddb3df97d2e03b69b815cfd23662ef1f3eb83a934f5336a63b73
+  data.tar.gz: fb39e4b322a411d8e93f29b0cdaefc27b12fc3c418efde0a74198e5301f51806
+SHA512:
+  metadata.gz: d3cdfbfc53a7015ceefed64e5c6ac7bfe364beea2f33e874ee946b0245ca7f90bc198c45a17fa77ab7be87b8b0e89395b91f6e73f2c2258077669942ea7758cb
+  data.tar.gz: 6a7060e5583b18bf30e218663ea19bd7cd6f93fba0541c39d2a0015be3847b57d608befd54313482d3f3e54e0184a6181caa40970334fbd40bcb2712bca30fb0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright LeFnord
+
+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,43 @@
+# Ffe
+
+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
+gem "ffe"
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Copy over the initializer with:
+```bash
+$ bin/rails g ffe:install
+```
+and adjust it to your needs.
+
+Install the migration with:
+```bash
+$ bin/rails ffe:install:migrations
+```
+(have an eye on the length of the `milieu` bit mask)
+
+Mount the engine in your application's `config/routes.rb` file:
+```ruby
+mount Ffe::Engine => "/feature_flags"
+```
+
+## Usage
+
+coming soon
+
+
+## Contributing
+Contribution directions go here.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/stylesheets/ffe/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/ffe/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Ffe
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/ffe/feature_flags_controller.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Ffe
+  class FeatureFlagsController < ApplicationController
+    before_action :set_ffe, only: %i[show edit update destroy]
+
+    def index
+      @feature_flags = ::Ffe::FeatureFlag.order(created_at: :desc)
+    end
+
+    def show; end
+
+    def new
+      @feature_flag = ::Ffe::FeatureFlag.new
+    end
+
+    def edit; end
+
+    def create
+      @feature_flag = ::Ffe::FeatureFlag.new(feature_flag_params.except(:milieus))
+
+      if @feature_flag.save
+        redirect_to feature_flag_path(@feature_flag), notice: 'FFE wurde erstellt.'
+      else
+        render :new, status: :unprocessable_content
+      end
+    end
+
+    def update
+      if @feature_flag.update(feature_flag_params.except(:milieus))
+        redirect_to feature_flag_path(@feature_flag), notice: 'FFE wurde aktualisiert.'
+      else
+        render :edit, status: :unprocessable_content
+      end
+    end
+
+    def destroy
+      @feature_flag.destroy
+      redirect_to feature_flags_path, notice: 'FFE wurde gelöscht.'
+    end
+
+    private
+
+    def set_ffe
+      @feature_flag = ::Ffe::FeatureFlag.find(params.expect(:id))
+    end
+
+    def feature_flag_params
+      params.expect(feature_flag: [:name, :description, :enabled, :expires_at, { milieus: {} }]).tap do |params|
+        params[:milieu] = params[:milieus].values.join.ljust(Ffe.config.bitlength, '0') if params[:milieus].present?
+      end
+    end
+  end
+end

data/app/helpers/ffe/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Ffe
+  module ApplicationHelper
+  end
+end

data/app/jobs/ffe/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Ffe
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/ffe/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Ffe
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/ffe/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ffe
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/ffe/feature_flag.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Ffe
+  class FeatureFlag < ApplicationRecord
+    self.table_name = 'feature_flags'
+
+    validates :name, presence: true, uniqueness: true, format: { with: /\A[a-zA-Z_]+\z/ }
+    validates :expires_at, comparison: { greater_than: Time.current.end_of_day }, if: -> { expires_at.present? }
+
+    # the Flag functionality itself
+    #
+    # main methods
+    def self.enabled?(flag)
+      feature = find_by(name: flag)
+
+      feature.enabled? && feature.allowed_milieu?
+    end
+
+    def self.disabled?(flag)
+      !enabled?(flag)
+    end
+
+    def self.enabled_for?(flag, user: nil)
+      return enabled?(flag) if user.blank?
+
+      feature = find_by(name: flag)
+      return false unless feature.allowed_milieu?
+
+      feature.enabled? && feature.user_ids.include?(user.id.to_s)
+    end
+
+    # instance methods
+    #
+    def allowed_milieu?
+      actual_milieu = ENV.fetch(Ffe.config.env_variable, false)
+      return false unless actual_milieu
+
+      pos = Ffe.config.milieus[actual_milieu.to_sym]
+      milieu[pos] == '1'
+    end
+
+    def readable_milieus # rubocop:disable Metrics/AbcSize
+      relevant = milieu.to_s.ljust(Ffe.config.milieus.length, '0').chars.first(Ffe.config.milieus.length)
+      return 'all' if relevant.all? { |m| m == '1' }
+      return 'no' if relevant.all? { |m| m == '0' }
+
+      inverted = Ffe.config.milieus.invert
+      relevant.each_with_index.filter_map { |m, i| inverted[i] if m == '1' }.join(', ')
+    end
+  end
+end

data/app/models/ffe/user.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# only a dummy model, it will be expected,
+# that the host app already has a users model and table
+module Ffe
+  class User < ApplicationRecord
+    self.table_name = 'users'
+  end
+end

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

@@ -0,0 +1,47 @@
+<%= form_with model: feature_flag do |form| %>
+  <% if feature_flag.errors.any? %>
+    <div>
+      <h2><%= pluralize(feature_flag.errors.count, "Fehler") %> verhindert das Speichern:</h2>
+      <ul>
+        <% feature_flag.errors.full_messages.each do |message| %>
+          <li><%= message %></li>
+        <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div>
+    <%= form.label :name %>
+    <%= form.text_field :name %>
+  </div>
+
+  <div>
+    <%= form.label :description %>
+    <%= form.text_field :description %>
+  </div>
+
+  <div>
+    <%= form.label :enabled %>
+    <%= form.check_box :enabled %>
+  </div>
+
+  <div>
+    <%= form.label :expires_at %>
+    <%= form.datetime_local_field :expires_at, min: Time.current.tomorrow.beginning_of_day, value: feature_flag.expires_at&.strftime('%Y-%m-%dT%H:%M') %>
+  </div>
+
+  <div>
+    <%= form.fields_for :milieus do |milieu| %>
+      <%- Ffe.config.milieus.each do |(env, pos)| %>
+        <div>
+          <%= milieu.label env %>
+          <%= milieu.check_box env, checked: feature_flag.milieu[pos] == '1' %>
+        </div>
+      <% end %>
+    <% end %>
+  </div>
+
+  <div>
+    <%= form.submit %>
+  </div>
+<% end %>

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

@@ -0,0 +1,5 @@
+<h1>FFE bearbeiten</h1>
+
+<%= render "form", feature_flag: @feature_flag %>
+
+<%= link_to "Zurück", feature_flags_path %>

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

@@ -0,0 +1,31 @@
+<h1>Feature Flags</h1>
+
+<p><%= link_to "Neues Feature Flag anlegen", new_feature_flag_path %></p>
+
+<table>
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Description</th>
+      <th>Enabled</th>
+      <th>Expires At</th>
+      <th>Environments</th>
+      <th>Actions</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @feature_flags.each do |feature_flag| %>
+      <tr>
+        <td><%= link_to feature_flag.name, feature_flag_path(feature_flag) %></td>
+        <td><%= feature_flag.description %></td>
+        <td><%= feature_flag.enabled %></td>
+        <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 %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

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

@@ -0,0 +1,5 @@
+<h1>Neues FFE</h1>
+
+<%= render "form", feature_flag: @feature_flag %>
+
+<%= link_to "Zurück", feature_flags_path %>

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

@@ -0,0 +1,21 @@
+<h1><%= @feature_flag.name %></h1>
+
+<div>
+  <strong>Description:</strong>
+  <%= @feature_flag.description %>
+</div>
+<div>
+  <strong>Enabled:</strong>
+  <%= @feature_flag.enabled %>
+</div>
+<div>
+  <strong>Expires at:</strong>
+  <%= @feature_flag.expires_at&.strftime('%Y-%m-%dT%H:%M') %>
+</div>
+<div>
+  <strong>Milieus:</strong>
+  <%= @feature_flag.readable_milieus %>
+</div>
+
+<p><%= link_to "Bearbeiten", edit_feature_flag_path(@feature_flag) %></p>
+<p><%= link_to "Zurück", feature_flags_path %></p>

data/app/views/layouts/ffe/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Ffe</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "ffe/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Ffe::Engine.routes.draw do
+  resources :feature_flags
+end

data/db/migrate/20260810150000_create_feature_flags.rb

@@ -0,0 +1,17 @@
+class CreateFeatureFlags < ActiveRecord::Migration[8.2]
+  def change
+    create_table :feature_flags do |t|
+      t.string :name, null: false
+      t.string :description
+      t.boolean :enabled, default: false
+      t.datetime :expires_at
+      t.column :milieu, "bit(#{Ffe.config.bitlength})", default: ''.ljust(Ffe.config.bitlength, '0') # only for PG
+      t.text :user_ids, array: true, default: []
+
+      t.timestamps
+    end
+
+    add_index :feature_flags, :name, unique: true
+    add_index :feature_flags, :user_ids, using: :gin
+  end
+end

data/db/migrate/20260814160209_create_users.rb

@@ -0,0 +1,11 @@
+# remove this migration, if you app already has a users model and table
+class CreateUsers < ActiveRecord::Migration[8.2]
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.string :email
+
+      t.timestamps
+    end
+  end
+end

data/lib/ffe/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Ffe
+  class Configuration
+    attr_accessor :bitlength, :env_variable, :milieus
+
+    def initialize
+      @bitlength = 4
+      @env_variable = 'RAILS_ENV'
+      @milieus = { development: 0, staging: 1, production: 2 }
+    end
+  end
+end

data/lib/ffe/engine.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Ffe
+  class Engine < ::Rails::Engine
+    isolate_namespace Ffe
+
+    config.ffe = Configuration.new
+  end
+end

data/lib/ffe/version.rb

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

data/lib/ffe.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'ffe/version'
+require 'ffe/configuration'
+require 'ffe/engine'
+
+module Ffe
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      Rails.application.config.ffe
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Ffe
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Creates an initializer for the Ffe engine'
+
+      def copy_initializer
+        template 'ffe_initializer.rb.tt', 'config/initializers/ffe.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+Ffe.configure do |config|
+  # Configure the Ffe engine here.
+  # (given values are the defaults)
+
+  # configure the length of the bitmask, used to store the milieus,
+  # the minimum length should be length of milieus
+  config.bitlength = 4
+
+  # define the environments you want to use,
+  # the count of items maps directly to the length of the milieu bit mask above,
+  # so change it accordingly
+  #
+  #   for example: add a fourth environment
+  #     config.milieus = { development: 0, staging: 1, production: 2, testing: 3}
+  #   the minimum bitlength becomes:
+  #     config.bitlength = 4
+  #
+  #   (later changes are bit more complicated, so increase the bit length before)
+  #
+  config.milieus = { development: 0, staging: 1, production: 2 }
+
+  # not all rails apps are using RAILS_ENV variable to set it
+  config.env_variable = 'RAILS_ENV'
+end

data/lib/tasks/ffe_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :ffe do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ffe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- LeFnord
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: A minimal Feature Flag Engine for Rails.
+email:
+- pscholz.le@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/ffe/application.css
+- app/controllers/ffe/application_controller.rb
+- app/controllers/ffe/feature_flags_controller.rb
+- app/helpers/ffe/application_helper.rb
+- app/jobs/ffe/application_job.rb
+- app/mailers/ffe/application_mailer.rb
+- app/models/ffe/application_record.rb
+- app/models/ffe/feature_flag.rb
+- app/models/ffe/user.rb
+- app/views/ffe/feature_flags/_form.html.erb
+- app/views/ffe/feature_flags/edit.html.erb
+- app/views/ffe/feature_flags/index.html.erb
+- app/views/ffe/feature_flags/new.html.erb
+- app/views/ffe/feature_flags/show.html.erb
+- app/views/layouts/ffe/application.html.erb
+- config/routes.rb
+- db/migrate/20260810150000_create_feature_flags.rb
+- db/migrate/20260814160209_create_users.rb
+- lib/ffe.rb
+- lib/ffe/configuration.rb
+- lib/ffe/engine.rb
+- lib/ffe/version.rb
+- lib/generators/ffe/install/install_generator.rb
+- lib/generators/ffe/templates/ffe_initializer.rb.tt
+- lib/tasks/ffe_tasks.rake
+homepage: https://github.com/LeFnord/ffe
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/LeFnord/ffe
+  source_code_uri: https://github.com/LeFnord/ffe
+  changelog_uri: https://github.com/LeFnord/ffe/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '4.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.18
+specification_version: 4
+summary: A minimal Feature Flag Engine for Rails
+test_files: []