magick-feature-flags 0.9.33 → 0.9.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5a00b216a8309fb592dd86b9ac4ec11c6cd958790864833ac7a023e06f26517
-  data.tar.gz: 0c6178010b7a588386fce54e089f43d630968bb41376ce94a4665383be183853
+  metadata.gz: 72089ec7fc15f5c7f854f03caf17896d4810f99d1067be9fadc17c9c5569b341
+  data.tar.gz: e928f66dd35ada0bb734c424178ba3c6db78f934b49599c21296506da697c4c2
 SHA512:
-  metadata.gz: 974ca2a2cafe3a28fbb6bbe7416eb54b668a4923b3c500bba2b7772c4d70286283a3b49852042a037289ed2e6114debdd88a67436c0df527a4969ed545997ea3
-  data.tar.gz: df5455d68e3d95581c48717e09021618a19d5e3b6e323a4fe25515191e67fcd1c92a7a8f69e2db2b55043dd90c6cf7b1fb0a038e258af3aac7b1da8ad9d5e8aa
+  metadata.gz: 0241c50192a89be6f429eac0367538687d8bb5d5dcd897cb1e7804cca4ce452d8e975132b62a0e1bc193f380294df1f0a9b2923680559964944fb9046be8fd94
+  data.tar.gz: dadadc9da7abcb0d031ec65c2ca016d9be0c4d914f1dd7240fbae12c614c8fc140e697a095e1fba744e0f691a6b2cacd3ab843c24ed479b4ecfdbd01c9ad04d6

data/README.md

@@ -111,9 +111,6 @@ Magick.configure do
   audit_log enabled: true
   versioning enabled: true
   warn_on_deprecated enabled: true
-
-  # Enable Admin UI (optional)
-  admin_ui enabled: true
 end
 ```
 
@@ -524,23 +521,17 @@ Magick includes a web-based Admin UI for managing feature flags. It's a Rails En
 
 **Setup:**
 
-1. Enable Admin UI in `config/initializers/magick.rb`:
-
-```ruby
-Magick.configure do
-  admin_ui enabled: true
-end
-```
-
-2. Configure roles (optional) for targeting management:
+1. Configure roles (optional) for targeting management in `config/initializers/magick.rb`:
 
 ```ruby
-Magick::AdminUI.configure do |config|
-  config.available_roles = ['admin', 'user', 'manager', 'guest']
+Rails.application.config.after_initialize do
+  Magick::AdminUI.configure do |config|
+    config.available_roles = ['admin', 'user', 'manager', 'guest']
+  end
 end
 ```
 
-3. Mount the engine in `config/routes.rb`:
+2. Mount the engine in `config/routes.rb`:
 
 ```ruby
 Rails.application.routes.draw do

data/config/features.rb.example

@@ -0,0 +1,46 @@
+# Example features configuration file
+# Copy this to config/features.rb in your Rails application
+
+# Boolean features
+boolean_feature :new_dashboard,
+  default: false,
+  name: "New Dashboard",
+  description: "New dashboard UI with improved navigation"
+
+boolean_feature :dark_mode,
+  default: false,
+  name: "Dark Mode",
+  description: "Dark mode theme support"
+
+# String features
+string_feature :api_version,
+  default: "v1",
+  description: "API version to use for requests"
+
+# Number features
+number_feature :max_results,
+  default: 10,
+  description: "Maximum number of results per page"
+
+# Features with status
+feature :experimental_feature,
+  type: :boolean,
+  default_value: false,
+  status: :deprecated,
+  description: "Experimental feature (deprecated, will be removed)"
+
+# Features with dependencies
+# A feature can depend on other features being enabled
+boolean_feature :advanced_feature,
+  default: false,
+  description: "Advanced feature that requires base_feature to be enabled",
+  dependencies: [:base_feature]
+
+# Multiple dependencies
+boolean_feature :premium_feature,
+  default: false,
+  description: "Premium feature requiring multiple base features",
+  dependencies: [:base_feature, :auth_feature]
+
+# You can also add dependencies after feature definition
+add_dependency(:another_feature, :required_feature)

data/config/magick.rb.example

@@ -0,0 +1,50 @@
+# Magick Configuration DSL
+# Copy this to config/initializers/magick.rb in your Rails application
+
+Magick.configure do
+  # Configure environment
+  environment Rails.env
+
+  # Configure memory adapter TTL (default: 3600 seconds)
+  memory_ttl 7200 # 2 hours
+
+  # Configure Redis adapter
+  redis url: ENV['REDIS_URL'], namespace: 'magick:features'
+
+  # Configure circuit breaker
+  circuit_breaker threshold: 5, timeout: 60
+
+  # Enable async updates for Redis (non-blocking)
+  async_updates true
+
+  # Enable performance metrics tracking
+  performance_metrics enabled: true
+
+  # Enable audit logging
+  audit_log enabled: true
+
+  # Enable versioning support
+  versioning enabled: true
+
+  # Enable deprecation warnings
+  warn_on_deprecated true
+end
+
+# Alternative simpler configuration:
+# Magick.configure do
+#   redis url: ENV['REDIS_URL']
+#   performance_metrics enabled: true
+#   audit_log enabled: true
+# end
+
+# Advanced configuration with nested adapter setup:
+# Magick.configure do
+#   adapter :registry do
+#     memory_ttl 3600
+#     redis url: ENV['REDIS_URL']
+#     async_updates true
+#     circuit_breaker threshold: 5, timeout: 60
+#   end
+#   performance_metrics enabled: true
+#   audit_log enabled: true
+# end

data/{lib/magick/admin_ui/config → config}/routes.rb

@@ -7,6 +7,9 @@ Magick::AdminUI::Engine.routes.draw do
       put :enable
       put :disable
       put :enable_for_user
+      put :enable_for_role
+      put :disable_for_role
+      put :update_targeting
     end
   end
   resources :stats, only: [:show]

data/lib/magick/admin_ui/engine.rb

@@ -15,116 +15,6 @@ module Magick
       isolate_namespace Magick::AdminUI
 
       engine_name 'magick_admin_ui'
-
-      # Critical fix: Prevent the engine from interfering with Warden/Devise
-      # Rails engines with isolate_namespace create their own middleware stack
-      # This can break Warden/Devise in the main app if not handled correctly
-      # We ensure the engine doesn't modify the main app's middleware or request handling
-
-      # Don't add any middleware that could interfere
-      # The engine will use its own middleware stack (due to isolate_namespace)
-      # but this shouldn't affect the main app's middleware stack
-
-      # Rails engines automatically detect app/views and app/controllers directories
-      # With isolate_namespace, views should be at:
-      # app/views/magick/adminui/[controller]/[action].html.erb
-      # Controllers should be at:
-      # app/controllers/magick/adminui/[controller]_controller.rb
-      # Rails handles this automatically, but we explicitly add app/controllers to autoload paths
-      # to ensure controllers are found
-      config.autoload_paths += %W[#{root}/app/controllers] if root.join('app', 'controllers').exist?
-
-      # Explicitly require controllers early to ensure they're loaded when gem is from RubyGems
-      # This initializer runs after Warden/Devise is set up to avoid interfering with authentication
-      initializer 'magick.admin_ui.require_controllers', after: :load_config_initializers do
-        engine_root = Magick::AdminUI::Engine.root
-        controller_path = engine_root.join('app', 'controllers', 'magick', 'adminui', 'features_controller.rb')
-        require controller_path.to_s if controller_path.exist?
-
-        stats_controller_path = engine_root.join('app', 'controllers', 'magick', 'adminui', 'stats_controller.rb')
-        require stats_controller_path.to_s if stats_controller_path.exist?
-      end
-
-      # Explicitly add app/views to view paths
-      # Rails engines should do this automatically, but we ensure it's configured
-      initializer 'magick.admin_ui.append_view_paths', after: :add_view_paths do |app|
-        engine_root = Magick::AdminUI::Engine.root
-        app.paths['app/views'] << engine_root.join('app', 'views').to_s if engine_root.join('app', 'views').exist?
-      end
-
-      # Also ensure view paths are added when ActionController loads
-      initializer 'magick.admin_ui.append_view_paths_to_controller', after: :add_view_paths do
-        ActiveSupport.on_load(:action_controller) do
-          view_path = Magick::AdminUI::Engine.root.join('app', 'views').to_s
-          append_view_path view_path unless view_paths.include?(view_path)
-        end
-      end
-
-      # Ensure controllers are loaded and view paths are added in to_prepare
-      # This runs before each request in development and once at boot in production
-      config.to_prepare do
-        # Explicitly require controllers first to ensure they're loaded
-        # This is necessary when the gem is loaded from RubyGems
-        engine_root = Magick::AdminUI::Engine.root
-        controller_path = engine_root.join('app', 'controllers', 'magick', 'adminui', 'features_controller.rb')
-        require controller_path.to_s if controller_path.exist?
-
-        stats_controller_path = engine_root.join('app', 'controllers', 'magick', 'adminui', 'stats_controller.rb')
-        require stats_controller_path.to_s if stats_controller_path.exist?
-
-        # Then add view paths
-        view_path = engine_root.join('app', 'views').to_s
-        if File.directory?(view_path)
-          if defined?(Magick::AdminUI::FeaturesController)
-            Magick::AdminUI::FeaturesController.append_view_path(view_path)
-          end
-          Magick::AdminUI::StatsController.append_view_path(view_path) if defined?(Magick::AdminUI::StatsController)
-        end
-      end
-    end
-  end
-end
-
-# Draw routes directly - Rails engines should auto-load config/routes.rb
-# but for gems we need to ensure routes are drawn at the right time
-# Use both to_prepare (for development reloading) and an initializer (for production)
-if defined?(Rails)
-  # Initializer runs once during app initialization
-  Magick::AdminUI::Engine.initializer 'magick.admin_ui.draw_routes', after: :load_config_initializers do
-    Magick::AdminUI::Engine.routes.draw do
-      root 'features#index'
-      resources :features, only: %i[index show edit update] do
-        member do
-          put :enable
-          put :disable
-          put :enable_for_user
-          put :enable_for_role
-          put :disable_for_role
-          put :update_targeting
-        end
-      end
-      resources :stats, only: [:show]
-    end
-  end
-
-  # to_prepare runs before each request in development (for code reloading)
-  Magick::AdminUI::Engine.config.to_prepare do
-    # Routes are already drawn by initializer, but redraw if needed for development reloading
-    if Magick::AdminUI::Engine.routes.routes.empty?
-      Magick::AdminUI::Engine.routes.draw do
-        root 'features#index'
-        resources :features, only: %i[index show edit update] do
-          member do
-            put :enable
-            put :disable
-            put :enable_for_user
-            put :enable_for_role
-            put :disable_for_role
-            put :update_targeting
-          end
-        end
-        resources :stats, only: [:show]
-      end
     end
   end
 end

data/lib/magick/config.rb

@@ -3,7 +3,7 @@
 module Magick
   class Config
     attr_accessor :adapter_registry, :performance_metrics, :audit_log, :versioning, :warn_on_deprecated,
-                  :async_updates, :memory_ttl, :circuit_breaker_threshold, :circuit_breaker_timeout, :redis_url, :redis_namespace, :redis_db, :environment, :active_record_model_class, :enable_admin_ui
+                  :async_updates, :memory_ttl, :circuit_breaker_threshold, :circuit_breaker_timeout, :redis_url, :redis_namespace, :redis_db, :environment, :active_record_model_class
 
     def initialize
       @warn_on_deprecated = false
@@ -14,7 +14,6 @@ module Magick
       @redis_namespace = 'magick:features'
       @redis_db = nil # Use default database (0) unless specified
       @environment = defined?(Rails) ? Rails.env.to_s : 'development'
-      @enable_admin_ui = false # Admin UI disabled by default
     end
 
     # DSL methods for configuration
@@ -161,10 +160,6 @@ module Magick
       @environment = name.to_s
     end
 
-    def admin_ui(enabled: true)
-      @enable_admin_ui = enabled
-    end
-
     def apply!
       # Apply configuration to Magick module
       Magick.adapter_registry = adapter_registry if adapter_registry
@@ -194,13 +189,6 @@ module Magick
       Magick.audit_log = audit_log if audit_log
       Magick.versioning = versioning if versioning
       Magick.warn_on_deprecated = warn_on_deprecated
-
-      # Load optional components if enabled
-      return unless @enable_admin_ui && defined?(Rails)
-
-      # Load Admin UI - routes need to be drawn during initialization, not after
-      # The engine's isolate_namespace should prevent interference with Warden/Devise
-      require_relative '../magick/admin_ui' unless defined?(Magick::AdminUI)
     end
 
     private

data/lib/magick/rails/railtie.rb

@@ -6,6 +6,7 @@ if defined?(Rails)
   # DSL is already loaded by magick.rb, but ensure it's available
   require 'magick/dsl' unless defined?(Magick::DSL)
   require_relative 'events'
+  # Admin UI engine is now loaded in magick.rb when Rails is detected
 
   module Magick
     module Rails

data/lib/magick/version.rb

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

data/lib/magick.rb

@@ -35,6 +35,13 @@ require_relative 'magick/config'
 # Always load DSL - it will make itself available when Rails is detected
 require_relative 'magick/dsl'
 
+# Always require Admin UI engine when Rails is detected, so Rails can discover it as a railtie
+# Rails discovers railties during gem loading, not during initialization hooks
+# Users control whether the engine is active by mounting it in their routes file
+if defined?(Rails)
+  require_relative 'magick/admin_ui' unless defined?(Magick::AdminUI)
+end
+
 module Magick
   class << self
     attr_accessor :adapter_registry, :default_adapter, :audit_log, :versioning,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magick-feature-flags
 version: !ruby/object:Gem::Version
-  version: 0.9.33
+  version: 0.9.34
 platform: ruby
 authors:
 - Andrew Lobanov
@@ -102,6 +102,9 @@ files:
 - app/views/magick/adminui/features/index.html.erb
 - app/views/magick/adminui/features/show.html.erb
 - app/views/magick/adminui/stats/show.html.erb
+- config/features.rb.example
+- config/magick.rb.example
+- config/routes.rb
 - lib/generators/magick/active_record/active_record_generator.rb
 - lib/generators/magick/active_record/templates/create_magick_features.rb
 - lib/generators/magick/install/install_generator.rb
@@ -114,7 +117,6 @@ files:
 - lib/magick/adapters/redis.rb
 - lib/magick/adapters/registry.rb
 - lib/magick/admin_ui.rb
-- lib/magick/admin_ui/config/routes.rb
 - lib/magick/admin_ui/engine.rb
 - lib/magick/admin_ui/helpers.rb
 - lib/magick/admin_ui/routes.rb