flipside 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40777dd3225cce9bdb82e6d66301c8612a7284a51011610203cf717e6b68d2bc
-  data.tar.gz: 26f0f2f2570389e80c76ebc3cdb347ff328d504b6291a4ba50d3df88d1c61a91
+  metadata.gz: e49af6fc8d31128f0e88089ad6d46ce1745a223a68c4f5e4f2e5353f99091073
+  data.tar.gz: cb1547b1c3892b363830aa5f75375998092b90f150e6a275b3224051b6eb3b19
 SHA512:
-  metadata.gz: 88e26979066424e8474657fe29818254e85ac182113513bfb9fae0849fd73c9c54541c7e1cbca2f33a98e41b01b1c8b54c5c9adcb6613000fa99c181086128bd
-  data.tar.gz: 899954def9a08cbdd895683e2975e32e59ab2ab1147d423460be32db25eeb764342124dfe7b89aacbf95abcca6613181cfb9470b1c377cfd25c83ddbfbb71757
+  metadata.gz: cc95be97c95f5c6285d4eb57e6b378b47277d61e43f6606eb44bf9c9c6f914a2b6019c4a143c8b9a5058c64eac6ea0f4cffbecf7138ad3836ca0dcb196515c22
+  data.tar.gz: fb5262d598dea36dd87e7c987ae1d263500b2bc7e39882d7da5a119a6c11aab009821d7981732a442176985054900355e6bcf2b8d2b0fa68eab99e03a6469337

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-## [Unreleased]
+## [0.2.1] - 2025-01-30
+
+- Option to create missing features
+- Option to set link back to main application
+
+## [0.2.0] - 2025-01-29
+
+- Support checking multiple objects at once
+- Show hover text for feature statuses
+- Support feature names with spaces
 
 ## [0.1.1] - 2024-11-22
 

data/README.md

@@ -35,12 +35,51 @@ This will create a migration file. Run the migration, to add the flipside tables
 
 1. Defining Features
 
-Feature are created by running this (in a console or from code):
+Features are created by running this (in a console or from code):
 ```ruby
-Flipside::Feature.create(name: "MyFeature", description: "Some optional description about what this feature do")
+Flipside::Feature.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`.
+```ruby
+Flipside::Feature.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.
+```ruby
+Flipside::Feature.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`:
+```ruby
+user = User.first
+Flipside.enabled? user # => false
+Flipside.add_entity(name: "MyFeature", user)
+Flipside.enabled? 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:
+```ruby
+user1 = User.new(admin: false)
+user2 = User.new(admin: true)
+Flipside.add_role(
+  name: "MyFeature",
+  class_name: "User",
+  method_name: :admin?
+)
+Flipside.enabled? user1 # => false
+Flipside.enabled? user2 # => true
+```
+
 
 2. Checking Feature Status
 
@@ -54,13 +93,41 @@ Flipside.enabled? "MyFeature"
 
 #### For a Specific Record
 
-Check if a feature is enabled for a specific record (e.g. a user, an organization or a user responding `true` to `user.admin?`):
+Check if a feature is enabled for a specific record (e.g. a user):
 
 ```ruby
 Flipside.enabled? "MyFeature", user
 ```
 
-## Configuration
+## 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.
+
+![UI](/features.png)
+
+
+### Configuration
+
+Entities can be added to a feature by searching for records and adding them.
+![Start screen](/add_entity.png)
+
+To make this work, some configuration is required. Use the class method `Flipside.register_entity` for this.
+```ruby
+Flipside.register_entity(
+  class_name: "User",
+  search_by: :name,
+  display_as: :name,
+  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)`.
+
 TODO
 
 ## Development

data/lib/flipside/config/settings.rb

@@ -0,0 +1,7 @@
+module Flipside
+  module Config
+    module Settings
+      attr_accessor :ui_back_path, :create_missing_features
+    end
+  end
+end

data/lib/flipside/feature_presenter.rb

@@ -12,7 +12,7 @@ class FeaturePresenter
   end
 
   def href
-    File.join(base_path, "feature", name)
+    File.join(base_path, "feature", ERB::Util.url_encode(name))
   end
 
   def toggle_path
@@ -87,6 +87,14 @@ class FeaturePresenter
     feature.deactivated_at <= Time.now + period
   end
 
+  def status_title
+    if activates_soon?
+      "Activates at: #{activated_at}"
+    elsif deactivates_soon?
+      "deactivates at: #{deactivated_at}"
+    end
+  end
+
   def entity_count_str
     count = feature.entities.count
     if count == 1

data/lib/flipside/version.rb

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

data/lib/flipside/views/_feature_item.erb

@@ -1,8 +1,12 @@
 <div class="p-4 grid grid-cols-12 gap-4 cursor-pointer text-slate-300">
   <div class="col-span-3 text-left text-xl"><%= feature.name %></div>
-  <div class="col-span-4 text-left text-lg"><%= feature.description&.capitalize %></div>
-  <div class="col-span-4 text-right text-lg font-normal">
-    <span class="inline-block py-1 px-2 min-w-20 text-center rounded-lg <%= feature.status_color %>"><%= feature.status %></span>
+  <div class="col-span-7 text-center text-lg"><%= feature.description&.capitalize %></div>
+  <div class="col-span-1 text-right text-lg font-normal">
+    <span
+      class="inline-block py-1 px-2 min-w-20 text-center rounded-lg <%= feature.status_color %>"
+      title="<%= feature.status_title %>">
+      <%= feature.status %>
+    </span>
   </div>
   <div class="text-right">
     <%= erb :_toggle_button, locals: {feature:} %>

data/lib/flipside/views/index.erb

@@ -1,15 +1,20 @@
-<div class="mt-12 w-3/4 m-auto bg-gray-800 text-slate-400 p-8 pb-24 rounded-lg shadow-lg">
-  <h1 class="text-3xl text-center font-bold mb-6">Flipside feature flags</h1>
+<div class="m-12">
+  <% if Flipside.ui_back_path %>
+    <a href="<%= Flipside.ui_back_path %>" class="p-2 rounded-lg text-xl text-slate-300 bg-blue-900 border border-blue-950 hover:bg-blue-800">Back</a>
+  <% end %>
+  <div class="mt-12 w-3/4 m-auto bg-gray-800 text-slate-400 p-8 pb-24 rounded-lg shadow-lg">
+    <h1 class="text-3xl text-center font-bold mb-6">Flipside feature flags</h1>
 
-  <div class="mt-12 w-3/4 m-auto">
-    <ul>
-      <% features.each do |feature| %>
-        <li class="border-b border-slate-500 hover:font-semibold">
-          <a href=<%= feature.href %>>
-            <%= erb :_feature_item, locals: {feature:} %>
-          </a>
-        </li>
-      <% end %>
-    </ul>
+    <div class="mt-12 m-auto">
+      <ul>
+        <% features.each do |feature| %>
+          <li class="border-b border-slate-500 hover:font-semibold">
+            <a href=<%= feature.href %>>
+              <%= erb :_feature_item, locals: {feature:} %>
+            </a>
+          </li>
+        <% end %>
+      </ul>
+    </div>
   </div>
 </div>

data/lib/flipside.rb

@@ -2,11 +2,13 @@
 
 require "flipside/version"
 require "flipside/web"
+require "flipside/config/settings"
 require "flipside/config/entities"
 require "flipside/config/roles"
 require "models/flipside/feature"
 
 module Flipside
+  extend Config::Settings
   extend Config::Entities
   extend Config::Roles
 
@@ -19,11 +21,12 @@ module Flipside
   end
 
   class << self
-    def enabled?(name, object = nil)
+    def enabled?(name, *objects)
       feature = find_by(name:)
       return false unless feature
 
-      feature.enabled? object
+      objects << nil if objects.empty?
+      objects.any? { |object| feature.enabled? object }
     end
 
     def enable!(name)
@@ -51,12 +54,21 @@ module Flipside
       feature.roles.find_by(id: role_id)&.destroy
     end
 
-    def find_by(name:)
-      Feature.find_by(name:)
+    def find_by(name:, create_on_missing: create_missing_features)
+      feature = Feature.find_by(name:)
+      feature ||= create_missing(name) if create_on_missing
+      feature
     end
 
     def find_by!(name:)
       find_by(name:) || raise(NoSuchFeauture.new(name))
     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}")
+    end
   end
 end

metadata

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