vp-heimdall 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: afa14f68e897944a552060844aa714985c5b7da3985bdd312a89b2cf2613af2d
+  data.tar.gz: 352e939bc7428fba6151e32bb62a1130fac385e012a36d1da1a972e77dc214df
+SHA512:
+  metadata.gz: b7ce20618dd28fa3d784115aa64f0580250eff38461c935a6d6ac8e2084e5f9ac56fb7d1905077326c10e055e85b049588491ade6701549d1103540acb2c9577
+  data.tar.gz: 50be617513919573038a056399decae6bfa00041f78edd9afc75f12998e1c44503b7508b6160f71f8f64183c0db78cb23e8e5caf3ea4e7468bcd418a5118b8b2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/AbcSize:
+  Max: 10
+
+Metrics/BlockLength:
+  Max: 100

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-06
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hari@volopay.co. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 hari-prasad-01
+
+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,117 @@
+# Heimdall
+
+Heimdall is a simple feature gate library that provides a mechanism to control access to features in your application. It uses a tree structure to represent feature flags and allows you to build and manage feature trees from templates. The library also includes access control checks to ensure that only authorized users can access certain features.
+
+## Features
+
+- Define and manage feature flags using a tree structure.
+- Build feature trees from JSON templates.
+- Perform access control checks based on feature flags.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heimdall'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+```ruby
+rails generate heimdall:install <NameOfClass> --prefix=[feature|feature_template] --type=[all|model|controller|migration] --path=<path of the controller> 
+```
+
+1) To install feature artifacts
+
+    ```ruby
+    rails generate heimdall:install Feature --prefix=feature --type=all
+    ```
+
+2) To install feature Template artifacts
+
+    ```ruby
+    rails generate heimdall:install FeatureTemplate --prefix=feature_template --type=all
+    ```
+
+3) add Heimdall in your application controller
+
+    ```ruby
+    class ApplicationController < ActionController::API
+      include Heimdall
+    end
+    ```
+
+`Note: It is recommended to install templates in public schema if you are using multi-tenancy.`
+
+### Some of the good practices
+
+1. keep feature name as `snake_case` and `singular` form. if a feature is sub-feature like google_login of user then it should be `user.google_login`.
+    eg:
+
+    ```ruby
+    feature_names:[`profile_enabled`, `user.security.google_login_enabled`]
+    ```
+
+2. those features can we checked or accessed via
+
+    ```ruby
+    Feature.user_security_google_login_enabled?
+    ```
+
+3. if you want to check feature on controller. then you can create something like runes
+
+    eg: we need to have `UsersRune` for `UsersController`
+
+    if controller structure is considered to be this
+
+    ```ruby
+        class UsersController < ApplicationController
+          before_action only: [:google_login_link] do
+            worthy? params[:action] #, UsersRune (optional rune class name if used unconventionally)
+          end
+
+          # some code
+          def google_login_link
+            # generate_login_url
+          end
+        end
+    ```
+
+    then rune structure should be
+
+    ```ruby
+        class UsersRune 
+          def google_login_link?
+            Feature.user_security_google_login_enabled?
+          end
+        end
+    ```
+
+4. It can be directly used in serializer/jobs
+
+5. To maintain `Singe Responsibility Principle`, it is recommended to use runes for controllers and jobs. Try not to use in business logic like either in model or service functions.
+
+## 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/volopay/heimdall>. 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/volopay/heimdall/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Heimdall project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/heimdall/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/heimdall.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/heimdall/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "vp-heimdall"
+  spec.version = Heimdall::VERSION
+  spec.authors = ["hari-prasad-01"]
+  spec.email = ["hari@volopay.co"]
+
+  spec.summary = "Write a short summary, because RubyGems requires one."
+  spec.description = "Write a longer description or delete this line."
+  spec.homepage = "https://github.com/volopay/heimdall"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  # spec.metadata["allowed_push_host"] = "https://volopay.com"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/volopay/heimdall"
+  spec.metadata["changelog_uri"] = "https://github.com/Volopay/Heimdall/CHANGELOG.md"
+
+  # 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.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  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

data/lib/errors/access_denied_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Access Denied Exception
+#
+# This exception is raised when a user tries to access a resource they don't have permission to access.
+#
+class AccessDeniedError < StandardError
+  def initialize(options = {}) # rubocop:disable Metrics/AbcSize
+    message = options[:message]
+    query = options[:query].to_s.gsub(/[^\w]*/, '')
+    klass = options[:klass].to_s
+
+    # message = "Access Denied to access #{query} from #{klass}" if message.nil? && query.present? && klass.present? && (Rails.env.development? || Rails.env.test?)
+    message ||= "Access Denied"
+
+    super(message)
+  end
+end

data/lib/generators/heimdall/install_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/migration"
+require_relative "migration_helper"
+require "active_record"
+require "rails/generators/active_record"
+require "rails/generators/active_record/model/model_generator"
+
+module Heimdall
+  module Generators
+    # https://guides.rubyonrails.org/generators.html
+    class InstallGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+      include Heimdall::Generators::MigrationHelper
+      extend Heimdall::Generators::MigrationHelper
+
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :type, type: :string, default: "all",
+                          desc: "Type of files to generate (model/migration/controller/all)"
+
+      class_option :prefix, type: :string, default: "feature",
+                            desc: "Prefix for table and model names -- [feature, feature_template]"
+
+      class_option :path, type: :string, default: "",
+                          desc: "Path to the controller file"
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      def generate_files
+        case options[:type].downcase
+        when "model"
+          create_model_file
+        when "migration"
+          create_migration_file
+        when "controller"
+          create_controller_file
+        when "route"
+          add_routes
+        else
+          create_model_file
+          create_migration_file
+          create_controller_file
+        end
+      end
+
+      private
+
+      def create_model_file
+        template "models/#{options[:prefix]}_model.rb.tt", File.join("app/models", class_path, "#{file_name}.rb")
+      end
+
+      def create_migration_file
+        migration_file_name = "create_#{file_name.pluralize}"
+        migration_template "migrations/#{migration_file_name}.erb", "db/migrate/#{migration_file_name}_table.rb"
+      end
+
+      def create_controller_file
+        template "controllers/#{options[:prefix]}_controller.rb.tt", File.join("app/controllers", options[:path], class_path, "#{file_name.pluralize}_controller.rb")
+      end
+
+      def add_routes
+        route "resources #{file_name.pluralize.to_sym}"
+      end
+    end
+  end
+end

data/lib/generators/heimdall/migration_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Heimdall
+  module Generators
+    # methods used by all generators
+    module MigrationHelper
+      def migration_parent
+        "ActiveRecord::Migration[#{ActiveRecord::Migration.current_version}]"
+      end
+
+      def next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        if timestamped_migrations?
+          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
+        else
+          "%.3d" % next_migration_number
+        end
+      end
+
+      private
+
+      def timestamped_migrations?
+        ::ActiveRecord.timestamped_migrations
+      end
+    end
+  end
+end

data/lib/generators/heimdall/templates/controllers/feature_controller.rb.tt

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# this is a sample controller. Feel free to modify and add your own methods
+# NOTE: this controller is not protected by any authentication and it is not tested
+# it is meant to be a template
+# add routes of your own
+
+class <%= class_name.pluralize %>Controller < ApplicationController
+  # GET current tree for the template given
+  def index
+    root = FeatureTree.build(template, flags) 
+    
+    return render json: root.as_json, status: :ok
+  end
+
+  # PUT update template
+  def update
+    FeatureTree.update(template, flags, *update_params)
+
+    return render json: 'flag got update successfully', status: :ok
+  end
+
+ private
+
+  def template
+    @template = <%= class_name %>Template.find(params[:template_id])
+  end
+
+  def flags
+    @flags = <%= class_name %>.current_config_json
+  end
+
+  def update_params
+    params.permit(*<%= class_name %>::UPDATE_ARGS)
+  end
+end

data/lib/generators/heimdall/templates/controllers/feature_template_controller.rb.tt

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# this is a sample controller. Feel free to modify and add your own methods
+# NOTE: this controller is not protected by any authentication and it is not tested
+# it is meant to be a template
+# add routes of your own
+class <%= class_name.pluralize %>Controller < ApplicationController
+  # POST create node in the template
+  def add_node
+    root = FeatureTree.add_node(root: template.tree, **add_node_params) 
+    template.update!(config: root.as_json)
+    
+    return render json: { message: 'Node added successfully' }, status: :ok
+  end
+
+ # DELETE delete a node from template
+  def delete_node
+    FeatureTree.remove_node(root: template.tree, key: params[:key])
+    template.update!(config: template.tree.as_json)
+
+    return render json: { message: 'Node deleted successfully' }, status: :ok
+  end
+
+  # POST create template
+  def create
+    @template = <%= class_name %>.new(create_params)
+
+    return render json: { message: 'Template created successfully' }, status: :ok if @template.save 
+  end
+
+  # DELETE delete template
+  def destroy
+    template.destroy
+    return render json: { message: 'Template deleted successfully' }, status: :ok
+  end
+
+  # PUT update template
+  def update
+    template.update!(create_params)
+    return render json: { message: 'Template updated successfully' }, status: :ok
+  end
+
+ private
+
+  def add_node_params
+    params.permit(:key, :parent_key, :child_key)
+  end
+
+  def template
+    @template = <%= class_name %>.find(params[:id])
+  end
+
+  def create_params
+    params.permit(:name, :description, :active, config: [:key, :children])
+  end
+end

data/lib/generators/heimdall/templates/migrations/create_feature_templates.erb

@@ -0,0 +1,12 @@
+class Create<%= class_name.pluralize %>Table < <%= migration_parent %>
+  def change
+    create_table :<%= file_name.pluralize %> do |t|
+      t.string :name, null: false
+      t.text :description
+      t.jsonb :config, default: {}
+      t.boolean :active, default: false
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/heimdall/templates/migrations/create_features.erb

@@ -0,0 +1,19 @@
+class Create<%= class_name.pluralize %>Table < <%= migration_parent %>
+  def change
+    create_table :<%= file_name.pluralize %> do |t|
+      t.string :key, null: false # uniq identifier for each flag
+      t.string :name, null: false # human readable name
+      t.string :value, null: false # value of the flag
+      t.string :description # brief description of the flag for internal purposes
+      t.string :options, array: true, default: [] # list of possible values for the flag
+      t.string :tags, array: true, default: [] # list of tags for the flag
+      t.timestamps
+
+      # add custom columns here
+      # t.boolean :customization, default: false
+    end
+
+    # adding unique index to key column for validation/ bulk upsert(constraint)
+    add_index :<%= file_name.pluralize %>, :key, unique: true
+  end
+end

data/lib/generators/heimdall/templates/models/feature_model.rb.tt

@@ -0,0 +1,42 @@
+class <%= class_name %> < ActiveRecord::Base
+  UPDATE_ARGS = %i[value options tags]
+
+  class << self
+    # return current client flag config in json format
+    def current_config_json
+      flags = {}
+      <%= class_name %>.all.map do |feature|
+        flags[feature.key] = feature
+      end
+
+      flags
+    end
+
+    # return current client flag config in json format with key as camelized symboll
+    def feature_map
+      # need to cache it
+      feature_map = current_config_json.map { |k, v| [k.gsub('.', '_').to_sym, v] }
+      feature_map.to_h
+    end
+
+    def respond_to_missing?(meth, include_private = false)
+      if Feature.pluck(:key).map { |u| u.gsub('.', '_') }.include? meth.to_s.gsub('?', '').to_sym
+        meth = meth.to_s.gsub('?', '').to_sym
+        feature = Feature.find_by(key: meth)
+        feature.present? && feature.value
+      else
+        super
+      end
+    end
+
+    def method_missing(meth, *args, &block)
+      key = meth.to_s.gsub('?', '').to_sym
+
+      feature = feature_map[key]
+
+      super if feature.nil?
+
+      feature.present? && feature.value
+    end
+  end
+end

data/lib/generators/heimdall/templates/models/feature_template_model.rb.tt

@@ -0,0 +1,18 @@
+class <%= class_name %> < ActiveRecord::Base
+
+  # validations
+  validates :name, :config, presence: true
+
+  # scopes
+  scope :active, -> { where(active: true) }
+
+  # this method return the tree object for the template's config
+  def tree
+    FeatureTree.parse_template(self.config)
+  end
+  
+  # archive the template
+  def archive!
+    update!(active: false)
+  end
+end

data/lib/heimdall/rune_finder.rb

@@ -0,0 +1,29 @@
+module Heimdall
+  module RuneFinder
+    #
+    # rune_class
+    # This method will fetch the rune class for the given controller.
+    # note: for this it should be named same the controller.
+    # eg: ```
+    # UsersController --> UsersRune
+    # ```
+    # @param [string] klass - class of the controller/ rune
+    #
+    # @return [Class] - class of the Rune
+    #
+    def rune_class(klass)
+      klass ||= "#{fetch_controller}Rune"
+      klass = klass.is_a?(String) ? klass.safe_constantize : klass
+
+      raise "Couldn't find rune class" if klass.nil?
+
+      klass
+    end
+
+    private
+
+    def fetch_controller
+      self.class.name.split('::').last.gsub('Controller', '')
+    end
+  end
+end

data/lib/heimdall/version.rb

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

data/lib/heimdall.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "heimdall/version"
+require_relative "tree/feature_tree"
+require_relative "errors/access_denied_error"
+require_relative "heimdall/rune_finder"
+
+# Heimdall is a simple feature gate library.
+#
+# Heimdall provides a mechanism to control access to features in your application.
+# It uses a tree structure to represent feature flags and allows you to build and manage
+# feature trees from templates. The library also includes access control checks to ensure
+# that only authorized users can access certain features.
+#
+# ## Features
+#
+# - Define and manage feature flags using a tree structure.
+# - Build feature trees from JSON templates.
+# - Perform access control checks based on feature flags.
+#
+# ## Usage
+#
+# ```ruby
+# # Define a policy class
+# class MyPolicy
+#   def some_feature?
+#     # logic to check access
+#   end
+# end
+#
+# # Check access to a feature
+# Heimdall.check_access?(query: :some_feature?, klass: MyPolicy)
+# ```
+module Heimdall
+  include Heimdall::RuneFinder
+
+  class Error < StandardError; end
+
+  class << self
+
+    def worthy?(query:, klass:)
+      policy = klass.new
+      raise AccessDeniedError.new({ query: query, klass: klass }) unless policy.public_send(query)
+
+      true
+    end
+  end
+
+  protected
+
+  #
+  # worthy?
+  #
+  # @param [string] query - name of the function to check
+  # @param [string] klass - name of the class to check
+  #
+  # @return [boolean] - true if the query is worthy, otherwise throws AccessDeniedError
+  def worthy?(query, klass=nil)
+    query = "#{query}?"
+    klass = rune_class(klass)
+
+    Heimdall.worthy?(query: query, klass: klass)
+  end
+end

data/lib/tree/feature_tree.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "tree"
+
+# FeatureTree is a tree structure that represents the feature flags
+# It is used to build the feature tree from the feature flag template
+class FeatureTree < Tree
+  attr_accessor :id, :key, :name, :value, :options, :editable_by_admin, :editable_by_user, :tags, :children
+
+  class << self
+    #
+    # Build the tree with the given template
+    #
+    # @param [Tree] FeatureTemplate tree - config of feature template
+    # @param [json] flags - current flags from db
+    # @param [Proc] block(node) - block to execute
+    #
+    # @return [Tree] node - root of the tree
+    def build(template, flags, &block) # rubocop:disable Metrics/AbcSize,Lint/UnusedMethodArgument
+      traverse(template) do |node|
+        yield node if block_given?
+
+        node.id = flags[node.key].id
+        node.key = flags[node.key].key
+        node.value = flags[node.key].value
+        node.name = flags[node.key].name
+        node.options = flags[node.key].options
+        node.tags = flags[node.key].tags
+      end
+
+      template
+    end
+
+    #
+    # update the node/feature table
+    #
+    # @param [Tree] FeatureTemplate tree - config of feature template
+    # @param [json] flags - current flags from db
+    # @param [key] key - key from which the update should happen
+    # @param [update_args] update_args - key-value pairs to be updated
+    #
+    # @return nil
+    #
+    def update(template, flags, key:, update_args: {})
+      head = find(template, key)
+
+      raise TypeError, "Feature flag not found" unless head
+
+      traverse(head) do |node|
+        flags[node.key].update(**update_args)
+      end
+    end
+  end
+end

data/lib/tree/tree.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+# ## Tree
+#
+# A simple Tree node Abstract class.
+# it has a key and a list of children
+#
+#
+# ##### Purpose
+#
+#  methods to traverse and find nodes
+#
+# ##### Example
+#
+# ```ruby
+#   node = Tree.new(1, children: [Tree.new(2), Tree.new(3)])
+#   node.key # => 1
+#   node.children # => [Tree.new(2), Tree.new(3)]
+#   ```
+class Tree
+  attr_accessor :key, :children
+
+  def initialize(key, children: [])
+    @key = key
+    @children = children
+  end
+
+  class << self
+    # Traverse the tree and yield each node
+    # optional block to perform an action on each node
+    #
+    # @param [Tree] node - node of a Tree
+    # @param [Proc] &block - proc to execute client logic
+    #
+    # @return nil
+    def traverse(node, &block)
+      return nil unless node
+
+      yield node if block_given?
+
+      node.children&.map do |child|
+        traverse(child, &block)
+      end
+    end
+
+    # Find the node by key
+    #
+    # @param [Tree] node - root node
+    # @param [string] key - key to find the node
+    #
+    # @return [Tree] node - node with the key
+    #
+    def find(node, key, &block)
+      return nil unless node
+
+      return node if node.key == key
+
+      yield(node) if block_given?
+
+      node.children&.map do |child|
+        result = find(child, key, &block)
+        return result if result
+      end
+
+      nil
+    end
+
+    # add node to the tree
+    #
+    # @param [Tree] root - template's root node
+    # @param [string] key - key for the new node
+    # @param [string] parent_key - key for its parent node
+    # @param [string] children - key for its child node
+    #
+    # @return root - updated root node
+    def add_node(root:, key:, parent_key:, child_key: nil) # rubocop:disable Metrics/AbcSize
+      parent = find(root, parent_key)
+      child = find(root, child_key) if child_key
+      parent.children = parent.children&.delete_if { |c| c.key == child_key } if child_key
+      new_node = Tree.new(key, children: [child] || [])
+      parent.children ||= []
+      parent.children << new_node
+      root
+    end
+
+    #
+    # Remove node from the templates's root node
+    #
+    # @param [Tree] root - template's root node
+    # @param [string] key - key for the new node
+    #
+    # @return root - updated root node
+    #
+    def remove_node(root:, key:)
+      raise TypeError, 'Cannot delete root node' if root.key == key
+
+      node_to_delete = find(root, key)
+      raise TypeError, 'Cannot find the node to delete' unless node_to_delete
+
+      parent = parent(root, key)
+
+      parent.children.delete_if { |child| child.key == key }
+      root
+    end
+
+
+    def parse_template(json)
+      return nil unless json
+      children = json["children"]&.map do |child|
+        parse_template(child)
+      end
+
+      self.new(json["key"], children: children)
+    end
+
+    private
+
+    def parent(root, key)
+      return find(root, key) do |node|
+        return node if node&.children&.select{ |u| u.key == key }.present?
+      end
+    end
+  end
+end

data/sig/gate_keeper.rbs

@@ -0,0 +1,4 @@
+module Heimdall
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: vp-heimdall
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- hari-prasad-01
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-20 00:00:00.000000000 Z
+dependencies: []
+description: Write a longer description or delete this line.
+email:
+- hari@volopay.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- heimdall.gemspec
+- lib/errors/access_denied_error.rb
+- lib/generators/heimdall/install_generator.rb
+- lib/generators/heimdall/migration_helper.rb
+- lib/generators/heimdall/templates/controllers/feature_controller.rb.tt
+- lib/generators/heimdall/templates/controllers/feature_template_controller.rb.tt
+- lib/generators/heimdall/templates/migrations/create_feature_templates.erb
+- lib/generators/heimdall/templates/migrations/create_features.erb
+- lib/generators/heimdall/templates/models/feature_model.rb.tt
+- lib/generators/heimdall/templates/models/feature_template_model.rb.tt
+- lib/heimdall.rb
+- lib/heimdall/rune_finder.rb
+- lib/heimdall/version.rb
+- lib/tree/feature_tree.rb
+- lib/tree/tree.rb
+- sig/gate_keeper.rbs
+homepage: https://github.com/volopay/heimdall
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/volopay/heimdall
+  source_code_uri: https://github.com/volopay/heimdall
+  changelog_uri: https://github.com/Volopay/Heimdall/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- 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.6
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []