magick-feature-flags 0.9.34 → 0.9.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72089ec7fc15f5c7f854f03caf17896d4810f99d1067be9fadc17c9c5569b341
-  data.tar.gz: e928f66dd35ada0bb734c424178ba3c6db78f934b49599c21296506da697c4c2
+  metadata.gz: 8fc6c9effed1052fbf1f929d206c9714917c1a5281234d517b4679cf9da44ded
+  data.tar.gz: cb345d7d484c471906a91b47ef63c3450e7613015ac6ca335c24bd73390f95f3
 SHA512:
-  metadata.gz: 0241c50192a89be6f429eac0367538687d8bb5d5dcd897cb1e7804cca4ce452d8e975132b62a0e1bc193f380294df1f0a9b2923680559964944fb9046be8fd94
-  data.tar.gz: dadadc9da7abcb0d031ec65c2ca016d9be0c4d914f1dd7240fbae12c614c8fc140e697a095e1fba744e0f691a6b2cacd3ab843c24ed479b4ecfdbd01c9ad04d6
+  metadata.gz: 3ad0164ef606ed0cf3112ee94013a084a45ae16a3fc9f8a3ed6647043be76aa367f868d38324dc7dcb5118e4263164902eedd7704846d90c90c993e09dba85d7
+  data.tar.gz: f4b37a363842a2b34019c92370f0446a565a1087c90e0fb467244103bc1213c3dfc57b97c8b2e7d1b5623329862f9af23f9e75d2c0d0641ffb2b323d2289ba0a

data/README.md

@@ -45,18 +45,15 @@ This will create `config/initializers/magick.rb` with a basic configuration.
 
 ### ActiveRecord Adapter (Optional)
 
-If you want to use ActiveRecord as a persistent storage backend, generate the migration:
+If you want to use ActiveRecord as a persistent storage backend, you **must** generate and run the migration:
 
 ```bash
 rails generate magick:active_record
-```
-
-This will create a migration file that creates the `magick_features` table. Then run:
-
-```bash
 rails db:migrate
 ```
 
+This will create a migration file that creates the `magick_features` table. **The adapter will not auto-create the table** - you must run migrations.
+
 **Note:** The ActiveRecord adapter is optional and only needed if you want database-backed feature flags. The gem works perfectly fine with just the memory adapter or Redis adapter.
 
 ## Configuration
@@ -137,7 +134,8 @@ end
 Magick.register_feature(:new_dashboard,
   type: :boolean,
   default_value: false,
-  description: "New dashboard UI"
+  description: "New dashboard UI",
+  group: "UI"  # Optional: group features for organization
 )
 
 # Register a string feature
@@ -460,7 +458,7 @@ The ActiveRecord adapter provides database-backed persistent storage for feature
 
 **Setup:**
 
-1. Generate the migration:
+1. **Generate and run the migration** (required):
    ```bash
    rails generate magick:active_record
    rails db:migrate
@@ -469,8 +467,11 @@ The ActiveRecord adapter provides database-backed persistent storage for feature
    **With UUID primary keys:**
    ```bash
    rails generate magick:active_record --uuid
+   rails db:migrate
    ```
 
+   **Important:** The adapter will **not** auto-create the table. You must run migrations before using the ActiveRecord adapter. If the table doesn't exist, the adapter will raise a clear error with instructions.
+
 2. Configure in `config/initializers/magick.rb`:
    ```ruby
    Magick.configure do
@@ -480,8 +481,6 @@ The ActiveRecord adapter provides database-backed persistent storage for feature
    end
    ```
 
-The adapter automatically creates the `magick_features` table if it doesn't exist, but using the generator is recommended for production applications.
-
 **PostgreSQL Support:**
 
 The generator automatically detects PostgreSQL and uses `jsonb` for the `data` column, providing:
@@ -566,6 +565,33 @@ Once mounted, visit `/magick` in your browser to access the Admin UI.
   - **Visual Display**: See all active targeting rules with badges
 - **Edit Features**: Update feature values (boolean, string, number) directly from the UI
 - **Statistics**: View performance metrics and usage statistics for each feature
+- **Feature Grouping**: Organize features into groups for easier management and filtering
+- **Filtering**: Filter features by group, name, or description
+
+**Feature Grouping:**
+
+Features can be organized into groups for easier management and filtering:
+
+1. **Setting Groups**:
+   - Set a group when registering a feature in code:
+     ```ruby
+     Magick.register_feature(:new_payment_flow,
+       type: :boolean,
+       default_value: false,
+       group: 'Payment',
+       description: "New payment processing flow"
+     )
+     ```
+   - Or set/update groups via the Admin UI when editing a feature
+
+2. **Filtering by Group**:
+   - Use the group dropdown in the Admin UI to filter features by group
+   - Combine group filtering with search to find specific features quickly
+
+3. **Benefits**:
+   - Organize features by functional area (e.g., "Authentication", "Payment", "UI")
+   - Quickly find related features
+   - Better organization for large feature flag sets
 
 **Targeting Management:**
 

data/app/controllers/magick/adminui/features_controller.rb

@@ -26,6 +26,24 @@ module Magick
 
       def index
         @features = Magick.features.values
+
+        # Filter by group if provided
+        if params[:group].present?
+          @features = @features.select { |f| f.group == params[:group] }
+        end
+
+        # Filter by search query (name or description)
+        if params[:search].present?
+          search_term = params[:search].downcase
+          @features = @features.select do |f|
+            f.name.downcase.include?(search_term) ||
+            (f.display_name && f.display_name.downcase.include?(search_term)) ||
+            (f.description && f.description.downcase.include?(search_term))
+          end
+        end
+
+        # Get all available groups for filter dropdown
+        @available_groups = Magick.features.values.map(&:group).compact.uniq.sort
       end
 
       def show
@@ -35,6 +53,11 @@ module Magick
       end
 
       def update
+        # Update group if provided
+        if params.key?(:group)
+          @feature.set_group(params[:group])
+        end
+
         if @feature.type == :boolean
           # For boolean features, checkbox sends 'true' when checked, nothing when unchecked
           # Rails form helpers handle this - if checkbox is unchecked, params[:value] will be nil

data/app/views/magick/adminui/features/edit.html.erb

@@ -18,6 +18,12 @@
       <input type="text" value="<%= @feature.type.to_s.capitalize %>" disabled>
     </div>
 
+    <div class="form-group">
+      <label>Group</label>
+      <%= text_field_tag 'group', @feature.group, placeholder: 'e.g., Authentication, Payment, UI', class: 'form-control' %>
+      <small style="color: #999;">Optional: Group features together for easier organization and filtering</small>
+    </div>
+
     <div class="form-group">
       <label>Current Value</label>
       <% if @feature.type == :boolean %>

data/app/views/magick/adminui/features/index.html.erb

@@ -6,6 +6,26 @@
     </div>
   </div>
 
+  <!-- Filtering UI -->
+  <div style="padding: 16px; border-bottom: 1px solid #e0e0e0; background: #f9f9f9;">
+    <%= form_with url: magick_admin_ui.features_path, method: :get, local: true, style: "display: flex; gap: 12px; flex-wrap: wrap; align-items: flex-end;" do |f| %>
+      <div style="flex: 1; min-width: 200px;">
+        <label for="search" style="display: block; margin-bottom: 4px; font-weight: 500;">Search</label>
+        <%= text_field_tag :search, params[:search], placeholder: "Search by name or description...", class: 'form-control', style: "width: 100%;" %>
+      </div>
+      <div style="flex: 0 0 180px;">
+        <label for="group" style="display: block; margin-bottom: 4px; font-weight: 500;">Group</label>
+        <%= select_tag :group, options_for_select([['All Groups', '']] + @available_groups.map { |g| [g, g] }, params[:group]), class: 'form-control', style: "width: 100%;" %>
+      </div>
+      <div style="flex: 0 0 auto;">
+        <%= submit_tag 'Filter', class: 'btn btn-primary btn-sm', style: "height: 38px;" %>
+        <% if params[:search].present? || params[:group].present? %>
+          <%= link_to 'Clear', magick_admin_ui.features_path, class: 'btn btn-secondary btn-sm', style: "height: 38px;" %>
+        <% end %>
+      </div>
+    <% end %>
+  </div>
+
   <% if @features.empty? %>
     <div class="empty-state">
       <h3>No features found</h3>
@@ -16,6 +36,7 @@
       <thead>
         <tr>
           <th>Name</th>
+          <th>Group</th>
           <th>Type</th>
           <th>Status</th>
           <th>Value</th>
@@ -31,6 +52,13 @@
               <br>
               <small style="color: #999;"><%= feature.name %></small>
             </td>
+            <td data-label="Group">
+              <% if feature.group.present? %>
+                <span class="badge badge-info"><%= feature.group %></span>
+              <% else %>
+                <em style="color: #999;">—</em>
+              <% end %>
+            </td>
             <td data-label="Type">
               <span class="badge badge-info">
                 <%= feature.type.to_s.capitalize %>

data/app/views/magick/adminui/features/show.html.erb

@@ -18,6 +18,14 @@
         <span class="badge badge-info"><%= @feature.type.to_s.capitalize %></span>
       </div>
     </div>
+    <% if @feature.group.present? %>
+      <div class="detail-item">
+        <div class="detail-label">Group</div>
+        <div class="detail-value">
+          <span class="badge badge-info"><%= @feature.group %></span>
+        </div>
+      </div>
+    <% end %>
     <div class="detail-item">
       <div class="detail-label">Status</div>
       <div class="detail-value">

data/lib/magick/adapters/active_record.rb

@@ -3,18 +3,17 @@
 module Magick
   module Adapters
     class ActiveRecord < Base
-      @table_created_mutex = Mutex.new
-      @table_created = false
-
       def initialize(model_class: nil)
         @model_class = model_class || default_model_class
-        ensure_table_exists
+        # Verify table exists - raise clear error if it doesn't
+        unless @model_class.table_exists?
+          raise AdapterError, "Table 'magick_features' does not exist. Please run: rails generate magick:active_record && rails db:migrate"
+        end
       rescue StandardError => e
         raise AdapterError, "Failed to initialize ActiveRecord adapter: #{e.message}"
       end
 
       def get(feature_name, key)
-        ensure_table_exists unless @model_class.table_exists?
         feature_name_str = feature_name.to_s
         record = @model_class.find_by(feature_name: feature_name_str)
         return nil unless record
@@ -24,16 +23,10 @@ module Magick
         value = data.is_a?(Hash) ? data[key.to_s] : nil
         deserialize_value(value)
       rescue StandardError => e
-        # If table doesn't exist, try to create it and retry once
-        if e.message.include?('no such table') || e.message.include?("doesn't exist")
-          ensure_table_exists
-          retry
-        end
         raise AdapterError, "Failed to get from ActiveRecord: #{e.message}"
       end
 
       def set(feature_name, key, value)
-        ensure_table_exists unless @model_class.table_exists?
         feature_name_str = feature_name.to_s
         retries = 5
         begin
@@ -48,54 +41,31 @@ module Magick
           record.save!
         rescue ::ActiveRecord::StatementInvalid, ::ActiveRecord::ConnectionTimeoutError => e
           # SQLite busy/locked errors - retry with exponential backoff
-          if (e.message.include?('database is locked') || e.message.include?('busy') || e.message.include?('timeout') || e.message.include?('no such table')) && retries > 0
+          if (e.message.include?('database is locked') || e.message.include?('busy') || e.message.include?('timeout')) && retries > 0
             retries -= 1
-            # If it's a "no such table" error, ensure table exists
-            if e.message.include?('no such table')
-              ensure_table_exists
-            end
             sleep(0.01 * (6 - retries)) # Exponential backoff: 0.01, 0.02, 0.03, 0.04, 0.05
             retry
           end
           raise AdapterError, "Failed to set in ActiveRecord: #{e.message}"
         rescue StandardError => e
-          # If table doesn't exist, try to create it and retry once
-          if (e.message.include?('no such table') || e.message.include?("doesn't exist")) && retries > 0
-            retries -= 1
-            ensure_table_exists
-            sleep(0.01)
-            retry
-          end
           raise AdapterError, "Failed to set in ActiveRecord: #{e.message}"
         end
       end
 
       def delete(feature_name)
-        ensure_table_exists unless @model_class.table_exists?
         feature_name_str = feature_name.to_s
         retries = 5
         begin
           @model_class.where(feature_name: feature_name_str).destroy_all
         rescue ::ActiveRecord::StatementInvalid, ::ActiveRecord::ConnectionTimeoutError => e
           # SQLite busy/locked errors - retry with exponential backoff
-          if (e.message.include?('database is locked') || e.message.include?('busy') || e.message.include?('timeout') || e.message.include?('no such table')) && retries > 0
+          if (e.message.include?('database is locked') || e.message.include?('busy') || e.message.include?('timeout')) && retries > 0
             retries -= 1
-            # If it's a "no such table" error, ensure table exists
-            if e.message.include?('no such table')
-              ensure_table_exists
-            end
             sleep(0.01 * (6 - retries)) # Exponential backoff: 0.01, 0.02, 0.03, 0.04, 0.05
             retry
           end
           raise AdapterError, "Failed to delete from ActiveRecord: #{e.message}"
         rescue StandardError => e
-          # If table doesn't exist, try to create it and retry once
-          if (e.message.include?('no such table') || e.message.include?("doesn't exist")) && retries > 0
-            retries -= 1
-            ensure_table_exists
-            sleep(0.01)
-            retry
-          end
           raise AdapterError, "Failed to delete from ActiveRecord: #{e.message}"
         end
       end
@@ -148,66 +118,6 @@ module Magick
         end)
       end
 
-      def ensure_table_exists
-        return if @model_class.table_exists?
-
-        # Use a non-blocking mutex to prevent deadlocks
-        mutex = self.class.instance_variable_get(:@table_created_mutex)
-        if mutex.try_lock
-          begin
-            # Double-check after acquiring lock
-            return if @model_class.table_exists?
-
-            create_table
-            self.class.instance_variable_set(:@table_created, true)
-          ensure
-            mutex.unlock
-          end
-        else
-          # Another thread is creating the table, wait for it to complete
-          # Use a longer timeout with exponential backoff to avoid hanging
-          20.times do |i|
-            sleep(0.01 * (i + 1)) # Exponential backoff: 0.01, 0.02, 0.03, ...
-            return if @model_class.table_exists?
-          end
-          # If we still don't have the table, try one more time
-          unless @model_class.table_exists?
-            # Last attempt: try to acquire lock and create
-            if mutex.try_lock
-              begin
-                return if @model_class.table_exists?
-                create_table
-                self.class.instance_variable_set(:@table_created, true)
-              ensure
-                mutex.unlock
-              end
-            end
-          end
-        end
-      rescue StandardError => e
-        # Don't raise if table exists now (might have been created by another thread)
-        return if @model_class.table_exists?
-        raise e
-      end
-
-      def create_table
-        connection = @model_class.connection
-        return if connection.table_exists?('magick_features')
-
-        connection.create_table :magick_features do |t|
-          t.string :feature_name, null: false, index: { unique: true }
-          t.text :data
-          t.timestamps
-        end
-      rescue StandardError => e
-        # Table might already exist or migration might be needed
-        # Check if table exists now (might have been created by another thread)
-        return if connection.table_exists?('magick_features')
-
-        warn "Magick: Could not create magick_features table: #{e.message}" if defined?(Rails) && Rails.env.development?
-        raise e if defined?(Rails) && Rails.env.test?
-      end
-
       def serialize_value(value)
         # For ActiveRecord 8.1+ with attribute :json, we can store booleans as-is
         # For older versions with serialize, we convert to strings

data/lib/magick/feature.rb

@@ -8,7 +8,7 @@ module Magick
     VALID_TYPES = %i[boolean string number].freeze
     VALID_STATUSES = %i[active inactive deprecated].freeze
 
-    attr_reader :name, :type, :status, :default_value, :description, :display_name, :adapter_registry
+    attr_reader :name, :type, :status, :default_value, :description, :display_name, :group, :adapter_registry
 
     def initialize(name, adapter_registry, **options)
       @name = name.to_s
@@ -18,6 +18,7 @@ module Magick
       @default_value = options.fetch(:default_value, default_for_type)
       @description = options[:description]
       @display_name = options[:name] || options[:display_name]
+      @group = options[:group]
       @targeting = {}
       @dependencies = options[:dependencies] ? Array(options[:dependencies]) : []
       @stored_value_initialized = false # Track if @stored_value has been explicitly set
@@ -405,6 +406,7 @@ module Magick
       adapter_registry.set(name, 'default_value', default_value)
       adapter_registry.set(name, 'description', description) if description
       adapter_registry.set(name, 'display_name', display_name) if display_name
+      adapter_registry.set(name, 'group', group) if group
       @stored_value = value
       @stored_value_initialized = true # Mark as initialized
 
@@ -516,6 +518,24 @@ module Magick
       true
     end
 
+    def set_group(group_name)
+      if group_name.nil? || group_name.to_s.strip.empty?
+        @group = nil
+        # Clear group from adapter by setting to empty string (adapters handle this)
+        adapter_registry.set(name, 'group', nil)
+      else
+        @group = group_name.to_s.strip
+        adapter_registry.set(name, 'group', @group)
+      end
+
+      # Update registered feature instance if it exists
+      if Magick.features.key?(name)
+        Magick.features[name].instance_variable_set(:@group, @group)
+      end
+
+      true
+    end
+
     def delete
       adapter_registry.delete(name)
       @stored_value = nil
@@ -541,6 +561,7 @@ module Magick
         registered.instance_variable_set(:@status, @status)
         registered.instance_variable_set(:@description, @description)
         registered.instance_variable_set(:@display_name, @display_name)
+        registered.instance_variable_set(:@group, @group)
         registered.instance_variable_set(:@targeting, @targeting.dup)
         registered.instance_variable_set(:@_targeting_empty, @_targeting_empty)
         registered.instance_variable_set(:@_perf_metrics_enabled, @_perf_metrics_enabled)
@@ -619,6 +640,10 @@ module Magick
         @display_name = display_name_value if display_name_value
       end
 
+      # Load group from adapter (can be set via DSL or Admin UI)
+      group_value = adapter_registry.get(name, 'group')
+      @group = group_value if group_value
+
       targeting_value = adapter_registry.get(name, 'targeting')
       if targeting_value.is_a?(Hash)
         # Normalize keys to symbols and handle nested structures
@@ -636,9 +661,8 @@ module Magick
       # The features.rb file is the source of truth for metadata
       # This ensures metadata is always up-to-date even if feature already exists
       adapter_registry.set(name, 'description', @description) if @description
-      return unless @display_name
-
-      adapter_registry.set(name, 'display_name', @display_name)
+      adapter_registry.set(name, 'display_name', @display_name) if @display_name
+      adapter_registry.set(name, 'group', @group) if @group
     end
 
     def load_value_from_adapter

data/lib/magick/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Magick
-  VERSION = '0.9.34'
+  VERSION = '0.9.37'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magick-feature-flags
 version: !ruby/object:Gem::Version
-  version: 0.9.34
+  version: 0.9.37
 platform: ruby
 authors:
 - Andrew Lobanov
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.22'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.22'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -77,14 +77,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 description: Magick is a better free version of Flipper feature-toggle gem. It is
   absolutely performant and memory efficient (by my opinion).
 email:
@@ -160,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="