Release 3.0

Rewrite due to new logic, add Config, Flag and Flags::Collection, Errors objects, implement part of the flags engine when enable_local_evaluation is set to false

Set up gitflow actions, update tests

Implement Flags Engine

Set up rspec, add end to end tests, fixes

Fix checkout with submodules

Use Flagsmith as the namespace, add Flagsmith::Client to instantiate the SDK.

Make all hashes from parsed JSON with symbol keys

Fix issue with support changes of hash arguments for ruby later 3.0

https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/

Engine::Core test coverage

Use segment priority

Test coverage of SDK

Small fixes after testing

Make #get_identity_feature_states_dict private, fix FeatureSegment priority

Rename Features::State to FeatureState

Add Github action to publish gem

Author: byReham

.github/workflows/publish.yaml

@@ -0,0 +1,32 @@
+# This workflow will build the gem from gemspec and publish
+
+name: Push Ruby Gem
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    env:
+      GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # need all the commits
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: .ruby-version
+          bundler-cache: true
+      - name: Configure Git
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Action"
+      - name: Bump and Commit
+        run: |
+          git push --follow-tags
+      - name: Buld and Push to rubygems.org
+        run: |
+          rake release[remote]

.github/workflows/pull_request.yaml

@@ -0,0 +1,45 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI RSpec Tests
+
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: CI
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: recursive
+    - name: Set up Ruby
+      # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+      # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec spec

.gitignore

@@ -13,6 +13,7 @@
 /pkg/
 /spec/reports/
 /spec/examples.txt
+.rspec_status
 /test/tmp/
 /test/version_tmp/
 /tmp/
@@ -51,7 +52,7 @@ build-iPhoneSimulator/
 # intended to run in multiple environments; otherwise, check them in:
 # Gemfile.lock
 # .ruby-version
-# .ruby-gemset
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
+.rvmrc

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/engine-test-data"]
+	path = spec/engine-test-data
+	url = [email protected]:Flagsmith/engine-test-data.git

.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

.rubocop.yml

@@ -2,7 +2,9 @@ inherit_from: .rubocop_todo.yml
 
 Layout/HashAlignment:
   AllowMultipleStyles: true
-  EnforcedColonStyle: separator
+  EnforcedColonStyle: key
 AllCops:
   NewCops: enable
   SuggestExtensions: false
+  Exclude:
+    - 'spec/**/*'

.rubocop_todo.yml

@@ -12,7 +12,6 @@
 Metrics/BlockLength:
   Exclude:
     - '**/*.gemspec'
-    - 'spec/flagsmith_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: AllowedMethods.

.ruby-version

@@ -0,0 +1 @@
+2.4.0

Gemfile.lock

@@ -3,23 +3,50 @@ PATH
   specs:
     flagsmith (2.0.0)
       faraday
+      faraday-retry
       faraday_middleware
+      semantic
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.1)
+    coderay (1.1.3)
     diff-lcs (1.4.4)
-    faraday (1.2.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.3)
       multipart-post (>= 1.2, < 3)
-      ruby2_keywords
-    faraday_middleware (1.0.0)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     gem-release (2.2.0)
+    method_source (1.0.0)
     multipart-post (2.1.1)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.0.3)
@@ -49,7 +76,8 @@ GEM
     rubocop-ast (1.3.0)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.2)
+    ruby2_keywords (0.0.5)
+    semantic (1.6.1)
     unicode-display_width (1.7.0)
 
 PLATFORMS
@@ -59,9 +87,10 @@ DEPENDENCIES
   bundler
   flagsmith!
   gem-release
+  pry
   rake
   rspec
   rubocop
 
 BUNDLED WITH
-   1.17.2
+   2.3.14

Rakefile

@@ -5,4 +5,8 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]