RubyGems - magick-feature-flags - Versions diffs - 0.9.23 → 0.9.25 - Mend

magick-feature-flags 0.9.23 → 0.9.25

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (18) hide show

checksums.yaml +4 -4
data/README.md +213 -5
data/lib/generators/magick/active_record/active_record_generator.rb +44 -0
data/lib/generators/magick/active_record/templates/create_magick_features.rb +20 -0
data/lib/magick/adapters/active_record.rb +267 -0
data/lib/magick/adapters/registry.rb +106 -33
data/lib/magick/admin_ui/config/routes.rb +13 -0
data/lib/magick/admin_ui/engine.rb +98 -0
data/lib/magick/admin_ui/helpers.rb +33 -0
data/lib/magick/admin_ui/routes.rb +17 -0
data/lib/magick/admin_ui.rb +42 -0
data/lib/magick/config.rb +115 -9
data/lib/magick/documentation.rb +153 -0
data/lib/magick/feature.rb +62 -23
data/lib/magick/rails/railtie.rb +18 -7
data/lib/magick/version.rb +1 -1
data/lib/magick.rb +9 -0
metadata +46 -6

data/lib/magick/documentation.rb ADDED Viewed

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+module Magick
+  class Documentation
+    class << self
+      def generate(format: :markdown)
+        features = Magick.features.values
+        case format.to_sym
+        when :markdown
+          generate_markdown(features)
+        when :html
+          generate_html(features)
+        when :json
+          generate_json(features)
+        else
+          raise ArgumentError, "Unknown format: #{format}"
+        end
+      end
+      def generate_markdown(features = nil)
+        features ||= Magick.features.values
+        output = ["# Feature Flags Documentation\n", "Generated: #{Time.now}\n\n"]
+        features.each do |feature|
+          output << "## #{feature.display_name || feature.name}\n\n"
+          output << "**Name:** `#{feature.name}`\n\n"
+          output << "**Type:** #{feature.type.to_s.capitalize}\n\n"
+          output << "**Status:** #{feature.status.to_s.capitalize}\n\n"
+          output << "**Default Value:** `#{feature.default_value.inspect}`\n\n"
+          output << "**Description:** #{feature.description || 'No description'}\n\n"
+          # Access targeting via instance_variable_get since it's private
+          targeting = feature.instance_variable_get(:@targeting) || {}
+          if targeting.any?
+            output << "### Targeting Rules\n\n"
+            targeting.each do |key, value|
+              case key.to_sym
+              when :user
+                user_list = value.is_a?(Array) ? value : [value]
+                user_list.each do |user_id|
+                  output << "- **user_id:** #{user_id}\n"
+                end
+              when :group
+                group_list = value.is_a?(Array) ? value : [value]
+                group_list.each do |group|
+                  output << "- **group:** #{group}\n"
+                end
+              when :role
+                role_list = value.is_a?(Array) ? value : [value]
+                role_list.each do |role|
+                  output << "- **role:** #{role}\n"
+                end
+              when :percentage_users
+                output << "- **percentage_users:** #{value}%\n"
+              when :percentage_requests
+                output << "- **percentage_requests:** #{value}%\n"
+              else
+                output << "- **#{key}:** #{value.inspect}\n"
+              end
+            end
+            output << "\n"
+          end
+          if feature.dependencies.any?
+            output << "### Dependencies\n\n"
+            feature.dependencies.each do |dep|
+              output << "- `#{dep}`\n"
+            end
+            output << "\n"
+          end
+          output << "---\n\n"
+        end
+        output.join
+      end
+      def generate_html(features = nil)
+        features ||= Magick.features.values
+        html = <<~HTML
+          <!DOCTYPE html>
+          <html>
+          <head>
+            <title>Feature Flags Documentation</title>
+            <style>
+              body { font-family: Arial, sans-serif; margin: 20px; }
+              table { border-collapse: collapse; width: 100%; margin: 20px 0; }
+              th, td { border: 1px solid #ddd; padding: 8px; text-align: left; }
+              th { background-color: #f2f2f2; }
+              .status-active { color: green; }
+              .status-deprecated { color: orange; }
+              .status-inactive { color: red; }
+            </style>
+          </head>
+          <body>
+            <h1>Feature Flags Documentation</h1>
+            <p>Generated: #{Time.now}</p>
+            <table>
+              <thead>
+                <tr>
+                  <th>Name</th>
+                  <th>Type</th>
+                  <th>Status</th>
+                  <th>Default Value</th>
+                  <th>Description</th>
+                </tr>
+              </thead>
+              <tbody>
+        HTML
+        features.each do |feature|
+          html << <<~HTML
+            <tr>
+              <td><code>#{feature.name}</code></td>
+              <td>#{feature.type.to_s.capitalize}</td>
+              <td class="status-#{feature.status}">#{feature.status.to_s.capitalize}</td>
+              <td><code>#{feature.default_value.inspect}</code></td>
+              <td>#{feature.description || 'No description'}</td>
+            </tr>
+          HTML
+        end
+        html << <<~HTML
+              </tbody>
+            </table>
+          </body>
+          </html>
+        HTML
+        html
+      end
+      def generate_json(features = nil)
+        features ||= Magick.features.values
+        features_data = features.map do |feature|
+          # Use to_h to get all feature data including targeting
+          feature_hash = feature.to_h
+          {
+            name: feature_hash[:name],
+            display_name: feature_hash[:display_name],
+            type: feature_hash[:type].to_s,
+            status: feature_hash[:status].to_s,
+            default_value: feature_hash[:default_value],
+            description: feature_hash[:description],
+            targeting: feature_hash[:targeting] || {},
+            dependencies: feature.dependencies
+          }
+        end
+        JSON.pretty_generate(features_data)
+      end
+    end
+  end
+end

data/lib/magick/feature.rb CHANGED Viewed

@@ -107,6 +107,20 @@ module Magick
         # Check complex conditions
         return false if targeting[:complex_conditions] && !complex_conditions_match?(context,
                                                                                      targeting[:complex_conditions])
+        # Check user/group/role/percentage targeting
+        targeting_result = check_targeting(context)
+        if targeting_result.nil?
+          # Targeting doesn't match - return false
+          return false
+        else
+          # Targeting matches - for boolean features, return true directly
+          # For string/number features, still check the value
+          if type == :boolean
+            return true
+          end
+          # For string/number, continue to check value below
+        end
       end
       # Get value and check based on type
@@ -151,7 +165,30 @@ module Magick
       # Fast path: check targeting rules first (only if targeting exists)
       unless @_targeting_empty
         targeting_result = check_targeting(context)
-        return targeting_result unless targeting_result.nil?
+        # If targeting matches (returns truthy), return the stored value
+        # If targeting doesn't match (returns nil), continue to return default value
+        unless targeting_result.nil?
+          # Targeting matches - return stored value (or load it if not initialized)
+          if @stored_value_initialized
+            return @stored_value
+          else
+            # Load from adapter
+            loaded_value = load_value_from_adapter
+            if loaded_value.nil?
+              # Value not found in adapter, use default and cache it
+              @stored_value = default_value
+              @stored_value_initialized = true
+              return default_value
+            else
+              # Value found in adapter, use it and mark as initialized
+              @stored_value = loaded_value
+              @stored_value_initialized = true
+              return loaded_value
+            end
+          end
+        end
+        # Targeting doesn't match - return default value
+        return default_value
       end
       # Fast path: use cached value if initialized (avoid adapter calls)
@@ -524,6 +561,30 @@ module Magick
       }
     end
+    def save_targeting
+      # Save targeting to adapter (this updates memory synchronously, then Redis/AR)
+      adapter_registry.set(name, 'targeting', targeting)
+      # Update the feature in Magick.features if it's registered
+      if Magick.features.key?(name)
+        Magick.features[name].instance_variable_set(:@targeting, targeting.dup)
+        # Update targeting empty cache for performance
+        Magick.features[name].instance_variable_set(:@_targeting_empty, targeting.empty?)
+      end
+      # Update local targeting empty cache for performance
+      @_targeting_empty = targeting.empty?
+      # Explicitly publish cache invalidation to other processes via Pub/Sub
+      # This ensures other Rails app instances/consoles invalidate their cache and reload
+      # Note: We don't invalidate local cache here because we just updated it above
+      # The set method publishes cache invalidation, but we also publish here to ensure
+      # it happens even if Redis update fails or is async
+      if adapter_registry.respond_to?(:publish_cache_invalidation)
+        adapter_registry.publish_cache_invalidation(name)
+      end
+    end
     private
     attr_reader :targeting
@@ -847,28 +908,6 @@ module Magick
       true
     end
-    def save_targeting
-      # Save targeting to adapter (this triggers cache invalidation via Pub/Sub)
-      adapter_registry.set(name, 'targeting', targeting)
-      # Update the feature in Magick.features if it's registered
-      if Magick.features.key?(name)
-        Magick.features[name].instance_variable_set(:@targeting, targeting.dup)
-        # Update targeting empty cache for performance
-        Magick.features[name].instance_variable_set(:@_targeting_empty, targeting.empty?)
-      end
-      # Update local targeting empty cache for performance
-      @_targeting_empty = targeting.empty?
-      # Explicitly trigger cache invalidation for targeting updates
-      # Targeting changes affect enabled? checks, so we need immediate cache invalidation
-      # even if async updates are enabled
-      return unless adapter_registry.respond_to?(:invalidate_cache)
-      adapter_registry.invalidate_cache(name)
-    end
     def default_for_type
       case type
       when :boolean

data/lib/magick/rails/railtie.rb CHANGED Viewed

@@ -10,6 +10,15 @@ if defined?(Rails)
   module Magick
     module Rails
       class Railtie < ::Rails::Railtie
+        # Configure inflector to keep AdminUI as AdminUI (not AdminUi)
+        # This must run very early, before any routes or constants are loaded
+        initializer 'magick.inflector', before: :set_load_path do
+          ActiveSupport::Inflector.inflections(:en) do |inflect|
+            inflect.acronym 'AdminUI'
+            inflect.acronym 'UI'
+          end
+        end
         # Make DSL available early so it works in config/initializers/features.rb
         initializer 'magick.dsl', before: :load_config_initializers do
           # Ensure DSL is available globally for initializers
@@ -25,7 +34,13 @@ if defined?(Rails)
               if defined?(Redis)
                 begin
                   redis_url = app.config.respond_to?(:redis_url) ? app.config.redis_url : nil
-                  redis_client = redis_url ? ::Redis.new(url: redis_url) : ::Redis.new
+                  # Use database 1 for Magick by default to avoid conflicts with Rails cache (which uses DB 0)
+                  # Users can override this in their config/initializers/magick.rb
+                  redis_db = 1
+                  redis_options = {}
+                  redis_options[:url] = redis_url if redis_url
+                  redis_options[:db] = redis_db
+                  redis_client = redis_url ? ::Redis.new(redis_options) : ::Redis.new(db: redis_db)
                   memory_adapter = Adapters::Memory.new
                   redis_adapter = Adapters::Redis.new(redis_client)
                   magick.adapter_registry = Adapters::Registry.new(memory_adapter, redis_adapter)
@@ -48,17 +63,13 @@ if defined?(Rails)
           end
           # Ensure adapter_registry is always set (fallback to default if not configured)
-          unless Magick.adapter_registry
-            Magick.adapter_registry = Magick.default_adapter_registry
-          end
+          Magick.adapter_registry = Magick.default_adapter_registry unless Magick.adapter_registry
           # Ensure adapter_registry is set and Redis tracking is enabled after all initializers have run
           # This ensures user's config/initializers/magick.rb has been loaded
           config.after_initialize do
             # Ensure adapter_registry is set (fallback to default if not configured)
-            unless Magick.adapter_registry
-              Magick.adapter_registry = Magick.default_adapter_registry
-            end
+            Magick.adapter_registry = Magick.default_adapter_registry unless Magick.adapter_registry
             # Force enable Redis tracking if Redis adapter is available
             # This is a final safety net to ensure stats are collected

data/lib/magick/version.rb CHANGED Viewed

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

data/lib/magick.rb CHANGED Viewed

@@ -5,6 +5,12 @@ require_relative 'magick/feature'
 require_relative 'magick/adapters/base'
 require_relative 'magick/adapters/memory'
 require_relative 'magick/adapters/redis'
+# Active Record adapter is loaded conditionally - only if ActiveRecord is available
+begin
+  require_relative 'magick/adapters/active_record' if defined?(::ActiveRecord::Base)
+rescue LoadError, NameError
+  # ActiveRecord not available, skip
+end
 require_relative 'magick/adapters/registry'
 require_relative 'magick/targeting/base'
 require_relative 'magick/targeting/user'
@@ -21,6 +27,9 @@ require_relative 'magick/versioning'
 require_relative 'magick/circuit_breaker'
 require_relative 'magick/testing_helpers'
 require_relative 'magick/feature_dependency'
+require_relative 'magick/documentation'
+# AdminUI is loaded conditionally via configuration
+# It is not loaded by default - must be enabled in Magick.configure
 require_relative 'magick/config'
 # Always load DSL - it will make itself available when Rails is detected

metadata CHANGED Viewed

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: magick-feature-flags
 version: !ruby/object:Gem::Version
-  version: 0.9.23
+  version: 0.9.25
 platform: ruby
 authors:
 - Andrew Lobanov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,6 +51,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.22'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: Magick is a better free version of Flipper feature-toggle gem. It is
   absolutely performant and memory efficient (by my opinion).
 email:
@@ -62,17 +95,26 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- 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
 - lib/generators/magick/install/templates/README
 - lib/generators/magick/install/templates/magick.rb
 - lib/magick.rb
+- lib/magick/adapters/active_record.rb
 - lib/magick/adapters/base.rb
 - lib/magick/adapters/memory.rb
 - 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
 - lib/magick/audit_log.rb
 - lib/magick/circuit_breaker.rb
 - lib/magick/config.rb
+- lib/magick/documentation.rb
 - lib/magick/dsl.rb
 - lib/magick/errors.rb
 - lib/magick/export_import.rb
@@ -102,7 +144,6 @@ homepage: https://github.com/andrew-woblavobla/magick
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,8 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.19
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A performant and memory-efficient feature toggle gem
 test_files: []