simple_feature_flags 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a488fbf34e74246e7256a469d99a257b6f20171f9e0f57c0f5186388937cc0
-  data.tar.gz: 224dde8807aaf6aec346641e05106de0de0a88b3f0ba388e05bc51af93270664
+  metadata.gz: a84d6f21fb85142181cf9396572ffb07ba4cb6d1573064c3ea984ab339371ddc
+  data.tar.gz: ca84facde85a613ceb6ecd54a88139a5ff9996838d8463d607e2e8ef93a1ce8e
 SHA512:
-  metadata.gz: 4596a45fc389a9235700db3b76260735f8a2ce71b0eb5bec19d8efb621ed842dc149c86246ab4701a5ee3d6205d99eb1f175a294e65ec028c8dc81373141391d
-  data.tar.gz: a938f338faf71ff1048b88ca280f5800d530298873398840ced76231cad1a57501cfd58a424888769074e1a80657f758f5796403f7dda526581ca12a082752d1
+  metadata.gz: f74fb3b884d0523845038311ce962c5d41e24715f78f7580d1e45889c74eba9df1acd02ce37a6d6ac4e51208fb1d0b6dca0d76a097d90ebf8b367dbb46296996
+  data.tar.gz: e554a51da1a596189a62857ac4a4bf18ffac37578fece7680f5455222380763e4d1c55a952107b262955533cdfac8ebc7a0211f2c2378dad49d8768c7170da23

data/.github/workflows/ci.yml

@@ -0,0 +1,74 @@
+name: CI Ruby
+
+on:
+  push:
+    branches: [ 'main', 'develop' ]
+  pull_request:
+    branches: [ 'main', 'develop' ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      # Label used to access the service container
+      redis:
+        # Docker Hub image
+        image: redis
+        # Set health checks to wait until redis has started
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          # Maps port 6379 on service container to the host
+          - 6379:6379
+    env:
+      CI: true
+      # The hostname used to communicate with the Redis service container
+      REDIS_HOST: localhost
+      # The default Redis port
+      REDIS_PORT: 6379
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run unit tests
+        run: bundle exec rake test
+
+  lint:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+      - name: Lint Ruby files
+        run: bundle exec rubocop --parallel
+
+  typecheck:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3'
+          bundler-cache: true
+      - name: Typecheck Ruby files
+        run: bundle exec srb tc

data/.gitignore

@@ -6,5 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.vscode
 .byebug_history
 my_examples

data/.rubocop.yml

@@ -1,78 +1,32 @@
-Style/StringLiterals:
-  Enabled: false
-
-Style/SingleArgumentDig:
-  Enabled: false
-
-Layout/LineLength:
-  Enabled: false
+inherit_gem:
+  rubocop-espago: sorbet.yml
 
-Style/Documentation:
+Metrics/MethodLength:
   Enabled: false
 
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/MethodCallWithArgsParentheses:
-  Enabled: false
-
-Style/ModuleFunction:
-  EnforcedStyle: 'extend_self'
-
-Style/MissingElse:
+Sorbet/RedundantExtendTSig:
   Enabled: false
 
-Lint/NumberConversion:
+Sorbet/HasSigil:
   Enabled: false
 
-Lint/ConstantResolution:
+Metrics/ClassLength:
   Enabled: false
 
-Style/RescueStandardError:
-  Enabled: false
-
-Style/FormatStringToken:
-  Enabled: false
-
-Style/FormatString:
-  Enabled: false
-
-Style/DocumentationMethod:
-  Enabled: false
-
-Style/Copyright:
-  Enabled: false
-
-Style/StringHashKeys:
-  Enabled: false
-
-Style/InlineComment:
-  Enabled: false
-
-Layout/FirstHashElementLineBreak:
-  Enabled: false
-
-Layout/FirstMethodArgumentLineBreak:
-  Enabled: false
-
-Style/ConstantVisibility:
-  Enabled: false
-
-Layout/FirstArrayElementLineBreak:
-  Enabled: false
-
-Layout/MultilineMethodArgumentLineBreaks:
-  Enabled: false
+Sorbet/EnforceSignatures:
+  Exclude:
+    - 'bin/*'
+    - 'test/**/*'
 
-Layout/MultilineAssignmentLayout:
+Sorbet/ForbidTUnsafe:
   Enabled: false
 
-Bundler/GemComment:
+Naming/BlockForwarding:
   Enabled: false
 
 AllCops:
+  TargetRubyVersion: 3.1.0
   EnabledByDefault: true
   Exclude:
     - 'bin/*'
-    - 'spec/**/*'
-    - 'test/**/*'
+    - 'sorbet/**/*'

data/.ruby-version

@@ -1 +1 @@
-2.7.4
+3.3.6

data/.vscode/settings.json

@@ -13,5 +13,9 @@
     "optparse",
     "solargraph",
     "testtask"
-  ]
+  ],
+  "sorbet.enabled": true,
+  "[ruby]": {
+      "editor.defaultFormatter": "Shopify.ruby-lsp"
+  }
 }

data/Gemfile

@@ -1,6 +1,16 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in simple_feature_flags.gemspec
 gemspec
+
+gem 'byebug', '~> 11.1' # debugger
+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

data/Gemfile.lock

@@ -1,89 +1,101 @@
 PATH
   remote: .
   specs:
-    simple_feature_flags (1.1.1)
+    simple_feature_flags (1.3.0)
+      sorbet-runtime (> 0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    backport (1.2.0)
-    benchmark (0.1.1)
-    bundler-audit (0.8.0)
-      bundler (>= 1.2.0, < 3)
-      thor (~> 1.0)
     byebug (11.1.3)
-    diff-lcs (1.4.4)
-    e2mmap (0.1.0)
-    jaro_winkler (1.5.4)
-    kramdown (2.3.1)
-      rexml
-    kramdown-parser-gfm (1.1.0)
-      kramdown (~> 2.0)
-    mini_portile2 (2.6.1)
-    minitest (5.14.4)
-    nokogiri (1.12.3)
-      mini_portile2 (~> 2.6.1)
-      racc (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    connection_pool (2.4.1)
+    erubi (1.13.0)
+    json (2.8.2)
+    language_server-protocol (3.17.0.3)
+    minitest (5.25.1)
+    netrc (0.11.0)
+    parallel (1.26.3)
+    parser (3.3.6.0)
       ast (~> 2.4.1)
-    racc (1.5.2)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    redis (4.4.0)
-    redis-namespace (1.8.1)
-      redis (>= 3.0.4)
-    regexp_parser (2.1.1)
-    reverse_markdown (2.0.0)
-      nokogiri
-    rexml (3.2.5)
-    rubocop (1.19.0)
+      racc
+    prism (1.2.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    rbi (0.2.1)
+      prism (~> 1.0)
+      sorbet-runtime (>= 0.5.9204)
+    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)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.9.1, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.9.1)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    solargraph (0.43.0)
-      backport (~> 1.2)
-      benchmark
-      bundler (>= 1.17.2)
-      diff-lcs (~> 1.4)
-      e2mmap
-      jaro_winkler (~> 1.5)
-      kramdown (~> 2.3)
-      kramdown-parser-gfm (~> 1.1)
-      parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
-      thor (~> 1.0)
-      tilt (~> 2.0)
-      yard (~> 0.9, >= 0.9.24)
-    thor (1.1.0)
-    tilt (2.0.10)
-    unicode-display_width (2.0.0)
-    yard (0.9.26)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.36.1)
+      parser (>= 3.3.1.0)
+    rubocop-espago (1.1.5)
+      rubocop
+    rubocop-sorbet (0.8.7)
+      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)
+      erubi (>= 1.10.0)
+      prism (>= 0.28.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    tapioca (0.16.4)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.2)
+    unicode-display_width (2.6.0)
+    yard (0.9.37)
+    yard-sorbet (0.9.0)
+      sorbet-runtime
+      yard
 
 PLATFORMS
-  ruby
+  aarch64-linux
+  universal-darwin
+  x86_64-linux
 
 DEPENDENCIES
-  bundler
-  bundler-audit
-  byebug
+  byebug (~> 11.1)
   minitest (~> 5.0)
-  rake (~> 12.0)
-  redis
-  redis-namespace
-  rubocop
+  rake (~> 13.0)
+  redis (~> 5.3)
+  redis-namespace (~> 1.11)
+  rubocop-espago (~> 1.0)
+  rubocop-sorbet (~> 0.8)
   simple_feature_flags!
-  solargraph
+  sorbet (>= 0.5)
+  tapioca (> 0.13)
 
 BUNDLED WITH
-   2.1.4
+   2.5.22

data/README.md

@@ -136,11 +136,19 @@ FEATURE_FLAGS.active?(:feature_name) #=> false
 FEATURE_FLAGS.active_globally?(:feature_name) #=> false
 FEATURE_FLAGS.active_partially?(:feature_name) #=> false
 
+FEATURE_FLAGS.inactive?(:feature_name) #=> true
+FEATURE_FLAGS.inactive_globally?(:feature_name) #=> true
+FEATURE_FLAGS.inactive_partially?(:feature_name) #=> true
+
 FEATURE_FLAGS.activate(:feature_name) # or FEATURE_FLAGS.activate_globally(:feature_name)
 
 FEATURE_FLAGS.active?(:feature_name) #=> true
 FEATURE_FLAGS.active_globally?(:feature_name) #=> true
 FEATURE_FLAGS.active_partially?(:feature_name) #=> false
+
+FEATURE_FLAGS.inactive?(:feature_name) #=> false
+FEATURE_FLAGS.inactive_globally?(:feature_name) #=> false
+FEATURE_FLAGS.inactive_partially?(:feature_name) #=> true
 ```
 
 #### Deactivate a feature
@@ -149,10 +157,12 @@ Deactivates a feature in the global scope
 
 ```ruby
 FEATURE_FLAGS.active?(:feature_name) #=> true
+FEATURE_FLAGS.inactive?(:feature_name) #=> false
 
 FEATURE_FLAGS.deactivate(:feature_name)
 
 FEATURE_FLAGS.active?(:feature_name) #=> false
+FEATURE_FLAGS.inactive?(:feature_name) #=> true
 ```
 
 #### Activate a feature for a particular record/object
@@ -162,11 +172,19 @@ FEATURE_FLAGS.active_partially?(:feature_name) #=> true
 FEATURE_FLAGS.active_for?(:feature_name, User.first) #=> false
 FEATURE_FLAGS.active_for?(:feature_name, User.last) #=> false
 
+FEATURE_FLAGS.inactive_partially?(:feature_name) #=> false
+FEATURE_FLAGS.inactive_for?(:feature_name, User.first) #=> true
+FEATURE_FLAGS.inactive_for?(:feature_name, User.last) #=> true
+
 FEATURE_FLAGS.activate_for(:feature_name, User.first) #=> true
 
 FEATURE_FLAGS.active_partially?(:feature_name) #=> true
 FEATURE_FLAGS.active_for?(:feature_name, User.first) #=> true
 FEATURE_FLAGS.active_for?(:feature_name, User.last) #=> false
+
+FEATURE_FLAGS.inactive_partially?(:feature_name) #=> false
+FEATURE_FLAGS.inactive_for?(:feature_name, User.first) #=> false
+FEATURE_FLAGS.inactive_for?(:feature_name, User.last) #=> true
 ```
 
 Note that the flag itself has to be active `partially` for any record/object specific settings to work.
@@ -299,6 +317,10 @@ if FEATURE_FLAGS.active?(:feature_name)
   number += 1
 end
 
+if FEATURE_FLAGS.inactive?(:feature_name)
+  number += 1
+end
+
 # or using a block
 
 # this code will run only when the :feature_name flag is active (either partially or globally)
@@ -306,27 +328,52 @@ FEATURE_FLAGS.when_active(:feature_name) do
   number += 1
 end
 
+# the opposite
+FEATURE_FLAGS.when_inactive(:feature_name) do
+  number += 1
+end
+
 # this code will run only when the :feature_name flag is active globally
 FEATURE_FLAGS.when_active_globally(:feature_name) do
   number += 1
 end
 
+# the opposite
+FEATURE_FLAGS.when_inactive_globally(:feature_name) do
+  number += 1
+end
+
 # this code will run only when the :feature_name flag is active partially (only for specific records/users)
 FEATURE_FLAGS.when_active_partially(:feature_name) do
   number += 1
 end
 
-# this code will run only if the :feature_name flag is active partially for the first User
+# the opposite
+FEATURE_FLAGS.when_inactive_partially(:feature_name) do
+  number += 1
+end
+
+# this code will run only if the :feature_name flag is active for the first User
 FEATURE_FLAGS.when_active_for(:feature_name, User.first) do
   number += 1
 end
 
+# the opposite
+FEATURE_FLAGS.when_inactive_for(:feature_name, User.first) do
+  number += 1
+end
+
 # feature flags that don't exist will return false
 FEATURE_FLAGS.active?(:non_existant) #=> false
+FEATURE_FLAGS.inactive?(:non_existant) #=> true
 
 if FEATURE_FLAGS.active_for?(:feature_name, User.first)
   number += 1
 end
+
+if FEATURE_FLAGS.inactive_for?(:feature_name, User.first)
+  number += 1
+end
 ```
 
 #### Adding feature flags
@@ -340,7 +387,7 @@ FEATURE_FLAGS.add(:feature_name, 'Description')
 FEATURE_FLAGS.active?(:feature_name) #=> false
 FEATURE_FLAGS.active_partially?(:feature_name) #=> false
 FEATURE_FLAGS.active_globally?(:feature_name) #=> false
-FEATURE_FLAGS.active_for?(:feature_active_partially, User.first) #=> false
+FEATURE_FLAGS.active_for?(:feature_name, User.first) #=> false
 
 # add a new globally active flag
 FEATURE_FLAGS.add(:active_feature, 'Description', :globally)
@@ -370,6 +417,10 @@ FEATURE_FLAGS.remove(:feature_name)
 FEATURE_FLAGS.active?(:feature_name) #=> false
 FEATURE_FLAGS.active_partially?(:feature_name) #=> false
 FEATURE_FLAGS.active_globally?(:feature_name) #=> false
+
+FEATURE_FLAGS.inactive?(:feature_name) #=> true
+FEATURE_FLAGS.inactive_partially?(:feature_name) #=> true
+FEATURE_FLAGS.inactive_globally?(:feature_name) #=> true
 ```
 
 

data/Rakefile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 task default: :test

data/bin/tapioca

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+
+bundle_binstub = File.expand_path("bundle", __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("tapioca", "tapioca")

data/bin/test

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rubocop --parallel --color
+bundle exec srb tc
+bundle exec rake test

data/lib/example_files/config/initializers/simple_feature_flags.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
+
 # Redis has 16 DBs (0 to 15)
 
 FEATURE_FLAGS = if ::Rails.env.test?
                   # Use RamStorage in tests to make them faster
-                  ::SimpleFeatureFlags::RamStorage.new("#{::Rails.root.to_s}/config/simple_feature_flags.yml")
+                  ::SimpleFeatureFlags::RamStorage.new("#{::Rails.root}/config/simple_feature_flags.yml")
                 else
-                  redis = ::Redis.new(host: '127.0.0.1', port: 6379, db: 0)
+                  redis = ::Redis.new(host: '127.0.0.1', port: 6379, db: 0) # rubocop:disable Style/IpAddresses
                   # We recommend using the `redis-namespace` gem to avoid key conflicts with Sidekiq or Resque
                   # redis = ::Redis::Namespace.new(:simple_feature_flags, redis: redis)
 
-                  ::SimpleFeatureFlags::RedisStorage.new(redis, "#{::Rails.root.to_s}/config/simple_feature_flags.yml")
+                  ::SimpleFeatureFlags::RedisStorage.new(redis, "#{::Rails.root}/config/simple_feature_flags.yml")
                 end