simple_feature_flags 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a84d6f21fb85142181cf9396572ffb07ba4cb6d1573064c3ea984ab339371ddc
-  data.tar.gz: ca84facde85a613ceb6ecd54a88139a5ff9996838d8463d607e2e8ef93a1ce8e
+  metadata.gz: a31152f17215cd2905c721f27217aaa187c006345a5c811ca6194ae36fabef89
+  data.tar.gz: 9df276339edd478dc86e0ce590518c21ebc115f63899fe493ad328d11180ae5d
 SHA512:
-  metadata.gz: f74fb3b884d0523845038311ce962c5d41e24715f78f7580d1e45889c74eba9df1acd02ce37a6d6ac4e51208fb1d0b6dca0d76a097d90ebf8b367dbb46296996
-  data.tar.gz: e554a51da1a596189a62857ac4a4bf18ffac37578fece7680f5455222380763e4d1c55a952107b262955533cdfac8ebc7a0211f2c2378dad49d8768c7170da23
+  metadata.gz: 8b02dde3a77725c376a0375d8c291e308ee5ce8e7b885e2e051a08e8205eb8407b64e460e43ee6a404a504dd9f9bf1248f387a6764870ec444c3c44f0b423f71
+  data.tar.gz: f3f1cdecad7872b6c10c3a1e086f773844e04bf3869fc07d6661fef81dcf33fdb78f2d731318b3f6410cc6ca039fb10625bedb4ffc854f865b0ccf3cfe98f1b6

data/.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
       REDIS_PORT: 6379
     strategy:
       matrix:
-        ruby-version: ['3.1', '3.2', '3.3']
+        ruby-version: ['3.2', '3.3', '3.4']
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

data/.rubocop.yml

@@ -24,8 +24,11 @@ Sorbet/ForbidTUnsafe:
 Naming/BlockForwarding:
   Enabled: false
 
+Sorbet/ForbidSig:
+  Enabled: false
+
 AllCops:
-  TargetRubyVersion: 3.1.0
+  TargetRubyVersion: 3.2.0
   EnabledByDefault: true
   Exclude:
     - 'bin/*'

data/.ruby-version

@@ -1 +1 @@
-3.3.6
+3.4.3

data/Gemfile

@@ -10,7 +10,7 @@ gem 'minitest', '~> 5.0' # test library
 gem 'rake', '~> 13.0' # automation tasks
 gem 'redis', '~> 5.3' # redis client
 gem 'redis-namespace', '~> 1.11' # namespaces for redis
-gem 'rubocop-espago', '~> 1.0' # ruby linter
-gem 'rubocop-sorbet', '~> 0.8' # rubocop for sorbet
-gem 'sorbet', '>= 0.5' # static typechecker
-gem 'tapioca', '> 0.13' # RBI generator for sorbet
+gem 'rubocop-espago', '~> 1.1' # ruby linter
+gem 'rubocop-sorbet', '~> 0.10' # rubocop for sorbet
+gem 'sorbet', '~> 0.5' # static typechecker
+gem 'tapioca', '~> 0.17' # RBI generator for sorbet

data/Gemfile.lock

@@ -1,80 +1,96 @@
 PATH
   remote: .
   specs:
-    simple_feature_flags (1.3.0)
+    simple_feature_flags (1.4.1)
       sorbet-runtime (> 0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
+    ast (2.4.3)
+    benchmark (0.4.1)
     byebug (11.1.3)
     connection_pool (2.4.1)
-    erubi (1.13.0)
-    json (2.8.2)
-    language_server-protocol (3.17.0.3)
+    erubi (1.13.1)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.7.0)
     minitest (5.25.1)
     netrc (0.11.0)
-    parallel (1.26.3)
-    parser (3.3.6.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
-    prism (1.2.0)
+    prism (1.4.0)
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
-    rbi (0.2.1)
+    rbi (0.3.6)
       prism (~> 1.0)
-      sorbet-runtime (>= 0.5.9204)
+      rbs (>= 3.4.4)
+    rbs (4.0.0.dev.4)
+      logger
+      prism (>= 1.3.0)
     redis (5.3.0)
       redis-client (>= 0.22.0)
     redis-client (0.22.2)
       connection_pool
     redis-namespace (1.11.0)
       redis (>= 4)
-    regexp_parser (2.9.2)
-    rubocop (1.68.0)
+    regexp_parser (2.10.0)
+    require-hooks (0.2.2)
+    rexml (3.4.1)
+    rubocop (1.74.0)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.4, < 3.0)
-      rubocop-ast (>= 1.32.2, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.36.1)
-      parser (>= 3.3.1.0)
-    rubocop-espago (1.1.5)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.42.0)
+      parser (>= 3.3.7.2)
+    rubocop-espago (1.1.8)
       rubocop
-    rubocop-sorbet (0.8.7)
+    rubocop-sorbet (0.10.0)
       rubocop (>= 1)
     ruby-progressbar (1.13.0)
-    sorbet (0.5.11647)
-      sorbet-static (= 0.5.11647)
-    sorbet-runtime (0.5.11647)
-    sorbet-static (0.5.11647-aarch64-linux)
-    sorbet-static (0.5.11647-universal-darwin)
-    sorbet-static (0.5.11647-x86_64-linux)
-    sorbet-static-and-runtime (0.5.11647)
-      sorbet (= 0.5.11647)
-      sorbet-runtime (= 0.5.11647)
-    spoom (1.5.0)
+    sorbet (0.5.12210)
+      sorbet-static (= 0.5.12210)
+    sorbet-runtime (0.5.12210)
+    sorbet-static (0.5.12210-aarch64-linux)
+    sorbet-static (0.5.12210-universal-darwin)
+    sorbet-static (0.5.12210-x86_64-linux)
+    sorbet-static-and-runtime (0.5.12210)
+      sorbet (= 0.5.12210)
+      sorbet-runtime (= 0.5.12210)
+    spoom (1.7.4)
       erubi (>= 1.10.0)
       prism (>= 0.28.0)
+      rbi (>= 0.3.3)
+      rbs (>= 4.0.0.dev.4)
+      rexml (>= 3.2.6)
       sorbet-static-and-runtime (>= 0.5.10187)
       thor (>= 0.19.2)
-    tapioca (0.16.4)
+    tapioca (0.17.5)
+      benchmark
       bundler (>= 2.2.25)
       netrc (>= 0.11.0)
       parallel (>= 1.21.0)
-      rbi (~> 0.2)
+      rbi (>= 0.3.1)
+      require-hooks (>= 0.2.2)
       sorbet-static-and-runtime (>= 0.5.11087)
-      spoom (>= 1.2.0)
+      spoom (>= 1.7.0)
       thor (>= 1.2.0)
       yard-sorbet
     thor (1.3.2)
-    unicode-display_width (2.6.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
     yard (0.9.37)
     yard-sorbet (0.9.0)
       sorbet-runtime
@@ -91,11 +107,11 @@ DEPENDENCIES
   rake (~> 13.0)
   redis (~> 5.3)
   redis-namespace (~> 1.11)
-  rubocop-espago (~> 1.0)
-  rubocop-sorbet (~> 0.8)
+  rubocop-espago (~> 1.1)
+  rubocop-sorbet (~> 0.10)
   simple_feature_flags!
-  sorbet (>= 0.5)
-  tapioca (> 0.13)
+  sorbet (~> 0.5)
+  tapioca (~> 0.17)
 
 BUNDLED WITH
-   2.5.22
+   2.6.8

data/README.md

@@ -151,6 +151,21 @@ FEATURE_FLAGS.inactive_globally?(:feature_name) #=> false
 FEATURE_FLAGS.inactive_partially?(:feature_name) #=> true
 ```
 
+#### Activate a feature in a block
+
+Activates a feature for the code in the given block
+then restores the original state of the feature.
+
+```ruby
+FEATURE_FLAGS.active?(:feature_name) #=> false
+
+FEATURE_FLAGS.do_activate(:feature_name) do
+  FEATURE_FLAGS.active?(:feature_name) #=> true
+end
+
+FEATURE_FLAGS.active?(:feature_name) #=> false
+```
+
 #### Deactivate a feature
 
 Deactivates a feature in the global scope
@@ -165,6 +180,21 @@ FEATURE_FLAGS.active?(:feature_name) #=> false
 FEATURE_FLAGS.inactive?(:feature_name) #=> true
 ```
 
+#### Deactivate a feature in a block
+
+Activates a feature for the code in the given block
+then restores the original state of the feature.
+
+```ruby
+FEATURE_FLAGS.active?(:feature_name) #=> true
+
+FEATURE_FLAGS.do_deactivate(:feature_name) do
+  FEATURE_FLAGS.active?(:feature_name) #=> false
+end
+
+FEATURE_FLAGS.active?(:feature_name) #=> true
+```
+
 #### Activate a feature for a particular record/object
 
 ```ruby

data/lib/simple_feature_flags/base_storage.rb

@@ -5,11 +5,9 @@ require 'yaml'
 
 module SimpleFeatureFlags
   # Abstract class for all storage adapters.
+  # @abstract
   class BaseStorage
     extend T::Sig
-    extend T::Helpers
-
-    abstract!
 
     # Path to the file with feature flags
     sig { abstract.returns(String) }
@@ -166,14 +164,50 @@ module SimpleFeatureFlags
     sig { abstract.params(feature: T.any(Symbol, String)).returns(T::Boolean) }
     def activate(feature); end
 
+    # Activates the flag, calls the block and restores the previous state of the flag.
+    sig do
+      abstract
+        .type_parameters(:R)
+        .params(
+          feature: T.any(Symbol, String),
+          block:   T.proc.returns(T.type_parameter(:R)),
+        )
+        .returns(T.type_parameter(:R))
+    end
+    def do_activate(feature, &block); end
+
     # Activates the given flag globally. Returns `false` if it does not exist.
     sig { abstract.params(feature: T.any(Symbol, String)).returns(T::Boolean) }
     def activate_globally(feature); end
 
+    # Activates the flag globally, calls the block and restores the previous state of the flag.
+    sig do
+      abstract
+        .type_parameters(:R)
+        .params(
+          feature: T.any(Symbol, String),
+          block:   T.proc.returns(T.type_parameter(:R)),
+        )
+        .returns(T.type_parameter(:R))
+    end
+    def do_activate_globally(feature, &block); end
+
     # Activates the given flag partially. Returns `false` if it does not exist.
     sig { abstract.params(feature: T.any(Symbol, String)).returns(T::Boolean) }
     def activate_partially(feature); end
 
+    # Activates the flag partially, calls the block and restores the previous state of the flag.
+    sig do
+      abstract
+        .type_parameters(:R)
+        .params(
+          feature: T.any(Symbol, String),
+          block:   T.proc.returns(T.type_parameter(:R)),
+        )
+        .returns(T.type_parameter(:R))
+    end
+    def do_activate_partially(feature, &block); end
+
     # Activates the given flag for the given objects. Returns `false` if it does not exist.
     sig do
       abstract
@@ -209,6 +243,18 @@ module SimpleFeatureFlags
     sig { abstract.params(feature: T.any(Symbol, String)).returns(T::Boolean) }
     def deactivate(feature); end
 
+    # Deactivates the flag, calls the block and restores the previous state of the flag.
+    sig do
+      abstract
+        .type_parameters(:R)
+        .params(
+          feature: T.any(Symbol, String),
+          block:   T.proc.returns(T.type_parameter(:R)),
+        )
+        .returns(T.type_parameter(:R))
+    end
+    def do_deactivate(feature, &block); end
+
     # Returns a hash of Objects that the given flag is turned on for.
     # The keys are class/model names, values are arrays of IDs of instances/records.
     #
@@ -252,7 +298,7 @@ module SimpleFeatureFlags
           active:      T.any(String, Symbol, T::Boolean, NilClass),
         ).returns(T.nilable(T::Hash[String, T.anything]))
     end
-    def add(feature, description, active = 'false'); end
+    def add(feature, description = '', active = 'false'); end
 
     # Removes the given feature flag.
     # Returns its data or nil if it does not exist.
@@ -272,13 +318,13 @@ module SimpleFeatureFlags
 
     private
 
-    sig { params(objects: T::Array[Object], object_id_method: Symbol).returns(T::Hash[String, T::Array[Object]]) }
+    #: (Array[Object] objects, ?object_id_method: Symbol) -> Hash[String, Array[Object]]
     def objects_to_hash(objects, object_id_method: CONFIG.default_id_method)
       objects.group_by { |ob| ob.class.to_s }
              .transform_values { |arr| arr.map(&object_id_method) }
     end
 
-    sig { void }
+    #: -> void
     def import_flags_from_file
       changes = YAML.load_file(file)
       changes = { mandatory: [], remove: [] } unless changes.is_a? ::Hash

data/lib/simple_feature_flags/cli/command/generate.rb

@@ -10,17 +10,17 @@ module SimpleFeatureFlags
       class Generate
         extend T::Sig
 
-        CONFIG_FILE = T.let('simple_feature_flags.yml', String)
+        CONFIG_FILE = 'simple_feature_flags.yml' #: String
 
-        sig { returns(Options) }
+        #: Options
         attr_reader :options
 
-        sig { params(options: Options).void }
+        #: (Options options) -> void
         def initialize(options)
           @options = options
         end
 
-        sig { void }
+        #: -> void
         def run
           if options.rails
             generate_for_rails
@@ -36,7 +36,7 @@ module SimpleFeatureFlags
 
         private
 
-        sig { void }
+        #: -> void
         def generate_for_rails
           ::FileUtils.cp_r example_config_dir, destination_dir
 
@@ -70,26 +70,20 @@ module SimpleFeatureFlags
           system 'bundle'
         end
 
-        sig do
-          params(
-            file_path: String,
-            regexp:    Regexp,
-            block:     T.proc.params(arg0: String).returns(String),
-          ).void
-        end
+        #: (String file_path, Regexp regexp) { (String arg0) -> String } -> void
         def file_gsub(file_path, regexp, &block)
           new_content = File.read(file_path).gsub(regexp, &block)
           File.binwrite(file_path, new_content)
         end
 
-        sig { params(file_path: String, line: String).void }
+        #: (String file_path, String line) -> void
         def file_append(file_path, line)
           new_content = File.read(file_path)
           new_content = "#{new_content}\n#{line}\n"
           File.binwrite(file_path, new_content)
         end
 
-        sig { params(dir: String, embed_level: Integer).void }
+        #: (String dir, ?Integer embed_level) -> void
         def print_dir_tree(dir, embed_level = 0)
           padding = ' ' * (embed_level * 2)
 
@@ -105,32 +99,32 @@ module SimpleFeatureFlags
           end
         end
 
-        sig { returns String }
+        #: -> String
         def initializer_file
           ::File.join(destination_dir, 'config', 'initializers', 'simple_feature_flags.rb')
         end
 
-        sig { returns String }
+        #: -> String
         def gemfile
           ::File.join(destination_dir, 'Gemfile')
         end
 
-        sig { returns String }
+        #: -> String
         def routes_rb
           ::File.join(destination_dir, 'config', 'routes.rb')
         end
 
-        sig { returns String }
+        #: -> String
         def example_config_dir
           ::File.join(::File.expand_path(__dir__), '..', '..', '..', 'example_files', 'config')
         end
 
-        sig { returns String }
+        #: -> String
         def example_config_file
           ::File.join(example_config_dir, CONFIG_FILE)
         end
 
-        sig { returns String }
+        #: -> String
         def destination_dir
           if options.rails && !::Dir.new(::Dir.pwd).entries.include?('config')
             raise IncorrectWorkingDirectoryError,
@@ -140,7 +134,7 @@ module SimpleFeatureFlags
           ::Dir.pwd
         end
 
-        sig { returns String }
+        #: -> String
         def destination_file
           @destination_file ||= ::File.join(destination_dir, CONFIG_FILE)
         end

data/lib/simple_feature_flags/cli/options.rb

@@ -9,23 +9,23 @@ module SimpleFeatureFlags
     class Options
       extend T::Sig
 
-      sig { returns(OptionParser) }
+      #: OptionParser
       attr_reader :opt_parser
 
-      sig { returns(T::Boolean) }
+      #: bool
       attr_reader :generate
 
-      sig { returns(T::Boolean) }
+      #: bool
       attr_reader :rails
 
-      sig { returns(T::Boolean) }
+      #: bool
       attr_reader :ui
 
-      sig { params(args: T::Array[String]).void }
+      #: (Array[String] args) -> void
       def initialize(args)
-        @rails = T.let(true, T::Boolean)
-        @ui = T.let(false, T::Boolean)
-        @generate = T.let(false, T::Boolean)
+        @rails = true #: bool
+        @ui = false #: bool
+        @generate = false #: bool
 
         @opt_parser = ::OptionParser.new do |opts|
           opts.banner = 'Usage: simple_feature_flags [options]'

data/lib/simple_feature_flags/cli/runner.rb

@@ -7,15 +7,15 @@ module SimpleFeatureFlags
     class Runner
       extend T::Sig
 
-      sig { returns(Options) }
+      #: Options
       attr_reader :options
 
-      sig { params(args: T::Array[String]).void }
+      #: (?Array[String] args) -> void
       def initialize(args = ARGV)
         @options = Options.new(args)
       end
 
-      sig { void }
+      #: -> void
       def run
         command_class =
           if @options.generate

data/lib/simple_feature_flags/configuration.rb

@@ -6,10 +6,10 @@ module SimpleFeatureFlags
   class Configuration
     extend T::Sig
 
-    sig { returns(Symbol) }
+    #: Symbol
     attr_accessor :default_id_method
 
-    sig { void }
+    #: -> void
     def initialize
       @default_id_method = :id
     end