switchlet 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aef30a43a9f953b56491c74e2569110d8f71ac8ed664643776fa8ae2fb066a8f
-  data.tar.gz: 394b31eed795afb2cf2d8da5f5db665cbde32dd1b514e31acd2eaf6b82922c5c
+  metadata.gz: a8309b12036dc97dd351cf840b260b942f7a481b16f2d2256449f3d14afe1175
+  data.tar.gz: b89973e26a4365e673141e017246d67c066af6a5704f860ce76cc7efc311ffa6
 SHA512:
-  metadata.gz: ea64546f7de6ab36485fb05c2e74f5db764b9b15f6abc58f4280c40d34df1a48d449c8a6570beaa885d8d05068ea93d7304847df7795adaa1106ec62d8435f1d
-  data.tar.gz: c83defe48ee72b6d2f7f7121032800589c69424cb85f637d61dac1489c9dc85540218190715b951af224cbc471df1724137d73188e918aa473a7a4c78a732db3
+  metadata.gz: 5693ae735fde0e0a420e09433a7601f0dda586aa2afd0cf3309a56a0e6430beafc6036e02cbd8cebfdbf9af98c40bbc1e87e4cc16daeefe91893d613e5431f1e
+  data.tar.gz: d1e017ab424b46f7e28d82905e6ab281305cd188ccf873f7b645c5c7888e2b865c2c3a069fdcad28d04f3e0b974bcd42257f153b7c78d92353b0a7f5448c3119

data/README.md

@@ -27,14 +27,23 @@ Switchlet.enabled?(:my_feature)  # => false
 # Enable a feature
 Switchlet.enable!(:my_feature)   # => true
 
+# Enable a feature with description
+Switchlet.enable!(:my_feature, description: "New payment system")   # => true
+
 # Disable a feature
 Switchlet.disable!(:my_feature)  # => false
 
+# Disable with description
+Switchlet.disable!(:my_feature, description: "Temporarily disabled")  # => false
+
+# Set or update description
+Switchlet.set_description!(:my_feature, "Updated description")  # => "Updated description"
+
 # Delete a feature flag
 Switchlet.delete!(:my_feature)   # => nil
 
-# List all feature flags
-Switchlet.list  # => [{ name: "my_feature", enabled: true, updated_at: Time }]
+# List all feature flags (includes descriptions)
+Switchlet.list  # => [{ name: "my_feature", enabled: true, description: "New payment system", updated_at: Time }]
 ```
 
 ## Web UI
@@ -47,9 +56,10 @@ mount Switchlet::Engine => "/switchlet"
 ```
 
 Then visit `/switchlet` in your browser to:
-- View all feature flags
+- View all feature flags with descriptions
 - Toggle flags ON/OFF
-- Create new flags
+- Create new flags with optional descriptions
+- Edit descriptions inline (click to edit)
 - Delete existing flags
 
 ### Securing the Web Interface

data/app/controllers/switchlet/flags_controller.rb

@@ -21,14 +21,22 @@ module Switchlet
 
     def create
       flag_name = params[:flag_name].strip
+      description = params[:description]&.strip
       if flag_name.present?
-        Switchlet.enable!(flag_name)
+        Switchlet.enable!(flag_name, description: description)
         redirect_to switchlet.flags_path, notice: "Flag '#{flag_name}' created and enabled"
       else
         redirect_to switchlet.flags_path, alert: "Flag name cannot be empty"
       end
     end
 
+    def update
+      flag_name = params[:name]
+      description = params[:description]
+      Switchlet.set_description!(flag_name, description)
+      redirect_to switchlet.flags_path, notice: "Description updated for '#{flag_name}'"
+    end
+
     def destroy
       flag_name = params[:name]
       Switchlet.delete!(flag_name)

data/app/views/switchlet/flags/index.html.erb

@@ -52,16 +52,26 @@
       color: #2c3e50;
     }
     .form-group {
+      display: flex;
+      flex-direction: column;
+      gap: 10px;
+    }
+    .form-row {
       display: flex;
       gap: 10px;
       align-items: center;
     }
-    input[type="text"] {
+    input[type="text"], textarea {
       flex: 1;
       padding: 8px 12px;
       border: 1px solid #ddd;
       border-radius: 4px;
       font-size: 14px;
+      font-family: inherit;
+    }
+    textarea {
+      resize: vertical;
+      min-height: 40px;
     }
     .btn {
       padding: 8px 16px;
@@ -136,6 +146,36 @@
       padding: 40px;
       color: #7f8c8d;
     }
+    .text-muted {
+      color: #7f8c8d;
+      font-style: italic;
+    }
+    .description-cell {
+      min-width: 200px;
+    }
+    .description-text {
+      cursor: pointer;
+      display: block;
+      min-height: 20px;
+      padding: 4px;
+      border-radius: 4px;
+      transition: background-color 0.2s;
+    }
+    .description-text:hover {
+      background-color: #f8f9fa;
+    }
+    .description-input {
+      width: 100%;
+      margin-bottom: 8px;
+    }
+    .description-actions {
+      display: flex;
+      gap: 4px;
+    }
+    .btn-sm {
+      padding: 4px 8px;
+      font-size: 12px;
+    }
   </style>
 </head>
 <body>
@@ -154,8 +194,11 @@
       <h2>Create New Flag</h2>
       <%= form_with url: switchlet.flags_path, local: true do |form| %>
         <div class="form-group">
-          <%= form.text_field :flag_name, placeholder: "Enter flag name...", required: true %>
-          <%= form.submit "Create Flag", class: "btn btn-primary" %>
+          <div class="form-row">
+            <%= form.text_field :flag_name, placeholder: "Enter flag name...", required: true %>
+            <%= form.submit "Create Flag", class: "btn btn-primary" %>
+          </div>
+          <%= form.text_area :description, placeholder: "Optional description...", rows: 2 %>
         </div>
       <% end %>
     </div>
@@ -170,6 +213,7 @@
         <thead>
           <tr>
             <th>Flag Name</th>
+            <th>Description</th>
             <th>Status</th>
             <th>Last Updated</th>
             <th>Actions</th>
@@ -179,6 +223,28 @@
           <% @flags.each do |flag| %>
             <tr>
               <td><strong><%= flag[:name] %></strong></td>
+              <td>
+                <div class="description-cell" data-flag="<%= flag[:name] %>">
+                  <span class="description-text" onclick="editDescription('<%= flag[:name] %>')">
+                    <% if flag[:description].present? %>
+                      <%= flag[:description] %>
+                    <% else %>
+                      <span class="text-muted">Click to add description</span>
+                    <% end %>
+                  </span>
+                  <div class="description-edit" style="display: none;">
+                    <%= form_with url: switchlet.flag_path(flag[:name]), method: :patch, local: true, class: "description-form" do |form| %>
+                      <%= form.text_area :description, value: flag[:description], rows: 2, 
+                                        class: "description-input", 
+                                        placeholder: "Enter description..." %>
+                      <div class="description-actions">
+                        <%= form.submit "Save", class: "btn btn-success btn-sm" %>
+                        <button type="button" class="btn btn-secondary btn-sm" onclick="cancelEdit('<%= flag[:name] %>')">Cancel</button>
+                      </div>
+                    <% end %>
+                  </div>
+                </div>
+              </td>
               <td>
                 <span class="<%= flag[:enabled] ? 'status-enabled' : 'status-disabled' %>">
                   <%= flag[:enabled] ? 'ENABLED' : 'DISABLED' %>
@@ -206,5 +272,39 @@
       </table>
     <% end %>
   </div>
+
+  <script>
+    function editDescription(flagName) {
+      const cell = document.querySelector(`[data-flag="${flagName}"]`);
+      const textSpan = cell.querySelector('.description-text');
+      const editDiv = cell.querySelector('.description-edit');
+      const input = cell.querySelector('.description-input');
+      
+      textSpan.style.display = 'none';
+      editDiv.style.display = 'block';
+      input.focus();
+      input.select();
+    }
+
+    function cancelEdit(flagName) {
+      const cell = document.querySelector(`[data-flag="${flagName}"]`);
+      const textSpan = cell.querySelector('.description-text');
+      const editDiv = cell.querySelector('.description-edit');
+      
+      textSpan.style.display = 'block';
+      editDiv.style.display = 'none';
+    }
+
+    // Escape key to cancel editing
+    document.addEventListener('keydown', function(e) {
+      if (e.key === 'Escape') {
+        const activeEdit = document.querySelector('.description-edit[style*="block"]');
+        if (activeEdit) {
+          const flagName = activeEdit.closest('[data-flag]').dataset.flag;
+          cancelEdit(flagName);
+        }
+      }
+    });
+  </script>
 </body>
 </html>

data/config/routes.rb

@@ -3,7 +3,7 @@
 Switchlet::Engine.routes.draw do
   root "flags#index"
   
-  resources :flags, only: [:index, :create, :destroy], param: :name do
+  resources :flags, only: [:index, :create, :update, :destroy], param: :name do
     member do
       patch :toggle
     end

data/lib/generators/switchlet/add_description_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
+
+module Switchlet
+  module Generators
+    class AddDescriptionGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      def create_migration_file
+        migration_template "add_description_to_switchlet_flags.rb", "db/migrate/add_description_to_switchlet_flags.rb"
+      end
+    end
+  end
+end

data/lib/generators/switchlet/templates/add_description_to_switchlet_flags.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddDescriptionToSwitchletFlags < ActiveRecord::Migration[6.1]
+  def change
+    add_column :switchlet_flags, :description, :text
+  end
+end

data/lib/generators/switchlet/templates/create_switchlet_flags.rb

@@ -3,8 +3,9 @@
 class CreateSwitchletFlags < ActiveRecord::Migration[6.1]
   def change
     create_table :switchlet_flags do |t|
-      t.string  :name,    null: false
-      t.boolean :enabled, null: false, default: false
+      t.string  :name,        null: false
+      t.boolean :enabled,     null: false, default: false
+      t.text    :description
       t.timestamps
     end
     add_index :switchlet_flags, :name, unique: true

data/lib/switchlet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Switchlet
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/lib/switchlet.rb

@@ -21,15 +21,19 @@ module Switchlet
     Flag.find_by(name: name.to_s)&.enabled || false
   end
 
-  def self.enable!(name)
+  def self.enable!(name, description: nil)
     flag = Flag.find_or_create_by(name: name.to_s)
-    flag.update!(enabled: true)
+    attrs = { enabled: true }
+    attrs[:description] = description if description
+    flag.update!(attrs)
     true
   end
 
-  def self.disable!(name)
+  def self.disable!(name, description: nil)
     flag = Flag.find_or_create_by(name: name.to_s)
-    flag.update!(enabled: false)
+    attrs = { enabled: false }
+    attrs[:description] = description if description
+    flag.update!(attrs)
     false
   end
 
@@ -43,8 +47,15 @@ module Switchlet
       {
         name: flag.name,
         enabled: flag.enabled,
+        description: flag.description,
         updated_at: flag.updated_at
       }
     end
   end
+
+  def self.set_description!(name, description)
+    flag = Flag.find_or_create_by(name: name.to_s)
+    flag.update!(description: description)
+    flag.description
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switchlet
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - komagata
@@ -65,7 +65,9 @@ files:
 - app/controllers/switchlet/flags_controller.rb
 - app/views/switchlet/flags/index.html.erb
 - config/routes.rb
+- lib/generators/switchlet/add_description_generator.rb
 - lib/generators/switchlet/install_generator.rb
+- lib/generators/switchlet/templates/add_description_to_switchlet_flags.rb
 - lib/generators/switchlet/templates/create_switchlet_flags.rb
 - lib/generators/switchlet/templates/switchlet.rb
 - lib/switchlet.rb
@@ -79,6 +81,7 @@ files:
 - switchlet-0.1.1.gem
 - switchlet-0.1.2.gem
 - switchlet-0.1.3.gem
+- switchlet-0.1.4.gem
 homepage: https://github.com/komagata/switchlet
 licenses:
 - MIT