flipside 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 982b83a0163d681b2b82a9d2e6d8315044e28b74c7fa437f0b9b267f2e409a90
-  data.tar.gz: fc0cabac07632fe04647b28af3cecf2fc5cd8400ca5c33107831812f0551ad65
+  metadata.gz: e49af6fc8d31128f0e88089ad6d46ce1745a223a68c4f5e4f2e5353f99091073
+  data.tar.gz: cb1547b1c3892b363830aa5f75375998092b90f150e6a275b3224051b6eb3b19
 SHA512:
-  metadata.gz: a076c81b783ed62ae7975373048c5a0cb4b3575971840c7f190ba4dc2a2cbd9ef9d3a5524e1b4375d0d8712f77317fea4f0a9dbd4d4547290c1a75483d8739da
-  data.tar.gz: 887476b87ce17f6069d9b6dfef90e693399e43b16877aae67cc636aa0008b288c6d49ef19e66ecf76ad428bc75df04ce7878f00ab0d8cecb18e29321c4b390a5
+  metadata.gz: cc95be97c95f5c6285d4eb57e6b378b47277d61e43f6606eb44bf9c9c6f914a2b6019c4a143c8b9a5058c64eac6ea0f4cffbecf7138ad3836ca0dcb196515c22
+  data.tar.gz: fb5262d598dea36dd87e7c987ae1d263500b2bc7e39882d7da5a119a6c11aab009821d7981732a442176985054900355e6bcf2b8d2b0fa68eab99e03a6469337

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [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

data/README.md

@@ -58,7 +58,7 @@ Flipside::Feature.create(
 )
 ```
 
-Features can be enabled for a certain record, typically a certain record or organization. This records are called entities. To enable a feature for a given record use.
+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
@@ -67,7 +67,7 @@ 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.
+for all users how are admins, using the `.add_role` method:
 ```ruby
 user1 = User.new(admin: false)
 user2 = User.new(admin: true)
@@ -104,13 +104,32 @@ Flipside comes with a sinatra web ui to mange feature flags. To mount this sinat
 ```ruby
 mount Flipside::Web, at: '/flipside'
 ```
+Note: you probably want to wrap this inside a constraints block to provide some authentication.
 
-Note: you also 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
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests.

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/version.rb

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

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 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
 
@@ -52,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.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sammy Henningsson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-29 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