togglefy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a20296d9c30f3937ab02ace87872c15fe519a2ab6aaef86b1c5a3c4c331e5cf
+  data.tar.gz: da69eba486689763b59df5974c34cdddf8b42f3b93ea54ab3fa52507305ceb1b
+SHA512:
+  metadata.gz: 4e655f2ba4eea61ae0ad8311a2d0dab1c10ec997c6e09724f43c17282970a559199c2053f1f7b9a61ebab3a97142338ec9c60641709768a8759e4bdafde6d979
+  data.tar.gz: 515d922552d07a7e4c115d2d225dff3e659eb34daeb6c35ad059a8c798c1cf98f17794641dbaa525bc938f47c24fe0bc437146a97e0e646893b2e0562cfbfe4c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+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,273 @@
+# Togglefy
+
+Togglefy is a simple feature management solution to help you control which features an user or a group has access to.
+
+Togglefy is free, open source and you are welcome to help build it.
+
+## Installation
+
+### UNDER CONSTRUCTION BECAUSE GEM STILL NEEDS TO BE UPLOADED TO RUBYGEMS
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Add the gem manually to your Gemfile:
+
+```gemfile
+gem "togglefy"
+```
+
+Or install it and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+### First steps
+
+#### Installing inside the project
+After adding the gem to your project, you need to run the generate command to add the necessary files:
+```bash
+rails generate togglefy:install
+```
+
+This command will create the migrations to create the tables inside your project. Please, don't remove/change anything that's there or Togglefy may not work as expected.
+
+Run the migration to create these in your datase:
+```bash
+rails db:migrate
+```
+Or if you're using a legacy codebase:
+```bash
+rake db:migrate
+```
+
+The models are stored inside Togglefy, so you don't need to create them inside your project unless you want to.
+
+If that's something you want, you can check them following this path: `app/models/togglefy/`.
+
+After that, the next steps are also pretty simple.
+
+#### Including inside the Assignable
+
+Add the following to your model that will have a relation with the features. It can be an `User`, `Account` or something you decide:
+```ruby
+include Togglefy::Featureable
+```
+
+This will add the relationship between Togglefy's models and yours. Yours will be referred to as **assignable** throughout this documentation. If you want to check it in the source code, you can find it here: `lib/togglefy/featureable.rb` inside de `included` block.
+
+With that, everything is ready to use **Togglefy**, welcome!
+
+### Creating Features
+To create features it's as simple as drinking a nice cold beer after a hard day or drinking the entire bottle of coffee in a span of 1 hour:
+
+```ruby
+Togglefy::Feature.create(
+  name: "Magic",
+  description: "You're a Wizard, Harry"
+) # To create a simple Feature
+```
+
+If you have tenant, groups (or roles), difference between environments, you can do the following:
+
+```ruby
+Togglefy::Feature.create(
+  name: "Super Powers",
+  description: "With great power comes great responsibility", 
+  tenant_id: "123abc",
+  group: :admin,
+  environment: :production
+)
+```
+
+You don't have to fill all fields, the only one that is mandatory is the name, because is by using the name that we will create the unique identifier, which is the field we'll use to find, delete and more.
+
+The identifier is the name, downcased and snake_cased 🐍
+
+Whenever you create a `Togglefy::Feature`, you can expect something like this:
+
+```ruby
+id: 1,
+name: "Super Powers",
+identifier: "super_powers",
+description: "With great power comes great responsibility",
+created_at: "2025-04-12 01:39:10.176561000 +0000",
+updated_at: "2025-04-12 01:39:46.818928000 +0000",
+tenant: "123abc",
+group: "admin",
+environment: "production",
+status: "inactive"
+```
+
+#### About `Togglefy::Feature` status
+
+As you can see, the `Togglefy::Feature` also has a status and it is default to `inactive`. You can change this during creation.
+
+The status holds the `inactive` or `active` values. This status is not to define if a assignable (any model that has the `include Togglefy::Featureable`) either has ou hasn't a feature, but to decide if this feature is available in the entire system.
+
+It's up to you to define how you will implement it.
+
+* Is it disabled? Then this feature is likely unrelease
+* Or maybe if it is disabled, you can see the flag to active to an assignable but can't change the values?
+
+Again, it's up to you!
+
+You can change the status by:
+* Sending a value during creation
+* Updating the column
+* Doing a:
+  ```ruby
+  feature.active! # To activate
+  feature.inactive! # To inactivate
+  ```
+
+### Managing Assignables <-> Features
+Now that we know how to create features, let's check how we can manage them.
+
+An assignable has some direct methods thanks to the `include Togglefy::Featureable`, which are (and let's use an user as an example of an assignable):
+
+```ruby
+user.has_feature?(:super_powers) # Checks if user has a single feature
+user.add_feature(:super_powers) # Adds a feature to user
+user.remove_feature(:super_powers) # Removes a feature from an user
+user.clear_features # Clears all features from an user
+```
+
+The assignable <-> feature relation is held by the `Togglefy::FeatureAssignment` table/model.
+
+But there's another way to manage assignables <-> features by using the `FeatureManager`. It's up to you to decide which one.
+
+Here are the examples:
+
+```ruby
+Togglefy.for(assignable).has?(:super_powers) # Checks if assignable (user || account || anything) has a single feature
+Togglefy.for(assignable).enable(:super_powers) # Enables/adds a feature to an assignable
+Togglefy.for(assignable).disable(:super_powers) # Disables/removes a feature from an assignable
+Togglefy.for(assignable).clear # Clears all features from an assignable
+```
+
+This second method may look strange, but it's the default used by the gem and you will see that right now!
+
+### Querying Features
+Remember when I told you a looooong time ago that the strange way is the default using by the gem? If you don't, no worries. It was a really loooong time ago, like `1.minute.ago`.
+
+It's actually pretty simple. Each line of each code block will show you a way to query to achieve the same result in the context. You **don't** need to use all of options listed in each code block.
+
+#### Querying Features (plural)
+
+To query `Togglefy::Feature` from a specific group (the same applies to environment and tenant), you would do something like this:
+
+```ruby
+Togglefy::Feature.where(group: :dev)
+Togglefy::Feature.for_group(:dev)
+Togglefy.for_group(:dev)
+Togglefy.for_role(:dev)
+Togglefy.for_filters(filters: {group: :dev})
+Togglefy.for_filters(filter: {role: :dev})
+```
+
+The `for_filters` is recommended when you want to use more than one filter, like:
+
+```ruby
+Togglefy.for_filters(filters: {group: :admin, environment: :production})
+```
+
+This will query me all `Togglefy::Feature`s that belongs to group admin and the production environment.
+
+You can send `nil` values too, like:
+
+```ruby
+Togglefy.for_tenant(nil) # This will query me all Togglefy::Features with tenant_id nil
+
+Togglefy.for_filters(filters: {group: :admin, environment: :nil, tenant_id: nil})
+```
+
+There's also another way to filter for `nil` values:
+
+```ruby
+Togglefy.without_group
+Togglefy.without_role
+
+Togglefy.without_environment
+Togglefy.without_env
+
+Togglefy.without_tenant
+```
+
+#### Querying by Status
+To query Togglefy::Features by status (the same applies to inactive).
+
+```ruby
+Togglefy::Feature.where(status: :active)
+Togglefy::Feature.active
+Togglefy.with_status(:active)
+```
+
+#### Finding a specific feature
+```ruby
+Togglefy.feature(:super_powers)
+Togglefy::Feature.find_by(identifier: :super_powers)
+```
+
+#### Finding a specific feature just to destroy it because you're mean 😈
+```ruby
+Togglefy.destroy_feature(:super_powers)
+Togglefy::Feature.find_by(identifier: :super_powers).destroy
+```
+
+#### Querying all features enabled to a klass
+Let's assume that you have two different assignables: User and Account.
+
+You want to list all features being used by assignables of User type:
+
+```ruby
+Togglefy.for_type(User) # This is return all current FeatureAssignment with a User assignable
+```
+
+#### Aliases
+
+By the way, did you notice that I wrote `group` and `role` to get group?
+
+There are aliases for both group and environment that can be used outside of `Togglefy::Feature`. If you want to query `Togglefy::Feature` directly, use only the default name.
+* `group` can be written as `role` outside of `Togglefy::Feature`
+* `environment` can be written as `env` out side of `Togglefy::Feature`
+
+```ruby
+Togglefy.for_group(:dev)
+Togglefy.for_role(:dev)
+Togglefy.for_filters(filters: {group: :dev})
+Togglefy.for_filters(filter: {role: :dev})
+
+Togglefy.for_environment(:production)
+Togglefy.for_env(:production)
+Togglefy.for_filters(filters: {environment: :production})
+Togglefy.for_filters(filter: {env: :production})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/azeveco/togglefy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/azeveco/togglefy/blob/master/CODE_OF_CONDUCT.md).
+
+There's a PR Template. Its usa is highly encouraged.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the togglefy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/azeveco/togglefy/blob/master/CODE_OF_CONDUCT.md).

data/app/models/togglefy/feature.rb

@@ -0,0 +1,31 @@
+module Togglefy
+  class Feature < ApplicationRecord
+    enum :status, [ :inactive, :active ]
+    
+    has_many :feature_assignments, dependent: :destroy
+    has_many :assignables, through: :feature_assignments, source: :assignable
+
+    before_validation :build_identifier
+
+    scope :for_group, ->(group) { where(group:) }
+    scope :without_group, -> { where(group: nil) }
+
+    scope :for_environment, ->(environment) { where(environment:) }
+    scope :without_environment, -> { where(environment: nil) }
+
+    scope :for_tenant, ->(tenant_id) { where(tenant_id:) }
+    scope :without_tenant, -> { where(tenant_id: nil) }
+
+    scope :inactive, -> { where(status: :inactive) }
+    scope :active, -> { where(status: :active) }
+    scope :with_status, ->(status) { where(status:) }
+
+    validates :name, :identifier, presence: true, uniqueness: true
+
+    private
+
+    def build_identifier
+      self.identifier = self.name.underscore.parameterize(separator: '_')
+    end
+  end
+end

data/app/models/togglefy/feature_assignment.rb

@@ -0,0 +1,8 @@
+module Togglefy
+  class FeatureAssignment < ApplicationRecord
+    belongs_to :feature, class_name: "Togglefy::Feature"
+    belongs_to :assignable, polymorphic: true
+
+    scope :for_type, ->(klass) { where(assignable_type: klass.to_s) }
+  end
+end

data/lib/generators/togglefy/install_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+module Togglefy
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      def copy_migrations
+        migration_template "create_features.rb", "db/migrate/create_togglefy_features.rb"
+        migration_template "create_feature_assignments.rb", "db/migrate/create_togglefy_feature_assignments.rb"
+      end
+    end
+  end
+end

data/lib/generators/togglefy/templates/create_feature_assignments.rb

@@ -0,0 +1,10 @@
+class CreateTogglefyFeatureAssignments < ActiveRecord::Migration[8.0]
+  def change
+    create_table :togglefy_feature_assignments do |t|
+      t.references :feature, null: false, foreign_key: { to_table: :togglefy_features }
+      t.references :assignable, polymorphic: true, null: false
+      t.timestamps
+    end
+    add_index :togglefy_feature_assignments, [:feature_id, :assignable_type, :assignable_id], unique: true, name: "index_togglefy_assignments_uniqueness"
+  end
+end

data/lib/generators/togglefy/templates/create_features.rb

@@ -0,0 +1,16 @@
+class CreateTogglefyFeatures < ActiveRecord::Migration[8.0]
+  def change
+    create_table :togglefy_features do |t|
+      t.string :name, null: false
+      t.string :identifier, null: false
+      t.string :description
+      t.string :tenant
+      t.string :group
+      t.string :environment
+      t.integer :status, default: 0, null: false
+      t.timestamps
+    end
+    add_index :togglefy_features, :name, unique: true
+    add_index :togglefy_features, :identifier, unique: true
+  end
+end

data/lib/togglefy/engine.rb

@@ -0,0 +1,5 @@
+module Togglefy
+  class Engine < ::Rails::Engine
+    isolate_namespace Togglefy
+  end
+end

data/lib/togglefy/feature_manager.rb

@@ -0,0 +1,27 @@
+module Togglefy
+  class FeatureManager
+    def initialize(assignable)
+      @assignable = assignable
+    end
+
+    def enable(feature)
+      assignable.add_feature(feature)
+    end
+
+    def disable(feature)
+      assignable.remove_feature(feature)
+    end
+
+    def clear
+      assignable.clear_features
+    end
+
+    def has?(feature)
+      assignable.has_feature?(feature)
+    end
+
+    private
+
+    attr_reader :assignable
+  end
+end

data/lib/togglefy/feature_query.rb

@@ -0,0 +1,55 @@
+module Togglefy
+  class FeatureQuery
+    def feature(identifier)
+      Togglefy::Feature.find_by!(identifier:)
+    end
+
+    def destroy_feature(identifier)
+      feature = Togglefy::Feature.find_by!(identifier:)
+      feature&.destroy
+    end
+
+    def for_type(klass)
+      Togglefy::FeatureAssignment.for_type(klass)
+    end
+
+    def for_group(group)
+      Togglefy::Feature.for_group(group)
+    end
+    alias :for_role :for_group
+
+    def without_group
+      Togglefy::Feature.without_group
+    end
+    alias :without_role :without_group
+
+    def for_environment(environment)
+      Togglefy::Feature.for_environment(environment)
+    end
+    alias :for_env :for_environment
+
+    def without_environment
+      Togglefy::Feature.without_environment
+    end
+    alias :without_env :without_environment
+
+    def for_tenant(tenant_id)
+      Togglefy::Feature.for_tenant(tenant_id)
+    end
+
+    def without_tenant
+      Togglefy::Feature.without_tenant
+    end
+
+    def for_filters(filters)
+      Togglefy::Feature
+        .for_group(filters[:group] || filters[:role])
+        .for_environment(filters[:environment] || filters[:env])
+        .for_tenant(filters[:tenant_id])
+    end
+
+    def with_status(status)
+      Togglefy::Feature.with_status(status)
+    end
+  end
+end

data/lib/togglefy/featureable.rb

@@ -0,0 +1,36 @@
+module Togglefy
+  module Featureable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :feature_assignments, as: :assignable, class_name: "Togglefy::FeatureAssignment"
+      has_many :features, through: :feature_assignments, class_name: "Togglefy::Feature"
+    end
+
+    def has_feature?(identifier)
+      features.exists?(identifier: identifier.to_s)
+    end
+
+    def add_feature(feature)
+      feature = find_feature!(feature)
+      features << feature unless has_feature?(feature.identifier)
+    end
+
+    def remove_feature(feature)
+      feature = find_feature!(feature)
+      features.destroy(feature) if has_feature?(feature.identifier)
+    end
+
+    def clear_features
+      features.destroy_all
+    end
+
+    private
+
+    def find_feature!(feature)
+      return feature if feature.is_a?(Togglefy::Feature)
+
+      Togglefy::Feature.find_by!(identifier: feature.to_s)
+    end
+  end
+end

data/lib/togglefy/version.rb

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

data/lib/togglefy.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "togglefy/version"
+require "togglefy/engine"
+require "togglefy/featureable"
+require "togglefy/feature_manager"
+require "togglefy/feature_query"
+
+module Togglefy
+  class Error < StandardError; end
+
+  def self.feature(identifier)
+    FeatureQuery.new.feature(identifier)
+  end
+
+  def self.destroy_feature(identifier)
+    FeatureQuery.new.destroy_feature(identifier)
+  end
+  
+  def self.for(assignable)
+    FeatureManager.new(assignable)
+  end
+  
+  def self.for_type(klass)
+    FeatureQuery.new.for_type(klass)
+  end
+  
+  def self.for_group(group)
+    FeatureQuery.new.for_group(group)
+  end
+
+  def self.without_group
+    FeatureQuery.new.without_group
+  end
+
+  def self.for_environment(environment)
+    FeatureQuery.new.for_environment(environment)
+  end
+
+  def self.without_environment
+    FeatureQuery.new.without_environment
+  end
+
+  def self.for_tenant(tenant_id)
+    FeatureQuery.new.for_tenant(tenant_id)
+  end
+
+  def self.without_tenant
+    FeatureQuery.new.without_tenant
+  end
+
+  def self.for_filters(filters: {})
+    FeatureQuery.new.for_filters(filters)
+  end
+
+  def self.with_status(status)
+    FeatureQuery.new.with_status(status)
+  end
+
+  class <<self
+    alias_method :for_role, :for_group
+    alias_method :without_role, :without_group
+
+    alias_method :for_env, :for_environment
+    alias_method :without_env, :without_environment
+  end
+end

data/togglefy.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/togglefy/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "togglefy"
+  spec.version = Togglefy::VERSION
+  spec.authors = ["Gabriel Azevedo"]
+  spec.email = ["gazeveco@gmail.com"]
+
+  spec.summary = "Simple and open source Feature Management."
+  spec.description = "Togglefy is a feature management solution to help you control which features an user or a group has access to."
+  spec.homepage = "https://github.com/azeveco/Togglefy"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/azeveco/Togglefy"
+  spec.metadata["changelog_uri"] = "https://github.com/azeveco/Togglefy/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  gemspec = File.basename(__FILE__)
+  spec.files = Dir.glob("lib/**/*") +
+             Dir.glob("app/**/*") +
+             Dir.glob("config/**/*") +
+             %w[LICENSE.txt README.md togglefy.gemspec]
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: togglefy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gabriel Azevedo
+bindir: exe
+cert_chain: []
+date: 2025-04-12 00:00:00.000000000 Z
+dependencies: []
+description: Togglefy is a feature management solution to help you control which features
+  an user or a group has access to.
+email:
+- gazeveco@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- app/models/togglefy/feature.rb
+- app/models/togglefy/feature_assignment.rb
+- lib/generators/togglefy/install_generator.rb
+- lib/generators/togglefy/templates/create_feature_assignments.rb
+- lib/generators/togglefy/templates/create_features.rb
+- lib/togglefy.rb
+- lib/togglefy/engine.rb
+- lib/togglefy/feature_manager.rb
+- lib/togglefy/feature_query.rb
+- lib/togglefy/featureable.rb
+- lib/togglefy/version.rb
+- togglefy.gemspec
+homepage: https://github.com/azeveco/Togglefy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/azeveco/Togglefy
+  source_code_uri: https://github.com/azeveco/Togglefy
+  changelog_uri: https://github.com/azeveco/Togglefy/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Simple and open source Feature Management.
+test_files: []