rails_flags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd89ec7b4bef50b03eeda197bffb23d1f88da83dfd91e7e68d18f65643b46c46
+  data.tar.gz: b3fe66c98c53b2f07e10460a08d8853f4e2f62d79ca37f20eb2b66c2d453a6ea
+SHA512:
+  metadata.gz: 39f075f0e4bd50afffcb40f53a6130b535151c0e8cfcf1f60dc3bc265ef82e84b2393ca2457cfe54dc7b1a32728501593cc792267c3d0269e121cd3032ecc7c5
+  data.tar.gz: 3da159ab062c096037bda7c92a38696fd987c6fde0209dc5206885e3f71bc22f13cbf8a6f9d5c5f00649b28d3d6a976c1c52ecf692037b5400c8fb957b9c1c2a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Dhurba Baral
+
+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,113 @@
+# RailsFlags
+
+A simple and powerful feature flagging system for Ruby on Rails applications. RailsFlags provides an easy way to manage feature flags with support for multiple storage backends.
+
+## Features
+
+- Multiple storage adapters (Redis, Memory)
+- Simple and intuitive API
+- Thread-safe operations
+- Configurable default states
+- Support for flag metadata (descriptions, creation timestamps)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rails_flags"
+```
+
+And then execute:
+```bash
+bundle install
+```
+
+## Configuration
+
+RailsFlags can be configured with different adapters based on your needs:
+
+### Memory Adapter (Default)
+```ruby
+# config/initializers/rails_flags.rb
+RailsFlags.configure do |config|
+    config.adapter = RailsFlags::Adapters::MemoryAdapter.new
+end
+```
+
+### Redis Adapter
+```ruby
+# config/initializers/rails_flags.rb
+RailsFlags.configure do |config|
+    config.adapter = RailsFlags::Adapters::RedisAdapter.new(
+        host: "localhost",
+        port: 6379
+    )
+end
+```
+
+### Registering Flags
+```ruby
+# Register a new feature flag (disabled by default)
+RailsFlags.register(
+  :new_feature,
+  enabled: false,
+  description: "Awesome new feature"
+)
+
+# Register an enabled feature flag
+RailsFlags.register(
+  :another_feature,
+  enabled: true,
+  description: "Another awesome feature"
+)
+```
+
+### Checking Flags
+```ruby
+# Check if a flag is enabled
+if RailsFlags.enabled?(:new_feature)
+  # Feature code here
+end
+
+# Check if a flag is registered
+RailsFlags.registered?(:new_feature)
+```
+
+### Managing Flags
+```ruby
+# Enable a flag
+RailsFlags.enable(:new_feature)
+
+# Disable a flag
+RailsFlags.disable(:new_feature)
+
+# Get all flags
+all_flags = RailsFlags.all_flags
+```
+
+## Storage Adapters
+
+### Memory Adapter
+- Simple in-memory storage
+- Suitable for development and testing
+- Data is lost when the application restarts
+
+### Redis Adapter
+- Persistent storage using Redis
+- Suitable for production use
+- Provides atomic operations
+- Requires Redis server
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin feature/my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/stylesheets/rails_flags/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/rails_flags/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsFlags
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/rails_flags/application_helper.rb

@@ -0,0 +1,4 @@
+module RailsFlags
+  module ApplicationHelper
+  end
+end

data/app/jobs/rails_flags/application_job.rb

@@ -0,0 +1,4 @@
+module RailsFlags
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/rails_flags/application_mailer.rb

@@ -0,0 +1,6 @@
+module RailsFlags
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/rails_flags/application_record.rb

@@ -0,0 +1,5 @@
+module RailsFlags
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/rails_flags/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails flags</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= yield :head %>
+
+  <%= stylesheet_link_tag    "rails_flags/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+RailsFlags::Engine.routes.draw do
+end

data/lib/rails_flags/adapters/base.rb

@@ -0,0 +1,25 @@
+module RailsFlags
+  module Adapters
+    class Base
+      def read(flag)
+        raise NotImplementedError
+      end
+
+      def write(flag, value)
+        raise NotImplementedError
+      end
+
+      def delete(flag)
+        raise NotImplementedError
+      end
+
+      def all
+        raise NotImplementedError
+      end
+
+      def clear
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/rails_flags/adapters/memory_adapter.rb

@@ -0,0 +1,31 @@
+require_relative 'base'
+
+module RailsFlags
+  module Adapters
+    class MemoryAdapter < Base
+      def initialize
+        @features = {}
+      end
+
+      def read(flag)
+        @features[flag.to_sym]
+      end
+
+      def write(flag, value)
+        @features[flag.to_sym] = value
+      end
+
+      def delete(flag)
+        @features.delete(flag.to_sym)
+      end
+
+      def all
+        @features.dup
+      end
+
+      def clear
+        @features.clear
+      end
+    end
+  end
+end

data/lib/rails_flags/adapters/redis_adapter.rb

@@ -0,0 +1,52 @@
+require 'redis'
+require 'json'
+require_relative 'base'
+
+module RailsFlags
+  module Adapters
+    class RedisAdapter < Base
+      REDIS_KEY_PREFIX = 'rails_flags:'.freeze
+
+      def initialize(redis: nil, **redis_config)
+        @redis = redis || Redis.new(redis_config)
+      end
+
+      def read(flag)
+        data = @redis.get(key_for(flag))
+        return nil unless data
+
+        JSON.parse(data, symbolize_names: true)
+      end
+
+      def write(flag, value)
+        @redis.set(key_for(flag), value.to_json)
+      end
+
+      def delete(flag)
+        @redis.del(key_for(flag))
+      end
+
+      def all
+        keys = @redis.keys("#{REDIS_KEY_PREFIX}*")
+        return {} if keys.empty?
+
+        values = @redis.mget(keys)
+        keys.zip(values).each_with_object({}) do |(key, value), hash|
+          flag_name = key.sub(REDIS_KEY_PREFIX, '').to_sym
+          hash[flag_name] = JSON.parse(value, symbolize_names: true) if value
+        end
+      end
+
+      def clear
+        keys = @redis.keys("#{REDIS_KEY_PREFIX}*")
+        @redis.del(keys) unless keys.empty?
+      end
+
+      private
+
+      def key_for(flag)
+        "#{REDIS_KEY_PREFIX}#{flag}"
+      end
+    end
+  end
+end

data/lib/rails_flags/configuration.rb

@@ -0,0 +1,64 @@
+require_relative "adapters/base"
+require_relative "adapters/redis_adapter"
+require_relative "adapters/memory_adapter"
+
+module RailsFlags
+  class Configuration
+    attr_accessor :adapter
+
+    def initialize(adapter: nil)
+      @adapter = adapter || Adapters::MemoryAdapter.new
+    end
+
+    def register(name, enabled: false, description: nil)
+      validate_flag_name!(name)
+      data = {
+        enabled: enabled,
+        description: description,
+        created_at: Time.now
+      }
+
+      @adapter.write(name.to_sym, data)
+      data
+    end
+
+    def enabled?(flag)
+      validate_flag_exists!(flag)
+      data = @adapter.read(flag.to_sym)
+      data ? data[:enabled] == true : false
+    end
+
+    def enable(flag)
+      validate_flag_exists!(flag)
+      data = @adapter.read(flag.to_sym).dup
+      data[:enabled] = true
+      @adapter.write(flag.to_sym, data)
+    end
+
+    def disable(flag)
+      validate_flag_exists!(flag)
+      data = @adapter.read(flag.to_sym).dup
+      data[:enabled] = false
+      @adapter.write(flag.to_sym, data)
+    end
+
+    def registered?(flag)
+      @adapter.read(flag.to_sym) ? true : false
+    end
+
+    def all_flags
+      @adapter.all
+    end
+
+    private
+
+    def validate_flag_name!(name)
+      raise ArgumentError, "Flag name must be a String or Symbol" unless name.is_a?(String) || name.is_a?(Symbol)
+      raise ArgumentError, "Flag name cannot be empty" if name.to_s.strip.empty?
+    end
+
+    def validate_flag_exists!(flag)
+      raise KeyError, "Flag '#{flag}' is not registered" unless registered?(flag)
+    end
+  end
+end

data/lib/rails_flags/engine.rb

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

data/lib/rails_flags/version.rb

@@ -0,0 +1,3 @@
+module RailsFlags
+  VERSION = "0.1.0"
+end

data/lib/rails_flags.rb

@@ -0,0 +1,52 @@
+require "rails_flags/version"
+require "rails_flags/engine"
+require "rails_flags/configuration"
+
+module RailsFlags
+  class Error < StandardError; end
+  class FlagNotRegisteredError < Error; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def register(flag_name, **options)
+      configuration.register(flag_name, **options)
+    end
+
+    def enabled?(flag)
+      configuration.enabled?(flag)
+    rescue KeyError => e
+      raise FlagNotRegisteredError, e.message
+    end
+
+    def disabled?(flag)
+      !enabled?(flag)
+    end
+
+    def enable(flag)
+      configuration.enable(flag)
+    rescue KeyError => e
+      raise FlagNotRegisteredError, e.message
+    end
+
+    def disable(flag)
+      configuration.disable(flag)
+    rescue KeyError => e
+      raise FlagNotRegisteredError, e.message
+    end
+
+    def registered?(flag)
+      configuration.registered?(flag)
+    end
+
+    def all_flags
+      configuration.all_flags
+    end
+  end
+end

data/lib/tasks/rails_flags_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_flags do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rails_flags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dhurba Baral
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+description: A simple and powerful feature flagging system for Ruby on Rails applications.
+  RailsFlags provides an easy way to manage feature flags with support for multiple
+  storage backends.
+email:
+- dhurba87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/rails_flags/application.css
+- app/controllers/rails_flags/application_controller.rb
+- app/helpers/rails_flags/application_helper.rb
+- app/jobs/rails_flags/application_job.rb
+- app/mailers/rails_flags/application_mailer.rb
+- app/models/rails_flags/application_record.rb
+- app/views/layouts/rails_flags/application.html.erb
+- config/routes.rb
+- lib/rails_flags.rb
+- lib/rails_flags/adapters/base.rb
+- lib/rails_flags/adapters/memory_adapter.rb
+- lib/rails_flags/adapters/redis_adapter.rb
+- lib/rails_flags/configuration.rb
+- lib/rails_flags/engine.rb
+- lib/rails_flags/version.rb
+- lib/tasks/rails_flags_tasks.rake
+homepage: https://github.com/dhurba87/rails_flags
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dhurba87/rails_flags
+  source_code_uri: https://github.com/dhurba87/rails_flags
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Feature flags for Rails.
+test_files: []