this_feature 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a2e4f072c94b68b9a9e4675ac663f4d6f451d1d7c854e457079d539bd16184e
-  data.tar.gz: 6bbda6b3a7257f0a2e1ebd13784c3a78d4eb4ba3340727b99aa9d9df90753ea3
+  metadata.gz: 1038dc52ca2faa768e02dd16ac68f71551cad5405932575de6ffbb0be648896d
+  data.tar.gz: 9c930c96c3f67226b1a3eef72661320cb77cc275d0ac0fb69f8bd2342eddecf6
 SHA512:
-  metadata.gz: 0c0e69e00abb16fc2e781b4fdeb63664af7705280095c1f0a12cb660c5195b886463195e0830c91382474f62cd5c9c0b777aeddb14b494f48040cc2522d238c9
-  data.tar.gz: 6b1e05ba21a6409f413ba5b11167f1c17e561a9c2989edde58a1b2f50d1c368c4b76fde8153db4588757d6e4bd93a0f9e36d2fa4874e7190fa8c4347699e9c53
+  metadata.gz: 96c1151cc8dd148de9c5ba09e62cb1071b6cf18ce168145f07fa27cc4cf0075690deecd3326c6529966c74463bb088112bb8dd5bb5ad61d089a9a528318928af
+  data.tar.gz: b9c7ce61ee74dd0dbde08de215e72b8965fb9816a9a88cdfc0d68baa651db933d10801301a9ecb2f5de588d469870f2b479edc04a199f4aee71f94a28a0839d3

data/.github/workflows/linter-rubocop.yml

@@ -0,0 +1,19 @@
+on: [push]
+
+name: Ruby linter (Rubocop)
+
+jobs:
+  linter_rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@main
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Run Rubocop
+        run: bundle exec rubocop --parallel

data/.github/workflows/test.yml

@@ -1,34 +1,19 @@
 on: [push]
 
-name: Test
+name: Tests
 
 jobs:
-  run:
+  test:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
-        uses: actions/checkout@master
+        uses: actions/checkout@main
 
       - name: Set up Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@master
         with:
-          ruby-version: '2.7.x'
           bundler-cache: true
 
-      - name: Cache bundled gems
-        uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-gems-${{ hashFiles('Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-gems-
-
-      - name: Install Ruby gems
-        run: |
-          bundle config path vendor/bundle
-          bundle install
-
-      - name: Run Rspec
-        run: |
-          bundle exec rspec
+      - name: Run RSpec
+        run:  bundle exec rspec

data/.gitignore

@@ -1,6 +1,8 @@
 # sqlite3 database for tests, just called 'memory' for some reason
 memory
 
+**/.DS_Store
+*.gem
 /.bundle/
 /.yardoc
 /_yardoc/

data/.rubocop.yml

@@ -0,0 +1,32 @@
+require:
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-thread_safety
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+
+RSpec/NestedGroups:
+  Max: 4
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+  EnforcedShorthandSyntax: never
+
+Style/WordArray:
+  Exclude:
+    - spec/support/schema.rb
+
+Style/NumericLiterals:
+  Exclude:
+    - 'spec/support/schema.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,100 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-05-31 05:59:25 UTC using RuboCop version 1.51.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/this_feature_spec.rb'
+
+# Offense count: 3
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/this_feature/adapters/flipper.rb'
+    - 'lib/this_feature/adapters/memory.rb'
+    - 'lib/this_feature/adapters/split_io.rb'
+
+# Offense count: 23
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+    - 'lib/this_feature/adapters/base.rb'
+    - 'lib/this_feature/adapters/flipper.rb'
+    - 'lib/this_feature/adapters/memory.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 19
+
+# Offense count: 1
+RSpec/AnyInstance:
+  Exclude:
+    - 'spec/this_feature/adapters/split_io_adapter_spec.rb'
+
+# Offense count: 10
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 12
+
+# Offense count: 4
+# Configuration parameters: Max.
+RSpec/IndexedLet:
+  Exclude:
+    - 'spec/this_feature/adapters/memory_adapter_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 23
+RSpec/MultipleExpectations:
+  Max: 12
+
+# Offense count: 72
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+# Offense count: 9
+# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
+# SupportedStyles: always, named_only
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/this_feature/adapters/flipper_adapter_spec.rb'
+    - 'spec/this_feature/adapters/memory_adapter_spec.rb'
+    - 'spec/this_feature_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/this_feature_spec.rb'
+
+# Offense count: 3
+Style/MultilineBlockChain:
+  Exclude:
+    - 'spec/this_feature/adapters/base_adapter_spec.rb'
+    - 'spec/this_feature_spec.rb'
+
+# Offense count: 15
+Style/OpenStructUse:
+  Exclude:
+    - 'spec/this_feature/adapters/flipper_adapter_spec.rb'
+    - 'spec/this_feature/adapters/memory_adapter_spec.rb'
+    - 'spec/this_feature/adapters/split_io_adapter_spec.rb'
+
+# Offense count: 2
+ThreadSafety/InstanceVariableInClassMethod:
+  Exclude:
+    - 'lib/this_feature.rb'

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -1,5 +1,18 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gemspec name: "this_feature"
-gemspec name: "this_feature-adapters-flipper"
-gemspec name: "this_feature-adapters-split_io"
+gemspec name: 'this_feature'
+gemspec name: 'this_feature-adapters-flipper'
+gemspec name: 'this_feature-adapters-split_io'
+
+gem 'bundler'
+gem 'database_cleaner-active_record'
+gem 'gem-release'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-md'
+gem 'rubocop-performance'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'rubocop-thread_safety'
+gem 'sqlite3'

data/Gemfile.lock

@@ -1,37 +1,36 @@
 PATH
   remote: .
   specs:
-    this_feature (0.8.0)
-    this_feature-adapters-flipper (0.8.0)
-      flipper (~> 0.16)
-      flipper-active_record (~> 0.16)
+    this_feature (0.9.0)
+    this_feature-adapters-flipper (0.9.0)
+      flipper
+      flipper-active_record
       this_feature
-    this_feature-adapters-split_io (0.8.0)
+    this_feature-adapters-split_io (0.9.0)
       splitclient-rb
       this_feature
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activerecord (7.0.3.1)
-      activemodel (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activesupport (7.0.3.1)
+    activemodel (7.0.5)
+      activesupport (= 7.0.5)
+    activerecord (7.0.5)
+      activemodel (= 7.0.5)
+      activesupport (= 7.0.5)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    byebug (11.1.2)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.10)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
     connection_pool (2.2.5)
     database_cleaner (1.8.4)
     database_cleaner-active_record (1.8.0)
       activerecord
       database_cleaner (~> 1.8.0)
-    diff-lcs (1.3)
+    diff-lcs (1.5.0)
     faraday (1.7.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -51,43 +50,73 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    flipper (0.25.0)
-    flipper-active_record (0.25.0)
+    flipper (0.28.0)
+      concurrent-ruby (< 2)
+    flipper-active_record (0.28.0)
       activerecord (>= 4.2, < 8)
-      flipper (~> 0.25.0)
+      flipper (~> 0.28.0)
     gem-release (2.2.1)
     hitimes (1.3.1)
-    i18n (1.11.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.5.1)
     jwt (2.2.3)
     lru_redux (1.1.0)
-    method_source (1.0.0)
-    minitest (5.16.2)
+    minitest (5.18.0)
     multipart-post (2.1.1)
     net-http-persistent (4.0.1)
       connection_pool (~> 2.2)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.9.0)
-      byebug (~> 11.0)
-      pry (~> 0.13.0)
-    rake (13.0.1)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
     redis (4.4.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-md (1.2.0)
+      rubocop (>= 1.0)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    rubocop-thread_safety (0.5.1)
+      rubocop (>= 0.90.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     socketry (0.5.1)
       hitimes (~> 1.2)
@@ -103,23 +132,29 @@ GEM
       thread_safe (>= 0.3)
     sqlite3 (1.4.2)
     thread_safe (0.3.6)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
+  bundler
   database_cleaner-active_record
   gem-release
-  pry-byebug
-  rake (~> 13.0)
-  rspec (~> 3.0)
+  rake
+  rspec
+  rubocop
+  rubocop-md
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  rubocop-thread_safety
   sqlite3
   this_feature!
   this_feature-adapters-flipper!
   this_feature-adapters-split_io!
 
 BUNDLED WITH
-   2.3.21
+   2.4.13

data/README.md

@@ -4,9 +4,7 @@
 
 ThisFeature can be used to more easily migrate from one feature flag service to another
 
-If your code uses ThisFeature,
-then you can just swap out the vendor adapter without needing to do a bunch of find-and-replace in your codebase
-from one vendor's class/method signature to the another's.
+If your code uses ThisFeature, then you can just swap out the vendor adapter without needing to do a bunch of find-and-replace in your codebase from one vendor's class/method signature to the another's.
 
 ## Installation
 
@@ -68,7 +66,7 @@ ThisFeature.flag('flag_name', context: context, data: { org_id: 1 }).on?
 
 ### Avoid Pitfalls
 
-1. If your flag has context-specific rules (e.g. on for some orgs, off for others), make sure that the code does a context-specific check. `ThisFeature.flag("flag_name").on?` may return true, while `ThisFeature.flag("flag_name", context: Org.first).on?` would return false. 
+1. If your flag has context-specific rules (e.g. on for some orgs, off for others), make sure that the code does a context-specific check. `ThisFeature.flag("flag_name").on?` may return true, while `ThisFeature.flag("flag_name", context: Org.first).on?` would return false.
 2. Related to the previous bullet point, if you are checking whether a flag is "globally enabled" (and thus may be removed from the codebase), do not just use `ThisFeature.flag("flag_name").on?`, it won't tell you the whole story.  Go to the vendor console and check whether there are context-specific rules enabled.
 
 ## Available Adapters
@@ -103,6 +101,3 @@ To write a new adapter, check the [Guide](./docs/writing_an_adapter.md).
 ## License
 
 ThisFeature is released under the [MIT License](https://choosealicense.com/licenses/mit).
-
-
-

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,14 +1,10 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "this_feature"
+require 'bundler/setup'
+require 'this_feature'
 
 # 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"
+require 'irb'
 IRB.start(__FILE__)

data/docs/flipper.md

@@ -3,7 +3,7 @@
 ## Installation
 
 ```ruby
-gem 'this_feature-adapters-flipper
+gem 'this_feature-adapters-flipper'
 ```
 
 ## Configuration

data/docs/memory.md

@@ -24,7 +24,7 @@ in test suites.
 This adapter is included with the core gem:
 
 ```ruby
-gem 'this_feature
+gem 'this_feature'
 ```
 
 ## Configuration
@@ -50,7 +50,7 @@ For example:
 # of a context object (e.g. imagine this module is included onto User)
 module FeatureFlaggable
   def this_feature_id
-    "#{self.class}-#{self.id}"
+    "#{self.class}-#{id}"
   end
 end
 

data/docs/splitio.md

@@ -3,7 +3,7 @@
 ## Installation
 
 ```ruby
-gem 'this_feature-adapters-split-io
+gem 'this_feature-adapters-split-io'
 ```
 
 ## Configuration
@@ -39,7 +39,7 @@ attributes to the `data` hash. To take advantage of this, the application must
 set a `base_data_lambda` in the config. An example—
 ```ruby
 ThisFeature.configure do |config|
-  config.base_data_lambda = -> (record) do
+  config.base_data_lambda = lambda { |record|
     case record
     when Org
       {
@@ -52,11 +52,11 @@ ThisFeature.configure do |config|
         org_name: record.org.name,
         user_email: record.email,
         user_id: record.id,
-        user_name: record.name,
+        user_name: record.name
       }
     end
-  end
+  }
 end
 ```
 Then `ThisFeature.flag("my-flag", record: user).on?` will automatically include
-org_id, org_name, user_email, user_id, and user_name in the data attributes.
+org_id, org_name, user_email, user_id, and user_name in the data attributes.

data/docs/writing_an_adapter.md

@@ -1,8 +1,8 @@
-Look at [lib/this_feature/adapters/base.rb](../lib/this_feature/adapters/base.rb) to see the methods that your class should implement. 
+Look at [lib/this_feature/adapters/base.rb](../lib/this_feature/adapters/base.rb) to see the methods that your class should implement.
 
-Make sure your class inherits from `ThisFeature::Adapters::Base` - this is a requirement. 
+Make sure your class inherits from `ThisFeature::Adapters::Base` - this is a requirement.
 
-You may define a custom `initialize` method - this isn't used by `this_feature` internals because we require an already-constructed instance to be passed into `ThisFeature.configure`. 
+You may define a custom `initialize` method - this isn't used by `this_feature` internals because we require an already-constructed instance to be passed into `ThisFeature.configure`.
 
 For an example, look at one of the existing adapters: [lib/this_feature/adapters/](../lib/this_feature/adapters/)
 

data/lib/this_feature/adapters/flipper.rb

@@ -1,5 +1,5 @@
-require "flipper"
-require "flipper/adapters/active_record"
+require 'flipper'
+require 'flipper/adapters/active_record'
 
 class ThisFeature
   module Adapters

data/lib/this_feature/adapters/memory.rb

@@ -1,7 +1,6 @@
 class ThisFeature
   module Adapters
     class Memory < Base
-
       def initialize(context_key_method: nil)
         @context_key_method = context_key_method
       end

data/lib/this_feature/adapters/split_io.rb

@@ -5,7 +5,7 @@ class ThisFeature
     class SplitIo < Base
       # Used as the context key when none is given. This arg is required by
       # Split, but it's nice not to have to pass it when the context is empty.
-      EMPTY_CONTEXT = 'undefined_key'
+      EMPTY_CONTEXT = 'undefined_key'.freeze
 
       def initialize(client: nil, context_key_method: nil)
         @client = client || default_split_client

data/lib/this_feature/adapters.rb

@@ -1,5 +1,5 @@
-require_relative './adapters/base.rb'
-require_relative './adapters/memory.rb'
+require_relative './adapters/base'
+require_relative './adapters/memory'
 
 class ThisFeature
   module Adapters

data/lib/this_feature/configuration.rb

@@ -7,10 +7,10 @@ class ThisFeature
     end
 
     def validate_adapters!
-      raise(NoAdaptersError.new) unless adapters.any?
+      raise NoAdaptersError unless adapters.any?
 
       adapters.each do |adapter|
-        raise BadAdapterError.new(adapter) unless adapter.class < Adapters::Base
+        raise BadAdapterError, adapter unless adapter.class < Adapters::Base
       end
     end
 
@@ -27,7 +27,7 @@ class ThisFeature
     end
 
     def base_data_lambda
-      @base_data_lambda ||= -> (record) { {} }
+      @base_data_lambda ||= ->(_record) { {} }
     end
   end
 end

data/lib/this_feature/errors.rb

@@ -1,10 +1,9 @@
 class ThisFeature
-
   class Error < StandardError; end
 
   class UnimplementedError < Error
     def initialize(adapter_instance, fn_name)
-      super("class #{adapter_instance.class.name} doesnt implement method .#{fn_name}")
+      super("class #{adapter_instance.class.name} doesn't implement method .#{fn_name}")
     end
   end
 
@@ -16,8 +15,7 @@ class ThisFeature
 
   class NoAdaptersError < Error
     def initialize
-      super("No adapters configured.")
+      super('No adapters configured.')
     end
   end
-
 end

data/lib/this_feature/version.rb

@@ -1,3 +1,3 @@
 class ThisFeature
-  VERSION = "0.8.0"
+  VERSION = '0.9.0'.freeze
 end