flipside 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e49af6fc8d31128f0e88089ad6d46ce1745a223a68c4f5e4f2e5353f99091073
-  data.tar.gz: cb1547b1c3892b363830aa5f75375998092b90f150e6a275b3224051b6eb3b19
+  metadata.gz: 3c0a3e61bb314f51e06511146b141050b6ca6da1bc7caefa8307f854e19deb78
+  data.tar.gz: f9465ceb62faf692a5a19addcd5d38251d76712d9ee39b3c634fa9b78be745f1
 SHA512:
-  metadata.gz: cc95be97c95f5c6285d4eb57e6b378b47277d61e43f6606eb44bf9c9c6f914a2b6019c4a143c8b9a5058c64eac6ea0f4cffbecf7138ad3836ca0dcb196515c22
-  data.tar.gz: fb5262d598dea36dd87e7c987ae1d263500b2bc7e39882d7da5a119a6c11aab009821d7981732a442176985054900355e6bcf2b8d2b0fa68eab99e03a6469337
+  metadata.gz: f779f75b475ae4b140a65dd6b1da62b9c77f8593000475ee0dec0a5bf7ad4d3170cd1af307d83927312d8c1ee389285d3bf001476a7190c4dff7392cdc7f4f0f
+  data.tar.gz: 3606e255c03e504d704f147d106783cb920d62c29b8a163b2869bdb50a8f204e4d8c45b0ba524683fe1fc6617b27e23da7b9ad55246df1d12f3e139c1872585d

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.2.2] - 2025-04-25
+
+- Add disabled? method
+- Edit feature description from UI
+- Add configuration for setting default_object
+
 ## [0.2.1] - 2025-01-30
 
 - Option to create missing features

data/README.md

@@ -33,41 +33,72 @@ This will create a migration file. Run the migration, to add the flipside tables
 
 ## Usage
 
-1. Defining Features
+### Defining Features
 
 Features are created by running this (in a console or from code):
 ```ruby
-Flipside::Feature.create(
+Flipside.create(
   name: "MyFeature",
   description: "Some optional description about what this feature do"
 )
 ```
 
-By default features are turned off. If you would like it turned on from the beginning you could pass in `enabled: true`.
+By default features are turned off. If we would like it turned on from the get go we could pass in `enabled: true`.
 ```ruby
-Flipside::Feature.create(name: "MyFeature", enabled: true)
+Flipside.create(name: "MyFeature", enabled: true)
 ```
 
 Features can be active during a given period. Set `activated_at` and/or `deactivated_at` to define this period.
 Note: A feature is always disabled outside of the active period.
+Note: A nil value means that its active. I.e. `activated_at = nil` means active from the start, `deactivated_at = nil` means never deactivates.
 ```ruby
-Flipside::Feature.create(
+Flipside.create(
   name: "MyFeature",
   activated_at: 1.week.from_now,
   deactivated_at: 2.weeks.from_now
 )
 ```
 
-Features can be enabled for a certain record, typically a certain user or organization. This records are called entities. To enable a feature for a given record use `.add_entity`:
+### Checking Feature Status
+
+#### Globally
+
+Check if a feature is enabled globally:
+
+```ruby
+Flipside.enabled? "MyFeature"
+```
+
+We can also check if a feature is disabled:
+```ruby
+Flipside.disabled? "MyFeature"
+```
+
+#### For a Specific Record
+
+Check if a feature is enabled for a specific record (e.g. a user):
+
+```ruby
+Flipside.enabled? "MyFeature", user
+```
+
+We can also check multiple records. `.enabled?` will return `true` if any of them have the feature enabled:
+```ruby
+Flipside.enabled? "MyFeature", user, company, location
+```
+
+### Enabling features for specific records
+
+Features can be enabled for a certain record, typically a certain user or organization. These records are called entities. To enable a feature for a given record use `.add_entity`:
 ```ruby
 user = User.first
-Flipside.enabled? user # => false
+Flipside.enabled? "MyFeature", user # => false
 Flipside.add_entity(name: "MyFeature", user)
-Flipside.enabled? user # => true
+Flipside.enabled? "MyFeature", user # => true
 ```
 
 Features can be enabled for records responding true to a certain method. This is called a "role". Given that User records have an admin? method. A feature can then be enabled
-for all users how are admins, using the `.add_role` method:
+for all users who are admins, using the `.add_role` method:
 ```ruby
 user1 = User.new(admin: false)
 user2 = User.new(admin: true)
@@ -76,43 +107,69 @@ Flipside.add_role(
   class_name: "User",
   method_name: :admin?
 )
-Flipside.enabled? user1 # => false
-Flipside.enabled? user2 # => true
+Flipside.enabled? "MyFeature", user1 # => false
+Flipside.enabled? "MyFeature", user2 # => true
+Flipside.enabled? "MyFeature", user1, user2 # => true, enabled for at least one.
 ```
 
 
-2. Checking Feature Status
+## UI
+Flipside comes with a sinatra web ui to mange feature flags. To mount this sinatra app in Rails add the following to your routes.rb file.
+```ruby
+mount Flipside::Web, at: '/flipside'
+```
+Note: you probably want to wrap this inside a constraints block to provide some authentication.
 
-#### Globally
+![UI](/features.png)
 
-Check if a feature is enabled globally:
 
-```ruby
-Flipside.enabled? "MyFeature"
-```
+### Configuration
 
-#### For a Specific Record
+The Flipside UI can be configured by calling some class methods on `Flipside` (see below).
 
-Check if a feature is enabled for a specific record (e.g. a user):
+`ui_back_path` is used to set a path to return to from the Flipside UI. If this is set, then the UI shows a "Back" button,
+targeting this path/url. By default no back button is shown.
+
+
+If `create_missing_features` is set to true, then features will automatically be created, whenever a check for an unknown feature is done.
+This can be a convenient way of makes features "show up" in the Flipside UI. However, the description will not reveal much about what this features does.
+(it will simply point to the place in the code where this check was done). So these features should be manually updated with a better description.
+By default, features are not added and code like `Flipside.enabled? "Some unknown feature"` will simply return `false`.
 
+`default_object` can be used to avoid the need to always pass in a record when checking if a feature is enabled. For example, say that we
+always want to check if a feature is enabled for the currently logged in user (`Current.user`). Then we might add this configuration:
 ```ruby
-Flipside.enabled? "MyFeature", user
+Flipside.default_object = -> { Current.user }
 ```
-
-## UI
-Flipside comes with a sinatra web ui to mange feature flags. To mount this sinatra app in Rails add the following to your routes.rb file.
+Now we can check if a feature is enabled without needing to pass in `Current.user`:
 ```ruby
-mount Flipside::Web, at: '/flipside'
+# With `default_object` set then all we need is this
+Flipside.enabled? :some_feature
+
+# Which will be the same as
+Flipside.enabled? :some_feature, Current.user
+
+# Note: if we do pass in an argument, then `default_object ` will not be used:
+Flipside.enabled? :some_feature, Current.company # check current company instead of user.
 ```
-Note: you probably want to wrap this inside a constraints block to provide some authentication.
 
-![UI](/features.png)
 
+Typically this configuration should be declared in an initializer file.
 
-### Configuration
+```ruby
+# config/initializers/flipside.rb
+require 'flipside'
 
-Entities can be added to a feature by searching for records and adding them.
-![Start screen](/add_entity.png)
+Flipside.ui_back_path = "/"
+Flipside.create_missing_features = true
+Flipside.default_object = -> { Current.user }
+```
+
+#### Entities
+
+Entities can be added to a feature by searching for records.
+
+![Add an entity](/add_entity.png)
 
 To make this work, some configuration is required. Use the class method `Flipside.register_entity` for this.
 ```ruby
@@ -123,12 +180,59 @@ Flipside.register_entity(
   identified_by: :id
 )
 ```
-Typically this should be configured in an initializer file.
 
-The `.register_entity` method should be called once for each class that may be used as feature enablers.
-The `search_by` keyword argument, which may be a symbol or a proc, dictates how records are found from searching in the ui. When a symbol is given, then searches with an exact match on the corresponding attribute are returned. E.g. `User.where(name: query)`.
+The `.register_entity` method should be called once for each class that may be used as a feature enabler.
+The `search_by` keyword argument, which may be a `Symbol` or a `Proc`, dictates how records are found from searching in the ui.
+When a `Symbol` is given, e.g. `:name`, then entities with an exact match on the corresponding attribute are returned. I.e. `User.where(name: query)`.
+When a `Proc` is given, then this `Proc` is called with the search string and is expected to return an object responding to `to_a` (e.g. an AR collection).
+This gives us the flexibility to decide how to search for entities. For example, to search for users with matching first name or last name or an email
+starting with _query_, something like this could be used.
+```ruby
+Flipside.register_entity(
+  class_name: "User",
+  search_by: ->(str) { User.where("lower(first_name) = :name OR lower(last_name) = :name or email LIKE :str", name: str.downcase, str: "#{str}%") },
+)
+
+```
 
-TODO
+The `identified_by` keyword argument, sets the column used as primary key for the corresponding table. This defaults to `:id` and typically does need to be change.
+Currently composite keys are not supported.
+
+The `display_as` keyword argument, is used to configure how these entities show up in the combobox. When set to a `Symbol`, then this value is sent to the corresponding entity.
+For example, given the following setup. Users will be displayed with first name and last name:
+```ruby
+class User < ApplicationRecord
+  def name
+    [first_name, last_name].compact.map(&:capitalize).join(" ")
+  end
+end
+
+Flipside.register_entity(
+  class_name: "User",
+  display_as: :name,
+)
+```
+
+When a `Proc` is given, then it is expected to take an entity as input and return a string used for displaying the entity. The config above could then instead be done using:
+```ruby
+Flipside.register_entity(
+  class_name: "User",
+  display_as: ->(user) { [user.first_name, user.last_name].compact.map(&:capitalize).join(" ") }
+)
+```
+
+#### Roles
+
+Features can be enabled for certain roles, by searching for roles (by method name).
+
+![Add a role](/add_role.png)
+
+This is configured by calling the class method `Flipside.register_role` for each role to be added.
+Note a role consists of a class and a corresponding instance method.
+```ruby
+Flipside.register_role(class_name: "User", method_name: :admin?)
+Flipside.register_role(class_name: "User", method_name: :awesome?)
+```
 
 ## Development
 

data/lib/flipside/config/settings.rb

@@ -2,6 +2,16 @@ module Flipside
   module Config
     module Settings
       attr_accessor :ui_back_path, :create_missing_features
+      attr_writer :default_object
+
+      def default_object
+        case @default_object
+        when Proc
+          @default_object.call
+        else
+          @default_object
+        end
+      end
     end
   end
 end

data/lib/flipside/public/index.js

@@ -2,8 +2,10 @@ import { Application } from "@hotwired/stimulus"
 import ToggleController from "toggle_controller"
 import SearchController from "search_controller"
 import ModalController from "modal_controller"
+import InlineEditController from "inline_edit_controller"
 
 const application = Application.start()
 application.register("toggle", ToggleController)
 application.register("search", SearchController)
 application.register("modal", ModalController)
+application.register("inline-edit", InlineEditController)

data/lib/flipside/public/inline_edit_controller.js

@@ -0,0 +1,25 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class InlineEditController extends Controller {
+  static targets = ["read", "edit"];
+
+  edit() {
+    this.readTargets.forEach(element => {
+      element.classList.add("hidden")
+    })
+
+    this.editTargets.forEach(element => {
+      element.classList.remove("hidden")
+    })
+  }
+
+  cancel() {
+    this.editTargets.forEach(element => {
+      element.classList.add("hidden")
+    })
+    this.readTargets.forEach(element => {
+      element.classList.remove("hidden")
+    })
+  }
+}
+

data/lib/flipside/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flipside
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/flipside/views/layout.erb

@@ -10,7 +10,8 @@
         "@hotwired/stimulus": "https://cdn.jsdelivr.net/npm/@hotwired/stimulus/dist/stimulus.js",
         "toggle_controller": "/flipside/toggle_controller.js",
         "search_controller": "/flipside/search_controller.js",
-        "modal_controller": "/flipside/modal_controller.js"
+        "modal_controller": "/flipside/modal_controller.js",
+        "inline_edit_controller": "/flipside/inline_edit_controller.js"
       }
     }
     </script>

data/lib/flipside/views/show.erb

@@ -8,9 +8,31 @@
           <span class="font-semibold">Name:</span>
           <span class="font-bold text-lg text-slate-300"><%= feature.name %></span>
         </div>
-        <div class="mt-2 flex justify-between items-center">
-          <span class="font-semibold">Description:</span>
-          <span><%= feature.description %></span>
+				<div class="mt-2 flex justify-between items-center text-center" data-controller="inline-edit">
+          <div class="font-semibold">Description:</div>
+          <div data-inline-edit-target="read"><%= feature.description %></div>
+          <div class="ml-2 " data-inline-edit-target="read">
+            <button
+              class="px-2 py-1 rounded-lg bg-blue-900 text-xl text-slate-400 border border-blue-950 hover:bg-blue-800"
+              data-action="inline-edit#edit" >
+              Edit
+            </button>
+          </div>
+          <form action="<%= feature.href %>" method="post"  class="hidden ml-4 grow flex gap-2" data-inline-edit-target="edit">
+            <input type="hidden" name="_method" value="put" />
+            <input
+              type="text"
+              value="<%= feature.description %>"
+              name="description"
+              class="grow border text-slate-600 border-slate-300 rounded px-3 py-2 focus:outline-none focus:ring-2 focus:ring-blue-500" />
+              <button
+                type="button"
+                class="p-2 bg-slate-600 text-slate-300 font-semibold rounded hover:bg-slate-500"
+                data-action="inline-edit#cancel" >
+                Cancel
+              </button>
+              <button type="submit" class="p-2 bg-blue-900 font-semibold rounded hover:bg-blue-800">Update</button>
+          </form>
         </div>
       </div>
       <div class="mt-2 flex justify-between items-center">
@@ -39,7 +61,8 @@
             Edit
           </a>
         </span>
-      </div><div class="mt-2 grid grid-cols-3  items-center">
+      </div>
+      <div class="mt-2 grid grid-cols-3 items-center">
         <span class="font-semibold">Roles:</span>
         <span class="text-center"><%= feature.role_count_str %></span>
         <span class="text-right text-xl text-slate-400">

data/lib/flipside/web.rb

@@ -20,6 +20,12 @@ module Flipside
       erb :show, locals: {feature: FeaturePresenter.new(feature, base_path)}
     end
 
+    put "/feature/:name" do
+      feature.update(params.slice("description"))
+
+      redirect to(request.path_info), 303
+    end
+
     put "/feature/:name/toggle" do
       content_type :text
 

data/lib/flipside.rb

@@ -25,10 +25,14 @@ module Flipside
       feature = find_by(name:)
       return false unless feature
 
-      objects << nil if objects.empty?
+      objects = [default_object] if objects.empty?
       objects.any? { |object| feature.enabled? object }
     end
 
+    def disabled?(...)
+      !enabled?(...)
+    end
+
     def enable!(name)
       feature = find_by!(name:)
       feature.update(enabled: true)
@@ -64,11 +68,15 @@ module Flipside
       find_by(name:) || raise(NoSuchFeauture.new(name))
     end
 
+    def create(name:, description: nil)
+      Feature.create(name: name, description: description)
+    end
+
     def create_missing(name)
       trace = caller.find { |trace| !trace.start_with? __FILE__ }
       source, line, _ = trace.split(":")
       source = [source, line].join(":") if line.match?(/\d+/)
-      Feature.create(name:, description: "Created from #{source}")
+      create(name:, description: "Created from #{source}")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipside
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Sammy Henningsson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-30 00:00:00.000000000 Z
+date: 2025-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -106,6 +106,7 @@ files:
 - lib/flipside/config/settings.rb
 - lib/flipside/feature_presenter.rb
 - lib/flipside/public/index.js
+- lib/flipside/public/inline_edit_controller.js
 - lib/flipside/public/modal_controller.js
 - lib/flipside/public/search_controller.js
 - lib/flipside/public/toggle_controller.js