flipside 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10dcbfd4da7a00053fc1e9486c54312a0010096deeec169368e251dd173a6c41
+  data.tar.gz: 0327eac1507849ce0ae681a37af3ca5b09af9d642331619879cfd2e876f97462
+SHA512:
+  metadata.gz: 1380f6f03f37f95a4f567ea840534e371a963fa1380bde5424981651d558761c642f67ba9cbc9bc14fac90ee0dc9393020a3bb13ca809b0e5206cea7c542ffe9
+  data.tar.gz: f9827baa63d88ec20224c8e5bb356af5ac03271714a0db706359e53b157a28e03108a2be5c729fd83e58a39d443dc548b4e7bdcdebe591fce706b7839bae8d55

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-11-22
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Sammy Henningsson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Flipside
+
+**Flipside** is a gem for managing feature flags in your Rails applications.
+
+---
+
+## Features
+
+- enable or disable features globally
+- enable features for specific records (e.g. users, organizations)
+- enabled features for objects responding `true` to a certain method
+- Setting a start and end time for when the feature is active
+
+---
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add flipside
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install flipside
+
+Then run 
+
+    $ rails generate flipside:install
+
+This will create a migration file. Run the migration, to add the flipside tables
+
+    $ rails db:migrate
+
+## Usage
+
+1. Defining Features
+
+Feature 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")
+```
+
+By default features are turned off. If you would like it turned on from the beginning you could pass in `enabled: true`.
+
+2. Checking Feature Status
+
+#### Globally
+
+Check if a feature is enabled globally:
+
+```ruby
+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?`):
+
+```ruby
+Flipside.enabled? "MyFeature", user
+```
+
+## Configuration
+TODO
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[sammyhenningsson]/flipside.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/models/flipside/checks.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Flipside
+  module Checks
+    def add_check(&block)
+      checks << block
+    end
+
+    def checks
+      @checks ||= []
+    end
+  end
+end

data/app/models/flipside/entities.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "models/flipside/entity"
+
+module Flipside
+  module Entities
+    def self.included(base)
+      base.has_many :entities, foreign_key: :feature_id
+
+      base.add_check do |entity|
+        entity && entities.where(flippable: entity).exists?
+      end
+    end
+  end
+end

data/app/models/flipside/entity.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Flipside
+  # A join table to map entities to a Feature
+  class Entity < ::ActiveRecord::Base
+    self.table_name = "flipside_entities"
+
+    belongs_to :feature
+    belongs_to :flippable, polymorphic: true
+  end
+end

data/app/models/flipside/feature.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "models/flipside/checks"
+require "models/flipside/entities"
+require "models/flipside/roles"
+
+module Flipside
+  class Feature < ::ActiveRecord::Base
+    extend Checks
+    include Entities
+    include Roles
+
+    self.table_name = "flipside_features"
+
+    def enabled?(object = nil)
+      return false unless active?
+      return true if enabled
+
+      self.class.checks.any? { |check| instance_exec(object, &check) }
+    end
+
+    def active?
+      activated? && !deactivated?
+    end
+
+    private
+
+    def activated?
+      return true if activated_at.nil?
+
+      activated_at <= Time.current
+    end
+
+    def deactivated?
+      return false if deactivated_at.nil?
+
+      deactivated_at <= Time.current
+    end
+  end
+end

data/app/models/flipside/key.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Flipside
+  # This class piggybacks on the Role class. They both need the same data, so
+  # it feels a bit unnecessary to have two similar db tables.
+  class Key < Role
+    KEY_CLASS = "_FlipsideKey_"
+
+    after_initialize { self.class_name = KEY_CLASS }
+    attr_readonly :class_name
+
+    alias_attribute :key, :method
+  end
+end

data/app/models/flipside/keys.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "models/flipside/key"
+
+module Flipside
+  module Keys
+    def self.included(base)
+      validate_roles! base
+      base.add_check { |key| enabled_for? key.to_s }
+    end
+
+    def self.validate_roles!(base)
+      return if base.ancestors.include? Roles
+      raise "Internal error in Flipside: Roles module has not been loaded"
+    end
+
+    def enabled_for?(key)
+      return false if key.blank?
+
+      roles.where(
+        class_name: Key::KEY_CLASS,
+        method: key
+      ).exists?
+    end
+  end
+end

data/app/models/flipside/role.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Flipside
+  # A join table to map roles to a Feature
+  class Role < ::ActiveRecord::Base
+    self.table_name = "flipside_roles"
+
+    belongs_to :feature
+  end
+end

data/app/models/flipside/roles.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "models/flipside/role"
+
+module Flipside
+  module Roles
+    def self.included(base)
+      base.has_many :roles, foreign_key: :feature_id
+      base.add_check { |object| has_role? object }
+    end
+
+    def has_role?(object)
+      return false unless object
+
+      methods = lookup_methods_for(object)
+      methods.any? { |method| object.public_send(method) }
+    end
+
+    def lookup_methods_for(object)
+      roles
+        .where(class_name: object.class.to_s)
+        .pluck(:method)
+        .select { |method| object.respond_to?(method) }
+    end
+  end
+end

data/lib/flipside/config/entities.rb

@@ -0,0 +1,40 @@
+require "flipside/config/registered_entity"
+
+module Flipside
+  module Config
+    module Entities
+      def register_entity(class_name:, search_by:, display_as:, identified_by: :id)
+        registered_entities[class_name.to_s] = RegisteredEntity.new(
+          class_name:,
+          search_by:,
+          display_as:,
+          identified_by:
+        )
+      end
+
+      def entity_classes
+        registered_entities.keys
+      end
+
+      def search_entity(class_name:, query:)
+        registered_entities.fetch(class_name.to_s).search(query)
+      end
+
+      def find_entity(class_name:, identifier:)
+        registered_entities.fetch(class_name.to_s).find(identifier)
+      end
+
+      def display_entity(entity)
+        registered_entities
+          .fetch(entity.class.to_s)
+          .display(entity)
+      end
+
+      private
+
+      def registered_entities
+        @registered_entities ||= {}
+      end
+    end
+  end
+end

data/lib/flipside/config/registered_entity.rb

@@ -0,0 +1,60 @@
+require "flipside/search_result"
+
+module Flipside
+  class RegisteredEntity
+    attr_reader :class_name, :search_by, :display_as, :identified_by
+
+    def initialize(class_name:, identified_by: :id, search_by: nil, display_as: nil)
+      @class_name = class_name
+      @search_by = search_by
+      @display_as = display_as
+      @identified_by = identified_by
+    end
+
+    def search(query)
+      Array(lookup_proc.call(query)).map do |entity|
+        SearchResult.new(
+          entity,
+          display(entity),
+          entity.public_send(identified_by)
+        )
+      end
+    end
+
+    def find(identifier)
+      class_name.constantize.find_by!("#{identified_by}": identifier)
+    end
+
+    def display(entity)
+      display_proc.call(entity)
+    end
+
+    private
+
+    def lookup_proc
+      @lookup_proc ||=
+        case search_by
+        when Proc
+          search_by
+        when Symbol
+          ->(query) { class_name.constantize.where("#{search_by}": query) }
+        else
+          ->(query) { class_name.constantize.where("#{identified_by}": query) }
+        end
+    end
+
+    def display_proc
+      @display_proc ||=
+        case display_as
+        when Proc
+          display_as
+        when Symbol
+          ->(entity) { entity.public_send(display_as) }
+        when String
+          ->(entity) { display_as }
+        else
+          ->(entity) { entity.public_send(identified_by) }
+        end
+    end
+  end
+end

data/lib/flipside/config/registered_role.rb

@@ -0,0 +1,43 @@
+require "flipside/search_result"
+
+module Flipside
+  class RegisteredRole
+    attr_reader :class_name, :method_name, :display_as
+
+    def initialize(class_name:, method_name:, display_as: nil)
+      @class_name = class_name
+      @method_name = method_name
+      @display_as = display_as || method_name.to_s
+    end
+
+    def to_result
+      SearchResult.new(
+        nil,
+        display,
+        method_name
+      )
+    end
+
+    def match?(query)
+      query = query.to_s.downcase
+      method_name.to_s.downcase.include?(query) ||
+        display.to_s.downcase.include?(query)
+    end
+
+    def display
+      display_proc.call
+    end
+
+    private
+
+    def display_proc
+      @display_proc ||=
+        case display_as
+        when Proc
+          display_as
+        else
+          -> { display_as }
+        end
+    end
+  end
+end

data/lib/flipside/config/roles.rb

@@ -0,0 +1,33 @@
+require "flipside/config/registered_role"
+
+module Flipside
+  module Config
+    module Roles
+      def register_role(class_name:, method_name:, display_as: nil)
+        registered_roles[class_name.to_s] ||= []
+        registered_roles[class_name.to_s] << RegisteredRole.new(
+          class_name:,
+          method_name:,
+          display_as:
+        )
+      end
+
+      def role_classes
+        registered_roles.keys
+      end
+
+      def search_role(class_name:, query:)
+        registered_roles.fetch(class_name.to_s).filter_map do |registered_role|
+          next unless registered_role.match? query
+          registered_role.to_result
+        end
+      end
+
+      private
+
+      def registered_roles
+        @registered_roles ||= {}
+      end
+    end
+  end
+end

data/lib/flipside/feature_presenter.rb

@@ -0,0 +1,111 @@
+require 'forwardable'
+
+class FeaturePresenter
+  extend Forwardable
+  attr_reader :feature, :base_path
+
+  def_delegators :@feature, :name, :description, :enabled, :entities, :roles
+
+  def initialize(feature, base_path)
+    @feature = feature
+    @base_path = base_path
+  end
+
+  def href
+    File.join(base_path, "feature", name)
+  end
+
+  def toggle_path
+    File.join(href, "toggle")
+  end
+
+  def back_path
+    base_path
+  end
+
+  def entities_path
+    File.join(href, "entities")
+  end
+
+  def add_entity_path
+    File.join(href, "add_entity")
+  end
+
+  def remove_entity_path
+    File.join(href, "remove_entity")
+  end
+
+  def roles_path
+    File.join(href, "roles")
+  end
+
+  def add_role_path
+    File.join(href, "add_role")
+  end
+
+  def remove_role_path
+    File.join(href, "remove_role")
+  end
+
+  def status
+    if feature.active?
+      "active"
+    else
+      "inactive"
+    end
+  end
+
+  def status_color
+    if feature.active?
+      deactivates_soon? ? "bg-orange-600" : "bg-green-600"
+    elsif activates_soon?
+      "bg-yellow-600"
+    else
+      "bg-zinc-600"
+    end
+  end
+
+  def activated_at
+    feature.activated_at&.strftime("%Y-%m-%d %H:%M")
+  end
+
+  def deactivated_at
+    feature.deactivated_at&.strftime("%Y-%m-%d %H:%M")
+  end
+
+  def activates_soon?(period = 60 * 60 * 24)
+    return false if feature.active?
+    return false if feature.activated_at.nil?
+
+    feature.activated_at <= Time.now + period
+  end
+
+  def deactivates_soon?(period = 60 * 60 * 24)
+    return false unless feature.active?
+    return false if feature.deactivated_at.nil?
+
+    feature.deactivated_at <= Time.now + period
+  end
+
+  def entity_count_str
+    count = feature.entities.count
+    if count == 1
+      "Enabled for one entity"
+    elsif count.positive?
+      "Enabled for #{count} entities"
+    else
+      ""
+    end
+  end
+
+  def role_count_str
+    count = feature.roles.count
+    if count == 1
+      "Enabled for one role"
+    elsif count.positive?
+      "Enabled for #{count} roles"
+    else
+      ""
+    end
+  end
+end

data/lib/flipside/search_result.rb

@@ -0,0 +1,11 @@
+module Flipside
+  class SearchResult
+    attr_reader :object, :display_as, :identifier
+
+    def initialize(object, display_as, identifier)
+      @object = object
+      @display_as = display_as
+      @identifier = identifier
+    end
+  end
+end

data/lib/flipside/version.rb

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

data/lib/flipside/views/_datetime_modal.erb

@@ -0,0 +1,37 @@
+<div data-controller="modal">
+  <button
+    class="p-2 rounded-lg hover:bg-slate-600"
+    data-action="click->modal#open">
+    <%= feature.public_send(attribute) || "Not set" %>
+  </button>
+
+  <dialog data-modal-target="dialog" class="hidden fixed inset-0 flex items-center justify-center bg-black/50">
+    <div class="flex flex-col bg-slate-500 rounded-lg shadow-lg w-full max-w-xl p-6">
+      <div class="flex justify-end space-x-2">
+        <button
+          type="button"
+          class="px-2 bg-gray-300 text-gray-700 rounded hover:bg-gray-400"
+          data-action="modal#close">
+          X
+        </button>
+      </div>
+      <div class="mt-4">
+        <form action="<%= feature.href %>" method="post">
+          <input type="hidden" name="_method" value="put" />
+          <%# <input type="hidden" name="feature_name" value="<%= feature.name %1>" /> %>
+          <label class="font-bold text-slate-800">Update <%= attribute %></label>
+          <input
+            type="datetime-local"
+            class="block mt-1 p-2 rounded-lg bg-slate-300 text-slate-600 border border-slate-400"
+            name="<%= attribute %>"
+            value="<%= feature.public_send(attribute) %>" />
+          <button
+            type="submit"
+            class="block mt-4 mx-auto p-2 rounded-lg text-slate-300 bg-blue-900 border border-blue-950 hover:bg-blue-800">
+            Save
+          </button>
+        </form>
+      </div>
+    </div>
+  </dialog>
+</div>

data/lib/flipside/views/_feature_item.erb

@@ -0,0 +1,10 @@
+<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>
+  <div class="text-right">
+    <%= erb :_toggle_button, locals: {feature:} %>
+  </div>
+</div>

data/lib/flipside/views/_search_result.erb

@@ -0,0 +1,9 @@
+<% if result.present? %>
+  <% result.map do |r| %>
+    <option value="<%= r.identifier %>" class="text-slate-800 p-2 rounded-md hover:bg-slate-300">
+    <%= r.display_as %>
+    </option>
+  <% end %>
+<% else %>
+  <div class="text-slate-800 p-2">No <%= class_name %> matched "<%= query %>"</div>
+<% end %>

data/lib/flipside/views/_toggle_button.erb

@@ -0,0 +1,12 @@
+<% color = feature.enabled ? "bg-blue-700" : "bg-gray-200" %>
+<% translate = feature.enabled ? "translate-x-5" : "translate-x-0" %>
+
+<button type="button"
+        class="relative inline-flex h-6 w-11 shrink-0 cursor-pointer rounded-full border-2 border-transparent <%= color %>"
+        data-controller="toggle"
+        data-action="click->toggle#switch:prevent"
+        data-toggle-url-value="<%= feature.toggle_path %>"
+        data-toggle-enabled-value="<%= feature.enabled %>"
+        >
+        <span aria-hidden="true" class="pointer-events-none inline-block size-5 <%= translate %> transform rounded-full bg-white shadow"></span>
+</button>

data/lib/flipside/views/feature_entities.erb

@@ -0,0 +1,68 @@
+<div class="m-12">
+  <a href="<%= feature.href %>" class="p-2 rounded-lg text-xl text-slate-300 bg-blue-900 border border-blue-950 hover:bg-blue-800">Back</a>
+  <div class="mt-12 w-1/3 m-auto bg-gray-800 text-slate-400 p-8 rounded-lg shadow-lg">
+    <h1 class="text-2xl font-bold mb-6">Entities for <span class="font-extrabold text-slate-300"><%= feature.name %></span></h1>
+    <h2 class="text-xl font-bold">Add entity</h2>
+    <form action="<%= feature.add_entity_path %>" method="post">
+      <div data-controller="search" data-search-url-value="/flipside/search_entity" class="w-full flex p-0 gap-2 items-center">
+        <select
+          name="class_name"
+          data-search-target="param"
+          data-search-param="class_name"
+          data-action="search#clearAll"
+          class="border text-slate-600 border-gray-300 rounded px-3 py-2 focus:outline-none focus:ring-2 focus:ring-blue-500">
+          <% Flipside.entity_classes.each do |class_name| %>
+            <option value="<%= class_name %>"><%= class_name %></option>
+          <% end %>
+        </select>
+
+        <input
+          type="hidden"
+          data-search-target="value"
+          name="identifier" />
+        <div class="ml-2 relative flex-grow">
+          <input
+            type="text"
+            autocomplete="off"
+            data-action="search#search"
+            data-search-target="input"
+            placeholder="Search..."
+            class="w-full border text-slate-600 border-gray-300 rounded px-3 py-2 focus:outline-none focus:ring-2 focus:ring-blue-500" />
+          <div
+            class="mt-2 rounded-md absolute left-0 top-full w-full bg-slate-400 bg-border shadow-lg z-10"
+            data-search-target="results"
+            data-action="click->search#select" >
+          </div>
+        </div>
+        <button
+          type="submit"
+          disabled="true"
+          data-search-target="addButton"
+          class="ml-2 p-2 bg-gray-600 text-gray-700 font-semibold rounded" >
+          Add
+        </button>
+      </div>
+    </form>
+
+    <div class="mt-8">
+      <h2 class="text-xl font-bold">Enabled entities</h2>
+      <ul>
+        <% feature.entities.each do |entity| %>
+          <li class="mt-2 p-2 bg-slate-700 text-slate-300 border border-slate-600 rounded-lg">
+            <div class="flex justify-between items-center">
+              <div>
+                <%= Flipside.display_entity(entity.flippable) %> (<%= entity.flippable_type %>)
+              </div>
+              <div>
+                <form action="<%= feature.remove_entity_path %>" method="post">
+                  <input type="hidden" name="entity_id" value="<%= entity.id %>" />
+                  <button type="submit" class="p-2 bg-gray-300 text-gray-700 font-semibold rounded hover:bg-gray-400">Remove</button>
+                </form>
+              </div>
+            </div>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  </div>
+</div>

data/lib/flipside/views/feature_roles.erb

@@ -0,0 +1,68 @@
+<div class="m-12">
+  <a href="<%= feature.href %>" class="p-2 rounded-lg text-xl text-slate-300 bg-blue-900 border border-blue-950 hover:bg-blue-800">Back</a>
+  <div class="mt-12 w-1/3 m-auto bg-gray-800 text-slate-400 p-8 rounded-lg shadow-lg">
+    <h1 class="text-2xl font-bold mb-6">Roles for <span class="font-extrabold text-slate-300"><%= feature.name %></span></h1>
+    <h2 class="text-xl font-bold">Add Role</h2>
+    <form action="<%= feature.add_role_path %>" method="post">
+      <div data-controller="search" data-search-url-value="/flipside/search_role" class="w-full flex p-0 gap-2 items-center">
+        <select
+          name="class_name"
+          data-search-target="param"
+          data-search-param="class_name"
+          data-action="search#clearAll"
+          class="border text-slate-600 border-gray-300 rounded px-3 py-2 focus:outline-none focus:ring-2 focus:ring-blue-500">
+          <% Flipside.role_classes.each do |class_name| %>
+            <option value="<%= class_name %>"><%= class_name %></option>
+          <% end %>
+        </select>
+
+        <input
+          type="hidden"
+          data-search-target="value"
+          name="identifier" />
+        <div class="ml-2 relative flex-grow">
+          <input
+            type="text"
+            autocomplete="off"
+            data-action="search#search"
+            data-search-target="input"
+            placeholder="Search..."
+            class="w-full border text-slate-600 border-gray-300 rounded px-3 py-2 focus:outline-none focus:ring-2 focus:ring-blue-500" />
+          <div
+            class="mt-2 rounded-md absolute left-0 top-full w-full bg-slate-400 bg-border shadow-lg z-10"
+            data-search-target="results"
+            data-action="click->search#select" >
+          </div>
+        </div>
+        <button
+          type="submit"
+          disabled="true"
+          data-search-target="addButton"
+          class="ml-2 p-2 bg-gray-600 text-gray-700 font-semibold rounded" >
+          Add
+        </button>
+      </div>
+    </form>
+
+    <div class="mt-8">
+      <h2 class="text-xl font-bold">Enabled Roles</h2>
+      <ul>
+        <% feature.roles.each do |role| %>
+          <li class="mt-2 p-2 bg-slate-700 text-slate-300 border border-slate-600 rounded-lg">
+            <div class="flex justify-between items-center">
+              <div>
+                <%= "#{role.class_name}##{role.method}" %>
+              </div>
+              <div>
+                <form action="<%= feature.remove_role_path %>" method="post">
+                  <input type="hidden" name="role_id" value="<%= role.id %>" />
+                  <button type="submit" class="p-2 bg-gray-300 text-gray-700 font-semibold rounded hover:bg-gray-400">Remove</button>
+                </form>
+              </div>
+            </div>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  </div>
+</div>

data/lib/flipside/views/index.erb

@@ -0,0 +1,15 @@
+<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>
+</div>

data/lib/flipside/views/layout.erb

@@ -0,0 +1,25 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <script src="https://cdn.tailwindcss.com"></script>
+    <script type="importmap">
+      {
+      "imports": {
+        "@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"
+      }
+    }
+    </script>
+  </head>
+  <body class="w-full h-full bg-slate-600">
+    <div id="main">
+      <%= yield %>
+    </div>
+
+    <script src="/flipside/index.js" type="module" ></script>
+  </body>
+</html>

data/lib/flipside/views/not_found.erb

@@ -0,0 +1 @@
+<h1 class="mt-12 text-center text-slate-300 text-3xl font-semibold">This resource could not be found!</h1>

data/lib/flipside/views/show.erb

@@ -0,0 +1,55 @@
+<div class="m-12">
+  <a href="<%= feature.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>
+  <div class="mt-12 w-1/2 m-auto bg-gray-800 text-slate-400 p-8 rounded-lg shadow-lg">
+    <h1 class="text-2xl font-bold mb-6">Feature Details</h1>
+    <div class="mt-4 grid grid-cols-1 gap-4">
+      <div class="pb-6 border-b border-gray-600">
+        <div class="mt-2 flex justify-between items-center">
+          <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>
+      </div>
+      <div class="mt-2 flex justify-between items-center">
+        <span class="font-semibold">Enabled for all:</span>
+        <span><%= erb :_toggle_button, locals: {feature:} %></span>
+      </div>
+      <div class="mt-2 flex justify-between items-center">
+        <span class="font-semibold">Active From:</span>
+        <span>
+          <%= erb :_datetime_modal, locals: {feature:, attribute: :activated_at} %>
+        </span>
+      </div>
+      <div class="mt-2 flex justify-between items-center">
+        <span class="font-semibold">Active Until:</span>
+        <span>
+          <%= erb :_datetime_modal, locals: {feature:, attribute: :deactivated_at} %>
+        </span>
+      </div>
+      <div class="mt-2 grid grid-cols-3 items-center">
+        <span class="font-semibold">Entities:</span>
+        <span class="text-center"><%= feature.entity_count_str %></span>
+        <span class="text-right text-xl text-slate-400">
+          <a
+            href="<%= feature.entities_path %>"
+            class="px-2 py-1 rounded-lg bg-blue-900 border border-blue-950 hover:bg-blue-800" >
+            Edit
+          </a>
+        </span>
+      </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">
+          <a
+            href="<%= feature.roles_path %>"
+            class="px-2 py-1 rounded-lg bg-blue-900 border border-blue-950 hover:bg-blue-800" >
+            Edit
+          </a>
+        </span>
+      </div>
+    </div>
+  </div>
+</div>

data/lib/flipside/web.rb

@@ -0,0 +1,99 @@
+require "sinatra"
+require "uri"
+require "flipside/feature_presenter"
+
+module Flipside
+  class Web < Sinatra::Base
+    not_found do
+      erb :not_found
+    end
+
+    get "/" do
+      features = Flipside::Feature.order(:name).map do |feature|
+        FeaturePresenter.new(feature, base_path)
+      end
+
+      erb :index, locals: {features:}
+    end
+
+    get "/feature/:name" do
+      erb :show, locals: {feature: FeaturePresenter.new(feature, base_path)}
+    end
+
+    put "/feature/:name/toggle" do
+      content_type :text
+
+      if feature.update(enabled: !feature.enabled)
+        204
+      else
+        [422, "Failed to update feature"]
+      end
+    end
+
+    put "/feature/:name" do
+      kwargs = params.slice("activated_at", "deactivated_at")
+      feature.update(**kwargs)
+      redirect to("/feature/#{params["name"]}"), 303
+    end
+
+    get "/feature/:name/entities" do
+      erb :feature_entities, locals: {feature: FeaturePresenter.new(feature, base_path)}
+    end
+
+    get '/search_entity' do
+      class_name = params[:class_name]
+      query = URI.decode_www_form_component(params[:q])
+      result = Flipside.search_entity(class_name:, query:)
+
+      erb :_search_result, locals: {result:, class_name:, query:}
+    end
+
+    post "/feature/:name/add_entity" do
+      name, class_name, identifier = params.values_at("name", "class_name", "identifier")
+
+      entity = Flipside.find_entity(class_name:, identifier:)
+      Flipside.add_entity(name: , entity:)
+      redirect to("/feature/#{name}/entities"), 303
+    end
+
+    post "/feature/:name/remove_entity" do
+      Flipside.remove_entity(name: params["name"], entity_id: params["entity_id"])
+      redirect to("/feature/#{params["name"]}/entities"), 303
+    end
+
+    get "/feature/:name/roles" do
+      erb :feature_roles, locals: {feature: FeaturePresenter.new(feature, base_path)}
+    end
+
+    get '/search_role' do
+      class_name = params[:class_name]
+      query = URI.decode_www_form_component(params[:q])
+      result = Flipside.search_role(class_name:, query:)
+
+      erb :_search_result, locals: {result:, class_name:, query:}
+    end
+
+    post "/feature/:name/add_role" do
+      name, class_name, method_name = params.values_at("name", "class_name", "identifier")
+      Flipside.add_role(name:, class_name:, method_name:)
+
+      redirect to("/feature/#{name}/roles"), 303
+    end
+
+    post "/feature/:name/remove_role" do
+      Flipside.remove_role(name: params["name"], role_id: params["role_id"])
+
+      redirect to("/feature/#{params["name"]}/roles"), 303
+    end
+
+    def feature
+      @feature ||= Flipside::Feature.find_by!(name: params["name"])
+    rescue
+      halt 404, "This feature does not exist"
+    end
+
+    def base_path
+      @base_path ||= request.script_name
+    end
+  end
+end

data/lib/flipside.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "flipside/version"
+require "flipside/web"
+require "flipside/config/entities"
+require "flipside/config/roles"
+require "models/flipside/feature"
+
+module Flipside
+  extend Config::Entities
+  extend Config::Roles
+
+  class Error < StandardError; end
+
+  class NoSuchFeauture < Error
+    def initialize(name)
+      super("There's no feature named '#{name}'")
+    end
+  end
+
+  class << self
+    def enabled?(name, object = nil)
+      feature = find_by(name:)
+      return false unless feature
+
+      feature.enabled? object
+    end
+
+    def enable!(name)
+      feature = find_by!(name:)
+      feature.update(enabled: true)
+    end
+
+    def add_entity(name:, entity:)
+      feature = find_by!(name:)
+      Entity.find_or_create_by(feature:, flippable: entity)
+    end
+
+    def remove_entity(name:, entity_id:)
+      feature = find_by!(name:)
+      feature.entities.find_by(id: entity_id)&.destroy
+    end
+
+    def add_role(name:, class_name:, method_name:)
+      feature = find_by!(name:)
+      Role.find_or_create_by(feature:, class_name:, method: method_name)
+    end
+
+    def remove_role(name:, role_id:)
+      feature = find_by!(name:)
+      feature.roles.find_by(id: role_id)&.destroy
+    end
+
+    def find_by(name:)
+      Feature.find_by(name:)
+    end
+
+    def find_by!(name:)
+      find_by(name:) || raise(NoSuchFeauture.new(name))
+    end
+  end
+end

data/lib/generators/flipside/install/install_generator.rb

@@ -0,0 +1,20 @@
+# require "rails/generators"
+require "rails/generators/active_record"
+
+module Flipside
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      # Makes this generator available as "rails generate feature_flags:install"
+      source_root File.expand_path("templates", __dir__)
+
+      def create_migration_file
+        # Check if the migration file already exists to avoid duplicates
+        unless ActiveRecord::Base.connection.table_exists?("flipside")
+          migration_template "20241122_create_flipside_migration.rb", "db/migrate/create_flipside_migration.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/flipside/install/templates/20241122_create_flipside_migration.rb

@@ -0,0 +1,28 @@
+class CreateFlipsideMigration < ActiveRecord::Migration[6.1]
+  def change
+    create_table :flipside_features do |t|
+      t.string :name, null: false
+      t.string :description
+      t.boolean :enabled, default: false, null: false
+      t.datetime :activated_at
+      t.datetime :deactivated_at
+      t.timestamps
+    end
+
+    create_table :flipside_entities do |t|
+      t.belongs_to :feature, null: false
+      t.bigint :flippable_id, null: false
+      t.string :flippable_type, null: false
+      t.timestamps
+    end
+
+    create_table :flipside_roles do |t|
+      t.belongs_to :feature, null: false
+      t.string :class_name, null: false
+      t.string :method, null: false
+      t.timestamps
+    end
+
+    add_index :flipside_features, :name, unique: true
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: flipside
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sammy Henningsson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: Create simple feature toggles.
+email:
+- sammy.henningsson@apoex.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- app/models/flipside/checks.rb
+- app/models/flipside/entities.rb
+- app/models/flipside/entity.rb
+- app/models/flipside/feature.rb
+- app/models/flipside/key.rb
+- app/models/flipside/keys.rb
+- app/models/flipside/role.rb
+- app/models/flipside/roles.rb
+- lib/flipside.rb
+- lib/flipside/config/entities.rb
+- lib/flipside/config/registered_entity.rb
+- lib/flipside/config/registered_role.rb
+- lib/flipside/config/roles.rb
+- lib/flipside/feature_presenter.rb
+- lib/flipside/search_result.rb
+- lib/flipside/version.rb
+- lib/flipside/views/_datetime_modal.erb
+- lib/flipside/views/_feature_item.erb
+- lib/flipside/views/_search_result.erb
+- lib/flipside/views/_toggle_button.erb
+- lib/flipside/views/feature_entities.erb
+- lib/flipside/views/feature_roles.erb
+- lib/flipside/views/index.erb
+- lib/flipside/views/layout.erb
+- lib/flipside/views/not_found.erb
+- lib/flipside/views/show.erb
+- lib/flipside/web.rb
+- lib/generators/flipside/install/install_generator.rb
+- lib/generators/flipside/install/templates/20241122_create_flipside_migration.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- app
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Feature flags.
+test_files: []