simple_flag 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f2041da22824b405194cc6203aa275e474ee4055f733d4959c60256d0984d51
+  data.tar.gz: d5c4f449cadb4febda25719c8653eeff8d1f4fc65c42c72f9f0d1661cae3eac1
+SHA512:
+  metadata.gz: d95d77afd1ee6c44acf335e977034920f7f70eba17f52577823489240bfa3089ee5348a762fd7f2a192ed7ac29b93a1aca52d35567fc4e80363d751bf2602a47
+  data.tar.gz: 440b21b9616ff41ff02597088ec1da841224cbfa513c6c3f5c309ef576e5480fac001399715a316edc7929c6aa76385609327fdea6f5b3b357d2ace469e1f223

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/.vscode
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Layout/LineLength:
+  Max: 120
+Layout/MultilineMethodCallIndentation:
+  Exclude:
+    - ./spec/**/*_spec.rb
+Metrics/BlockLength:
+  Exclude:
+    - ./spec/**/*_spec.rb
+Metrics/MethodLength:
+  Max: 20
+Style/GuardClause:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_flag.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Vojtech Kusy
+
+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,90 @@
+# SimpleFlag
+
+Simple but powerful feature flag implementation in 90 LOC.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_flag'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install simple_flag
+
+## Usage
+
+### Configuration
+
+```ruby
+FEATURE = SimpleFlag.new do |feature|
+  feature.define(:new_user_profile) do |user_id:|
+    Admin.where(user_id: user_id).exists?
+  end
+  feature.define(:third_party_analytics) do
+    not Rails.env.production?
+  end
+end
+```
+
+### Usage in app code
+
+```ruby
+class ProfilesController < ApplicationController
+  def show
+    FEATURE.with(:new_user_profile, user_id: current_user.id) do
+      return render :new_user_profile, locals: { user: NewUserProfilePresenterV2.new(current_user) }
+    end
+    render :show, locals: { user: UserProfilePresenterV1.new(current_user) }
+  end
+end
+```
+
+### Testing with before...after
+
+```ruby
+describe "User profiles" do
+  after { FEATURE.reset_all_overrides }
+
+  context "with new_user_profile feature enabled" do
+    before { FEATURE.override(:new_user_profile, true) }
+    it "renders new profile"
+  end
+
+  context "with new_user_profile feature disabled" do
+    before { FEATURE.override(:new_user_profile, false) }
+    it "renders old profile"
+  end
+end
+```
+
+### Testing with inline block
+
+```ruby
+it "shows new user profile" do
+  FEATURE.override_with(:new_user_profile, true) do
+    expect( FEATURE.active?(:new_user_profile) ).to be_truthy
+  end
+  expect( FEATURE.active?(:new_user_profile) ).to be_falsy
+end
+```
+
+## 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 tags, 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/wojtha/simple_flag.
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'simple_flag'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/simple_flag.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'simple_flag/version'
+
+# Class FeatureFlag defines and stores feature flags
+#
+# @example Configuration
+#
+#    FEATURE = FeatureFlag.new do |feature|
+#      feature.define(:new_user_profile) do |user_id:|
+#        Admin.where(user_id: user_id).exists?
+#      end
+#
+#      feature.define(:third_party_analytics) do
+#        not Rails.env.production?
+#      end
+#    end
+#
+# @example Usage
+#
+#    class ProfilesController < ApplicationController
+#      def show
+#        FEATURE.with(:new_user_profile, user_id: current_user.id) do
+#          return render :new_user_profile, locals: { user: NewUserProfilePresenterV2.new(current_user) }
+#        end
+#
+#        render :show, locals: { user: UserProfilePresenterV1.new(current_user) }
+#      end
+#    end
+#
+# @example Testing with before...after
+#
+#    describe "User profiles" do
+#      before { FEATURE.override(:new_user_profile, true) }
+#      after  { FEATURE.reset_all_overrides }
+#    end
+#
+# @example Testing with inline block
+#
+#    it "shows new user profile" do
+#      FEATURE.override_with(:new_user_profile, true) do
+#        expect( FEATURE.active?(:new_user_profile) ).to be_truthy
+#      end
+#
+#      expect( FEATURE.active?(:new_user_profile) ).to be_falsy
+#    end
+#
+# @see http://blog.arkency.com/2015/11/simple-feature-toggle-for-rails-app/
+#
+class SimpleFlag
+  FlagAlreadyDefined = Class.new(StandardError)
+  FlagNotDefined = Class.new(StandardError)
+  FlagNotOverridden = Class.new(StandardError)
+  FlagArgumentsMismatch = Class.new(StandardError)
+
+  attr_reader :env
+
+  def initialize(env: nil)
+    @env       = env
+    @flags     = {}
+    @overrides = {}
+    yield self if block_given?
+  end
+
+  def define(name, &block)
+    raise FlagAlreadyDefined, "Feature flag `#{name}` is already defined" if flag?(name)
+
+    @flags[name] = block
+  end
+
+  def redefine(name, &block)
+    @flags[name] = block
+  end
+
+  def flags
+    @flags.keys
+  end
+
+  def with(name, *args, &block)
+    block.call if active?(name, *args)
+  end
+
+  def override(name, result = true, &block)
+    raise FlagNotDefined, "Feature flag `#{name}` is not defined" unless flag?(name)
+    raise FlagAlreadyDefined, "Feature flag `#{name}` is already overridden" if overridden?(name)
+
+    # We are using proc, not lambda, because proc does not check for number of arguments
+    original_block = @flags[name]
+    @overrides[name] = original_block
+    @flags[name] =
+      if block_given?
+        validate_flag_arity(name, original_block.arity, block.arity)
+        block
+      else
+        proc { |*_args| result }
+      end
+
+    original_block
+  end
+
+  def reset_override(name)
+    raise FlagNotOverridden, "Feature flag `#{name}` was not overridden" unless overridden?(name)
+
+    original_block = @overrides.delete(name)
+    @flags[name] = original_block
+  end
+
+  def reset_all_overrides
+    @overrides.each_key { |name| reset_override(name) }
+  end
+
+  def override_with(name, result = true, &block)
+    raise FlagNotDefined, "Feature flag `#{name}` is not defined" unless flag?(name)
+
+    original_block = @flags[name]
+    @flags[name] = proc { |*_args| result }
+    block.call
+  ensure
+    @flags[name] = original_block
+  end
+
+  def flag?(name)
+    @flags.key?(name)
+  end
+
+  def overridden?(name)
+    @overrides.key?(name)
+  end
+
+  def active?(name, *args)
+    flag = @flags.fetch(name, proc { |*_args| false })
+    validate_flag_arguments(name, flag.arity, args.size)
+    flag.call(*args)
+  end
+  alias enabled? active?
+
+  def inactive?(name, *args)
+    !active?(name, *args)
+  end
+  alias disabled? inactive?
+
+  def env?(*args)
+    [*args].map(&:to_s).include?(env.to_s)
+  end
+
+  private
+
+  def validate_flag_arity(flag_name, flag_arity, override_arity)
+    original_arity = flag_arity < 0 ? flag_arity.abs - 1 : flag_arity
+
+    if original_arity != override_arity
+      raise FlagArgumentsMismatch, "Flag '#{flag_name}' expects #{flag_arity} arguments, " \
+            "but #{override_arity} arguments were given"
+    end
+  end
+
+  def validate_flag_arguments(flag_name, flag_arity, args_size)
+    if flag_arity < 0 && (flag_arity.abs - 1) > args_size
+      # Contains variable -n-1 arguments
+      raise FlagArgumentsMismatch, "Flag '#{flag_name}' expects #{flag_arity.abs - 1} or more arguments, " \
+            "but #{args_size} arguments were given"
+    elsif flag_arity >= 0 && flag_arity != args_size
+      # Contains zero or fixed number of arguments
+      raise FlagArgumentsMismatch, "Flag '#{flag_name}' expects #{flag_arity} arguments, " \
+            "but #{args_size} arguments were given"
+    end
+  end
+end

data/lib/simple_flag/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class SimpleFlag
+  VERSION = '0.1.1'
+end

data/simple_flag.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/simple_flag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_flag'
+  spec.authors       = ['Vojtěch Kusý']
+  spec.email         = ['wojtha@gmail.com']
+  spec.license       = 'MIT'
+  spec.version       = SimpleFlag::VERSION
+
+  spec.summary       = 'Simple feature flags'
+  spec.description   = 'Simple but powerful feature flag implementation in 90 LOC.'
+  spec.homepage      = 'https://github.com/wojtha/simple_flag'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['changelog_uri']     = 'https://github.com/wojtha/simple_flag/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri']   = 'https://github.com/wojtha/simple_flag'
+  spec.metadata['bug_tracker_uri']   = 'https://github.com/wojtha/simple_flag/issues'
+
+  spec.required_ruby_version = '>= 2.4.0'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = []
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: simple_flag
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Vojtěch Kusý
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple but powerful feature flag implementation in 90 LOC.
+email:
+- wojtha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_flag.rb
+- lib/simple_flag/version.rb
+- simple_flag.gemspec
+homepage: https://github.com/wojtha/simple_flag
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wojtha/simple_flag
+  allowed_push_host: https://rubygems.org
+  changelog_uri: https://github.com/wojtha/simple_flag/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/wojtha/simple_flag
+  bug_tracker_uri: https://github.com/wojtha/simple_flag/issues
+post_install_message: 
+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.1.1
+signing_key: 
+specification_version: 4
+summary: Simple feature flags
+test_files: []