simple_flag 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f2041da22824b405194cc6203aa275e474ee4055f733d4959c60256d0984d51
-  data.tar.gz: d5c4f449cadb4febda25719c8653eeff8d1f4fc65c42c72f9f0d1661cae3eac1
+  metadata.gz: bbd1947bf544e442e36623fd657fb8cdf6e0efe8fb63ec7f0971f262be989ca0
+  data.tar.gz: 195755be62e37c5e6ba4e6ac26c35b1923336fe928077e8fb949e2c4b1ef9c24
 SHA512:
-  metadata.gz: d95d77afd1ee6c44acf335e977034920f7f70eba17f52577823489240bfa3089ee5348a762fd7f2a192ed7ac29b93a1aca52d35567fc4e80363d751bf2602a47
-  data.tar.gz: 440b21b9616ff41ff02597088ec1da841224cbfa513c6c3f5c309ef576e5480fac001399715a316edc7929c6aa76385609327fdea6f5b3b357d2ace469e1f223
+  metadata.gz: 2513065a2f663f190be82516af7f633b85ac3ea3615d036cc296c08e7a19f151a0fff34f0e025d67e8c452ca7b14e393f9dc087aa05778fb7ebc4be015a2e0b5
+  data.tar.gz: 1bae49ddd11e11832f46cd908c70998fef9097b114d66c034d4cb6c32e627aa968ad73b4cd3adbb0118ee3acb18728181607c52a27116ab3448496661521f49d

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [ 'master' ]
+  pull_request:
+    branches: [ 'master' ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run linter
+      run: bundle exec rubocop
+    - name: Run tests
+      run: bundle exec rspec

data/.gitignore

@@ -9,5 +9,8 @@
 /tmp/
 Gemfile.lock
 
+# ASDF-VM
+.tool-versions
+
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -1,3 +1,7 @@
+AllCops:
+  NewCops: enable
+Gemspec/RequiredRubyVersion:
+  Enabled: false
 Layout/LineLength:
   Max: 120
 Layout/MultilineMethodCallIndentation:
@@ -12,3 +16,5 @@ Style/GuardClause:
   Enabled: false
 Style/NumericPredicate:
   Enabled: false
+Style/OptionalBooleanParameter:
+  Enabled: false

data/Gemfile

@@ -5,5 +5,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in simple_flag.gemspec
 gemspec
 
-gem 'rake', '~> 12.0'
-gem 'rspec', '~> 3.0'
+gem 'rake', '~> 13.1'
+gem 'rspec', '~> 3.12'
+gem 'rubocop', '~> 1.57'

data/lib/simple_flag/overrides.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class SimpleFlag
+  # Overrides module provides methods for overriding feature flags during testing.
+  module Overrides
+    def override(name, result = true, &block)
+      raise FlagNotDefined, "Feature flag `#{name}` is not defined" unless flag?(name)
+
+      # We are using proc, not lambda, because proc does not check for number of arguments
+      original_block = overridden?(name) ? @overrides[name] : @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 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 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 overridden?(name)
+      @overrides.key?(name)
+    end
+  end
+end

data/lib/simple_flag/version.rb

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

data/lib/simple_flag.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'simple_flag/version'
+require 'simple_flag/overrides'
 
 # Class FeatureFlag defines and stores feature flags
 #
@@ -48,6 +49,8 @@ require 'simple_flag/version'
 # @see http://blog.arkency.com/2015/11/simple-feature-toggle-for-rails-app/
 #
 class SimpleFlag
+  include Overrides
+
   FlagAlreadyDefined = Class.new(StandardError)
   FlagNotDefined = Class.new(StandardError)
   FlagNotOverridden = Class.new(StandardError)
@@ -80,64 +83,38 @@ class SimpleFlag
     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?
+  alias on? active?
 
   def inactive?(name, *args)
     !active?(name, *args)
   end
   alias disabled? inactive?
+  alias off? inactive?
+
+  # Returns thruthy value, returned by flag or nil
+  #
+  # @param [Symbol] name The name of the flag
+  # @param [Array<Symbol>] args The flag arguments
+  #
+  # @return [TrueClass,NilClass] Returns truthy value from flag or nil
+  #
+  # @example Usage in Rails
+  #   user.birth_date = birth_date || FEATURE.on?(:fake_data).presence && '1983-01-01'
+  #   user.birth_date = birth_date || FEATURE.presence(:fake_data) && '1983-01-01'
+  #
+  def presence(name, *args)
+    active?(name, *args) || nil
+  end
 
   def env?(*args)
     [*args].map(&:to_s).include?(env.to_s)
@@ -150,7 +127,7 @@ class SimpleFlag
 
     if original_arity != override_arity
       raise FlagArgumentsMismatch, "Flag '#{flag_name}' expects #{flag_arity} arguments, " \
-            "but #{override_arity} arguments were given"
+                                   "but #{override_arity} arguments were given"
     end
   end
 
@@ -158,11 +135,11 @@ class SimpleFlag
     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"
+                                   "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"
+                                   "but #{args_size} arguments were given"
     end
   end
 end

data/simple_flag.gemspec

@@ -18,8 +18,9 @@ Gem::Specification.new do |spec|
   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.metadata['rubygems_mfa_required'] = 'true'
 
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 2.7.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.
@@ -29,8 +30,4 @@ Gem::Specification.new do |spec|
   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

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: simple_flag
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Vojtěch Kusý
-autorequire: 
+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'
+date: 2023-11-01 00:00:00.000000000 Z
+dependencies: []
 description: Simple but powerful feature flag implementation in 90 LOC.
 email:
 - wojtha@gmail.com
@@ -59,10 +17,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -70,6 +28,7 @@ files:
 - bin/console
 - bin/setup
 - lib/simple_flag.rb
+- lib/simple_flag/overrides.rb
 - lib/simple_flag/version.rb
 - simple_flag.gemspec
 homepage: https://github.com/wojtha/simple_flag
@@ -81,7 +40,8 @@ metadata:
   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: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,15 +49,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
-signing_key: 
+rubygems_version: 3.4.21
+signing_key:
 specification_version: 4
 summary: Simple feature flags
 test_files: []

data/.travis.yml

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