ci: add rubocop (#32)

* Rubcop fixes

* Add rubocop action

* Update rubocop and fix new linting issues
Update .rubocop_todo

* Drop ruby <2.7 support

* Exclude vendor files

Author: matthewelwell

.github/workflows/pull_request.yaml

@@ -31,7 +31,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
 
     steps:
     - uses: actions/checkout@v3
@@ -44,5 +44,7 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Linting
+      run: bundle exec rubocop
     - name: Run tests
       run: bundle exec rspec spec

.rubocop.yml

@@ -9,3 +9,4 @@ AllCops:
   Exclude:
     - 'spec/**/*'
     - 'example/**/*'
+    - 'vendor/**/*'

.rubocop_todo.yml

@@ -1,29 +1,22 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2020-12-30 22:56:14 UTC using RuboCop version 1.7.0.
+# `rubocop --auto-gen-config`
+# on 2023-07-20 10:26:52 UTC using RuboCop version 1.54.2.
 # 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: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
-# IgnoredMethods: refine
-Metrics/BlockLength:
+# Offense count: 6
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
   Exclude:
-    - '**/*.gemspec'
-
-# Offense count: 1
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: respond_to_missing?
-Style/OptionalBooleanParameter:
-  Exclude:
-    - 'lib/flagsmith.rb'
+    - 'flagsmith.gemspec'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Exclude:
-    - 'flagsmith.gemspec'
+  Max: 183

Gemfile.lock

@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    ast (2.4.2)
     coderay (1.1.3)
     diff-lcs (1.4.4)
     faraday (1.10.0)
@@ -39,17 +39,21 @@ GEM
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
     gem-release (2.2.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
     multipart-post (2.2.3)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rainbow (3.0.0)
+    racc (1.7.1)
+    rainbow (3.1.1)
     rake (13.0.3)
-    regexp_parser (2.0.3)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -64,21 +68,23 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.1)
-    rubocop (1.7.0)
+    rubocop (1.54.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     semantic (1.6.1)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby

flagsmith.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday_middleware'
   spec.add_dependency 'faraday-retry'
   spec.add_dependency 'semantic'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

lib/flagsmith.rb

@@ -22,7 +22,7 @@
 # no-doc
 module Flagsmith
   # Ruby client for flagsmith.com
-  class Client
+  class Client # rubocop:disable Metrics/ClassLength
     extend Forwardable
     # A Flagsmith client.
     #
@@ -153,13 +153,13 @@ def get_value_for_identity(feature_name, user_id = nil, default: nil)
 
     def get_identity_segments(identifier, traits = {})
       unless environment
-        raise Flagsmith::ClientError, 
-          'Local evaluation required to obtain identity segments.'
+        raise Flagsmith::ClientError,
+              'Local evaluation required to obtain identity segments.'
       end
 
       identity_model = build_identity_model(identifier, traits)
       segment_models = engine.get_identity_segments(environment, identity_model)
-      return segment_models.map { |sm| Flagsmith::Segments::Segment.new(id: sm.id, name: sm.name) }.compact
+      segment_models.map { |sm| Flagsmith::Segments::Segment.new(id: sm.id, name: sm.name) }.compact
     end
 
     private

lib/flagsmith/engine/features/models.rb

@@ -40,9 +40,7 @@ def multivariate_value(identity_id)
         multivariate_feature_state_values.sort.each do |multi_fs_value|
           limit = multi_fs_value.percentage_allocation + start_percentage
 
-          if start_percentage <= percentage_value && percentage_value < limit
-            return multi_fs_value.multivariate_feature_option.value
-          end
+          return multi_fs_value.multivariate_feature_option.value if start_percentage <= percentage_value && percentage_value < limit
 
           start_percentage = limit
         end
@@ -165,7 +163,7 @@ class Segment
         attr_reader :priority
 
         def initialize(params = {})
-          @priority = params[:priority].nil? ? nil : params[:priority].to_i
+          @priority = params[:priority]&.to_i
         end
       end
     end

lib/flagsmith/engine/segments/evaluator.rb

@@ -36,6 +36,7 @@ def evaluate_identity_in_segment(identity, segment, override_traits = nil)
             end
         end
 
+        # rubocop:disable Metrics/MethodLength
         def traits_match_segment_rule(identity_traits, rule, segment_id, identity_id)
           matching_block = lambda { |condition|
             traits_match_segment_condition(identity_traits, condition, segment_id, identity_id)
@@ -44,23 +45,25 @@ def traits_match_segment_rule(identity_traits, rule, segment_id, identity_id)
           matches_conditions =
             if rule.conditions&.length&.positive?
               rule.conditions.send(rule.matching_function, &matching_block)
-            else true
+            else
+              true
             end
 
           matches_conditions &&
             rule.rules.all? { |r| traits_match_segment_rule(identity_traits, r, segment_id, identity_id) }
         end
+        # rubocop:enable Metrics/MethodLength
 
         def traits_match_segment_condition(identity_traits, condition, segment_id, identity_id)
           if condition.operator == PERCENTAGE_SPLIT
-            return hashed_percentage_for_object_ids([segment_id, identity_id]) <= condition.value.to_f
+            return hashed_percentage_for_object_ids([segment_id,
+                                                     identity_id]) <= condition.value.to_f
           end
 
           trait = identity_traits.find { |t| t.key.to_s == condition.property }
 
-          if [IS_SET, IS_NOT_SET].include?(condition.operator)
-            return handle_trait_existence_conditions(trait, condition.operator)
-          end
+          return handle_trait_existence_conditions(trait, condition.operator) if [IS_SET,
+                                                                                  IS_NOT_SET].include?(condition.operator)
 
           return condition.match_trait_value?(trait.trait_value) if trait
 

lib/flagsmith/engine/segments/models.rb

@@ -56,9 +56,7 @@ def initialize(operator:, value:, property: nil)
 
         def match_trait_value?(trait_value)
           # handle some exceptions
-          if @value.is_a?(String) && @value.match?(/:semver$/)
-            trait_value = Semantic::Version.new(trait_value.gsub(/:semver$/, ''))
-          end
+          trait_value = Semantic::Version.new(trait_value.gsub(/:semver$/, '')) if @value.is_a?(String) && @value.match?(/:semver$/)
 
           return match_modulo_value(trait_value) if @operator == MODULO
 
@@ -73,8 +71,8 @@ def format_to_type_of(input)
           {
             'String' => ->(v) { v.to_s },
             'Semantic::Version' => ->(v) { Semantic::Version.new(v.to_s.gsub(/:semver$/, '')) },
-            'TrueClass' => ->(v) { ['True', 'true', 'TRUE', true, 1, '1'].include?(v) ? true : false },
-            'FalseClass' => ->(v) { ['False', 'false', 'FALSE', false, 0, '0'].include?(v) ? false : true },
+            'TrueClass' => ->(v) { ['True', 'true', 'TRUE', true, 1, '1'].include?(v) },
+            'FalseClass' => ->(v) { !['False', 'false', 'FALSE', false, 0, '0'].include?(v) },
             'Integer' => ->(v) { v.to_i },
             'Float' => ->(v) { v.to_f }
           }[input.class.to_s]
@@ -83,7 +81,7 @@ def format_to_type_of(input)
 
         def match_modulo_value(trait_value)
           divisor, remainder = @value.split('|')
-          trait_value.is_a?(Numeric) && trait_value % divisor.to_f == remainder.to_f
+          trait_value.is_a?(Numeric) && trait_value % divisor.to_f == remainder.to_f # rubocop:disable Lint/FloatComparison
         rescue StandardError
           false
         end

lib/flagsmith/sdk/config.rb

@@ -84,7 +84,7 @@ def build_config(options)
 
     class << self
       def environment_key
-        ENV['FLAGSMITH_ENVIRONMENT_KEY']
+        ENV.fetch('FLAGSMITH_ENVIRONMENT_KEY', nil)
       end
     end
   end